@kontent-ai/migration-toolkit 1.5.0 → 2.0.0

package/lib/translation/transforms/export-transforms.ts

@@ -1,21 +1,20 @@
-import {
-    MigrationElementType,
-    MigrationReference,
-    MigrationRichTextElementValue,
-    MigrationUrlSlugElementValue,
-    findRequired,
-    isNotUndefined
-} from '../../core/index.js';
 import { ContentTypeElements, TaxonomyModels } from '@kontent-ai/management-sdk';
-import { ExportTransformFunc, ExportContext, ExportElement } from '../../export/index.js';
-import { richTextProcessor } from '../helpers/rich-text.processor.js';
 import chalk from 'chalk';
+import { MigrationElementTransformData, MigrationElementType, MigrationReference, findRequired, isNotUndefined } from '../../core/index.js';
+import { ExportContext, ExportElement, ExportTransformFunc } from '../../export/index.js';
+import { richTextProcessor } from '../helpers/rich-text.processor.js';
 
 export const exportTransforms: Readonly<Record<MigrationElementType, ExportTransformFunc>> = {
-    text: (data) => data.exportElement.value?.toString(),
+    text: (data) => {
+        return {
+            value: data.exportElement.value?.toString()
+        };
+    },
     number: (data) => {
-        if (!data.exportElement.value) {
-            return undefined;
+        if (data.exportElement.value === undefined || data.exportElement.value === null) {
+            return {
+                value: undefined
+            };
         }
 
         if (Array.isArray(data.exportElement.value)) {
@@ -23,40 +22,55 @@ export const exportTransforms: Readonly<Record<MigrationElementType, ExportTrans
         }
 
         if (data.exportElement.value === 0) {
-            return 0;
+            return {
+                value: 0
+            };
         }
 
-        return +data.exportElement.value;
+        return {
+            value: +data.exportElement.value
+        };
+    },
+    date_time: (data) => {
+        return {
+            value: data.exportElement.value?.toString(),
+            display_timezone: data.exportElement.displayTimezone ?? undefined
+        };
     },
-    date_time: (data) => data.exportElement.value?.toString(),
     rich_text: (data) => transformRichTextValue(data.exportElement, data.context),
     asset: (data) => {
         if (!data.exportElement.value) {
-            return [];
+            return {
+                value: []
+            };
         }
 
         if (!Array.isArray(data.exportElement.value)) {
             throw Error(`Expected value to be an array`);
         }
 
-        // translate asset id to codename
-        return data.exportElement.value
-            .map((m) => m.id)
-            .filter(isNotUndefined)
-            .map<MigrationReference>((id) => {
-                const assetState = data.context.getAssetStateInSourceEnvironment(id);
-
-                if (assetState.asset) {
-                    // reference asset by codename
-                    return { codename: assetState.asset.codename };
-                } else {
-                    throw Error(`Missing asset with id '${chalk.red(id)}'`);
-                }
-            });
+        return {
+            // translate asset id to codename
+            value: data.exportElement.value
+                .map((m) => m.id)
+                .filter(isNotUndefined)
+                .map<MigrationReference>((id) => {
+                    const assetState = data.context.getAssetStateInSourceEnvironment(id);
+
+                    if (assetState.asset) {
+                        // reference asset by codename
+                        return { codename: assetState.asset.codename };
+                    } else {
+                        throw Error(`Missing asset with id '${chalk.red(id)}'`);
+                    }
+                })
+        };
     },
     taxonomy: (data) => {
         if (!data.exportElement.value) {
-            return [];
+            return {
+                value: []
+            };
         }
 
         if (!Array.isArray(data.exportElement.value)) {
@@ -73,57 +87,67 @@ export const exportTransforms: Readonly<Record<MigrationElementType, ExportTrans
             `Could not find taxonomy group with id '${chalk.red(taxonomyGroupId)}'`
         );
 
-        // translate taxonomy term to codename
-        return data.exportElement.value
-            .map((m) => m.id)
-            .filter(isNotUndefined)
-            .map<MigrationReference>((id) => {
-                const taxonomyTerm = findTaxonomy(id, taxonomy);
-
-                if (taxonomyTerm) {
-                    // reference taxonomy term by codename
-                    return { codename: taxonomyTerm.codename };
-                } else {
-                    throw Error(`Missing taxonomy term with id '${chalk.red(id)}'`);
-                }
-            });
+        return {
+            // translate taxonomy term to codename
+            value: data.exportElement.value
+                .map((m) => m.id)
+                .filter(isNotUndefined)
+                .map<MigrationReference>((id) => {
+                    const taxonomyTerm = findTaxonomy(id, taxonomy);
+
+                    if (taxonomyTerm) {
+                        // reference taxonomy term by codename
+                        return { codename: taxonomyTerm.codename };
+                    } else {
+                        throw Error(`Missing taxonomy term with id '${chalk.red(id)}'`);
+                    }
+                })
+        };
     },
     modular_content: (data) => {
         if (!data.exportElement.value) {
-            return [];
+            return {
+                value: []
+            };
         }
 
         if (!Array.isArray(data.exportElement.value)) {
             throw Error(`Expected value to be an array`);
         }
 
-        // translate item id to codename
-        return data.exportElement.value
-            .map((m) => m.id)
-            .filter(isNotUndefined)
-            .map<MigrationReference>((id) => {
-                const itemState = data.context.getItemStateInSourceEnvironment(id);
-
-                if (itemState.item) {
-                    // reference item by codename
-                    return { codename: itemState.item.codename };
-                } else {
-                    throw Error(`Missing item with id '${chalk.red(id)}'`);
-                }
-            });
+        return {
+            // translate item id to codename
+            value: data.exportElement.value
+                .map((m) => m.id)
+                .filter(isNotUndefined)
+                .map<MigrationReference>((id) => {
+                    const itemState = data.context.getItemStateInSourceEnvironment(id);
+
+                    if (itemState.item) {
+                        // reference item by codename
+                        return { codename: itemState.item.codename };
+                    } else {
+                        throw Error(`Missing item with id '${chalk.red(id)}'`);
+                    }
+                })
+        };
+    },
+    custom: (data) => {
+        return {
+            value: data.exportElement.value?.toString()
+        };
     },
-    custom: (data) => data.exportElement.value?.toString(),
     url_slug: (data) => {
-        const urlSlugElementValue: MigrationUrlSlugElementValue = {
-            mode: data.exportElement.urlSlugMode ?? 'autogenerated',
-            value: data.exportElement.value?.toString() ?? undefined
+        return {
+            value: data.exportElement.value?.toString() ?? undefined,
+            mode: data.exportElement.urlSlugMode ?? 'autogenerated'
         };
-
-        return urlSlugElementValue;
     },
     multiple_choice: (data) => {
         if (!data.exportElement.value) {
-            return [];
+            return {
+                value: []
+            };
         }
 
         if (!Array.isArray(data.exportElement.value)) {
@@ -133,45 +157,51 @@ export const exportTransforms: Readonly<Record<MigrationElementType, ExportTrans
         // translate multiple choice option id to codename
         const multipleChoiceElement = data.typeElement.element as Readonly<ContentTypeElements.IMultipleChoiceElement>;
 
-        return data.exportElement.value
-            .map((m) => m.id)
-            .filter(isNotUndefined)
-            .map<MigrationReference>((id) => {
-                const option = findRequired(
-                    multipleChoiceElement.options,
-                    (option) => option.id === id,
-                    `Could not find multiple choice element with option id '${chalk.red(id)}'`
-                );
-
-                if (!option.codename) {
-                    throw Error(`Invalid codename for multiple choice option '${chalk.red(option.name)}'`);
-                }
-
-                return { codename: option.codename };
-            });
+        return {
+            value: data.exportElement.value
+                .map((m) => m.id)
+                .filter(isNotUndefined)
+                .map<MigrationReference>((id) => {
+                    const option = findRequired(
+                        multipleChoiceElement.options,
+                        (option) => option.id === id,
+                        `Could not find multiple choice element with option id '${chalk.red(id)}'`
+                    );
+
+                    if (!option.codename) {
+                        throw Error(`Invalid codename for multiple choice option '${chalk.red(option.name)}'`);
+                    }
+
+                    return { codename: option.codename };
+                })
+        };
     },
     subpages: (data) => {
         if (!data.exportElement.value) {
-            return [];
+            return {
+                value: []
+            };
         }
         if (!Array.isArray(data.exportElement.value)) {
             throw Error(`Expected value to be an array`);
         }
 
-        // translate item id to codename
-        return data.exportElement.value
-            .map((m) => m.id)
-            .filter(isNotUndefined)
-            .map<MigrationReference>((id) => {
-                const itemState = data.context.getItemStateInSourceEnvironment(id);
-
-                if (itemState.item) {
-                    // reference item by codename
-                    return { codename: itemState.item.codename };
-                } else {
-                    throw Error(`Missing item with id '${chalk.red(id)}'`);
-                }
-            });
+        return {
+            // translate item id to codename
+            value: data.exportElement.value
+                .map((m) => m.id)
+                .filter(isNotUndefined)
+                .map<MigrationReference>((id) => {
+                    const itemState = data.context.getItemStateInSourceEnvironment(id);
+
+                    if (itemState.item) {
+                        // reference item by codename
+                        return { codename: itemState.item.codename };
+                    } else {
+                        throw Error(`Missing item with id '${chalk.red(id)}'`);
+                    }
+                })
+        };
     }
 };
 
@@ -191,10 +221,7 @@ function findTaxonomy(termId: string, taxonomy: Readonly<TaxonomyModels.Taxonomy
     return undefined;
 }
 
-function transformRichTextValue(
-    exportElement: ExportElement | undefined,
-    context: ExportContext
-): MigrationRichTextElementValue | undefined {
+function transformRichTextValue(exportElement: ExportElement | undefined, context: ExportContext): MigrationElementTransformData {
     if (!exportElement || !exportElement.value) {
         return {
             components: [],
@@ -243,6 +270,19 @@ function transformRichTextValue(
         };
     }).html;
 
+    // replace link asset ids with codenames
+    richTextHtml = richTextProcessor().processLinkAssetIds(richTextHtml, (id) => {
+        const assetInEnv = context.getAssetStateInSourceEnvironment(id).asset;
+
+        if (!assetInEnv) {
+            throw Error(`Failed to get asset with id '${chalk.red(id)}'`);
+        }
+
+        return {
+            codename: assetInEnv.codename
+        };
+    }).html;
+
     return {
         components: exportElement.components,
         value: richTextHtml

package/lib/translation/transforms/import-transforms.ts

@@ -1,11 +1,5 @@
-import { SharedContracts, LanguageVariantElementsBuilder, LanguageVariantElements } from '@kontent-ai/management-sdk';
-import {
-    parseAsMigrationReferencesArray,
-    MigrationElementType,
-    MigrationRichTextElementValue,
-    MigrationItem,
-    MigrationUrlSlugElementValue
-} from '../../core/index.js';
+import { LanguageVariantElements, LanguageVariantElementsBuilder, SharedContracts } from '@kontent-ai/management-sdk';
+import { MigrationElementTransformData, MigrationElementType, MigrationItem, parseAsMigrationReferencesArray } from '../../core/index.js';
 import { ImportContext, ImportTransformFunc } from '../../import/index.js';
 import { richTextProcessor } from '../helpers/rich-text.processor.js';
 
@@ -21,7 +15,7 @@ export const importTransforms: Readonly<Record<MigrationElementType, ImportTrans
             element: {
                 codename: data.elementCodename
             },
-            value: parseAsMigrationReferencesArray(data.value).map((m) => {
+            value: parseAsMigrationReferencesArray(data.elementData.value).map((m) => {
                 return {
                     codename: m.codename
                 };
@@ -29,7 +23,7 @@ export const importTransforms: Readonly<Record<MigrationElementType, ImportTrans
         });
     },
     asset: (data) => {
-        const assetReferences = parseAsMigrationReferencesArray(data.value)
+        const assetReferences = parseAsMigrationReferencesArray(data.elementData.value)
             .map((reference) => reference.codename)
             .map<Readonly<SharedContracts.IReferenceObjectContract>>((codename) => {
                 const assetState = data.importContext.getAssetStateInTargetEnvironment(codename);
@@ -54,7 +48,7 @@ export const importTransforms: Readonly<Record<MigrationElementType, ImportTrans
             element: {
                 codename: data.elementCodename
             },
-            value: data.value?.toString() ?? ''
+            value: data.elementData.value?.toString() ?? ''
         });
     },
     date_time: (data) => {
@@ -62,11 +56,12 @@ export const importTransforms: Readonly<Record<MigrationElementType, ImportTrans
             element: {
                 codename: data.elementCodename
             },
-            value: data.value?.toString() ?? null
+            value: data.elementData.value?.toString() ?? null,
+            display_timezone: data.elementData.display_timezone ?? null
         });
     },
     modular_content: (data) => {
-        const linkedItemReferences = parseAsMigrationReferencesArray(data.value)
+        const linkedItemReferences = parseAsMigrationReferencesArray(data.elementData.value)
             .map((reference) => reference.codename)
             .map<Readonly<SharedContracts.IReferenceObjectContract>>((codename) => {
                 const itemState = data.importContext.getItemStateInTargetEnvironment(codename);
@@ -90,7 +85,7 @@ export const importTransforms: Readonly<Record<MigrationElementType, ImportTrans
             element: {
                 codename: data.elementCodename
             },
-            value: parseAsMigrationReferencesArray(data.value).map((m) => {
+            value: parseAsMigrationReferencesArray(data.elementData.value).map((m) => {
                 return {
                     codename: m.codename
                 };
@@ -102,12 +97,10 @@ export const importTransforms: Readonly<Record<MigrationElementType, ImportTrans
             element: {
                 codename: data.elementCodename
             },
-            value: data.value ? +data.value : null
+            value: data.elementData ? +data.elementData : null
         });
     },
     rich_text: (data) => {
-        const rteElementValue = data.value as MigrationRichTextElementValue;
-
         return elementsBuilder.richTextElement({
             element: {
                 codename: data.elementCodename
@@ -115,11 +108,11 @@ export const importTransforms: Readonly<Record<MigrationElementType, ImportTrans
             components: mapComponents({
                 importContext: data.importContext,
                 migrationItems: data.migrationItems,
-                rteValue: rteElementValue
+                elementData: data.elementData
             }),
             value:
                 processImportRichTextHtmlValue({
-                    element: rteElementValue,
+                    elementData: data.elementData,
                     importContext: data.importContext,
                     migrationItems: data.migrationItems
                 }) ?? null
@@ -130,7 +123,7 @@ export const importTransforms: Readonly<Record<MigrationElementType, ImportTrans
             element: {
                 codename: data.elementCodename
             },
-            value: parseAsMigrationReferencesArray(data.value).map((m) => {
+            value: parseAsMigrationReferencesArray(data.elementData.value).map((m) => {
                 return {
                     codename: m.codename
                 };
@@ -142,28 +135,26 @@ export const importTransforms: Readonly<Record<MigrationElementType, ImportTrans
             element: {
                 codename: data.elementCodename
             },
-            value: data.value?.toString() ?? null
+            value: data.elementData.value?.toString() ?? null
         });
     },
     url_slug: (data) => {
-        const urlSlugElementValue = data.value as Readonly<MigrationUrlSlugElementValue>;
-
         return elementsBuilder.urlSlugElement({
             element: {
                 codename: data.elementCodename
             },
-            value: urlSlugElementValue.value?.toString() ?? '',
-            mode: urlSlugElementValue.mode
+            value: data.elementData.value?.toString() ?? '',
+            mode: data.elementData.mode ?? 'autogenerated'
         });
     }
 };
 
 function mapComponents(data: {
-    readonly rteValue: MigrationRichTextElementValue;
+    readonly elementData: MigrationElementTransformData;
     readonly importContext: ImportContext;
     readonly migrationItems: readonly MigrationItem[];
 }): LanguageVariantElements.IRichTextComponent[] {
-    return data.rteValue.components.map((component) => {
+    return (data.elementData.components ?? []).map((component) => {
         const mappedComponent: Readonly<LanguageVariantElements.IRichTextComponent> = {
             id: component.system.id,
             type: {
@@ -174,7 +165,7 @@ function mapComponents(data: {
                     elementCodename: key,
                     importContext: data.importContext,
                     migrationItems: data.migrationItems,
-                    value: element.value
+                    elementData: element
                 });
 
                 return transformedElementValue;
@@ -186,15 +177,15 @@ function mapComponents(data: {
 }
 
 function processImportRichTextHtmlValue(data: {
-    readonly element: MigrationRichTextElementValue;
+    readonly elementData: MigrationElementTransformData;
     readonly importContext: ImportContext;
     readonly migrationItems: readonly MigrationItem[];
 }): string | undefined {
-    if (!data.element) {
+    if (!data.elementData) {
         return undefined;
     }
 
-    let richTextHtml: string = data.element.value ?? '';
+    let richTextHtml: string = data.elementData.value?.toString() ?? '';
 
     // replace item codenames with existing codename or external_id
     richTextHtml = richTextProcessor().processItemCodenames(richTextHtml, (codename) => {
@@ -211,5 +202,10 @@ function processImportRichTextHtmlValue(data: {
         return data.importContext.getAssetStateInTargetEnvironment(codename);
     }).html;
 
+    // replace link asset codenames with existing codename or external_id
+    richTextHtml = richTextProcessor().processLinkAssetCodenames(richTextHtml, (codename) => {
+        return data.importContext.getAssetStateInTargetEnvironment(codename);
+    }).html;
+
     return richTextHtml;
 }

package/lib/zip/zip-manager.ts

@@ -1,7 +1,8 @@
+import { Buffer } from 'buffer';
 import JSZip from 'jszip';
 import { Logger, MigrationData, getDefaultLogger } from '../core/index.js';
-import { zipTransformer } from './zip-transformer.js';
 import { zipPackager } from './zip-packager.js';
+import { zipTransformer } from './zip-transformer.js';
 import { FileBinaryData } from './zip.models.js';
 
 export function zipManager(logger?: Logger) {

package/lib/zip/zip-packager.ts

@@ -1,8 +1,9 @@
-import JSZip from 'jszip';
+import { Buffer } from 'buffer';
 import chalk from 'chalk';
-import { Logger, formatBytes, getCurrentEnvironment, exitProgram, getDefaultLogger } from '../core/index.js';
-import { FileBinaryData, ZipCompressionLevel, ZipPackager } from './zip.models.js';
+import JSZip from 'jszip';
 import { match } from 'ts-pattern';
+import { Logger, exitProgram, formatBytes, getCurrentEnvironment, getDefaultLogger } from '../core/index.js';
+import { FileBinaryData, ZipCompressionLevel, ZipPackager } from './zip.models.js';
 
 type ZipOutputType = 'nodebuffer' | 'blob';
 

package/lib/zip/zip-transformer.ts

@@ -1,6 +1,5 @@
 import chalk from 'chalk';
 import { z } from 'zod';
-import { FileBinaryData, ZipPackager } from './zip.models.js';
 import {
     Logger,
     MigrationAsset,
@@ -12,6 +11,7 @@ import {
     getDefaultLogger,
     mapAsync
 } from '../core/index.js';
+import { FileBinaryData, ZipPackager } from './zip.models.js';
 
 type ZipAssetRecord = z.infer<typeof ZipMigrationAssetSchema>;
 
@@ -52,8 +52,8 @@ export function zipTransformer(zip: ZipPackager, logger?: Logger) {
                 folder: asset.folder
             });
 
-            if (asset.binaryData) {
-                codenameFolder.addFile(asset.filename, asset.binaryData);
+            if (asset.binary_data) {
+                codenameFolder.addFile(asset.filename, asset.binary_data);
             }
         });
 
@@ -93,7 +93,7 @@ export function zipTransformer(zip: ZipPackager, logger?: Logger) {
                 title: assetRecord.title,
                 descriptions: assetRecord.descriptions,
                 folder: assetRecord.folder,
-                binaryData: binaryFile
+                binary_data: binaryFile
             };
 
             return migrationAsset;

package/lib/zip/zip.models.ts

@@ -1,3 +1,4 @@
+import { Buffer } from 'buffer';
 import { Logger } from '../core/index.js';
 
 export type FileBinaryData = Buffer | Blob;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@kontent-ai/migration-toolkit",
-    "version": "1.5.0",
+    "version": "2.0.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,
@@ -53,37 +53,38 @@
     "license": "MIT",
     "dependencies": {
         "@kontent-ai-consulting/tools-analytics": "0.0.7",
-        "@kontent-ai/management-sdk": "7.2.0",
+        "@kontent-ai/management-sdk": "7.4.0",
         "browser-or-node": "3.0.0",
         "bytes": "3.1.2",
         "chalk": "5.3.0",
         "dotenv": "16.4.5",
         "jszip": "3.10.1",
         "mime": "4.0.4",
-        "ora": "8.0.1",
+        "ora": "8.1.0",
         "prompts": "2.4.2",
         "yargs": "17.7.2",
         "p-limit": "6.1.0",
         "deep-equal": "2.2.3",
         "zod": "3.23.8",
-        "ts-pattern": "5.3.1"
+        "ts-pattern": "5.4.0",
+        "buffer": "6.0.3"
     },
     "devDependencies": {
-        "@eslint/js": "9.9.0",
+        "@eslint/js": "9.11.1",
         "@types/deep-equal": "1.0.4",
         "@types/browser-or-node": "1.3.2",
         "@types/bytes": "3.1.4",
         "@types/eslint__js": "8.42.3",
-        "@types/node": "22.3.0",
+        "@types/node": "22.7.4",
         "@types/prompts": "2.4.9",
         "@types/yargs": "17.0.33",
-        "@typescript-eslint/eslint-plugin": "8.1.0",
-        "@typescript-eslint/parser": "8.1.0",
-        "eslint": "9.9.0",
+        "@typescript-eslint/eslint-plugin": "8.8.0",
+        "@typescript-eslint/parser": "8.8.0",
+        "eslint": "9.11.1",
         "standard-version": "9.5.0",
-        "tslib": "2.6.3",
-        "tsx": "4.17.0",
-        "typescript": "5.5.4",
-        "typescript-eslint": "8.1.0"
+        "tslib": "2.7.0",
+        "tsx": "4.19.1",
+        "typescript": "5.6.2",
+        "typescript-eslint": "8.8.0"
     }
 }