@stackbit/cms-core 0.1.25 → 0.1.26-develop.1

package/src/content-store-types.ts

@@ -1,527 +0,0 @@
-import { DocumentStatus, FieldType } from '@stackbit/types';
-import { Model } from '@stackbit/sdk';
-import * as CSITypes from '@stackbit/types';
-
-export { FieldType, DocumentStatus, Logger } from '@stackbit/types';
-
-export interface ContentSourceData {
-    /* Internal content source id computed by concatenating srcType and srcProjectId */
-    id: string;
-    /* The content source instance loaded from stackbitConfig.contentSources */
-    instance: CSITypes.ContentSourceInterface;
-    srcType: string;
-    srcProjectId: string;
-    locales?: CSITypes.Locale[];
-    defaultLocaleCode?: string;
-    /* Array of extended and validated Models */
-    models: Model[];
-    /* Map of extended and validated Models by model name */
-    modelMap: Record<string, Model>;
-    /* Array of original Models (as provided by content source)  */
-    csiModels: CSITypes.Model[];
-    /* Map of original Models (as provided by content source) by model name */
-    csiModelMap: Record<string, CSITypes.Model>;
-    /* Array of original content source Documents */
-    csiDocuments: CSITypes.Document[];
-    /* Map of original content source Documents by document ID */
-    csiDocumentMap: Record<string, CSITypes.Document>;
-    /* Array of converted content-store Documents */
-    documents: Document[];
-    /* Map of converted content-store Documents by document ID */
-    documentMap: Record<string, Document>;
-    /* Array of original content source Assets */
-    csiAssets: CSITypes.Asset[];
-    /* Map of original content source Assets by asset ID */
-    csiAssetMap: Record<string, CSITypes.Asset>;
-    /* Array of converted content-store Assets */
-    assets: Asset[];
-    /* Map of converted content-store Assets by asset ID */
-    assetMap: Record<string, Asset>;
-}
-
-export interface Document {
-    type: 'document';
-    srcType: string;
-    srcProjectId: string;
-    srcProjectUrl: string;
-    srcEnvironment: string;
-    srcObjectId: string;
-    srcObjectUrl: string;
-    srcObjectLabel: string;
-    srcModelName: string;
-    srcModelLabel: string;
-    isChanged: boolean;
-    status: DocumentStatus;
-    createdAt: string;
-    createdBy?: string;
-    updatedAt: string;
-    updatedBy?: string[];
-    locale?: string;
-    fields: Record<string, DocumentField>;
-}
-
-export interface Asset {
-    type: 'asset';
-    srcType: string;
-    srcProjectId: string;
-    srcProjectUrl: string;
-    srcEnvironment: string;
-    srcObjectId: string;
-    srcObjectUrl: string;
-    srcObjectLabel: string;
-    srcModelName: string;
-    srcModelLabel: string;
-    isChanged: boolean;
-    status: DocumentStatus;
-    createdAt: string;
-    createdBy?: string;
-    updatedAt: string;
-    updatedBy?: string[];
-    locale?: string;
-    fields: AssetFields;
-}
-
-export type AssetFields = {
-    title: DocumentValueFieldForType<'string'>;
-    file: AssetFileField;
-};
-
-export interface UploadAssetData {
-    url: string;
-    data?: string;
-    metadata: {
-        name: string;
-        type: string;
-    };
-}
-
-export interface ContentChangeResultItem {
-    srcType: string;
-    srcProjectId: string;
-    srcObjectId: string;
-}
-
-export interface ContentChangeResult {
-    updatedDocuments: ContentChangeResultItem[];
-    updatedAssets: ContentChangeResultItem[];
-    deletedDocuments: ContentChangeResultItem[];
-    deletedAssets: ContentChangeResultItem[];
-}
-
-export type APIObject = APIDocumentObject | APIImageObject;
-
-export interface APIDocumentObject extends Omit<Document, 'fields' | 'type'> {
-    type: 'object';
-    fields: Record<string, DocumentFieldAPI>;
-}
-
-export interface APIImageObject extends Omit<Asset, 'fields' | 'type'> {
-    type: 'image';
-    fields: AssetFieldsAPI;
-}
-
-export type AssetFieldsAPI = {
-    title: DocumentFieldAPIForType<'string'>;
-    url: DocumentFieldAPIForType<'string'>;
-};
-
-export interface APIAsset {
-    objectId: string;
-    createdAt: string;
-    url: string;
-    title?: string;
-    fileName?: string;
-    contentType?: string;
-    size?: number;
-    width?: number;
-    height?: number;
-}
-
-export type DocumentField =
-    | DocumentValueField
-    | DocumentObjectField
-    | DocumentModelField
-    | DocumentReferenceField
-    | DocumentCrossReferenceField
-    | DocumentListField
-    | DocumentMarkdownField
-    | DocumentRichTextField
-    | DocumentImageField;
-
-export type DocumentFieldLocalized =
-    | DocumentValueFieldLocalized
-    | DocumentObjectFieldLocalized
-    | DocumentModelFieldLocalized
-    | DocumentReferenceFieldLocalized
-    | DocumentCrossReferenceFieldLocalized
-    | DocumentMarkdownFieldLocalized
-    | DocumentRichTextFieldLocalized
-    | DocumentListFieldLocalized
-    | DocumentImageFieldLocalized;
-
-export type DocumentFieldNonLocalized =
-    | DocumentValueFieldNonLocalized
-    | DocumentObjectFieldNonLocalized
-    | DocumentModelFieldNonLocalized
-    | DocumentReferenceFieldNonLocalized
-    | DocumentCrossReferenceFieldNonLocalized
-    | DocumentMarkdownFieldNonLocalized
-    | DocumentRichTextFieldNonLocalized
-    | DocumentListFieldNonLocalized
-    | DocumentImageFieldNonLocalized;
-
-export type DocumentFieldAPI =
-    | DocumentValueFieldAPI
-    | DocumentObjectFieldAPI
-    | DocumentModelFieldAPI
-    | DocumentReferenceFieldAPI
-    | DocumentCrossReferenceFieldAPI
-    | DocumentMarkdownFieldAPI
-    | DocumentRichTextFieldAPI
-    | DocumentListFieldAPI
-    | DocumentImageFieldAPI;
-
-export type DocumentFieldBaseProps =
-    | DocumentValueFieldBaseProps
-    | DocumentObjectFieldBase
-    | DocumentModelFieldBase
-    | DocumentReferenceFieldBase
-    | DocumentCrossReferenceFieldBase
-    | DocumentListFieldBase
-    | DocumentRichTextFieldBase
-    | DocumentImageFieldBase;
-
-export type DistributiveOmit<T, K extends PropertyKey> = T extends any ? Omit<T, K> : never;
-
-export type Simplify<T> = {
-    [K in keyof T]: T[K];
-};
-
-export type FindByType<Union extends { type: FieldType | 'unresolved_reference' }, Type> = Union extends { type: Type } ? Union : never;
-export type DocumentFieldForType<Type extends FieldType> = FindByType<DocumentField, Type>;
-export type DocumentFieldLocalizedForType<Type extends FieldType> = FindByType<DocumentFieldLocalized, Type>;
-export type DocumentFieldNonLocalizedForType<Type extends FieldType> = FindByType<DocumentFieldNonLocalized, Type>;
-export type DocumentFieldAPIForType<Type extends FieldType | 'unresolved_reference'> = FindByType<DocumentFieldAPI, Type>;
-export type DocumentFieldBasePropsForType<Type extends FieldType> = FindByType<DocumentFieldBaseProps, Type>;
-export type DocumentFieldSpecificPropsForType<Type extends FieldType> = Simplify<
-    DistributiveOmit<DocumentFieldNonLocalizedForType<Type>, keyof DocumentFieldBasePropsForType<Type> | 'label' | 'locale' | 'localized'>
->;
-
-// helpers
-export type DocumentFieldTypeLocalized<BaseFieldProps, LocalizedFieldProps> = Simplify<
-    BaseFieldProps & {
-        label?: string;
-        localized: true;
-        locales: Record<string, { locale: string } & Omit<Exclude<LocalizedFieldProps, DocumentFieldUnsetProps>, 'isUnset'>>;
-    }
->;
-
-export type DocumentFieldTypeNonLocalized<BaseFieldProps, LocalizedFieldProps> = Simplify<
-    BaseFieldProps &
-        LocalizedFieldProps & {
-            label?: string;
-            localized?: false;
-        }
->;
-
-export type DocumentFieldTypeAPI<BaseFieldProps, LocalizedFieldProps> = BaseFieldProps &
-    LocalizedFieldProps & {
-        label?: string;
-        description?: string;
-        locale?: string;
-        localized?: boolean;
-    } & ({ localized?: false } | { localized: true; locale: string });
-
-// any field that is not 'object' | 'model' | 'reference' | 'cross-reference' | 'richText' | 'markdown' | 'list'
-export type DocumentValueFieldType = Exclude<FieldType, 'object' | 'model' | 'reference' | 'cross-reference' | 'markdown' | 'richText' | 'list' | 'image'>;
-
-export type DocumentValueFieldForType<Type> = Type extends DocumentValueFieldType
-    ? DocumentValueFieldLocalizedForType<Type> | DocumentValueFieldNonLocalizedForType<Type>
-    : never;
-export type DocumentValueField = DocumentValueFieldForType<DocumentValueFieldType>;
-
-export type DocumentValueFieldLocalizedForType<Type> = Type extends DocumentValueFieldType
-    ? DocumentFieldTypeLocalized<DocumentValueFieldBase<Type>, DocumentValueFieldProps>
-    : never;
-export type DocumentValueFieldLocalized = DocumentValueFieldLocalizedForType<DocumentValueFieldType>;
-
-export type DocumentValueFieldNonLocalizedForType<Type> = Type extends DocumentValueFieldType
-    ? DocumentFieldTypeNonLocalized<DocumentValueFieldBase<Type>, DocumentValueFieldProps>
-    : never;
-export type DocumentValueFieldNonLocalized = DocumentValueFieldNonLocalizedForType<DocumentValueFieldType>;
-
-export type DocumentValueFieldAPIForType<Type> = Type extends DocumentValueFieldType
-    ? DocumentFieldTypeAPI<DocumentValueFieldBase<Type>, DocumentValueFieldProps>
-    : never;
-export type DocumentValueFieldAPI = DocumentValueFieldAPIForType<DocumentValueFieldType>;
-
-export type DocumentValueFieldBasePropsForType<Type> = Type extends DocumentValueFieldType ? DocumentValueFieldBase<Type> : never;
-export type DocumentValueFieldBaseProps = DocumentValueFieldBasePropsForType<DocumentValueFieldType>;
-export type DocumentValueFieldBase<Type extends DocumentValueFieldType> = {
-    type: Type;
-};
-export type DocumentValueFieldProps = {
-    value: any;
-};
-
-export type DocumentFieldUnsetProps = { isUnset: true };
-
-// object
-export type DocumentObjectField = DocumentObjectFieldLocalized | DocumentObjectFieldNonLocalized;
-export type DocumentObjectFieldLocalized = DocumentFieldTypeLocalized<DocumentObjectFieldBase, DocumentObjectFieldProps>;
-export type DocumentObjectFieldNonLocalized = DocumentFieldTypeNonLocalized<DocumentObjectFieldBase, DocumentObjectFieldProps>;
-export type DocumentObjectFieldAPI = DocumentFieldTypeAPI<DocumentObjectFieldBase, DocumentObjectFieldPropsAPI>;
-export type DocumentObjectFieldBase = { type: 'object' };
-export type DocumentObjectFieldPropsCommon = {
-    srcObjectLabel: string;
-};
-export type DocumentObjectFieldProps = DocumentFieldUnsetProps | ({ isUnset?: false; fields: Record<string, DocumentField> } & DocumentObjectFieldPropsCommon);
-export type DocumentObjectFieldPropsAPI =
-    | DocumentFieldUnsetProps
-    | ({ isUnset?: false; fields: Record<string, DocumentFieldAPI> } & DocumentObjectFieldPropsCommon);
-
-// model
-export type DocumentModelField = DocumentModelFieldLocalized | DocumentModelFieldNonLocalized;
-export type DocumentModelFieldLocalized = DocumentFieldTypeLocalized<DocumentModelFieldBase, DocumentModelFieldProps>;
-export type DocumentModelFieldNonLocalized = DocumentFieldTypeNonLocalized<DocumentModelFieldBase, DocumentModelFieldProps>;
-export type DocumentModelFieldAPI = DocumentFieldTypeAPI<{ type: 'object' }, DocumentModelFieldPropsAPI>;
-export type DocumentModelFieldBase = { type: 'model' };
-export type DocumentModelFieldPropsCommon = {
-    srcObjectLabel: string;
-    srcModelName: string;
-    srcModelLabel: string;
-};
-export type DocumentModelFieldProps = DocumentFieldUnsetProps | ({ isUnset?: false; fields: Record<string, DocumentField> } & DocumentModelFieldPropsCommon);
-export type DocumentModelFieldPropsAPI =
-    | DocumentFieldUnsetProps
-    | ({ isUnset?: false; fields: Record<string, DocumentFieldAPI> } & DocumentModelFieldPropsCommon);
-
-// reference
-export type DocumentReferenceField = DocumentReferenceFieldLocalized | DocumentReferenceFieldNonLocalized;
-export type DocumentReferenceFieldLocalized = DocumentFieldTypeLocalized<DocumentReferenceFieldBase, DocumentReferenceFieldProps>;
-export type DocumentReferenceFieldNonLocalized = DocumentFieldTypeNonLocalized<DocumentReferenceFieldBase, DocumentReferenceFieldProps>;
-export type DocumentReferenceFieldAPI = DocumentFieldTypeAPI<DocumentReferenceFieldBaseAPI, DocumentReferenceFieldProps>;
-export type DocumentReferenceFieldBase = {
-    type: 'reference';
-    refType: 'document' | 'asset';
-};
-export type DocumentReferenceFieldProps = DocumentFieldUnsetProps | { isUnset?: false; refId: string };
-export type DocumentReferenceFieldBaseAPI = {
-    type: 'unresolved_reference';
-    refType: 'object' | 'image';
-};
-
-// cross-reference
-export type DocumentCrossReferenceField = DocumentCrossReferenceFieldLocalized | DocumentCrossReferenceFieldNonLocalized;
-export type DocumentCrossReferenceFieldLocalized = DocumentFieldTypeLocalized<DocumentCrossReferenceFieldBase, DocumentCrossReferenceFieldProps>;
-export type DocumentCrossReferenceFieldNonLocalized = DocumentFieldTypeNonLocalized<DocumentCrossReferenceFieldBase, DocumentCrossReferenceFieldProps>;
-export type DocumentCrossReferenceFieldAPI = DocumentFieldTypeAPI<DocumentCrossReferenceFieldBase, DocumentCrossReferenceFieldProps>;
-export type DocumentCrossReferenceFieldBase = {
-    type: 'cross-reference';
-    refType: 'document' | 'asset';
-};
-export type DocumentCrossReferenceFieldProps =
-    | DocumentFieldUnsetProps
-    | {
-          isUnset?: false;
-          refId: string;
-          refSrcType: string;
-          refProjectId: string;
-      };
-
-// markdown
-export type DocumentMarkdownField = DocumentMarkdownFieldLocalized | DocumentMarkdownFieldNonLocalized;
-export type DocumentMarkdownFieldLocalized = DocumentFieldTypeLocalized<DocumentMarkdownFieldBase, DocumentMarkdownFieldProps>;
-export type DocumentMarkdownFieldNonLocalized = DocumentFieldTypeNonLocalized<DocumentMarkdownFieldBase, DocumentMarkdownFieldProps>;
-export type DocumentMarkdownFieldAPI = DocumentFieldTypeAPI<DocumentMarkdownFieldBase, DocumentMarkdownFieldProps>;
-export type DocumentMarkdownFieldBase = {
-    type: 'markdown';
-};
-export type DocumentMarkdownFieldProps = {
-    isUnset?: boolean;
-    multiElement?: boolean;
-    value: any;
-};
-
-// richText
-export type DocumentRichTextField = DocumentRichTextFieldLocalized | DocumentRichTextFieldNonLocalized;
-export type DocumentRichTextFieldLocalized = DocumentFieldTypeLocalized<DocumentRichTextFieldBase, DocumentRichTextFieldProps>;
-export type DocumentRichTextFieldNonLocalized = DocumentFieldTypeNonLocalized<DocumentRichTextFieldBase, DocumentRichTextFieldProps>;
-export type DocumentRichTextFieldAPI = DocumentFieldTypeAPI<DocumentRichTextFieldBase, DocumentRichTextFieldProps>;
-export type DocumentRichTextFieldBase = {
-    type: 'richText';
-};
-export type DocumentRichTextFieldProps = {
-    isUnset?: boolean;
-    hint?: string;
-    multiElement?: boolean;
-    value: any;
-};
-
-// list
-export type DocumentListField = DocumentListFieldLocalized | DocumentListFieldNonLocalized;
-export type DocumentListFieldLocalized = DocumentFieldTypeLocalized<DocumentListFieldBase, DocumentListFieldProps>;
-export type DocumentListFieldNonLocalized = DocumentFieldTypeNonLocalized<DocumentListFieldBase, DocumentListFieldProps>;
-export type DocumentListFieldAPI = DocumentFieldTypeAPI<DocumentListFieldBase, DocumentListFieldPropsAPI>;
-export type DocumentListFieldBase = {
-    type: 'list';
-};
-export type DocumentListFieldItems = Exclude<DocumentFieldNonLocalized, DocumentListFieldNonLocalized>;
-export type DocumentListFieldProps = {
-    items: DocumentListFieldItems[];
-};
-export type DocumentListFieldItemsAPI = Exclude<DocumentFieldAPI, DocumentListFieldAPI>;
-export type DocumentListFieldPropsAPI = {
-    items: DocumentListFieldItemsAPI[];
-};
-
-// image
-export type DocumentImageField = DocumentImageFieldLocalized | DocumentImageFieldNonLocalized;
-export type DocumentImageFieldLocalized = DocumentFieldTypeLocalized<DocumentImageFieldBase, DocumentImageFieldProps>;
-export type DocumentImageFieldNonLocalized = DocumentFieldTypeNonLocalized<DocumentImageFieldBase, DocumentImageFieldProps>;
-export type DocumentImageFieldAPI = DocumentFieldTypeAPI<DocumentImageFieldBase, DocumentImageFieldPropsAPI>;
-export type DocumentImageFieldBase = { type: 'image' };
-export type DocumentImageFieldProps = DocumentFieldUnsetProps | { isUnset?: false; fields: ImageFields };
-export type DocumentImageFieldPropsAPI = DocumentFieldUnsetProps | { isUnset?: false; fields: ImageFieldsAPI };
-export type ImageFields = {
-    title: DocumentFieldForType<'string'>;
-    url: DocumentFieldForType<'string'>;
-};
-export type ImageFieldsAPI = AssetFieldsAPI;
-
-// assetFile
-export type AssetFileField = AssetFileFieldLocalized | AssetFileFieldNonLocalized;
-export type AssetFileFieldLocalized = DocumentFieldTypeLocalized<AssetFileFieldBase, AssetFileFieldProps>;
-export type AssetFileFieldNonLocalized = DocumentFieldTypeNonLocalized<AssetFileFieldBase, AssetFileFieldProps>;
-export type AssetFileFieldBase = {
-    type: 'assetFile';
-};
-export type AssetFileFieldProps = {
-    url: string;
-    fileName?: string;
-    contentType?: string;
-    size?: number;
-    dimensions?: {
-        width?: number;
-        height?: number;
-    };
-};
-export type UpdateOperation = UpdateOperationSet | UpdateOperationUnset | UpdateOperationInsert | UpdateOperationRemove | UpdateOperationReorder;
-
-export interface UpdateOperationBase {
-    opType: string;
-    fieldPath: (string | number)[];
-    locale?: string;
-}
-
-export interface UpdateOperationSet extends UpdateOperationBase {
-    opType: 'set';
-    field: UpdateOperationField;
-}
-
-export interface UpdateOperationUnset extends UpdateOperationBase {
-    opType: 'unset';
-}
-
-export interface UpdateOperationInsert extends UpdateOperationBase {
-    opType: 'insert';
-    index?: number;
-    item: Exclude<UpdateOperationField, UpdateOperationListField>;
-}
-
-export interface UpdateOperationRemove extends UpdateOperationBase {
-    opType: 'remove';
-    index: number;
-}
-
-export interface UpdateOperationReorder extends UpdateOperationBase {
-    opType: 'reorder';
-    order: number[];
-}
-
-export type UpdateOperationField =
-    | UpdateOperationValueField
-    | UpdateOperationObjectField
-    | UpdateOperationModelField
-    | UpdateOperationReferenceField
-    | UpdateOperationCrossReferenceField
-    | UpdateOperationListField;
-
-export type UpdateOperationValueFieldType = Exclude<FieldType, 'object' | 'model' | 'reference' | 'cross-reference' | 'list'>;
-
-export type UpdateOperationValueField = DistributeUpdateOperationValueField<UpdateOperationValueFieldType>;
-
-export type DistributeUpdateOperationValueField<Type extends UpdateOperationValueFieldType> = Type extends UpdateOperationValueFieldType
-    ? UpdateOperationValueFieldForType<Type>
-    : never;
-
-export type UpdateOperationValueFieldForType<Type extends UpdateOperationValueFieldType> = {
-    type: Type;
-    value: any;
-};
-
-export type UpdateOperationObjectField = {
-    type: 'object';
-    object: Record<string, any>;
-};
-
-export type UpdateOperationModelField = {
-    type: 'model';
-    modelName: string;
-    object: Record<string, any>;
-};
-
-export type UpdateOperationReferenceField = {
-    type: 'reference';
-    refType: 'document' | 'asset';
-    refId: string;
-};
-
-export type UpdateOperationCrossReferenceField = {
-    type: 'cross-reference';
-    refType: 'document' | 'asset';
-    refId: string;
-    refSrcType: string;
-    refProjectId: string;
-};
-
-export type UpdateOperationListField = {
-    type: 'list';
-    items: any[];
-};
-
-export type User = {
-    name: string;
-    email: string;
-    connections: {
-        type: string;
-        [key: string]: any;
-    }[];
-};
-
-export type ValidationError = {
-    message: string;
-    srcType: string;
-    srcProjectId: string;
-    srcObjectType: string;
-    srcObjectId: string;
-    fieldPath: (string | number)[];
-    isUniqueValidation?: boolean;
-};
-
-export type HasAccessResult = {
-    hasConnection: boolean;
-    hasPermissions: boolean;
-    contentSources: {
-        srcType: string;
-        srcProjectId: string;
-        hasConnection: boolean;
-        hasPermissions: boolean;
-    }[];
-};
-
-export interface CrossReferenceData {
-    refId: string;
-    refSrcType: string;
-    refProjectId: string;
-}