@kontent-ai/migration-toolkit 1.0.0

package/.npmignore

@@ -0,0 +1,13 @@
+# Ignore everything
+*
+
+# But descend into directories
+
+# Recursively allow files under subtree
+!/lib/**
+!/dist/**
+!package.json
+!.npmignore
+!README.md
+
+

package/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024 Kontent s.r.o.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,272 @@
+# 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.
+
+> [!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 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
+
+# you can also install the package globally, or locally
+npm i @kontent-ai-consulting/migration-toolkit -g
+
+# with the package installed, you can call the tool as follows
+kontent-ai-migration-toolkit --help
+
+# or check details of particular command
+kontent-ai-migration-toolkit migrate --help
+```
+
+## Code examples
+
+1. [Import](https://github.com/Kontent-ai/kontent-ai-migration-toolkit/blob/main/samples/import-sample.ts)
+2. [Export](https://github.com/Kontent-ai/kontent-ai-migration-toolkit/blob/main/samples/export-sample.ts)
+3. [Migrate from external system](https://github.com/Kontent-ai/kontent-ai-migration-toolkit/blob/main/samples/migrate-from-external-system.ts)
+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.
+
+# Migrate between Kontent.ai environments
+
+You may migrate content (items & asset) between Kontent.ai environments. For migrating _Data model / structure_ see
+[Data Ops](https://github.com/kontent-ai/data-ops) instead.
+
+> [!CAUTION]  
+> **We recommend migrating to test / dev environments first ** to ensure nothing unexpected happens..
+
+## Configuration
+
+| Config                  | Value                                                                                                 |
+| ----------------------- | ----------------------------------------------------------------------------------------------------- |
+| **sourceEnvironmentId** | Id of source environment **(required)**                                                               |
+| **sourceApiKey**        | Management API key of source environment **(required)**                                               |
+| **targetEnvironmentId** | Id of target environment **(required)**                                                               |
+| **targetApiKey**        | Management API key of target environment **(required)**                                               |
+| **language**            | Codename of language that items will be exported in **(required)**                                    |
+| **items**               | Comma separated list of items that will be exported **(required)**                                    |
+| force                   | Can be used to disable confirmation prompts. Available options: `true` & `false`. Detaults to `false` |
+
+## Migrate CLI
+
+```bash
+# Migrate from Kontent.ai environment into another Kontent.ai environment
+kontent-ai-migration-toolkit migrate --targetEnvironmentId=x --targetApiKey=x --sourceEnvironmentId=x --sourceApiKey=x --language=default --items=itemA,itemB
+```
+
+# 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.
+
+> [!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.
+
+## Configuration
+
+| Config                  | Value                                                                                                 |
+| ----------------------- | ----------------------------------------------------------------------------------------------------- |
+| **targetEnvironmentId** | Id of Kontent.ai environment **(required)**                                                           |
+| **targetApiKey**        | Management API key **(required)**                                                                     |
+| **filename**            | Name of the zip file **(required)**                                                                   |
+| baseUrl                 | Custom base URL for Kontent.ai API calls                                                              |
+| force                   | Can be used to disable confirmation prompts. Available options: `true` & `false`. Detaults to `false` |
+
+## Import CLI
+
+```bash
+# Import into target environment
+kontent-ai-migration-toolkit import --targetEnvironmentId=x --targetApiKey=x --filename=data.zip
+```
+
+# 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.
+
+## Configuration
+
+| Config                  | Value                                                              |
+| ----------------------- | ------------------------------------------------------------------ |
+| **sourceEnvironmentId** | Id of Kontent.ai environment **(required)**                        |
+| **sourceApiKey**        | Management API key of Kontent.ai environment **(required)**        |
+| **language**            | Codename of language that items will be exported in **(required)** |
+| **items**               | Comma separated list of items that will be exported **(required)** |
+| filename                | Name of the zip file                                               |
+| baseUrl                 | Custom base URL for Kontent.ai API calls                           |
+
+## Export CLI
+
+```bash
+# Export from Kontent.ai environment
+kontent-ai-migration-toolkit export --sourceEnvironmentId=x --sourceApiKey=x --language=default --items=itemA,itemB
+```
+
+# 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.
+
+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
+ */
+interface ArticleElements extends MigrationElements {
+    title: MigrationElementModels.TextElement;
+    rating: MigrationElementModels.NumberElement;
+    related_pages: MigrationElementModels.LinkedItemsElement;
+    teaser_image: MigrationElementModels.AssetElement;
+}
+
+const migrationItem: MigrationItem<ArticleElements> = {
+    system: {
+        name: 'My article',
+        // codename is primary identifier - also used for validating whether asset exists in target env
+        codename: 'myArticle',
+        collection: {
+            // collection codename must match the collection in your target K.ai environment
+            codename: 'default'
+        },
+        language: {
+            // language codename must match the language in your target K.ai environment
+            codename: 'en_uk'
+        },
+        type: {
+            // type codename must match the content type codename in your target K.ai environment
+            codename: 'article'
+        }
+    },
+    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 = {
+    // codename of the asset - Used for validating whether asset exists in target env
+    codename: 'article_teaser',
+    // filename will be used in K.ai asset as a filename
+    filename: 'article_teaser.jpg',
+    // title will be used in K.ai asset as a title
+    title: 'Article teaser',
+    // binary data of the asset you want to upload
+    binaryData: <BinaryData>,
+    // collection assignment
+    collection: {
+        codename: 'teasers'
+    },
+    // description of asset in project languages
+    descriptions: [
+        {
+            description: 'Teaser of the article',
+            language: {
+                codename: 'en_uk'
+            }
+        }
+    ]
+};
+```
+
+Once you are happy with the data, you can import them to Kontent.ai using the `importAsync` function.
+
+```typescript
+await importAsync({
+    environmentId: environmentId,
+    apiKey: apiKey,
+    data: {
+        assets: [migrationAsset],
+        items: [migrationItem]
+    }
+});
+```
+
+# Migration / import processing
+
+### 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.
+
+### 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.
+
+### 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.
+
+See the table below to learn how `external_id` is generated by default:
+
+| Object type      | Template           | Sample `codename` of the object | Generated `external_id` |
+| ---------------- | ------------------ | ------------------------------- | ----------------------- |
+| **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.
+
+## 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
+
+## 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)
+
+Example script call:
+
+```bash
+node --max-http-header-size 150000 %USERPROFILE%\AppData\Roaming\npm\node_modules\kontent-ai-migration-toolkit\dist\cjs\lib\node\cli\app --action=export --apiKey=<key> --environmentId=<environmentId>
+```

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

@@ -0,0 +1,37 @@
+import { WorkflowModels } from '@kontent-ai/management-sdk';
+export type WorkflowStep = {
+    readonly codename: string;
+    readonly id: string;
+};
+type WorkflowMatcher = {
+    readonly match: (workflow: Readonly<WorkflowModels.Workflow>, index: number) => boolean;
+    readonly errorMessage: string;
+};
+type StepMatcher = {
+    readonly match: (step: WorkflowStep, index: number) => boolean;
+    readonly errorMessage: string;
+};
+export declare function workflowHelper(workflows: readonly Readonly<WorkflowModels.Workflow>[]): {
+    getWorkflowByCodename: (workflowCodename: string) => Readonly<WorkflowModels.Workflow>;
+    getWorkflowStepByCodename: (workflow: Readonly<WorkflowModels.Workflow>, stepCodename: string) => WorkflowStep;
+    getWorkflowAndStepByCodenames: (data: {
+        readonly workflowCodename: string;
+        readonly stepCodename: string;
+    }) => {
+        step: WorkflowStep;
+        workflow: Readonly<WorkflowModels.Workflow>;
+    };
+    getWorkflowStep: (workflow: Readonly<WorkflowModels.Workflow>, stepMatcher: StepMatcher) => WorkflowStep;
+    getWorkflowAndStep: (data: {
+        readonly workflowMatcher: WorkflowMatcher;
+        readonly stepMatcher: StepMatcher;
+    }) => {
+        step: WorkflowStep;
+        workflow: Readonly<WorkflowModels.Workflow>;
+    };
+    getWorkflow: (workflowMatcher: WorkflowMatcher) => Readonly<WorkflowModels.Workflow>;
+    isPublishedStepByCodename: (stepCodename: string) => boolean;
+    isArchivedStepByCodename: (stepCodename: string) => boolean;
+    isScheduledStepByCodename: (stepCodename: string) => boolean;
+};
+export {};

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

@@ -0,0 +1,67 @@
+import chalk from 'chalk';
+import { findRequired } from '../utils/array.utils.js';
+export function workflowHelper(workflows) {
+    const getWorkflowStep = (workflow, stepMatcher) => {
+        return findRequired([...workflow.steps, workflow.archivedStep, workflow.publishedStep, workflow.scheduledStep], stepMatcher.match, stepMatcher.errorMessage);
+    };
+    const getWorkflow = (workflowMatcher) => {
+        return findRequired(workflows, workflowMatcher.match, workflowMatcher.errorMessage);
+    };
+    const getWorkflowByCodename = (workflowCodename) => {
+        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(', ')}`
+            ].join(', '),
+            match: (workflow) => workflow.codename.toLowerCase() === workflowCodename.toLowerCase()
+        });
+    };
+    const getWorkflowStepByCodename = (workflow, stepCodename) => {
+        return getWorkflowStep(workflow, {
+            errorMessage: [
+                `Workflow step with codename '${chalk.red(stepCodename)}' does not exist in target project`,
+                `Step in workflow '${chalk.yellow(workflow.codename)}' are (${workflows.length}): ${workflows
+                    .map((m) => chalk.cyan(m.codename))
+                    .join(', ')}`
+            ].join(', '),
+            match: (step) => step.codename.toLowerCase() === stepCodename.toLowerCase()
+        });
+    };
+    const getWorkflowAndStep = (data) => {
+        const workflow = getWorkflow(data.workflowMatcher);
+        return {
+            workflow,
+            step: getWorkflowStep(workflow, data.stepMatcher)
+        };
+    };
+    const getWorkflowAndStepByCodenames = (data) => {
+        const workflow = getWorkflowByCodename(data.workflowCodename);
+        return {
+            workflow,
+            step: getWorkflowStepByCodename(workflow, data.stepCodename)
+        };
+    };
+    const isPublishedStepByCodename = (stepCodename) => {
+        return workflows.find((workflow) => workflow.publishedStep.codename === stepCodename) ? true : false;
+    };
+    const isArchivedStepByCodename = (stepCodename) => {
+        return workflows.find((workflow) => workflow.archivedStep.codename === stepCodename) ? true : false;
+    };
+    const isScheduledStepByCodename = (stepCodename) => {
+        return workflows.find((workflow) => workflow.scheduledStep.codename === stepCodename) ? true : false;
+    };
+    return {
+        getWorkflowByCodename,
+        getWorkflowStepByCodename,
+        getWorkflowAndStepByCodenames,
+        getWorkflowStep,
+        getWorkflowAndStep,
+        getWorkflow,
+        isPublishedStepByCodename,
+        isArchivedStepByCodename,
+        isScheduledStepByCodename
+    };
+}
+//# sourceMappingURL=workflow-helper.js.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,15 @@
+export * from './utils/global.utils.js';
+export * from './utils/processing-utils.js';
+export * from './utils/http.utils.js';
+export * from './utils/confirm.utils.js';
+export * from './utils/error.utils.js';
+export * from './utils/run.utils.js';
+export * from './utils/external-id.utils.js';
+export * from './utils/binary-data.utils.js';
+export * from './utils/array.utils.js';
+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 './logs/loggers.js';
+export * from './helpers/workflow-helper.js';

package/dist/es2022/core/index.js

@@ -0,0 +1,16 @@
+export * from './utils/global.utils.js';
+export * from './utils/processing-utils.js';
+export * from './utils/http.utils.js';
+export * from './utils/confirm.utils.js';
+export * from './utils/error.utils.js';
+export * from './utils/run.utils.js';
+export * from './utils/external-id.utils.js';
+export * from './utils/binary-data.utils.js';
+export * from './utils/array.utils.js';
+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 './logs/loggers.js';
+export * from './helpers/workflow-helper.js';
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +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"}

package/dist/es2022/core/logs/loggers.d.ts

@@ -0,0 +1,2 @@
+import { Logger } from '../models/log.models.js';
+export declare function getDefaultLogger(): Logger;

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

@@ -0,0 +1,69 @@
+import chalk from 'chalk';
+import { getCurrentEnvironment } from '../utils/global.utils.js';
+const originalWarn = console.warn;
+export function getDefaultLogger() {
+    const currentEnv = getCurrentEnvironment();
+    if (currentEnv === 'node') {
+        return defaultNodeLogger;
+    }
+    if (currentEnv === 'browser') {
+        return defaultBrowserLogger;
+    }
+    throw Error(`Invalid environment`);
+}
+const defaultNodeLogger = {
+    log: (data) => console.log(getLogDataMessage(data)),
+    logWithSpinnerAsync: async (func) => {
+        const ora = await import('ora');
+        return await ora.oraPromise(async (spinner) => {
+            // patch global console to prevent disrupting ora instance
+            // this often happens when JS SDK logs console.warn for
+            // retried requests. Patching this ensures the flow is uninterrupted
+            global.console.warn = (m) => {
+                if (m) {
+                    spinner.text = m?.toString() ?? 'Invalid warn value';
+                }
+            };
+            const result = await func((data) => {
+                // remember last used prefix. This is useful as we don't have to pass prefix to every single function
+                // calling the spinner
+                if (data.prefix) {
+                    spinner.prefixText = data.prefix ?? '';
+                }
+                spinner.text = getLogDataMessage(data);
+            });
+            // restore original warn
+            global.console.warn = originalWarn;
+            return result;
+        }, {});
+    }
+};
+const defaultBrowserLogger = {
+    log: (data) => console.log(getLogDataMessage(data)),
+    logWithSpinnerAsync: async (func) => {
+        return await func((data) => {
+            const prefix = data.prefix ? `${data.prefix}: ` : '';
+            console.log(`${prefix}${getLogDataMessage(data)}`);
+        });
+    }
+};
+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}`;
+}
+//# sourceMappingURL=loggers.js.map

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

@@ -0,0 +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,IACH,IAAI,CAAC,IAAI,KAAK,OAAO;QACrB,IAAI,CAAC,IAAI,KAAK,WAAW;QACzB,IAAI,CAAC,IAAI,KAAK,SAAS;QACvB,IAAI,CAAC,IAAI,KAAK,QAAQ,EACxB,CAAC;QACC,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"}

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

@@ -0,0 +1,91 @@
+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 TargetItemState = 'exists' | 'doesNotExists';
+export type CliAction = 'export' | 'import' | 'migrate';
+export type GeneralItemType = 'exportedItem' | 'migrationItem';
+export type GeneralActionType = 'readFs' | 'skip' | 'writeFs' | 'download';
+export type EnvContext = 'browser' | 'node';
+export type MapiAction = 'list' | 'view' | 'archive' | 'unpublish' | 'changeWorkflowStep' | 'publish' | 'upload' | 'create' | 'upsert' | 'createNewVersion';
+export type MapiType = 'contentType' | 'asset' | 'contentTypeSnippet' | 'contentItem' | 'languageVariant' | 'language' | 'collection' | 'taxonomy' | 'binaryFile' | 'workflow';
+export interface ItemInfo {
+    readonly title: string;
+    readonly itemType: GeneralItemType | MapiType;
+}
+export interface ErrorData {
+    readonly message: string;
+    readonly requestData?: string;
+    readonly requestUrl?: string;
+    readonly isUnknownError: boolean;
+    readonly error: unknown;
+}
+export interface ReferencedDataInMigrationItems {
+    readonly itemCodenames: ReadonlySet<string>;
+    readonly assetCodenames: ReadonlySet<string>;
+}
+export interface ReferencedDataInLanguageVariants {
+    readonly itemIds: ReadonlySet<string>;
+    readonly assetIds: ReadonlySet<string>;
+}
+export interface ItemStateInSourceEnvironmentById {
+    readonly state: TargetItemState;
+    readonly id: string;
+    readonly item: Readonly<ContentItemModels.ContentItem> | undefined;
+}
+export interface AssetStateInSourceEnvironmentById {
+    readonly state: TargetItemState;
+    readonly id: string;
+    readonly asset: Readonly<AssetModels.Asset> | undefined;
+}
+export interface ItemStateInTargetEnvironmentByCodename {
+    readonly state: TargetItemState;
+    readonly itemCodename: string;
+    readonly item: Readonly<ContentItemModels.ContentItem> | undefined;
+    readonly externalIdToUse: string;
+}
+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;
+}
+export interface AssetStateInTargetEnvironmentByCodename {
+    readonly state: TargetItemState;
+    readonly assetCodename: string;
+    readonly asset: Readonly<AssetModels.Asset> | undefined;
+    readonly externalIdToUse: string;
+}
+export interface PackageMetadata {
+    readonly created: Date;
+    readonly environmentId: string;
+    readonly dataOverview: PackageDataOverview;
+}
+export interface PackageDataOverview {
+    readonly contentItemsCount: number;
+    readonly assetsCount: number;
+}
+export interface FlattenedContentTypeElement {
+    readonly codename: string;
+    readonly id: string;
+    readonly type: MigrationElementType;
+    readonly element: Readonly<ContentTypeElements.ContentTypeElementModel>;
+}
+export interface FlattenedContentType {
+    readonly contentTypeCodename: string;
+    readonly contentTypeId: string;
+    readonly elements: readonly FlattenedContentTypeElement[];
+}
+export interface OriginalManagementError {
+    response?: {
+        status?: number;
+        config?: {
+            url?: string;
+            data?: string;
+        };
+        data?: {
+            error_code?: number;
+        };
+    };
+}

package/dist/es2022/core/models/core.models.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=core.models.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"core.models.js","sourceRoot":"","sources":["../../../../lib/core/models/core.models.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,15 @@
+import { GeneralActionType, GeneralItemType, MapiAction, MapiType } from '../index.js';
+export type DebugType = 'error' | 'completed' | 'warning' | 'info' | 'errorData' | 'cancel' | 'process' | MapiType | GeneralActionType | MapiAction | GeneralItemType;
+export interface LogMessage {
+    readonly type: DebugType;
+    readonly message: string;
+}
+export interface LogSpinnerMessage extends LogMessage {
+    readonly prefix?: string;
+}
+export type LogData = (data: LogMessage) => void;
+export type LogSpinnerData = (data: LogSpinnerMessage) => void;
+export interface Logger {
+    readonly logWithSpinnerAsync: <T>(func: (logData: LogSpinnerData) => Promise<T>) => Promise<T>;
+    readonly log: LogData;
+}

package/dist/es2022/core/models/log.models.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=log.models.js.map

package/dist/es2022/core/models/log.models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"log.models.js","sourceRoot":"","sources":["../../../../lib/core/models/log.models.ts"],"names":[],"mappings":""}