contensis-cli 1.6.1-beta.2 → 1.6.1-beta.20

package/esbuild.config.js

@@ -5,7 +5,6 @@ const { globPlugin } = require('esbuild-plugin-glob');
 const { nodeExternalsPlugin } = require('esbuild-node-externals');
 const { replaceTscAliasPaths } = require('tsc-alias');
 
-// const watch = !!process.argv.includes('--watch');
 const completed = `${chalk.green('[contensis-cli]')} Build successful 👍\n`;
 
 console.time(completed);
@@ -16,9 +15,9 @@ rimraf('./dist').then(() => {
   console.time(' - esbuild complete');
   esbuild
     .build({
-      entryPoints: ['src/**/*.[jt]s'],
+      entryPoints: ['src/index.ts', 'src/shell.ts'],
       outdir: 'dist',
-      bundle: false,
+      bundle: true,
       minify: false,
       platform: 'node',
       format: 'cjs',
@@ -26,16 +25,12 @@ rimraf('./dist').then(() => {
       // 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) {
-      //     if (error) console.error('esbuild watch build failed:', error);
-      //     else
-      //       console.log(
-      //         'esbuild watch build succeeded, waiting for changes...'
-      //       );
-      //   },
-      // },
+      plugins: [globPlugin(), nodeExternalsPlugin({
+        allowList: [/^@inquirer\//],
+        dependencies: true,
+        forceExternalList: ['enterprise-fetch']
+        // forceExternalList: ['keytar', '@action-validator/core', 'figlet', 'node-fetch', 'enterprise-fetch']
+      })],
     })
     .then(() => {
       console.timeEnd(' - esbuild complete');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "contensis-cli",
-  "version": "1.6.1-beta.2",
+  "version": "1.6.1-beta.20",
   "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": {
     "type": "git",
@@ -28,6 +28,7 @@
   "license": "ISC",
   "dependencies": {
     "@action-validator/core": "^0.6.0",
+    "@inquirer/prompts": "^8.2.0",
     "adm-zip": "^0.5.16",
     "app-root-path": "^3.1.0",
     "chalk": "^4.1.2",
@@ -42,7 +43,7 @@
     "inquirer-command-prompt": "^0.1.0",
     "keytar": "^7.9.0",
     "lodash": "^4.17.21",
-    "migratortron": "^1.0.0-beta.84",
+    "migratortron": "^1.0.0-beta.86",
     "nanospinner": "^1.2.0",
     "node-fetch": "^2.6.7",
     "parse-git-config": "^3.0.0",

package/src/commands/create.ts

@@ -71,6 +71,54 @@ Example call:
       );
     });
 
+  create
+    .command('node')
+    .description('create a new site view node')
+    .argument('<"node path or id">', 'the path or id of the node to create')
+    .argument(
+      '["display name"]',
+      'provide a separate display name for the node (optional)'
+    )
+    .argument(
+      '["slug"]',
+      'provide a slug for the node (defaults to slug from provided node path)'
+    )
+    .option(
+      '--include-in-menu',
+      'set include in menu flag on the created node',
+      false
+    )
+    .option(
+      '--language <language>',
+      'language of the node to create (defaults to current project primary language)'
+    )
+    .option('--entry-id <entryId>', 'attach an entry to the node')
+    .usage(
+      '<"node path or id"> ["display name"] (both args in "double quotes")'
+    )
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > create node /test "Test Node" --include-in-menu\n`
+    )
+    .action(
+      async (
+        pathOrId: string,
+        displayName: string,
+        slug: string,
+        opts: any
+      ) => {
+        await cliCommand(['create', 'node', pathOrId], opts).CreateOrUpdateNode(
+          pathOrId,
+          opts,
+          displayName,
+          slug,
+          opts.language
+        );
+      }
+    );
+
   create
     .command('role')
     .description('create a new role')

package/src/commands/dev.ts

@@ -1,4 +1,4 @@
-import { Command } from 'commander';
+import { Command, Option } from 'commander';
 import { devCommand } from '~/services/ContensisDevService';
 
 export const makeDevCommand = () => {
@@ -58,6 +58,16 @@ Example call:
       '--release <release>',
       'launch a specific release version of the request handler'
     )
+    .option(
+      '--override [override...]',
+      'override configurations for other blocks'
+    )
+    .addOption(
+      new Option(
+        '-ll --log-level <logLevel>',
+        'set the request handler logging level'
+      ).choices(['debug', 'information', 'warning', 'error', 'none'])
+    )
     .usage('[block-id] [local-uri]')
     .addHelpText(
       'after',
@@ -70,7 +80,7 @@ Example call:
       await devCommand(
         ['dev', 'requests', blockId.join(' ')],
         opts
-      ).ExecRequestHandler(blockId, opts?.args, opts.release);
+      ).ExecRequestHandler(blockId, opts?.override, opts?.args, opts.release);
     });
 
   return dev;

package/src/commands/globalOptions.ts

@@ -54,11 +54,13 @@ export const mapContensisOpts = (opts: any = {}): MigrateRequest => ({
   noPublish: !opts.publish, // arg is inverted automatically from `--no-publish` to `publish: false`
   outputLogs: opts.logLevel,
   stopLevel:
-    typeof opts.stopLevel === 'number'
+    typeof opts.stopLevel === 'number' // stopLevel is used with `import entries`
       ? Number(opts.stopLevel)
-      : typeof opts.dependents === 'number'
+      : typeof opts.dependents === 'number' // dependents is used with `get entries`
         ? Number(opts.dependents)
-        : undefined,
+        : typeof opts.depth === 'number' // depth is used with `import nodes`
+          ? Number(opts.depth)
+          : undefined,
 });
 
 /* Output options */

package/src/commands/import.ts

@@ -36,10 +36,7 @@ export const makeImportCommand = () => {
       '-nod --no-defaults',
       'ignore any default entries or nodes attached to content types or fields'
     )
-    .option(
-      '-nov --no-validations',
-      'import fields with validations removed'
-    )
+    .option('-nov --no-validations', 'import fields with validations removed')
     .option(
       '-preserve --preserve-guids',
       'import any default entries or nodes using the same id as the source'
@@ -153,7 +150,7 @@ Example call:
       'after',
       `
 Example call:
-  > import entries --source-cms example-dev --source-project-id microsite --zenql "sys.contentTypeId = blog"
+  > import entries --source-alias example-dev --source-project-id microsite --zenql "sys.contentTypeId = blog"
   > import entries --from-file myImportData.json --preserve-guids
 `
     )
@@ -175,6 +172,12 @@ Example call:
     .command('nodes')
     .description('import nodes')
     .argument('[root]', 'import nodes from the specified path e.g. /blog', '/')
+    .addOption(
+      new Option(
+        '-d --depth <depth>',
+        'import nodes with children to a specified depth'
+      ).argParser(parseInt)
+    )
     .option(
       '-preserve --preserve-guids',
       'include this flag when you are importing nodes that you have previously exported and wish to update'
@@ -301,6 +304,44 @@ Example call:
       });
     });
 
+  program
+    .command('webhooks')
+    .description('import webhooks')
+    .argument('[name]', 'import webhooks with this name')
+    .option('-i --id <ids...>', 'limit to the supplied webhook id(s)')
+    .option('--enabled', 'import enabled webhooks only')
+    .option('--disabled', 'import disabled webhooks only')
+    .addOption(commit)
+    .addOption(
+      new Option(
+        '-od --output-detail <outputDetail>',
+        'how much detail to output from the import'
+      )
+        .choices(['errors', 'changes', 'all'])
+        .default('changes')
+    )
+    .addHelpText(
+      'after',
+      `
+    Example call:
+      > import webhooks --source-cms example-dev --source-project-id microsite
+      > import webhooks --from-file myImportData.json
+    `
+    )
+    .action(async (name, opts) => {
+      await cliCommand(
+        ['import', 'webhooks'],
+        opts,
+        mapContensisOpts({ ...opts, id: opts.ids, search: name })
+      ).ImportWebhooks({
+        commit: opts.commit,
+        fromFile: opts.fromFile,
+        logOutput: opts.outputDetail,
+        enabled: opts.enabled,
+        disabled: opts.disabled,
+      });
+    });
+
   return program;
 };
 

package/src/commands/push.ts

@@ -149,6 +149,11 @@ Example call:
       'whether to release the pushed block version',
       false
     )
+    .option(
+      '--make-live',
+      'whether to make the pushed block version live immediately',
+      false
+    )
     .option(
       '-cid --commit-id <commitId>',
       'the id of the source git commit for the supplied image uri'
@@ -196,6 +201,7 @@ Example call:
 
       const blockRequest = mapJson(mapSourceVars, {
         release: { $path: 'release', $default: () => false },
+        makeLive: { $path: 'makeLive', $default: () => false },
         id: ['blockId'],
         image: () => {
           const lastIndexOfColon = imageUri.lastIndexOf(':');
@@ -217,7 +223,8 @@ Example call:
           repositoryUrl: {
             $path: ['repositoryUrl', 'CI_PROJECT_URL', 'GITHUB_REPOSITORY'],
             $formatting: (url: string, { GITHUB_ACTIONS }) => {
-              if (GITHUB_ACTIONS) url = `https://github.com/${url}`;
+              if (GITHUB_ACTIONS && !url.startsWith(`https://`))
+                url = `https://github.com/${url}`;
 
               if (url && !url.endsWith('.git')) return `${url}.git`;
               return url;

package/src/commands/set.ts

@@ -1,4 +1,4 @@
-import { Argument, Command } from 'commander';
+import { Argument, Command, Option } from 'commander';
 import { cliCommand } from '~/services/ContensisCliService';
 import { shell } from '~/shell';
 
@@ -10,6 +10,56 @@ export const makeSetCommand = () => {
     .showHelpAfterError(true)
     .exitOverride();
 
+  const node = set.command('node').description('update a site view node');
+
+  node
+    .command('entry')
+    .description('assign an entry to a node')
+    .argument('<"node path or id">', 'the path or id of the node to update')
+    .argument('<entryId>', 'the new entry id to assign to the node')
+    .usage('<"node path or id"> <entryId>')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > set node entry /path 1502f64e-e9b1-436b-b62f-e273f639ecb6\n`
+    )
+    .action(async (nodePathOrId: string, entryId: string, opts) => {
+      await cliCommand(['set', 'node', 'entry'], opts).CreateOrUpdateNode(
+        nodePathOrId,
+        { entryId }
+      );
+    });
+
+  node
+    .command('renderer')
+    .description('assign a renderer to a node')
+    .argument('<"node path or id">', 'the path or id of the node to update')
+    .argument('<rendererUuid>', 'the renderer uuid to assign to the node')
+    .option(
+      '--is-partial-match-root',
+      'should the renderer be used as the partial match root for the node',
+      false
+    )
+    .usage('<"node path or id"> <rendererUuid>')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > set node renderer /path 1502f64e-e9b1-436b-b62f-e273f639ecb6 --is-partial-match-root\n`
+    )
+    .action(async (nodePathOrId: string, rendererId: string, opts) => {
+      await cliCommand(['set', 'node', 'renderer'], opts).CreateOrUpdateNode(
+        nodePathOrId,
+        {
+          renderer: {
+            id: rendererId,
+            isPartialMatchRoot: opts.isPartialMatchRoot,
+          },
+        }
+      );
+    });
+
   const project = set
     .command('project')
     .description('set current working project')
@@ -178,6 +228,21 @@ Example call:
       '--entry-languages [entry-languages...]',
       'the entry languages to add to the role permissions'
     )
+    .addOption(
+      new Option(
+        '--block-actions [block-actions...]',
+        'the block actions to add to the role permissions'
+      ).choices([
+        'push',
+        'release',
+        'manageLive',
+        'manualStartStop',
+        'markAsBroken',
+        'delete',
+        'view',
+        '*',
+      ])
+    )
     .addHelpText(
       'after',
       `
@@ -194,6 +259,9 @@ Example call:
               actions: opts.entryActions || [],
               languages: opts.entryLanguages || [],
             })),
+            blocks: opts.blockActions
+              ? { actions: opts.blockActions }
+              : undefined,
           },
         }
       );

package/src/factories/RequestHandlerFactory.ts

@@ -6,7 +6,7 @@ import { LogMessages } from '~/localisation/en-GB';
 import GitHubCliModuleProvider from '~/providers/GitHubCliModuleProvider';
 
 import ManifestProvider from '~/providers/ManifestProvider';
-import { appRootDir, checkDir, joinPath } from '~/providers/file-provider';
+import { appRootDir, joinPath, pathExists } from '~/providers/file-provider';
 import { isDebug } from '~/util/debug';
 import { Logger } from '~/util/logger';
 
@@ -117,10 +117,10 @@ export class RequestHandlerFactory {
       await new Promise(resolve => setTimeout(resolve, 2000));
 
       // keep the method running until we can return
-      while (true === true) {
-        if (!isRunning) return;
+      while (isRunning) {
         await new Promise(resolve => setTimeout(resolve, 1000));
       }
+      return;
     };
   }
 
@@ -146,8 +146,8 @@ export class RequestHandlerFactory {
       else
         log.warning(messages.devrequests.install.notFound(moduleInfo.github));
 
-    const downloadSpecificRelease =
-      version && !checkDir('c') && release?.tag_name;
+    // checkDir(this.exePath);
+    const downloadSpecificRelease = version && release?.tag_name;
 
     // Should we download an update?
     if (
@@ -177,9 +177,12 @@ export class RequestHandlerFactory {
           path: downloadPath,
           // Map NodeJS os platform to release asset name
           platforms: [
-            ['win32', 'win-x64'],
-            ['darwin', 'osx-x64'],
-            ['linux', 'linux-x64'],
+            ['win32', 'arm64', 'win-arm64'],
+            ['win32', 'x64', 'win-x64'],
+            ['darwin', 'arm64', 'osx-arm64'],
+            ['darwin', 'x64', 'osx-x64'],
+            ['linux', 'arm64', 'linux-arm64'],
+            ['linux', 'x64', 'linux-x64'],
           ],
         });
       } catch (ex: any) {
@@ -238,6 +241,14 @@ export class RequestHandlerFactory {
 
         // TODO: clean up user folder by deleting old version(s)}
       }
+    } else if (moduleInfo.version) {
+      // Validate the installed version exists
+      if (!pathExists(this.exePath)) {
+        // If not, set the version to force re-download and recreate
+        Logger.warning(messages.devrequests.missingBinary(moduleInfo.version));
+        this.version = moduleInfo.version;
+        await this.Create();
+      }
     }
   }
 }

package/src/localisation/en-GB.ts

@@ -188,6 +188,14 @@ export const LogMessages = {
         depth ? ` to a depth of ${depth}` : ``
       }\n`,
     noChange: (env: string) => `[${env}] No changes to be made`,
+    setPayload: () => `Updating node with details\n`,
+    set: (env: string) => `[${env}] Succesfully updated node\n`,
+    failedSet: (env: string, name?: string) =>
+      `[${env}] Unable to update node ${Logger.highlightText(name)}`,
+    created: (env: string, name: string) =>
+      `[${env}] Created node ${Logger.highlightText(name)}\n`,
+    failedCreate: (env: string, name?: string) =>
+      `[${env}] Unable to create node ${Logger.highlightText(name)}`,
   },
   contenttypes: {
     list: (projectId: string) =>
@@ -521,12 +529,17 @@ export const LogMessages = {
     list: (env: string) => `[${env}] Webhook subscriptions:`,
     noList: (env: string) => `[${env}] Cannot retrieve webhook subscriptions`,
     noneExist: () => `No webhook subscriptions exist`,
+    imported: (env: string, commit: boolean, webhooks: number) =>
+      LogMessages.migrate.imported(env, commit, { webhook: webhooks }),
+    noChange: (env: string) => `[${env}] No changes to be made`,
     created: (env: string, name: string) =>
       `[${env}] Created Webhook subscription ${Logger.highlightText(name)}`,
-    failedCreate: (env: string, name: string) =>
-      `[${env}] Unable to create Webhook subscription ${Logger.highlightText(
-        name
-      )}`,
+    failedCreate: (env: string, name?: string) =>
+      `[${env}] Unable to create ${name ? `webhook ${Logger.highlightText(name)}` : 'webhooks'}`,
+    // failedCreate: (env: string, name: string) =>
+    //   `[${env}] Unable to create Webhook subscription ${Logger.highlightText(
+    //     name
+    //   )}`,
     deleted: (env: string, id: string) =>
       `[${env}] Deleted Webhook subscription ${Logger.highlightText(id)}`,
     failedDelete: (env: string, id: string) =>
@@ -707,11 +720,16 @@ export const LogMessages = {
     launch: () => `Launching request handler for local development`,
     overrideBlock: () => `Which block will you be running?`,
     overrideUri: () => `How to access your development site`,
+    overrideBlocks: () => `Which blocks will you be overriding?`,
+    overrideBranch: (blockId: string) =>
+      `Which branch would you like ${blockId} to target?`,
     spawn: () =>
       `If you see a firewall popup requesting network access, it is safe to approve`,
     exited: (code: number | null) =>
       `Request handler exited with code ${code}\n`,
     errored: (error: Error) =>
       `Could not launch request handler due to error \n${error}`,
+    missingBinary: (version: string) =>
+      `Could not locate request handler module ${version}, attempting to reinstall`,
   },
 };

package/src/mappers/DevRequests-to-RequestHanderCliArgs.ts

@@ -1,4 +1,4 @@
-import { ContensisMigrationService } from 'migratortron';
+import { Block, ContensisMigrationService } from 'migratortron';
 import PQueue from 'p-queue';
 import ContensisCli from '~/services/ContensisCliService';
 
@@ -43,11 +43,14 @@ interface ISiteConfigYaml {
 }
 
 class RequestHandlerArgs {
-  private cli;
   args?: string[];
   siteConfig?: ISiteConfigYaml;
 
-  constructor(cli: ContensisCli) {
+  constructor(
+    public blocks: Block[],
+    public blockBranches: Map<string, string>,
+    private cli: ContensisCli
+  ) {
     this.cli = cli;
   }
 
@@ -59,7 +62,6 @@ class RequestHandlerArgs {
 
   buildSiteConfig = async () => {
     const { currentEnv, currentProject, env, log, messages, urls } = this.cli;
-    const contensis = await this.cli.ConnectContensis();
 
     const siteConfig: ISiteConfigYaml = {
       alias: currentEnv,
@@ -73,28 +75,31 @@ class RequestHandlerArgs {
       renderers: [],
     };
 
-    const getBlocks = async (contensis: ContensisMigrationService) => {
-      const [err, blocksRaw] = await contensis.blocks.GetBlocks();
-      if (err)
-        log.error(messages.blocks.noList(currentEnv, env.currentProject));
-
-      // const blocksRaw = await cli.PrintBlocks();
-
+    const getBlockVersions = async (contensis: ContensisMigrationService) => {
       const blocks: BlockJson[] = [];
       const queue = new PQueue({ concurrency: 4 });
-      for (const block of blocksRaw || []) {
+      for (const block of this.blocks || []) {
         queue.add(async () => {
           // Retrieve block version
+          const branch =
+            // If we've set an override branch
+            this.blockBranches.get(block.id) ||
+            // If the block has no master/main branch, use the first branch
+            !block.branches.find(br => ['master', 'main'].includes(br.id))
+              ? block.branches[0]?.id
+              : // Else use default for Contensis to fetch master or main
+                'default';
+
           const [err, versions] = await contensis.blocks.GetBlockVersions(
             block.id,
-            'default',
+            branch,
             'latest'
           );
           if (err || versions?.length === 0)
             log.warning(
               messages.blocks.noGet(
                 block.id,
-                'default',
+                branch,
                 'latest',
                 currentEnv,
                 env.currentProject
@@ -118,10 +123,10 @@ class RequestHandlerArgs {
       return blocks;
     };
 
-    if (contensis) {
+    if (this.cli.contensis) {
       const [blocks, renderers] = await Promise.all([
-        getBlocks(contensis),
-        contensis.renderers.GetRenderers(),
+        getBlockVersions(this.cli.contensis),
+        this.cli.contensis.renderers.GetRenderers(),
       ]);
 
       siteConfig.blocks = blocks;
@@ -174,6 +179,9 @@ class RequestHandlerArgs {
         args.push('--password', client.password);
     }
 
+    if (cli.logLevel && !args.find(a => a === '--log-level'))
+      args.push('--log-level', cli.logLevel);
+
     return args;
   };
 

package/src/models/CliService.d.ts

@@ -1,3 +1,5 @@
+import ContensisCli from '~/services/ContensisCliService';
+
 export type CliUrls =
   | {
       api: string;
@@ -33,7 +35,9 @@ export interface IImportOptions {
   sourceProjectId?: string;
 }
 
-export type OutputOptionsConstructorArg = OutputOptions &
+export type OutputOptionsConstructorArg = {
+  logLevel?: ContensisCli['logLevel'];
+} & OutputOptions &
   IConnectOptions &
   IImportOptions;
 

package/src/providers/GitHubCliModuleProvider.ts

@@ -10,6 +10,7 @@ import {
   removeFile,
 } from './file-provider';
 import { doRetry } from '~/util/fetch';
+import { isWindows } from '~/util/os';
 
 type GitHubApiRelease =
   Endpoints['GET /repos/{owner}/{repo}/releases/latest']['response']['data'];
@@ -85,17 +86,16 @@ class GitHubCliModuleProvider {
       cmd: string;
       path: string;
       unzip?: boolean;
-      platforms: [NodeJS.Platform, string][];
+      platforms: [NodeJS.Platform, NodeJS.Architecture, string][];
     }
   ) {
     // find os-specific asset
-    const platform = platforms.find(p => p[0] === os.platform()) || [
-      os.platform(),
-      os.platform(),
-    ];
+    const platform = platforms.find(
+      p => p[0] === os.platform() && p[1] === os.arch()
+    ) || [os.platform(), os.arch(), `${os.platform()}-${os.arch()}`];
 
     const asset = release.assets.find(r =>
-      r.name.toLowerCase().includes(platform[1])
+      r.name.toLowerCase().includes(platform[2])
     );
 
     // download asset
@@ -114,12 +114,12 @@ class GitHubCliModuleProvider {
         removeFile(filePath);
       }
 
-      if (os.platform() !== 'win32') addExecutePermission(joinPath(path, cmd));
+      if (!isWindows()) addExecutePermission(joinPath(path, cmd));
     } else
       throw new Error(
         `no asset found in release ${
           release.tag_name
-        } for platform ${os.platform()}\n${release.html_url}`
+        } for platform ${os.platform()} and architecture ${os.arch()}\n${release.html_url}`
       );
   }
 }

package/src/providers/HttpProvider.ts

@@ -2,7 +2,7 @@ import to from 'await-to-js';
 import { FetchInit } from 'enterprise-fetch';
 import fs from 'fs';
 import { Readable } from 'stream';
-import { finished } from 'stream/promises';
+import { pipeline } from 'stream/promises';
 
 import { isJson, tryParse } from '~/util/assert';
 import { enhancedFetch } from '~/util/fetch';
@@ -42,7 +42,7 @@ class HttpProvider {
     const res = await fetch(url);
     if (res.ok && res.body !== null) {
       const fileStream = fs.createWriteStream(destination, { flags: 'wx' });
-      await finished(Readable.fromWeb(res.body as any).pipe(fileStream));
+      await pipeline(Readable.from(res.body), fileStream);
     }
   }
 }