@stackbit/cms-core 3.0.7 → 3.0.8

package/src/types/custom-actions.ts

@@ -1,7 +1,9 @@
 import {
     CustomActionGlobal,
     CustomActionBulk,
+    CustomActionModel,
     CustomActionDocument,
+    CustomActionModelObject,
     CustomActionObjectModel,
     CustomActionObjectField,
     CustomActionField,
@@ -9,63 +11,121 @@ import {
     CustomActionInputField,
     CustomActionPermissions
 } from '@stackbit/types';
+import * as StackbitTypes from '@stackbit/types';
 import { User } from './index';
 
+export type CustomActionStateWithFinished = CustomActionState | 'finished' | 'failed';
+
 export type CustomActionRunStateMap = Record<string, CustomActionRunState>;
 export type CustomActionRunState = {
-    // specifies if the action is current running in this container instance
-    runningHandler?: boolean;
-    // the action state returned by the recent 'run' invocation
-    lastResultState?: CustomActionState;
+    isRunning?: boolean;
+    userId?: string;
+    /**
+     * An object specifying the model the running action belong to.
+     * This property is only applicable for actions of type 'modelGlobal' as
+     * these actions are not defined inside a model but inside stackbit config.
+     **/
+    modelSpec?: APICustomActionModelSpecifier;
 };
 
 export type ExtendedCustomAction =
     | ExtendedCustomActionGlobal
     | ExtendedCustomActionBulk
+    | ExtendedCustomActionModelGlobal
+    | ExtendedCustomActionModel
     | ExtendedCustomActionDocument
+    | ExtendedCustomActionModelObject
     | ExtendedCustomActionObjectModel
     | ExtendedCustomActionObjectField
     | ExtendedCustomActionField;
 
-export type ExtendedCustomActionGlobal = CustomActionGlobal & ContentStoreCustomActionCommonProps;
-export type ExtendedCustomActionBulk = CustomActionBulk & ContentStoreCustomActionCommonProps;
+export type ExtendedCustomActionGlobal = CustomActionGlobal & ContentStoreCustomActionCommonProps & { extendedType: 'global' };
+export type ExtendedCustomActionBulk = CustomActionBulk & ContentStoreCustomActionCommonProps & { extendedType: 'bulk' };
+export type ExtendedCustomActionModelGlobal = CustomActionModel &
+    ContentStoreCustomActionCommonProps & {
+        extendedType: 'modelGlobal';
+        modelSpec?: APICustomActionModelSpecifier;
+    };
+export type ExtendedCustomActionModel = CustomActionModel &
+    ContentStoreCustomActionCommonProps & {
+        extendedType: 'model';
+        modelSpec: APICustomActionModelSpecifier;
+    };
 export type ExtendedCustomActionDocument = CustomActionDocument &
     ContentStoreCustomActionCommonProps & {
         type: 'document';
-        documentSpec: APICustomActionDocumentSpecifier;
+        extendedType: 'document';
+        documentWithSource: StackbitTypes.DocumentWithSource;
+        modelWithSource: StackbitTypes.ModelWithSource;
     };
-export type ExtendedCustomActionObjectModel = Omit<CustomActionObjectModel, 'type'> &
+export type ExtendedCustomActionModelObject = CustomActionModelObject &
     ContentStoreCustomActionCommonProps & {
-        type: 'objectModel';
-        documentSpec: APICustomActionDocumentSpecifier;
+        extendedType: 'modelObject';
+        documentWithSource: StackbitTypes.DocumentWithSource;
+        modelWithSource: StackbitTypes.ModelWithSource;
+        modelField: StackbitTypes.FieldModel;
+        objectModel: StackbitTypes.ModelWithSource<StackbitTypes.ObjectModel>;
         fieldPath: (string | number)[];
+        // objectModel: ModelWithSource<ObjectModel>;
     };
-export type ExtendedCustomActionObjectField = Omit<CustomActionObjectField, 'type'> &
+export type ExtendedCustomActionObjectModel = CustomActionObjectModel &
     ContentStoreCustomActionCommonProps & {
-        type: 'objectField';
-        documentSpec: APICustomActionDocumentSpecifier;
+        type: 'object';
+        extendedType: 'objectModel';
+        documentWithSource: StackbitTypes.DocumentWithSource;
+        modelWithSource: StackbitTypes.ModelWithSource;
+        documentField: StackbitTypes.DocumentModelFieldNonLocalized;
+        modelField: StackbitTypes.FieldModel;
+        objectModel: StackbitTypes.ModelWithSource<StackbitTypes.ObjectModel>;
+        fieldPath: (string | number)[];
+    };
+export type ExtendedCustomActionObjectField = CustomActionObjectField &
+    ContentStoreCustomActionCommonProps & {
+        extendedType: 'objectField';
+        documentWithSource: StackbitTypes.DocumentWithSource;
+        modelWithSource: StackbitTypes.ModelWithSource;
+        documentField: StackbitTypes.DocumentObjectFieldNonLocalized;
+        modelField: StackbitTypes.FieldObject;
         fieldPath: (string | number)[];
     };
 export type ExtendedCustomActionField = CustomActionField &
     ContentStoreCustomActionCommonProps & {
         type: 'field';
-        documentSpec: APICustomActionDocumentSpecifier;
+        extendedType: 'field';
+        documentWithSource: StackbitTypes.DocumentWithSource;
+        modelWithSource: StackbitTypes.ModelWithSource;
+        documentField: StackbitTypes.DocumentField | undefined;
+        modelField: StackbitTypes.Field;
         fieldPath: (string | number)[];
     };
 export type ContentStoreCustomActionCommonProps = {
     type: string;
+    extendedType: string;
+    /**
+     * The unique id of the action definition.
+     * All actions, except actions of type 'model', can not run in parallel.
+     * Actions of type 'model' can run in parallel and can be triggered by the
+     * same user or by different users. The `actionId` of these executions will
+     * be different that the ID of the action that was originally triggered.
+     **/
     actionId: string;
+    /** The id of the user who executed the action */
+    userId?: 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;
+    isRunning?: boolean;
 };
 
-export type CustomActionType = 'global' | 'bulk' | 'document' | 'object' | 'field';
+export type CustomActionType = 'global' | 'bulk' | 'model' | 'document' | 'object' | 'field';
 
-export type APICustomAction = APICustomActionGlobal | APICustomActionBulk | APICustomActionDocument | APICustomActionObject | APICustomActionField;
+export type APICustomAction =
+    | APICustomActionGlobal
+    | APICustomActionBulk
+    | APICustomActionModel
+    | APICustomActionDocument
+    | APICustomActionObject
+    | APICustomActionField;
 
 export interface APICustomActionGlobal extends APICustomActionCommonProps {
     type: 'global';
@@ -75,6 +135,11 @@ export interface APICustomActionBulk extends APICustomActionCommonProps {
     type: 'bulk';
 }
 
+export interface APICustomActionModel extends APICustomActionCommonProps {
+    type: 'model';
+    models?: string[];
+}
+
 export interface APICustomActionDocument extends APICustomActionCommonProps {
     type: 'document';
 }
@@ -94,14 +159,20 @@ export interface APICustomActionCommonProps {
     icon?: string;
     inputFields?: CustomActionInputField[];
     actionId: string;
+    /** The userId is set when the action is in 'running' state */
+    userId?: string;
     state: CustomActionState;
     hidden?: boolean;
     permissions?: CustomActionPermissions;
 }
 
+export type APIRunCustomActionResponse = { actionId: string };
+
 export type APIRunCustomActionRequest =
     | APIRunCustomActionRequestGlobal
     | APIRunCustomActionRequestBulk
+    | APIRunCustomActionRequestModelGlobal
+    | APIRunCustomActionRequestModel
     | APIRunCustomActionRequestDocument
     | APIRunCustomActionRequestObject
     | APIRunCustomActionRequestField;
@@ -115,6 +186,21 @@ export interface APIRunCustomActionRequestBulk extends APIRunCustomActionRequest
     documents: APICustomActionDocumentSpecifier[];
 }
 
+export interface APIRunCustomActionRequestModelGlobal extends APIRunCustomActionRequestCommonParams {
+    actionType: 'model';
+    srcType: string;
+    srcProjectId: string;
+    modelName: string;
+    location: 'new-card' | 'preset-card';
+    presetId?: string;
+}
+
+export interface APIRunCustomActionRequestModel extends APIRunCustomActionRequestCommonParams {
+    actionType: 'model';
+    location: 'new-card' | 'preset-card';
+    presetId?: string;
+}
+
 export interface APIRunCustomActionRequestDocument extends APIRunCustomActionRequestCommonParams {
     actionType: 'document';
 }
@@ -146,6 +232,16 @@ export interface APIGetCustomActionRequest {
     currentPageDocument?: APICustomActionDocumentSpecifier; // the document id of the current page
 }
 
+export interface APIGetRunningCustomActionsRequest {
+    user: User;
+}
+
+export interface APICustomActionModelSpecifier {
+    srcType: string;
+    srcProjectId: string;
+    modelName: string;
+}
+
 export interface APICustomActionDocumentSpecifier {
     srcType: string;
     srcProjectId: string;
@@ -156,7 +252,14 @@ export interface CustomActionStateChange {
     actionType: CustomActionType;
     actionId: string;
     actionName: string;
-    state: CustomActionState;
+    state: CustomActionStateWithFinished;
+    userId?: string;
+    // While the action is running, the 'message' may change multiple times
+    // with user-facing messages to provide information about the progress of the action.
+    message?: string;
+    // While the action is running, the 'percent' may update with numerical value
+    // between 0 and 100 to provide information about the progress of the action.
+    percent?: number;
     success?: string;
     error?: string;
     result?: unknown;

package/src/utils/create-update-csi-docs.ts

@@ -1,5 +1,4 @@
 import _ from 'lodash';
-import slugify from 'slugify';
 
 import { Config, Model as SDKModel } from '@stackbit/sdk';
 import {
@@ -87,13 +86,13 @@ export function getCreateDocumentThunk({
 /**
  * Receives a plain `object`, and creates a map of `CSITypes.UpdateOperationField`
  * by recursively iterating the `object` fields. Then invokes the `createDocument`
- * callback to delegate the creation if CSI document.
+ * callback to delegate the creation of the document to a CSI module.
  *
- * If the `object` has fields of type `reference` or `model` with the special
- * `$$type` property holding the model name of the nested object, this function
- * will recursively create new documents and nested objects for these fields.
- * Other fields of will be used to populate the fields of the new document or
- * nested object.
+ * If the `object` has fields of type `reference`, `cross-reference` or `model`
+ * with the special `$$type` property holding the model name of the nested object,
+ * this function will recursively create new documents and nested objects for
+ * these fields. Other fields within the object will be used to populate the
+ * fields of the new document or nested object.
  *
  * @example
  * {
@@ -181,13 +180,6 @@ export async function createDocumentRecursively({
     };
 }
 
-function sanitizeSlug(slug?: string) {
-    return slug
-        ?.split('/')
-        .map((part) => slugify(part, { lower: true }))
-        .join('/');
-}
-
 async function createObjectRecursively({
     object,
     modelFields,
@@ -339,7 +331,7 @@ async function createObjectRecursively({
  *       { type: 'text', name: 'content' }
  *     ]
  *   }
- * )
+ * })
  * // The generated UpdateOperationField will use the original csiModelField types:
  * {
  *   field: {