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

package/src/utils/csi-to-store-docs-converter.ts

@@ -1,5 +1,5 @@
 import _ from 'lodash';
-import { Model, ObjectModel, ImageModel } from '@stackbit/sdk';
+import { Model, ObjectModel, ImageModel, PageModel, DataModel } from '@stackbit/sdk';
 import { omitByNil } from '@stackbit/utils';
 import {
     Field,
@@ -17,6 +17,11 @@ import * as ContentStoreTypes from '../types';
 import { IMAGE_MODEL } from '../common/common-schema';
 import { BackCompatContentSourceInterface } from './backward-compatibility';
 import { getImageFieldsFromSourceData } from './asset-sources-utils';
+import {
+    convertDocumentActionToAPICustomDocumentAction,
+    convertFieldActionToAPICustomAction,
+    convertObjectModelActionToAPICustomObjectAction
+} from './custom-actions';
 
 export function mapCSIAssetsToStoreAssets({
     csiAssets,
@@ -100,7 +105,8 @@ export function mapCSIDocumentsToStoreDocuments({
     modelMap,
     defaultLocaleCode,
     assetSources,
-    createConfigDelegate
+    createConfigDelegate,
+    customActionMap
 }: {
     csiDocuments: CSITypes.Document[];
     contentSourceInstance: BackCompatContentSourceInterface;
@@ -108,6 +114,7 @@ export function mapCSIDocumentsToStoreDocuments({
     defaultLocaleCode?: string;
     assetSources: CSITypes.AssetSource[];
     createConfigDelegate: () => CSITypes.ConfigDelegate;
+    customActionMap: ContentStoreTypes.ContentStoreCustomActionMap;
 }): ContentStoreTypes.Document[] {
     const meta = getMetadataFromContentStore({ contentSourceInstance });
     return csiDocuments.map((csiDocument) =>
@@ -118,7 +125,8 @@ export function mapCSIDocumentsToStoreDocuments({
             defaultLocaleCode,
             meta,
             assetSources,
-            createConfigDelegate
+            createConfigDelegate,
+            customActionMap
         })
     );
 }
@@ -130,7 +138,8 @@ function mapCSIDocumentToStoreDocument({
     defaultLocaleCode,
     meta,
     assetSources,
-    createConfigDelegate
+    createConfigDelegate,
+    customActionMap
 }: {
     csiDocument: CSITypes.Document;
     model: Model;
@@ -139,6 +148,7 @@ function mapCSIDocumentToStoreDocument({
     meta: { srcType: string; srcProjectId: string; srcProjectUrl: string; srcEnvironment: string };
     assetSources: CSITypes.AssetSource[];
     createConfigDelegate: () => CSITypes.ConfigDelegate;
+    customActionMap: ContentStoreTypes.ContentStoreCustomActionMap;
 }): ContentStoreTypes.Document {
     return omitByNil({
         type: 'document',
@@ -163,6 +173,14 @@ function mapCSIDocumentToStoreDocument({
         updatedAt: csiDocument.updatedAt,
         updatedBy: csiDocument.updatedBy,
         locale: getDocumentLocale({ csiDocument, model }),
+        getDocumentActions: () =>
+            getDocumentActions({
+                csiDocument,
+                model: model as PageModel | DataModel,
+                srcType: meta.srcType,
+                srcProjectId: meta.srcProjectId,
+                customActionMap
+            }),
         fields: mapCSIFieldsToStoreFields({
             csiDocumentFields: csiDocument.fields,
             modelFields: model.fields ?? [],
@@ -173,7 +191,9 @@ function mapCSIDocumentToStoreDocument({
                 modelMap,
                 defaultLocaleCode,
                 assetSources,
-                createConfigDelegate
+                createConfigDelegate,
+                customActionMap,
+                fieldPath: []
             }
         })
     });
@@ -187,6 +207,8 @@ type MapContext = {
     defaultLocaleCode?: string;
     assetSources: CSITypes.AssetSource[];
     createConfigDelegate: () => CSITypes.ConfigDelegate;
+    customActionMap: ContentStoreTypes.ContentStoreCustomActionMap;
+    fieldPath: (string | number)[];
 };
 
 function mapCSIFieldsToStoreFields({
@@ -200,13 +222,30 @@ function mapCSIFieldsToStoreFields({
 }): Record<string, ContentStoreTypes.DocumentField> {
     return modelFields.reduce((result: Record<string, ContentStoreTypes.DocumentField>, modelField) => {
         const csiDocumentField = csiDocumentFields[modelField.name];
+        const fieldPath = context.fieldPath.concat(modelField.name);
         const docField = mapCSIFieldToStoreField({
             csiDocumentField,
             modelField,
             localized: modelField.localized,
-            context
+            context: {
+                ...context,
+                fieldPath: fieldPath
+            }
         });
         docField.label = modelField.label;
+        if (Array.isArray(modelField.actions)) {
+            docField.getFieldActions = ({ locale }: { locale?: string } = {}) => {
+                return getFieldActions({
+                    modelField,
+                    csiParentDocument: context.parentDocument,
+                    srcType: context.srcType,
+                    srcProjectId: context.srcProjectId,
+                    customActionMap: context.customActionMap,
+                    fieldPath: fieldPath,
+                    locale
+                });
+            };
+        }
         result[modelField.name] = docField;
         return result;
     }, {});
@@ -483,10 +522,20 @@ function mapObjectField(
             locale
         }) as ContentStoreTypes.DocumentObjectFieldPreview;
     };
+    const _getObjectActions = (fieldPath: (string | number)[]) => () =>
+        getObjectFieldActions({
+            modelField: modelField,
+            csiParentDocument: context.parentDocument,
+            srcType: context.srcType,
+            srcProjectId: context.srcProjectId,
+            customActionMap: context.customActionMap,
+            fieldPath: fieldPath
+        });
     if (!isLocalizedField(csiDocumentField)) {
         return {
             type: csiDocumentField.type,
             getPreview: _getObjectPreview,
+            getObjectActions: _getObjectActions(context.fieldPath),
             fields: mapCSIFieldsToStoreFields({
                 csiDocumentFields: csiDocumentField.fields ?? {},
                 modelFields: modelField.fields ?? [],
@@ -498,13 +547,18 @@ function mapObjectField(
         type: csiDocumentField.type,
         localized: true,
         locales: _.mapValues(csiDocumentField.locales, (locale) => {
+            const fieldPath = context.fieldPath.concat(locale.locale);
             return {
                 locale: locale.locale,
                 getPreview: _getObjectPreview,
+                getObjectActions: _getObjectActions(fieldPath),
                 fields: mapCSIFieldsToStoreFields({
                     csiDocumentFields: locale.fields ?? {},
                     modelFields: modelField.fields ?? [],
-                    context
+                    context: {
+                        ...context,
+                        fieldPath: fieldPath
+                    }
                 })
             };
         })
@@ -525,6 +579,15 @@ function mapModelField(csiDocumentField: CSITypes.DocumentModelField, modelField
                 locale
             }) as ContentStoreTypes.DocumentModelFieldPreview;
         };
+    const _getObjectActions = (model: ObjectModel, fieldPath: (string | number)[]) => () =>
+        getObjectModelActions({
+            csiParentDocument: context.parentDocument,
+            model: model,
+            srcType: context.srcType,
+            srcProjectId: context.srcProjectId,
+            customActionMap: context.customActionMap,
+            fieldPath: fieldPath
+        });
     if (!isLocalizedField(csiDocumentField)) {
         const model = context.modelMap[csiDocumentField.modelName]! as ObjectModel;
         return {
@@ -532,6 +595,7 @@ function mapModelField(csiDocumentField: CSITypes.DocumentModelField, modelField
             getPreview: _getObjectPreview(model),
             srcModelName: csiDocumentField.modelName,
             srcModelLabel: model.label ?? _.startCase(model.name),
+            getObjectActions: _getObjectActions(model, context.fieldPath),
             fields: mapCSIFieldsToStoreFields({
                 csiDocumentFields: csiDocumentField.fields ?? {},
                 modelFields: model.fields ?? [],
@@ -544,15 +608,20 @@ function mapModelField(csiDocumentField: CSITypes.DocumentModelField, modelField
         localized: true,
         locales: _.mapValues(csiDocumentField.locales, (locale) => {
             const model = context.modelMap[locale.modelName]! as ObjectModel;
+            const fieldPath = context.fieldPath.concat(locale.locale);
             return {
                 locale: locale.locale,
                 getPreview: _getObjectPreview(model),
                 srcModelName: locale.modelName,
                 srcModelLabel: model.label ?? _.startCase(model.name),
+                getObjectActions: _getObjectActions(model, fieldPath),
                 fields: mapCSIFieldsToStoreFields({
                     csiDocumentFields: locale.fields ?? {},
                     modelFields: model.fields ?? [],
-                    context
+                    context: {
+                        ...context,
+                        fieldPath
+                    }
                 })
             };
         })
@@ -564,13 +633,16 @@ function mapListField(csiDocumentField: CSITypes.DocumentListField, modelField:
         return {
             type: csiDocumentField.type,
             items: csiDocumentField.items.map(
-                (item) =>
+                (item, index) =>
                     mapCSIFieldToStoreField({
                         csiDocumentField: item,
                         modelField: modelField.items ?? { type: 'string' },
                         // list items can not be localized, only the list itself can be localized
                         localized: false,
-                        context
+                        context: {
+                            ...context,
+                            fieldPath: context.fieldPath.concat(index)
+                        }
                     }) as ContentStoreTypes.DocumentListFieldItems
             )
         };
@@ -582,13 +654,16 @@ function mapListField(csiDocumentField: CSITypes.DocumentListField, modelField:
             return {
                 locale: locale.locale,
                 items: (locale.items ?? []).map(
-                    (item) =>
+                    (item, index) =>
                         mapCSIFieldToStoreField({
                             csiDocumentField: item,
                             modelField: modelField.items ?? { type: 'string' },
                             // list items can not be localized, only the list itself can be localized
                             localized: false,
-                            context
+                            context: {
+                                ...context,
+                                fieldPath: context.fieldPath.concat([locale.locale, index])
+                            }
                         }) as ContentStoreTypes.DocumentListFieldItems
                 )
             };
@@ -832,3 +907,136 @@ function getAssetLabelFromLabelField(csiAsset: CSITypes.Asset, imageModel: Image
 function getObjectTitleFromModel(model: Model | ImageModel): string {
     return model.label ? model.label : _.startCase(model.name);
 }
+
+function getDocumentActions({
+    csiDocument,
+    model,
+    srcType,
+    srcProjectId,
+    customActionMap
+}: {
+    csiDocument: CSITypes.Document;
+    model: PageModel | DataModel;
+    srcType: string;
+    srcProjectId: string;
+    customActionMap: ContentStoreTypes.ContentStoreCustomActionMap;
+}): ContentStoreTypes.APICustomActionDocument[] | undefined {
+    if (!('actions' in model) || !Array.isArray(model.actions)) {
+        return undefined;
+    }
+    return model.actions.map((action) => {
+        return convertDocumentActionToAPICustomDocumentAction({
+            action,
+            customActionMap,
+            csiDocument: {
+                ...csiDocument,
+                srcType,
+                srcProjectId
+            }
+        });
+    });
+}
+
+function getObjectModelActions({
+    model,
+    csiParentDocument,
+    srcType,
+    srcProjectId,
+    customActionMap,
+    fieldPath
+}: {
+    model: ObjectModel;
+    csiParentDocument: CSITypes.Document;
+    srcType: string;
+    srcProjectId: string;
+    customActionMap: ContentStoreTypes.ContentStoreCustomActionMap;
+    fieldPath: (string | number)[];
+}): ContentStoreTypes.APICustomActionObject[] | undefined {
+    if (!('actions' in model) || !Array.isArray(model.actions)) {
+        return undefined;
+    }
+    return model.actions.map((action) => {
+        return convertObjectModelActionToAPICustomObjectAction({
+            action,
+            customActionMap,
+            fieldPath: fieldPath,
+            csiParentDocument: {
+                ...csiParentDocument,
+                srcType,
+                srcProjectId
+            }
+        });
+    });
+}
+
+function getObjectFieldActions({
+    modelField,
+    csiParentDocument,
+    srcType,
+    srcProjectId,
+    customActionMap,
+    fieldPath,
+    locale
+}: {
+    modelField: FieldObjectProps;
+    csiParentDocument: CSITypes.Document;
+    srcType: string;
+    srcProjectId: string;
+    customActionMap: ContentStoreTypes.ContentStoreCustomActionMap;
+    fieldPath: (string | number)[];
+    locale?: string;
+}): ContentStoreTypes.APICustomActionObject[] | undefined {
+    if (!('actions' in modelField) || !Array.isArray(modelField.actions)) {
+        return undefined;
+    }
+    return modelField.actions
+        .filter((action): action is CSITypes.CustomActionObjectField => action.type === 'object')
+        .map((action) => {
+            return convertFieldActionToAPICustomAction({
+                action,
+                customActionMap,
+                fieldPath: locale ? fieldPath.concat(locale) : fieldPath,
+                csiParentDocument: {
+                    ...csiParentDocument,
+                    srcType,
+                    srcProjectId
+                }
+            });
+        });
+}
+
+function getFieldActions({
+    modelField,
+    csiParentDocument,
+    srcType,
+    srcProjectId,
+    customActionMap,
+    fieldPath,
+    locale
+}: {
+    modelField: FieldSpecificProps;
+    csiParentDocument: CSITypes.Document;
+    srcType: string;
+    srcProjectId: string;
+    customActionMap: ContentStoreTypes.ContentStoreCustomActionMap;
+    fieldPath: (string | number)[];
+    locale?: string;
+}): ContentStoreTypes.APICustomActionField[] | undefined {
+    if (!('actions' in modelField) || !Array.isArray(modelField.actions)) {
+        return undefined;
+    }
+    return modelField.actions
+        .filter((action): action is CSITypes.CustomActionField => action.type !== 'object')
+        .map((action) => {
+            return convertFieldActionToAPICustomAction({
+                action,
+                customActionMap,
+                fieldPath: locale ? fieldPath.concat(locale) : fieldPath,
+                csiParentDocument: {
+                    ...csiParentDocument,
+                    srcType,
+                    srcProjectId
+                }
+            });
+        });
+}