contensis-cli 1.0.0-beta.9 → 1.0.0-beta.91

package/dist/util/yaml.js

@@ -0,0 +1,45 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var yaml_exports = {};
+__export(yaml_exports, {
+  parseYaml: () => parseYaml,
+  parseYamlDocument: () => parseYamlDocument,
+  stringifyYaml: () => stringifyYaml,
+  validateWorkflowYaml: () => validateWorkflowYaml
+});
+module.exports = __toCommonJS(yaml_exports);
+var import_core = require("@action-validator/core");
+var import_yaml = require("yaml");
+const parseYaml = import_yaml.parse;
+const parseYamlDocument = import_yaml.parseDocument;
+const stringifyYaml = import_yaml.stringify;
+const validateWorkflowYaml = (yaml) => {
+  const { actionType, errors } = (0, import_core.validateWorkflow)(yaml);
+  if (actionType && errors.length === 0)
+    return true;
+  return errors;
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  parseYaml,
+  parseYamlDocument,
+  stringifyYaml,
+  validateWorkflowYaml
+});
+//# sourceMappingURL=yaml.js.map

package/dist/util/yaml.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/util/yaml.ts"],
+  "sourcesContent": ["import { validateWorkflow } from '@action-validator/core';\n\nimport { parse, parseDocument, stringify } from 'yaml';\n\nexport const parseYaml = parse;\nexport const parseYamlDocument = parseDocument;\nexport const stringifyYaml = stringify;\n\nexport const validateWorkflowYaml = (yaml: string) => {\n  const { actionType, errors } = validateWorkflow(yaml);\n  if (actionType && errors.length === 0) return true;\n  return errors;\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAAiC;AAEjC,kBAAgD;AAEzC,MAAM,YAAY;AAClB,MAAM,oBAAoB;AAC1B,MAAM,gBAAgB;AAEtB,MAAM,uBAAuB,CAAC,SAAiB;AACpD,QAAM,EAAE,YAAY,OAAO,QAAI,8BAAiB,IAAI;AACpD,MAAI,cAAc,OAAO,WAAW;AAAG,WAAO;AAC9C,SAAO;AACT;",
+  "names": []
+}

package/dist/version.js

@@ -21,7 +21,7 @@ __export(version_exports, {
   LIB_VERSION: () => LIB_VERSION
 });
 module.exports = __toCommonJS(version_exports);
-const LIB_VERSION = "1.0.0-beta.9";
+const LIB_VERSION = "1.0.0-beta.91";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   LIB_VERSION

package/dist/version.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/version.ts"],
-  "sourcesContent": ["export const LIB_VERSION = \"1.0.0-beta.9\";\n"],
+  "sourcesContent": ["export const LIB_VERSION = \"1.0.0-beta.91\";\n"],
   "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAO,MAAM,cAAc;",
   "names": []
 }

package/esbuild.config.js

@@ -23,7 +23,9 @@ rimraf('./dist', () => {
       platform: 'node',
       format: 'cjs',
       sourcemap: true,
-      target: 'node16',
+      // needs to be node12 to transform dynamic imports into requires
+      // so the bundles are compatible with the pkg exe builds
+      target: 'node12',
       plugins: [globPlugin(), nodeExternalsPlugin()],
       watch: watch && {
         onRebuild(error) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "contensis-cli",
-  "version": "1.0.0-beta.9",
+  "version": "1.0.0-beta.91",
   "description": "A fully featured Contensis command line interface with a shell UI provides simple and intuitive ways to manage or profile your content in any NodeJS terminal.",
   "repository": "https://github.com/contensis/node-cli",
   "homepage": "https://github.com/contensis/node-cli/tree/main/packages/contensis-cli#readme",
@@ -23,30 +23,39 @@
   "author": "Zengenti",
   "license": "ISC",
   "dependencies": {
+    "@action-validator/core": "^0.5.3",
     "app-root-path": "^3.1.0",
     "chalk": "^4.1.2",
     "commander": "^9.4.1",
     "csv": "^6.1.0",
     "dayjs": "^1.11.6",
+    "diff": "^5.1.0",
     "figlet": "^1.5.2",
     "flat": "^5.0.2",
+    "giturl": "^2.0.0",
+    "hosted-git-info": "^6.1.1",
     "inquirer-command-prompt": "^0.1.0",
     "json2csv": "^5.0.7",
     "jsonpath-mapper": "^1.1.0",
     "keytar": "^7.9.0",
     "lodash": "^4.17.21",
-    "migratortron": "^1.0.0-beta.14",
+    "migratortron": "^1.0.0-beta.32",
     "node-fetch": "^2.6.7",
+    "parse-git-config": "^3.0.0",
     "patch-package": "^6.4.7",
-    "xml2js": "^0.4.23"
+    "printable-characters": "^1.0.42",
+    "xml2js": "^0.4.23",
+    "yaml": "^2.3.1"
   },
   "devDependencies": {
     "@types/figlet": "^1.5.4",
     "@types/flat": "^5.0.2",
+    "@types/hosted-git-info": "^3.0.2",
     "@types/inquirer": "^8.2.1",
     "@types/json2csv": "^5.0.3",
     "@types/lodash": "^4.14.182",
     "@types/node-fetch": "^2.6.1",
+    "@types/parse-git-config": "^3.0.1",
     "@types/xml2js": "^0.4.11",
     "esbuild": "^0.14.43",
     "esbuild-node-externals": "^1.4.1",

package/src/commands/connect.ts

@@ -6,6 +6,7 @@ import { project } from './globalOptions';
 export const makeConnectCommand = () => {
   const connect = new Command()
     .command('connect')
+    .description('connect to a Contensis instance')
     .argument('<alias>', 'the Contensis Cloud alias to connect with')
     .addOption(project)
     .usage('<alias>')
@@ -16,8 +17,8 @@ Example call:
   > connect example-dev`
     )
     .action(async (alias, opts) => {
-      await cliCommand(['connect', alias], opts).Connect(alias);
-      await shell().start();
+      await cliCommand(['connect', alias], { ...opts, alias }).Connect(alias);
+      await shell().restart();
     });
   return connect;
 };

package/src/commands/create.ts

@@ -1,26 +1,57 @@
 import { Command } from 'commander';
+import { Project } from 'contensis-core-api';
 import { cliCommand } from '~/services/ContensisCliService';
 import { shell } from '~/shell';
+import { isUuid } from '~/util';
 
 export const makeCreateCommand = () => {
   const create = new Command()
     .command('create')
+    .description('create command')
+    .addHelpText('after', `\n`)
     .showHelpAfterError(true)
     .exitOverride();
 
   create
     .command('project')
+    .description('create a new project')
     .argument('<projectId>', 'the id of the project to create')
-    .usage('<projectId>')
-    .action(async (projectId: string, opts: any) => {
-      const project = await cliCommand(
-        ['create', 'project', projectId],
-        opts
-      ).SetProject(projectId);
-      if (project) await shell().start();
-    });
+    .argument('<name>', 'the name of the project to create')
+    .argument('[description]', 'optional description of the project')
+    .option(
+      '-l --language',
+      'the default language of the project to create',
+      'en-GB'
+    )
+    .option(
+      '-langs --supported-languages <langs...>',
+      'space separated list of other supported languages'
+    )
+    .usage(
+      'projectId "Project name" ["Description of project"] --language en-GB --supported-languages es-ES de-DE nl-NL'
+    )
+    .addHelpText('after', `\n`)
+    .action(
+      async (projectId: string, name: string, description = '', opts: any) => {
+        const createProject: Project = {
+          id: projectId,
+          name,
+          description,
+          primaryLanguage: opts.language,
+          supportedLanguages: opts.supportedLanguages || [],
+        };
+
+        const project = await cliCommand(
+          ['create', 'project', projectId],
+          opts
+        ).CreateProject(createProject);
+        if (project) await shell().restart();
+      }
+    );
+
   create
     .command('key')
+    .description('create a new api key')
     .argument('<"key name">', 'the name of the key to create')
     .argument('["description"]', 'provide a description for the key (optional)')
     .usage('<"key name"> ["description"] (both args in "double quotes")')
@@ -37,5 +68,27 @@ Example call:
       );
     });
 
+  create
+    .command('role')
+    .description('create a new role')
+    .argument('<"Role name">', 'the name of the role to create')
+    .argument('["Role description">', 'the description of the role')
+    .option('--disabled', 'do not enable the created role', false)
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > create role "My role" "This role is for testing" --disabled \n`
+    )
+    .action(async (roleName: string, description: string, opts) => {
+      await cliCommand(['create', 'role', roleName], opts).CreateRole({
+        name: roleName,
+        description,
+        enabled: !opts.disabled,
+        assignments: { apiKeys: [], groups: [], users: [] },
+        permissions: { contentTypes: [], entries: [] },
+      });
+    });
+
   return create;
 };

package/src/commands/dev.ts

@@ -0,0 +1,69 @@
+import { Command } from 'commander';
+import { devCommand } from '~/services/ContensisDevService';
+
+export const makeDevCommand = () => {
+  const dev = new Command()
+    .command('dev')
+    .description('dev command')
+    .addHelpText('after', `\n`)
+    .showHelpAfterError(true)
+    .exitOverride();
+
+  dev
+    .command('init')
+    .description(
+      'initialise a git clone directory to connect and deploy to Contensis'
+    )
+    .argument(
+      '[projectHome]',
+      'the path of the folder to initialise',
+      process.cwd()
+    )
+    .option(
+      '--url <url>',
+      'override the git url or add one to initialise a non-git folder'
+    )
+    .option(
+      '-d --dry-run',
+      'perform a dry run of the project initialisation where no changes are made',
+      true
+    )
+    .option(
+      '--commit',
+      'commit change (will eventually be deprecated in favour of --dry-run)'
+    )
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > dev init\n`
+    )
+    .action(async (projectHome: string, opts) => {
+      // TODO: add opts for overriding project name and git url
+      await devCommand(['dev', 'init', projectHome], opts).DevelopmentInit(
+        projectHome,
+        { ...opts, dryRun: !opts.commit }
+      );
+    });
+
+  dev
+    .command('requests')
+    .description('launch request handler for local development')
+    .argument('[block-ids...]', 'ids of any blocks to develop locally')
+    .option('--args <args...>', 'override or add additional args')
+    .usage('[block-ids...]')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > dev requests test-block-one\n`
+    )
+    .action(async (blockIds: string[] = [], opts) => {
+      await devCommand(
+        ['dev', 'requests', blockIds.join(' ')],
+        opts
+      ).ExecRequestHandler(blockIds, opts?.args);
+    });
+
+  return dev;
+};

package/src/commands/diff.ts

@@ -0,0 +1,41 @@
+import { Command } from 'commander';
+import { cliCommand } from '~/services/ContensisCliService';
+import { mapContensisOpts } from './globalOptions';
+
+export const makeDiffCommand = () => {
+  const release = new Command()
+    .command('diff')
+    .description('diff command')
+    .addHelpText('after', `\n`)
+    .showHelpAfterError(true)
+    .exitOverride();
+
+  release
+    .command('models')
+    .description('differences with content models')
+    .argument(
+      '[model-ids...]',
+      'ids of any content types or components to diff (optional)'
+    )
+    .usage('[model-ids...]')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > diff models blogPost\n`
+    )
+    .action(async (modelIds: string[] = [], opts) => {
+      await cliCommand(
+        ['diff', 'models', modelIds.join(' ')],
+        opts,
+        mapContensisOpts({ modelIds, ...opts })
+      ).DiffModels(
+        {
+          ...opts,
+        },
+        modelIds
+      );
+    });
+
+  return release;
+};

package/src/commands/execute.ts

@@ -0,0 +1,117 @@
+import { Argument, Command } from 'commander';
+import { cliCommand } from '~/services/ContensisCliService';
+import { addGlobalOptions } from './globalOptions';
+
+export const makeExecuteCommand = () => {
+  const execute = new Command()
+    .command('execute')
+    .description('execute block actions')
+    .addHelpText('after', `\n`)
+    .showHelpAfterError(true)
+    .exitOverride();
+
+  const block = execute
+    .command('block')
+    .description('execute block command to invoke block actions');
+
+  const action = block
+    .command('action')
+    .description('execute block action command to invoke block actions');
+
+  const blockIdArg = new Argument(
+    '<block-id>',
+    'the name of the block to perform action with'
+  );
+  const blockVersionArg = new Argument(
+    '<version>',
+    'the block version to perform action with'
+  );
+
+  action
+    .command('release')
+    .description('release a block version')
+    .addArgument(blockIdArg)
+    .argument('[version]', blockVersionArg.description, 'latest')
+    .usage('[block-id> <version]')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > execute block action release contensis-app
+
+Note: block actions are executed on blocks deployed from a "main" or "master" branch\n`
+    )
+    .action(async (blockId: string, version: string, opts) => {
+      await cliCommand(
+        ['execute', 'block', 'action', 'release', blockId],
+        opts
+      ).ExecuteBlockAction('release', blockId, version);
+    });
+
+  action
+    .command('makelive')
+    .description('make a block version live')
+    .addArgument(blockIdArg)
+    .addArgument(blockVersionArg)
+    .usage('<block-id> <version>')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > execute block action makelive contensis-app 3
+
+Note: block actions are executed on blocks deployed from a "main" or "master" branch\n`
+    )
+    .action(async (blockId: string, version: string, opts) => {
+      await cliCommand(
+        ['execute', 'block', 'action', 'makelive', blockId],
+        opts
+      ).ExecuteBlockAction('makeLive', blockId, version);
+    });
+
+  action
+    .command('rollback')
+    .description('rollback a live block version to last live version')
+    .addArgument(blockIdArg)
+    .addArgument(blockVersionArg)
+    .usage('<block-id> <version>')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > execute block action rollback contensis-app 3
+
+Note: block actions are executed on blocks deployed from a "main" or "master" branch\n`
+    )
+    .action(async (blockId: string, version: string, opts) => {
+      await cliCommand(
+        ['execute', 'block', 'action', 'rollback', blockId],
+        opts
+      ).ExecuteBlockAction('rollback', blockId, version);
+    });
+
+  action
+    .command('markasbroken')
+    .description('mark a block version as broken')
+    .addArgument(blockIdArg)
+    .addArgument(blockVersionArg)
+    .usage('<block-id> <version>')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > execute block action markasbroken contensis-app 3
+
+Note: block actions are executed on blocks deployed from a "main" or "master" branch\n`
+    )
+    .action(async (blockId: string, version: string, opts) => {
+      await cliCommand(
+        ['execute', 'block', 'action', 'markasbroken', blockId],
+        opts
+      ).ExecuteBlockAction('markAsBroken', blockId, version);
+    });
+
+  // Add global opts for inner sub-commands
+  addGlobalOptions(action);
+  return execute;
+};