@kontent-ai/migration-toolkit 1.3.0 → 1.5.0

package/README.md

@@ -1,13 +1,12 @@
 # Kontent.ai Migration Toolkit
 
-The purpose of this tool is to facilitate _content migration_ to & from [Kontent.ai](https://kontent.ai) environments.
-It can be used to simplify migration from external systems and also provides a built-in migration between kontent.ai
-environments.
+The purpose of this tool is to facilitate _content migration_ to & from [Kontent.ai](https://kontent.ai) environments. It can be used to
+simplify migration from external systems and also provides a built-in migration between kontent.ai environments.
 
 > [!TIP]  
-> This library aims to streamline the migration to / from Kontent.ai environments by providing an abstraction layer
-> which handles creation / updates of content items, language variants, moving items through workflow, publishing,
-> archiving, downloading binary data, uploading assets, `id` to `codename` translation and more.
+> This library aims to streamline the migration to / from Kontent.ai environments by providing an abstraction layer which handles creation /
+> updates of content items, language variants, moving items through workflow, publishing, archiving, downloading binary data, uploading
+> assets, `id` to `codename` translation and more.
 
 This library can only be used as a library both in `node.js` & `browser` or as a `CLI` utility.
 
@@ -36,8 +35,7 @@ kontent-ai-migration-toolkit migrate --help
 4. [Migrate content between Kontent.ai environments](https://github.com/Kontent-ai/kontent-ai-migration-toolkit/blob/main/samples/migrate-between-kontent-ai-environments.ts)
 
 > [!NOTE]  
-> You can run `kontent-ai-migration-toolkit` many times over without being worried that duplicate content items / assets
-> are created.
+> You can run `kontent-ai-migration-toolkit` many times over without being worried that duplicate content items / assets are created.
 
 # Migrate between Kontent.ai environments
 
@@ -69,14 +67,13 @@ kontent-ai-migration-toolkit migrate --targetEnvironmentId=x --targetApiKey=x --
 # Import
 
 > [!CAUTION]  
-> **We do not recommended importing into a production environment directly without testing**. Instead you should first
-> create a testing environment and run the script there to make sure everything works as you intended to.
+> **We do not recommended importing into a production environment directly without testing**. Instead you should first create a testing
+> environment and run the script there to make sure everything works as you intended to.
 
 > [!NOTE]  
-> When importing it is essential that the target project structure (i.e. `Content types`, `Taxonomies`, `Collections`,
-> `Workflows`, `languages`...) are consistent with the ones defined in source environment. Any inconsistency in data
-> such as referencing inexistent taxonomy term, incorrect element type and other inconsistencies may cause import to
-> fail.
+> When importing it is essential that the target project structure (i.e. `Content types`, `Taxonomies`, `Collections`, `Workflows`,
+> `languages`...) are consistent with the ones defined in source environment. Any inconsistency in data such as referencing inexistent
+> taxonomy term, incorrect element type and other inconsistencies may cause import to fail.
 
 ## Configuration
 
@@ -97,8 +94,8 @@ kontent-ai-migration-toolkit import --targetEnvironmentId=x --targetApiKey=x --f
 
 # Migrate from Kontent.ai
 
-This library can also be used to export content items & assets from Kontent.ai environments. However, when migration
-from 3rd party system you typically only use the `import` capabilities of this repository.
+This library can also be used to export content items & assets from Kontent.ai environments. However, when migration from 3rd party system
+you typically only use the `import` capabilities of this repository.
 
 ## Configuration
 
@@ -120,27 +117,38 @@ kontent-ai-migration-toolkit export --sourceEnvironmentId=x --sourceApiKey=x --l
 
 # Migrate from external systems
 
-You can use this library when exporting from 3rd party systems (i.e. legacy CMS) as it will abstract your from using
-Kontent.ai Management API directly.
+You can use this library when exporting from 3rd party systems (i.e. legacy CMS) as it will abstract your from using Kontent.ai Management
+API directly.
 
-The main focus is therefore on transforming the data you need to migrate into a format this library supports. The main
-migration models are `MigrationItem` and `MigrationAsset`. For creating element values `elementsBuilder`.
+The main focus is therefore on transforming the data you need to migrate into a format this library supports. The main migration models are
+`MigrationItem` and `MigrationAsset`. For creating element values `elementsBuilder`.
 
 See below example of using a strongly typed model and migrating a single item with an asset.
 
 ```typescript
 /**
- * Optionally (but strongly recommended) you may define a migration model
- * representing the content type you are trying to migrate into
+ * Optionally (but highly recommended) you may define a migration model
+ * representing the environment you are trying to migrate into.
  */
-interface ArticleElements extends MigrationElements {
-    title: MigrationElementModels.TextElement;
-    rating: MigrationElementModels.NumberElement;
-    related_pages: MigrationElementModels.LinkedItemsElement;
-    teaser_image: MigrationElementModels.AssetElement;
-}
-
-const migrationItem: MigrationItem<ArticleElements> = {
+type LanguageCodenames = 'default' | 'en';
+type CollectionCodenames = 'default' | 'global';
+type WorkflowCodenames = 'default' | 'custom';
+type ContentTypeCodenames = 'article' | 'author';
+type WorkflowStepCodenames = 'published' | 'archived' | 'draft';
+type ContentTypeCodename<Codename extends ContentTypeCodenames> = Codename;
+
+type ArticleItem = MigrationItem<
+    {
+        title: MigrationElementModels.TextElement;
+        rating: MigrationElementModels.NumberElement;
+        related_pages: MigrationElementModels.LinkedItemsElement;
+        teaser_image: MigrationElementModels.AssetElement;
+    },
+    MigrationItemSystem<ContentTypeCodename<'article'>, LanguageCodenames, CollectionCodenames, WorkflowCodenames>,
+    WorkflowStepCodenames
+>;
+
+const migrationItem: ArticleItem = {
     system: {
         name: 'My article',
         // codename is primary identifier - also used for validating whether asset exists in target env
@@ -151,29 +159,39 @@ const migrationItem: MigrationItem<ArticleElements> = {
         },
         language: {
             // language codename must match the language in your target K.ai environment
-            codename: 'en_uk'
+            codename: 'en'
         },
         type: {
             // type codename must match the content type codename in your target K.ai environment
             codename: 'article'
+        },
+        workflow: {
+            codename: 'default'
         }
     },
-    elements: {
-        title: elementsBuilder.textElement({ value: 'Title of the article' }),
-        rating: elementsBuilder.numberElement({ value: 5 }),
-        related_pages: elementsBuilder.linkedItemsElement({
-            value: [
-                {
-                    codename: 'pageA'
-                },
-                {
-                    codename: 'pageB'
-                }
-            ]
-        }),
-        // assets are referenced by their codename
-        teaser_image: elementsBuilder.assetElement({ value: [{ codename: 'article_teaser' }] })
-    }
+    versions: [
+        {
+            workflow_step: {
+                codename: 'published'
+            },
+            elements: {
+                title: elementsBuilder.textElement({ value: 'Title of the article' }),
+                rating: elementsBuilder.numberElement({ value: 5 }),
+                related_pages: elementsBuilder.linkedItemsElement({
+                    value: [
+                        {
+                            codename: 'pageA'
+                        },
+                        {
+                            codename: 'pageB'
+                        }
+                    ]
+                }),
+                // assets are referenced by their codename
+                teaser_image: elementsBuilder.assetElement({ value: [{ codename: 'article_teaser' }] })
+            }
+        }
+    ]
 };
 
 const migrationAsset: MigrationAsset = {
@@ -218,21 +236,20 @@ await importAsync({
 
 ### How are content items imported?
 
-The Migration Toolkit creates content items that are not present in target project. If the content item exists in target
-project (based on item's `codename`) the item will be updated, otherwise it will be created. No duplicate items will be
-created. The workflow of the item in target environment will be set to match the source environment.
+The Migration Toolkit creates content items that are not present in target project. If the content item exists in target project (based on
+item's `codename`) the item will be updated, otherwise it will be created. No duplicate items will be created. The workflow of the item in
+target environment will be set to match the source environment.
 
 ### How are assets imported?
 
-If asset exists in target project (based on asset's `codename`), the asset upload will be skipped and not uploaded at
-all. Otherwise the asset will be created in target environment.
+If asset exists in target project (based on asset's `codename`), the asset upload will be skipped and not uploaded at all. Otherwise the
+asset will be created in target environment.
 
 ### How are referenced content items & asset handled?
 
-If you have a reference to a content item or asset (i.e. in linked items element, asset element, rich text element...)
-the migration toolkit first checks whether the referenced object exists (based on item or asset `codename`) and if it
-does, successfuly sets the reference. If the object does not exist, it will be referenced by an `external_id` which
-creates a placeholder for the item until it becomes available.
+If you have a reference to a content item or asset (i.e. in linked items element, asset element, rich text element...) the migration toolkit
+first checks whether the referenced object exists (based on item or asset `codename`) and if it does, successfuly sets the reference. If the
+object does not exist, it will be referenced by an `external_id` which creates a placeholder for the item until it becomes available.
 
 See the table below to learn how `external_id` is generated by default:
 
@@ -241,25 +258,20 @@ See the table below to learn how `external_id` is generated by default:
 | **Asset**        | `asset_{codename}` | my_file                         | `asset_my_file`         |
 | **Content item** | `item_{codename}`  | article                         | `item_article`          |
 
-If you need to change the way `external_id` is created, you may supply a custom implementation of `externalIdGenerator`
-within import / migrate functions.
+If you need to change the way `external_id` is created, you may supply a custom implementation of `externalIdGenerator` within import /
+migrate functions.
 
 ## Limitations
 
-1. Asset folder assignments are not preserved during migration because folders can be referenced only by id's and not
-   codenames.
-2. Assets element values are not preserved during migration because elements can be referenced only by id's and not
-   codenames.
-3. Language variants in `Scheduled` workflow step do not preserve their workflow status because the API does not provide
-   an information about scheduled times
+1. Custom asset elements are not supported (= values of these elements are not exported or imported )
 
 ## FAQ
 
 ### I'm getting `Header overflow` exception
 
-The Node.js limits the maximum header size of HTTP requests. In some cases it may be required for you to increase this
-limitation to be able to successfully fetch data from Kontent.ai. You can do so by using the `max-http-header-size`
-option (https://nodejs.org/api/cli.html#--max-http-header-sizesize)
+The Node.js limits the maximum header size of HTTP requests. In some cases it may be required for you to increase this limitation to be able
+to successfully fetch data from Kontent.ai. You can do so by using the `max-http-header-size` option
+(https://nodejs.org/api/cli.html#--max-http-header-sizesize)
 
 Example script call:
 

package/dist/es2022/core/helpers/workflow-helper.d.ts

@@ -33,5 +33,6 @@ export declare function workflowHelper(workflows: readonly Readonly<WorkflowMode
     isPublishedStepByCodename: (stepCodename: string) => boolean;
     isArchivedStepByCodename: (stepCodename: string) => boolean;
     isScheduledStepByCodename: (stepCodename: string) => boolean;
+    isPublishedStepById: (stepId: string) => boolean;
 };
 export {};

package/dist/es2022/core/helpers/workflow-helper.js

@@ -11,9 +11,7 @@ export function workflowHelper(workflows) {
         return getWorkflow({
             errorMessage: [
                 `Workflow with codename '${chalk.red(workflowCodename)}' does not exist in target project`,
-                `Available workflows are (${workflows.length}): ${workflows
-                    .map((m) => chalk.cyan(m.codename))
-                    .join(', ')}`
+                `Available workflows are (${workflows.length}): ${workflows.map((m) => chalk.cyan(m.codename)).join(', ')}`
             ].join(', '),
             match: (workflow) => workflow.codename.toLowerCase() === workflowCodename.toLowerCase()
         });
@@ -52,6 +50,9 @@ export function workflowHelper(workflows) {
     const isScheduledStepByCodename = (stepCodename) => {
         return workflows.find((workflow) => workflow.scheduledStep.codename === stepCodename) ? true : false;
     };
+    const isPublishedStepById = (stepId) => {
+        return workflows.find((workflow) => workflow.publishedStep.id === stepId) ? true : false;
+    };
     return {
         getWorkflowByCodename,
         getWorkflowStepByCodename,
@@ -61,7 +62,8 @@ export function workflowHelper(workflows) {
         getWorkflow,
         isPublishedStepByCodename,
         isArchivedStepByCodename,
-        isScheduledStepByCodename
+        isScheduledStepByCodename,
+        isPublishedStepById
     };
 }
 //# sourceMappingURL=workflow-helper.js.map

package/dist/es2022/core/helpers/workflow-helper.js.map

@@ -1 +1 @@
-{"version":3,"file":"workflow-helper.js","sourceRoot":"","sources":["../../../../lib/core/helpers/workflow-helper.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAgBvD,MAAM,UAAU,cAAc,CAAC,SAAuD;IAClF,MAAM,eAAe,GAAG,CAAC,QAA2C,EAAE,WAAwB,EAAgB,EAAE;QAC5G,OAAO,YAAY,CACf,CAAC,GAAG,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,YAAY,EAAE,QAAQ,CAAC,aAAa,EAAE,QAAQ,CAAC,aAAa,CAAC,EAC1F,WAAW,CAAC,KAAK,EACjB,WAAW,CAAC,YAAY,CAC3B,CAAC;IACN,CAAC,CAAC;IAEF,MAAM,WAAW,GAAG,CAAC,eAAgC,EAAqC,EAAE;QACxF,OAAO,YAAY,CAAC,SAAS,EAAE,eAAe,CAAC,KAAK,EAAE,eAAe,CAAC,YAAY,CAAC,CAAC;IACxF,CAAC,CAAC;IAEF,MAAM,qBAAqB,GAAG,CAAC,gBAAwB,EAAqC,EAAE;QAC1F,OAAO,WAAW,CAAC;YACf,YAAY,EAAE;gBACV,2BAA2B,KAAK,CAAC,GAAG,CAAC,gBAAgB,CAAC,oCAAoC;gBAC1F,4BAA4B,SAAS,CAAC,MAAM,MAAM,SAAS;qBACtD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;qBAClC,IAAI,CAAC,IAAI,CAAC,EAAE;aACpB,CAAC,IAAI,CAAC,IAAI,CAAC;YACZ,KAAK,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,EAAE,KAAK,gBAAgB,CAAC,WAAW,EAAE;SAC1F,CAAC,CAAC;IACP,CAAC,CAAC;IAEF,MAAM,yBAAyB,GAAG,CAC9B,QAA2C,EAC3C,YAAoB,EACR,EAAE;QACd,OAAO,eAAe,CAAC,QAAQ,EAAE;YAC7B,YAAY,EAAE;gBACV,gCAAgC,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,oCAAoC;gBAC3F,qBAAqB,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,UAAU,SAAS,CAAC,MAAM,MAAM,SAAS;qBACxF,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;qBAClC,IAAI,CAAC,IAAI,CAAC,EAAE;aACpB,CAAC,IAAI,CAAC,IAAI,CAAC;YACZ,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,KAAK,YAAY,CAAC,WAAW,EAAE;SAC9E,CAAC,CAAC;IACP,CAAC,CAAC;IAEF,MAAM,kBAAkB,GAAG,CAAC,IAG3B,EAAuE,EAAE;QACtE,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QACnD,OAAO;YACH,QAAQ;YACR,IAAI,EAAE,eAAe,CAAC,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC;SACpD,CAAC;IACN,CAAC,CAAC;IAEF,MAAM,6BAA6B,GAAG,CAAC,IAGtC,EAAuE,EAAE;QACtE,MAAM,QAAQ,GAAG,qBAAqB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC9D,OAAO;YACH,QAAQ;YACR,IAAI,EAAE,yBAAyB,CAAC,QAAQ,EAAE,IAAI,CAAC,YAAY,CAAC;SAC/D,CAAC;IACN,CAAC,CAAC;IAEF,MAAM,yBAAyB,GAAG,CAAC,YAAoB,EAAW,EAAE;QAChE,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,QAAQ,KAAK,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;IACzG,CAAC,CAAC;IAEF,MAAM,wBAAwB,GAAG,CAAC,YAAoB,EAAW,EAAE;QAC/D,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,QAAQ,KAAK,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;IACxG,CAAC,CAAC;IAEF,MAAM,yBAAyB,GAAG,CAAC,YAAoB,EAAW,EAAE;QAChE,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,QAAQ,KAAK,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;IACzG,CAAC,CAAC;IAEF,OAAO;QACH,qBAAqB;QACrB,yBAAyB;QACzB,6BAA6B;QAC7B,eAAe;QACf,kBAAkB;QAClB,WAAW;QACX,yBAAyB;QACzB,wBAAwB;QACxB,yBAAyB;KAC5B,CAAC;AACN,CAAC"}
+{"version":3,"file":"workflow-helper.js","sourceRoot":"","sources":["../../../../lib/core/helpers/workflow-helper.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAgBvD,MAAM,UAAU,cAAc,CAAC,SAAuD;IAClF,MAAM,eAAe,GAAG,CAAC,QAA2C,EAAE,WAAwB,EAAgB,EAAE;QAC5G,OAAO,YAAY,CACf,CAAC,GAAG,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,YAAY,EAAE,QAAQ,CAAC,aAAa,EAAE,QAAQ,CAAC,aAAa,CAAC,EAC1F,WAAW,CAAC,KAAK,EACjB,WAAW,CAAC,YAAY,CAC3B,CAAC;IACN,CAAC,CAAC;IAEF,MAAM,WAAW,GAAG,CAAC,eAAgC,EAAqC,EAAE;QACxF,OAAO,YAAY,CAAC,SAAS,EAAE,eAAe,CAAC,KAAK,EAAE,eAAe,CAAC,YAAY,CAAC,CAAC;IACxF,CAAC,CAAC;IAEF,MAAM,qBAAqB,GAAG,CAAC,gBAAwB,EAAqC,EAAE;QAC1F,OAAO,WAAW,CAAC;YACf,YAAY,EAAE;gBACV,2BAA2B,KAAK,CAAC,GAAG,CAAC,gBAAgB,CAAC,oCAAoC;gBAC1F,4BAA4B,SAAS,CAAC,MAAM,MAAM,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;aAC9G,CAAC,IAAI,CAAC,IAAI,CAAC;YACZ,KAAK,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,EAAE,KAAK,gBAAgB,CAAC,WAAW,EAAE;SAC1F,CAAC,CAAC;IACP,CAAC,CAAC;IAEF,MAAM,yBAAyB,GAAG,CAAC,QAA2C,EAAE,YAAoB,EAAgB,EAAE;QAClH,OAAO,eAAe,CAAC,QAAQ,EAAE;YAC7B,YAAY,EAAE;gBACV,gCAAgC,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,oCAAoC;gBAC3F,qBAAqB,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,UAAU,SAAS,CAAC,MAAM,MAAM,SAAS;qBACxF,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;qBAClC,IAAI,CAAC,IAAI,CAAC,EAAE;aACpB,CAAC,IAAI,CAAC,IAAI,CAAC;YACZ,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,KAAK,YAAY,CAAC,WAAW,EAAE;SAC9E,CAAC,CAAC;IACP,CAAC,CAAC;IAEF,MAAM,kBAAkB,GAAG,CAAC,IAG3B,EAAuE,EAAE;QACtE,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QACnD,OAAO;YACH,QAAQ;YACR,IAAI,EAAE,eAAe,CAAC,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC;SACpD,CAAC;IACN,CAAC,CAAC;IAEF,MAAM,6BAA6B,GAAG,CAAC,IAGtC,EAAuE,EAAE;QACtE,MAAM,QAAQ,GAAG,qBAAqB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC9D,OAAO;YACH,QAAQ;YACR,IAAI,EAAE,yBAAyB,CAAC,QAAQ,EAAE,IAAI,CAAC,YAAY,CAAC;SAC/D,CAAC;IACN,CAAC,CAAC;IAEF,MAAM,yBAAyB,GAAG,CAAC,YAAoB,EAAW,EAAE;QAChE,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,QAAQ,KAAK,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;IACzG,CAAC,CAAC;IAEF,MAAM,wBAAwB,GAAG,CAAC,YAAoB,EAAW,EAAE;QAC/D,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,QAAQ,KAAK,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;IACxG,CAAC,CAAC;IAEF,MAAM,yBAAyB,GAAG,CAAC,YAAoB,EAAW,EAAE;QAChE,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,QAAQ,KAAK,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;IACzG,CAAC,CAAC;IAEF,MAAM,mBAAmB,GAAG,CAAC,MAAc,EAAW,EAAE;QACpD,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;IAC7F,CAAC,CAAC;IAEF,OAAO;QACH,qBAAqB;QACrB,yBAAyB;QACzB,6BAA6B;QAC7B,eAAe;QACf,kBAAkB;QAClB,WAAW;QACX,yBAAyB;QACzB,wBAAwB;QACxB,yBAAyB;QACzB,mBAAmB;KACtB,CAAC;AACN,CAAC"}

package/dist/es2022/core/logs/loggers.js

@@ -1,15 +1,12 @@
 import chalk from 'chalk';
 import { getCurrentEnvironment } from '../utils/global.utils.js';
+import { match, P } from 'ts-pattern';
 const originalWarn = console.warn;
 export function getDefaultLogger() {
-    const currentEnv = getCurrentEnvironment();
-    if (currentEnv === 'node') {
-        return defaultNodeLogger;
-    }
-    if (currentEnv === 'browser') {
-        return defaultBrowserLogger;
-    }
-    throw Error(`Invalid environment`);
+    return match(getCurrentEnvironment())
+        .with('node', () => defaultNodeLogger)
+        .with('browser', () => defaultBrowserLogger)
+        .exhaustive();
 }
 const defaultNodeLogger = {
     log: (data) => console.log(getLogDataMessage(data)),
@@ -48,19 +45,13 @@ const defaultBrowserLogger = {
     }
 };
 function getLogDataMessage(data) {
-    let typeColor = chalk.yellow;
-    if (data.type === 'info') {
-        typeColor = chalk.cyan;
-    }
-    else if (data.type === 'error' || data.type === 'errorData' || data.type === 'warning' || data.type === 'cancel') {
-        typeColor = chalk.red;
-    }
-    else if (data.type === 'completed') {
-        typeColor = chalk.green;
-    }
-    else if (data.type === 'skip') {
-        typeColor = chalk.gray;
-    }
-    return `${typeColor(data.type)}: ${data.message}`;
+    const color = match(data.type)
+        .returnType()
+        .with('info', () => chalk.cyan)
+        .with(P.union('error', 'errorData', 'warning', 'cancel'), () => chalk.red)
+        .with('completed', () => chalk.green)
+        .with('skip', () => chalk.gray)
+        .otherwise(() => chalk.yellow);
+    return `${color(data.type)}: ${data.message}`;
 }
 //# sourceMappingURL=loggers.js.map

package/dist/es2022/core/logs/loggers.js.map

@@ -1 +1 @@
-{"version":3,"file":"loggers.js","sourceRoot":"","sources":["../../../../lib/core/logs/loggers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AAEjE,MAAM,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;AAElC,MAAM,UAAU,gBAAgB;IAC5B,MAAM,UAAU,GAAG,qBAAqB,EAAE,CAAC;IAE3C,IAAI,UAAU,KAAK,MAAM,EAAE,CAAC;QACxB,OAAO,iBAAiB,CAAC;IAC7B,CAAC;IACD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC3B,OAAO,oBAAoB,CAAC;IAChC,CAAC;IACD,MAAM,KAAK,CAAC,qBAAqB,CAAC,CAAC;AACvC,CAAC;AAED,MAAM,iBAAiB,GAAW;IAC9B,GAAG,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IACnD,mBAAmB,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;QAChC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,CAAC;QAEhC,OAAO,MAAM,GAAG,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;YAC1C,0DAA0D;YAC1D,uDAAuD;YACvD,oEAAoE;YACpE,MAAM,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC,EAAE,EAAE;gBACxB,IAAI,CAAC,EAAE,CAAC;oBACJ,OAAO,CAAC,IAAI,GAAI,CAAa,EAAE,QAAQ,EAAE,IAAI,oBAAoB,CAAC;gBACtE,CAAC;YACL,CAAC,CAAC;YAEF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;gBAC/B,qGAAqG;gBACrG,sBAAsB;gBACtB,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;oBACd,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC;gBAC3C,CAAC;gBACD,OAAO,CAAC,IAAI,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;YAC3C,CAAC,CAAC,CAAC;YAEH,wBAAwB;YACxB,MAAM,CAAC,OAAO,CAAC,IAAI,GAAG,YAAY,CAAC;YAEnC,OAAO,MAAM,CAAC;QAClB,CAAC,EAAE,EAAE,CAAC,CAAC;IACX,CAAC;CACJ,CAAC;AAEF,MAAM,oBAAoB,GAAW;IACjC,GAAG,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IACnD,mBAAmB,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;QAChC,OAAO,MAAM,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;YACvB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;YACrD,OAAO,CAAC,GAAG,CAAC,GAAG,MAAM,GAAG,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;IACP,CAAC;CACJ,CAAC;AAEF,SAAS,iBAAiB,CAAC,IAAuB;IAC9C,IAAI,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC;IAE7B,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QACvB,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC;IAC3B,CAAC;SAAM,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QACjH,SAAS,GAAG,KAAK,CAAC,GAAG,CAAC;IAC1B,CAAC;SAAM,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;QACnC,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC;IAC5B,CAAC;SAAM,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QAC9B,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC;IAC3B,CAAC;IAED,OAAO,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC;AACtD,CAAC"}
+{"version":3,"file":"loggers.js","sourceRoot":"","sources":["../../../../lib/core/logs/loggers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAwB,MAAM,OAAO,CAAC;AAE7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,YAAY,CAAC;AAEtC,MAAM,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;AAElC,MAAM,UAAU,gBAAgB;IAC5B,OAAO,KAAK,CAAC,qBAAqB,EAAE,CAAC;SAChC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,iBAAiB,CAAC;SACrC,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,oBAAoB,CAAC;SAC3C,UAAU,EAAE,CAAC;AACtB,CAAC;AAED,MAAM,iBAAiB,GAAW;IAC9B,GAAG,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IACnD,mBAAmB,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;QAChC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,CAAC;QAEhC,OAAO,MAAM,GAAG,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;YAC1C,0DAA0D;YAC1D,uDAAuD;YACvD,oEAAoE;YACpE,MAAM,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC,EAAE,EAAE;gBACxB,IAAI,CAAC,EAAE,CAAC;oBACJ,OAAO,CAAC,IAAI,GAAI,CAAa,EAAE,QAAQ,EAAE,IAAI,oBAAoB,CAAC;gBACtE,CAAC;YACL,CAAC,CAAC;YAEF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;gBAC/B,qGAAqG;gBACrG,sBAAsB;gBACtB,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;oBACd,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC;gBAC3C,CAAC;gBACD,OAAO,CAAC,IAAI,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;YAC3C,CAAC,CAAC,CAAC;YAEH,wBAAwB;YACxB,MAAM,CAAC,OAAO,CAAC,IAAI,GAAG,YAAY,CAAC;YAEnC,OAAO,MAAM,CAAC;QAClB,CAAC,EAAE,EAAE,CAAC,CAAC;IACX,CAAC;CACJ,CAAC;AAEF,MAAM,oBAAoB,GAAW;IACjC,GAAG,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IACnD,mBAAmB,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;QAChC,OAAO,MAAM,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;YACvB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;YACrD,OAAO,CAAC,GAAG,CAAC,GAAG,MAAM,GAAG,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;IACP,CAAC;CACJ,CAAC;AAEF,SAAS,iBAAiB,CAAC,IAAuB;IAC9C,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;SACzB,UAAU,EAAiB;SAC3B,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC;SAC9B,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC;SACzE,IAAI,CAAC,WAAW,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC;SACpC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC;SAC9B,SAAS,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAEnC,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC;AAClD,CAAC"}

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

@@ -1,12 +1,18 @@
 import { AssetModels, ContentItemModels, ContentTypeElements, LanguageVariantModels, WorkflowModels } from '@kontent-ai/management-sdk';
 import { MigrationElementType } from './migration.models.js';
-import { WorkflowStep } from '../helpers/workflow-helper.js';
+export type LiteralUnion<T extends string> = T | (string & {});
 export type TargetItemState = 'exists' | 'doesNotExists';
 export type CliAction = 'export' | 'import' | 'migrate';
 export type EnvContext = 'browser' | 'node';
-export type MapiAction = 'list' | 'view' | 'archive' | 'unpublish' | 'changeWorkflowStep' | 'publish' | 'upload' | 'create' | 'upsert' | 'createNewVersion';
+export type MapiAction = 'list' | 'view' | 'archive' | 'unpublish' | 'changeWorkflowStep' | 'publish' | 'upload' | 'create' | 'upsert' | 'schedulePublish' | 'scheduleUnpublish' | 'cancelScheduledPublish' | 'cancelScheduledUnpublish' | 'createNewVersion';
 export type MigrationItemType = 'exportItem';
-export type MapiType = 'contentType' | 'asset' | 'contentTypeSnippet' | 'contentItem' | 'languageVariant' | 'language' | 'collection' | 'taxonomy' | 'binaryFile' | 'workflow';
+export type MapiType = 'contentType' | 'assetFolder' | 'asset' | 'contentTypeSnippet' | 'contentItem' | 'languageVariant' | 'language' | 'collection' | 'taxonomy' | 'binaryFile' | 'workflow';
+export type LanguageVariantWorkflowStateValues = 'published' | 'archived' | 'draft' | 'scheduled';
+export type LanguageVariantSchedulesStateValues = 'scheduledPublish' | 'scheduledUnpublish' | 'n/a';
+export type LanguageVariantWorkflowState = {
+    readonly workflowState: LanguageVariantWorkflowStateValues;
+    readonly scheduledState: LanguageVariantSchedulesStateValues;
+} | undefined;
 export interface ItemInfo {
     readonly title: string;
     readonly itemType: MapiType | MigrationItemType;
@@ -42,13 +48,17 @@ export interface ItemStateInTargetEnvironmentByCodename {
     readonly item: Readonly<ContentItemModels.ContentItem> | undefined;
     readonly externalIdToUse: string;
 }
+export interface LanguageVariantStateData {
+    readonly languageVariant: Readonly<LanguageVariantModels.ContentItemLanguageVariant> | undefined;
+    readonly workflow: Readonly<WorkflowModels.Workflow> | undefined;
+    readonly workflowState: LanguageVariantWorkflowState;
+}
 export interface LanguageVariantStateInTargetEnvironmentByCodename {
     readonly state: TargetItemState;
     readonly itemCodename: string;
     readonly languageCodename: string;
-    readonly languageVariant: Readonly<LanguageVariantModels.ContentItemLanguageVariant> | undefined;
-    readonly workflow: Readonly<WorkflowModels.Workflow> | undefined;
-    readonly step: Readonly<WorkflowStep> | undefined;
+    readonly publishedLanguageVariant: LanguageVariantStateData | undefined;
+    readonly draftLanguageVariant: LanguageVariantStateData | undefined;
 }
 export interface AssetStateInTargetEnvironmentByCodename {
     readonly state: TargetItemState;

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

@@ -21,13 +21,13 @@ export declare namespace MigrationElementModels {
 export type MigrationReference<T extends string = string> = z.infer<typeof MigrationReferenceSchema> & {
     readonly codename: T;
 };
-export type MigrationItemSystem<TType extends string = string, TLanguage extends string = string, TCollection extends string = string, TWorkflow extends string = string> = z.infer<typeof MigrationItemSystemSchema> & {
+export type MigrationItemSystem<TTypeCodenames extends string = string, TLanguageCodenames extends string = string, TCollectionCodenames extends string = string, TWorkflowCodenames extends string = string> = z.infer<typeof MigrationItemSystemSchema> & {
     readonly codename: string;
     readonly name: string;
-    readonly language: MigrationReference<TLanguage>;
-    readonly type: MigrationReference<TType>;
-    readonly collection: MigrationReference<TCollection>;
-    readonly workflow: MigrationReference<TWorkflow>;
+    readonly language: MigrationReference<TLanguageCodenames>;
+    readonly type: MigrationReference<TTypeCodenames>;
+    readonly collection: MigrationReference<TCollectionCodenames>;
+    readonly workflow: MigrationReference<TWorkflowCodenames>;
 };
 export type MigrationUrlSlugMode = z.infer<typeof MigrationUrlSlugModeSchema>;
 export type MigrationElementType = z.infer<typeof MigrationElementTypeSchema>;
@@ -40,11 +40,11 @@ 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, TWorkflowStepCodename extends string = string> = z.infer<typeof MigrationItemVersionSchema> & {
+export type MigrationItemVersion<TElements extends MigrationElements = MigrationElements, TWorkflowStepCodenames extends string = string> = z.infer<typeof MigrationItemVersionSchema> & {
     readonly elements: Readonly<TElements>;
-    readonly workflow_step: MigrationReference<TWorkflowStepCodename>;
+    readonly workflow_step: MigrationReference<TWorkflowStepCodenames>;
 };
-export type MigrationItem<TElements extends MigrationElements = MigrationElements, TSystem extends MigrationItemSystem = MigrationItemSystem, TWorkflowStepCodename extends string = string> = z.infer<typeof MigrationItemSchema> & {
-    readonly versions: Readonly<MigrationItemVersion<TElements, TWorkflowStepCodename>[]>;
+export type MigrationItem<TElements extends MigrationElements = MigrationElements, TSystem extends MigrationItemSystem = MigrationItemSystem, TWorkflowStepCodenames extends string = string> = z.infer<typeof MigrationItemSchema> & {
+    readonly versions: Readonly<MigrationItemVersion<TElements, TWorkflowStepCodenames>[]>;
     readonly system: TSystem;
 };