contentful-import 9.1.0 → 9.2.0

package/dist/tasks/push-to-space/push-to-space.js

@@ -1,329 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (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 });
-const listr_1 = __importDefault(require("listr"));
-const listr_verbose_renderer_1 = __importDefault(require("listr-verbose-renderer"));
-const logging_1 = require("contentful-batch-libs/dist/logging");
-const listr_2 = require("contentful-batch-libs/dist/listr");
-const assets = __importStar(require("./assets"));
-const creation = __importStar(require("./creation"));
-const publishing = __importStar(require("./publishing"));
-const DEFAULT_CONTENT_STRUCTURE = {
-    entries: [],
-    assets: [],
-    contentTypes: [],
-    tags: [],
-    locales: [],
-    webhooks: [],
-    editorInterfaces: []
-};
-/**
- * Pushes all changes to a given space. Handles (un)publishing
- * as well as delays after creation and before publishing.
- *
- * Creates everything in the right order so that a content type for a given entry
- * is there when entry creation for that content type is attempted.
- *
- * Allows only content model or only content pushing.
- *
- * Options:
- * - sourceData: see DEFAULT_CONTENT_STRUCTURE
- * - destinationData: see DEFAULT_CONTENT_STRUCTURE
- * - client: preconfigured management API client
- * - spaceId: ID of space content is being copied to
- * - contentModelOnly: synchronizes only content types and locales
- * - skipLocales: skips locales when synchronizing the content model
- * - skipContentModel: synchronizes only entries and assets
- * - skipContentPublishing: create content but don't publish it
- * - uploadAssets: upload exported files instead of pointing to an existing URL
- * - assetsDirectory: path to exported asset files to be uploaded instead of pointing to an existing URL
- */
-function pushToSpace({ sourceData, destinationData = {}, client, spaceId, environmentId, contentModelOnly, skipContentModel, skipLocales, skipContentPublishing, timeout, retryLimit, listrOptions, uploadAssets, assetsDirectory, requestQueue }) {
-    sourceData = {
-        ...DEFAULT_CONTENT_STRUCTURE,
-        ...sourceData
-    };
-    destinationData = {
-        ...DEFAULT_CONTENT_STRUCTURE,
-        ...destinationData
-    };
-    listrOptions = listrOptions || {
-        renderer: listr_verbose_renderer_1.default
-    };
-    const destinationDataById = {};
-    for (const [entityType, entities] of Object.entries(destinationData)) {
-        const entitiesById = new Map();
-        for (const entity of entities) {
-            entitiesById.set(entity.sys.id, entity);
-        }
-        destinationDataById[entityType] = entitiesById;
-    }
-    return new listr_1.default([
-        {
-            title: 'Connecting to space',
-            task: (0, listr_2.wrapTask)(async (ctx, task) => {
-                const space = await client.getSpace(spaceId);
-                const environment = await space.getEnvironment(environmentId);
-                ctx.space = space;
-                ctx.environment = environment;
-            })
-        },
-        {
-            title: 'Importing Locales',
-            task: (0, listr_2.wrapTask)(async (ctx, task) => {
-                const locales = await creation.createLocales({
-                    context: { target: ctx.environment, type: 'Locale' },
-                    entities: sourceData.locales,
-                    destinationEntitiesById: destinationDataById.locales,
-                    requestQueue
-                });
-                ctx.data.locales = locales;
-            }),
-            skip: () => skipContentModel || skipLocales
-        },
-        {
-            title: 'Importing Content Types',
-            task: (0, listr_2.wrapTask)(async (ctx, task) => {
-                const contentTypes = await creation.createEntities({
-                    context: { target: ctx.environment, type: 'ContentType' },
-                    entities: sourceData.contentTypes,
-                    destinationEntitiesById: destinationDataById.contentTypes,
-                    requestQueue
-                });
-                ctx.data.contentTypes = contentTypes;
-            }),
-            skip: () => skipContentModel
-        },
-        {
-            title: 'Publishing Content Types',
-            task: (0, listr_2.wrapTask)(async (ctx, task) => {
-                const publishedContentTypes = await publishEntities({
-                    entities: ctx.data.contentTypes,
-                    sourceEntities: sourceData.contentTypes,
-                    requestQueue
-                });
-                ctx.data.contentTypes = publishedContentTypes;
-            }),
-            skip: (ctx) => skipContentModel
-        },
-        {
-            title: 'Importing Tags',
-            task: (0, listr_2.wrapTask)(async (ctx, task) => {
-                const tags = await creation.createEntities({
-                    context: { target: ctx.environment, type: 'Tag' },
-                    entities: sourceData.tags,
-                    destinationEntitiesById: destinationDataById.tags,
-                    requestQueue
-                });
-                ctx.data.tags = tags;
-            }),
-            // we remove `tags` from destination data if an error was thrown trying to access them
-            // this means the user doesn't have access to this feature, skip importing tags
-            skip: () => !destinationDataById.tags
-        },
-        {
-            title: 'Importing Editor Interfaces',
-            task: (0, listr_2.wrapTask)(async (ctx, task) => {
-                const allEditorInterfacesBeingFetched = ctx.data.contentTypes.map(async (contentType) => {
-                    const editorInterface = sourceData.editorInterfaces.find((editorInterface) => {
-                        return editorInterface.sys.contentType.sys.id === contentType.sys.id;
-                    });
-                    if (!editorInterface) {
-                        return;
-                    }
-                    try {
-                        const ctEditorInterface = await requestQueue.add(() => ctx.environment.getEditorInterfaceForContentType(contentType.sys.id));
-                        logging_1.logEmitter.emit('info', `Fetched editor interface for ${contentType.name}`);
-                        ctEditorInterface.controls = editorInterface.controls;
-                        ctEditorInterface.groupControls = editorInterface.groupControls;
-                        ctEditorInterface.editorLayout = editorInterface.editorLayout;
-                        const updatedEditorInterface = await requestQueue.add(() => ctEditorInterface.update());
-                        return updatedEditorInterface;
-                    }
-                    catch (err) {
-                        err.entity = editorInterface;
-                        throw err;
-                    }
-                });
-                const allEditorInterfaces = await Promise.all(allEditorInterfacesBeingFetched);
-                const editorInterfaces = allEditorInterfaces.filter((editorInterface) => editorInterface);
-                ctx.data.editorInterfaces = editorInterfaces;
-            }),
-            skip: (ctx) => skipContentModel || ctx.data.contentTypes.length === 0
-        },
-        {
-            title: 'Uploading Assets',
-            task: (0, listr_2.wrapTask)(async (ctx, task) => {
-                const allPendingUploads = [];
-                for (const asset of sourceData.assets) {
-                    for (const file of Object.values(asset.transformed.fields.file)) {
-                        allPendingUploads.push(requestQueue.add(async () => {
-                            try {
-                                logging_1.logEmitter.emit('info', `Uploading Asset file ${file.upload}`);
-                                const assetStream = await assets.getAssetStreamForURL(file.upload, assetsDirectory);
-                                const upload = await ctx.environment.createUpload({
-                                    fileName: asset.transformed.sys.id,
-                                    file: assetStream
-                                });
-                                delete file.upload;
-                                file.uploadFrom = {
-                                    sys: {
-                                        type: 'Link',
-                                        linkType: 'Upload',
-                                        id: upload.sys.id
-                                    }
-                                };
-                                return upload;
-                            }
-                            catch (err) {
-                                logging_1.logEmitter.emit('error', err);
-                            }
-                        }));
-                    }
-                }
-                // We call the pending uploads for the side effects
-                // so we can just await all pending ones that are queued
-                const uploads = await Promise.all(allPendingUploads);
-                ctx.data.uploadedAssetFiles = uploads;
-            }),
-            skip: (ctx) => !uploadAssets || !sourceData.assets.length
-        },
-        {
-            title: 'Importing Assets',
-            task: (0, listr_2.wrapTask)(async (ctx, task) => {
-                const assetsToProcess = await creation.createEntities({
-                    context: { target: ctx.environment, type: 'Asset' },
-                    entities: sourceData.assets,
-                    destinationEntitiesById: destinationDataById.assets,
-                    requestQueue
-                });
-                const processedAssets = await assets.processAssets({
-                    assets: assetsToProcess,
-                    timeout,
-                    retryLimit,
-                    requestQueue
-                });
-                ctx.data.assets = processedAssets;
-            }),
-            skip: (ctx) => contentModelOnly
-        },
-        {
-            title: 'Publishing Assets',
-            task: (0, listr_2.wrapTask)(async (ctx, task) => {
-                const publishedAssets = await publishEntities({
-                    entities: ctx.data.assets,
-                    sourceEntities: sourceData.assets,
-                    requestQueue
-                });
-                ctx.data.publishedAssets = publishedAssets;
-            }),
-            skip: (ctx) => contentModelOnly || skipContentPublishing
-        },
-        {
-            title: 'Archiving Assets',
-            task: (0, listr_2.wrapTask)(async (ctx, task) => {
-                const archivedAssets = await archiveEntities({
-                    entities: ctx.data.assets,
-                    sourceEntities: sourceData.assets,
-                    requestQueue
-                });
-                ctx.data.archivedAssets = archivedAssets;
-            }),
-            skip: (ctx) => contentModelOnly || skipContentPublishing
-        },
-        {
-            title: 'Importing Content Entries',
-            task: (0, listr_2.wrapTask)(async (ctx, task) => {
-                const entries = await creation.createEntries({
-                    context: { target: ctx.environment, skipContentModel },
-                    entities: sourceData.entries,
-                    destinationEntitiesById: destinationDataById.entries,
-                    requestQueue
-                });
-                ctx.data.entries = entries;
-            }),
-            skip: (ctx) => contentModelOnly
-        },
-        {
-            title: 'Publishing Content Entries',
-            task: (0, listr_2.wrapTask)(async (ctx, task) => {
-                const publishedEntries = await publishEntities({
-                    entities: ctx.data.entries,
-                    sourceEntities: sourceData.entries,
-                    requestQueue
-                });
-                ctx.data.publishedEntries = publishedEntries;
-            }),
-            skip: (ctx) => contentModelOnly || skipContentPublishing
-        },
-        {
-            title: 'Archiving Entries',
-            task: (0, listr_2.wrapTask)(async (ctx, task) => {
-                const archivedEntries = await archiveEntities({
-                    entities: ctx.data.entries,
-                    sourceEntities: sourceData.entries,
-                    requestQueue
-                });
-                ctx.data.archivedEntries = archivedEntries;
-            }),
-            skip: (ctx) => contentModelOnly || skipContentPublishing
-        },
-        {
-            title: 'Creating Web Hooks',
-            task: (0, listr_2.wrapTask)(async (ctx, task) => {
-                const webhooks = await creation.createEntities({
-                    context: { target: ctx.space, type: 'Webhook' },
-                    entities: sourceData.webhooks,
-                    destinationEntitiesById: destinationDataById.webhooks,
-                    requestQueue
-                });
-                ctx.data.webhooks = webhooks;
-            }),
-            skip: (ctx) => contentModelOnly || (environmentId !== 'master' && 'Webhooks can only be imported in master environment')
-        }
-    ], listrOptions);
-}
-exports.default = pushToSpace;
-function archiveEntities({ entities, sourceEntities, requestQueue }) {
-    const entityIdsToArchive = sourceEntities
-        .filter(({ original }) => original.sys.archivedVersion)
-        .map(({ original }) => original.sys.id);
-    const entitiesToArchive = entities
-        .filter((entity) => entityIdsToArchive.indexOf(entity.sys.id) !== -1);
-    return publishing.archiveEntities({ entities: entitiesToArchive, requestQueue });
-}
-function publishEntities({ entities, sourceEntities, requestQueue }) {
-    // Find all entities in source content which are published
-    const entityIdsToPublish = sourceEntities
-        .filter(({ original }) => original.sys.publishedVersion)
-        .map(({ original }) => original.sys.id);
-    // Filter imported entities and publish only these who got published in the source
-    const entitiesToPublish = entities
-        .filter((entity) => entityIdsToPublish.indexOf(entity.sys.id) !== -1);
-    return publishing.publishEntities({ entities: entitiesToPublish, requestQueue });
-}

package/dist/transform/transform-space.js

@@ -1,56 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (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 });
-const object_1 = require("lodash/object");
-const defaultTransformers = __importStar(require("./transformers"));
-const sort_entries_1 = __importDefault(require("../utils/sort-entries"));
-const sort_locales_1 = __importDefault(require("../utils/sort-locales"));
-const spaceEntities = [
-    'contentTypes', 'entries', 'assets', 'locales', 'webhooks', 'tags'
-];
-/**
- * Run transformer methods on each item for each kind of entity, in case there
- * is a need to transform data when copying it to the destination space
- */
-function default_1(sourceData, destinationData, customTransformers, entities = spaceEntities) {
-    const transformers = (0, object_1.defaults)(customTransformers, defaultTransformers);
-    const baseSpaceData = (0, object_1.omit)(sourceData, ...entities);
-    sourceData.locales = (0, sort_locales_1.default)(sourceData.locales);
-    const tagsEnabled = !!destinationData.tags;
-    return entities.reduce((transformedSpaceData, type) => {
-        // tags don't contain links to other entities, don't need to be sorted
-        const sortedEntities = (type === 'tags') ? sourceData[type] : (0, sort_entries_1.default)(sourceData[type]);
-        const transformedEntities = sortedEntities.map((entity) => ({
-            original: entity,
-            transformed: transformers[type](entity, destinationData[type], tagsEnabled)
-        }));
-        transformedSpaceData[type] = transformedEntities;
-        return transformedSpaceData;
-    }, baseSpaceData);
-}
-exports.default = default_1;

package/dist/transform/transformers.js

@@ -1,70 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.locales = exports.assets = exports.webhooks = exports.entries = exports.tags = exports.contentTypes = void 0;
-const object_1 = require("lodash/object");
-const collection_1 = require("lodash/collection");
-/**
- * Default transformer methods for each kind of entity.
- *
- * In the case of assets it also changes the asset url to the upload property
- * as the whole upload process needs to be followed again.
- */
-function contentTypes(contentType) {
-    return contentType;
-}
-exports.contentTypes = contentTypes;
-function tags(tag) {
-    return tag;
-}
-exports.tags = tags;
-function entries(entry, _, tagsEnabled = false) {
-    return removeMetadataTags(entry, tagsEnabled);
-}
-exports.entries = entries;
-function webhooks(webhook) {
-    // Workaround for webhooks with credentials
-    if (webhook.httpBasicUsername) {
-        delete webhook.httpBasicUsername;
-    }
-    // Workaround for webhooks with secret headers
-    if (webhook.headers) {
-        webhook.headers = webhook.headers.filter(header => !header.secret);
-    }
-    return webhook;
-}
-exports.webhooks = webhooks;
-function assets(asset, _, tagsEnabled = false) {
-    const transformedAsset = (0, object_1.omit)(asset, 'sys');
-    transformedAsset.sys = (0, object_1.pick)(asset.sys, 'id');
-    transformedAsset.fields = (0, object_1.pick)(asset.fields, 'title', 'description');
-    transformedAsset.fields.file = (0, collection_1.reduce)(asset.fields.file, (newFile, localizedFile, locale) => {
-        newFile[locale] = (0, object_1.pick)(localizedFile, 'contentType', 'fileName');
-        if (!localizedFile.uploadFrom) {
-            const assetUrl = localizedFile.url || localizedFile.upload;
-            newFile[locale].upload = `${/^(http|https):\/\//i.test(assetUrl) ? '' : 'https:'}${assetUrl}`;
-        }
-        else {
-            newFile[locale].uploadFrom = localizedFile.uploadFrom;
-        }
-        return newFile;
-    }, {});
-    return removeMetadataTags(transformedAsset, tagsEnabled);
-}
-exports.assets = assets;
-function locales(locale, destinationLocales) {
-    const transformedLocale = (0, object_1.pick)(locale, 'code', 'name', 'contentManagementApi', 'contentDeliveryApi', 'fallbackCode', 'optional');
-    const destinationLocale = (0, collection_1.find)(destinationLocales, { code: locale.code });
-    if (destinationLocale) {
-        // This will implicitly remove the locale ID
-        // which then causes the create path to not pick `createLocaleWithId` but `createLocale` instead
-        transformedLocale.sys = (0, object_1.pick)(destinationLocale.sys, 'id');
-    }
-    return transformedLocale;
-}
-exports.locales = locales;
-function removeMetadataTags(entity, tagsEnabled = false) {
-    if (!tagsEnabled) {
-        delete entity.metadata;
-    }
-    return entity;
-}

package/dist/usageParams.js

@@ -1,115 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (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 });
-const yargs_1 = __importDefault(require("yargs"));
-const packageFile = __importStar(require("../package"));
-exports.default = yargs_1.default
-    .version(packageFile.version || 'Version only available on installed package')
-    .usage('Usage: $0 [options]')
-    .option('space-id', {
-    describe: 'ID of the destination space',
-    type: 'string',
-    demand: true
-})
-    .option('environment-id', {
-    describe: 'ID the environment in the destination space',
-    type: 'string',
-    default: 'master',
-    demand: false
-})
-    .option('management-token', {
-    describe: 'Contentful management API token for the destination space',
-    type: 'string',
-    demand: true
-})
-    .option('content-file', {
-    describe: 'JSON file that contains data to be import to your space',
-    type: 'string',
-    demand: true
-})
-    .option('content-model-only', {
-    describe: 'Import only content types',
-    type: 'boolean',
-    default: false
-})
-    .option('skip-content-model', {
-    describe: 'Skip importing content types and locales',
-    type: 'boolean',
-    default: false
-})
-    .option('skip-locales', {
-    describe: 'Skip importing locales',
-    type: 'boolean',
-    default: false
-})
-    .option('skip-content-publishing', {
-    describe: 'Skips content publishing. Creates content but does not publish it',
-    type: 'boolean',
-    default: false
-})
-    .option('upload-assets', {
-    describe: 'Uses local asset files and uploads them instead of pointing to the URLs of previously uploaded assets. Requires assets-directory',
-    type: 'boolean',
-    default: false
-})
-    .implies('upload-assets', 'assets-directory')
-    .option('assets-directory', {
-    describe: 'Path to a directory with an asset export made using the downloadAssets option to upload those files instead of pointing to the URLs of previously uploaded assets. Requires upload-assets',
-    type: 'string'
-})
-    .implies('assets-directory', 'upload-assets')
-    .option('error-log-file', {
-    describe: 'Full path to the error log file',
-    type: 'string'
-})
-    .option('host', {
-    describe: 'Management API host',
-    type: 'string',
-    default: 'api.contentful.com'
-})
-    .option('proxy', {
-    describe: 'Proxy configuration in HTTP auth format: [http|https]://host:port or [http|https]://user:password@host:port',
-    type: 'string'
-})
-    .option('raw-proxy', {
-    describe: 'Pass proxy config to Axios instead of creating a custom httpsAgent',
-    type: 'boolean',
-    default: false
-})
-    .option('rate-limit', {
-    describe: 'Maximum requests per second used for API requests',
-    type: 'number',
-    default: 7
-})
-    .option('header', {
-    alias: 'H',
-    type: 'string',
-    describe: 'Pass an additional HTTP Header'
-})
-    .config('config', 'An optional configuration JSON file containing all the options for a single run')
-    .argv;

package/dist/utils/headers.js

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getHeadersConfig = void 0;
-/**
- * Turn header option into an object. Invalid header values
- * are ignored.
- *
- * @example
- * getHeadersConfig('Accept: Any')
- * // -> {Accept: 'Any'}
- *
- * @example
- * getHeadersConfig(['Accept: Any', 'X-Version: 1'])
- * // -> {Accept: 'Any', 'X-Version': '1'}
- *
- * @param value {string|string[]}
- */
-function getHeadersConfig(value) {
-    if (!value) {
-        return {};
-    }
-    const values = Array.isArray(value) ? value : [value];
-    return values.reduce((headers, value) => {
-        value = value.trim();
-        const separatorIndex = value.indexOf(':');
-        // Invalid header format
-        if (separatorIndex === -1) {
-            return headers;
-        }
-        const headerKey = value.slice(0, separatorIndex).trim();
-        const headerValue = value.slice(separatorIndex + 1).trim();
-        return {
-            ...headers,
-            [headerKey]: headerValue
-        };
-    }, {});
-}
-exports.getHeadersConfig = getHeadersConfig;