@kontent-ai/migration-toolkit 2.9.1 → 3.0.0-1

package/lib/node/cli/commands.ts

@@ -1,158 +1,170 @@
-import { argumentsSetter } from './args/args-setter.js';
+import { argumentsSetter } from "./args/args-setter.js";
 
 export const cliArgs = argumentsSetter()
-    .withCommand({
-        name: 'export',
-        description: 'Exports content (items & assets) from Kontent.ai environment',
-        examples: [`kontent-ai-migration-toolkit export --sourceEnvironmentId=x --sourceApiKey=x --language=default --items=itemA,itemB`],
-        options: [
-            {
-                name: `sourceApiKey`,
-                description: `Api key used for request authorization`,
-                type: 'string',
-                isRequired: true
-            },
-            {
-                name: `sourceEnvironmentId`,
-                description: `Environment id of the source environment`,
-                type: 'string',
-                isRequired: true
-            },
-            {
-                name: `language`,
-                description: `Language codename of items to export`,
-                type: 'string',
-                isRequired: true
-            },
-            {
-                name: `items`,
-                description: `Comma separated item codenames to export`,
-                type: 'string',
-                isRequired: true
-            },
-            {
-                name: `filename`,
-                description: `Name of items file to export / import`,
-                type: 'string',
-                isRequired: false
-            },
-            {
-                name: `assetsFilename`,
-                description: `Name of assets file to export / import`,
-                type: 'string',
-                isRequired: false
-            },
-            {
-                name: `baseUrl`,
-                description: `Custom base URL`,
-                type: 'string',
-                isRequired: false
-            }
-        ]
-    })
+	.withCommand({
+		name: "export",
+		description: "Exports content (items & assets) from Kontent.ai environment",
+		examples: [`kontent-ai-migration-toolkit export --sourceEnvironmentId=x --sourceApiKey=x --language=default --items=itemA,itemB`],
+		options: [
+			{
+				name: `sourceApiKey`,
+				description: `Api key used for request authorization`,
+				type: "string",
+				isRequired: true,
+			},
+			{
+				name: `sourceEnvironmentId`,
+				description: `Environment id of the source environment`,
+				type: "string",
+				isRequired: true,
+			},
+			{
+				name: `language`,
+				description: `Language codename of items to export`,
+				type: "string",
+				isRequired: true,
+			},
+			{
+				name: `items`,
+				description: `Comma separated item codenames to export`,
+				type: "string",
+				isRequired: true,
+			},
+			{
+				name: `filename`,
+				description: `Name of items file to export / import`,
+				type: "string",
+				isRequired: false,
+			},
+			{
+				name: `assetsFilename`,
+				description: `Name of assets file to export / import`,
+				type: "string",
+				isRequired: false,
+			},
+			{
+				name: `baseUrl`,
+				description: `Custom base URL`,
+				type: "string",
+				isRequired: false,
+			},
+			{
+				name: `skipMissingReferences`,
+				description: `When enabled, missing items and assets will be skipped instead of throwing errors`,
+				type: "boolean",
+				isRequired: false,
+			},
+		],
+	})
 
-    .withCommand({
-        name: 'import',
-        description: 'Imports content (items & assets) into Kontent.ai environment',
-        examples: [
-            `kontent-ai-migration-toolkit import --targetEnvironmentId=x --targetApiKey=x --filename=items.zip --assetsFilename=assets.zip`
-        ],
-        options: [
-            {
-                name: `targetApiKey`,
-                description: `Api key used for request authorization`,
-                type: 'string',
-                isRequired: true
-            },
-            {
-                name: `targetEnvironmentId`,
-                description: `Environment id of the target environment`,
-                type: 'string',
-                isRequired: true
-            },
-            {
-                name: `filename`,
-                description: `Name of items file to export / import`,
-                type: 'string',
-                isRequired: false
-            },
-            {
-                name: `assetsFilename`,
-                description: `Name of assets file to export / import`,
-                type: 'string',
-                isRequired: false
-            },
-            {
-                name: `baseUrl`,
-                description: `Custom base URL`,
-                type: 'string',
-                isRequired: false
-            }
-        ]
-    })
+	.withCommand({
+		name: "import",
+		description: "Imports content (items & assets) into Kontent.ai environment",
+		examples: [
+			`kontent-ai-migration-toolkit import --targetEnvironmentId=x --targetApiKey=x --filename=items.zip --assetsFilename=assets.zip`,
+		],
+		options: [
+			{
+				name: `targetApiKey`,
+				description: `Api key used for request authorization`,
+				type: "string",
+				isRequired: true,
+			},
+			{
+				name: `targetEnvironmentId`,
+				description: `Environment id of the target environment`,
+				type: "string",
+				isRequired: true,
+			},
+			{
+				name: `filename`,
+				description: `Name of items file to export / import`,
+				type: "string",
+				isRequired: false,
+			},
+			{
+				name: `assetsFilename`,
+				description: `Name of assets file to export / import`,
+				type: "string",
+				isRequired: false,
+			},
+			{
+				name: `baseUrl`,
+				description: `Custom base URL`,
+				type: "string",
+				isRequired: false,
+			},
+		],
+	})
 
-    .withCommand({
-        name: 'migrate',
-        description: 'Migrates content (items & assets) from one Kontent.ai environment into another Kontent.ai environment',
-        examples: [
-            `kontent-ai-migration-toolkit migrate --targetEnvironmentId=x --targetApiKey=x --sourceEnvironmentId=x --sourceApiKey=x --language=default --items=itemA,itemB`
-        ],
-        options: [
-            {
-                name: `sourceApiKey`,
-                description: `Api key used for request authorization`,
-                type: 'string',
-                isRequired: true
-            },
-            {
-                name: `sourceEnvironmentId`,
-                description: `Environment id of the source environment`,
-                type: 'string',
-                isRequired: true
-            },
-            {
-                name: `language`,
-                description: `Language codename of items to export`,
-                type: 'string',
-                isRequired: true
-            },
-            {
-                name: `items`,
-                description: `Comma separated item codenames to export`,
-                type: 'string',
-                isRequired: true
-            },
-            {
-                name: `targetApiKey`,
-                description: `Api key used for request authorization`,
-                type: 'string',
-                isRequired: true
-            },
-            {
-                name: `targetEnvironmentId`,
-                description: `Environment id of the target environment`,
-                type: 'string',
-                isRequired: true
-            },
-            {
-                name: `baseUrl`,
-                description: `Custom base URL`,
-                type: 'string',
-                isRequired: false
-            }
-        ]
-    })
+	.withCommand({
+		name: "migrate",
+		description: "Migrates content (items & assets) from one Kontent.ai environment into another Kontent.ai environment",
+		examples: [
+			`kontent-ai-migration-toolkit migrate --targetEnvironmentId=x --targetApiKey=x --sourceEnvironmentId=x --sourceApiKey=x --language=default --items=itemA,itemB`,
+		],
+		options: [
+			{
+				name: `sourceApiKey`,
+				description: `Api key used for request authorization`,
+				type: "string",
+				isRequired: true,
+			},
+			{
+				name: `sourceEnvironmentId`,
+				description: `Environment id of the source environment`,
+				type: "string",
+				isRequired: true,
+			},
+			{
+				name: `language`,
+				description: `Language codename of items to export`,
+				type: "string",
+				isRequired: true,
+			},
+			{
+				name: `items`,
+				description: `Comma separated item codenames to export`,
+				type: "string",
+				isRequired: true,
+			},
+			{
+				name: `targetApiKey`,
+				description: `Api key used for request authorization`,
+				type: "string",
+				isRequired: true,
+			},
+			{
+				name: `targetEnvironmentId`,
+				description: `Environment id of the target environment`,
+				type: "string",
+				isRequired: true,
+			},
+			{
+				name: `baseUrl`,
+				description: `Custom base URL`,
+				type: "string",
+				isRequired: false,
+			},
+			{
+				name: `skipMissingReferences`,
+				description: `When enabled, missing items and assets will be skipped instead of throwing errors`,
+				type: "boolean",
+				isRequired: false,
+			},
+		],
+	})
 
-    .withOption({
-        alias: `f`,
-        name: `force`,
-        description: `When enabled, confirmation is not required`,
-        type: 'boolean',
-        isRequired: false
-    })
-    .withOption({
-        alias: `h`,
-        name: `help`,
-        description: `Show help`,
-        isRequired: false
-    });
+	.withOption({
+		alias: `f`,
+		name: `force`,
+		description: `When enabled, confirmation is not required`,
+		type: "boolean",
+		isRequired: false,
+	})
+	.withOption({
+		alias: `h`,
+		name: `help`,
+		description: `Show help`,
+		isRequired: false,
+	});

package/lib/toolkit/elements-builder.ts

@@ -1,72 +1,72 @@
-import type { MigrationElementModels } from '../core/index.js';
+import type { MigrationElementModels } from "../core/models/migration.models.js";
 
 export const elementsBuilder = {
-    textElement: (data: Omit<MigrationElementModels.TextElement, 'type'>): MigrationElementModels.TextElement => {
-        return {
-            ...data,
-            type: 'text'
-        };
-    },
-    assetElement: (data: Omit<MigrationElementModels.AssetElement, 'type'>): MigrationElementModels.AssetElement => {
-        return {
-            ...data,
-            type: 'asset'
-        };
-    },
-    customElement: (data: Omit<MigrationElementModels.CustomElement, 'type'>): MigrationElementModels.CustomElement => {
-        return {
-            ...data,
-            type: 'custom'
-        };
-    },
-    dateTimeElement: (data: Omit<MigrationElementModels.DateTimeElement, 'type'>): MigrationElementModels.DateTimeElement => {
-        return {
-            ...data,
-            type: 'date_time'
-        };
-    },
-    linkedItemsElement: (data: Omit<MigrationElementModels.LinkedItemsElement, 'type'>): MigrationElementModels.LinkedItemsElement => {
-        return {
-            ...data,
-            type: 'modular_content'
-        };
-    },
-    multipleChoiceElement: (
-        data: Omit<MigrationElementModels.MultipleChoiceElement, 'type'>
-    ): MigrationElementModels.MultipleChoiceElement => {
-        return {
-            ...data,
-            type: 'multiple_choice'
-        };
-    },
-    numberElement: (data: Omit<MigrationElementModels.NumberElement, 'type'>): MigrationElementModels.NumberElement => {
-        return {
-            ...data,
-            type: 'number'
-        };
-    },
-    richTextElement: (data: Omit<MigrationElementModels.RichTextElement, 'type'>): MigrationElementModels.RichTextElement => {
-        return {
-            ...data,
-            type: 'rich_text'
-        };
-    },
-    subpagesElement: (data: Omit<MigrationElementModels.SubpagesElement, 'type'>): MigrationElementModels.SubpagesElement => {
-        return {
-            ...data,
-            type: 'subpages'
-        };
-    },
-    taxonomyElement: (data: Omit<MigrationElementModels.TaxonomyElement, 'type'>): MigrationElementModels.TaxonomyElement => {
-        return {
-            ...data,
-            type: 'taxonomy'
-        };
-    },
-    urlSlugElement: (data: Omit<MigrationElementModels.UrlSlugElement, 'type'>): MigrationElementModels.UrlSlugElement => {
-        return {
-            ...data,
-            type: 'url_slug'
-        };
-    }
+	textElement: (data: Omit<MigrationElementModels.TextElement, "type">): MigrationElementModels.TextElement => {
+		return {
+			...data,
+			type: "text",
+		};
+	},
+	assetElement: (data: Omit<MigrationElementModels.AssetElement, "type">): MigrationElementModels.AssetElement => {
+		return {
+			...data,
+			type: "asset",
+		};
+	},
+	customElement: (data: Omit<MigrationElementModels.CustomElement, "type">): MigrationElementModels.CustomElement => {
+		return {
+			...data,
+			type: "custom",
+		};
+	},
+	dateTimeElement: (data: Omit<MigrationElementModels.DateTimeElement, "type">): MigrationElementModels.DateTimeElement => {
+		return {
+			...data,
+			type: "date_time",
+		};
+	},
+	linkedItemsElement: (data: Omit<MigrationElementModels.LinkedItemsElement, "type">): MigrationElementModels.LinkedItemsElement => {
+		return {
+			...data,
+			type: "modular_content",
+		};
+	},
+	multipleChoiceElement: (
+		data: Omit<MigrationElementModels.MultipleChoiceElement, "type">,
+	): MigrationElementModels.MultipleChoiceElement => {
+		return {
+			...data,
+			type: "multiple_choice",
+		};
+	},
+	numberElement: (data: Omit<MigrationElementModels.NumberElement, "type">): MigrationElementModels.NumberElement => {
+		return {
+			...data,
+			type: "number",
+		};
+	},
+	richTextElement: (data: Omit<MigrationElementModels.RichTextElement, "type">): MigrationElementModels.RichTextElement => {
+		return {
+			...data,
+			type: "rich_text",
+		};
+	},
+	subpagesElement: (data: Omit<MigrationElementModels.SubpagesElement, "type">): MigrationElementModels.SubpagesElement => {
+		return {
+			...data,
+			type: "subpages",
+		};
+	},
+	taxonomyElement: (data: Omit<MigrationElementModels.TaxonomyElement, "type">): MigrationElementModels.TaxonomyElement => {
+		return {
+			...data,
+			type: "taxonomy",
+		};
+	},
+	urlSlugElement: (data: Omit<MigrationElementModels.UrlSlugElement, "type">): MigrationElementModels.UrlSlugElement => {
+		return {
+			...data,
+			type: "url_slug",
+		};
+	},
 };

package/lib/toolkit/export.ts

@@ -1,24 +1,24 @@
-import type { MigrationData } from '../core/index.js';
-import { executeWithTrackingAsync } from '../core/index.js';
-import type { ExportConfig } from '../export/index.js';
-import { exportManager } from '../export/index.js';
-import { libMetadata } from '../metadata.js';
+import type { MigrationData } from "../core/models/migration.models.js";
+import { executeWithTrackingAsync } from "../core/utils/global.utils.js";
+import type { ExportConfig } from "../export/export.models.js";
+import { exportManager } from "../export/export-manager.js";
+import { libMetadata } from "../metadata.js";
 
 export async function exportAsync(config: ExportConfig): Promise<MigrationData> {
-    return await executeWithTrackingAsync({
-        event: {
-            tool: 'migrationToolkit',
-            package: {
-                name: libMetadata.name,
-                version: libMetadata.version
-            },
-            action: 'export',
-            relatedEnvironmentId: undefined,
-            details: {}
-        },
-        func: async () => {
-            return await exportManager(config).exportAsync();
-        },
-        logger: config.logger
-    });
+	return await executeWithTrackingAsync({
+		event: {
+			tool: "migrationToolkit",
+			package: {
+				name: libMetadata.name,
+				version: libMetadata.version,
+			},
+			action: "export",
+			relatedEnvironmentId: undefined,
+			details: {},
+		},
+		func: async () => {
+			return await exportManager(config).exportAsync();
+		},
+		logger: config.logger,
+	});
 }

package/lib/toolkit/file.ts

@@ -1,68 +1,74 @@
-import { Buffer as BufferProxy } from 'buffer';
-import type { Logger, MigrationData } from '../core/index.js';
-import { defaultZipFilename, executeWithTrackingAsync, getDefaultLogger } from '../core/index.js';
-import { fileManager } from '../file/index.js';
-import { libMetadata } from '../metadata.js';
-import { zipManager } from '../zip/index.js';
+import { Buffer as BufferProxy } from "buffer";
+import { getDefaultLogger } from "../core/logs/loggers.js";
+import { MigrationToolkitError } from "../core/models/error.models.js";
+import type { Logger } from "../core/models/log.models.js";
+import type { MigrationData } from "../core/models/migration.models.js";
+import { defaultZipFilename, executeWithTrackingAsync } from "../core/utils/global.utils.js";
+import { fileManager } from "../file/file-manager.js";
+import { libMetadata } from "../metadata.js";
+import { zipManager } from "../zip/zip-manager.js";
 
 export interface StoreConfig {
-    readonly data: MigrationData;
-    readonly filename?: string;
-    readonly logger?: Logger;
+	readonly data: MigrationData;
+	readonly filename?: string;
+	readonly logger?: Logger;
 }
 
 export interface ExtractConfig {
-    readonly filename?: string;
-    readonly logger?: Logger;
+	readonly filename?: string;
+	readonly logger?: Logger;
 }
 
 export async function storeAsync(config: StoreConfig): Promise<void> {
-    const logger = config.logger ?? getDefaultLogger();
-    const filename = config.filename ?? defaultZipFilename;
+	const logger = config.logger ?? getDefaultLogger();
+	const filename = config.filename ?? defaultZipFilename;
 
-    await executeWithTrackingAsync<void>({
-        event: {
-            tool: 'migrationToolkit',
-            package: {
-                name: libMetadata.name,
-                version: libMetadata.version
-            },
-            action: 'store',
-            relatedEnvironmentId: undefined,
-            details: {}
-        },
-        func: async () => {
-            const zipData = await zipManager(logger).createZipAsync(config.data);
+	await executeWithTrackingAsync<void>({
+		event: {
+			tool: "migrationToolkit",
+			package: {
+				name: libMetadata.name,
+				version: libMetadata.version,
+			},
+			action: "store",
+			relatedEnvironmentId: undefined,
+			details: {},
+		},
+		func: async () => {
+			const zipData = await zipManager(logger).createZipAsync(config.data);
 
-            if (zipData instanceof BufferProxy) {
-                await fileManager(logger).writeFileAsync(filename, zipData);
-            } else {
-                throw Error(`Cannot store '${filename}' on File system because the provided zip is not a Buffer`);
-            }
-        },
-        logger: config.logger
-    });
+			if (zipData instanceof BufferProxy) {
+				await fileManager(logger).writeFileAsync(filename, zipData);
+			} else {
+				throw new MigrationToolkitError(
+					"invalidZip",
+					`Cannot store '${filename}' on File system because the provided zip is not a Buffer`,
+				);
+			}
+		},
+		logger: config.logger,
+	});
 }
 
 export async function extractAsync(config: ExtractConfig): Promise<MigrationData> {
-    const logger = config.logger ?? getDefaultLogger();
-    const filename = config.filename ?? defaultZipFilename;
+	const logger = config.logger ?? getDefaultLogger();
+	const filename = config.filename ?? defaultZipFilename;
 
-    return await executeWithTrackingAsync({
-        event: {
-            tool: 'migrationToolkit',
-            package: {
-                name: libMetadata.name,
-                version: libMetadata.version
-            },
-            action: 'extract',
-            relatedEnvironmentId: undefined,
-            details: {}
-        },
-        func: async () => {
-            const fileData = await fileManager(logger).loadFileAsync(filename);
-            return await zipManager(logger).parseZipAsync(fileData);
-        },
-        logger: config.logger
-    });
+	return await executeWithTrackingAsync({
+		event: {
+			tool: "migrationToolkit",
+			package: {
+				name: libMetadata.name,
+				version: libMetadata.version,
+			},
+			action: "extract",
+			relatedEnvironmentId: undefined,
+			details: {},
+		},
+		func: async () => {
+			const fileData = await fileManager(logger).loadFileAsync(filename);
+			return await zipManager(logger).parseZipAsync(fileData);
+		},
+		logger: config.logger,
+	});
 }