@kontent-ai/migration-toolkit 2.2.2 → 2.3.0

package/lib/import/importers/language-variant-importer.ts

@@ -1,4 +1,4 @@
-import { ContentItemModels, ElementContracts, LanguageVariantModels, ManagementClient, WorkflowModels } from '@kontent-ai/management-sdk';
+import { ElementContracts, LanguageVariantModels, ManagementClient, WorkflowModels } from '@kontent-ai/management-sdk';
 import chalk from 'chalk';
 import { match } from 'ts-pattern';
 import {
@@ -16,13 +16,13 @@ import {
     workflowHelper
 } from '../../core/index.js';
 import { importTransforms } from '../../translation/index.js';
-import { ImportContext } from '../import.models.js';
+import { ImportContext, ImportedItem, ImportedLanguageVariant } from '../import.models.js';
 import { throwErrorForMigrationItem } from '../utils/import.utils.js';
 import { workflowImporter as workflowImporterInit } from './workflow-importer.js';
 
 export function languageVariantImporter(config: {
     readonly logger: Logger;
-    readonly preparedContentItems: readonly ContentItemModels.ContentItem[];
+    readonly preparedContentItems: readonly ImportedItem[];
     readonly importContext: ImportContext;
     readonly client: Readonly<ManagementClient>;
 }) {
@@ -37,7 +37,7 @@ export function languageVariantImporter(config: {
         readonly logSpinner: LogSpinnerData;
         readonly migrationItem: MigrationItem;
         readonly migrationItemVersion: MigrationItemVersion;
-        readonly preparedContentItem: Readonly<ContentItemModels.ContentItem>;
+        readonly preparedContentItem: ImportedItem;
     }): Promise<Readonly<LanguageVariantModels.ContentItemLanguageVariant>> => {
         return await runMapiRequestAsync({
             logger: config.logger,
@@ -45,7 +45,7 @@ export function languageVariantImporter(config: {
                 return (
                     await config.client
                         .upsertLanguageVariant()
-                        .byItemCodename(data.preparedContentItem.codename)
+                        .byItemCodename(data.preparedContentItem.inputItem.system.codename)
                         .byLanguageCodename(data.migrationItem.system.language.codename)
                         .withData(() => {
                             return {
@@ -110,7 +110,7 @@ export function languageVariantImporter(config: {
         readonly logSpinner: LogSpinnerData;
         readonly migrationItem: MigrationItem;
         readonly migrationItemVersion: MigrationItemVersion;
-        readonly preparedContentItem: Readonly<ContentItemModels.ContentItem>;
+        readonly preparedContentItem: ImportedItem;
         readonly createNewVersion?: boolean;
     }): Promise<Readonly<LanguageVariantModels.ContentItemLanguageVariant>> => {
         // validate workflow
@@ -158,7 +158,7 @@ export function languageVariantImporter(config: {
     const importLanguageVariantAsync = async (
         logSpinner: LogSpinnerData,
         migrationItem: MigrationItem,
-        preparedContentItem: Readonly<ContentItemModels.ContentItem>
+        preparedContentItem: ImportedItem
     ): Promise<readonly LanguageVariantModels.ContentItemLanguageVariant[]> => {
         const { draftVersion, publishedVersion } = categorizeVersions(migrationItem);
 
@@ -297,7 +297,7 @@ export function languageVariantImporter(config: {
         return importTransformResult;
     };
 
-    const importAsync = async (): Promise<readonly Readonly<LanguageVariantModels.ContentItemLanguageVariant>[]> => {
+    const importAsync = async (): Promise<readonly ImportedLanguageVariant[]> => {
         config.logger.log({
             type: 'info',
             message: `Importing '${chalk.yellow(
@@ -305,32 +305,30 @@ export function languageVariantImporter(config: {
             )}' language variants`
         });
 
-        return (
-            await processItemsAsync<MigrationItem, readonly Readonly<LanguageVariantModels.ContentItemLanguageVariant>[]>({
-                action: 'Importing language variants',
-                logger: config.logger,
-                parallelLimit: 1,
-                items: config.importContext.categorizedImportData.contentItems,
-                itemInfo: (input) => {
-                    return {
-                        itemType: 'languageVariant',
-                        title: input.system.name,
-                        partA: input.system.language.codename
-                    };
-                },
-                processAsync: async (migrationItem, logSpinner) => {
-                    const contentItem = findRequired(
-                        config.preparedContentItems,
-                        (item) => item.codename === migrationItem.system.codename,
-                        `Missing content item with codename '${chalk.red(
-                            migrationItem.system.codename
-                        )}'. Content item should have been prepepared.`
-                    );
-
-                    return await importLanguageVariantAsync(logSpinner, migrationItem, contentItem);
-                }
-            })
-        ).flatMap((m) => m.map((s) => s));
+        return await processItemsAsync<MigrationItem, readonly Readonly<LanguageVariantModels.ContentItemLanguageVariant>[]>({
+            action: 'Importing language variants',
+            logger: config.logger,
+            parallelLimit: 1,
+            items: config.importContext.categorizedImportData.contentItems,
+            itemInfo: (input) => {
+                return {
+                    itemType: 'languageVariant',
+                    title: input.system.name,
+                    partA: input.system.language.codename
+                };
+            },
+            processAsync: async (migrationItem, logSpinner) => {
+                const contentItem = findRequired(
+                    config.preparedContentItems,
+                    (item) => item.inputItem.system.codename === migrationItem.system.codename,
+                    `Missing content item with codename '${chalk.red(
+                        migrationItem.system.codename
+                    )}'. Content item should have been prepepared.`
+                );
+
+                return await importLanguageVariantAsync(logSpinner, migrationItem, contentItem);
+            }
+        });
     };
 
     return {

package/lib/metadata.ts

@@ -1,6 +1,6 @@
 
 export const libMetadata = {
 	name: '@kontent-ai/migration-toolkit',
-    timestamp: 'Thu, 07 Nov 2024 07:54:04 GMT',
-    version: '2.2.2'
+    timestamp: 'Thu, 12 Dec 2024 13:23:40 GMT',
+    version: '2.3.0'
 };

package/lib/node/cli/actions/import-action.ts

@@ -7,6 +7,7 @@ export async function importActionAsync(argsFetcher: CliArgumentsFetcher): Promi
     const environmentId = argsFetcher.getRequiredArgumentValue('targetEnvironmentId');
     const apiKey = argsFetcher.getRequiredArgumentValue('targetApiKey');
     const baseUrl = argsFetcher.getOptionalArgumentValue('baseUrl');
+    const createReportFile = argsFetcher.getBooleanArgumentValue('createReportFile', false);
     const force = argsFetcher.getBooleanArgumentValue('force', false);
     const filename = argsFetcher.getOptionalArgumentValue('filename') ?? defaultZipFilename;
 
@@ -27,7 +28,8 @@ export async function importActionAsync(argsFetcher: CliArgumentsFetcher): Promi
         data: importData,
         baseUrl: baseUrl,
         environmentId: environmentId,
-        apiKey: apiKey
+        apiKey: apiKey,
+        createReportFile: createReportFile
     });
 
     log.log({ type: 'completed', message: `Import has been successful` });

package/lib/toolkit/file.ts

@@ -1,4 +1,4 @@
-import { Buffer } from 'buffer';
+import { Buffer as BufferProxy } from 'buffer';
 import { defaultZipFilename, executeWithTrackingAsync, getDefaultLogger, Logger, MigrationData } from '../core/index.js';
 import { fileManager } from '../file/index.js';
 import { libMetadata } from '../metadata.js';
@@ -33,7 +33,7 @@ export async function storeAsync(config: StoreConfig): Promise<void> {
         func: async () => {
             const zipData = await zipManager(logger).createZipAsync(config.data);
 
-            if (zipData instanceof Buffer) {
+            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`);

package/lib/toolkit/import.ts

@@ -1,5 +1,7 @@
+import chalk from 'chalk';
+import { writeFile } from 'fs/promises';
 import { executeWithTrackingAsync } from '../core/index.js';
-import { ImportConfig, ImportResult, importManager } from '../import/index.js';
+import { ImportConfig, ImportResult, importManager as _importManager } from '../import/index.js';
 import { libMetadata } from '../metadata.js';
 
 export async function importAsync(config: ImportConfig): Promise<ImportResult> {
@@ -15,7 +17,19 @@ export async function importAsync(config: ImportConfig): Promise<ImportResult> {
             details: {}
         },
         func: async () => {
-            return await importManager(config).importAsync();
+            const importManager = _importManager(config);
+            const importResult = await importManager.importAsync();
+
+            if (config.createReportFile) {
+                const reportFile = importManager.getReportFile(importResult);
+                await writeFile(reportFile.filename, reportFile.content);
+                config.logger?.log({
+                    type: 'writeFs',
+                    message: `Report '${chalk.yellow(reportFile.filename)}' was created`
+                });
+            }
+
+            return importResult;
         },
         logger: config.logger
     });

package/lib/translation/extraction/items-extraction.processor.ts

@@ -12,7 +12,7 @@ import { GetFlattenedElementByCodenames } from '../../import/index.js';
 import { richTextProcessor } from '../index.js';
 
 export interface ExtractItemById {
-    readonly elements: Readonly<ElementModels.ContentItemElement>[];
+    readonly elements: readonly Readonly<ElementModels.ContentItemElement>[];
     readonly contentTypeId: string;
 }
 
@@ -95,7 +95,7 @@ export function itemsExtractionProcessor() {
             { itemIds: new Set(), assetIds: new Set() }
         );
 
-        return <ReferencedDataInLanguageVariants>{
+        return {
             itemIds: extractedIds.itemIds,
             assetIds: extractedIds.assetIds
         };
@@ -175,7 +175,7 @@ export function itemsExtractionProcessor() {
             }
         );
 
-        return <ReferencedDataInMigrationItems>{
+        return {
             itemCodenames: extractedCodenames.itemCodenames,
             assetCodenames: extractedCodenames.assetCodenames
         };

package/lib/zip/zip-manager.ts

@@ -1,4 +1,4 @@
-import { Buffer } from 'buffer';
+import { Buffer as BufferProxy } from 'buffer';
 import JSZip from 'jszip';
 import { Logger, MigrationData, getDefaultLogger } from '../core/index.js';
 import { zipPackager } from './zip-packager.js';
@@ -17,7 +17,7 @@ export function zipManager(logger?: Logger) {
         return await zipTransformer(zipPackager(new JSZip()), loggerToUse).transformAsync(migrationData);
     };
 
-    const parseZipAsync = async (zipFile: Buffer): Promise<MigrationData> => {
+    const parseZipAsync = async (zipFile: BufferProxy): Promise<MigrationData> => {
         loggerToUse.log({
             type: 'info',
             message: `Parsing zip file`

package/lib/zip/zip-packager.ts

@@ -1,4 +1,4 @@
-import { Buffer } from 'buffer';
+import { Buffer as BufferProxy } from 'buffer';
 import chalk from 'chalk';
 import JSZip from 'jszip';
 import { match } from 'ts-pattern';
@@ -23,7 +23,7 @@ export function zipPackager(jsZip: JSZip): ZipPackager {
                 (data) => data.size
             )
             .when(
-                (data) => data instanceof Buffer,
+                (data) => data instanceof BufferProxy,
                 (data) => data.byteLength
             )
             .otherwise(() => {
@@ -75,8 +75,7 @@ export function zipPackager(jsZip: JSZip): ZipPackager {
             return result;
         },
         async getBinaryDataAsync(filePath: string): Promise<FileBinaryData | undefined> {
-            const binaryData = await jsZip.file(filePath)?.async(getZipOutputType());
-            return binaryData;
+            return await jsZip.file(filePath)?.async(getZipOutputType());
         },
         async getFileContentAsync(filePath: string): Promise<string | undefined> {
             return await jsZip.file(filePath)?.async('string');

package/lib/zip/zip-transformer.ts

@@ -21,7 +21,7 @@ export function zipTransformer(zip: ZipPackager, logger?: Logger) {
     const assetsFilename: string = 'assets.json';
     const assetsBinaryFolderName: string = 'binary_data';
 
-    const getAssetFolderConfig = (asset: MigrationAsset): { partialColder: string; fullPath: string } => {
+    const getAssetFolderConfig = (asset: MigrationAsset): { readonly partialColder: string; readonly fullPath: string } => {
         const codenamePartialFolder: string = asset.codename.slice(0, 2);
         return {
             partialColder: codenamePartialFolder,

package/lib/zip/zip.models.ts

@@ -1,13 +1,13 @@
-import { Buffer } from 'buffer';
+import { Buffer as BufferProxy } from 'buffer';
 import { Logger } from '../core/index.js';
 
-export type FileBinaryData = Buffer | Blob;
+export type FileBinaryData = BufferProxy | Blob;
 export type ZipCompressionLevel = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
 
 export type ZipPackager = {
     addFile(filePath: string, data: string | FileBinaryData): void;
     addFolder(name: string): ZipPackager;
-    generateZipAsync(config: { logger?: Logger; compressionLevel?: ZipCompressionLevel }): Promise<FileBinaryData>;
+    generateZipAsync(config: { readonly logger?: Logger; readonly compressionLevel?: ZipCompressionLevel }): Promise<FileBinaryData>;
     getBinaryDataAsync(filePath: string): Promise<FileBinaryData | undefined>;
     getFileContentAsync(filePath: string): Promise<string | undefined>;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@kontent-ai/migration-toolkit",
-    "version": "2.2.2",
+    "version": "2.3.0",
     "description": "This program can be used to import content related data into Kontent.ai from various formats. Additionally, it can also be used to export Kontent.ai data using Delivery API.",
     "preferGlobal": true,
     "private": false,
@@ -60,33 +60,33 @@
         "bytes": "3.1.2",
         "chalk": "5.3.0",
         "deep-equal": "2.2.3",
-        "dotenv": "16.4.5",
+        "dotenv": "16.4.7",
         "jszip": "3.10.1",
         "mime": "4.0.4",
-        "ora": "8.1.0",
+        "ora": "8.1.1",
         "p-limit": "6.1.0",
         "prompts": "2.4.2",
         "ts-pattern": "5.5.0",
         "yargs": "17.7.2",
-        "zod": "3.23.8"
+        "zod": "3.24.1"
     },
     "devDependencies": {
-        "@eslint/js": "9.13.0",
+        "@eslint/js": "9.16.0",
         "@types/browser-or-node": "1.3.2",
-        "@types/bytes": "3.1.4",
+        "@types/bytes": "3.1.5",
         "@types/deep-equal": "1.0.4",
         "@types/eslint__js": "8.42.3",
-        "@types/node": "22.8.2",
+        "@types/node": "22.10.2",
         "@types/prompts": "2.4.9",
         "@types/yargs": "17.0.33",
-        "@typescript-eslint/eslint-plugin": "8.12.1",
-        "@typescript-eslint/parser": "8.12.1",
-        "eslint": "9.13.0",
+        "@typescript-eslint/eslint-plugin": "8.18.0",
+        "@typescript-eslint/parser": "8.18.0",
+        "eslint": "9.16.0",
         "standard-version": "9.5.0",
-        "tslib": "2.8.0",
+        "tslib": "2.8.1",
         "tsx": "4.19.2",
         "typescript": "5.6.3",
-        "typescript-eslint": "8.12.1",
-        "vitest": "2.1.4"
+        "typescript-eslint": "8.18.0",
+        "vitest": "2.1.8"
     }
 }