@kontent-ai/migration-toolkit 1.3.0 → 1.5.0

package/lib/core/models/migration.schema.ts

@@ -1,178 +1,189 @@
-import { z } from 'zod';
-
-interface Elements {
-    readonly [key: string]: Element;
-}
-
-type UrlSlugMode = 'autogenerated' | 'custom';
-
-type UrlSlugElementValue = {
-    readonly value?: string;
-    readonly mode: UrlSlugMode;
-};
-
-type Reference = { readonly codename: string };
-
-type Component = {
-    readonly system: {
-        readonly id: string;
-        readonly type: Reference;
-    };
-    readonly elements: Elements;
-};
-
-type RichTextElementValue = {
-    readonly value: string;
-    readonly components: Readonly<Component[]>;
-};
-
-type ElementValue = string | undefined | number | Reference[] | RichTextElementValue | UrlSlugElementValue;
-
-type Element = {
-    readonly type: ElementType;
-    readonly value?: ElementValue;
-};
-
-type ElementType =
-    | 'text'
-    | 'rich_text'
-    | 'number'
-    | 'multiple_choice'
-    | 'date_time'
-    | 'asset'
-    | 'modular_content'
-    | 'taxonomy'
-    | 'url_slug'
-    | 'custom'
-    | 'subpages';
-
-export const MigrationUrlSlugModeSchema = z.enum(['autogenerated', 'custom']).readonly();
-export const MigrationElementTypeSchema = z
-    .enum([
-        'text',
-        'rich_text',
-        'number',
-        'multiple_choice',
-        'date_time',
-        'asset',
-        'modular_content',
-        'taxonomy',
-        'url_slug',
-        'custom',
-        'subpages'
-    ])
-    .readonly();
-
-export const MigrationReferenceSchema = z
-    .strictObject({
-        codename: z.string().readonly()
-    })
-    .readonly();
-
-/**
- * ZodType is needed to be specified here due to the use of 'lazy' & circular dependency between types
- * Otherwise TS has no way of statically inferring the type
- */
-export const MigrationElementsSchema: z.ZodReadonly<z.ZodType<Elements>> = z
-    .record(
-        z.string(),
-        z.lazy(() => MigrationElementSchema)
-    )
-    .readonly();
-
-export const MigrationComponentSchema = z
-    .strictObject({
-        system: z.strictObject({
-            id: z.string(),
-            type: MigrationReferenceSchema
-        }),
-        elements: MigrationElementsSchema
-    })
-    .readonly();
-
-export const MigrationUrlSlugElementValueSchema = z
-    .strictObject({
-        value: z.optional(z.string()),
-        mode: MigrationUrlSlugModeSchema
-    })
-    .readonly();
-
-export const MigrationRichTextElementValueSchema = z
-    .strictObject({
-        value: z.string(),
-        components: z.array(MigrationComponentSchema).readonly()
-    })
-    .readonly();
-
-export const MigrationElementValueSchema = z.union([
-    z.string(),
-    z.undefined(),
-    z.number(),
-    z.array(MigrationReferenceSchema),
-    MigrationRichTextElementValueSchema,
-    MigrationUrlSlugElementValueSchema
-]);
-
-export const MigrationElementSchema = z
-    .strictObject({
-        type: MigrationElementTypeSchema,
-        value: MigrationElementValueSchema
-    })
-    .readonly();
-
-export const MigrationItemVersionSchema = z
-    .strictObject({
-        workflow_step: MigrationReferenceSchema,
-        elements: MigrationElementsSchema
-    })
-    .readonly();
-
-export const MigrationItemSystemSchema = z.strictObject({
-    codename: z.string(),
-    name: z.string(),
-    language: MigrationReferenceSchema,
-    type: MigrationReferenceSchema,
-    collection: MigrationReferenceSchema,
-    workflow: MigrationReferenceSchema
-});
-
-export const MigrationItemSchema = z
-    .strictObject({
-        system: MigrationItemSystemSchema,
-        versions: z.array(MigrationItemVersionSchema).readonly()
-    })
-    .readonly();
-
-export const MigrationAssetDescriptionSchema = z
-    .strictObject({
-        language: MigrationReferenceSchema,
-        description: z.optional(z.string())
-    })
-    .readonly();
-
-const BaseMigrationAssetSchema = z.strictObject({
-    codename: z.string(),
-    filename: z.string(),
-    title: z.string(),
-    collection: z.optional(MigrationReferenceSchema),
-    descriptions: z.optional(z.array(MigrationAssetDescriptionSchema)).readonly()
-});
-
-export const MigrationAssetSchema = BaseMigrationAssetSchema.extend({
-    binaryData: z.union([z.instanceof(Buffer), z.instanceof(Blob)])
-}).readonly();
-
-export const ZipMigrationAssetSchema = BaseMigrationAssetSchema.extend({
-    _zipFilename: z.string()
-}).readonly();
-
-export const MigrationAssetsSchema = z.array(MigrationAssetSchema).readonly();
-export const ZipMigrationAssetsSchema = z.array(ZipMigrationAssetSchema).readonly();
-export const MigrationItemsSchema = z.array(MigrationItemSchema).readonly();
-
-export const MigrationDataSchema = z
-    .strictObject({
-        items: MigrationItemsSchema,
-        assets: MigrationAssetsSchema
-    })
-    .readonly();
+import { z } from 'zod';
+
+interface Elements {
+    readonly [key: string]: Element;
+}
+
+type UrlSlugMode = 'autogenerated' | 'custom';
+
+type UrlSlugElementValue = {
+    readonly value?: string;
+    readonly mode: UrlSlugMode;
+};
+
+type Reference = { readonly codename: string };
+
+type Component = {
+    readonly system: {
+        readonly id: string;
+        readonly type: Reference;
+    };
+    readonly elements: Elements;
+};
+
+type RichTextElementValue = {
+    readonly value: string;
+    readonly components: Readonly<Component[]>;
+};
+
+type ElementValue = string | undefined | number | Reference[] | RichTextElementValue | UrlSlugElementValue;
+
+type Element = {
+    readonly type: ElementType;
+    readonly value?: ElementValue;
+};
+
+type ElementType =
+    | 'text'
+    | 'rich_text'
+    | 'number'
+    | 'multiple_choice'
+    | 'date_time'
+    | 'asset'
+    | 'modular_content'
+    | 'taxonomy'
+    | 'url_slug'
+    | 'custom'
+    | 'subpages';
+
+export const MigrationUrlSlugModeSchema = z.enum(['autogenerated', 'custom']).readonly();
+export const MigrationElementTypeSchema = z
+    .enum([
+        'text',
+        'rich_text',
+        'number',
+        'multiple_choice',
+        'date_time',
+        'asset',
+        'modular_content',
+        'taxonomy',
+        'url_slug',
+        'custom',
+        'subpages'
+    ])
+    .readonly();
+
+export const MigrationReferenceSchema = z
+    .strictObject({
+        codename: z.string().readonly()
+    })
+    .readonly();
+
+export const ScheduleSchema = z
+    .strictObject({
+        publish_time: z.string().datetime().optional().readonly(),
+        publish_display_timezone: z.string().optional().readonly(),
+        unpublish_time: z.string().datetime().optional().readonly(),
+        unpublish_display_timezone: z.string().optional().readonly()
+    })
+    .readonly();
+
+/**
+ * ZodType is needed to be specified here due to the use of 'lazy' & circular dependency between types
+ * Otherwise TS has no way of statically inferring the type
+ */
+export const MigrationElementsSchema: z.ZodReadonly<z.ZodType<Elements>> = z
+    .record(
+        z.string(),
+        z.lazy(() => MigrationElementSchema)
+    )
+    .readonly();
+
+export const MigrationComponentSchema = z
+    .strictObject({
+        system: z.strictObject({
+            id: z.string(),
+            type: MigrationReferenceSchema
+        }),
+        elements: MigrationElementsSchema
+    })
+    .readonly();
+
+export const MigrationUrlSlugElementValueSchema = z
+    .strictObject({
+        value: z.optional(z.string()),
+        mode: MigrationUrlSlugModeSchema
+    })
+    .readonly();
+
+export const MigrationRichTextElementValueSchema = z
+    .strictObject({
+        value: z.string(),
+        components: z.array(MigrationComponentSchema).readonly()
+    })
+    .readonly();
+
+export const MigrationElementValueSchema = z.union([
+    z.string(),
+    z.undefined(),
+    z.number(),
+    z.array(MigrationReferenceSchema),
+    MigrationRichTextElementValueSchema,
+    MigrationUrlSlugElementValueSchema
+]);
+
+export const MigrationElementSchema = z
+    .strictObject({
+        type: MigrationElementTypeSchema,
+        value: MigrationElementValueSchema
+    })
+    .readonly();
+
+export const MigrationItemVersionSchema = z
+    .strictObject({
+        workflow_step: MigrationReferenceSchema,
+        elements: MigrationElementsSchema,
+        schedule: ScheduleSchema.optional()
+    })
+    .readonly();
+
+export const MigrationItemSystemSchema = z.strictObject({
+    codename: z.string(),
+    name: z.string(),
+    language: MigrationReferenceSchema,
+    type: MigrationReferenceSchema,
+    collection: MigrationReferenceSchema,
+    workflow: MigrationReferenceSchema
+});
+
+export const MigrationItemSchema = z
+    .strictObject({
+        system: MigrationItemSystemSchema,
+        versions: z.array(MigrationItemVersionSchema).readonly()
+    })
+    .readonly();
+
+export const MigrationAssetDescriptionSchema = z
+    .strictObject({
+        language: MigrationReferenceSchema,
+        description: z.optional(z.string())
+    })
+    .readonly();
+
+const BaseMigrationAssetSchema = z.strictObject({
+    codename: z.string(),
+    filename: z.string(),
+    title: z.string(),
+    collection: z.optional(MigrationReferenceSchema),
+    descriptions: z.optional(z.array(MigrationAssetDescriptionSchema)).readonly(),
+    folder: z.optional(MigrationReferenceSchema)
+});
+
+export const MigrationAssetSchema = BaseMigrationAssetSchema.extend({
+    binaryData: z.union([z.instanceof(Buffer), z.instanceof(Blob)])
+}).readonly();
+
+export const ZipMigrationAssetSchema = BaseMigrationAssetSchema.extend({
+    _zipFilename: z.string()
+}).readonly();
+
+export const MigrationAssetsSchema = z.array(MigrationAssetSchema).readonly();
+export const ZipMigrationAssetsSchema = z.array(ZipMigrationAssetSchema).readonly();
+export const MigrationItemsSchema = z.array(MigrationItemSchema).readonly();
+
+export const MigrationDataSchema = z
+    .strictObject({
+        items: MigrationItemsSchema,
+        assets: MigrationAssetsSchema
+    })
+    .readonly();

package/lib/core/utils/array.utils.ts

@@ -10,16 +10,8 @@ export function parseAsMigrationReferencesArray(value: MigrationElementValue): r
     throw Error(`Value is not an array`);
 }
 
-export function findRequired<T>(
-    array: readonly T[],
-    predicate: (item: T, index: number) => boolean,
-    errorMessage: string
-): T;
-export function findRequired<T>(
-    array: readonly T[],
-    predicate: (item: T, index: number) => boolean,
-    errorMessage: () => never
-): T;
+export function findRequired<T>(array: readonly T[], predicate: (item: T, index: number) => boolean, errorMessage: string): T;
+export function findRequired<T>(array: readonly T[], predicate: (item: T, index: number) => boolean, errorMessage: () => never): T;
 export function findRequired<T>(
     array: readonly T[],
     predicate: (item: T, index: number) => boolean,

package/lib/core/utils/binary-data.utils.ts

@@ -14,16 +14,11 @@ export async function getBinaryDataFromUrlAsync(url: string): Promise<{ data: Bu
         }
     );
 
-    const contentLengthHeader = response.headers.find((m) => m.header.toLowerCase() === 'content-length');
-    const contentLength = contentLengthHeader ? +contentLengthHeader.value : 0;
+    const contentLength = +(response.headers.find((m) => m.header.toLowerCase() === 'content-length')?.value ?? 0);
 
     return { data: response.data, contentLength: contentLength };
 }
 
 export function geSizeInBytes(data: Blob | Buffer): number {
-    if (data instanceof Blob) {
-        return data.size;
-    }
-
-    return data.byteLength;
+    return data instanceof Blob ? data.size : data.byteLength;
 }

package/lib/core/utils/confirm.utils.ts

@@ -19,11 +19,9 @@ export async function confirmExportAsync(data: {
         data.logger
     ).getEnvironmentAsync();
 
-    const text: string = `Are you sure to export '${chalk.cyan(
+    const text: string = `Are you sure to export '${chalk.cyan(data.dataToExport.itemsCount)}' content ${getItemsPluralText(
         data.dataToExport.itemsCount
-    )}' content ${getItemsPluralText(data.dataToExport.itemsCount)} from ${chalk.yellow(
-        environment.name
-    )} (${chalk.magenta(environment.environment)})?`;
+    )} from ${chalk.yellow(environment.name)} (${chalk.magenta(environment.environment)})?`;
 
     await confirmAsync({
         force: data.force,
@@ -65,9 +63,9 @@ export async function confirmMigrateAsync(data: {
 
     const text: string = `Are you sure to migrate '${chalk.cyan(data.dataToMigrate.itemsCount)}' ${getItemsPluralText(
         data.dataToMigrate.itemsCount
-    )} from ${chalk.yellow(sourceEnvironment.name)} (${chalk.magenta(
-        sourceEnvironment.environment
-    )}) to environment ${chalk.yellow(targetEnvironment.name)} (${chalk.magenta(targetEnvironment.environment)}) ?`;
+    )} from ${chalk.yellow(sourceEnvironment.name)} (${chalk.magenta(sourceEnvironment.environment)}) to environment ${chalk.yellow(
+        targetEnvironment.name
+    )} (${chalk.magenta(targetEnvironment.environment)}) ?`;
 
     await confirmAsync({
         force: data.force,
@@ -91,9 +89,7 @@ export async function confirmImportAsync(data: {
         data.logger
     ).getEnvironmentAsync();
 
-    const text: string = `Are you sure to import data into ${chalk.yellow(environment.name)} (${chalk.magenta(
-        environment.environment
-    )})?`;
+    const text: string = `Are you sure to import data into ${chalk.yellow(environment.name)} (${chalk.magenta(environment.environment)})?`;
 
     await confirmAsync({
         force: data.force,
@@ -116,24 +112,22 @@ async function confirmAsync(data: {
     if (data.force) {
         data.logger.log({
             type: 'info',
-            message: `Skipping confirmation prompt due to the use of 'force' param`
-        });
-    } else {
-        const confirmed = await prompts.default({
-            type: 'confirm',
-            name: 'confirm',
-            message: `${chalk.cyan(data.action)}: ${data.message}`
+            message: `Skipping confirmation`
         });
+        return;
+    }
 
-        if (!confirmed.confirm) {
-            throw Error(`Confirmation refused.`);
-        }
+    const confirmed = await prompts.default({
+        type: 'confirm',
+        name: 'confirm',
+        message: `${chalk.cyan(data.action)}: ${data.message}`
+    });
+
+    if (!confirmed.confirm) {
+        throw Error(`Confirmation refused.`);
     }
 }
 
 function getItemsPluralText(count: number): string {
-    if (count === 1) {
-        return 'item';
-    }
-    return 'items';
+    return count === 1 ? 'item' : 'items';
 }

package/lib/core/utils/error.utils.ts

@@ -2,39 +2,59 @@ import { SharedModels } from '@kontent-ai/management-sdk';
 import chalk from 'chalk';
 import { ErrorData, OriginalManagementError } from '../models/core.models.js';
 import { ZodError } from 'zod';
+import { match } from 'ts-pattern';
 
 export function extractErrorData(error: unknown): ErrorData {
-    let isUnknownError: boolean = true;
-    let message: string = `Unknown error`;
-    let requestUrl: string | undefined = undefined;
-    let requestData: string | undefined = undefined;
+    return match(error)
+        .returnType<ErrorData>()
+        .when(
+            (error) => error instanceof SharedModels.ContentManagementBaseKontentError,
+            (error) => {
+                const originalError = error.originalError as OriginalManagementError | undefined;
 
-    if (error instanceof SharedModels.ContentManagementBaseKontentError) {
-        isUnknownError = false;
-        const originalError = error.originalError as OriginalManagementError | undefined;
-
-        requestUrl = originalError?.response?.config?.url;
-        requestData = originalError?.response?.config?.data;
-
-        message = `${error.message}: ${error.validationErrors.map((m) => m.message).join(', ')}`;
-    } else if (error instanceof ZodError) {
-        isUnknownError = false;
-        message = `Found '${chalk.red(error.issues.length)}' parsing errors: \n${error.issues.reduce<string>((current, issue, index) => {
-            return (current += `\n${index + 1}. ${chalk.red(issue.message)} (${chalk.yellow('path')}: ${issue.path.join(',')})`);
-        }, '')}`;
-    } else if (error instanceof Error) {
-        message = error.message;
-    }
-
-    const errorData: ErrorData = {
-        message: message,
-        requestData: requestData,
-        requestUrl: requestUrl,
-        error: error,
-        isUnknownError: isUnknownError
-    };
-
-    return errorData;
+                return {
+                    isUnknownError: false,
+                    error: error,
+                    message: `${error.message} ${error.validationErrors.map((m) => m.message).join(', ')}`,
+                    requestUrl: originalError?.response?.config?.url,
+                    requestData: originalError?.response?.config?.data
+                };
+            }
+        )
+        .when(
+            (error) => error instanceof ZodError,
+            (error) => {
+                return {
+                    isUnknownError: false,
+                    error: error,
+                    message: `Found '${chalk.red(error.issues.length)}' parsing errors: \n${error.issues.reduce<string>(
+                        (current, issue, index) => {
+                            return (current += `\n${index + 1}. ${chalk.red(issue.message)} (${chalk.yellow('path')}: ${issue.path.join(
+                                ','
+                            )})`);
+                        },
+                        ''
+                    )}`
+                };
+            }
+        )
+        .when(
+            (error) => error instanceof Error,
+            (error) => {
+                return {
+                    isUnknownError: false,
+                    error: error,
+                    message: error.message
+                };
+            }
+        )
+        .otherwise((error) => {
+            return {
+                isUnknownError: true,
+                error: error,
+                message: `Unknown error`
+            };
+        });
 }
 
 export function is404Error(error: unknown): boolean {

package/lib/core/utils/http.utils.ts

@@ -1,5 +1,6 @@
 import { HttpService, IRetryStrategyOptions } from '@kontent-ai/core-sdk';
 import { OriginalManagementError } from '../models/core.models.js';
+import { match } from 'ts-pattern';
 
 const rateExceededErrorCode: number = 10000;
 const notFoundErrorCode: number = 10000;
@@ -14,21 +15,19 @@ export const defaultRetryStrategy: Readonly<IRetryStrategyOptions> = {
         const originalError = err as OriginalManagementError | undefined;
         const errorCode: number = originalError?.response?.data?.error_code ?? -1;
 
-        if (errorCode === rateExceededErrorCode) {
-            // retry rate exceeded error
-            return true;
-        }
-
-        if (errorCode === notFoundErrorCode) {
-            // do not retry errors indicating resource does not exist
-            return false;
-        }
-
-        if (errorCode >= 0) {
-            // otherwise if error code is set, do not retry the request
-            return false;
-        }
-        return true;
+        return (
+            match(errorCode)
+                // retry rate exceeded error
+                .with(rateExceededErrorCode, () => true)
+                // do not retry errors indicating resource does not exist
+                .with(notFoundErrorCode, () => false)
+                // if error code is set, do not retry the request
+                .when(
+                    (errorCode) => errorCode >= 0,
+                    () => false
+                )
+                .otherwise(() => true)
+        );
     },
     maxAttempts: 3,
     deltaBackoffMs: 1000