contensis-cli 1.1.2-beta.1 → 1.1.2-beta.11

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

@@ -1,4 +1,5 @@
 import { ContensisMigrationService } from 'migratortron';
+import PQueue from 'p-queue';
 import ContensisCli from '~/services/ContensisCliService';
 
 type EndpointJson = {
@@ -32,114 +33,168 @@ type RendererRuleJson = {
 interface ISiteConfigYaml {
   alias: string;
   projectId: string;
-  accessToken: string;
+  iisHostname: string;
+  podClusterId: string;
+  accessToken: string; // needed?
   clientId: string;
   sharedSecret: string;
   blocks: BlockJson[];
   renderers: RendererJson[];
 }
 
-export const buildSiteConfig = async (cli: ContensisCli) => {
-  const { currentEnv, env, log, messages } = cli;
-  const siteConfig: ISiteConfigYaml = {
-    alias: cli.currentEnv,
-    projectId: cli.currentProject,
-    accessToken: '',
-    clientId: '',
-    sharedSecret: '',
-    blocks: [],
-    renderers: [],
+class RequestHandlerArgs {
+  private cli;
+  args?: string[];
+  siteConfig?: ISiteConfigYaml;
+
+  constructor(cli: ContensisCli) {
+    this.cli = cli;
+  }
+
+  Create = async () => {
+    this.siteConfig = await this.buildSiteConfig();
+    await this.cli.Login(this.cli.env.lastUserId, { silent: true }); // to hydrate the auth service
+    this.args = this.getArgs();
   };
 
-  const getBlocks = async (contensis: ContensisMigrationService) => {
-    const [err, blocksRaw] = await contensis.blocks.GetBlocks();
-    if (err) log.error(messages.blocks.noList(currentEnv, env.currentProject));
+  buildSiteConfig = async () => {
+    const { currentEnv, currentProject, env, log, messages, urls } = this.cli;
+    const contensis = await this.cli.ConnectContensis();
 
-    // const blocksRaw = await cli.PrintBlocks();
+    const siteConfig: ISiteConfigYaml = {
+      alias: currentEnv,
+      projectId: currentProject,
+      iisHostname: urls?.iisPreviewWeb.split('//')[1] || '',
+      podClusterId: 'hq',
+      accessToken: '',
+      clientId: '',
+      sharedSecret: '',
+      blocks: [],
+      renderers: [],
+    };
 
-    const blocks: BlockJson[] = [];
-    for (const block of blocksRaw || []) {
-      // Retrieve block version
-      const [err, versions] = await contensis.blocks.GetBlockVersions(
-        block.id,
-        'default',
-        'latest'
-      );
-      if (err || versions?.length === 0)
-        log.warning(
-          messages.blocks.noGet(
+    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 blocks: BlockJson[] = [];
+      const queue = new PQueue({ concurrency: 4 });
+      for (const block of blocksRaw || []) {
+        queue.add(async () => {
+          // Retrieve block version
+          const [err, versions] = await contensis.blocks.GetBlockVersions(
             block.id,
             'default',
-            'latest',
-            currentEnv,
-            env.currentProject
-          )
-        );
-      if (versions?.[0]) {
-        const v = versions[0];
-        blocks.push({
-          id: v.id,
-          baseUri: v.previewUrl,
-          staticPaths: v.staticPaths,
-          endpoints: v.endpoints,
-          versionNo: v.version.versionNo,
-          branch: v.source.branch,
+            'latest'
+          );
+          if (err || versions?.length === 0)
+            log.warning(
+              messages.blocks.noGet(
+                block.id,
+                'default',
+                'latest',
+                currentEnv,
+                env.currentProject
+              )
+            );
+          if (versions?.[0]) {
+            const v = versions[0];
+            blocks.push({
+              id: v.id,
+              baseUri: v.previewUrl,
+              staticPaths: v.staticPaths,
+              endpoints: v.endpoints,
+              versionNo: v.version.versionNo,
+              branch: v.source.branch,
+            });
+          }
         });
       }
+
+      await queue.onIdle();
+      return blocks;
+    };
+
+    if (contensis) {
+      const [blocks, renderers] = await Promise.all([
+        getBlocks(contensis),
+        contensis.renderers.GetRenderers(),
+      ]);
+
+      siteConfig.blocks = blocks;
+      siteConfig.renderers = renderers?.[1]
+        ?.filter(r => blocks.find(b => b.id === r.id))
+        .map(r => ({
+          id: r.id,
+          name: r.name,
+          assignedContentTypes: r.assignedContentTypes,
+          rules: r.rules,
+        }));
     }
-    return blocks;
+    return siteConfig;
   };
 
-  const contensis = await cli.ConnectContensis();
-  if (contensis) {
-    const [blocks, renderers] = await Promise.all([
-      getBlocks(contensis),
-      contensis.renderers.GetRenderers(),
-    ]);
-
-    siteConfig.blocks = blocks;
-    siteConfig.renderers = renderers?.[1]?.map(r => ({
-      id: r.id,
-      name: r.name,
-      assignedContentTypes: r.assignedContentTypes,
-      rules: r.rules,
-    }));
-  }
-  return siteConfig;
-};
+  getArgs = (overrideArgs: string[] = []) => {
+    const args = overrideArgs
+      ? typeof overrideArgs?.[0] === 'string' &&
+        overrideArgs[0].includes(' ', 2)
+        ? overrideArgs[0].split(' ')
+        : overrideArgs
+      : []; // args could be [ '-c .\\site_config.yaml' ] or [ '-c', '.\\site_config.yaml' ]
 
-export const requestHandlerCliArgs = async (
-  cli: ContensisCli,
-  overrideArgs: string[] = []
-) => {
-  const args = overrideArgs
-    ? typeof overrideArgs?.[0] === 'string' && overrideArgs[0].includes(' ', 2)
-      ? overrideArgs[0].split(' ')
-      : overrideArgs
-    : []; // args could be [ '-c .\\site_config.yaml' ] or [ '-c', '.\\site_config.yaml' ]
-
-  const siteConfig = await buildSiteConfig(cli);
-  // Add required args
-  if (!args.find(a => a === '--alias')) args.push('--alias', cli.currentEnv);
-  if (!args.find(a => a === '--project-api-id'))
-    args.push('--project-api-id', cli.currentProject);
-  if (!args.find(a => a === '--blocks-json'))
-    args.push('--blocks-json', JSON.stringify(siteConfig.blocks));
-  if (!args.find(a => a === '--renderers-json'))
-    args.push('--renderers-json', JSON.stringify(siteConfig.renderers));
-
-  await cli.Login(cli.env.lastUserId, { silent: true }); // to hydrate the auth service
-  const client = cli.auth?.clientDetails;
-  if (client) {
-    if (!args.find(a => a === '--client-id') && 'clientId' in client)
-      args.push('--client-id', client.clientId);
-    if (!args.find(a => a === '--client-secret') && 'clientSecret' in client)
-      args.push('--client-secret', client.clientSecret);
-    if (!args.find(a => a === '--username') && 'username' in client)
-      args.push('--username', client.username);
-    if (!args.find(a => a === '--password') && 'password' in client)
-      args.push('--password', client.password);
-  }
+    const { cli, siteConfig } = this;
+    if (siteConfig) {
+      // Add required args
+      if (!args.find(a => a === '--alias'))
+        args.push('--alias', cli.currentEnv);
+      if (!args.find(a => a === '--project-api-id'))
+        args.push('--project-api-id', cli.currentProject);
+      if (!args.find(a => a === '--iis-hostname'))
+        args.push('--iis-hostname', siteConfig.iisHostname);
+      if (!args.find(a => a === '--pod-cluster-id'))
+        args.push('--pod-cluster-id', siteConfig.podClusterId);
+      if (!args.find(a => a === '--blocks-json'))
+        args.push('--blocks-json', JSON.stringify(siteConfig.blocks));
+      if (!args.find(a => a === '--renderers-json'))
+        args.push('--renderers-json', JSON.stringify(siteConfig.renderers));
+    }
 
-  return args;
-};
+    const client = cli.auth?.clientDetails;
+    if (client) {
+      if (!args.find(a => a === '--client-id') && 'clientId' in client)
+        args.push('--client-id', client.clientId);
+      if (!args.find(a => a === '--client-secret') && 'clientSecret' in client)
+        args.push('--client-secret', client.clientSecret);
+      if (!args.find(a => a === '--username') && 'username' in client)
+        args.push('--username', client.username);
+      if (!args.find(a => a === '--password') && 'password' in client)
+        args.push('--password', client.password);
+    }
+
+    return args;
+  };
+
+  overrideBlock = (blockId: string, overrideUri: string) => {
+    if (blockId && blockId !== 'none') {
+      const blockIndex = this.siteConfig?.blocks.findIndex(
+        b => b.id.toLowerCase() === blockId.toLowerCase()
+      );
+      if (
+        typeof blockIndex === 'number' &&
+        !isNaN(blockIndex) &&
+        this.siteConfig?.blocks[blockIndex]
+      ) {
+        this.siteConfig.blocks[blockIndex].baseUri = overrideUri;
+        // this.siteConfig.blocks[blockIndex].staticPaths.push(
+        //   ...['/static/*', '/image-library/*']
+        // );
+        this.siteConfig.blocks[blockIndex].staticPaths.push('/*.js');
+      }
+    }
+  };
+}
+
+export default RequestHandlerArgs;

package/src/providers/GitHubCliModuleProvider.ts

@@ -3,6 +3,7 @@ import Zip from 'adm-zip';
 import type { Endpoints } from '@octokit/types';
 import HttpProvider from '~/providers/HttpProvider';
 import {
+  addExecutePermission,
   checkDir,
   joinPath,
   removeDirectory,
@@ -37,7 +38,7 @@ class GitHubCliModuleProvider {
     this.repo = repo;
   }
 
-  async FindLatestRelease() {
+  async FindLatestRelease(version?: string) {
     const { http, latest_release_url, releases_url } = this;
     // return latest tag version is:
 
@@ -55,14 +56,18 @@ class GitHubCliModuleProvider {
       throw new Error(`Unable to get releases`, { cause: releasesErr });
     } else if (!releases || releases.length === 0)
       throw new Error(`No releases available`);
-    else if (latestErr && !latest) {
+    else if (version) {
+      const release = releases.find(
+        r => r.tag_name.toLowerCase() === version.toLowerCase()
+      );
+      if (release) return release;
+      else throw new Error(`No release for ${version} found`);
+    } else if (latestErr && !latest) {
       if (latestResponse?.status === 404 && releases?.length) {
         // No latest release, check releases for prerelease version, fallback to last release
         const release = releases.find(r => r.prerelease) || releases[0];
 
-        if (release) {
-          return release;
-        }
+        if (release) return release;
       }
     } else {
       return latest;
@@ -72,10 +77,16 @@ class GitHubCliModuleProvider {
   async DownloadRelease(
     release: GitHubApiRelease,
     {
+      cmd,
       path,
       platforms,
       unzip = true,
-    }: { path: string; unzip?: boolean; platforms: [NodeJS.Platform, string][] }
+    }: {
+      cmd: string;
+      path: string;
+      unzip?: boolean;
+      platforms: [NodeJS.Platform, string][];
+    }
   ) {
     // find os-specific asset
     const platform = platforms.find(p => p[0] === os.platform()) || [
@@ -102,6 +113,8 @@ class GitHubCliModuleProvider {
         // delete the downloaded zip file
         removeFile(filePath);
       }
+
+      if (os.platform() !== 'win32') addExecutePermission(joinPath(path, cmd));
     } else
       throw new Error(
         `no asset found in release ${

package/src/providers/file-provider.ts

@@ -93,6 +93,10 @@ export const cwdPath = (filePath: string) =>
 
 export const joinPath = path.join;
 
+export const addExecutePermission = (filePath: string) =>
+  // Fails in windows with `TypeError [ERR_INVALID_ARG_TYPE]: The "mode" argument must be of type number. Received undefined`
+  fs.chmodSync(filePath, fs.constants.S_IRWXU);
+
 type DetectedFileType =
   | { type: 'json'; contents: any }
   | { type: 'xml' | 'csv'; contents: string };

package/src/services/ContensisCliService.ts

@@ -36,6 +36,7 @@ import {
   tryStringify,
   url,
 } from '~/util';
+import { sanitiseIds } from '~/util/api-ids';
 import {
   printBlockVersion,
   printEntriesMigrateResult,
@@ -142,6 +143,14 @@ class ContensisCli {
     this.session = new SessionCacheProvider();
 
     this.contensisOpts = contensisOpts;
+
+    // Explicitly sanitise supplied fields to api-friendly ids
+    if (Array.isArray(this.contensisOpts.query?.fields)) {
+      this.contensisOpts.query.fields = sanitiseIds(
+        this.contensisOpts.query.fields
+      );
+    }
+
     this.format = outputOpts?.format;
     this.output =
       outputOpts?.output && path.join(process.cwd(), outputOpts.output);
@@ -1788,6 +1797,79 @@ class ContensisCli {
     }
   };
 
+  CopyEntryField = async ({
+    commit,
+    fromFile,
+    logOutput,
+  }: {
+    commit: boolean;
+    fromFile: string;
+    logOutput: string;
+  }) => {
+    const { currentEnv, currentProject, log, messages } = this;
+
+    const contensis = await this.ConnectContensisImport({
+      commit,
+      fromFile,
+      importDataType: 'entries',
+    });
+
+    if (contensis) {
+      log.line();
+      if (contensis.isPreview) {
+        console.log(log.successText(` -- IMPORT PREVIEW -- `));
+      } else {
+        console.log(log.warningText(` *** COMMITTING IMPORT *** `));
+      }
+
+      const [err, result] = await to(
+        contensis.content.copy.MigrateFieldContent()
+      );
+
+      if (err) logError(err);
+      if (result)
+        await this.HandleFormattingAndOutput(result, () => {
+          // print the migrateResult to console
+          printEntriesMigrateResult(this, result, {
+            showAll: logOutput === 'all',
+            showDiff: logOutput === 'all' || logOutput === 'changes',
+            showChanged: logOutput === 'changes',
+          });
+        });
+
+      if (
+        result &&
+        !err &&
+        !result.errors?.length &&
+        ((!commit && result.entriesToMigrate[currentProject].totalCount) ||
+          (commit &&
+            (result.migrateResult?.created || result.migrateResult?.updated)))
+      ) {
+        log.success(
+          messages.entries.imported(
+            currentEnv,
+            commit,
+            commit
+              ? (result.migrateResult?.created || 0) +
+                  (result.migrateResult?.updated || 0)
+              : result.entriesToMigrate[currentProject].totalCount
+          )
+        );
+        if (!commit) {
+          log.raw(``);
+          log.help(messages.entries.commitTip());
+        }
+      } else {
+        log.error(messages.entries.failedImport(currentEnv), err);
+        if (!result?.entriesToMigrate?.[currentProject]?.totalCount)
+          log.help(messages.entries.notFound(currentEnv));
+      }
+    } else {
+      log.warning(messages.models.noList(currentProject));
+      log.help(messages.connect.tip());
+    }
+  };
+
   GetNodes = async (rootPath: string, depth = 0) => {
     const { currentProject, log, messages } = this;
     const contensis = await this.ConnectContensis();

package/src/services/ContensisDevService.ts

@@ -11,7 +11,7 @@ import { createRequestHandler } from '~/factories/RequestHandlerFactory';
 import { OutputOptionsConstructorArg } from '~/models/CliService';
 import { EnvContentsToAdd } from '~/models/DevService';
 import { mapCIWorkflowContent } from '~/mappers/DevInit-to-CIWorkflow';
-import { requestHandlerCliArgs } from '~/mappers/DevRequests-to-RequestHanderCliArgs';
+import RequestHandlerArgs from '~/mappers/DevRequests-to-RequestHanderCliArgs';
 import { deployKeyRole } from '~/mappers/DevInit-to-RolePermissions';
 import { readFile, writeFile } from '~/providers/file-provider';
 import { diffFileContent } from '~/util/diff';
@@ -412,8 +412,9 @@ class ContensisDev extends ContensisRole {
   };
 
   ExecRequestHandler = async (
-    blockIds: string[],
-    overrideArgs: string[] = []
+    blockId: string[],
+    overrideArgs: string[] = [],
+    version?: string
   ) => {
     const { debug, log, messages } = this;
 
@@ -422,15 +423,45 @@ class ContensisDev extends ContensisRole {
       : log.info(messages.devrequests.launch());
 
     // Ensure request handler is available to use
-    const requestHandler = await createRequestHandler();
+    const requestHandler = await createRequestHandler(version);
 
     // Generate args for request handler using CLI methods
+    const args = new RequestHandlerArgs(this);
     spinner?.start();
-    const args = await requestHandlerCliArgs(this, overrideArgs);
+    await args.Create();
     spinner?.success();
 
+    // Prompt block id and dev uri to run locally (if not supplied)
+    const blockIdChoices = args.siteConfig?.blocks.map(block => block.id) || [];
+    blockIdChoices.push('none');
+    const defaultDeveloperUri = 'http://localhost:3000';
+
+    const { overrideBlockId, overrideUri } = blockId.length
+      ? {
+          overrideBlockId: blockId[0],
+          overrideUri: blockId?.[1] || defaultDeveloperUri,
+        }
+      : await inquirer.prompt([
+          {
+            type: 'list',
+            prefix: '🧱',
+            message: messages.devrequests.overrideBlock(),
+            name: 'overrideBlockId',
+            choices: blockIdChoices,
+          },
+          {
+            type: 'input',
+            prefix: '🔗',
+            message: messages.devrequests.overrideUri(),
+            name: 'overrideUri',
+            default: defaultDeveloperUri,
+          },
+        ]);
+
+    args.overrideBlock(overrideBlockId, overrideUri);
+
     // Launch request handler
-    await requestHandler(args);
+    await requestHandler(args.getArgs(overrideArgs));
   };
 }
 export const devCommand = (

package/src/shell.ts

@@ -135,6 +135,7 @@ class ContensisShell {
       availableCommands.push('login', 'list projects', 'set project');
     if (userId)
       availableCommands.push(
+        'copy field',
         'create key',
         'create project',
         'create role',
@@ -306,4 +307,4 @@ process.stdin.on('data', key => {
   }
 });
 
-// // process.env.http_proxy = 'http://127.0.0.1:8888';
+// process.env.http_proxy = 'http://127.0.0.1:8888';

package/src/util/api-ids.ts

@@ -0,0 +1,111 @@
+export const sanitiseId = (id: string) =>
+  id
+    .split('.')
+    .map(part => toApiId(part, 'camelCase', true))
+    .join('.');
+
+export const sanitiseIds = (arr: string[]) => arr.map(sanitiseId);
+
+// borrowed from packages\contensis\components\app\src\utils.ts
+
+export function isApiId(id: string, mode: 'camelCase' | 'snake-case'): boolean {
+  if (!id) {
+    return false;
+  }
+  const validChars = mode === 'camelCase' ? /[^a-zA-Z0-9]/g : /[^a-z0-9-]/g;
+  if (id !== id.replace(validChars, '')) {
+    return false;
+  }
+  if (!id.substr(0, 1).replace(/[^a-z]/g, '')) {
+    return false;
+  }
+  return true;
+}
+
+export function toApiId(
+  name: string,
+  mode: 'camelCase' | 'snake-case',
+  isId: boolean
+) {
+  if (!name) {
+    return name;
+  }
+  const validChars =
+    mode === 'camelCase' ? /[^a-zA-Z0-9 ]/g : /[^a-zA-Z0-9 -]/g;
+  let id = name.replace(validChars, '');
+  id = id.replace(/-/g, ' ');
+  id = id.trim();
+
+  const noStart = '0123456789 '.split('');
+  id = id
+    .split('')
+    .reduce(
+      (prev, char) => (prev || !noStart.includes(char) ? prev + char : prev),
+      ''
+    );
+  return mode === 'camelCase' ? toCamelCase(id, isId) : toSnakeCase(id);
+}
+
+function toSnakeCase(sentence: string): string {
+  sentence = (sentence || '').trim();
+  if (!sentence) {
+    return sentence;
+  }
+  sentence = sentence.toLowerCase();
+  return sentence
+    .split(' ')
+    .filter(w => !!w)
+    .join('-');
+}
+
+function toCamelCase(sentence: string, isId: boolean): string {
+  sentence = (sentence || '').trim();
+  if (!sentence) {
+    return sentence;
+  }
+  if (sentence.length < 2) {
+    return sentence.toLowerCase();
+  }
+  const words = sentence.split(' ');
+  if (isId && words.length === 1) {
+    return words[0].substr(0, 1).toLowerCase() + words[0].substr(1);
+  }
+  const result = words
+    .filter(w => !!w)
+    .map((w, index) =>
+      index === 0 ? firstWordToCamelCase(w) : wordToCamelCase(w)
+    )
+    .join('');
+
+  return result
+    .split('.')
+    .map((w, index) => (index === 0 ? w : wordToCamelCase(w)))
+    .join('.');
+}
+
+function firstWordToCamelCase(word: string) {
+  return isUpperCase(word)
+    ? word.toLowerCase()
+    : lowerCaseInitialCapitalLettersExceptLast(word);
+}
+
+function wordToCamelCase(word: string) {
+  return word.substr(0, 1).toUpperCase() + word.substr(1);
+}
+
+function lowerCaseInitialCapitalLettersExceptLast(value: string): string {
+  return value.split('').reduce((prev, char, index) => {
+    if (index === 0) {
+      char = char.toLowerCase();
+    } else if (isUpperCase(char)) {
+      if (index + 1 < value.length && isUpperCase(value.charAt(index + 1))) {
+        char = char.toLowerCase();
+      }
+    }
+    return prev + char;
+  }, '');
+}
+
+function isUpperCase(value: string): boolean {
+  return value === value.toUpperCase();
+}

package/src/util/console.printer.ts

@@ -4,6 +4,7 @@ import { deconstructApiError } from './error';
 import { Logger, addNewLines } from './logger';
 import {
   BlockVersion,
+  CopyFieldResult,
   EntriesResult,
   MigrateModelsResult,
   MigrateNodesTree,
@@ -116,7 +117,7 @@ export const printBlockVersion = (
 
 export const printEntriesMigrateResult = (
   { log, messages, currentProject }: ContensisCli,
-  migrateResult: EntriesResult,
+  migrateResult: EntriesResult | CopyFieldResult,
   {
     action = 'import',
     showDiff = false,

package/src/version.ts

@@ -1 +1 @@
-export const LIB_VERSION = "1.1.2-beta.1";
+export const LIB_VERSION = "1.1.2-beta.11";