@stackbit/cms-core 0.0.20 → 0.0.21-alpha.2

package/src/content-store-types.ts

@@ -0,0 +1,430 @@
+import { DocumentStatus, FieldType } from './content-source-interface';
+
+export { FieldType, Logger, LeveledLogMethod, DocumentStatus } from './content-source-interface';
+
+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[];
+    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[];
+    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
+    | DocumentListField
+    | DocumentMarkdownField
+    | DocumentRichTextField
+    | DocumentImageField;
+
+export type DocumentFieldLocalized =
+    | DocumentValueFieldLocalized
+    | DocumentObjectFieldLocalized
+    | DocumentModelFieldLocalized
+    | DocumentReferenceFieldLocalized
+    | DocumentMarkdownFieldLocalized
+    | DocumentRichTextFieldLocalized
+    | DocumentListFieldLocalized
+    | DocumentImageFieldLocalized;
+
+export type DocumentFieldNonLocalized =
+    | DocumentValueFieldNonLocalized
+    | DocumentObjectFieldNonLocalized
+    | DocumentModelFieldNonLocalized
+    | DocumentReferenceFieldNonLocalized
+    | DocumentMarkdownFieldNonLocalized
+    | DocumentRichTextFieldNonLocalized
+    | DocumentListFieldNonLocalized
+    | DocumentImageFieldNonLocalized;
+
+export type DocumentFieldAPI =
+    | DocumentValueFieldAPI
+    | DocumentObjectFieldAPI
+    | DocumentModelFieldAPI
+    | DocumentReferenceFieldAPI
+    | DocumentMarkdownFieldAPI
+    | DocumentRichTextFieldAPI
+    | DocumentListFieldAPI
+    | DocumentImageFieldAPI;
+
+export type DocumentFieldBaseProps =
+    | DocumentValueFieldBaseProps
+    | DocumentObjectFieldBase
+    | DocumentModelFieldBase
+    | DocumentReferenceFieldBase
+    | 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<LocalizedFieldProps, 'isUnset'>>;
+    }
+>;
+
+export type DocumentFieldTypeNonLocalized<BaseFieldProps, LocalizedFieldProps> = Simplify<
+    BaseFieldProps &
+        LocalizedFieldProps & {
+            label?: string;
+            localized?: false;
+            locale?: string;
+        }
+>;
+
+export type DocumentFieldTypeAPI<BaseFieldProps, LocalizedFieldProps> = BaseFieldProps &
+    LocalizedFieldProps & {
+        label?: string;
+        description?: string;
+        locale?: string;
+        localized?: boolean;
+    };
+
+// any field that is not 'object' | 'model' | 'reference' | 'richText' | 'markdown' | 'list'
+export type DocumentValueFieldType = Exclude<FieldType, 'object' | 'model' | '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;
+};
+
+// 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 = { isUnset: true } | ({ isUnset?: false; fields: Record<string, DocumentField> } & DocumentObjectFieldPropsCommon);
+export type DocumentObjectFieldPropsAPI = { isUnset: true } | ({ 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<DocumentModelFieldBase, DocumentModelFieldPropsAPI>;
+export type DocumentModelFieldBase = { type: 'model' };
+export type DocumentModelFieldPropsCommon = {
+    srcObjectLabel: string;
+    srcModelName: string;
+    srcModelLabel: string;
+};
+export type DocumentModelFieldProps = { isUnset: true } | ({ isUnset?: false; fields: Record<string, DocumentField> } & DocumentModelFieldPropsCommon);
+export type DocumentModelFieldPropsAPI = { isUnset: true } | ({ 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 = { isUnset: true } | { isUnset?: false; refId: string };
+export type DocumentReferenceFieldBaseAPI = {
+    type: 'unresolved_reference';
+    refType: 'object' | 'image';
+};
+
+// 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 DocumentListFieldProps = {
+    items: DocumentField[];
+};
+export type DocumentListFieldPropsAPI = {
+    items: DocumentFieldAPI[];
+};
+
+// 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 = { isUnset: true } | { isUnset?: false; fields: AssetFieldsAPI };
+export type DocumentImageFieldPropsAPI = { isUnset: true } | { isUnset?: false; fields: 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 type UpdateOperationBase = {
+    opType: string;
+    fieldPath: (string | number)[];
+    locale?: string;
+};
+
+export type UpdateOperationSet = Simplify<
+    UpdateOperationBase & {
+        opType: 'set';
+        field: UpdateOperationField;
+    }
+>;
+
+export type UpdateOperationUnset = Simplify<
+    UpdateOperationBase & {
+        opType: 'unset';
+    }
+>;
+
+export type UpdateOperationInsert = Simplify<
+    UpdateOperationBase & {
+        opType: 'insert';
+        index?: number;
+        item: UpdateOperationField;
+    }
+>;
+
+export type UpdateOperationRemove = Simplify<
+    UpdateOperationBase & {
+        opType: 'remove';
+        index: number;
+    }
+>;
+
+export type UpdateOperationReorder = Simplify<
+    UpdateOperationBase & {
+        opType: 'reorder';
+        order: number[];
+    }
+>;
+
+export type UpdateOperationField =
+    | UpdateOperationValueField
+    | UpdateOperationObjectField
+    | UpdateOperationModelField
+    | UpdateOperationReferenceField
+    | UpdateOperationListField;
+
+export type UpdateOperationValueFieldType = Exclude<FieldType, 'object' | 'model' | 'reference' | 'list'>;
+export type UpdateOperationValueField = {
+    type: UpdateOperationValueFieldType;
+    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 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;
+};