contensis-cli 1.0.0-beta.66 → 1.0.0-beta.67

package/dist/version.js.map

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "contensis-cli",
-  "version": "1.0.0-beta.66",
+  "version": "1.0.0-beta.67",
   "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",

package/src/commands/execute.ts

@@ -0,0 +1,106 @@
+import { Argument, Command } from 'commander';
+import { cliCommand } from '~/services/ContensisCliService';
+
+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)
+    .addArgument(blockVersionArg)
+    .usage('<block-id> <version>')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > execute block action release contensis-app 3\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\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\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\n`
+    )
+    .action(async (blockId: string, version: string, opts) => {
+      await cliCommand(
+        ['execute', 'block', 'action', 'markasbroken', blockId],
+        opts
+      ).ExecuteBlockAction('markAsBroken', blockId, version);
+    });
+
+  return execute;
+};

package/src/commands/get.ts

@@ -5,6 +5,7 @@ import { mapContensisOpts } from './globalOptions';
 export const makeGetCommand = () => {
   const program = new Command()
     .command('get')
+    .description('get command')
     .addHelpText('after', `\n`)
     .showHelpAfterError(true)
     .exitOverride();

package/src/commands/index.ts

@@ -4,6 +4,7 @@ import { LIB_VERSION } from '~/version';
 import { makeConnectCommand } from './connect';
 import { makeCreateCommand } from './create';
 import { makeDiffCommand } from './diff';
+import { makeExecuteCommand } from './execute';
 import { makeGetCommand } from './get';
 import {
   addAuthenticationOptions,
@@ -16,7 +17,6 @@ import { makeImportCommand } from './import';
 import { makeListCommand } from './list';
 import { makeLoginCommand } from './login';
 import { makePushCommand } from './push';
-import { makeReleaseCommand } from './release';
 import { makeRemoveCommand } from './remove';
 import { makeSetCommand } from './set';
 
@@ -31,6 +31,13 @@ const commands = () => {
           : str.trim() && Logger.help(str);
       },
     })
+    .addHelpText(
+      'after',
+      Logger.helpText`
+>> Each command has its own help - for example:
+  > login --help\n  > get --help
+`
+    )
     .exitOverride()
     .showHelpAfterError(true);
 
@@ -42,6 +49,9 @@ const commands = () => {
   program.addCommand(
     addGlobalOptions(makeCreateCommand()).copyInheritedSettings(program)
   );
+  program.addCommand(
+    addGlobalOptions(makeExecuteCommand()).copyInheritedSettings(program)
+  );
   program.addCommand(
     addGlobalOptions(
       addGetEntryOptions(addImportOptions(makeDiffCommand()))
@@ -64,9 +74,6 @@ const commands = () => {
   program.addCommand(
     addGlobalOptions(makePushCommand()).copyInheritedSettings(program)
   );
-  program.addCommand(
-    addGlobalOptions(makeReleaseCommand()).copyInheritedSettings(program)
-  );
   program.addCommand(
     addGlobalOptions(makeRemoveCommand()).copyInheritedSettings(program)
   );

package/src/localisation/en-GB.ts

@@ -1,4 +1,5 @@
 import {
+  BlockActionType,
   BlockRunningStatus,
   MigrateModelsResult,
   MigrateStatus,
@@ -279,14 +280,26 @@ export const LogMessages = {
       `[${env}] Unable to push block ${Logger.highlightText(
         id
       )} in project ${projectId}`,
-    released: (id: string, env: string, projectId?: string) =>
-      `[${env}] Released block ${Logger.highlightText(
+    actionComplete: (
+      action: BlockActionType,
+      id: string,
+      env: string,
+      projectId?: string
+    ) =>
+      `[${env}] Block action ${Logger.highlightText(
+        action
+      )} on ${Logger.highlightText(
         id
-      )} in project ${projectId}`,
-    failedRelease: (id: string, env: string, projectId?: string) =>
-      `[${env}] Unable to release block ${Logger.highlightText(
-        id
-      )} in project ${projectId}`,
+      )} in project ${projectId} requested successfully`,
+    actionFailed: (
+      action: BlockActionType,
+      id: string,
+      env: string,
+      projectId?: string
+    ) =>
+      `[${env}] Problem executing action ${Logger.highlightText(
+        action
+      )} on block ${Logger.highlightText(id)} in project ${projectId}`,
     deleted: (id: string, env: string, projectId?: string) =>
       `[${env}] Deleted block ${Logger.highlightText(
         id

package/src/services/ContensisCliService.ts

@@ -20,6 +20,7 @@ import {
   ContentTypesResult,
   Model,
   MigrateModelsResult,
+  BlockActionType,
 } from 'migratortron';
 import { Entry, Role } from 'contensis-management-api/lib/models';
 
@@ -1901,14 +1902,18 @@ class ContensisCli {
     }
   };
 
-  ReleaseBlock = async (blockId: string, version: string) => {
+  ExecuteBlockAction = async (
+    action: BlockActionType,
+    blockId: string,
+    version: string
+  ) => {
     const { currentEnv, env, log, messages } = this;
     const contensis = await this.ConnectContensis();
     if (contensis) {
-      // Retrieve block version
+      // Execute block action
       const [err, blockVersion] = await contensis.blocks.BlockAction(
         blockId,
-        'release',
+        action,
         version
       );
 
@@ -1916,7 +1921,12 @@ class ContensisCli {
         this.HandleFormattingAndOutput(blockVersion, () => {
           // print the version detail to console
           log.success(
-            messages.blocks.released(blockId, currentEnv, env.currentProject)
+            messages.blocks.actionComplete(
+              action,
+              blockId,
+              currentEnv,
+              env.currentProject
+            )
           );
           printBlockVersion(this, blockVersion);
         });
@@ -1924,7 +1934,12 @@ class ContensisCli {
 
       if (err) {
         log.error(
-          messages.blocks.failedRelease(blockId, currentEnv, env.currentProject)
+          messages.blocks.actionFailed(
+            action,
+            blockId,
+            currentEnv,
+            env.currentProject
+          )
         );
         log.error(jsonFormatter(err));
       }

package/src/shell.ts

@@ -139,6 +139,10 @@ class ContensisShell {
         'create project',
         'create role',
         'diff models',
+        'execute block action release',
+        'execute block action makelive',
+        'execute block action rollback',
+        'execute block action markasbroken',
         'get block',
         'get block logs',
         'get contenttype',
@@ -161,7 +165,6 @@ class ContensisShell {
         'list roles',
         'list webhooks',
         'push block',
-        'release block',
         'remove components',
         'remove contenttypes',
         'remove key',
@@ -182,7 +185,7 @@ class ContensisShell {
       {
         type: 'command',
         name: 'cmd',
-        autoCompletion: availableCommands,
+        autoCompletion: availableCommands.sort(),
         autocompletePrompt: log.infoText(messages.app.autocomplete()),
         message: `${userId ? `${userId}@` : ''}${currentEnvironment || ''}>`,
         context: 0,

package/src/version.ts

@@ -1 +1 @@
-export const LIB_VERSION = "1.0.0-beta.66";
+export const LIB_VERSION = "1.0.0-beta.67";

package/dist/commands/release.js

@@ -1,47 +0,0 @@
-"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 release_exports = {};
-__export(release_exports, {
-  makeReleaseCommand: () => makeReleaseCommand
-});
-module.exports = __toCommonJS(release_exports);
-var import_commander = require("commander");
-var import_ContensisCliService = require("../services/ContensisCliService");
-const makeReleaseCommand = () => {
-  const release = new import_commander.Command().command("release").description("release command").addHelpText("after", `
-`).showHelpAfterError(true).exitOverride();
-  release.command("block").description("release a block version").argument("<block-id>", "the name of the block to release").argument("<version>", "the block version to release").usage("<block-id> <version>").addHelpText(
-    "after",
-    `
-Example call:
-  > release block contensis-app 3
-`
-  ).action(async (blockId, version, opts) => {
-    await (0, import_ContensisCliService.cliCommand)(["release", "block", blockId], opts).ReleaseBlock(
-      blockId,
-      version
-    );
-  });
-  return release;
-};
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  makeReleaseCommand
-});
-//# sourceMappingURL=release.js.map

package/dist/commands/release.js.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../src/commands/release.ts"],
-  "sourcesContent": ["import { Command } from 'commander';\nimport { cliCommand } from '~/services/ContensisCliService';\n\nexport const makeReleaseCommand = () => {\n  const release = new Command()\n    .command('release')\n    .description('release command')\n    .addHelpText('after', `\\n`)\n    .showHelpAfterError(true)\n    .exitOverride();\n\n  release\n    .command('block')\n    .description('release a block version')\n    .argument('<block-id>', 'the name of the block to release')\n    .argument('<version>', 'the block version to release')\n    .usage('<block-id> <version>')\n    .addHelpText(\n      'after',\n      `\nExample call:\n  > release block contensis-app 3\\n`\n    )\n    .action(async (blockId: string, version: string, opts) => {\n      await cliCommand(['release', 'block', blockId], opts).ReleaseBlock(\n        blockId,\n        version\n      );\n    });\n\n  return release;\n};\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,uBAAwB;AACxB,iCAA2B;AAEpB,MAAM,qBAAqB,MAAM;AACtC,QAAM,UAAU,IAAI,yBAAQ,EACzB,QAAQ,SAAS,EACjB,YAAY,iBAAiB,EAC7B,YAAY,SAAS;AAAA,CAAI,EACzB,mBAAmB,IAAI,EACvB,aAAa;AAEhB,UACG,QAAQ,OAAO,EACf,YAAY,yBAAyB,EACrC,SAAS,cAAc,kCAAkC,EACzD,SAAS,aAAa,8BAA8B,EACpD,MAAM,sBAAsB,EAC5B;AAAA,IACC;AAAA,IACA;AAAA;AAAA;AAAA;AAAA,EAGF,EACC,OAAO,OAAO,SAAiB,SAAiB,SAAS;AACxD,cAAM,uCAAW,CAAC,WAAW,SAAS,OAAO,GAAG,IAAI,EAAE;AAAA,MACpD;AAAA,MACA;AAAA,IACF;AAAA,EACF,CAAC;AAEH,SAAO;AACT;",
-  "names": []
-}

package/src/commands/release.ts

@@ -1,32 +0,0 @@
-import { Command } from 'commander';
-import { cliCommand } from '~/services/ContensisCliService';
-
-export const makeReleaseCommand = () => {
-  const release = new Command()
-    .command('release')
-    .description('release command')
-    .addHelpText('after', `\n`)
-    .showHelpAfterError(true)
-    .exitOverride();
-
-  release
-    .command('block')
-    .description('release a block version')
-    .argument('<block-id>', 'the name of the block to release')
-    .argument('<version>', 'the block version to release')
-    .usage('<block-id> <version>')
-    .addHelpText(
-      'after',
-      `
-Example call:
-  > release block contensis-app 3\n`
-    )
-    .action(async (blockId: string, version: string, opts) => {
-      await cliCommand(['release', 'block', blockId], opts).ReleaseBlock(
-        blockId,
-        version
-      );
-    });
-
-  return release;
-};