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

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

@@ -0,0 +1,441 @@
+import _ from 'lodash';
+import { omitByUndefined } from '@stackbit/utils';
+import * as CSITypes from '@stackbit/types';
+import * as ContentStoreTypes from '../types';
+import { getContentSourceId, getDocumentFieldForLocale } from '../content-store-utils';
+
+export function mapDocumentsToApiDocuments({
+    documents,
+    allowedLocales,
+    contentSourceDataById,
+    delegate
+}: {
+    documents: ContentStoreTypes.Document[];
+    allowedLocales?: string[];
+    contentSourceDataById: Record<string, ContentStoreTypes.ContentSourceData>;
+    delegate: CSITypes.ConfigDelegate;
+}): ContentStoreTypes.APIDocument[] {
+    return documents.map((document) =>
+        documentToApiV2Object({
+            document,
+            allowedLocales,
+            contentSourceDataById,
+            delegate
+        })
+    );
+}
+
+function documentToApiV2Object({
+    document,
+    allowedLocales,
+    contentSourceDataById,
+    delegate
+}: {
+    document: ContentStoreTypes.Document;
+    allowedLocales?: string[];
+    contentSourceDataById: Record<string, ContentStoreTypes.ContentSourceData>;
+    delegate: CSITypes.ConfigDelegate;
+}): ContentStoreTypes.APIDocument {
+    const { fields, getPreview, ...rest } = document;
+    return omitByUndefined({
+        ..._.omit(rest),
+        srcObjectLabel: getPreview({ delegate /*, locale*/ }).previewTitle,
+        fields: toAPIV2Fields({
+            docFields: fields,
+            delegate,
+            allowedLocales,
+            contentSourceDataById,
+            contentSourceId: getContentSourceId(document.srcType, document.srcProjectId)
+        })
+    });
+}
+
+function toAPIV2Fields({
+    docFields,
+    delegate,
+    contentSourceDataById,
+    contentSourceId,
+    allowedLocales
+}: {
+    docFields: Record<string, ContentStoreTypes.DocumentField>;
+    delegate: CSITypes.ConfigDelegate;
+    contentSourceDataById: Record<string, ContentStoreTypes.ContentSourceData>;
+    contentSourceId: string;
+    allowedLocales?: string[];
+}): Record<string, ContentStoreTypes.DocumentFieldAPIV2> {
+    return _.mapValues(docFields, (docField) => {
+        return omitByUndefined(
+            toAPIV2Field({
+                docField,
+                delegate,
+                contentSourceDataById,
+                contentSourceId,
+                allowedLocales
+            })
+        );
+    });
+}
+
+function toAPIV2Field({
+    docField,
+    delegate,
+    contentSourceDataById,
+    contentSourceId,
+    allowedLocales,
+    isListItem = false
+}: {
+    docField: ContentStoreTypes.DocumentField;
+    delegate: CSITypes.ConfigDelegate;
+    allowedLocales?: string[];
+    contentSourceDataById: Record<string, ContentStoreTypes.ContentSourceData>;
+    contentSourceId: string;
+    isListItem?: boolean;
+}): ContentStoreTypes.DocumentFieldAPIV2 {
+    // TODO: reduce over allowedLocales rather then existing locales - use isUnset, and add fieldActions even for missing locales
+    switch (docField.type) {
+        case 'string':
+        case 'text':
+        case 'url':
+        case 'slug':
+        case 'html':
+        case 'number':
+        case 'boolean':
+        case 'enum':
+        case 'date':
+        case 'datetime':
+        case 'color':
+        case 'style':
+        case 'json':
+        case 'file':
+        case 'markdown':
+        case 'richText': {
+            if (docField.localized) {
+                const locales = _.reduce(
+                    docField.locales,
+                    (acc, cur, locale) => {
+                        acc[locale] = cur;
+                        return acc;
+                    },
+                    {} as ContentStoreTypes.DocumentFieldLocalizedAPIV2['locales']
+                );
+
+                return {
+                    ...docField,
+                    locales
+                } as ContentStoreTypes.DocumentFieldLocalizedAPIV2;
+            }
+
+            return docField;
+        }
+        case 'image': {
+            if (docField.localized) {
+                const locales = _.reduce(
+                    docField.locales,
+                    (acc, cur, locale) => {
+                        acc[locale] = {
+                            ...cur,
+                            fields: toAPIV2Fields({
+                                docFields: cur.fields,
+                                delegate,
+                                contentSourceDataById,
+                                contentSourceId,
+                                allowedLocales
+                            }) as ContentStoreTypes.ImageFieldsAPIV2
+                        };
+                        return acc;
+                    },
+                    {} as ContentStoreTypes.DocumentImageFieldLocalizedAPIV2['locales']
+                );
+
+                return {
+                    ...docField,
+                    locales
+                } as ContentStoreTypes.DocumentFieldLocalizedAPIV2;
+            }
+
+            if (docField.isUnset) {
+                return docField;
+            }
+
+            return {
+                ...docField,
+                fields: toAPIV2Fields({
+                    docFields: docField.fields,
+                    delegate,
+                    contentSourceDataById,
+                    contentSourceId,
+                    allowedLocales
+                }) as ContentStoreTypes.ImageFieldsAPIV2
+            };
+        }
+        case 'object': {
+            if (docField.localized) {
+                const locales = _.reduce(
+                    docField.locales,
+                    (acc, cur) => {
+                        const { fields, getPreview, locale } = cur;
+                        acc[locale] = {
+                            ...cur,
+                            srcObjectLabel:
+                                getPreview({
+                                    delegate,
+                                    locale
+                                }).previewTitle ?? (isListItem ? 'Item' : 'Object'),
+                            fields: toAPIV2Fields({
+                                docFields: fields,
+                                delegate,
+                                contentSourceDataById,
+                                contentSourceId,
+                                allowedLocales
+                            })
+                        };
+                        return acc;
+                    },
+                    {} as ContentStoreTypes.DocumentObjectFieldLocalizedAPIV2['locales']
+                );
+
+                return {
+                    ...docField,
+                    locales
+                };
+            }
+
+            // TODO: what about unset locales? what if there is an action that generates content for an empty object?
+            if (docField.isUnset) {
+                return docField;
+            }
+
+            const { fields, getPreview, ...rest } = docField;
+            return {
+                ...rest,
+                srcObjectLabel: getPreview({ delegate }).previewTitle ?? (isListItem ? 'Item' : 'Object'),
+                fields: toAPIV2Fields({
+                    docFields: fields,
+                    delegate,
+                    contentSourceDataById,
+                    contentSourceId,
+                    allowedLocales
+                })
+            };
+        }
+        case 'model': {
+            // TODO: merge with object
+            if (docField.localized) {
+                const locales = _.reduce(
+                    docField.locales,
+                    (acc, cur) => {
+                        const { fields, getPreview, locale } = cur;
+                        acc[locale] = {
+                            ...cur,
+                            srcObjectLabel: getPreview({
+                                delegate,
+                                locale
+                            }).previewTitle,
+                            fields: toAPIV2Fields({
+                                docFields: fields,
+                                delegate,
+                                contentSourceDataById,
+                                contentSourceId,
+                                allowedLocales
+                            })
+                        };
+                        return acc;
+                    },
+                    {} as ContentStoreTypes.DocumentModelFieldLocalizedAPIV2['locales']
+                );
+
+                return {
+                    ...docField,
+                    locales
+                };
+            }
+
+            // TODO: what about unset locales? what if there is an action that generates content for an empty object?
+            if (docField.isUnset) {
+                return docField;
+            }
+
+            const { fields, getPreview, ...rest } = docField;
+            return {
+                ...rest,
+                srcObjectLabel: getPreview({ delegate }).previewTitle,
+                fields: toAPIV2Fields({
+                    docFields: fields,
+                    delegate,
+                    contentSourceDataById,
+                    contentSourceId,
+                    allowedLocales
+                })
+            };
+        }
+        case 'reference': {
+            if (docField.localized) {
+                const refField = docField;
+                const locales = _.reduce(
+                    docField.locales,
+                    (acc, cur, locale) => {
+                        acc[locale] = {
+                            ...cur,
+                            ...populateReferenceLabels({
+                                docField: refField,
+                                contentSourceDataById,
+                                contentSourceId,
+                                locale: locale,
+                                delegate
+                            })
+                        };
+                        return acc;
+                    },
+                    {} as ContentStoreTypes.DocumentReferenceFieldLocalizedAPIV2['locales']
+                );
+
+                return {
+                    ...docField,
+                    locales
+                };
+            }
+
+            return {
+                ...docField,
+                ...populateReferenceLabels({ docField, contentSourceDataById, contentSourceId, delegate })
+            };
+        }
+        case 'cross-reference': {
+            // todo: unify with reference using helper methods
+            if (docField.localized) {
+                const refField = docField;
+                const locales = _.reduce(
+                    docField.locales,
+                    (acc, cur, locale) => {
+                        acc[locale] = {
+                            ...cur,
+                            ...populateReferenceLabels({
+                                docField: refField,
+                                contentSourceDataById,
+                                contentSourceId,
+                                locale: locale,
+                                delegate
+                            })
+                        };
+                        return acc;
+                    },
+                    {} as ContentStoreTypes.DocumentCrossReferenceFieldLocalizedAPIV2['locales']
+                );
+
+                return {
+                    ...docField,
+                    locales
+                };
+            }
+
+            return {
+                ...docField,
+                ...populateReferenceLabels({ docField, contentSourceDataById, contentSourceId, delegate })
+            };
+        }
+        case 'list': {
+            if (docField.localized) {
+                const locales = _.reduce(
+                    docField.locales,
+                    (acc, cur, locale) => {
+                        acc[locale] = {
+                            ...cur,
+                            items: (cur.items ?? []).map(
+                                (field) =>
+                                    toAPIV2Field({
+                                        docField: field,
+                                        contentSourceDataById,
+                                        contentSourceId,
+                                        delegate,
+                                        allowedLocales,
+                                        isListItem: true
+                                    }) as ContentStoreTypes.DocumentListFieldItemsAPIV2
+                            )
+                        };
+                        return acc;
+                    },
+                    {} as ContentStoreTypes.DocumentListFieldLocalizedAPIV2['locales']
+                );
+
+                return {
+                    ...docField,
+                    locales
+                };
+            }
+
+            const { items, ...rest } = docField;
+            return {
+                ...rest,
+                items: items.map(
+                    (field) =>
+                        toAPIV2Field({
+                            docField: field,
+                            delegate,
+                            contentSourceDataById,
+                            contentSourceId,
+                            allowedLocales,
+                            isListItem: true
+                        }) as ContentStoreTypes.DocumentListFieldItemsAPIV2
+                )
+            };
+        }
+        default: {
+            const _exhaustiveCheck: never = docField;
+            console.error(`toLocalizedAPIField _exhaustiveCheck failed, docField.type: ${docField['type']}`);
+            return _exhaustiveCheck;
+        }
+    }
+}
+
+function populateReferenceLabels({
+    docField,
+    locale,
+    contentSourceDataById,
+    contentSourceId,
+    delegate
+}: {
+    docField: ContentStoreTypes.DocumentReferenceField | ContentStoreTypes.DocumentCrossReferenceField;
+    locale?: string;
+    contentSourceDataById: Record<string, ContentStoreTypes.ContentSourceData>;
+    contentSourceId: string;
+    delegate: CSITypes.ConfigDelegate;
+}) {
+    const refField = getDocumentFieldForLocale(docField, locale);
+    if (!refField || refField?.isUnset) {
+        return {};
+    }
+
+    if (refField.type === 'reference') {
+        if (refField.refType === 'document') {
+            const document = contentSourceDataById[contentSourceId]?.documentMap[refField.refId];
+            if (document) {
+                return { srcObjectLabel: document?.getPreview({ delegate }).previewTitle, srcModelLabel: document?.srcModelLabel, isMissing: false };
+            }
+        } else if (refField.refType === 'asset') {
+            const asset = contentSourceDataById[contentSourceId]?.assetMap[refField.refId];
+            if (asset) {
+                return { srcObjectLabel: asset.srcObjectLabel, srcModelLabel: asset.srcModelLabel, isMissing: false };
+            }
+        }
+    } else if (refField?.type === 'cross-reference') {
+        const srcId = getContentSourceId(refField.refSrcType, refField.refProjectId);
+        if (refField.refType === 'document') {
+            const document = contentSourceDataById[srcId]?.documentMap[refField.refId];
+            if (document) {
+                return {
+                    refObjectLabel: document?.getPreview({ delegate }).previewTitle,
+                    refModelLabel: document?.srcModelLabel,
+                    refModelName: document?.srcModelName,
+                    isMissing: false
+                };
+            }
+        } else if (refField.refType === 'asset') {
+            const asset = contentSourceDataById[srcId]?.assetMap[refField.refId];
+            if (asset) {
+                return { refObjectLabel: asset.srcObjectLabel, refModelLabel: asset.srcModelLabel, refModelName: asset?.srcModelName, isMissing: false };
+            }
+        }
+    }
+
+    return { isMissing: true };
+}

package/dist/utils/file-cache.d.ts

@@ -1,13 +0,0 @@
-export declare class FileCache {
-    private readonly dirPath;
-    private readonly keyPrefix;
-    constructor({ dirPath, keyPrefix }: {
-        dirPath: string;
-        keyPrefix?: string;
-    });
-    get(key: string): Promise<unknown>;
-    set(key: string, value: unknown): Promise<void>;
-    remove(key: string): Promise<void>;
-    private filePathKey;
-}
-//# sourceMappingURL=file-cache.d.ts.map

package/dist/utils/file-cache.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"file-cache.d.ts","sourceRoot":"","sources":["../../src/utils/file-cache.ts"],"names":[],"mappings":"AAGA,qBAAa,SAAS;IAClB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;gBACvB,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE;IAIrE,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAYlC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ/C,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IASxC,OAAO,CAAC,WAAW;CAGtB"}

package/dist/utils/file-cache.js

@@ -1,69 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FileCache = void 0;
-const path_1 = __importDefault(require("path"));
-const fse = __importStar(require("fs-extra"));
-class FileCache {
-    constructor({ dirPath, keyPrefix }) {
-        this.dirPath = dirPath;
-        this.keyPrefix = keyPrefix !== null && keyPrefix !== void 0 ? keyPrefix : '';
-    }
-    async get(key) {
-        const fileName = this.filePathKey(key);
-        try {
-            const exists = await fse.pathExists(fileName);
-            if (!exists) {
-                return;
-            }
-            return fse.readJson(fileName);
-        }
-        catch (error) {
-            return;
-        }
-    }
-    async set(key, value) {
-        const fileName = this.filePathKey(key);
-        try {
-            return fse.outputJson(fileName, value);
-        }
-        catch (error) {
-            return;
-        }
-    }
-    async remove(key) {
-        const fileName = this.filePathKey(key);
-        try {
-            return await fse.remove(fileName);
-        }
-        catch (error) {
-            return;
-        }
-    }
-    filePathKey(key) {
-        return path_1.default.join(this.dirPath, '.stackbit/cache', `${this.keyPrefix}${key}.json`);
-    }
-}
-exports.FileCache = FileCache;
-//# sourceMappingURL=file-cache.js.map

package/dist/utils/file-cache.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"file-cache.js","sourceRoot":"","sources":["../../src/utils/file-cache.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA,gDAAwB;AACxB,8CAAgC;AAEhC,MAAa,SAAS;IAGlB,YAAY,EAAE,OAAO,EAAE,SAAS,EAA2C;QACvE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,SAAS,GAAG,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,EAAE,CAAC;IACrC,CAAC;IACD,KAAK,CAAC,GAAG,CAAC,GAAW;QACjB,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACvC,IAAI;YACA,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;YAC9C,IAAI,CAAC,MAAM,EAAE;gBACT,OAAO;aACV;YACD,OAAO,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SACjC;QAAC,OAAO,KAAK,EAAE;YACZ,OAAO;SACV;IACL,CAAC;IACD,KAAK,CAAC,GAAG,CAAC,GAAW,EAAE,KAAc;QACjC,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACvC,IAAI;YACA,OAAO,GAAG,CAAC,UAAU,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;SAC1C;QAAC,OAAO,KAAK,EAAE;YACZ,OAAO;SACV;IACL,CAAC;IACD,KAAK,CAAC,MAAM,CAAC,GAAW;QACpB,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACvC,IAAI;YACA,OAAO,MAAM,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;SACrC;QAAC,OAAO,KAAK,EAAE;YACZ,OAAO;SACV;IACL,CAAC;IAEO,WAAW,CAAC,GAAW;QAC3B,OAAO,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC,SAAS,GAAG,GAAG,OAAO,CAAC,CAAC;IACtF,CAAC;CACJ;AAvCD,8BAuCC"}