wip-backup-manager/src/export/export.models.ts

This utility enables backup & restore of Kentico Kontent projects

import {
    AssetContracts,
    AssetFolderContracts,
    ContentItemContracts,
    ContentTypeContracts,
    ContentTypeSnippetContracts,
    LanguageContracts,
    LanguageVariantContracts,
    TaxonomyContracts,
    ProjectContracts,
} from '@kentico/kontent-management';

import { IProcessedItem } from '../core';

export interface IExportConfig {
    projectId: string;
    apiKey: string;
    onExport?: (item: IProcessedItem) => void;
}

export interface IExportData {
    taxonomies: TaxonomyContracts.ITaxonomyContract[];
    contentTypeSnippets: ContentTypeSnippetContracts.IContentTypeSnippetContract[];
    contentTypes: ContentTypeContracts.IContentTypeContract[];
    contentItems: ContentItemContracts.IContentItemModelContract[];
    languageVariants: LanguageVariantContracts.ILanguageVariantModelContract[];
    languages: LanguageContracts.ILanguageModelContract[];
    assets: AssetContracts.IAssetModelContract[];
    assetFolders: AssetFolderContracts.IAssetFolderContract[];
}

export interface IExportMetadata {
    version: string;
    projectId: string;
    timestamp: Date;
    isInconsistentExport: boolean;
    dataOverview: IExportMetadataDataOverview;
}

export interface IExportMetadataDataOverview {
    taxonomiesCount: number;
    contentTypeSnippetsCount:  number;
    contentTypesCount:  number;
    contentItemsCount:  number;
    languageVariantsCount:  number;
    languagesCount:  number;
    assetsCount:  number;
    assetFoldersCount:  number;
}

export interface IExportAllResult {
    metadata: IExportMetadata;
    data: IExportData;
    validation: ProjectContracts.IProjectReportResponseContract;
}