@stackbit/cms-contentstack 0.1.2-staging.1 → 0.1.2-staging.2

package/dist/contentstack-conversion-utils.d.ts

@@ -0,0 +1,41 @@
+import * as StackbitTypes from '@stackbit/types';
+import { EntryData } from '@contentstack/management/types/stack/contentType/entry';
+import { Entry } from './contentstack-types';
+import { ModelWithContext } from './contentstack-schema-converter';
+import { DocumentWithContext } from './contentstack-entries-converter';
+declare type GetModelByName = (modelName: string) => ModelWithContext | undefined;
+declare type GetDocumentById = (documentId: string) => DocumentWithContext | undefined;
+export declare function createEntryFromOperationFields({ updateOperationFields, model, getDocumentById, getModelByName, logger }: {
+    updateOperationFields: Record<string, StackbitTypes.UpdateOperationField>;
+    model: ModelWithContext;
+    getDocumentById: GetDocumentById;
+    getModelByName: GetModelByName;
+    logger: StackbitTypes.Logger;
+}): EntryData;
+export declare function updateEntryFromUpdateOperations({ entry, updateOperations, getDocumentById, getModelByName, logger }: {
+    entry: Entry;
+    updateOperations: StackbitTypes.UpdateOperation[];
+    getDocumentById: GetDocumentById;
+    getModelByName: GetModelByName;
+    logger: StackbitTypes.Logger;
+}): Entry;
+export declare function getUpdatedEntryAtFieldPathWithOperation({ entry, updateOperation, model, getDocumentById, getModelByName, logger }: {
+    entry: Entry;
+    updateOperation: StackbitTypes.UpdateOperation;
+    model: ModelWithContext;
+    getDocumentById: GetDocumentById;
+    getModelByName: GetModelByName;
+    logger: StackbitTypes.Logger;
+}): Entry;
+export declare function convertOperationFieldValue({ updateOperationField, rootModel, modelField, entryFieldPath, modelFieldPath, getDocumentById, getModelByName, errorPrefix }: {
+    updateOperationField: StackbitTypes.UpdateOperationField;
+    rootModel: ModelWithContext;
+    modelField: StackbitTypes.FieldSpecificProps;
+    entryFieldPath: (string | number)[];
+    modelFieldPath: string[];
+    getDocumentById: GetDocumentById;
+    getModelByName: GetModelByName;
+    errorPrefix: string;
+}): any;
+export {};
+//# sourceMappingURL=contentstack-conversion-utils.d.ts.map

package/dist/contentstack-conversion-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contentstack-conversion-utils.d.ts","sourceRoot":"","sources":["../src/contentstack-conversion-utils.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,aAAa,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,wDAAwD,CAAC;AAEnF,OAAO,EAAE,KAAK,EAAS,MAAM,sBAAsB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAEvE,aAAK,cAAc,GAAG,CAAC,SAAS,EAAE,MAAM,KAAK,gBAAgB,GAAG,SAAS,CAAC;AAC1E,aAAK,eAAe,GAAG,CAAC,UAAU,EAAE,MAAM,KAAK,mBAAmB,GAAG,SAAS,CAAC;AAE/E,wBAAgB,8BAA8B,CAAC,EAC3C,qBAAqB,EACrB,KAAK,EACL,eAAe,EACf,cAAc,EACd,MAAM,EACT,EAAE;IACC,qBAAqB,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAC;IAC1E,KAAK,EAAE,gBAAgB,CAAC;IACxB,eAAe,EAAE,eAAe,CAAC;IACjC,cAAc,EAAE,cAAc,CAAC;IAC/B,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC;CAChC,GAAG,SAAS,CAsBZ;AAED,wBAAgB,+BAA+B,CAAC,EAC5C,KAAK,EACL,gBAAgB,EAChB,eAAe,EACf,cAAc,EACd,MAAM,EACT,EAAE;IACC,KAAK,EAAE,KAAK,CAAC;IACb,gBAAgB,EAAE,aAAa,CAAC,eAAe,EAAE,CAAC;IAClD,eAAe,EAAE,eAAe,CAAC;IACjC,cAAc,EAAE,cAAc,CAAC;IAC/B,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC;CAChC,GAAG,KAAK,CA8CR;AAED,wBAAgB,uCAAuC,CAAC,EACpD,KAAK,EACL,eAAe,EACf,KAAK,EACL,eAAe,EACf,cAAc,EACd,MAAM,EACT,EAAE;IACC,KAAK,EAAE,KAAK,CAAC;IACb,eAAe,EAAE,aAAa,CAAC,eAAe,CAAC;IAC/C,KAAK,EAAE,gBAAgB,CAAC;IACxB,eAAe,EAAE,eAAe,CAAC;IACjC,cAAc,EAAE,cAAc,CAAC;IAC/B,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC;CAChC,GAAG,KAAK,CA+OR;AA2FD,wBAAgB,0BAA0B,CAAC,EACvC,oBAAoB,EACpB,SAAS,EACT,UAAU,EACV,cAAc,EACd,cAAc,EACd,eAAe,EACf,cAAc,EACd,WAAW,EACd,EAAE;IACC,oBAAoB,EAAE,aAAa,CAAC,oBAAoB,CAAC;IACzD,SAAS,EAAE,gBAAgB,CAAC;IAC5B,UAAU,EAAE,aAAa,CAAC,kBAAkB,CAAC;IAC7C,cAAc,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IACpC,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,eAAe,EAAE,eAAe,CAAC;IACjC,cAAc,EAAE,cAAc,CAAC;IAC/B,WAAW,EAAE,MAAM,CAAC;CACvB,GAAG,GAAG,CA+KN"}

package/dist/contentstack-conversion-utils.js

@@ -0,0 +1,504 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertOperationFieldValue = exports.getUpdatedEntryAtFieldPathWithOperation = exports.updateEntryFromUpdateOperations = exports.createEntryFromOperationFields = void 0;
+const uuid_1 = require("uuid");
+const lodash_1 = __importDefault(require("lodash"));
+function createEntryFromOperationFields({ updateOperationFields, model, getDocumentById, getModelByName, logger }) {
+    return lodash_1.default.reduce(updateOperationFields, (accum, updateOperationField, fieldName) => {
+        const modelField = getModelField(model, fieldName);
+        if (!modelField) {
+            return accum;
+        }
+        accum[fieldName] = convertOperationFieldValue({
+            updateOperationField,
+            modelField,
+            rootModel: model,
+            entryFieldPath: [fieldName],
+            modelFieldPath: [fieldName],
+            getDocumentById,
+            getModelByName,
+            errorPrefix: 'Error occurred while creating an entry.'
+        });
+        return accum;
+    }, { title: (0, uuid_1.v4)() });
+}
+exports.createEntryFromOperationFields = createEntryFromOperationFields;
+function updateEntryFromUpdateOperations({ entry, updateOperations, getDocumentById, getModelByName, logger }) {
+    const model = getModelByName(entry.content_type_uid);
+    if (!model) {
+        throw new Error(`Error occurred while updating entry ${entry.uid}, model ${entry.content_type_uid} not found.`);
+    }
+    let updatedEntry = lodash_1.default.reduce(updateOperations, (entry, updateOperation) => {
+        return getUpdatedEntryAtFieldPathWithOperation({
+            entry,
+            updateOperation,
+            model,
+            getDocumentById,
+            getModelByName,
+            logger
+        });
+    }, entry);
+    // Create a copy of the entry and remove fields that were not updated.
+    const modelFieldsMap = lodash_1.default.keyBy(model.fields, 'name');
+    const updatedRootFieldNames = updateOperations.reduce((fieldNamesMap, updateOperations) => {
+        fieldNamesMap[updateOperations.fieldPath[0]] = true;
+        return fieldNamesMap;
+    }, {});
+    // const includedMetaProps = _.transform(
+    //     ['uid', 'stackHeaders', 'content_type_uid', 'taxonomy_uid', 'locale', '_version', 'urlPath'],
+    //     (map, value) => {
+    //         map[value] = true;
+    //     },
+    //     {} as Record<string, boolean>
+    // );
+    updatedEntry = lodash_1.default.reduce(updatedEntry, (newEntry, value, prop) => {
+        if (!modelFieldsMap[prop] || updatedRootFieldNames[prop]) {
+            newEntry[prop] = value;
+        }
+        return newEntry;
+    }, {});
+    return sanitizeForUpdate(updatedEntry);
+}
+exports.updateEntryFromUpdateOperations = updateEntryFromUpdateOperations;
+function getUpdatedEntryAtFieldPathWithOperation({ entry, updateOperation, model, getDocumentById, getModelByName, logger }) {
+    let opMessage;
+    switch (updateOperation.opType) {
+        case 'set':
+            opMessage = 'setting a field';
+            break;
+        case 'unset':
+            opMessage = 'unsetting a field';
+            break;
+        case 'insert':
+            opMessage = 'inserting an item into a list';
+            break;
+        case 'remove':
+            opMessage = 'removing an item from a list';
+            break;
+        case 'reorder':
+            opMessage = 'reordering a list';
+            break;
+    }
+    const errorPrefix = `Error occurred while ${opMessage} in entry '${entry.uid}'.`;
+    function createError(detailedMessage) {
+        return new Error(`${errorPrefix} ${detailedMessage}`);
+    }
+    function iterateModel({ value, model, fieldPath, entryFieldPath, modelFieldPath }) {
+        if (fieldPath.length === 0) {
+            return getValueForOperation({
+                updateOperation,
+                value,
+                rootEntry: entry,
+                rootModel: model,
+                entryFieldPath,
+                modelFieldPath,
+                getDocumentById,
+                getModelByName,
+                errorPrefix,
+                logger
+            });
+        }
+        const fieldName = lodash_1.default.head(fieldPath);
+        const fieldPathTail = lodash_1.default.tail(fieldPath);
+        if (typeof fieldName !== 'string') {
+            throw createError(`The field '${fieldName}' in field path '${entryFieldPath.concat(fieldName).join('.')}' ` +
+                `is not a string, 'typeof ${fieldName} === ${typeof fieldName}'.`);
+        }
+        const modelField = getModelField(model, fieldName);
+        if (!modelField) {
+            throw createError(`The field '${fieldName}' in field path '${entryFieldPath.concat(fieldName).join('.')}' does not exist in model '${model.name}'.`);
+        }
+        return {
+            ...value,
+            [fieldName]: iterateField({
+                value: value ? value[fieldName] : undefined,
+                modelField,
+                fieldPath: fieldPathTail,
+                rootModel: model,
+                entryFieldPath: entryFieldPath.concat(fieldName),
+                modelFieldPath: modelFieldPath.concat(fieldName)
+            })
+        };
+    }
+    function iterateField({ value, modelField, fieldPath, rootModel, entryFieldPath, modelFieldPath }) {
+        var _a, _b;
+        if (fieldPath.length === 0) {
+            return getValueForOperation({
+                updateOperation,
+                value,
+                rootEntry: entry,
+                rootModel,
+                entryFieldPath,
+                modelFieldPath,
+                getDocumentById,
+                getModelByName,
+                errorPrefix,
+                logger
+            });
+        }
+        if (modelField.type === 'object') {
+            // The value must be an object to apply the operation on its nested field with name fieldName,
+            // otherwise the fieldPath is illegal
+            if (!isObject(value)) {
+                throw createError(`The field path '${entryFieldPath.join('.')}' points to an empty value.`);
+            }
+            const fieldName = lodash_1.default.head(fieldPath);
+            const fieldPathTail = lodash_1.default.tail(fieldPath);
+            if (typeof fieldName !== 'string') {
+                throw createError(`The field '${fieldName}' in field path '${entryFieldPath.concat(fieldName).join('.')}' ` +
+                    `is not a string, 'typeof ${fieldName} === ${typeof fieldName}'.`);
+            }
+            const childModelField = getModelField(modelField, fieldName);
+            if (!childModelField) {
+                throw createError(`The field '${fieldName}' in field path '${entryFieldPath.concat(fieldName).join('.')}' does not exist in model '${model.name}'.`);
+            }
+            return {
+                ...value,
+                [fieldName]: iterateField({
+                    value: value ? value[fieldName] : undefined,
+                    modelField: childModelField,
+                    fieldPath: fieldPathTail,
+                    rootModel,
+                    entryFieldPath: entryFieldPath.concat(fieldName),
+                    modelFieldPath: modelFieldPath.concat(fieldName)
+                })
+            };
+        }
+        else if (modelField.type === 'model') {
+            // The value must be an object to apply the operation on its nested field with name fieldName,
+            // otherwise the fieldPath is illegal
+            if (!isObject(value)) {
+                throw createError(`The field path '${entryFieldPath.join('.')}' points to an empty value.`);
+            }
+            const fieldPathStr = modelFieldPath.join('.');
+            const blockMap = (_b = (_a = rootModel.context) === null || _a === void 0 ? void 0 : _a.blockMap) === null || _b === void 0 ? void 0 : _b[fieldPathStr];
+            if (blockMap) {
+                // This is a modular blocks field with keys mapping to inline (object)
+                // or global (model) fields mapped by model.context.blockMap[blockUID].
+                const blockUIDs = lodash_1.default.keys(value);
+                const blockUID = blockUIDs[0];
+                if (blockUIDs.length !== 1 || !blockUID) {
+                    throw createError(`The modular block at field path '${entryFieldPath.join('.')}' has no UID.`);
+                }
+                const block = value[blockUID];
+                if (!isObject(block)) {
+                    throw createError(`The field path '${entryFieldPath.join('.')}' points to an empty modular block '${blockUID}'.`);
+                }
+                const modelName = blockMap.blockIdToModelName[blockUID];
+                if (!modelName) {
+                    throw createError(`Could not match model name for modular block '${blockUID}' at field path '${entryFieldPath.join('.')}'.`);
+                }
+                const nestedModel = getModelByName(modelName);
+                if (!nestedModel) {
+                    throw createError(`Could not find model named '${modelName}' for modular block '${blockUID}' ` + `at field path '${entryFieldPath.join('.')}'.`);
+                }
+                return {
+                    [blockUID]: iterateModel({
+                        value: block,
+                        fieldPath: fieldPath,
+                        model: nestedModel,
+                        entryFieldPath: entryFieldPath,
+                        modelFieldPath: []
+                    })
+                };
+            }
+            else {
+                // This is as a regular global field (model) with a single model or as a CNTSTK_LINK_MODEL
+                if (modelField.models.length !== 1) {
+                    throw createError(`A model field at field path '${entryFieldPath.join('.')}' has more than one (or zero) models ${modelField.models.join('.')}.`);
+                }
+                const modelName = modelField.models[0];
+                const nestedModel = getModelByName(modelName);
+                if (!nestedModel) {
+                    throw createError(`Could not find model named '${modelName}' for object at field path '${entryFieldPath.join('.')}.'`);
+                }
+                return iterateModel({
+                    value: value,
+                    fieldPath: fieldPath,
+                    model: nestedModel,
+                    entryFieldPath: entryFieldPath,
+                    modelFieldPath: []
+                });
+            }
+        }
+        else if (modelField.type === 'list') {
+            // The value must be an array to apply the operation on its nested items with item index,
+            // otherwise the fieldPath is illegal
+            if (!Array.isArray(value)) {
+                throw createError(`The value at field path '${entryFieldPath.join('.')}' is not an array.`);
+            }
+            const fieldName = lodash_1.default.head(fieldPath);
+            const fieldPathTail = lodash_1.default.tail(fieldPath);
+            const index = lodash_1.default.toNumber(fieldName);
+            if (typeof index !== 'number' || lodash_1.default.isNaN(index)) {
+                throw createError(`The field '${fieldName}' in field path '${entryFieldPath.concat(fieldName).join('.')}' ` +
+                    `is not a string, 'typeof ${fieldName} === ${typeof fieldName}'.`);
+            }
+            const newArray = value.slice();
+            newArray.splice(index, 1, iterateField({
+                value: value[index],
+                fieldPath: fieldPathTail,
+                modelField: modelField.items,
+                rootModel,
+                entryFieldPath: entryFieldPath.concat(index),
+                modelFieldPath: modelFieldPath
+            }));
+            return newArray;
+        }
+        throw createError(`The field type '${modelField.type}' at field path '${entryFieldPath.join('.')}' is not a container type (object, model, list).`);
+    }
+    return iterateModel({
+        value: entry,
+        model,
+        fieldPath: updateOperation.fieldPath,
+        entryFieldPath: [],
+        modelFieldPath: []
+    });
+}
+exports.getUpdatedEntryAtFieldPathWithOperation = getUpdatedEntryAtFieldPathWithOperation;
+function getValueForOperation({ updateOperation, value, rootModel, entryFieldPath, modelFieldPath, getDocumentById, getModelByName, errorPrefix, logger }) {
+    switch (updateOperation.opType) {
+        case 'set':
+            return convertOperationFieldValue({
+                updateOperationField: updateOperation.field,
+                modelField: updateOperation.modelField,
+                rootModel: rootModel,
+                entryFieldPath: entryFieldPath,
+                modelFieldPath: modelFieldPath,
+                getModelByName,
+                getDocumentById,
+                errorPrefix
+            });
+        case 'unset': {
+            // TODO: is unset different per type?
+            return null;
+        }
+        case 'insert': {
+            if (typeof value === 'undefined') {
+                value = [];
+            }
+            if (!Array.isArray(value)) {
+                throw new Error(`${errorPrefix} The field path points to a non array value.`);
+            }
+            const newValue = convertOperationFieldValue({
+                updateOperationField: updateOperation.item,
+                modelField: updateOperation.modelField.items,
+                rootModel: rootModel,
+                entryFieldPath: entryFieldPath,
+                modelFieldPath: modelFieldPath,
+                getModelByName,
+                getDocumentById,
+                errorPrefix
+            });
+            if (typeof updateOperation.index === 'undefined') {
+                return value.concat(newValue);
+            }
+            const newArray = value.slice();
+            newArray.splice(updateOperation.index, 0, newValue);
+            return newArray;
+        }
+        case 'remove': {
+            if (typeof value === 'undefined') {
+                value = [];
+            }
+            if (!Array.isArray(value)) {
+                throw new Error(`${errorPrefix} The field path points to a non array value.`);
+            }
+            const newArray = value.slice();
+            newArray.splice(updateOperation.index, 1);
+            return newArray;
+        }
+        case 'reorder': {
+            if (typeof value === 'undefined') {
+                value = [];
+            }
+            if (!Array.isArray(value)) {
+                throw new Error(`${errorPrefix} The field path points to a non array value.`);
+            }
+            return updateOperation.order.map((newIndex) => value[newIndex]);
+        }
+        default: {
+            const _exhaustiveCheck = updateOperation;
+            return _exhaustiveCheck;
+        }
+    }
+}
+function convertOperationFieldValue({ updateOperationField, rootModel, modelField, entryFieldPath, modelFieldPath, getDocumentById, getModelByName, errorPrefix }) {
+    var _a, _b;
+    function createError(detailedMessage) {
+        return new Error(`${errorPrefix} ${detailedMessage}`);
+    }
+    switch (updateOperationField.type) {
+        case 'string':
+        case 'url':
+        case 'slug':
+        case 'text':
+        case 'markdown':
+        case 'html':
+        case 'date':
+        case 'datetime':
+        case 'color':
+        case 'enum': {
+            return updateOperationField.value;
+        }
+        case 'number': {
+            return updateOperationField.value || 0;
+        }
+        case 'boolean': {
+            return updateOperationField.value || false;
+        }
+        case 'file':
+        case 'image': {
+            return updateOperationField.value || null;
+        }
+        case 'richText':
+        case 'json':
+        case 'style':
+        case 'cross-reference': {
+            return updateOperationField.value;
+        }
+        case 'reference': {
+            if ((updateOperationField === null || updateOperationField === void 0 ? void 0 : updateOperationField.refType) === 'asset') {
+                return updateOperationField.refId;
+            }
+            const document = getDocumentById(updateOperationField === null || updateOperationField === void 0 ? void 0 : updateOperationField.refId);
+            if (!document) {
+                throw createError(`Could not find entry with ID '${updateOperationField === null || updateOperationField === void 0 ? void 0 : updateOperationField.refId}' referenced at field path ${entryFieldPath.join('.')}.`);
+            }
+            return {
+                uid: updateOperationField.refId,
+                _content_type_uid: document.modelName
+            };
+        }
+        case 'object': {
+            if (modelField.type !== 'object') {
+                throw createError(`The operation field type 'object' does not match model field type '${modelField.type}' at field path ${entryFieldPath.join('.')}.`);
+            }
+            return lodash_1.default.reduce(updateOperationField.fields, (accum, nestedUpdateOperationField, fieldName) => {
+                const nestedModelField = getModelField(modelField, fieldName);
+                if (!nestedModelField) {
+                    return accum;
+                }
+                accum[fieldName] = convertOperationFieldValue({
+                    updateOperationField: nestedUpdateOperationField,
+                    rootModel,
+                    modelField: nestedModelField,
+                    entryFieldPath: entryFieldPath.concat(fieldName),
+                    modelFieldPath: modelFieldPath.concat(fieldName),
+                    getDocumentById,
+                    getModelByName,
+                    errorPrefix
+                });
+                return accum;
+            }, {});
+        }
+        case 'model': {
+            if (modelField.type !== 'model') {
+                throw createError(`The operation field type 'model' does not match model field type '${modelField.type}' at field path ${entryFieldPath.join('.')}.`);
+            }
+            const nestedModel = getModelByName(updateOperationField.modelName);
+            if (!nestedModel) {
+                throw createError(`Could not find model named '${updateOperationField.modelName}' for field at path '${entryFieldPath.join('.')}'.`);
+            }
+            const fieldPathStr = modelFieldPath.join('.');
+            const blockMap = (_b = (_a = rootModel.context) === null || _a === void 0 ? void 0 : _a.blockMap) === null || _b === void 0 ? void 0 : _b[fieldPathStr];
+            if (blockMap) {
+                // this is a modular blocks field with keys mapping to inline (object) or global (model) fields
+                // mapped by context.blockMap[blockUID]
+                const blockUID = blockMap.modelNameToBlockId[updateOperationField.modelName];
+                if (!blockUID) {
+                    throw createError(`Could not match modular block UI for model '${updateOperationField.modelName}' for field path '${entryFieldPath.join('.')}'.`);
+                }
+                return {
+                    [blockUID]: lodash_1.default.reduce(updateOperationField.fields, (accum, nestedUpdateOperationField, fieldName) => {
+                        const nestedModelField = getModelField(nestedModel, fieldName);
+                        if (!nestedModelField) {
+                            return accum;
+                        }
+                        accum[fieldName] = convertOperationFieldValue({
+                            updateOperationField: nestedUpdateOperationField,
+                            rootModel: nestedModel,
+                            modelField: nestedModelField,
+                            entryFieldPath: entryFieldPath.concat([blockUID, fieldName]),
+                            modelFieldPath: [fieldName],
+                            getDocumentById,
+                            getModelByName,
+                            errorPrefix
+                        });
+                        return accum;
+                    }, {})
+                };
+            }
+            else {
+                // this is a regular global field (model) with a single model or as a CNTSTK_LINK_MODEL
+                return lodash_1.default.reduce(updateOperationField.fields, (accum, nestedUpdateOperationField, fieldName) => {
+                    const nestedModelField = getModelField(nestedModel, fieldName);
+                    if (!nestedModelField) {
+                        return accum;
+                    }
+                    accum[fieldName] = convertOperationFieldValue({
+                        updateOperationField: nestedUpdateOperationField,
+                        rootModel: nestedModel,
+                        modelField: nestedModelField,
+                        entryFieldPath: entryFieldPath.concat(fieldName),
+                        modelFieldPath: [fieldName],
+                        getDocumentById,
+                        getModelByName,
+                        errorPrefix
+                    });
+                    return accum;
+                }, {});
+            }
+        }
+        case 'list': {
+            if (modelField.type !== 'list') {
+                throw createError(`The operation field type 'list' does not match model field type '${modelField.type}' at field path ${entryFieldPath.join('.')}.`);
+            }
+            return lodash_1.default.reduce(updateOperationField.items, (accum, listItem, index) => {
+                accum.push(convertOperationFieldValue({
+                    updateOperationField: listItem,
+                    rootModel,
+                    modelField: modelField.items,
+                    entryFieldPath: entryFieldPath.concat(index),
+                    modelFieldPath: modelFieldPath,
+                    getDocumentById,
+                    getModelByName,
+                    errorPrefix
+                }));
+                return accum;
+            }, []);
+        }
+        default: {
+            const _exhaustiveCheck = updateOperationField;
+            return _exhaustiveCheck;
+        }
+    }
+}
+exports.convertOperationFieldValue = convertOperationFieldValue;
+function getModelField(model, fieldName) {
+    var _a;
+    return (_a = model.fields) === null || _a === void 0 ? void 0 : _a.find((field) => field.name === fieldName);
+}
+function isObject(value) {
+    return lodash_1.default.isPlainObject(value);
+}
+function sanitizeForUpdate(entry) {
+    return lodash_1.default.cloneDeepWith(entry, (value) => {
+        if (isAsset(value)) {
+            return value.uid;
+        }
+    });
+}
+function isAsset(value) {
+    if (!isObject(value) || !value.uid) {
+        return false;
+    }
+    // if all asset keys are present in the value, then it is an asset
+    const imageKeys = ['uid', 'created_at', 'updated_at', 'created_by', 'updated_by', 'content_type', 'file_size', 'filename', 'url'];
+    const objectKeys = lodash_1.default.keys(value);
+    return lodash_1.default.difference(imageKeys, objectKeys).length === 0;
+}
+//# sourceMappingURL=contentstack-conversion-utils.js.map

package/dist/contentstack-conversion-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contentstack-conversion-utils.js","sourceRoot":"","sources":["../src/contentstack-conversion-utils.ts"],"names":[],"mappings":";;;;;;AAAA,+BAAoC;AACpC,oDAAuB;AAWvB,SAAgB,8BAA8B,CAAC,EAC3C,qBAAqB,EACrB,KAAK,EACL,eAAe,EACf,cAAc,EACd,MAAM,EAOT;IACG,OAAO,gBAAC,CAAC,MAAM,CACX,qBAAqB,EACrB,CAAC,KAAgB,EAAE,oBAAoB,EAAE,SAAS,EAAE,EAAE;QAClD,MAAM,UAAU,GAAG,aAAa,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QACnD,IAAI,CAAC,UAAU,EAAE;YACb,OAAO,KAAK,CAAC;SAChB;QACD,KAAK,CAAC,SAAS,CAAC,GAAG,0BAA0B,CAAC;YAC1C,oBAAoB;YACpB,UAAU;YACV,SAAS,EAAE,KAAK;YAChB,cAAc,EAAE,CAAC,SAAS,CAAC;YAC3B,cAAc,EAAE,CAAC,SAAS,CAAC;YAC3B,eAAe;YACf,cAAc;YACd,WAAW,EAAE,yCAAyC;SACzD,CAAC,CAAC;QACH,OAAO,KAAK,CAAC;IACjB,CAAC,EACD,EAAE,KAAK,EAAE,IAAA,SAAM,GAAE,EAAE,CACtB,CAAC;AACN,CAAC;AAlCD,wEAkCC;AAED,SAAgB,+BAA+B,CAAC,EAC5C,KAAK,EACL,gBAAgB,EAChB,eAAe,EACf,cAAc,EACd,MAAM,EAOT;IACG,MAAM,KAAK,GAAG,cAAc,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACrD,IAAI,CAAC,KAAK,EAAE;QACR,MAAM,IAAI,KAAK,CAAC,uCAAuC,KAAK,CAAC,GAAG,WAAW,KAAK,CAAC,gBAAgB,aAAa,CAAC,CAAC;KACnH;IAED,IAAI,YAAY,GAAG,gBAAC,CAAC,MAAM,CACvB,gBAAgB,EAChB,CAAC,KAAY,EAAE,eAAe,EAAE,EAAE;QAC9B,OAAO,uCAAuC,CAAC;YAC3C,KAAK;YACL,eAAe;YACf,KAAK;YACL,eAAe;YACf,cAAc;YACd,MAAM;SACT,CAAC,CAAC;IACP,CAAC,EACD,KAAK,CACR,CAAC;IAEF,sEAAsE;IACtE,MAAM,cAAc,GAAG,gBAAC,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrD,MAAM,qBAAqB,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC,aAAa,EAAE,gBAAgB,EAAE,EAAE;QACtF,aAAa,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAW,CAAC,GAAG,IAAI,CAAC;QAC9D,OAAO,aAAa,CAAC;IACzB,CAAC,EAAE,EAA6B,CAAC,CAAC;IAClC,yCAAyC;IACzC,oGAAoG;IACpG,wBAAwB;IACxB,6BAA6B;IAC7B,SAAS;IACT,oCAAoC;IACpC,KAAK;IACL,YAAY,GAAG,gBAAC,CAAC,MAAM,CACnB,YAAY,EACZ,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;QACtB,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,qBAAqB,CAAC,IAAI,CAAC,EAAE;YACtD,QAAQ,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;SAC1B;QACD,OAAO,QAAQ,CAAC;IACpB,CAAC,EACD,EAAW,CACd,CAAC;IAEF,OAAO,iBAAiB,CAAC,YAAY,CAAC,CAAC;AAC3C,CAAC;AA1DD,0EA0DC;AAED,SAAgB,uCAAuC,CAAC,EACpD,KAAK,EACL,eAAe,EACf,KAAK,EACL,eAAe,EACf,cAAc,EACd,MAAM,EAQT;IACG,IAAI,SAAiB,CAAC;IACtB,QAAQ,eAAe,CAAC,MAAM,EAAE;QAC5B,KAAK,KAAK;YACN,SAAS,GAAG,iBAAiB,CAAC;YAC9B,MAAM;QACV,KAAK,OAAO;YACR,SAAS,GAAG,mBAAmB,CAAC;YAChC,MAAM;QACV,KAAK,QAAQ;YACT,SAAS,GAAG,+BAA+B,CAAC;YAC5C,MAAM;QACV,KAAK,QAAQ;YACT,SAAS,GAAG,8BAA8B,CAAC;YAC3C,MAAM;QACV,KAAK,SAAS;YACV,SAAS,GAAG,mBAAmB,CAAC;YAChC,MAAM;KACb;IACD,MAAM,WAAW,GAAG,wBAAwB,SAAS,cAAc,KAAK,CAAC,GAAG,IAAI,CAAC;IAEjF,SAAS,WAAW,CAAC,eAAuB;QACxC,OAAO,IAAI,KAAK,CAAC,GAAG,WAAW,IAAI,eAAe,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED,SAAS,YAAY,CAAuC,EACxD,KAAK,EACL,KAAK,EACL,SAAS,EACT,cAAc,EACd,cAAc,EAOjB;QACG,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;YACxB,OAAO,oBAAoB,CAAC;gBACxB,eAAe;gBACf,KAAK;gBACL,SAAS,EAAE,KAAK;gBAChB,SAAS,EAAE,KAAK;gBAChB,cAAc;gBACd,cAAc;gBACd,eAAe;gBACf,cAAc;gBACd,WAAW;gBACX,MAAM;aACT,CAAC,CAAC;SACN;QACD,MAAM,SAAS,GAAG,gBAAC,CAAC,IAAI,CAAC,SAAS,CAAE,CAAC;QACrC,MAAM,aAAa,GAAG,gBAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACxC,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;YAC/B,MAAM,WAAW,CACb,cAAc,SAAS,oBAAoB,cAAc,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI;gBACrF,4BAA4B,SAAS,QAAQ,OAAO,SAAS,IAAI,CACxE,CAAC;SACL;QACD,MAAM,UAAU,GAAG,aAAa,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QACnD,IAAI,CAAC,UAAU,EAAE;YACb,MAAM,WAAW,CACb,cAAc,SAAS,oBAAoB,cAAc,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,8BAA8B,KAAK,CAAC,IAAI,IAAI,CACpI,CAAC;SACL;QACD,OAAO;YACH,GAAG,KAAK;YACR,CAAC,SAAS,CAAC,EAAE,YAAY,CAAC;gBACtB,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS;gBAC3C,UAAU;gBACV,SAAS,EAAE,aAAa;gBACxB,SAAS,EAAE,KAAK;gBAChB,cAAc,EAAE,cAAc,CAAC,MAAM,CAAC,SAAS,CAAC;gBAChD,cAAc,EAAE,cAAc,CAAC,MAAM,CAAC,SAAS,CAAC;aACnD,CAAC;SACG,CAAC;IACd,CAAC;IAED,SAAS,YAAY,CAAC,EAClB,KAAK,EACL,UAAU,EACV,SAAS,EACT,SAAS,EACT,cAAc,EACd,cAAc,EAQjB;;QACG,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;YACxB,OAAO,oBAAoB,CAAC;gBACxB,eAAe;gBACf,KAAK;gBACL,SAAS,EAAE,KAAK;gBAChB,SAAS;gBACT,cAAc;gBACd,cAAc;gBACd,eAAe;gBACf,cAAc;gBACd,WAAW;gBACX,MAAM;aACT,CAAC,CAAC;SACN;QAED,IAAI,UAAU,CAAC,IAAI,KAAK,QAAQ,EAAE;YAC9B,8FAA8F;YAC9F,qCAAqC;YACrC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;gBAClB,MAAM,WAAW,CAAC,mBAAmB,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;aAC/F;YACD,MAAM,SAAS,GAAG,gBAAC,CAAC,IAAI,CAAC,SAAS,CAAE,CAAC;YACrC,MAAM,aAAa,GAAG,gBAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACxC,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;gBAC/B,MAAM,WAAW,CACb,cAAc,SAAS,oBAAoB,cAAc,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI;oBACrF,4BAA4B,SAAS,QAAQ,OAAO,SAAS,IAAI,CACxE,CAAC;aACL;YACD,MAAM,eAAe,GAAG,aAAa,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;YAC7D,IAAI,CAAC,eAAe,EAAE;gBAClB,MAAM,WAAW,CACb,cAAc,SAAS,oBAAoB,cAAc,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,8BAA8B,KAAK,CAAC,IAAI,IAAI,CACpI,CAAC;aACL;YACD,OAAO;gBACH,GAAG,KAAK;gBACR,CAAC,SAAS,CAAC,EAAE,YAAY,CAAC;oBACtB,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS;oBAC3C,UAAU,EAAE,eAAe;oBAC3B,SAAS,EAAE,aAAa;oBACxB,SAAS;oBACT,cAAc,EAAE,cAAc,CAAC,MAAM,CAAC,SAAS,CAAC;oBAChD,cAAc,EAAE,cAAc,CAAC,MAAM,CAAC,SAAS,CAAC;iBACnD,CAAC;aACL,CAAC;SACL;aAAM,IAAI,UAAU,CAAC,IAAI,KAAK,OAAO,EAAE;YACpC,8FAA8F;YAC9F,qCAAqC;YACrC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;gBAClB,MAAM,WAAW,CAAC,mBAAmB,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;aAC/F;YACD,MAAM,YAAY,GAAG,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC9C,MAAM,QAAQ,GAAG,MAAA,MAAA,SAAS,CAAC,OAAO,0CAAE,QAAQ,0CAAG,YAAY,CAAC,CAAC;YAC7D,IAAI,QAAQ,EAAE;gBACV,sEAAsE;gBACtE,uEAAuE;gBACvE,MAAM,SAAS,GAAG,gBAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAChC,MAAM,QAAQ,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;gBAC9B,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE;oBACrC,MAAM,WAAW,CAAC,oCAAoC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;iBAClG;gBACD,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;gBAC9B,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;oBAClB,MAAM,WAAW,CAAC,mBAAmB,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,uCAAuC,QAAQ,IAAI,CAAC,CAAC;iBACrH;gBACD,MAAM,SAAS,GAAG,QAAQ,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;gBACxD,IAAI,CAAC,SAAS,EAAE;oBACZ,MAAM,WAAW,CAAC,iDAAiD,QAAQ,oBAAoB,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;iBAChI;gBACD,MAAM,WAAW,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC;gBAC9C,IAAI,CAAC,WAAW,EAAE;oBACd,MAAM,WAAW,CACb,+BAA+B,SAAS,wBAAwB,QAAQ,IAAI,GAAG,kBAAkB,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAChI,CAAC;iBACL;gBACD,OAAO;oBACH,CAAC,QAAQ,CAAC,EAAE,YAAY,CAAC;wBACrB,KAAK,EAAE,KAAK;wBACZ,SAAS,EAAE,SAAS;wBACpB,KAAK,EAAE,WAAW;wBAClB,cAAc,EAAE,cAAc;wBAC9B,cAAc,EAAE,EAAE;qBACrB,CAAC;iBACL,CAAC;aACL;iBAAM;gBACH,0FAA0F;gBAC1F,IAAI,UAAU,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;oBAChC,MAAM,WAAW,CACb,gCAAgC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,wCAAwC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CACjI,CAAC;iBACL;gBACD,MAAM,SAAS,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAE,CAAC;gBACxC,MAAM,WAAW,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC;gBAC9C,IAAI,CAAC,WAAW,EAAE;oBACd,MAAM,WAAW,CAAC,+BAA+B,SAAS,+BAA+B,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;iBAC1H;gBACD,OAAO,YAAY,CAAC;oBAChB,KAAK,EAAE,KAAK;oBACZ,SAAS,EAAE,SAAS;oBACpB,KAAK,EAAE,WAAW;oBAClB,cAAc,EAAE,cAAc;oBAC9B,cAAc,EAAE,EAAE;iBACrB,CAAC,CAAC;aACN;SACJ;aAAM,IAAI,UAAU,CAAC,IAAI,KAAK,MAAM,EAAE;YACnC,yFAAyF;YACzF,qCAAqC;YACrC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;gBACvB,MAAM,WAAW,CAAC,4BAA4B,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;aAC/F;YACD,MAAM,SAAS,GAAG,gBAAC,CAAC,IAAI,CAAC,SAAS,CAAE,CAAC;YACrC,MAAM,aAAa,GAAG,gBAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACxC,MAAM,KAAK,GAAG,gBAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;YACpC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,gBAAC,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE;gBAC7C,MAAM,WAAW,CACb,cAAc,SAAS,oBAAoB,cAAc,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI;oBACrF,4BAA4B,SAAS,QAAQ,OAAO,SAAS,IAAI,CACxE,CAAC;aACL;YACD,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC;YAC/B,QAAQ,CAAC,MAAM,CACX,KAAK,EACL,CAAC,EACD,YAAY,CAAC;gBACT,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC;gBACnB,SAAS,EAAE,aAAa;gBACxB,UAAU,EAAE,UAAU,CAAC,KAAK;gBAC5B,SAAS;gBACT,cAAc,EAAE,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC;gBAC5C,cAAc,EAAE,cAAc;aACjC,CAAC,CACL,CAAC;YACF,OAAO,QAAQ,CAAC;SACnB;QACD,MAAM,WAAW,CAAC,mBAAmB,UAAU,CAAC,IAAI,oBAAoB,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,kDAAkD,CAAC,CAAC;IACxJ,CAAC;IAED,OAAO,YAAY,CAAC;QAChB,KAAK,EAAE,KAAK;QACZ,KAAK;QACL,SAAS,EAAE,eAAe,CAAC,SAAS;QACpC,cAAc,EAAE,EAAE;QAClB,cAAc,EAAE,EAAE;KACrB,CAAC,CAAC;AACP,CAAC;AA7PD,0FA6PC;AAED,SAAS,oBAAoB,CAAC,EAC1B,eAAe,EACf,KAAK,EACL,SAAS,EACT,cAAc,EACd,cAAc,EACd,eAAe,EACf,cAAc,EACd,WAAW,EACX,MAAM,EAYT;IACG,QAAQ,eAAe,CAAC,MAAM,EAAE;QAC5B,KAAK,KAAK;YACN,OAAO,0BAA0B,CAAC;gBAC9B,oBAAoB,EAAE,eAAe,CAAC,KAAK;gBAC3C,UAAU,EAAE,eAAe,CAAC,UAAU;gBACtC,SAAS,EAAE,SAAS;gBACpB,cAAc,EAAE,cAAc;gBAC9B,cAAc,EAAE,cAAc;gBAC9B,cAAc;gBACd,eAAe;gBACf,WAAW;aACd,CAAC,CAAC;QACP,KAAK,OAAO,CAAC,CAAC;YACV,qCAAqC;YACrC,OAAO,IAAI,CAAC;SACf;QACD,KAAK,QAAQ,CAAC,CAAC;YACX,IAAI,OAAO,KAAK,KAAK,WAAW,EAAE;gBAC9B,KAAK,GAAG,EAAE,CAAC;aACd;YACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;gBACvB,MAAM,IAAI,KAAK,CAAC,GAAG,WAAW,8CAA8C,CAAC,CAAC;aACjF;YACD,MAAM,QAAQ,GAAG,0BAA0B,CAAC;gBACxC,oBAAoB,EAAE,eAAe,CAAC,IAAI;gBAC1C,UAAU,EAAE,eAAe,CAAC,UAAU,CAAC,KAAK;gBAC5C,SAAS,EAAE,SAAS;gBACpB,cAAc,EAAE,cAAc;gBAC9B,cAAc,EAAE,cAAc;gBAC9B,cAAc;gBACd,eAAe;gBACf,WAAW;aACd,CAAC,CAAC;YACH,IAAI,OAAO,eAAe,CAAC,KAAK,KAAK,WAAW,EAAE;gBAC9C,OAAO,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;aACjC;YACD,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC;YAC/B,QAAQ,CAAC,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;YACpD,OAAO,QAAQ,CAAC;SACnB;QACD,KAAK,QAAQ,CAAC,CAAC;YACX,IAAI,OAAO,KAAK,KAAK,WAAW,EAAE;gBAC9B,KAAK,GAAG,EAAE,CAAC;aACd;YACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;gBACvB,MAAM,IAAI,KAAK,CAAC,GAAG,WAAW,8CAA8C,CAAC,CAAC;aACjF;YACD,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC;YAC/B,QAAQ,CAAC,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YAC1C,OAAO,QAAQ,CAAC;SACnB;QACD,KAAK,SAAS,CAAC,CAAC;YACZ,IAAI,OAAO,KAAK,KAAK,WAAW,EAAE;gBAC9B,KAAK,GAAG,EAAE,CAAC;aACd;YACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;gBACvB,MAAM,IAAI,KAAK,CAAC,GAAG,WAAW,8CAA8C,CAAC,CAAC;aACjF;YACD,OAAO,eAAe,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAE,KAAe,CAAC,QAAQ,CAAC,CAAC,CAAC;SAC9E;QACD,OAAO,CAAC,CAAC;YACL,MAAM,gBAAgB,GAAU,eAAe,CAAC;YAChD,OAAO,gBAAgB,CAAC;SAC3B;KACJ;AACL,CAAC;AAED,SAAgB,0BAA0B,CAAC,EACvC,oBAAoB,EACpB,SAAS,EACT,UAAU,EACV,cAAc,EACd,cAAc,EACd,eAAe,EACf,cAAc,EACd,WAAW,EAUd;;IACG,SAAS,WAAW,CAAC,eAAuB;QACxC,OAAO,IAAI,KAAK,CAAC,GAAG,WAAW,IAAI,eAAe,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED,QAAQ,oBAAoB,CAAC,IAAI,EAAE;QAC/B,KAAK,QAAQ,CAAC;QACd,KAAK,KAAK,CAAC;QACX,KAAK,MAAM,CAAC;QACZ,KAAK,MAAM,CAAC;QACZ,KAAK,UAAU,CAAC;QAChB,KAAK,MAAM,CAAC;QACZ,KAAK,MAAM,CAAC;QACZ,KAAK,UAAU,CAAC;QAChB,KAAK,OAAO,CAAC;QACb,KAAK,MAAM,CAAC,CAAC;YACT,OAAO,oBAAoB,CAAC,KAAK,CAAC;SACrC;QACD,KAAK,QAAQ,CAAC,CAAC;YACX,OAAO,oBAAoB,CAAC,KAAK,IAAI,CAAC,CAAC;SAC1C;QACD,KAAK,SAAS,CAAC,CAAC;YACZ,OAAO,oBAAoB,CAAC,KAAK,IAAI,KAAK,CAAC;SAC9C;QACD,KAAK,MAAM,CAAC;QACZ,KAAK,OAAO,CAAC,CAAC;YACV,OAAO,oBAAoB,CAAC,KAAK,IAAI,IAAI,CAAC;SAC7C;QACD,KAAK,UAAU,CAAC;QAChB,KAAK,MAAM,CAAC;QACZ,KAAK,OAAO,CAAC;QACb,KAAK,iBAAiB,CAAC,CAAC;YACpB,OAAO,oBAAoB,CAAC,KAAK,CAAC;SACrC;QACD,KAAK,WAAW,CAAC,CAAC;YACd,IAAI,CAAA,oBAAoB,aAApB,oBAAoB,uBAApB,oBAAoB,CAAE,OAAO,MAAK,OAAO,EAAE;gBAC3C,OAAO,oBAAoB,CAAC,KAAK,CAAC;aACrC;YACD,MAAM,QAAQ,GAAG,eAAe,CAAC,oBAAoB,aAApB,oBAAoB,uBAApB,oBAAoB,CAAE,KAAK,CAAC,CAAC;YAC9D,IAAI,CAAC,QAAQ,EAAE;gBACX,MAAM,WAAW,CAAC,iCAAiC,oBAAoB,aAApB,oBAAoB,uBAApB,oBAAoB,CAAE,KAAK,8BAA8B,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;aAC5I;YACD,OAAO;gBACH,GAAG,EAAE,oBAAoB,CAAC,KAAK;gBAC/B,iBAAiB,EAAE,QAAQ,CAAC,SAAS;aACxC,CAAC;SACL;QACD,KAAK,QAAQ,CAAC,CAAC;YACX,IAAI,UAAU,CAAC,IAAI,KAAK,QAAQ,EAAE;gBAC9B,MAAM,WAAW,CACb,sEAAsE,UAAU,CAAC,IAAI,mBAAmB,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CACtI,CAAC;aACL;YACD,OAAO,gBAAC,CAAC,MAAM,CACX,oBAAoB,CAAC,MAAM,EAC3B,CAAC,KAA8B,EAAE,0BAA0B,EAAE,SAAS,EAAE,EAAE;gBACtE,MAAM,gBAAgB,GAAG,aAAa,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;gBAC9D,IAAI,CAAC,gBAAgB,EAAE;oBACnB,OAAO,KAAK,CAAC;iBAChB;gBACD,KAAK,CAAC,SAAS,CAAC,GAAG,0BAA0B,CAAC;oBAC1C,oBAAoB,EAAE,0BAA0B;oBAChD,SAAS;oBACT,UAAU,EAAE,gBAAgB;oBAC5B,cAAc,EAAE,cAAc,CAAC,MAAM,CAAC,SAAS,CAAC;oBAChD,cAAc,EAAE,cAAc,CAAC,MAAM,CAAC,SAAS,CAAC;oBAChD,eAAe;oBACf,cAAc;oBACd,WAAW;iBACd,CAAC,CAAC;gBACH,OAAO,KAAK,CAAC;YACjB,CAAC,EACD,EAAE,CACL,CAAC;SACL;QACD,KAAK,OAAO,CAAC,CAAC;YACV,IAAI,UAAU,CAAC,IAAI,KAAK,OAAO,EAAE;gBAC7B,MAAM,WAAW,CACb,qEAAqE,UAAU,CAAC,IAAI,mBAAmB,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CACrI,CAAC;aACL;YACD,MAAM,WAAW,GAAG,cAAc,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;YACnE,IAAI,CAAC,WAAW,EAAE;gBACd,MAAM,WAAW,CAAC,+BAA+B,oBAAoB,CAAC,SAAS,wBAAwB,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;aACxI;YACD,MAAM,YAAY,GAAG,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC9C,MAAM,QAAQ,GAAG,MAAA,MAAA,SAAS,CAAC,OAAO,0CAAE,QAAQ,0CAAG,YAAY,CAAC,CAAC;YAC7D,IAAI,QAAQ,EAAE;gBACV,+FAA+F;gBAC/F,uCAAuC;gBACvC,MAAM,QAAQ,GAAG,QAAQ,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;gBAC7E,IAAI,CAAC,QAAQ,EAAE;oBACX,MAAM,WAAW,CACb,+CAA+C,oBAAoB,CAAC,SAAS,qBAAqB,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CACjI,CAAC;iBACL;gBACD,OAAO;oBACH,CAAC,QAAQ,CAAC,EAAE,gBAAC,CAAC,MAAM,CAChB,oBAAoB,CAAC,MAAM,EAC3B,CAAC,KAA8B,EAAE,0BAA0B,EAAE,SAAS,EAAE,EAAE;wBACtE,MAAM,gBAAgB,GAAG,aAAa,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;wBAC/D,IAAI,CAAC,gBAAgB,EAAE;4BACnB,OAAO,KAAK,CAAC;yBAChB;wBACD,KAAK,CAAC,SAAS,CAAC,GAAG,0BAA0B,CAAC;4BAC1C,oBAAoB,EAAE,0BAA0B;4BAChD,SAAS,EAAE,WAAW;4BACtB,UAAU,EAAE,gBAAgB;4BAC5B,cAAc,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;4BAC5D,cAAc,EAAE,CAAC,SAAS,CAAC;4BAC3B,eAAe;4BACf,cAAc;4BACd,WAAW;yBACd,CAAC,CAAC;wBACH,OAAO,KAAK,CAAC;oBACjB,CAAC,EACD,EAAE,CACL;iBACJ,CAAC;aACL;iBAAM;gBACH,uFAAuF;gBACvF,OAAO,gBAAC,CAAC,MAAM,CACX,oBAAoB,CAAC,MAAM,EAC3B,CAAC,KAA8B,EAAE,0BAA0B,EAAE,SAAS,EAAE,EAAE;oBACtE,MAAM,gBAAgB,GAAG,aAAa,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;oBAC/D,IAAI,CAAC,gBAAgB,EAAE;wBACnB,OAAO,KAAK,CAAC;qBAChB;oBACD,KAAK,CAAC,SAAS,CAAC,GAAG,0BAA0B,CAAC;wBAC1C,oBAAoB,EAAE,0BAA0B;wBAChD,SAAS,EAAE,WAAW;wBACtB,UAAU,EAAE,gBAAgB;wBAC5B,cAAc,EAAE,cAAc,CAAC,MAAM,CAAC,SAAS,CAAC;wBAChD,cAAc,EAAE,CAAC,SAAS,CAAC;wBAC3B,eAAe;wBACf,cAAc;wBACd,WAAW;qBACd,CAAC,CAAC;oBACH,OAAO,KAAK,CAAC;gBACjB,CAAC,EACD,EAAE,CACL,CAAC;aACL;SACJ;QACD,KAAK,MAAM,CAAC,CAAC;YACT,IAAI,UAAU,CAAC,IAAI,KAAK,MAAM,EAAE;gBAC5B,MAAM,WAAW,CACb,oEAAoE,UAAU,CAAC,IAAI,mBAAmB,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CACpI,CAAC;aACL;YACD,OAAO,gBAAC,CAAC,MAAM,CACX,oBAAoB,CAAC,KAAK,EAC1B,CAAC,KAAY,EAAE,QAAoD,EAAE,KAAK,EAAE,EAAE;gBAC1E,KAAK,CAAC,IAAI,CACN,0BAA0B,CAAC;oBACvB,oBAAoB,EAAE,QAAQ;oBAC9B,SAAS;oBACT,UAAU,EAAE,UAAU,CAAC,KAAK;oBAC5B,cAAc,EAAE,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC;oBAC5C,cAAc,EAAE,cAAc;oBAC9B,eAAe;oBACf,cAAc;oBACd,WAAW;iBACd,CAAC,CACL,CAAC;gBACF,OAAO,KAAK,CAAC;YACjB,CAAC,EACD,EAAE,CACL,CAAC;SACL;QACD,OAAO,CAAC,CAAC;YACL,MAAM,gBAAgB,GAAU,oBAAoB,CAAC;YACrD,OAAO,gBAAgB,CAAC;SAC3B;KACJ;AACL,CAAC;AAjMD,gEAiMC;AAED,SAAS,aAAa,CAAC,KAAwD,EAAE,SAAiB;;IAC9F,OAAO,MAAA,KAAK,CAAC,MAAM,0CAAE,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;AACnE,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC5B,OAAO,gBAAC,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;AAClC,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAY;IACnC,OAAO,gBAAC,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE;QACpC,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE;YAChB,OAAO,KAAK,CAAC,GAAG,CAAC;SACpB;IACL,CAAC,CAAC,CAAC;AACP,CAAC;AAED,SAAS,OAAO,CAAC,KAAc;IAC3B,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE;QAChC,OAAO,KAAK,CAAC;KAChB;IACD,kEAAkE;IAClE,MAAM,SAAS,GAAG,CAAC,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,cAAc,EAAE,WAAW,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;IAClI,MAAM,UAAU,GAAG,gBAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACjC,OAAO,gBAAC,CAAC,UAAU,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;AAC5D,CAAC"}

package/dist/contentstack-types.d.ts

@@ -220,6 +220,11 @@ export declare type Entry = ContentStackEntry & {
     updated_at: string;
     created_by: string;
     updated_by: string;
+    /**
+     * The entry's locale.
+     * Note, this can be different from the `publish_details.locale` if the
+     * entry was not localized for the published locale.
+     */
     locale?: string;
     tags?: string[];
     publish_details?: PublishDetails[];
@@ -232,23 +237,49 @@ export declare type PublishDetails = {
     environment: string;
     time: string;
     user: string;
+    /**
+     * The version of the entry that was published.
+     * If the entry_locale is provided, then the version is of that entry locale.
+     * Otherwise, it is a version of the entry's own locale.
+     */
     version: number;
     /**
-     * The locale of the published document.
-     * Note, the locale may be different from entry's own locale.
+     * The published locale.
+     * Note, the published locale may be different from the entry's locale if a
+     * non-localized entry was published.
+     *
+     * For example, a non-localized "fr-fr" entry can be published to the "fr-fr"
+     * locale. In this case, the entry will be published from the values stored
+     * in the entry of the fallback locale, e.g., 'en-us'. When this entry is
+     * fetched using the content delivery API with `locale=fr-fr` it will return
+     * the entry with `locale: 'en-us'`, and `publish_details.locale: 'fr-fr'`.
+     *
+     * If an entry was not published to a `fr-fr` locale but was published to its
+     * fallback locale, then it will be returned from the Content Delivery API
+     * for `locale=fr-fr` parameter only if it also has `include_fallback=false`.
+     * In other words, non-published locales will be returned only when
+     * `include_fallback=true`.
      */
     locale: string;
     /**
-     * The 'entry_locale' specified the original entry locale under which the
-     * entry was published, it may be different from the 'locale'.
+     * The 'publish_details.entry_locale' specifies the original entry locale
+     * from which the entry was published, and it may be different from the
+     * 'publish_details.locale' if the entry was localized after it was published.
+     *
+     * It also specifies the entry's locale the version field relates to.
      *
-     * For example, if an entry with locale "A" has been published to locale "B",
-     * for which it isn't localized. Then the 'locale' will be locale "B", while
-     * the entry's own locale will remain "A" (because it is not localized),
-     * even when entries are fetched with locale=B filter.
-     * But, once the entry will be localized to locale "B", the 'entry_locale'
-     * will be set to locale "A", and the 'locale' will be set to locale "B"
-     * matching the entry's own locale.
+     * For example, if an entry with locale "en-us" has been published to "fr-fr"
+     * locale without having a localized entry for "fr-fr". Then, when the entry
+     * is fetched with the locale=fr-fr filter, the `publish_details.locale`
+     * will be set to "fr-fr", but the entry's locale will remain "en-us" because
+     * it was not localized, and the `publish_details.entry_locale` will be undefined.
+     * Then, if the entry will be localized to "fr-fr" locale, the locale of
+     * the entry will be changed to "fr-fr", the `publish_details.locale` will
+     * remain "fr-fr" and the `publish_details.entry_locale` will be set to
+     * "en-us" specifying that the published entry's locale doesn't match the
+     * current's entry locale. Only after the localized "fr-fr" entry will be
+     * published to "fr-fr", then the `publish_details.entry_locale` will be set
+     * back to undefined.
      */
     entry_locale?: string;
 };