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

package/src/utils/document-hooks.ts

@@ -4,7 +4,7 @@ import * as StackbitTypes from '@stackbit/types';
 import * as ContentStoreTypes from '../types';
 import type { ContentSourceData } from '../types';
 import type { BackCompatContentSourceInterface } from './backward-compatibility';
-import { getUserContextForSrcType, findContentSourcesDataForTypeOrId } from '../content-store-utils';
+import { getUserContextForSrcType, findContentSourcesDataForTypeOrId, getUserContextForSrcTypeThunk } from '../content-store-utils';
 import { createConfigDelegate } from './config-delegate';
 
 export interface DocumentHookBaseOptions {
@@ -146,12 +146,12 @@ function getDocumentHookOptions<Action extends 'createDocument' | 'updateDocumen
             user: options.user,
             stackbitConfig: options.stackbitConfig
         }),
-        getUserContextForContentSourceType: (srcType) => getUserContextForSrcType(srcType, options.user),
+        getUserContextForContentSourceType: getUserContextForSrcTypeThunk(options.user),
         ...configDelegate
     };
 }
 
-function getContentSourceActionsForSourceThunk({
+export function getContentSourceActionsForSourceThunk({
     getContentSourceDataById,
     logger,
     user,

package/src/utils/search-utils.ts

@@ -2,7 +2,7 @@ import _ from 'lodash';
 import { ImageModel, Model } from '@stackbit/sdk';
 
 import * as ContentStoreTypes from '../types';
-import { ReferenceValueType, SearchFilter, SearchFilterItem } from '../types/search-filter';
+import { ReferenceValueType, SearchFilter, SearchFilterItem } from '../types';
 import { getContentSourceId, getDocumentFieldForLocale } from '../content-store-utils';
 
 const META_FIELD = {

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

@@ -1,8 +1,9 @@
 import _ from 'lodash';
 import path from 'path';
-import { omitByNil } from '@stackbit/utils';
+import { omitByNil, omitByUndefined } from '@stackbit/utils';
 import * as CSITypes from '@stackbit/types';
 import * as ContentStoreTypes from '../types';
+import { APICustomActionField, APICustomActionObject } from '../types';
 
 export function mapDocumentsToLocalizedApiObjects({
     documents,
@@ -31,13 +32,14 @@ function documentToLocalizedApiObject({
     locale?: string;
     delegate: CSITypes.ConfigDelegate;
 }): ContentStoreTypes.APIDocumentObject {
-    const { type, fields, getPreview, ...rest } = document;
-    return {
+    const { type, fields, getPreview, getDocumentActions, ...rest } = document;
+    return omitByUndefined({
         type: 'object',
         ...rest,
         srcObjectLabel: getPreview({ delegate, locale }).previewTitle,
+        actions: getDocumentActions?.(),
         fields: toLocalizedAPIFields({ docFields: fields, delegate, locale })
-    };
+    });
 }
 
 function toLocalizedAPIFields({
@@ -50,11 +52,13 @@ function toLocalizedAPIFields({
     locale?: string;
 }): Record<string, ContentStoreTypes.DocumentFieldAPI> {
     return _.mapValues(docFields, (docField) => {
-        return toLocalizedAPIField({
-            docField,
-            delegate,
-            locale
-        });
+        return omitByUndefined(
+            toLocalizedAPIField({
+                docField,
+                delegate,
+                locale
+            })
+        );
     });
 }
 
@@ -88,6 +92,9 @@ function toLocalizedAPIField({
             locale: locale
         };
     }
+    const { getFieldActions, ...restDocField } = docField;
+    const fieldActions = getFieldActions?.({ locale: docField.localized ? locale : undefined });
+    docField = restDocField;
     switch (docField.type) {
         case 'string':
         case 'text':
@@ -107,12 +114,14 @@ function toLocalizedAPIField({
                 return {
                     ...base,
                     ...localeProps,
-                    ...localeFields(localized)
+                    ...localeFields(localized),
+                    actions: fieldActions
                 } as ContentStoreTypes.DocumentStringLikeFieldAPI;
             }
             return {
                 ...docField,
-                ...localeFields(docField.localized)
+                ...localeFields(docField.localized),
+                actions: fieldActions
             };
         }
         case 'file':
@@ -126,18 +135,21 @@ function toLocalizedAPIField({
                     return {
                         ...base,
                         ...localeProps,
-                        ...localeFields(localized)
+                        ...localeFields(localized),
+                        actions: fieldActions
                     };
                 }
                 return {
                     ...base,
                     isUnset: true,
-                    ...localeFields(localized)
+                    ...localeFields(localized),
+                    actions: fieldActions
                 };
             }
             return {
                 ...docField,
-                ...localeFields(docField.localized)
+                ...localeFields(docField.localized),
+                actions: fieldActions
             };
         }
         case 'image': {
@@ -155,13 +167,15 @@ function toLocalizedAPIField({
                         ...base,
                         ...localeProps,
                         fields,
-                        ...localeFields(localized)
+                        ...localeFields(localized),
+                        actions: fieldActions
                     };
                 } else {
                     result = {
                         ...base,
                         isUnset: true,
-                        ...localeFields(localized)
+                        ...localeFields(localized),
+                        actions: fieldActions
                     };
                 }
             } else {
@@ -169,7 +183,8 @@ function toLocalizedAPIField({
                     result = {
                         ...docField,
                         type: 'image',
-                        ...localeFields(docField.localized)
+                        ...localeFields(docField.localized),
+                        actions: fieldActions
                     };
                 } else {
                     const fields = toLocalizedAPIFields({
@@ -181,7 +196,8 @@ function toLocalizedAPIField({
                         ...docField,
                         type: 'image',
                         fields,
-                        ...localeFields(docField.localized)
+                        ...localeFields(docField.localized),
+                        actions: fieldActions
                     };
                 }
             }
@@ -192,7 +208,8 @@ function toLocalizedAPIField({
                 const { localized, locales, ...base } = docField;
                 const localeProps = locales && locale ? locales[locale] : undefined;
                 if (localeProps) {
-                    const { fields, getPreview, locale } = localeProps;
+                    const { fields, getPreview, getObjectActions, locale } = localeProps;
+                    const objectActions = getObjectActions?.();
                     return {
                         ...base,
                         ...localeFields(localized),
@@ -201,6 +218,7 @@ function toLocalizedAPIField({
                                 delegate,
                                 locale
                             }).previewTitle ?? (isListItem ? 'Item' : 'Object'),
+                        actions: concatObjectAndFieldActions(objectActions, fieldActions),
                         fields: toLocalizedAPIFields({
                             docFields: fields,
                             delegate,
@@ -211,6 +229,7 @@ function toLocalizedAPIField({
                 return {
                     ...base,
                     ...localeFields(localized),
+                    actions: fieldActions,
                     isUnset: true
                 };
             }
@@ -218,10 +237,12 @@ function toLocalizedAPIField({
                 return {
                     ...docField,
                     type: 'object',
-                    ...localeFields(docField.localized)
+                    ...localeFields(docField.localized),
+                    actions: fieldActions
                 };
             }
-            const { fields, getPreview, ...rest } = docField;
+            const { fields, getPreview, getObjectActions, ...rest } = docField;
+            const objectActions = getObjectActions?.();
             return {
                 ...rest,
                 type: 'object',
@@ -230,6 +251,7 @@ function toLocalizedAPIField({
                         delegate,
                         locale
                     }).previewTitle ?? (isListItem ? 'Item' : 'Object'),
+                actions: concatObjectAndFieldActions(objectActions, fieldActions),
                 fields: toLocalizedAPIFields({
                     docFields: fields,
                     delegate,
@@ -243,7 +265,8 @@ function toLocalizedAPIField({
                 const { localized, locales, ...base } = docField;
                 const localeProps = locales && locale ? locales[locale] : undefined;
                 if (localeProps) {
-                    const { fields, getPreview, ...rest } = localeProps;
+                    const { fields, getPreview, getObjectActions, ...rest } = localeProps;
+                    const objectActions = getObjectActions?.();
                     return {
                         ...base,
                         ...rest,
@@ -253,6 +276,7 @@ function toLocalizedAPIField({
                             delegate,
                             locale
                         }).previewTitle,
+                        actions: concatObjectAndFieldActions(objectActions, fieldActions),
                         fields: toLocalizedAPIFields({
                             docFields: fields,
                             delegate,
@@ -264,17 +288,20 @@ function toLocalizedAPIField({
                     ...base,
                     type: 'object', // API uses 'object' not 'model'
                     isUnset: true,
-                    ...localeFields(localized)
+                    ...localeFields(localized),
+                    actions: fieldActions
                 };
             }
             if (docField.isUnset) {
                 return {
                     ...docField,
                     type: 'object', // API uses 'object' not 'model'
-                    ...localeFields(docField.localized)
+                    ...localeFields(docField.localized),
+                    actions: fieldActions
                 };
             } else {
-                const { fields, getPreview, ...rest } = docField;
+                const { fields, getPreview, getObjectActions, ...rest } = docField;
+                const objectActions = getObjectActions?.();
                 return {
                     ...rest,
                     type: 'object', // API uses 'object' not 'model'
@@ -283,6 +310,7 @@ function toLocalizedAPIField({
                         delegate,
                         locale
                     }).previewTitle,
+                    actions: concatObjectAndFieldActions(objectActions, fieldActions),
                     fields: toLocalizedAPIFields({
                         docFields: fields,
                         delegate,
@@ -301,7 +329,8 @@ function toLocalizedAPIField({
                         type: refType === 'asset' ? 'image' : 'object',
                         isUnset: true,
                         ...base,
-                        ...localeFields(localized)
+                        ...localeFields(localized),
+                        actions: fieldActions
                     } as ContentStoreTypes.DocumentObjectFieldAPI | ContentStoreTypes.DocumentImageFieldAPI;
                 }
                 return {
@@ -309,7 +338,8 @@ function toLocalizedAPIField({
                     refType: refType === 'asset' ? 'image' : 'object',
                     ...base,
                     ...localeProps,
-                    ...localeFields(localized)
+                    ...localeFields(localized),
+                    actions: fieldActions
                 };
             }
             const { type, refType, ...base } = docField;
@@ -317,14 +347,16 @@ function toLocalizedAPIField({
                 return {
                     type: refType === 'asset' ? 'image' : 'object',
                     ...base,
-                    ...localeFields(docField.localized)
+                    ...localeFields(docField.localized),
+                    actions: fieldActions
                 };
             }
             return {
                 type: 'unresolved_reference',
                 refType: refType === 'asset' ? 'image' : 'object',
                 ...base,
-                ...localeFields(docField.localized)
+                ...localeFields(docField.localized),
+                actions: fieldActions
             };
         }
         case 'cross-reference': {
@@ -337,7 +369,8 @@ function toLocalizedAPIField({
                         type: 'object',
                         isUnset: true,
                         ...base,
-                        ...localeFields(localized)
+                        ...localeFields(localized),
+                        actions: fieldActions
                     };
                 }
                 return {
@@ -345,7 +378,8 @@ function toLocalizedAPIField({
                     refType: refType,
                     ...base,
                     ...localeProps,
-                    ...localeFields(localized)
+                    ...localeFields(localized),
+                    actions: fieldActions
                 };
             }
             const { type, refType, ...base } = docField;
@@ -353,14 +387,16 @@ function toLocalizedAPIField({
                 return {
                     type: 'object',
                     ...base,
-                    ...localeFields(docField.localized)
+                    ...localeFields(docField.localized),
+                    actions: fieldActions
                 };
             }
             return {
                 type: 'cross-reference',
                 refType: refType,
                 ...base,
-                ...localeFields(docField.localized)
+                ...localeFields(docField.localized),
+                actions: fieldActions
             };
         }
         case 'list': {
@@ -370,6 +406,7 @@ function toLocalizedAPIField({
                 return {
                     ...base,
                     ...localeProps,
+                    actions: fieldActions,
                     items: (localeProps?.items ?? []).map(
                         (field) =>
                             toLocalizedAPIField({
@@ -386,6 +423,7 @@ function toLocalizedAPIField({
             return {
                 ...rest,
                 ...localeFields(docField.localized),
+                actions: fieldActions,
                 items: items.map(
                     (field) =>
                         toLocalizedAPIField({
@@ -498,3 +536,20 @@ function replaceAssetUrlIfNeeded(staticAssetsPublicPath: string, value: string |
     }
     return url;
 }
+
+function concatObjectAndFieldActions(
+    objectActions?: APICustomActionObject[],
+    fieldActions?: APICustomActionField[]
+): (APICustomActionObject | APICustomActionField)[] | undefined {
+    let result: (APICustomActionObject | APICustomActionField)[] = [];
+    if (objectActions) {
+        result = result.concat(objectActions);
+    }
+    if (fieldActions) {
+        result = result.concat(fieldActions);
+    }
+    if (result.length) {
+        return result;
+    }
+    return undefined;
+}

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

@@ -70,16 +70,16 @@ function mapStoreFieldsToCSIFields(documentFields: Record<string, ContentStoreTy
     );
 }
 
-function mapStoreFieldToCSIField<Type extends CSITypes.FieldType>(
+export function mapStoreFieldToCSIField<Type extends CSITypes.FieldType>(
     documentField: ContentStoreTypes.DocumentFieldLocalizedForType<Type>
 ): CSITypes.DocumentFieldLocalizedForType<Type> | undefined;
-function mapStoreFieldToCSIField<Type extends CSITypes.FieldType>(
+export function mapStoreFieldToCSIField<Type extends CSITypes.FieldType>(
     documentField: ContentStoreTypes.DocumentFieldNonLocalizedForType<Type>
 ): CSITypes.DocumentFieldNonLocalizedForType<Type> | undefined;
-function mapStoreFieldToCSIField<Type extends CSITypes.FieldType>(
+export function mapStoreFieldToCSIField<Type extends CSITypes.FieldType>(
     documentField: ContentStoreTypes.DocumentFieldForType<Type>
 ): CSITypes.DocumentFieldForType<Type> | undefined;
-function mapStoreFieldToCSIField(documentField: ContentStoreTypes.DocumentField): CSITypes.DocumentField | undefined {
+export function mapStoreFieldToCSIField(documentField: ContentStoreTypes.DocumentField): CSITypes.DocumentField | undefined {
     switch (documentField.type) {
         case 'string':
         case 'text':