@stackbit/cms-core 0.7.6-develop.2 → 0.8.0-develop.1

package/src/types/content-store-document-fields.ts

@@ -1,4 +1,5 @@
 import * as CSITypes from '@stackbit/types';
+import { APICustomActionField, APICustomActionObject } from './custom-actions';
 
 export type DocumentField =
     | DocumentStringLikeField
@@ -117,6 +118,7 @@ export interface DocumentStringLikeFieldNonLocalizedForType<Type extends Documen
     type: Type;
     label?: string;
     localized?: false;
+    getFieldActions?: (options?: { locale?: string }) => APICustomActionField[] | undefined;
     value?: string;
 }
 
@@ -124,6 +126,7 @@ export interface DocumentStringLikeFieldLocalizedForType<Type extends DocumentSt
     type: Type;
     label?: string;
     localized: true;
+    getFieldActions?: (options?: { locale?: string }) => APICustomActionField[] | undefined;
     locales: Record<
         string,
         {
@@ -137,6 +140,7 @@ export type DocumentStringLikeFieldAPIForType<Type extends DocumentStringLikeFie
     type: Type;
     label?: string;
     description?: string;
+    actions?: APICustomActionField[];
     value?: string | null;
 } & ({ localized?: false } | { localized: true; locale: string });
 
@@ -149,6 +153,7 @@ export type DocumentMarkdownFieldNonLocalized = {
     type: 'markdown';
     label?: string;
     localized?: false;
+    getFieldActions?: (options?: { locale?: string }) => APICustomActionField[] | undefined;
     multiElement?: boolean;
     value?: string;
 } & ({ isUnset: true; value?: never } | { isUnset?: false; value: string });
@@ -157,6 +162,7 @@ export interface DocumentMarkdownFieldLocalized {
     type: 'markdown';
     label?: string;
     localized: true;
+    getFieldActions?: (options?: { locale?: string }) => APICustomActionField[] | undefined;
     locales: Record<
         string,
         {
@@ -172,6 +178,7 @@ export type DocumentMarkdownFieldAPI = {
     multiElement?: boolean;
     label?: string;
     description?: string;
+    actions?: APICustomActionField[];
     value?: string | null;
 } & ({ isUnset: true; value?: null } | { isUnset?: false; value: string }) &
     ({ localized?: false } | { localized: true; locale: string });
@@ -185,6 +192,7 @@ export interface DocumentNumberFieldNonLocalized {
     type: 'number';
     label?: string;
     localized?: false;
+    getFieldActions?: (options?: { locale?: string }) => APICustomActionField[] | undefined;
     value?: number;
 }
 
@@ -192,6 +200,7 @@ export interface DocumentNumberFieldLocalized {
     type: 'number';
     label?: string;
     localized: true;
+    getFieldActions?: (options?: { locale?: string }) => APICustomActionField[] | undefined;
     locales: Record<
         string,
         {
@@ -206,6 +215,7 @@ export type DocumentNumberFieldAPI = {
     value?: number | null;
     label?: string;
     description?: string;
+    actions?: APICustomActionField[];
 } & ({ localized?: false } | { localized: true; locale: string });
 
 /**
@@ -217,6 +227,7 @@ export interface DocumentBooleanFieldNonLocalized {
     type: 'boolean';
     label?: string;
     localized?: false;
+    getFieldActions?: (options?: { locale?: string }) => APICustomActionField[] | undefined;
     value?: boolean;
 }
 
@@ -224,6 +235,7 @@ export interface DocumentBooleanFieldLocalized {
     type: 'boolean';
     label?: string;
     localized: true;
+    getFieldActions?: (options?: { locale?: string }) => APICustomActionField[] | undefined;
     locales: Record<
         string,
         {
@@ -238,6 +250,7 @@ export type DocumentBooleanFieldAPI = {
     value?: boolean | null;
     label?: string;
     description?: string;
+    actions?: APICustomActionField[];
 } & ({ localized?: false } | { localized: true; locale: string });
 
 /**
@@ -249,6 +262,7 @@ export type DocumentJsonFieldNonLocalized = {
     type: 'json';
     label?: string;
     localized?: false;
+    getFieldActions?: (options?: { locale?: string }) => APICustomActionField[] | undefined;
     value?: any;
 } & ({ isUnset: true; value?: never } | { isUnset?: false; value: any });
 
@@ -256,6 +270,7 @@ export interface DocumentJsonFieldLocalized {
     type: 'json';
     label?: string;
     localized: true;
+    getFieldActions?: (options?: { locale?: string }) => APICustomActionField[] | undefined;
     locales: Record<
         string,
         {
@@ -269,6 +284,7 @@ export type DocumentJsonFieldAPI = {
     type: 'json';
     label?: string;
     description?: string;
+    actions?: APICustomActionField[];
     value?: any;
 } & ({ isUnset: true; value?: null } | { isUnset?: false; value: any }) &
     ({ localized?: false } | { localized: true; locale: string });
@@ -283,6 +299,7 @@ export interface DocumentStyleFieldNonLocalized {
     type: 'style';
     label?: string;
     localized?: false;
+    getFieldActions?: (options?: { locale?: string }) => APICustomActionField[] | undefined;
     value?: DocumentStyleFieldValue;
 }
 
@@ -290,6 +307,7 @@ export interface DocumentStyleFieldLocalized {
     type: 'style';
     label?: string;
     localized: true;
+    getFieldActions?: (options?: { locale?: string }) => APICustomActionField[] | undefined;
     locales: Record<
         string,
         {
@@ -304,6 +322,7 @@ export type DocumentStyleFieldAPI = {
     value?: DocumentStyleFieldValue | null;
     label?: string;
     description?: string;
+    actions?: APICustomActionField[];
 } & ({ localized?: false } | { localized: true; locale: string });
 
 /**
@@ -317,6 +336,7 @@ export type DocumentRichTextFieldNonLocalized = {
     type: 'richText';
     label?: string;
     localized?: false;
+    getFieldActions?: (options?: { locale?: string }) => APICustomActionField[] | undefined;
     hint?: string;
     multiElement?: boolean;
     value?: DocumentRichTextFieldValue;
@@ -326,6 +346,7 @@ export interface DocumentRichTextFieldLocalized {
     type: 'richText';
     label?: string;
     localized: true;
+    getFieldActions?: (options?: { locale?: string }) => APICustomActionField[] | undefined;
     locales: Record<
         string,
         {
@@ -343,6 +364,7 @@ export type DocumentRichTextFieldAPI = {
     multiElement?: boolean;
     label?: string;
     description?: string;
+    actions?: APICustomActionField[];
     value?: DocumentRichTextFieldValue | null;
 } & ({ isUnset: true; value?: null } | { isUnset?: false; value: DocumentRichTextFieldValue }) &
     ({ localized?: false } | { localized: true; locale: string });
@@ -356,6 +378,7 @@ export type DocumentImageFieldNonLocalized = {
     type: 'image';
     label?: string;
     localized?: false;
+    getFieldActions?: (options?: { locale?: string }) => APICustomActionField[] | undefined;
     source?: string;
 } & (
     | { isUnset: true }
@@ -371,6 +394,7 @@ export interface DocumentImageFieldLocalized {
     label?: string;
     source?: string;
     localized: true;
+    getFieldActions?: (options?: { locale?: string }) => APICustomActionField[] | undefined;
     locales: Record<
         string,
         {
@@ -391,6 +415,7 @@ export type DocumentImageFieldAPI = {
     source?: string;
     label?: string;
     description?: string;
+    actions?: APICustomActionField[];
 } & ({ isUnset: true } | { isUnset?: false; sourceData?: any; fields: ImageFieldsAPI }) &
     ({ localized?: false } | { localized: true; locale: string });
 
@@ -408,6 +433,7 @@ export type DocumentFileFieldNonLocalized = {
     type: 'file';
     label?: string;
     localized?: false;
+    getFieldActions?: (options?: { locale?: string }) => APICustomActionField[] | undefined;
     value?: any;
 } & ({ isUnset: true; value?: never } | { isUnset?: false; value: any });
 
@@ -415,6 +441,7 @@ export interface DocumentFileFieldLocalized {
     type: 'file';
     label?: string;
     localized: true;
+    getFieldActions?: (options?: { locale?: string }) => APICustomActionField[] | undefined;
     locales: Record<
         string,
         {
@@ -428,6 +455,7 @@ export type DocumentFileFieldAPI = {
     type: 'file';
     label?: string;
     description?: string;
+    actions?: APICustomActionField[];
     value?: any;
 } & ({ isUnset: true; value?: null } | { isUnset?: false; value: any }) &
     ({ localized?: false } | { localized: true; locale: string });
@@ -441,11 +469,13 @@ export type DocumentObjectFieldNonLocalized = {
     type: 'object';
     label?: string;
     localized?: false;
+    getFieldActions?: (options?: { locale?: string }) => APICustomActionField[] | undefined;
 } & (
     | { isUnset: true }
     | {
           isUnset?: false;
           getPreview: (options: { delegate?: CSITypes.ConfigDelegate; locale?: string }) => DocumentObjectFieldPreview;
+          getObjectActions?: () => APICustomActionObject[] | undefined; // object actions can be defined only on existing object;
           fields: Record<string, DocumentField>;
       }
 );
@@ -454,11 +484,13 @@ export interface DocumentObjectFieldLocalized {
     type: 'object';
     label?: string;
     localized: true;
+    getFieldActions?: (options?: { locale?: string }) => APICustomActionField[] | undefined;
     locales: Record<
         string,
         {
             locale: string;
             getPreview: (options: { delegate?: CSITypes.ConfigDelegate; locale?: string }) => DocumentObjectFieldPreview;
+            getObjectActions?: () => APICustomActionObject[] | undefined; // object actions can be defined only on existing object
             fields: Record<string, DocumentField>;
         }
     >;
@@ -475,10 +507,14 @@ export type DocumentObjectFieldAPI = {
     label?: string;
     description?: string;
 } & (
-    | { isUnset: true }
+    | {
+          isUnset: true;
+          actions?: APICustomActionField[];
+      }
     | {
           isUnset?: false;
           srcObjectLabel: string;
+          actions?: (APICustomActionField | APICustomActionObject)[]; // object actions can be defined only on existing object
           fields: Record<string, DocumentFieldAPI>;
       }
 ) &
@@ -493,6 +529,7 @@ export type DocumentModelFieldNonLocalized = {
     type: 'model';
     label?: string;
     localized?: false;
+    getFieldActions?: (options?: { locale?: string }) => APICustomActionField[] | undefined;
 } & (
     | { isUnset: true }
     | {
@@ -500,6 +537,7 @@ export type DocumentModelFieldNonLocalized = {
           srcModelName: string;
           srcModelLabel: string;
           getPreview: (options: { delegate?: CSITypes.ConfigDelegate; locale?: string }) => DocumentModelFieldPreview;
+          getObjectActions?: () => APICustomActionObject[] | undefined; // object actions can be defined only on existing object
           fields: Record<string, DocumentField>;
       }
 );
@@ -508,6 +546,7 @@ export interface DocumentModelFieldLocalized {
     type: 'model';
     label?: string;
     localized: true;
+    getFieldActions?: (options?: { locale?: string }) => APICustomActionField[] | undefined;
     locales: Record<
         string,
         {
@@ -515,6 +554,7 @@ export interface DocumentModelFieldLocalized {
             srcModelName: string;
             srcModelLabel: string;
             getPreview: (options: { delegate?: CSITypes.ConfigDelegate; locale?: string }) => DocumentModelFieldPreview;
+            getObjectActions?: () => APICustomActionObject[] | undefined; // object actions can be defined only on existing object
             fields: Record<string, DocumentField>;
         }
     >;
@@ -525,12 +565,16 @@ export type DocumentModelFieldAPI = {
     label?: string;
     description?: string;
 } & (
-    | { isUnset: true }
+    | {
+          isUnset: true;
+          actions?: APICustomActionField[];
+      }
     | {
           isUnset?: false;
           srcObjectLabel: string;
           srcModelName: string;
           srcModelLabel: string;
+          actions?: (APICustomActionField | APICustomActionObject)[]; // object actions can be defined only on existing object
           fields: Record<string, DocumentFieldAPI>;
       }
 ) &
@@ -552,6 +596,7 @@ export type DocumentReferenceFieldNonLocalized = {
     refType: 'document' | 'asset';
     label?: string;
     localized?: false;
+    getFieldActions?: (options?: { locale?: string }) => APICustomActionField[] | undefined;
 } & (
     | { isUnset: true }
     | {
@@ -565,6 +610,7 @@ export interface DocumentReferenceFieldLocalized {
     refType: 'document' | 'asset';
     label?: string;
     localized: true;
+    getFieldActions?: (options?: { locale?: string }) => APICustomActionField[] | undefined;
     locales: Record<
         string,
         {
@@ -579,6 +625,7 @@ export type DocumentReferenceFieldAPI = {
     refType: 'object' | 'image';
     label?: string;
     description?: string;
+    actions?: APICustomActionField[];
 } & (
     | { isUnset: true }
     | {
@@ -598,6 +645,7 @@ export type DocumentCrossReferenceFieldNonLocalized = {
     refType: 'document' | 'asset';
     label?: string;
     localized?: false;
+    getFieldActions?: (options?: { locale?: string }) => APICustomActionField[] | undefined;
 } & (
     | { isUnset: true }
     | {
@@ -613,6 +661,7 @@ export interface DocumentCrossReferenceFieldLocalized {
     refType: 'document' | 'asset';
     label?: string;
     localized: true;
+    getFieldActions?: (options?: { locale?: string }) => APICustomActionField[] | undefined;
     locales: Record<
         string,
         {
@@ -629,6 +678,7 @@ export type DocumentCrossReferenceFieldAPI = {
     refType: 'document' | 'asset';
     label?: string;
     description?: string;
+    actions?: APICustomActionField[];
 } & (
     | { isUnset: true }
     | {
@@ -650,6 +700,7 @@ export interface DocumentListFieldNonLocalized {
     type: 'list';
     label?: string;
     localized?: false;
+    getFieldActions?: (options?: { locale?: string }) => APICustomActionField[] | undefined;
     items: DocumentListFieldItems[];
 }
 
@@ -657,6 +708,7 @@ export interface DocumentListFieldLocalized {
     type: 'list';
     label?: string;
     localized: true;
+    getFieldActions?: (options?: { locale?: string }) => APICustomActionField[] | undefined;
     locales: Record<
         string,
         {
@@ -671,5 +723,6 @@ export type DocumentListFieldAPI = {
     type: 'list';
     label?: string;
     description?: string;
+    actions?: APICustomActionField[];
     items: DocumentListFieldItemsAPI[];
 } & ({ localized?: false } | { localized: true; locale: string });

package/src/types/content-store-documents.ts

@@ -1,5 +1,6 @@
 import { DocumentStatus, ConfigDelegate } from '@stackbit/types';
 import { DocumentField, DocumentFieldAPI, DocumentFieldAPIForType, DocumentStringLikeFieldForType } from './content-store-document-fields';
+import { APICustomActionDocument } from './custom-actions';
 
 export interface Document {
     type: 'document';
@@ -12,6 +13,7 @@ export interface Document {
     /** @deprecated used by older, non-csi cms interface  */
     srcObjectLabel?: string;
     getPreview: (options: { delegate?: ConfigDelegate; locale?: string }) => DocumentPreview;
+    getDocumentActions?: () => APICustomActionDocument[] | undefined;
     srcModelName: string;
     srcModelLabel: string;
     isChanged: boolean;
@@ -93,9 +95,10 @@ export interface AssetFileFieldProps {
  */
 export type APIObject = APIDocumentObject | APIImageObject;
 
-export interface APIDocumentObject extends Omit<Document, 'getPreview' | 'fields' | 'type'> {
+export interface APIDocumentObject extends Omit<Document, 'getPreview' | 'getDocumentActions' | 'fields' | 'type'> {
     type: 'object';
     srcObjectLabel: string;
+    actions?: APICustomActionDocument[];
     fields: Record<string, DocumentFieldAPI>;
 }
 

package/src/types/content-store-types.ts

@@ -1,4 +1,4 @@
-import * as CSITypes from '@stackbit/types';
+import * as StackbitTypes from '@stackbit/types';
 import { Model } from '@stackbit/sdk';
 import { Asset, Document } from './content-store-documents';
 import { BackCompatContentSourceInterface } from '../utils/backward-compatibility';
@@ -12,35 +12,35 @@ export interface ContentSourceData {
     version: { interfaceVersion: string; contentSourceVersion: string };
     srcType: string;
     srcProjectId: string;
-    locales?: CSITypes.Locale[];
+    locales?: StackbitTypes.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)  */
-    csiSchema: CSITypes.Schema;
-    csiModels: CSITypes.Model[];
+    csiSchema: StackbitTypes.Schema;
+    csiModels: StackbitTypes.Model[];
     /* Map of original Models (as provided by content source) by model name */
-    csiModelMap: Record<string, CSITypes.Model>;
+    csiModelMap: Record<string, StackbitTypes.Model>;
     /* Array of original content source Documents */
-    csiDocuments: CSITypes.Document[];
+    csiDocuments: StackbitTypes.Document[];
     /* Map of original content source Documents by document ID */
-    csiDocumentMap: Record<string, CSITypes.Document>;
+    csiDocumentMap: Record<string, StackbitTypes.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[];
+    csiAssets: StackbitTypes.Asset[];
     /* Map of original content source Assets by asset ID */
-    csiAssetMap: Record<string, CSITypes.Asset>;
+    csiAssetMap: Record<string, StackbitTypes.Asset>;
     /* Array of converted content-store Assets */
     assets: Asset[];
     /* Map of converted content-store Assets by asset ID */
     assetMap: Record<string, Asset>;
     // Array of converted scheduled actions (publishes)
-    scheduledActions: CSITypes.ScheduledAction[];
+    scheduledActions: StackbitTypes.ScheduledAction[];
     /* Map of advanced features to enable in the studio client */
     enabledFeatures: {
         scheduledActions: boolean;

package/src/types/custom-actions.ts

@@ -0,0 +1,154 @@
+import {
+    CustomActionGlobal,
+    CustomActionBulk,
+    CustomActionDocument,
+    CustomActionObjectModel,
+    CustomActionObjectField,
+    CustomActionField,
+    CustomActionState,
+    CustomActionInputField
+} from '@stackbit/types';
+import { User } from './index';
+
+export type ContentStoreCustomActionMap = Record<string, ContentStoreCustomAction>;
+
+export type ContentStoreCustomAction =
+    | ContentStoreCustomActionGlobal
+    | ContentStoreCustomActionBulk
+    | ContentStoreCustomActionDocument
+    | ContentStoreCustomActionObjectModel
+    | ContentStoreCustomActionObjectField
+    | ContentStoreCustomActionField;
+
+export type ContentStoreCustomActionGlobal = CustomActionGlobal & ContentStoreCustomActionCommonProps;
+export type ContentStoreCustomActionBulk = CustomActionBulk & ContentStoreCustomActionCommonProps;
+export type ContentStoreCustomActionDocument = CustomActionDocument &
+    ContentStoreCustomActionCommonProps & {
+        type: 'document';
+        documentSpec: APICustomActionDocumentSpecifier;
+    };
+export type ContentStoreCustomActionObjectModel = CustomActionObjectModel &
+    ContentStoreCustomActionCommonProps & {
+        type: 'objectModel';
+        documentSpec: APICustomActionDocumentSpecifier;
+        fieldPath: (string | number)[];
+    };
+export type ContentStoreCustomActionObjectField = Omit<CustomActionObjectField, 'type'> &
+    ContentStoreCustomActionCommonProps & {
+        type: 'objectField';
+        documentSpec: APICustomActionDocumentSpecifier;
+        fieldPath: (string | number)[];
+    };
+export type ContentStoreCustomActionField = CustomActionField &
+    ContentStoreCustomActionCommonProps & {
+        type: 'field';
+        documentSpec: APICustomActionDocumentSpecifier;
+        fieldPath: (string | number)[];
+    };
+export type ContentStoreCustomActionCommonProps = {
+    type: string;
+    actionId: string;
+    // override optional label to required one
+    label: string;
+    // specifies if the action is current running in this container instance
+    runningHandler?: boolean;
+    // the action state returned by the recent 'run' invocation
+    lastResultState?: CustomActionState;
+};
+
+export type CustomActionType = 'global' | 'bulk' | 'document' | 'object' | 'field';
+
+export type APICustomAction = APICustomActionGlobal | APICustomActionBulk | APICustomActionDocument | APICustomActionObject | APICustomActionField;
+
+export interface APICustomActionGlobal extends APICustomActionCommonProps {
+    type: 'global';
+}
+
+export interface APICustomActionBulk extends APICustomActionCommonProps {
+    type: 'bulk';
+}
+
+export interface APICustomActionDocument extends APICustomActionCommonProps {
+    type: 'document';
+}
+
+export interface APICustomActionObject extends APICustomActionCommonProps {
+    type: 'object';
+}
+
+export interface APICustomActionField extends APICustomActionCommonProps {
+    type: 'field';
+}
+
+export interface APICustomActionCommonProps {
+    type: CustomActionType;
+    actionId: string;
+    name: string;
+    label: string;
+    icon?: string;
+    state: CustomActionState | 'unknown';
+    inputFields?: CustomActionInputField[];
+    needsResolving?: boolean;
+}
+
+export type APIRunCustomActionRequest =
+    | APIRunCustomActionRequestGlobal
+    | APIRunCustomActionRequestBulk
+    | APIRunCustomActionRequestDocument
+    | APIRunCustomActionRequestObject
+    | APIRunCustomActionRequestField;
+
+export interface APIRunCustomActionRequestGlobal extends APIRunCustomActionRequestCommonParams {
+    actionType: 'global';
+}
+
+export interface APIRunCustomActionRequestBulk extends APIRunCustomActionRequestCommonParams {
+    actionType: 'bulk';
+    documents: APICustomActionDocumentSpecifier[];
+}
+
+export interface APIRunCustomActionRequestDocument extends APIRunCustomActionRequestCommonParams {
+    actionType: 'document';
+}
+
+export interface APIRunCustomActionRequestObject extends APIRunCustomActionRequestCommonParams {
+    actionType: 'object';
+}
+
+export interface APIRunCustomActionRequestField extends APIRunCustomActionRequestCommonParams {
+    actionType: 'field';
+}
+
+interface APIRunCustomActionRequestCommonParams {
+    actionType: string;
+    actionId: string;
+    actionName: string;
+    locale?: string;
+    user?: User;
+    pageUrl?: string;
+    currentPageDocument?: APICustomActionDocumentSpecifier; // the document id of the current page
+    inputData?: Record<string, any>;
+}
+
+export interface APIGetCustomActionRequest {
+    customActionIds: string[];
+    locale?: string;
+    user?: User;
+    pageUrl?: string;
+    currentPageDocument?: APICustomActionDocumentSpecifier; // the document id of the current page
+}
+
+export interface APICustomActionDocumentSpecifier {
+    srcType: string;
+    srcProjectId: string;
+    srcDocumentId: string;
+}
+
+export interface CustomActionStateChange {
+    actionType: CustomActionType;
+    actionId: string;
+    actionName: string;
+    state: CustomActionState;
+    success?: string;
+    error?: string;
+}

package/src/types/index.ts

@@ -3,3 +3,4 @@ export * from './content-store-documents';
 export * from './content-store-document-fields';
 export * from './content-store-update-operation';
 export * from './search-filter';
+export * from './custom-actions';