@stackbit/cms-core 0.1.3 → 0.1.4-alpha.1

package/src/content-source-interface.ts

@@ -1,495 +0,0 @@
-import type { Model, Field } from '@stackbit/sdk';
-import { UserCommandSpawner } from './common/common-types';
-
-export type DocumentStatus = 'added' | 'modified' | 'published' | 'deleted';
-
-export interface LeveledLogMethod {
-    (message: string): void;
-    (message: string, ...meta: any[]): void;
-    (message: any): void;
-}
-
-export interface Logger {
-    error: LeveledLogMethod;
-    warn: LeveledLogMethod;
-    info: LeveledLogMethod;
-    debug: LeveledLogMethod;
-    createLogger: ({ label }: { label: string }) => Logger;
-}
-
-export interface Locale {
-    code: string;
-    default?: boolean;
-}
-
-export interface Document<DocumentContext = unknown> {
-    type: 'document';
-    id: string;
-    manageUrl: string;
-    modelName: string;
-    status: DocumentStatus;
-    createdAt: string;
-    createdBy?: string;
-    updatedAt: string;
-    updatedBy?: string[];
-    fields: Record<string, DocumentField>;
-    context: DocumentContext;
-}
-
-export interface Asset<AssetContext = unknown> {
-    type: 'asset';
-    id: string;
-    manageUrl: string;
-    status: DocumentStatus;
-    createdAt: string;
-    createdBy?: string;
-    updatedAt: string;
-    updatedBy?: string[];
-    fields: AssetFields;
-    context: AssetContext;
-}
-
-export type AssetFields = {
-    title: DocumentValueFieldForType<'string'>;
-    file: AssetFileField;
-};
-
-export type DocumentField =
-    | DocumentValueField
-    | DocumentObjectField
-    | DocumentModelField
-    | DocumentReferenceField
-    | DocumentListField
-    | DocumentRichTextField
-    | DocumentImageField;
-
-export type DocumentFieldLocalized =
-    | DocumentValueFieldLocalized
-    | DocumentObjectFieldLocalized
-    | DocumentModelFieldLocalized
-    | DocumentReferenceFieldLocalized
-    | DocumentListFieldLocalized
-    | DocumentRichTextFieldLocalized
-    | DocumentImageFieldLocalized;
-
-export type DocumentFieldNonLocalized =
-    | DocumentValueFieldNonLocalized
-    | DocumentObjectFieldNonLocalized
-    | DocumentModelFieldNonLocalized
-    | DocumentReferenceFieldNonLocalized
-    | DocumentListFieldNonLocalized
-    | DocumentRichTextFieldNonLocalized
-    | DocumentImageFieldNonLocalized;
-
-export type DocumentFieldBaseProps =
-    | DocumentValueFieldBaseProps
-    | DocumentObjectFieldBase
-    | DocumentModelFieldBase
-    | DocumentReferenceFieldBase
-    | DocumentListFieldBase
-    | DocumentRichTextFieldBase
-    | DocumentImageFieldBase;
-
-export type DocumentFieldSpecificProps =
-    | DocumentValueFieldProps
-    | DocumentObjectFieldProps
-    | DocumentModelFieldProps
-    | DocumentReferenceFieldProps
-    | DocumentListFieldProps
-    | DocumentRichTextFieldProps
-    | DocumentImageFieldProps;
-
-export function isLocalizedField(field: DocumentField | AssetFileField): field is DocumentFieldLocalized | AssetFileFieldLocalized {
-    return !!field.localized;
-}
-
-export function getLocalizedFieldForLocale<Type extends FieldType>(
-    field: DocumentFieldForType<Type>,
-    locale?: string
-): DocumentFieldNonLocalizedForType<Type> | null {
-    if (field.localized) {
-        if (!locale) {
-            return null;
-        }
-        const { localized, locales, ...base } = field;
-        const localizedField = locales[locale];
-        if (!localizedField) {
-            return null;
-        }
-        return {
-            ...base,
-            ...localizedField
-        } as unknown as DocumentFieldNonLocalizedForType<Type>;
-    } else {
-        return field;
-    }
-}
-
-export type FieldType =
-    | 'string'
-    | 'url'
-    | 'slug'
-    | 'text'
-    | 'markdown'
-    | 'html'
-    | 'number'
-    | 'boolean'
-    | 'enum'
-    | 'date'
-    | 'datetime'
-    | 'color'
-    | 'image'
-    | 'file'
-    | 'json'
-    | 'richText'
-    | 'object'
-    | 'model'
-    | 'reference'
-    | 'style'
-    | 'list';
-
-export type Simplify<T> = {
-    [K in keyof T]: T[K];
-};
-
-export type FindByType<Union extends { type: FieldType }, 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 DocumentFieldBasePropsForType<Type extends FieldType> = FindByType<DocumentFieldBaseProps, Type>;
-export type DocumentFieldSpecificPropsForType<Type extends FieldType> = Simplify<
-    Omit<DocumentFieldNonLocalizedForType<Type>, keyof DocumentFieldBasePropsForType<Type> | 'locale' | 'localized'>
->;
-
-export type DocumentFieldTypeLocalized<BaseFieldProps, LocalizedFieldProps> = Simplify<
-    BaseFieldProps & {
-        localized: true;
-        locales: Record<string, { locale: string } & LocalizedFieldProps>;
-    }
->;
-
-export type DocumentFieldTypeNonLocalized<BaseFieldProps, LocalizedFieldProps> = Simplify<
-    BaseFieldProps &
-        LocalizedFieldProps & {
-            localized?: false;
-            locale?: string;
-        }
->;
-
-// any field that is not 'object' | 'model' | 'reference' | 'richText' | 'list'
-export type DocumentValueFieldType = Exclude<FieldType, 'object' | 'model' | 'reference' | '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 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 DocumentObjectFieldBase = {
-    type: 'object';
-};
-export type DocumentObjectFieldProps = {
-    fields: Record<string, DocumentField>;
-};
-
-// model
-export type DocumentModelField = DocumentModelFieldLocalized | DocumentModelFieldNonLocalized;
-export type DocumentModelFieldLocalized = DocumentFieldTypeLocalized<DocumentModelFieldBase, DocumentModelFieldProps>;
-export type DocumentModelFieldNonLocalized = DocumentFieldTypeNonLocalized<DocumentModelFieldBase, DocumentModelFieldProps>;
-export type DocumentModelFieldBase = {
-    type: 'model';
-};
-export type DocumentModelFieldProps = {
-    modelName: string;
-    fields: Record<string, DocumentField>;
-};
-
-// reference
-export type DocumentReferenceField = DocumentReferenceFieldLocalized | DocumentReferenceFieldNonLocalized;
-export type DocumentReferenceFieldLocalized = DocumentFieldTypeLocalized<DocumentReferenceFieldBase, DocumentReferenceFieldProps>;
-export type DocumentReferenceFieldNonLocalized = DocumentFieldTypeNonLocalized<DocumentReferenceFieldBase, DocumentReferenceFieldProps>;
-export type DocumentReferenceFieldBase = {
-    type: 'reference';
-    refType: 'document' | 'asset';
-};
-export type DocumentReferenceFieldProps = {
-    refId: string;
-};
-
-// richText
-export type DocumentRichTextField = DocumentRichTextFieldLocalized | DocumentRichTextFieldNonLocalized;
-export type DocumentRichTextFieldLocalized = DocumentFieldTypeLocalized<DocumentRichTextFieldBase, DocumentRichTextFieldProps>;
-export type DocumentRichTextFieldNonLocalized = DocumentFieldTypeNonLocalized<DocumentRichTextFieldBase, DocumentRichTextFieldProps>;
-export type DocumentRichTextFieldBase = {
-    type: 'richText';
-};
-export type DocumentRichTextFieldProps = {
-    hint?: string;
-    value: any;
-};
-
-// list
-export type DocumentListField = DocumentListFieldLocalized | DocumentListFieldNonLocalized;
-export type DocumentListFieldLocalized = DocumentFieldTypeLocalized<DocumentListFieldBase, DocumentListFieldProps>;
-export type DocumentListFieldNonLocalized = DocumentFieldTypeNonLocalized<DocumentListFieldBase, DocumentListFieldProps>;
-export type DocumentListFieldBase = {
-    type: 'list';
-};
-export type DocumentListFieldProps = {
-    items: DocumentFieldNonLocalized[];
-};
-
-// image
-export type DocumentImageField = DocumentImageFieldLocalized | DocumentImageFieldNonLocalized;
-export type DocumentImageFieldLocalized = DocumentFieldTypeLocalized<DocumentImageFieldBase, DocumentImageFieldProps>;
-export type DocumentImageFieldNonLocalized = DocumentFieldTypeNonLocalized<DocumentImageFieldBase, DocumentImageFieldProps>;
-export type DocumentImageFieldBase = {
-    type: 'image';
-};
-export type DocumentImageFieldProps = {
-    fields: {
-        title: DocumentValueFieldForType<'string'>;
-        url: DocumentValueFieldForType<'string'>;
-    };
-};
-
-// 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 interface InitOptions {
-    logger: Logger;
-    userLogger: Logger;
-    userCommandSpawner?: UserCommandSpawner;
-    localDev: boolean;
-}
-
-export interface ContentChangeEvent<DocumentContext = unknown, AssetContext = unknown> {
-    documents: Document<DocumentContext>[];
-    assets: Asset<AssetContext>[];
-    deletedDocumentIds: string[];
-    deletedAssetIds: string[];
-}
-
-export type UpdateOperation = UpdateOperationSet | UpdateOperationUnset | UpdateOperationInsert | UpdateOperationRemove | UpdateOperationReorder;
-
-export type UpdateOperationBase = {
-    opType: string;
-    fieldPath: (string | number)[];
-    modelField: Field;
-    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> = Type extends UpdateOperationValueFieldType
-    ? UpdateOperationValueFieldForType<Type>
-    : never;
-export type UpdateOperationValueFieldForType<Type extends UpdateOperationValueFieldType> = {
-    type: Type;
-    value: any;
-};
-
-export type UpdateOperationObjectField = {
-    type: 'object';
-    fields: Record<string, UpdateOperationField>;
-};
-
-export type UpdateOperationModelField = {
-    type: 'model';
-    modelName: string;
-    fields: Record<string, UpdateOperationField>;
-};
-
-export type UpdateOperationReferenceField = {
-    type: 'reference';
-    refType: 'document' | 'asset';
-    refId: string;
-};
-
-export type UpdateOperationListField = {
-    type: 'list';
-    items: UpdateOperationField[];
-}
-
-export type ValidationError = {
-    message: string;
-    objectType: 'document' | 'asset';
-    objectId: string;
-    fieldPath: (string | number)[];
-    isUniqueValidation?: boolean;
-};
-
-export type ModelMap = Record<string, Model>;
-
-export interface ContentSourceInterface<UserContext = unknown, DocumentContext = unknown, AssetContext = unknown> {
-    /**
-     * This function should return the type of the content source.
-     * The type must be unique among other content sources within the same project.
-     */
-    getContentSourceType(): string;
-
-    /**
-     * This function should return the project ID of the content source.
-     * The ID must be unique among other content sources of the same type.
-     */
-    getProjectId(): string;
-
-    getProjectEnvironment(): string;
-
-    getProjectManageUrl(): string;
-
-    /**
-     * This function should initialize the content source by fetching the schema
-     * and everything else needed to produce the StackbitSchema
-     */
-    init(options: InitOptions): Promise<void>;
-
-    reset(): Promise<void>;
-
-    onFilesChange?({
-        updatedFiles
-    }: {
-        updatedFiles: string[];
-    }): { schemaChanged?: boolean; contentChangeEvent?: ContentChangeEvent<DocumentContext, AssetContext> };
-
-    startWatchingContentUpdates(options: {
-        getModelMap: () => ModelMap;
-        getDocument: ({ documentId }: { documentId: string }) => Document<DocumentContext> | undefined;
-        getAsset: ({ assetId }: { assetId: string }) => Asset<AssetContext> | undefined;
-        onContentChange: (contentChangeEvent: ContentChangeEvent<DocumentContext, AssetContext>) => void;
-        onSchemaChange: () => void;
-    }): void;
-
-    stopWatchingContentUpdates(): void;
-
-    /**
-     * This function is responsible to fetch and convert content models
-     * to Stackbit models.
-     */
-    getModels(): Promise<Model[]>;
-
-    getLocales(): Promise<Locale[]>;
-
-    /**
-     * This function should fetch the documents and convert them into Stackbit's
-     * Document type
-     */
-    getDocuments(options: { modelMap: ModelMap }): Promise<Document<DocumentContext>[]>;
-
-    getAssets(): Promise<Asset<AssetContext>[]>;
-
-    hasAccess(options: { userContext?: UserContext }): Promise<boolean>;
-
-    createDocument(options: {
-        updateOperationFields: Record<string, UpdateOperationField>;
-        model: Model;
-        modelMap: ModelMap;
-        locale?: string;
-        userContext?: UserContext;
-    }): Promise<Document<DocumentContext>>;
-
-    updateDocument(options: {
-        document: Document<DocumentContext>;
-        operations: UpdateOperation[];
-        modelMap: ModelMap;
-        userContext?: UserContext;
-    }): Promise<Document<DocumentContext>>;
-
-    deleteDocument(options: { document: Document<DocumentContext>; userContext?: UserContext }): Promise<void>;
-
-    uploadAsset(options: {
-        url?: string;
-        base64?: string;
-        fileName: string;
-        mimeType: string;
-        locale?: string;
-        userContext?: UserContext;
-    }): Promise<Asset<AssetContext>>;
-
-    validateDocuments(options: {
-        documents: Document<DocumentContext>[];
-        assets: Asset<AssetContext>[];
-        locale?: string;
-        userContext?: UserContext;
-    }): Promise<{ errors: ValidationError[] }>;
-
-    publishDocuments(options: { documents: Document<DocumentContext>[]; assets: Asset<AssetContext>[]; userContext?: UserContext }): Promise<void>;
-}