@stackbit/dev 0.0.54 → 0.0.56-alpha.1

package/src/types/api-methods.ts

@@ -0,0 +1,292 @@
+import { ContentStoreTypes } from '@stackbit/cms-core';
+import { CommitAuthor } from '@stackbit/dev-common';
+
+export type APIMethodName = APIMethod['method'];
+export type APIMethodForMethod<T, U> = U extends { method: T } ? U : never;
+export type APIMethodByMethod<T extends APIMethodName> = APIMethodForMethod<T, APIMethod>;
+export type APIMethodDataForMethod<T extends APIMethodName> = APIMethodByMethod<T>['data'];
+export type APIMethodResultForMethod<T extends APIMethodName> = APIMethodByMethod<T>['result'];
+
+export type APIMethod =
+    | APIMethodCreateDocument
+    | APIMethodCreateAndLinkDocument
+    | APIMethodUploadAndLinkAsset
+    | APIMethodDuplicateDocument
+    | APIMethodUpdateDocument
+    | APIMethodValidateDocuments
+    | APIMethodDeleteDocument
+    | APIMethodGetAssets
+    | APIMethodUploadAssets
+    | APIMethodCreatePreset
+    | APIMethodDeletePreset;
+
+export type APIMethodCreateDocument = {
+    method: 'createDocument';
+    data: {
+        srcType: string;
+        srcProjectId: string;
+        modelName: string;
+        object?: Record<string, any>;
+        locale?: string;
+    };
+    result: { srcDocumentId: string };
+};
+
+export type APIMethodCreateAndLinkDocument = {
+    method: 'createAndLinkDocument';
+    data: {
+        srcType: string;
+        srcProjectId: string;
+        srcDocumentId: string;
+        fieldPath: (string | number)[];
+        modelName: string;
+        object?: Record<string, any>;
+        index?: number;
+        locale?: string;
+    };
+    result: { srcDocumentId: string };
+};
+
+export type APIMethodUploadAndLinkAsset = {
+    method: 'uploadAndLinkAsset';
+    data: {
+        srcType: string;
+        srcProjectId: string;
+        srcDocumentId: string;
+        fieldPath: (string | number)[];
+        asset: UploadAssetData;
+        index?: number;
+        locale?: string;
+    };
+    result: { srcDocumentId: string };
+};
+
+export type APIMethodDuplicateDocument = {
+    method: 'duplicateDocument';
+    data: {
+        srcType: string;
+        srcProjectId: string;
+        srcDocumentId: string;
+        object?: Record<string, any>;
+    };
+    result: { srcDocumentId: string };
+};
+
+export type APIMethodUpdateDocument = {
+    method: 'updateDocument';
+    data: {
+        srcType: string;
+        srcProjectId: string;
+        srcDocumentId: string;
+        updateOperations: UpdateOperation[];
+    };
+    result: { srcDocumentId: string };
+};
+
+export type APIMethodDeleteDocument = {
+    method: 'deleteDocument';
+    data: {
+        srcType: string;
+        srcProjectId: string;
+        srcDocumentId: string;
+    };
+    result: void;
+};
+
+export type APIMethodValidateDocuments = {
+    method: 'validateDocuments';
+    data: {
+        objects: { srcType: string; srcProjectId: string; srcObjectId: string }[];
+        locale?: string;
+    };
+    result: {
+        errors: ContentStoreTypes.ValidationError[];
+    };
+};
+
+export type APIMethodPublishDocuments = {
+    method: 'publishDocuments';
+    data: {
+        objects: { srcType: string; srcProjectId: string; srcObjectId: string }[];
+    };
+    result: void;
+};
+
+export type APIMethodGetAssets = {
+    method: 'getAssets';
+    data: {
+        srcType?: string;
+        srcProjectId?: string;
+        pageSize?: number;
+        pageNum?: number;
+        searchQuery?: string;
+    };
+    result: {
+        assets: ContentStoreTypes.APIAsset[];
+        pageSize: number;
+        pageNum: number;
+        totalPages: number;
+    };
+};
+export type APIMethodUploadAssets = {
+    method: 'uploadAssets';
+    data: {
+        srcType: string;
+        srcProjectId: string;
+        assets: UploadAssetData[];
+        locale?: string;
+        user: any;
+    };
+    result: ContentStoreTypes.APIAsset[];
+};
+
+export type APIMethodCreatePreset = {
+    method: 'createPreset';
+    data: {
+        label: string;
+        metadata: any;
+        thumbnail: string;
+        fieldDataPath: string[];
+        user: CommitAuthor;
+        dryRun: boolean;
+    };
+    result: {
+        files: string[];
+        preset: {
+            modelName: string;
+            thumbnail?: string;
+            data: any;
+            label: string;
+            metadata: any;
+        };
+    };
+};
+
+export type APIMethodDeletePreset = {
+    method: 'deletePreset';
+    data: {
+        presetId: string;
+        user: CommitAuthor;
+    };
+    result: {
+        changes: {
+            filePath: string;
+            description: string;
+        }[];
+        filesRemoved: string[];
+    };
+};
+
+export interface UploadAssetData {
+    url: string;
+    data?: string;
+    metadata: {
+        name: string;
+        type: string;
+    };
+}
+
+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 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];
+};