@stackbit/cms-contentstack 0.2.4-staging.1 → 0.2.4-staging.3

package/src/contentstack-schema-converter.ts

@@ -69,12 +69,19 @@ export function convertLocales({
     return locales;
 }
 
-export function convertModels({ contentStackModels }: { contentStackModels: (ContentType | GlobalField)[] }): ModelWithContext[] {
+export function convertModels({
+    contentStackModels,
+    cloudinaryExtensionUID
+}: {
+    contentStackModels: (ContentType | GlobalField)[];
+    cloudinaryExtensionUID: string | undefined;
+}): ModelWithContext[] {
     const modelsToClone: CloneModelOptions[] = [];
     const models = contentStackModels.reduce((stackbitModels: ModelWithContext[], contentStackModel) => {
         const blockModels: ModelWithContext[] = [];
         const stackbitModel = convertModel({
             contentStackModel: contentStackModel,
+            cloudinaryExtensionUID,
             addBlockModel: (model: ModelWithContext) => {
                 blockModels.push(model);
             },
@@ -117,11 +124,13 @@ export function convertModels({ contentStackModels }: { contentStackModels: (Con
 
 function convertModel({
     contentStackModel,
+    cloudinaryExtensionUID,
     addBlockModel,
     cloneModel,
     referencedIn
 }: {
     contentStackModel: ContentType | GlobalField;
+    cloudinaryExtensionUID: string | undefined;
     addBlockModel: AddBlockModel;
     cloneModel: CloneModel;
     referencedIn?: ReferencedIn;
@@ -140,6 +149,7 @@ function convertModel({
             parentModelName: contentStackModel.uid,
             isNested: !!referencedIn,
             fieldPath: [],
+            cloudinaryExtensionUID,
             addBlockMap: ({ blockFieldPath, modelName, blockUID }) => {
                 if (!blockMap[blockFieldPath]) {
                     blockMap[blockFieldPath] = {
@@ -168,6 +178,7 @@ function convertFields(options: {
     parentModelName: string;
     isNested: boolean;
     fieldPath: string[];
+    cloudinaryExtensionUID: string | undefined;
     addBlockMap: AddBlockMap;
     addBlockModel: AddBlockModel;
     cloneModel: CloneModel;
@@ -187,6 +198,7 @@ function convertField({
     parentModelName,
     isNested,
     fieldPath,
+    cloudinaryExtensionUID,
     addBlockMap,
     addBlockModel,
     cloneModel
@@ -195,6 +207,7 @@ function convertField({
     parentModelName: string;
     isNested: boolean;
     fieldPath: string[];
+    cloudinaryExtensionUID: string | undefined;
     addBlockMap: AddBlockMap;
     addBlockModel: AddBlockModel;
     cloneModel: CloneModel;
@@ -238,6 +251,27 @@ function convertField({
                 return toFieldOrListField(field, {
                     type: 'richText'
                 });
+            } else if (field.field_metadata.extension && field.extension_uid === cloudinaryExtensionUID) {
+                // In Contentstack, custom Cloudinary images are always stored in arrays.
+                // If the custom cloudinary field is configured with "advanced.max_limit: 1",
+                // then treat it as a regular 'image' field. Otherwise, treat it as list of images.
+                const cloudinaryImageProps = {
+                    type: 'image',
+                    source: 'cloudinary'
+                } as const;
+                if (field.config?.advanced?.max_limit === 1) {
+                    const commonProps = getStackbitFieldPropsFromContentStackField(field, false);
+                    return {
+                        ...cloudinaryImageProps,
+                        ...commonProps
+                    };
+                }
+                const commonProps = getStackbitFieldPropsFromContentStackField(field, true);
+                return {
+                    type: 'list',
+                    ...commonProps,
+                    items: cloudinaryImageProps
+                };
             }
             return toFieldOrListField(field, {
                 type: 'json'
@@ -309,6 +343,7 @@ function convertField({
                     parentModelName: parentModelName,
                     isNested,
                     fieldPath,
+                    cloudinaryExtensionUID,
                     addBlockMap,
                     addBlockModel,
                     cloneModel
@@ -351,6 +386,7 @@ function convertField({
                             } as GlobalField;
                             const blockModel = convertModel({
                                 contentStackModel,
+                                cloudinaryExtensionUID,
                                 addBlockModel,
                                 cloneModel,
                                 referencedIn: {

package/src/contentstack-types.ts

@@ -1,5 +1,6 @@
 import type { Stack as ContentStackStack } from '@contentstack/management/types/stack';
 import type { User as ContentStackUser } from '@contentstack/management/types/user';
+import type { Extension as ContentStackExtension } from '@contentstack/management/types/stack/extension';
 import type { ContentType as ContentStackContentType } from '@contentstack/management/types/stack/contentType';
 import type { GlobalField as ContentStackGlobalField } from '@contentstack/management/types/stack/globalField';
 import type { Environment as ContentStackEnvironment } from '@contentstack/management/types/stack/environment';
@@ -34,6 +35,30 @@ export type User = ContentStackUser & {
     active?: boolean;
 };
 
+// Extensions
+// ==========
+
+export type Extension = ContentStackExtension & {
+    uid: string;
+    urlPath?: string;
+    // e.g.: "Cloudinary"
+    title?: string;
+    app_installation_uid?: string;
+    app_uid?: string;
+    config?: any;
+    // e.g.: "field"
+    type?: string;
+    // e.g.: "json"
+    data_type?: string;
+    multiple?: boolean;
+    src?: string;
+    created_at?: string;
+    updated_at?: string;
+    signed?: boolean;
+    _version?: number;
+    _branch?: string;
+};
+
 // Models
 // ======
 
@@ -104,11 +129,17 @@ export type ContentStackFieldCommon = {
     multiple: boolean;
     non_localizable: boolean;
     unique: boolean;
+    // extension uid (custom field id)
+    extension_uid?: string;
+    // extension config (custom field config)
+    config?: any;
     field_metadata: {
         description?: string;
         placeholder?: string;
         instruction?: string;
         default_value?: any;
+        // extension => custom field
+        extension?: boolean;
     };
 };