@directus/api/dist/types/snapshot.d.ts

Directus is a real-time API and App dashboard for managing SQL database content

import type { Field, FieldMeta, Relation, RelationMeta } from '@directus/types';
import type { Diff } from 'deep-diff';
import type { Collection } from './collection.js';
import type { DatabaseClient } from './database.js';
export type Snapshot = {
    version: number;
    directus: string;
    vendor?: DatabaseClient;
    collections: Collection[];
    fields: SnapshotField[];
    relations: SnapshotRelation[];
};
export type SnapshotField = Field & {
    meta: Omit<FieldMeta, 'id'>;
};
export type SnapshotRelation = Relation & {
    meta: Omit<RelationMeta, 'id'>;
};
export type SnapshotWithHash = Snapshot & {
    hash: string;
};
export type SnapshotDiff = {
    collections: {
        collection: string;
        diff: Diff<Collection | undefined>[];
    }[];
    fields: {
        collection: string;
        field: string;
        diff: Diff<SnapshotField | undefined>[];
    }[];
    relations: {
        collection: string;
        field: string;
        related_collection: string | null;
        diff: Diff<SnapshotRelation | undefined>[];
    }[];
};
export type SnapshotDiffWithHash = {
    hash: string;
    diff: SnapshotDiff;
};
/**
 * Indicates the kind of change based on comparisons by deep-diff package
 */
export declare const DiffKind: {
    /** indicates a newly added property/element */
    readonly NEW: "N";
    /** indicates a property/element was deleted */
    readonly DELETE: "D";
    /** indicates a property/element was edited */
    readonly EDIT: "E";
    /** indicates a change occurred within an array */
    readonly ARRAY: "A";
};