@stackbit/cms-core 0.5.2-develop.3 → 0.5.2

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

@@ -21,29 +21,29 @@ import { getAssetSourceBySourceName, transformAssetSourceDataForAssetSource } fr
 export type CreateDocumentThunk = ({
     updateOperationFields,
     contentSourceData,
-    modelName
+    modelName,
+    locale
 }: {
     updateOperationFields: Record<string, CSITypes.UpdateOperationField>;
     contentSourceData: ContentStoreTypes.ContentSourceData;
     modelName: string;
+    locale: string | undefined;
 }) => Promise<{ documentId: string }>;
 
 export function getCreateDocumentThunk({
     stackbitConfig,
     getContentSourceDataById,
     logger,
-    locale,
     defaultLocaleDocumentId,
     user
 }: {
     stackbitConfig: Config | null;
     getContentSourceDataById: () => Record<string, ContentStoreTypes.ContentSourceData>;
     logger: CSITypes.Logger;
-    locale?: string;
     defaultLocaleDocumentId?: string;
     user?: ContentStoreTypes.User;
 }): CreateDocumentThunk {
-    return async ({ updateOperationFields, modelName, contentSourceData }) => {
+    return async ({ updateOperationFields, modelName, contentSourceData, locale }) => {
         // When passing model and modelMap to contentSourceInstance, we have to pass
         // the original models (i.e., csiModel and csiModelMap) that we've received
         // from that contentSourceInstance. We can't pass internal models as they
@@ -112,18 +112,22 @@ export function getCreateDocumentThunk({
  */
 export async function createDocumentRecursively({
     object,
+    locale,
     modelName,
     contentSourceId,
     contentSourceDataById,
     assetSources,
-    createDocument
+    createDocument,
+    userLogger
 }: {
     object?: Record<string, any>;
+    locale: string | undefined;
     modelName: string;
     contentSourceId: string;
     contentSourceDataById: Record<string, ContentStoreTypes.ContentSourceData>;
     assetSources: CSITypes.AssetSource[];
     createDocument: CreateDocumentThunk;
+    userLogger: CSITypes.Logger;
 }): Promise<{ documentId: string; newRefDocumentIds: string[] }> {
     const contentSourceData = contentSourceDataById[contentSourceId];
     if (!contentSourceData) {
@@ -143,18 +147,21 @@ export async function createDocumentRecursively({
         modelFields,
         csiModelFields,
         fieldPath: [modelName],
+        locale,
         modelMap,
         csiModelMap,
         contentSourceId,
         contentSourceDataById,
         assetSources,
-        createDocument
+        createDocument,
+        userLogger
     });
 
     const result = await createDocument({
         updateOperationFields: nestedResult.fields,
         contentSourceData: contentSourceData,
-        modelName: modelName
+        modelName: modelName,
+        locale: locale
     });
     return {
         documentId: result.documentId,
@@ -174,23 +181,27 @@ async function createObjectRecursively({
     modelFields,
     csiModelFields,
     fieldPath,
+    locale,
     modelMap,
     csiModelMap,
     contentSourceId,
     contentSourceDataById,
     assetSources,
-    createDocument
+    createDocument,
+    userLogger
 }: {
     object?: Record<string, any>;
     modelFields: Field[];
     csiModelFields: Field[];
     fieldPath: (string | number)[];
+    locale: string | undefined;
     modelMap: Record<string, SDKModel>;
     csiModelMap: Record<string, CSIModel>;
     contentSourceId: string;
     contentSourceDataById: Record<string, ContentStoreTypes.ContentSourceData>;
     assetSources: CSITypes.AssetSource[];
     createDocument: CreateDocumentThunk;
+    userLogger: CSITypes.Logger;
 }): Promise<{
     fields: Record<string, CSITypes.UpdateOperationField>;
     newRefDocumentIds: string[];
@@ -217,16 +228,30 @@ async function createObjectRecursively({
             throw new Error(`no model field found for field at path ${fieldPathToString(fieldPath.concat(fieldName))}`);
         }
         let value;
-        if (fieldName in object) {
+        if (modelField.const) {
+            if (fieldName in object && typeof object[fieldName] !== 'undefined') {
+                userLogger.warn(
+                    `got a value for a constant field '${fieldName}' while creating a document, ignoring the provided value, using the 'const' value instead.`
+                );
+                _.pull(objectFieldNames, fieldName);
+            }
+            // if the model field has the "const" property, use its value
+            if (typeof modelField.const === 'function') {
+                value = await modelField.const({ data: object, locale });
+            } else {
+                value = modelField.const;
+            }
+        } else if (fieldName in object) {
             // if the object has a field name matching a model field, use it
             value = object[fieldName];
             _.pull(objectFieldNames, fieldName);
-        } else if (modelField.const) {
-            // if the model field has the "const" property, use its value
-            value = modelField.const;
         } else if (!_.isNil(modelField.default)) {
             // if the model field has the "default" property, use its value
-            value = modelField.default;
+            if (typeof modelField.default === 'function') {
+                value = await modelField.default({ data: object, locale });
+            } else {
+                value = modelField.default;
+            }
         }
         if (!_.isNil(value)) {
             const fieldResult = await createUpdateOperationFieldRecursively({
@@ -234,20 +259,21 @@ async function createObjectRecursively({
                 modelField,
                 csiModelField,
                 fieldPath: fieldPath.concat(fieldName),
+                locale,
                 modelMap,
                 csiModelMap,
                 contentSourceId,
                 contentSourceDataById,
                 assetSources,
-                createDocument
+                createDocument,
+                userLogger
             });
             result.fields[fieldName] = fieldResult.field;
             result.newRefDocumentIds = result.newRefDocumentIds.concat(fieldResult.newRefDocumentIds);
         }
     }
     if (objectFieldNames.length > 0) {
-        //TODO use logger
-        console.error(`no model fields found when creating a document with fields: '${objectFieldNames.join(', ')}'`);
+        userLogger.warn(`unknown fields were provided while creating a document, ignoring unknown fields: '${objectFieldNames.join(', ')}'`);
     }
 
     return result;
@@ -258,23 +284,27 @@ async function createUpdateOperationFieldRecursively({
     modelField,
     csiModelField,
     fieldPath,
+    locale,
     modelMap,
     csiModelMap,
     contentSourceId,
     contentSourceDataById,
     assetSources,
-    createDocument
+    createDocument,
+    userLogger
 }: {
     value: any;
     modelField: FieldSpecificProps;
     csiModelField: FieldSpecificProps;
     fieldPath: (string | number)[];
+    locale: string | undefined;
     modelMap: Record<string, SDKModel>;
     csiModelMap: Record<string, CSIModel>;
     contentSourceId: string;
     contentSourceDataById: Record<string, ContentStoreTypes.ContentSourceData>;
     assetSources: CSITypes.AssetSource[];
     createDocument: CreateDocumentThunk;
+    userLogger: CSITypes.Logger;
 }): Promise<{ field: CSITypes.UpdateOperationField; newRefDocumentIds: string[] }> {
     if (csiModelField.type === 'object') {
         if (modelField.type !== 'object') {
@@ -285,12 +315,14 @@ async function createUpdateOperationFieldRecursively({
             modelFields: modelField.fields,
             csiModelFields: csiModelField.fields,
             fieldPath,
+            locale,
             modelMap,
             csiModelMap,
             contentSourceId,
             contentSourceDataById,
             assetSources,
-            createDocument
+            createDocument,
+            userLogger
         });
         return {
             field: {
@@ -325,12 +357,14 @@ async function createUpdateOperationFieldRecursively({
             modelFields: model.fields ?? [],
             csiModelFields: csiModel.fields ?? [],
             fieldPath,
+            locale,
             modelMap,
             csiModelMap,
             contentSourceId,
             contentSourceDataById,
             assetSources,
-            createDocument
+            createDocument,
+            userLogger
         });
         return {
             field: {
@@ -416,11 +450,13 @@ async function createUpdateOperationFieldRecursively({
             }
             const { documentId, newRefDocumentIds } = await createDocumentRecursively({
                 object: rest,
+                locale,
                 modelName,
                 contentSourceId,
                 contentSourceDataById,
                 assetSources,
-                createDocument
+                createDocument,
+                userLogger
             });
             return {
                 field: {
@@ -457,11 +493,13 @@ async function createUpdateOperationFieldRecursively({
             }
             const { documentId, newRefDocumentIds } = await createDocumentRecursively({
                 object: rest,
+                locale,
                 modelName,
                 contentSourceId: getContentSourceId(refSrcType, refProjectId),
                 contentSourceDataById,
                 assetSources,
-                createDocument
+                createDocument,
+                userLogger
             });
             _newRefDocumentIds.push(documentId, ...newRefDocumentIds);
             refObject = { refId: documentId, refSrcType, refProjectId };
@@ -488,12 +526,14 @@ async function createUpdateOperationFieldRecursively({
                 modelField: itemsField,
                 csiModelField: csiItemsField,
                 fieldPath: fieldPath.concat(index),
+                locale,
                 modelMap,
                 csiModelMap,
                 contentSourceId,
                 contentSourceDataById,
                 assetSources,
-                createDocument
+                createDocument,
+                userLogger
             });
             if (result.field.type === 'list') {
                 throw new Error('list cannot have list as immediate child');
@@ -551,23 +591,27 @@ export async function convertOperationField({
     fieldPath,
     modelField,
     csiModelField,
+    locale,
     modelMap,
     csiModelMap,
     contentSourceId,
     contentSourceDataById,
     assetSources,
-    createDocument
+    createDocument,
+    userLogger
 }: {
     operationField: ContentStoreTypes.UpdateOperationField;
     fieldPath: (string | number)[];
     modelField: FieldSpecificProps;
     csiModelField: FieldSpecificProps;
+    locale: string | undefined;
     modelMap: Record<string, SDKModel>;
     csiModelMap: Record<string, SDKModel>;
     contentSourceId: string;
     contentSourceDataById: Record<string, ContentStoreTypes.ContentSourceData>;
     assetSources: CSITypes.AssetSource[];
     createDocument: CreateDocumentThunk;
+    userLogger: CSITypes.Logger;
 }): Promise<CSITypes.UpdateOperationField> {
     switch (operationField.type) {
         case 'object': {
@@ -579,12 +623,14 @@ export async function convertOperationField({
                 modelFields: modelField.fields,
                 csiModelFields: csiModelField.fields,
                 fieldPath,
+                locale,
                 modelMap,
                 csiModelMap,
                 contentSourceId,
                 contentSourceDataById,
                 assetSources,
-                createDocument
+                createDocument,
+                userLogger
             });
             return {
                 type: operationField.type,
@@ -602,12 +648,14 @@ export async function convertOperationField({
                 modelFields: model.fields ?? [],
                 csiModelFields: csiModel.fields ?? [],
                 fieldPath,
+                locale,
                 modelMap,
                 csiModelMap,
                 contentSourceId,
                 contentSourceDataById,
                 assetSources,
-                createDocument
+                createDocument,
+                userLogger
             });
             return {
                 type: operationField.type,
@@ -645,12 +693,14 @@ export async function convertOperationField({
                         modelField: modelField.items,
                         csiModelField: csiModelField.items,
                         fieldPath: fieldPath.concat(index),
+                        locale,
                         modelMap,
                         csiModelMap,
                         contentSourceId,
                         contentSourceDataById,
                         assetSources,
-                        createDocument
+                        createDocument,
+                        userLogger
                     });
                     if (result.field.type === 'list') {
                         throw new Error('list cannot have list as immediate child');
@@ -702,12 +752,14 @@ export async function convertOperationField({
                 modelField,
                 csiModelField,
                 fieldPath,
+                locale,
                 modelMap,
                 csiModelMap,
                 contentSourceId,
                 contentSourceDataById,
                 assetSources,
-                createDocument
+                createDocument,
+                userLogger
             });
             return result.field;
         }