@stackbit/cms-core 0.2.1 → 0.3.0-develop.1

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

@@ -17,7 +17,7 @@ export type CreateDocumentCallback = ({
     updateOperationFields: Record<string, CSITypes.UpdateOperationField>;
     contentSourceData: ContentStoreTypes.ContentSourceData;
     modelName: string;
-}) => Promise<CSITypes.Document>;
+}) => Promise<{ documentId: string }>;
 
 export function getCreateDocumentThunk({
     locale,
@@ -84,8 +84,8 @@ export function getCreateDocumentThunk({
  *
  * Returns an object with two fields:
  * 1. `document` holding the created CSITypes.Document for the passed object.
- * 2. `newRefDocuments` holding list of created CSITypes.Document that were
- *    created recursively for `reference` fields having the `$$type` property.
+ * 2. `newRefDocumentIds` containing the list of the created document IDs that
+ *    were created recursively for `reference` fields having the `$$type` property.
  */
 export async function createDocumentRecursively({
     object,
@@ -99,7 +99,7 @@ export async function createDocumentRecursively({
     contentSourceId: string;
     contentSourceDataById: Record<string, ContentStoreTypes.ContentSourceData>;
     createDocument: CreateDocumentCallback;
-}): Promise<{ document: CSITypes.Document; newRefDocuments: CSITypes.Document[] }> {
+}): Promise<{ documentId: string; newRefDocumentIds: string[] }> {
     const contentSourceData = contentSourceDataById[contentSourceId];
     if (!contentSourceData) {
         throw new Error(`no content source data for id '${contentSourceId}'`);
@@ -145,14 +145,14 @@ export async function createDocumentRecursively({
         createDocument
     });
 
-    const document = await createDocument({
+    const result = await createDocument({
         updateOperationFields: nestedResult.fields,
         contentSourceData: contentSourceData,
         modelName: modelName
     });
     return {
-        document: document,
-        newRefDocuments: nestedResult.newRefDocuments
+        documentId: result.documentId,
+        newRefDocumentIds: nestedResult.newRefDocumentIds
     };
 }
 
@@ -188,15 +188,15 @@ async function createObjectRecursively({
     createDocument: CreateDocumentCallback;
 }): Promise<{
     fields: Record<string, CSITypes.UpdateOperationField>;
-    newRefDocuments: CSITypes.Document[];
+    newRefDocumentIds: string[];
 }> {
     object = object ?? {};
     const result: {
         fields: Record<string, CSITypes.UpdateOperationField>;
-        newRefDocuments: CSITypes.Document[];
+        newRefDocumentIds: string[];
     } = {
         fields: {},
-        newRefDocuments: []
+        newRefDocumentIds: []
     };
     // When creating new documents, we are iterating over the model's fields to
     // construct the update operations. In case object has a field that does not
@@ -236,7 +236,7 @@ async function createObjectRecursively({
                 createDocument
             });
             result.fields[fieldName] = fieldResult.field;
-            result.newRefDocuments = result.newRefDocuments.concat(fieldResult.newRefDocuments);
+            result.newRefDocumentIds = result.newRefDocumentIds.concat(fieldResult.newRefDocumentIds);
         }
     }
     if (objectFieldNames.length > 0) {
@@ -267,7 +267,7 @@ async function createUpdateOperationFieldRecursively({
     contentSourceId: string;
     contentSourceDataById: Record<string, ContentStoreTypes.ContentSourceData>;
     createDocument: CreateDocumentCallback;
-}): Promise<{ field: CSITypes.UpdateOperationField; newRefDocuments: CSITypes.Document[] }> {
+}): Promise<{ field: CSITypes.UpdateOperationField; newRefDocumentIds: string[] }> {
     if (csiModelField.type === 'object') {
         if (modelField.type !== 'object') {
             throw new Error(`field type mismatch between content-source and mapped models at field path ${fieldPathToString(fieldPath)}`);
@@ -288,7 +288,7 @@ async function createUpdateOperationFieldRecursively({
                 type: 'object',
                 fields: result.fields
             },
-            newRefDocuments: result.newRefDocuments
+            newRefDocumentIds: result.newRefDocumentIds
         };
     } else if (csiModelField.type === 'model') {
         if (modelField.type !== 'model') {
@@ -328,7 +328,7 @@ async function createUpdateOperationFieldRecursively({
                 modelName: modelName,
                 fields: result.fields
             },
-            newRefDocuments: result.newRefDocuments
+            newRefDocumentIds: result.newRefDocumentIds
         };
     } else if (csiModelField.type === 'image') {
         let refId: string | undefined;
@@ -338,7 +338,7 @@ async function createUpdateOperationFieldRecursively({
                     type: 'image',
                     value: _.omit(value, ['$$type']) // backwards compatibility with legacy presets
                 },
-                newRefDocuments: []
+                newRefDocumentIds: []
             };
         }
         if (_.isPlainObject(value)) {
@@ -355,7 +355,7 @@ async function createUpdateOperationFieldRecursively({
                 refType: 'asset',
                 refId: refId
             },
-            newRefDocuments: []
+            newRefDocumentIds: []
         };
     } else if (csiModelField.type === 'reference') {
         if (modelField.type !== 'reference') {
@@ -369,7 +369,7 @@ async function createUpdateOperationFieldRecursively({
                     refType: 'document',
                     refId: refId
                 },
-                newRefDocuments: []
+                newRefDocumentIds: []
             };
         } else {
             const modelNames = modelField.models;
@@ -386,7 +386,7 @@ async function createUpdateOperationFieldRecursively({
             if (!modelName) {
                 throw new Error('reference field type must have $$type or $$ref properties when creating new documents');
             }
-            const { document, newRefDocuments } = await createDocumentRecursively({
+            const { documentId, newRefDocumentIds } = await createDocumentRecursively({
                 object: rest,
                 modelName,
                 contentSourceId,
@@ -397,9 +397,9 @@ async function createUpdateOperationFieldRecursively({
                 field: {
                     type: 'reference',
                     refType: 'document',
-                    refId: document.id
+                    refId: documentId
                 },
-                newRefDocuments: [document, ...newRefDocuments]
+                newRefDocumentIds: [documentId, ...newRefDocumentIds]
             };
         }
     } else if (
@@ -411,7 +411,7 @@ async function createUpdateOperationFieldRecursively({
         }
         let { $$ref: refId = null, $$type: modelName = null, $$refSrcType: refSrcType = null, $$refProjectId: refProjectId = null, ...rest } = value;
         let refObject;
-        const newRefDocuments: CSITypes.Document[] = [];
+        const _newRefDocumentIds: string[] = [];
         if (refId && refSrcType && refProjectId) {
             refObject = { refId, refSrcType, refProjectId };
         } else {
@@ -426,19 +426,19 @@ async function createUpdateOperationFieldRecursively({
             if (!modelName || !refSrcType || !refProjectId) {
                 throw new Error('reference field type must have $$type or $$ref properties when creating new documents');
             }
-            const { document, newRefDocuments } = await createDocumentRecursively({
+            const { documentId, newRefDocumentIds } = await createDocumentRecursively({
                 object: rest,
                 modelName,
                 contentSourceId: getContentSourceId(refSrcType, refProjectId),
                 contentSourceDataById,
                 createDocument
             });
-            newRefDocuments.push(document, ...newRefDocuments);
-            refObject = { refId: document.id, refSrcType, refProjectId };
+            _newRefDocumentIds.push(documentId, ...newRefDocumentIds);
+            refObject = { refId: documentId, refSrcType, refProjectId };
         }
         return {
             field: updateOperationValueFieldWithCrossReference(csiModelField.type, refObject),
-            newRefDocuments
+            newRefDocumentIds: _newRefDocumentIds
         };
     } else if (csiModelField.type === 'list') {
         if (modelField.type !== 'list') {
@@ -452,35 +452,32 @@ async function createUpdateOperationFieldRecursively({
         if (!itemsField || !csiItemsField) {
             throw new Error(`list field does not define items`);
         }
-        const arrayResult = await mapPromise(
-            value,
-            async (item, index): Promise<{ field: UpdateOperationListFieldItem; newRefDocuments: CSITypes.Document[] }> => {
-                const result = await createUpdateOperationFieldRecursively({
-                    value: item,
-                    modelField: itemsField,
-                    csiModelField: csiItemsField,
-                    fieldPath: fieldPath.concat(index),
-                    modelMap,
-                    csiModelMap,
-                    contentSourceId,
-                    contentSourceDataById,
-                    createDocument
-                });
-                if (result.field.type === 'list') {
-                    throw new Error('list cannot have list as immediate child');
-                }
-                return {
-                    field: result.field,
-                    newRefDocuments: result.newRefDocuments
-                };
+        const arrayResult = await mapPromise(value, async (item, index): Promise<{ field: UpdateOperationListFieldItem; newRefDocumentIds: string[] }> => {
+            const result = await createUpdateOperationFieldRecursively({
+                value: item,
+                modelField: itemsField,
+                csiModelField: csiItemsField,
+                fieldPath: fieldPath.concat(index),
+                modelMap,
+                csiModelMap,
+                contentSourceId,
+                contentSourceDataById,
+                createDocument
+            });
+            if (result.field.type === 'list') {
+                throw new Error('list cannot have list as immediate child');
             }
-        );
+            return {
+                field: result.field,
+                newRefDocumentIds: result.newRefDocumentIds
+            };
+        });
         return {
             field: {
                 type: 'list',
                 items: arrayResult.map((result) => result.field)
             },
-            newRefDocuments: arrayResult.reduce((result: CSITypes.Document[], { newRefDocuments }) => result.concat(newRefDocuments), [])
+            newRefDocumentIds: arrayResult.reduce((result: string[], { newRefDocumentIds }) => result.concat(newRefDocumentIds), [])
         };
     } else if (
         (csiModelField.type === 'string' || csiModelField.type === 'text') &&
@@ -492,7 +489,7 @@ async function createUpdateOperationFieldRecursively({
                 type: csiModelField.type,
                 value: JSON.stringify(value)
             },
-            newRefDocuments: []
+            newRefDocumentIds: []
         };
     }
     return {
@@ -500,7 +497,7 @@ async function createUpdateOperationFieldRecursively({
             type: csiModelField.type,
             value: value
         },
-        newRefDocuments: []
+        newRefDocumentIds: []
     };
 }