@kontent-ai/migration-toolkit 1.0.0 → 1.1.0

package/README.md

@@ -11,19 +11,15 @@ environments.
 
 This library can only be used as a library both in `node.js` & `browser` or as a `CLI` utility.
 
-> [!CAUTION]  
-> **This readme uses pre-release version of this library using `next` tag on NPM**. To install it you need to specify
-> version explicitely such as running `npm i @kontent-ai-consulting/migration-toolkit@1.0.0-24 -g`.
-
 # Getting started
 
 Use `--help` anytime to get information about available commands and their options.
 
 ```bash
-npx @kontent-ai-consulting/migration-toolkit --help
+npx @kontent-ai/migration-toolkit@latest --help
 
 # you can also install the package globally, or locally
-npm i @kontent-ai-consulting/migration-toolkit -g
+npm i @kontent-ai/migration-toolkit -g
 
 # with the package installed, you can call the tool as follows
 kontent-ai-migration-toolkit --help
@@ -49,7 +45,7 @@ You may migrate content (items & asset) between Kontent.ai environments. For mig
 [Data Ops](https://github.com/kontent-ai/data-ops) instead.
 
 > [!CAUTION]  
-> **We recommend migrating to test / dev environments first ** to ensure nothing unexpected happens..
+> **We recommend migrating to test / dev environments first** to ensure nothing unexpected happens..
 
 ## Configuration
 

package/dist/es2022/core/index.d.ts

@@ -11,5 +11,6 @@ export * from './utils/management-client-utils.js';
 export * from './models/log.models.js';
 export * from './models/core.models.js';
 export * from './models/migration.models.js';
+export * from './models/migration.schema.js';
 export * from './logs/loggers.js';
 export * from './helpers/workflow-helper.js';

package/dist/es2022/core/index.js

@@ -11,6 +11,7 @@ export * from './utils/management-client-utils.js';
 export * from './models/log.models.js';
 export * from './models/core.models.js';
 export * from './models/migration.models.js';
+export * from './models/migration.schema.js';
 export * from './logs/loggers.js';
 export * from './helpers/workflow-helper.js';
 //# sourceMappingURL=index.js.map

package/dist/es2022/core/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/core/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC;AACzC,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,wBAAwB,CAAC;AACvC,cAAc,oCAAoC,CAAC;AAEnD,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,8BAA8B,CAAC;AAE7C,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/core/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC;AACzC,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,wBAAwB,CAAC;AACvC,cAAc,oCAAoC,CAAC;AAEnD,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,8BAA8B,CAAC;AAE7C,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC"}

package/dist/es2022/core/models/migration.models.d.ts

@@ -1,136 +1,38 @@
-export type MigrationElementType = 'text' | 'rich_text' | 'number' | 'multiple_choice' | 'date_time' | 'asset' | 'modular_content' | 'taxonomy' | 'url_slug' | 'custom' | 'subpages';
-export type MigrationUrlSlugMode = 'autogenerated' | 'custom';
-export interface MigrationRichTextElementValue {
-    value: string;
-    components: readonly MigrationComponent[];
-}
-export interface MigrationUrlSlugElementValue {
-    value: string | undefined;
-    mode: MigrationUrlSlugMode;
-}
-export interface MigrationComponent {
-    system: {
-        id: string;
-        type: MigrationReference;
-    };
-    elements: MigrationElements;
-}
-export type MigrationElementValue = string | undefined | MigrationReference[] | number | MigrationRichTextElementValue | MigrationUrlSlugElementValue;
-export interface MigrationElement<TElementType extends MigrationElementType = MigrationElementType, TValue extends MigrationElementValue = MigrationElementValue> {
-    /**
-     * Value of the element
-     */
-    readonly value: TValue;
-    /**
-     * Type of the element
-     */
-    readonly type: TElementType;
-}
+import { z } from 'zod';
+import { MigrationComponentSchema, MigrationElementTypeSchema, MigrationElementValueSchema, MigrationReferenceSchema, MigrationUrlSlugElementValueSchema, MigrationUrlSlugModeSchema, MigrationRichTextElementValueSchema, MigrationElementSchema, MigrationElementsSchema, MigrationAssetDescriptionSchema, MigrationDataSchema, MigrationAssetSchema, BaseMigrationItemSchema, BaseMigrationItemVersionSchema } from './migration.schema.js';
 export declare namespace MigrationElementModels {
-    interface TextElement extends MigrationElement<'text', string | undefined> {
-    }
-    interface NumberElement extends MigrationElement<'number', number | undefined> {
-    }
-    interface RichTextElement extends MigrationElement<'rich_text', MigrationRichTextElementValue | undefined> {
-    }
-    interface MultipleChoiceElement extends MigrationElement<'multiple_choice', MigrationReference[] | undefined> {
-    }
-    interface DateTimeElement extends MigrationElement<'date_time', string | undefined> {
-    }
-    interface AssetElement extends MigrationElement<'asset', MigrationReference[] | undefined> {
-    }
-    interface LinkedItemsElement extends MigrationElement<'modular_content', MigrationReference[] | undefined> {
-    }
-    interface TaxonomyElement extends MigrationElement<'taxonomy', MigrationReference[] | undefined> {
-    }
-    interface UrlSlugElement extends MigrationElement<'url_slug', MigrationUrlSlugElementValue | undefined> {
-    }
-    interface CustomElement extends MigrationElement<'custom', string | undefined> {
-    }
-    interface SubpagesElement extends MigrationElement<'subpages', MigrationReference[] | undefined> {
-    }
-}
-export interface MigrationElements {
-    [elementCodename: string]: MigrationElement;
-}
-export interface MigrationItemVersion<TElements extends MigrationElements = MigrationElements> {
-    readonly elements: TElements;
-    readonly workflow_step: MigrationReference;
-}
-export interface MigrationItem<TElements extends MigrationElements = MigrationElements> {
-    readonly system: {
-        /**
-         * Codename of the content item
-         */
-        readonly codename: string;
-        /**
-         * Name of the content item
-         */
-        readonly name: string;
-        /**
-         * Language of the language variant
-         */
-        readonly language: MigrationReference;
-        /**
-         * Content type of the item
-         */
-        readonly type: MigrationReference;
-        /**
-         * Collection of the item
-         */
-        readonly collection: MigrationReference;
-        /**
-         * Workflow of the item
-         */
-        readonly workflow: MigrationReference;
+    type MigrationElementDef<TElementType extends MigrationElementType = MigrationElementType, TValue extends MigrationElementValue = MigrationElementValue> = {
+        readonly value: TValue;
+        readonly type: TElementType;
     };
+    export type TextElement = MigrationElementDef<'text', string | undefined>;
+    export type NumberElement = MigrationElementDef<'number', number | undefined>;
+    export type RichTextElement = MigrationElementDef<'rich_text', MigrationRichTextElementValue | undefined>;
+    export type MultipleChoiceElement = MigrationElementDef<'multiple_choice', MigrationReference[] | undefined>;
+    export type DateTimeElement = MigrationElementDef<'date_time', string | undefined>;
+    export type AssetElement = MigrationElementDef<'asset', MigrationReference[] | undefined>;
+    export type LinkedItemsElement = MigrationElementDef<'modular_content', MigrationReference[] | undefined>;
+    export type TaxonomyElement = MigrationElementDef<'taxonomy', MigrationReference[] | undefined>;
+    export type UrlSlugElement = MigrationElementDef<'url_slug', MigrationUrlSlugElementValue | undefined>;
+    export type CustomElement = MigrationElementDef<'custom', string | undefined>;
+    export type SubpagesElement = MigrationElementDef<'subpages', MigrationReference[] | undefined>;
+    export {};
+}
+export type MigrationReference = z.infer<typeof MigrationReferenceSchema>;
+export type MigrationUrlSlugMode = z.infer<typeof MigrationUrlSlugModeSchema>;
+export type MigrationElementType = z.infer<typeof MigrationElementTypeSchema>;
+export type MigrationUrlSlugElementValue = z.infer<typeof MigrationUrlSlugElementValueSchema>;
+export type MigrationRichTextElementValue = z.infer<typeof MigrationRichTextElementValueSchema>;
+export type MigrationComponent = z.infer<typeof MigrationComponentSchema>;
+export type MigrationElementValue = z.infer<typeof MigrationElementValueSchema>;
+export type MigrationElement = z.infer<typeof MigrationElementSchema>;
+export type MigrationElements = z.infer<typeof MigrationElementsSchema>;
+export type MigrationAssetDescription = z.infer<typeof MigrationAssetDescriptionSchema>;
+export type MigrationAsset = z.infer<typeof MigrationAssetSchema>;
+export type MigrationData = z.infer<typeof MigrationDataSchema>;
+export type MigrationItemVersion<TElements extends MigrationElements = MigrationElements> = z.infer<typeof BaseMigrationItemVersionSchema> & {
+    readonly elements: TElements;
+};
+export type MigrationItem<TElements extends MigrationElements = MigrationElements> = z.infer<typeof BaseMigrationItemSchema> & {
     readonly versions: MigrationItemVersion<TElements>[];
-}
-export interface MigrationReference {
-    /**
-     * Codename of the referenced object
-     */
-    readonly codename: string;
-}
-export interface MigrationAssetDescription {
-    readonly language: MigrationReference;
-    readonly description?: string;
-}
-export interface MigrationAsset {
-    /**
-     * Codename of the asset
-     */
-    readonly codename: string;
-    /**
-     * Binary data of the asset
-     */
-    readonly binaryData: Buffer | Blob;
-    /**
-     * Filename of the asset, will be used as a filename in Kontent.ai after importing the asset
-     */
-    readonly filename: string;
-    /**
-     * Title of the asset
-     */
-    readonly title: string;
-    /**
-     * Optional
-     * Collection of the asset
-     */
-    readonly collection?: MigrationReference;
-    /**
-     * Optional.
-     * Descriptions of the assets
-     */
-    readonly descriptions?: readonly MigrationAssetDescription[];
-}
-export interface MigrationData {
-    /**
-     * Array of migration items to process (export / import)
-     */
-    readonly items: readonly MigrationItem[];
-    /**
-     * Array of migration assets to process
-     */
-    readonly assets: readonly MigrationAsset[];
-}
+};