@stackbit/cms-core 0.8.4-develop.1 → 0.8.4-develop.2

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

@@ -34,6 +34,7 @@ function documentToLocalizedApiObject({
 }): ContentStoreTypes.APIDocumentObject {
     const { type, fields, getPreview, getDocumentActions, ...rest } = document;
     return omitByUndefined({
+        // for historical reasons, stackbit app works with { type: 'object' } not { type: 'document' }
         type: 'object',
         ...rest,
         srcObjectLabel: getPreview({ delegate, locale }).previewTitle,
@@ -62,6 +63,42 @@ function toLocalizedAPIFields({
     });
 }
 
+/**
+ * For historical reasons, Stackit app works with fields that can have only one
+ * locale. When Stackbit app fetches documents, it passes the current locale.
+ * This function converts the internal document field (DocumentField), possibly
+ * with nested locales, into an API field (DocumentFieldAPI) with single locale.
+ *
+ * DocumentField:
+ * {
+ *   type: "string",
+ *   localized: true,
+ *   locales: {
+ *       'en-US': {
+ *           locale: 'en-US',
+ *           value: 'hello
+ *       },
+ *       'fr-FR': {
+ *           locale: 'fr-FR',
+ *           valie: 'bonjour'
+ *       }
+ *   }
+ * }
+ *
+ * DocumentFieldAPI:
+ * {
+ *   type: "string",
+ *   localized: true,
+ *   locale: 'fr-FR',
+ *   value: 'bonjour'
+ * }
+ *
+ * It also does some conversions between field types:
+ * type: 'model' => 'object',
+ * type: 'reference' => 'unresolved_reference',
+ * refType: 'asset' => 'image'
+ * refType: 'document' => 'object'
+ */
 function toLocalizedAPIField({
     docField,
     delegate,
@@ -542,12 +579,12 @@ function concatObjectAndFieldActions(
     fieldActions?: APICustomActionField[]
 ): (APICustomActionObject | APICustomActionField)[] | undefined {
     let result: (APICustomActionObject | APICustomActionField)[] = [];
-    if (objectActions) {
-        result = result.concat(objectActions);
-    }
     if (fieldActions) {
         result = result.concat(fieldActions);
     }
+    if (objectActions) {
+        result = result.concat(objectActions);
+    }
     if (result.length) {
         return result;
     }