@kontent-ai/migration-toolkit 1.0.0 → 1.1.0

package/lib/export/export-manager.ts

@@ -16,7 +16,10 @@ import {
     isNotUndefined,
     MigrationElementValue,
     getMigrationManagementClient,
-    findRequired
+    findRequired,
+    Writeable,
+    MigrationItemsSchema,
+    MigrationAssetsSchema
 } from '../core/index.js';
 import { exportTransforms } from '../translation/index.js';
 import { exportContextFetcherAsync } from './context/export-context-fetcher.js';
@@ -61,11 +64,7 @@ export function exportManager(config: ExportConfig) {
         const componentType = context.environmentData.contentTypes.find((m) => m.contentTypeId === component.type.id);
 
         if (!componentType) {
-            throw Error(
-                `Could not find content type with id '${chalk.red(component.type.id)}' for component '${chalk.red(
-                    component.id
-                )}'`
-            );
+            throw Error(`Could not find content type with id '${chalk.red(component.type.id)}' for component '${chalk.red(component.id)}'`);
         }
 
         const migrationItem: MigrationComponent = {
@@ -96,7 +95,7 @@ export function exportManager(config: ExportConfig) {
                 }
                 return 0;
             })
-            .reduce<MigrationElements>((model, typeElement) => {
+            .reduce<Writeable<MigrationElements>>((model, typeElement) => {
                 const itemElement = findRequired(
                     elements,
                     (m) => m.element.id === typeElement.id,
@@ -128,9 +127,7 @@ export function exportManager(config: ExportConfig) {
                 context: data.context,
                 typeElement: data.typeElement,
                 exportElement: {
-                    components: data.exportElement.components.map((component) =>
-                        mapToMigrationComponent(data.context, component)
-                    ),
+                    components: data.exportElement.components.map((component) => mapToMigrationComponent(data.context, component)),
                     value: data.exportElement.value,
                     urlSlugMode: data.exportElement.mode
                 }
@@ -155,9 +152,7 @@ export function exportManager(config: ExportConfig) {
 
     const exportAssetsAsync = async (context: ExportContext): Promise<readonly Readonly<MigrationAsset>[]> => {
         const assets = Array.from(context.referencedData.assetIds)
-            .map<Readonly<AssetModels.Asset> | undefined>(
-                (assetId) => context.getAssetStateInSourceEnvironment(assetId).asset
-            )
+            .map<Readonly<AssetModels.Asset> | undefined>((assetId) => context.getAssetStateInSourceEnvironment(assetId).asset)
             .filter(isNotUndefined);
 
         return await getMigrationAssetsWithBinaryDataAsync(assets, context);
@@ -184,8 +179,9 @@ export function exportManager(config: ExportConfig) {
             },
             items: assets,
             processAsync: async (asset, logSpinner) => {
-                const assetCollection: Readonly<CollectionModels.Collection> | undefined =
-                    context.environmentData.collections.find((m) => m.id === asset.collection?.reference?.id);
+                const assetCollection: Readonly<CollectionModels.Collection> | undefined = context.environmentData.collections.find(
+                    (m) => m.id === asset.collection?.reference?.id
+                );
 
                 logSpinner({
                     type: 'download',
@@ -204,9 +200,9 @@ export function exportManager(config: ExportConfig) {
                         const language = findRequired(
                             context.environmentData.languages,
                             (language) => language.id === description.language.id,
-                            `Could not find language with id '${chalk.red(
-                                description.language.id
-                            )}' requested by asset '${chalk.red(asset.codename)}'`
+                            `Could not find language with id '${chalk.red(description.language.id)}' requested by asset '${chalk.red(
+                                asset.codename
+                            )}'`
                         );
 
                         return {
@@ -234,8 +230,8 @@ export function exportManager(config: ExportConfig) {
             ).getExportContextAsync();
 
             const migrationData: MigrationData = {
-                items: getMigrationItems(exportContext),
-                assets: await exportAssetsAsync(exportContext)
+                items: MigrationItemsSchema.parse(getMigrationItems(exportContext)),
+                assets: MigrationAssetsSchema.parse(await exportAssetsAsync(exportContext))
             };
 
             logger.log({

package/lib/import/import-manager.ts

@@ -11,9 +11,7 @@ export function importManager(config: ImportConfig) {
     const logger: Logger = config.logger ?? getDefaultLogger();
     const targetEnvironmentClient: ManagementClient = getMigrationManagementClient(config);
 
-    const importAssetsAsync = async (
-        importContext: ImportContext
-    ): Promise<Pick<ImportResult, 'editedAssets' | 'uploadedAssets'>> => {
+    const importAssetsAsync = async (importContext: ImportContext): Promise<Pick<ImportResult, 'editedAssets' | 'uploadedAssets'>> => {
         if (!importContext.categorizedImportData.assets.length) {
             logger.log({
                 type: 'info',
@@ -31,9 +29,7 @@ export function importManager(config: ImportConfig) {
             logger: logger
         }).importAsync();
     };
-    const importContentItemsAsync = async (
-        importContext: ImportContext
-    ): Promise<readonly Readonly<ContentItemModels.ContentItem>[]> => {
+    const importContentItemsAsync = async (importContext: ImportContext): Promise<readonly Readonly<ContentItemModels.ContentItem>[]> => {
         if (!importContext.categorizedImportData.contentItems.length) {
             logger.log({
                 type: 'info',

package/lib/metadata.ts

@@ -1,6 +1,6 @@
 
 export const libMetadata = {
 	name: '@kontent-ai/migration-toolkit',
-    timestamp: 'Wed, 10 Jul 2024 10:38:24 GMT',
-    version: '1.0.0'
+    timestamp: 'Tue, 16 Jul 2024 13:30:22 GMT',
+    version: '1.1.0'
 };

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

@@ -1,4 +1,4 @@
-import { confirmExportAsync, getDefaultZipFilename, getDefaultLogger } from '../../../core/index.js';
+import { confirmExportAsync, defaultZipFilename, getDefaultLogger } from '../../../core/index.js';
 import { exportAsync, storeAsync } from '../../../toolkit/index.js';
 import { CliArgumentsFetcher } from '../cli.models.js';
 
@@ -10,7 +10,7 @@ export async function exportActionAsync(cliFetcher: CliArgumentsFetcher): Promis
     const items = cliFetcher.getRequiredArgumentValue('items').split(',');
     const baseUrl = cliFetcher.getOptionalArgumentValue('baseUrl');
     const force = cliFetcher.getBooleanArgumentValue('force', false);
-    const filename = cliFetcher.getOptionalArgumentValue('filename') ?? getDefaultZipFilename();
+    const filename = cliFetcher.getOptionalArgumentValue('filename') ?? defaultZipFilename;
 
     await confirmExportAsync({
         force: force,

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

@@ -1,4 +1,4 @@
-import { confirmImportAsync, getDefaultZipFilename, getDefaultLogger } from '../../../core/index.js';
+import { confirmImportAsync, defaultZipFilename, getDefaultLogger } from '../../../core/index.js';
 import { extractAsync, importAsync } from '../../../toolkit/index.js';
 import { CliArgumentsFetcher } from '../cli.models.js';
 
@@ -8,7 +8,7 @@ export async function importActionAsync(argsFetcher: CliArgumentsFetcher): Promi
     const apiKey = argsFetcher.getRequiredArgumentValue('targetApiKey');
     const baseUrl = argsFetcher.getOptionalArgumentValue('baseUrl');
     const force = argsFetcher.getBooleanArgumentValue('force', false);
-    const filename = argsFetcher.getOptionalArgumentValue('filename') ?? getDefaultZipFilename();
+    const filename = argsFetcher.getOptionalArgumentValue('filename') ?? defaultZipFilename;
 
     await confirmImportAsync({
         force: force,

package/lib/node/cli/app.ts

@@ -6,6 +6,10 @@ import { exportActionAsync } from './actions/export-action.js';
 import { importActionAsync } from './actions/import-action.js';
 import { migrateActionAsync } from './actions/migrate-action.js';
 import { argumentsFetcherAsync } from './args/args-fetcher.js';
+import { cliArgs } from './commands.js';
+
+// This enabled --help with all commands, options & samples
+cliArgs.registerCommands();
 
 const run = async () => {
     const argsFetcher = await argumentsFetcherAsync();

package/lib/node/cli/args/args-setter.ts

@@ -30,6 +30,9 @@ export function argumentsSetter(): CliArgumentsSetter {
             });
 
             return this;
+        },
+        registerCommands(): void {
+            argv.parseSync();
         }
     };
 }

package/lib/node/cli/cli.models.ts

@@ -18,6 +18,7 @@ export interface CommandOption {
 export type CliArgumentsSetter = {
     withCommand(command: Command): CliArgumentsSetter;
     withOption(option: CommandOption): CliArgumentsSetter;
+    registerCommands(): void;
 };
 
 export type CliArgumentsFetcher = {

package/lib/toolkit/file.ts

@@ -1,11 +1,5 @@
 import { fileManager } from '../file/index.js';
-import {
-    Logger,
-    executeWithTrackingAsync,
-    getDefaultZipFilename,
-    getDefaultLogger,
-    MigrationData
-} from '../core/index.js';
+import { Logger, executeWithTrackingAsync, defaultZipFilename, getDefaultLogger, MigrationData } from '../core/index.js';
 import { zipManager } from '../zip/index.js';
 import { libMetadata } from '../metadata.js';
 
@@ -22,7 +16,7 @@ export interface ExtractConfig {
 
 export async function storeAsync(config: StoreConfig): Promise<void> {
     const logger = config.logger ?? getDefaultLogger();
-    const filename: string = getDefaultZipFilename();
+    const filename = config.filename ?? defaultZipFilename;
 
     await executeWithTrackingAsync<void>({
         event: {
@@ -49,7 +43,7 @@ export async function storeAsync(config: StoreConfig): Promise<void> {
 
 export async function extractAsync(config: ExtractConfig): Promise<MigrationData> {
     const logger = config.logger ?? getDefaultLogger();
-    const filename: string = getDefaultZipFilename();
+    const filename = config.filename ?? defaultZipFilename;
 
     return await executeWithTrackingAsync({
         event: {

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

@@ -175,10 +175,7 @@ export const exportTransforms: Readonly<Record<MigrationElementType, ExportTrans
     }
 };
 
-function findTaxonomy(
-    termId: string,
-    taxonomy: Readonly<TaxonomyModels.Taxonomy>
-): Readonly<TaxonomyModels.Taxonomy> | undefined {
+function findTaxonomy(termId: string, taxonomy: Readonly<TaxonomyModels.Taxonomy>): Readonly<TaxonomyModels.Taxonomy> | undefined {
     if (taxonomy.id === termId) {
         return taxonomy;
     }

package/lib/zip/zip-transformer.ts

@@ -1,10 +1,19 @@
-import { FileBinaryData, ZipPackager } from './zip.models.js';
-import { Logger, MigrationAsset, MigrationData, MigrationItem, getDefaultLogger, mapAsync } from '../core/index.js';
 import chalk from 'chalk';
-
-type ZipAssetRecord = Omit<MigrationAsset, 'binaryData'> & {
-    _zipFilename: string;
-};
+import { z } from 'zod';
+import { FileBinaryData, ZipPackager } from './zip.models.js';
+import {
+    Logger,
+    MigrationAsset,
+    MigrationData,
+    MigrationItem,
+    MigrationItemsSchema,
+    ZipMigrationAssetSchema,
+    ZipMigrationAssetsSchema,
+    getDefaultLogger,
+    mapAsync
+} from '../core/index.js';
+
+type ZipAssetRecord = z.infer<typeof ZipMigrationAssetSchema>;
 
 export function zipTransformer(zip: ZipPackager, logger?: Logger) {
     const loggerToUse: Logger = logger ?? getDefaultLogger();
@@ -51,18 +60,23 @@ export function zipTransformer(zip: ZipPackager, logger?: Logger) {
     };
 
     const parseItems = async () => {
-        const fileContent = await zip.getFileContentAsync(filename);
-        return fileContent ? (JSON.parse(fileContent) as MigrationItem[]) : [];
+        const content = await zip.getFileContentAsync(filename);
+
+        if (!content) {
+            return [];
+        }
+
+        return MigrationItemsSchema.parse(JSON.parse(content));
     };
 
     const parseAssets = async () => {
-        const text = await zip.getFileContentAsync(assetsFilename);
+        const content = await zip.getFileContentAsync(assetsFilename);
 
-        if (!text) {
+        if (!content) {
             return [];
         }
 
-        const assetRecords = JSON.parse(text) as ZipAssetRecord[];
+        const assetRecords = ZipMigrationAssetsSchema.parse(JSON.parse(content));
 
         return await mapAsync(assetRecords, async (assetRecord) => {
             const binaryFile = await zip.getBinaryDataAsync(`${assetRecord._zipFilename}`);

package/lib/zip/zip.models.ts

@@ -4,7 +4,7 @@ export type FileBinaryData = Buffer | Blob;
 export type ZipCompressionLevel = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
 
 export type ZipPackager = {
-    addFile(filePath: string, data: string | Blob | Buffer): void;
+    addFile(filePath: string, data: string | FileBinaryData): void;
     addFolder(name: string): ZipPackager;
     generateZipAsync(config: { logger?: Logger; compressionLevel?: ZipCompressionLevel }): Promise<FileBinaryData>;
     getBinaryDataAsync(filePath: string): Promise<FileBinaryData | undefined>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@kontent-ai/migration-toolkit",
-    "version": "1.0.0",
+    "version": "1.1.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,
@@ -59,30 +59,30 @@
         "chalk": "5.3.0",
         "dotenv": "16.4.5",
         "jszip": "3.10.1",
-        "mime": "4.0.3",
+        "mime": "4.0.4",
         "ora": "8.0.1",
         "prompts": "2.4.2",
         "yargs": "17.7.2",
-        "p-limit": "5.0.0",
-        "deep-equal": "2.2.3"
+        "p-limit": "6.1.0",
+        "deep-equal": "2.2.3",
+        "zod": "3.23.8"
     },
     "devDependencies": {
-        "@eslint/js": "9.6.0",
+        "@eslint/js": "9.7.0",
         "@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/jszip": "3.4.1",
-        "@types/node": "20.14.9",
+        "@types/node": "20.14.10",
         "@types/prompts": "2.4.9",
         "@types/yargs": "17.0.32",
-        "@typescript-eslint/eslint-plugin": "7.15.0",
-        "@typescript-eslint/parser": "7.15.0",
+        "@typescript-eslint/eslint-plugin": "7.16.0",
+        "@typescript-eslint/parser": "7.16.0",
         "eslint": "8.57.0",
         "standard-version": "9.5.0",
         "tslib": "2.6.3",
         "tsx": "4.16.2",
         "typescript": "5.5.3",
-        "typescript-eslint": "7.15.0"
+        "typescript-eslint": "7.16.0"
     }
 }