feat: updates to next version of management sdk + updates all deps, a…

…dds yargs help for use in command line, changes distribution modules and paths

.gitignore

@@ -4,10 +4,7 @@
 # See http://help.github.com/ignore-files/ for more about ignoring files.
 
 # compiled output
-/definitions
-/_commonjs
-/_es2015
-/_bundles
+/dist
 /tmp
 /coverage
 /out-tsc

.npmignore

@@ -4,8 +4,8 @@
 # But descend into directories
 
 # Recursively allow files under subtree
-!/src/**
-!/_commonjs/**
+!/lib/**
+!/dist/**
 !package.json
 !.npmignore
 !README.md

.vscode/launch.json

@@ -8,7 +8,7 @@
             "type": "node",
             "request": "launch",
             "name": "Test backup",
-            "program": "${workspaceFolder}\\src\\node-js\\cli\\app.ts",
+            "program": "${workspaceFolder}\\lib\\node\\cli\\app.ts",
             "preLaunchTask": "npm: build:all",
             "sourceMaps": true,
             "smartStep": true,
@@ -24,7 +24,7 @@
             "type": "node",
             "request": "launch",
             "name": "Test clean",
-            "program": "${workspaceFolder}\\src\\node-js\\cli\\app.ts",
+            "program": "${workspaceFolder}\\lib\\node\\cli\\app.ts",
             "preLaunchTask": "npm: build:all",
             "sourceMaps": true,
             "smartStep": true,
@@ -40,7 +40,7 @@
             "type": "node",
             "request": "launch",
             "name": "Test restore",
-            "program": "${workspaceFolder}\\src\\node-js\\cli\\app.ts",
+            "program": "${workspaceFolder}\\lib\\node\\cli\\app.ts",
             "preLaunchTask": "npm: build:all",
             "sourceMaps": true,
             "smartStep": true,

src/clean/clean.service.ts → lib/clean/clean.service.ts

@@ -1,10 +1,10 @@
-import { AssetFolderModels, IManagementClient, ManagementClient } from '@kentico/kontent-management';
+import { AssetFolderModels, ManagementClient } from '@kentico/kontent-management';
 
 import { ItemType } from '../core';
 import { ICleanConfig, ICleanResult } from './clean.models';
 
 export class CleanService {
-    private readonly client: IManagementClient;
+    private readonly client: ManagementClient;
 
     constructor(private config: ICleanConfig) {
         this.client = new ManagementClient({

src/export/export.service.ts → lib/export/export.service.ts

@@ -2,7 +2,6 @@ import {
     ContentItemContracts,
     ContentTypeContracts,
     ContentTypeSnippetContracts,
-    IManagementClient,
     LanguageVariantContracts,
     ManagementClient,
     TaxonomyContracts,
@@ -18,7 +17,7 @@ import { ItemType } from '../core';
 import { version } from '../../package.json';
 
 export class ExportService {
-    private readonly client: IManagementClient;
+    private readonly client: ManagementClient;
 
     constructor(private config: IExportConfig) {
         this.client = new ManagementClient({

src/import/import.service.ts → lib/import/import.service.ts

@@ -1,4 +1,3 @@
-import { HttpService } from '@kentico/kontent-core';
 import {
     AssetContracts,
     AssetFolderContracts,
@@ -9,7 +8,6 @@ import {
     ContentTypeContracts,
     ContentTypeModels,
     ContentTypeSnippetContracts,
-    IManagementClient,
     LanguageContracts,
     LanguageModels,
     LanguageVariantContracts,
@@ -34,7 +32,7 @@ import { IBinaryFile, IImportConfig, IImportSource } from './import.models';
 
 export class ImportService {
     private readonly defaultLanguageId: string = '00000000-0000-0000-0000-000000000000';
-    private readonly client: IManagementClient;
+    private readonly client: ManagementClient;
     private readonly publishedWorkflowStepName: string = 'Published';
 
     /**
@@ -53,16 +51,7 @@ export class ImportService {
                 canRetryError: (err) => true, // so that timeout errors are retried
                 maxAttempts: 3,
                 deltaBackoffMs: 1000,
-                maxCumulativeWaitTimeMs: 60000
-            },
-            httpService: new HttpService({
-                axiosRequestConfig: {
-                    // required for uploading large files
-                    // https://github.com/axios/axios/issues/1362
-                    maxContentLength: 'Infinity' as any,
-                    maxBodyLength: 'Infinity' as any
-                }
-            })
+            }
         });
     }
 

src/node-js/cli/app.ts → lib/node/cli/app.ts

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
-import * as fs from 'fs';
-import yargs = require('yargs');
+import { readFileSync } from 'fs';
+import * as yargs from 'yargs';
 
 import { CleanService } from '../../clean';
 import { ICliFileConfig, getFilenameWithoutExtension, CliAction, ItemType } from '../../core';
@@ -11,7 +11,45 @@ import { ProjectContracts, SharedModels } from '@kentico/kontent-management';
 import { FileService } from '../file/file.service';
 import { fileHelper } from '../file/file-helper';
 
-const argv = yargs.argv;
+const argv = yargs(process.argv.slice(2))
+    .example('kbm --action=backup --apiKey=xxx --projectId=xxx', 'Creates zip backup of Kontent project')
+    .example(
+        'kbm --action=restore --apiKey=xxx --projectId=xxx --zipFilename=backupFile',
+        'Read given zip file and recreates data in Kontent project'
+    )
+    .example(
+        'kbm --action=clean --apiKey=xxx --projectId=xxx',
+        'Deletes data from given Kontent project. Use with care, this action is not reversible.'
+    )
+    .alias('p', 'projectId')
+    .describe('p', 'ProjectId')
+    .alias('k', 'apiKey')
+    .describe('k', 'Management API Key')
+    .alias('a', 'action')
+    .describe('a', 'Action to perform. One of: backup, restore & clean')
+    .alias('z', 'zipFilename')
+    .describe('z', 'Name of zip used for export / restore')
+    .alias('l', 'enableLog')
+    .describe('l', 'Indicates if default logging is enabled (useful to indicate progress)')
+    .alias('f', 'force')
+    .describe(
+        'f',
+        'If enabled, project will we exported / restored even if there are data inconsistencies. Enabled by default.'
+    )
+    .alias('b', 'baseUrl')
+    .describe('b', 'Custom base URL for Management API calls.')
+    .alias('p', 'enablePublish')
+    .describe(
+        'p',
+        'Indicates if language variants published on the source project are also published on target. Enabled by default'
+    )
+    .alias('e', 'exportFilter')
+    .describe(
+        'e',
+        'Can be used to export only selected data types. Expects CSV of types. For example contentType,language will cause backup manager to export only content types & language data.'
+    )
+    .help('h')
+    .alias('h', 'help').argv;
 
 const backupAsync = async (config: ICliFileConfig) => {
     const exportService = new ExportService({
@@ -146,7 +184,7 @@ const validateConfig = (config?: ICliFileConfig) => {
     }
 };
 
-const process = async () => {
+const run = async () => {
     const config = await getConfig();
 
     validateConfig(config);
@@ -183,28 +221,35 @@ const canImport = (importData: IImportSource, config: ICliFileConfig) => {
 };
 
 const getConfig = async () => {
-    const configFilename: string = argv.config as string;
+    const resolvedArgs = await argv;
+    const configFilename: string = (await resolvedArgs.config) as string;
 
     if (configFilename) {
         // get config from file
-        const configFile = await fs.promises.readFile(`./${configFilename}`);
+        const configFile = readFileSync(`./${configFilename}`);
 
         return JSON.parse(configFile.toString()) as ICliFileConfig;
     }
 
-    const action: CliAction | undefined = argv.action as CliAction | undefined;
-    const apiKey: string | undefined = argv.apiKey as string | undefined;
-    const enableLog: boolean | undefined = (argv.enableLog as boolean | undefined) ?? true;
-    const force: boolean | undefined = (argv.force as boolean | undefined) ?? true;
-    const enablePublish: boolean | undefined = (argv.enablePublish as boolean | undefined) ?? true;
-    const projectId: string | undefined = argv.projectId as string | undefined;
-    const baseUrl: string | undefined = argv.baseUrl as string | undefined;
-    const zipFilename: string | undefined = (argv.zipFilename as string | undefined) ?? getDefaultBackupFilename();
-    const exportFilter: string | undefined = argv.exportFilter as string | undefined;
-
-    const exportFilterMapped: ItemType[] | undefined = exportFilter ? exportFilter.split(',').map(m => m.trim()).map(m => {
-        return m as ItemType;
-    }) : undefined;
+    const action: CliAction | undefined = resolvedArgs.action as CliAction | undefined;
+    const apiKey: string | undefined = resolvedArgs.apiKey as string | undefined;
+    const enableLog: boolean | undefined = (resolvedArgs.enableLog as boolean | undefined) ?? true;
+    const force: boolean | undefined = (resolvedArgs.force as boolean | undefined) ?? true;
+    const enablePublish: boolean | undefined = (resolvedArgs.enablePublish as boolean | undefined) ?? true;
+    const projectId: string | undefined = resolvedArgs.projectId as string | undefined;
+    const baseUrl: string | undefined = resolvedArgs.baseUrl as string | undefined;
+    const zipFilename: string | undefined =
+        (resolvedArgs.zipFilename as string | undefined) ?? getDefaultBackupFilename();
+    const exportFilter: string | undefined = resolvedArgs.exportFilter as string | undefined;
+
+    const exportFilterMapped: ItemType[] | undefined = exportFilter
+        ? exportFilter
+              .split(',')
+              .map((m) => m.trim())
+              .map((m) => {
+                  return m as ItemType;
+              })
+        : undefined;
 
     if (!action) {
         throw Error(`No action was provided`);
@@ -241,7 +286,7 @@ const getDefaultBackupFilename = () => {
     }-${date.getFullYear()}-${date.getHours()}-${date.getMinutes()}`;
 };
 
-process()
+run()
     .then((m) => {})
     .catch((err) => {
         if (err instanceof SharedModels.ContentManagementBaseKontentError) {

src/node-js/file/file-helper.ts → lib/node/file/file-helper.ts

@@ -1,13 +1,11 @@
-import * as fs from 'fs';
+import { promises } from 'fs';
 
 export class FileHelper {
-
     async createFileInCurrentFolderAsync(filename: string, data: any): Promise<void> {
         const filePath = './' + filename;
 
-        await fs.promises.writeFile(filePath, data);
+        await promises.writeFile(filePath, data);
     }
-
 }
 
-export const fileHelper = new FileHelper();
+export const fileHelper = new FileHelper();

src/node-js/file/file.service.ts → lib/node/file/file.service.ts

@@ -1,4 +1,4 @@
-import * as fs from 'fs';
+import { promises } from 'fs';
 import { IFileServiceConfig } from './file.models';
 
 export class FileService {
@@ -15,7 +15,7 @@ export class FileService {
         if (this.config.enableLog) {
             console.log(`Reading file '${filePath}'`);
         }
-        const file = await fs.promises.readFile(filePath);
+        const file = await promises.readFile(filePath);
         if (this.config.enableLog) {
             console.log(`Reading file completed`);
         }
@@ -27,7 +27,7 @@ export class FileService {
         const filePath = this.getFilePath(fileNameWithoutExtension);
 
         console.log(`Writing file '${filePath}'`);
-        await fs.promises.writeFile(filePath, content);
+        await promises.writeFile(filePath, content);
         console.log(`File saved`);
     }
 

src/samples/clean-sample.ts → lib/samples/clean-sample.ts

@@ -1,4 +1,4 @@
-import { CleanService } from 'src';
+import { CleanService } from 'lib';
 
 const run = async () => {
     const cleanService = new CleanService({

src/samples/export-sample.ts → lib/samples/export-sample.ts

@@ -1,7 +1,7 @@
-import { ZipService } from 'src/zip';
+import { ZipService } from 'lib/zip';
 
 import { ExportService } from '../export';
-import { FileService } from '../node-js';
+import { FileService } from '../node';
 
 const run = async () => {
     const fileService = new FileService({

src/samples/restore-sample.ts → lib/samples/restore-sample.ts

@@ -1,6 +1,6 @@
-import { ImportService } from 'src';
+import { ImportService } from 'lib';
 import { ZipService } from '../zip';
-import { FileService } from '../node-js';
+import { FileService } from '../node';
 
 const run = async () => {
     const zipService = new ZipService({

src/zip/zip.service.ts → lib/zip/zip.service.ts

@@ -1,5 +1,5 @@
 import { AssetContracts } from '@kentico/kontent-management';
-import JSZip = require('jszip');
+import * as JSZip from 'jszip';
 import axios, {} from 'axios';
 
 import { IExportAllResult } from '../export';