Merge pull request #24 from Kentico/feature/21

Tomáš Winkler · web-flow · commit 109d945f01a8 · 2021-08-05T19:27:47.000+02:00
Make MAPI JSD SDK Peer dependency
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -19,6 +19,7 @@ jobs:
           node-version: ${{ matrix.node-version }}
           registry-url: 'https://registry.npmjs.org'
       - run: npm install
+      - run: npm run lint
       - run: npm run build
       - run: npm publish
         env:
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -13,4 +13,7 @@ jobs:
       with:
         node-version: ${{ matrix.node-version }}
     - run: npm i
+    - run: npm run lint
+    - run: npm run build
     - run: npm run test
+
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,6 @@
 Migrations/.environments.json
 Migrations/status.json
 /package-lock.json
+
+# Generated by tests
+status.json
diff --git a/package.json b/package.json
@@ -1,13 +1,15 @@
 {
   "name": "@kentico/kontent-cli",
-  "version": "0.0.11",
+  "version": "0.1.0",
   "description": "Command line interface tool that can be used for generating and running Kontent migration scripts",
   "main": "./lib/index.js",
   "types": "./lib/types/index.d.ts",
   "scripts": {
     "build": "tsc",
+    "watch": "tsc -w",
     "test": "jest",
-    "lint": "tslint --project tsconfig.json --fix \"src/**/*.ts\" && prettier --write \"src/**/*.ts\"",
+    "lint": "tslint --project tsconfig.json \"src/**/*.ts\" && prettier --check \"src/**/*.ts\"",
+    "lint:fix": "tslint --project tsconfig.json --fix \"src/**/*.ts\" && prettier --write \"src/**/*.ts\"",
     "debug": "node --inspect ./lib/index.js migration run --all -e DEV"
   },
   "publishConfig": {
@@ -45,14 +47,13 @@
   },
   "homepage": "https://github.com/Kentico/kontent-cli#readme",
   "dependencies": {
+    "@kentico/kontent-backup-manager": "3.0.1",
     "chalk": "^4.0.0",
-    "yargs": "^15.3.1",
-    "@kentico/kontent-management": "~0.4.7",
-    "@kentico/kontent-backup-manager": "~1.2.2",
-    "dotenv": "^8.2.0"
+    "dotenv": "^8.2.0",
+    "yargs": "^15.3.1"
   },
   "peerDependencies": {
-    "rxjs": "^6.5.5"
+    "@kentico/kontent-management": "^1.2.0"
   },
   "devDependencies": {
     "@babel/core": "~7.9.0",
diff --git a/src/cmds/backup.ts b/src/cmds/backup.ts
@@ -1,9 +1,9 @@
 import yargs from 'yargs';
 import chalk from 'chalk';
 import { environmentConfigExists, getEnvironmentsConfig } from '../utils/environmentUtils';
-import { CleanService, ExportService, ImportService, ZipService } from '@kentico/kontent-backup-manager';
+import { CleanService, ExportService, ImportService, ZipService, IProcessedItem } from '@kentico/kontent-backup-manager';
 import { getFileBackupName } from '../utils/fileUtils';
-import { IProcessedItem } from '@kentico/kontent-backup-manager/_commonjs/src';
+import { FileService } from '@kentico/kontent-backup-manager/dist/cjs/lib/node';
 
 const kontentBackupCommand: yargs.CommandModule = {
     command: 'backup',
@@ -42,6 +42,12 @@ const kontentBackupCommand: yargs.CommandModule = {
                     describe: 'Environment name',
                     type: 'string',
                 },
+                'enable-publish': {
+                    alias: 'ep',
+                    describe: 'Indicates if language variants published on the source project are also published on target. Enabled by default',
+                    type: 'boolean',
+                    default: true,
+                },
             })
             .conflicts('environment', 'api-key')
             .conflicts('environment', 'project-id')
@@ -76,12 +82,16 @@ const kontentBackupCommand: yargs.CommandModule = {
 
         const defaultBackupName = getFileBackupName();
         const zipService = new ZipService({
-            filename: argv.name || defaultBackupName,
+            context: 'node.js',
             enableLog: argv.log,
         });
 
         console.log('Starting backup tool');
 
+        const fileService = new FileService({
+            enableLog: argv.log,
+        });
+
         switch (argv.action) {
             case 'backup':
                 const exportService = new ExportService({
@@ -95,21 +105,23 @@ const kontentBackupCommand: yargs.CommandModule = {
                 });
                 const exportedData = await exportService.exportAllAsync();
                 await zipService.createZipAsync(exportedData);
+                const backupZipData = await zipService.createZipAsync(exportedData);
+                await fileService.writeFileAsync(argv.name || defaultBackupName, backupZipData);
                 break;
 
             case 'restore':
-                const zipData = await zipService.extractZipAsync();
+                const zipData = await zipService.extractZipAsync(await fileService.loadFileAsync(argv.name || defaultBackupName));
                 const importService = new ImportService({
                     onImport: (item: IProcessedItem) => {
                         if (argv.log) {
                             console.log(`Imported: ${item.title} | ${item.type}`);
                         }
                     },
+                    enablePublish: argv.enablePublish,
                     projectId: projectId,
                     apiKey: apiKey,
                     enableLog: argv.log,
                     fixLanguages: true,
-                    workflowIdForImportedItems: '00000000-0000-0000-0000-000000000000',
                 });
                 await importService.importFromSourceAsync(zipData);
                 break;
diff --git a/src/cmds/environment.ts b/src/cmds/environment.ts
@@ -1,13 +1,13 @@
-import yargs from 'yargs';
-
-const environmentCommand: yargs.CommandModule = {
-    command: 'environment <command>',
-    describe: 'Environment commands',
-    builder: (yargs: any) => {
-        return yargs.commandDir('environment').demandCommand(2, 'Please specify a environment arguments');
-    },
-    handler: (argv: any) => {}
-};
-
-// yargs needs exported command in exports object
-Object.assign(exports, environmentCommand);
+import yargs from 'yargs';
+
+const environmentCommand: yargs.CommandModule = {
+    command: 'environment <command>',
+    describe: 'Environment commands',
+    builder: (yargs: any) => {
+        return yargs.commandDir('environment').demandCommand(2, 'Please specify a environment arguments');
+    },
+    handler: (argv: any) => {},
+};
+
+// yargs needs exported command in exports object
+Object.assign(exports, environmentCommand);
diff --git a/src/cmds/environment/add.ts b/src/cmds/environment/add.ts
@@ -3,7 +3,7 @@ import { saveEnvironmentConfig } from '../../utils/environmentUtils';
 
 const addEnvironmentCommand: yargs.CommandModule = {
     command: 'add',
-    describe: "Store information about the environment locally. The environment is defined as a named pair of values. For example, a 'DEV' environment can be defined as a pair of specific project ID and Management API key.",
+    describe: 'Store information about the environment locally. The environment is defined as a named pair of values. For example, a "DEV" environment can be defined as a pair of specific project ID and Management API key.',
     builder: (yargs: any) =>
         yargs
             .options({
diff --git a/src/cmds/migration.ts b/src/cmds/migration.ts
@@ -1,13 +1,13 @@
-import yargs from 'yargs';
-
-const migrationCommand: yargs.CommandModule = {
-    command: 'migration <command>',
-    describe: 'Migration commands',
-    builder: (yargs: any) => {
-        return yargs.commandDir('migration').demandCommand(2, 'Please specify a migration arguments');
-    },
-    handler: (argv: any) => {}
-};
-
-// yargs needs exported command in exports object
-Object.assign(exports, migrationCommand);
+import yargs from 'yargs';
+
+const migrationCommand: yargs.CommandModule = {
+    command: 'migration <command>',
+    describe: 'Migration commands',
+    builder: (yargs: any) => {
+        return yargs.commandDir('migration').demandCommand(2, 'Please specify a migration arguments');
+    },
+    handler: (argv: any) => {},
+};
+
+// yargs needs exported command in exports object
+Object.assign(exports, migrationCommand);
diff --git a/src/cmds/migration/add.ts b/src/cmds/migration/add.ts
@@ -1,37 +1,37 @@
-import yargs from 'yargs';
-import chalk from 'chalk';
-import { createMigration } from '../../utils/migrationUtils';
-import { TemplateType } from '../../models/templateType';
-
-const addMigrationCommand: yargs.CommandModule = {
-    command: 'add',
-    describe: 'Generates a template script (in JavaScript or TypeScript) for running a migration on a Kentico Kontent project.',
-    builder: (yargs: any) =>
-        yargs
-            .options({
-                name: {
-                    alias: 'n',
-                    describe: 'Migration name',
-                    type: 'string'
-                },
-                'template-type': {
-                    alias: 't',
-                    describe: 'Determines whether the template script is in TypeScript or plain JavaScript',
-                    type: 'string',
-                    default: 'javascript'
-                }
-            })
-            .demandOption(['name', 'template-type']),
-    handler: (argv: any) => {
-        if (!['javascript', 'typescript'].includes(argv.templateType)) {
-            console.error(chalk.redBright(`Unexpected template type ${argv.templateType} allowed is [typescript, javascript]`));
-            process.exit(1);
-        }
-
-        const templateType = argv.templateType === 'javascript' ? TemplateType.Javascript : TemplateType.TypeScript;
-        createMigration(argv.name, templateType);
-    }
-};
-
-// yargs needs exported command in exports object
-Object.assign(exports, addMigrationCommand);
+import yargs from 'yargs';
+import chalk from 'chalk';
+import { createMigration } from '../../utils/migrationUtils';
+import { TemplateType } from '../../models/templateType';
+
+const addMigrationCommand: yargs.CommandModule = {
+    command: 'add',
+    describe: 'Generates a template script (in JavaScript or TypeScript) for running a migration on a Kentico Kontent project.',
+    builder: (yargs: any) =>
+        yargs
+            .options({
+                name: {
+                    alias: 'n',
+                    describe: 'Migration name',
+                    type: 'string',
+                },
+                'template-type': {
+                    alias: 't',
+                    describe: 'Determines whether the template script is in TypeScript or plain JavaScript',
+                    type: 'string',
+                    default: 'javascript',
+                },
+            })
+            .demandOption(['name', 'template-type']),
+    handler: (argv: any) => {
+        if (!['javascript', 'typescript'].includes(argv.templateType)) {
+            console.error(chalk.redBright(`Unexpected template type ${argv.templateType} allowed is [typescript, javascript]`));
+            process.exit(1);
+        }
+
+        const templateType = argv.templateType === 'javascript' ? TemplateType.Javascript : TemplateType.TypeScript;
+        createMigration(argv.name, templateType);
+    },
+};
+
+// yargs needs exported command in exports object
+Object.assign(exports, addMigrationCommand);
diff --git a/src/index.ts b/src/index.ts
@@ -20,6 +20,7 @@ const createMigrationTool = (): number => {
         .example('kontent', 'backup --action backup --project-id <YOUR_PROJECT_ID> --api-key <YOUR_MANAGEMENT_API_KEY>')
         .example('kontent', 'backup --action backup --environment <YOUR_ENVIRONMENT>')
         .example('kontent', 'backup --action restore --name backup_file --project-id <YOUR_PROJECT_ID> --api-key <YOUR_MANAGEMENT_API_KEY>')
+        .example('kontent', 'backup --action restore --name backup_file --environment <YOUR_ENVIRONMENT> --enable-publish false')
         .example('kontent', 'backup --action clean --project-id <YOUR_PROJECT_ID> --api-key <YOUR_MANAGEMENT_API_KEY>')
         .strict().argv;
 
diff --git a/src/managementClientFactory.ts b/src/managementClientFactory.ts
@@ -1,6 +1,5 @@
 import { ManagementClient } from '@kentico/kontent-management';
 import { HttpService } from '@kentico/kontent-core';
-import chalk from 'chalk';
 const packageInfo = require('../package.json');
 import * as dotEnv from 'dotenv';
 
@@ -16,45 +15,26 @@ dotEnv.config();
 
 export const createManagementClient = (params: ICreateManagementClientParams): ManagementClient => {
     const httpService = new HttpService({
-        requestInterceptor: config => {
-            config.maxContentLength = 104857600;
-            config.headers['X-KC-SOURCE'] = `${packageInfo.name};${packageInfo.version}`;
-
-            if (params.debugMode) {
-                console.group(chalk.bgCyan(chalk.yellowBright('Request details:')));
-                console.log(chalk.yellow('URL:'), config.url);
-                console.log(chalk.yellow('Method:'), config.method);
-                console.log(chalk.yellow('Body:'), config.data);
-                console.groupEnd();
-            }
-            return config;
+        axiosRequestConfig: {
+            headers: {
+                'X-KC-SOURCE': `${packageInfo.name};${packageInfo.version}`,
+            },
         },
-        responseInterceptor: config => {
-            if (params.debugMode) {
-                console.group(chalk.bgCyan(chalk.yellowBright('Response details:')));
-                console.error(chalk.yellow('Body:'), config.data);
-                console.groupEnd();
-            }
-
-            return config;
-        }
     });
 
     return new ManagementClient({
         httpService: httpService,
         projectId: params.projectId,
         apiKey: params.apiKey,
-        isDeveloperMode: false,
         baseUrl: process.env.BASE_URL,
         retryStrategy: {
             addJitter: true,
             deltaBackoffMs: 1000,
-            maxCumulativeWaitTimeMs: 60000,
             maxAttempts: 10,
             canRetryError: (error: any) => {
                 const timeout = error.errno === 'ETIMEDOUT';
                 return timeout || (error.response && retryAbleCodes.includes(error.response.status));
-            }
-        }
+            },
+        },
     });
 };
diff --git a/src/models/templateType.ts b/src/models/templateType.ts
@@ -1,4 +1,4 @@
 export enum TemplateType {
     TypeScript,
-    Javascript
+    Javascript,
 }
diff --git a/src/tests/createMigration.test.ts b/src/tests/createMigration.test.ts
@@ -1,14 +1,14 @@
-import { generatePlainMigration, generateTypedMigration } from '../utils/migrationUtils';
-
-describe('Migration generation', () => {
-    it('Creates new typescript migration with name', () => {
-        const migrationContent = generateTypedMigration();
-        expect(migrationContent).toMatchSnapshot();
-    });
-
-    it('Creates new javascript migration with name', () => {
-        const migrationContent = generatePlainMigration();
-
-        expect(migrationContent).toMatchSnapshot();
-    });
-});
+import { generatePlainMigration, generateTypedMigration } from '../utils/migrationUtils';
+
+describe('Migration generation', () => {
+    it('Creates new typescript migration with name', () => {
+        const migrationContent = generateTypedMigration();
+        expect(migrationContent).toMatchSnapshot();
+    });
+
+    it('Creates new javascript migration with name', () => {
+        const migrationContent = generatePlainMigration();
+
+        expect(migrationContent).toMatchSnapshot();
+    });
+});
diff --git a/src/tests/duplicateMigration.test.ts b/src/tests/duplicateMigration.test.ts
diff --git a/src/tests/fileUtils.test.ts b/src/tests/fileUtils.test.ts
diff --git a/src/types/index.ts b/src/types/index.ts
diff --git a/src/utils/environmentUtils.ts b/src/utils/environmentUtils.ts
diff --git a/src/utils/migrationUtils.ts b/src/utils/migrationUtils.ts
