contensis-cli 1.0.0-beta.87 → 1.0.0-beta.89

package/src/localisation/en-GB.ts

@@ -221,6 +221,8 @@ export const LogMessages = {
       `Assign your new key to a role with "set role assignments", or create a new role with "create role"`,
     failedCreate: (env: string, name: string) =>
       `[${env}] Unable to create API key ${Logger.highlightText(name)}`,
+    failedUpdate: (env: string, name: string) =>
+      `[${env}] Unable to update API key ${Logger.highlightText(name)}`,
     removed: (env: string, id: string) =>
       `[${env}] Deleted API key ${Logger.highlightText(id)}`,
     failedRemove: (env: string, id: string) =>
@@ -479,7 +481,7 @@ You could visit ${git.secretsUri} to check that you can see repository settings`
       )}`,
     addGitSecretsIntro: () =>
       `We have ceated an API key that allows you to deploy your app image to a Contensis Block but we need you to add these details to your GitLab repository.`,
-    addGitSecretsHelp: (git: GitHelper, id: string, secret: string) =>
+    addGitSecretsHelp: (git: GitHelper, id?: string, secret?: string) =>
       `Add secrets or variables in your repository's settings page\n\nGo to ${Logger.highlightText(
         git.secretsUri
       )}\n\n${

package/src/models/CliService.d.ts

@@ -0,0 +1,36 @@
+
+export type OutputFormat = 'json' | 'csv' | 'xml';
+
+export type OutputOptions = {
+  format?: OutputFormat;
+  output?: string;
+};
+
+export interface IConnectOptions extends IAuthOptions {
+  alias?: string;
+  projectId?: string;
+}
+
+export interface IAuthOptions {
+  user?: string;
+  password?: string;
+  clientId?: string;
+  sharedSecret?: string;
+}
+
+export interface IImportOptions {
+  sourceAlias?: string;
+  sourceProjectId?: string;
+}
+
+export type OutputOptionsConstructorArg = OutputOptions &
+  IConnectOptions &
+  IImportOptions;
+
+export interface ContensisCliConstructor {
+  new (
+    args: string[],
+    outputOpts?: OutputOptionsConstructorArg,
+    contensisOpts?: Partial<MigrateRequest>
+  ): ContensisCli;
+}

package/src/services/ContensisCliService.ts

@@ -1,11 +1,12 @@
-import fs from 'fs';
-import path from 'path';
-import fetch from 'node-fetch';
-import inquirer from 'inquirer';
 import to from 'await-to-js';
 import chalk from 'chalk';
+import fs from 'fs';
+import inquirer from 'inquirer';
+import fetch from 'node-fetch';
+import path from 'path';
 
 import { Component, ContentType, Project } from 'contensis-core-api';
+import { Node } from 'contensis-delivery-api/lib/models';
 import { Entry, Role } from 'contensis-management-api/lib/models';
 import {
   ContensisMigrationService,
@@ -22,6 +23,7 @@ import {
 import ContensisAuthService from './ContensisAuthService';
 
 import { LogMessages } from '~/localisation/en-GB';
+import { OutputFormat, OutputOptionsConstructorArg } from '~/models/CliService';
 
 import { readJsonFile } from '~/providers/file-provider';
 import SessionCacheProvider from '../providers/SessionCacheProvider';
@@ -47,42 +49,8 @@ import { jsonFormatter } from '~/util/json.formatter';
 import { diffLogStrings } from '~/util/diff';
 import { logError, Logger } from '~/util/logger';
 import { promiseDelay } from '~/util/timers';
+import { findByIdOrName } from '~/util/find';
 
-type OutputFormat = 'json' | 'csv' | 'xml';
-
-type OutputOptions = {
-  format?: OutputFormat;
-  output?: string;
-};
-
-interface IConnectOptions extends IAuthOptions {
-  alias?: string;
-  projectId?: string;
-}
-
-interface IAuthOptions {
-  user?: string;
-  password?: string;
-  clientId?: string;
-  sharedSecret?: string;
-}
-
-interface IImportOptions {
-  sourceAlias?: string;
-  sourceProjectId?: string;
-}
-
-export type OutputOptionsConstructorArg = OutputOptions &
-  IConnectOptions &
-  IImportOptions;
-
-export interface ContensisCliConstructor {
-  new (
-    args: string[],
-    outputOpts?: OutputOptionsConstructorArg,
-    contensisOpts?: Partial<MigrateRequest>
-  ): ContensisCli;
-}
 let insecurePasswordWarningShown = false;
 
 class ContensisCli {
@@ -937,15 +905,7 @@ class ContensisCli {
       if (Array.isArray(roles)) {
         log.success(messages.roles.list(currentEnv));
 
-        const role =
-          roles.find(
-            r =>
-              r.id === roleNameOrId ||
-              r.name.toLowerCase() === roleNameOrId.toLowerCase()
-          ) ||
-          roles.find(r =>
-            r.name.toLowerCase().includes(roleNameOrId.toLowerCase())
-          );
+        const role = findByIdOrName(roles, roleNameOrId);
 
         if (role) this.HandleFormattingAndOutput(role, log.object);
         else log.error(messages.roles.failedGet(currentEnv, roleNameOrId));
@@ -996,11 +956,7 @@ class ContensisCli {
       if (Array.isArray(roles)) {
         log.success(messages.roles.list(currentEnv));
 
-        const existingRole = roles.find(
-          r =>
-            r.id === roleNameOrId ||
-            r.name.toLowerCase() === roleNameOrId.toLowerCase()
-        );
+        const existingRole = findByIdOrName(roles, roleNameOrId, true);
         if (existingRole) {
           log.info(messages.roles.setPayload());
           log.object(role);
@@ -1040,11 +996,8 @@ class ContensisCli {
       if (Array.isArray(roles)) {
         log.success(messages.roles.list(currentEnv));
 
-        const existingRole = roles.find(
-          r =>
-            r.id === roleNameOrId ||
-            r.name.toLowerCase() === roleNameOrId.toLowerCase()
-        );
+        const existingRole = findByIdOrName(roles, roleNameOrId, true);
+
         if (existingRole) {
           const [deleteErr] = await contensis.roles.RemoveRole(existingRole.id);
 
@@ -1737,12 +1690,45 @@ class ContensisCli {
         log.error(messages.nodes.failedGet(currentProject), err);
         return;
       }
-      const nodes = contensis.content.sourceRepo.nodes.tree;
+      const root = contensis.content.sourceRepo.nodes.tree;
 
       log.success(messages.nodes.get(currentProject, rootPath, depth));
-      this.HandleFormattingAndOutput(nodes, () => {
+
+      const outputNode = (node: Node | any, spaces: string) =>
+        `${node.entry ? log.highlightText('e') : log.infoText('-')}${
+          node.isCanonical ? log.highlightText('c') : log.infoText('-')
+        }${
+          node.includeInMenu ? log.highlightText('m') : log.infoText('-')
+        }${spaces}${
+          node.isCanonical ? log.boldText(`/${node.slug}`) : `/${node.slug}`
+        }${node.entry ? ` ${log.helpText(node.entry.sys.contentTypeId)}` : ''}${
+          node.childCount ? ` +${node.childCount}` : ``
+        } ${log.infoText(node.displayName)}`;
+
+      this.HandleFormattingAndOutput(root, () => {
         // print the nodes to console
-        log.object(nodes);
+        log.object({ ...root, children: undefined });
+        log.raw('');
+        log.info(
+          `${log.highlightText('e')} = has entry; ${log.highlightText(
+            'c'
+          )} = canonical; ${log.highlightText('m')} = include in menu`
+        );
+        log.line();
+        const outputChildren = (root: Node | undefined, depth = 2) => {
+          let str = '';
+          for (const node of (root as any)?.children as Node[]) {
+            str += `${outputNode(node, Array(depth + 1).join('  '))}\n`;
+            if ('children' in node) str += outputChildren(node, depth + 1);
+          }
+          return str;
+        };
+
+        const children = outputChildren(root);
+        log.limits(
+          `${outputNode(root, '  ')}${children ? `\n${children}` : ''}`,
+          100
+        );
       });
     } else {
       log.warning(messages.models.noList(currentProject));
@@ -2218,7 +2204,9 @@ class ContensisCli {
     const contensis = await this.ConnectContensis();
     if (contensis) {
       // Retrieve proxies list for env
-      const [err, proxies] = await contensis.proxies.GetProxies(proxyId);
+      const [err, proxies] = await (contensis.proxies.GetProxies as any)(
+        proxyId
+      ); // TODO: resolve any cast;
 
       if (Array.isArray(proxies)) {
         this.HandleFormattingAndOutput(proxies, () => {
@@ -2230,7 +2218,9 @@ class ContensisCli {
                 version.versionNo
               }] ${id} ${log.infoText`${description}`}`
             );
-            for (const [language, endpoint] of Object.entries(endpoints))
+            for (const [language, endpoint] of Object.entries(
+              endpoints as { [k: string]: any }
+            )) // TODO: resolve any cast
               console.log(
                 `      - ${log.infoText`language: ${language}
         server: ${endpoint.server}
@@ -2253,9 +2243,9 @@ class ContensisCli {
     const contensis = await this.ConnectContensis();
     if (contensis) {
       // Retrieve renderers list for env
-      const [err, renderers] = await contensis.renderers.GetRenderers(
+      const [err, renderers] = await (contensis.renderers.GetRenderers as any)(
         rendererId
-      );
+      ); // TODO: resolve any cast
 
       if (Array.isArray(renderers)) {
         this.HandleFormattingAndOutput(renderers, () => {

package/src/services/ContensisDevService.ts

@@ -1,19 +1,21 @@
+import to from 'await-to-js';
 import { execFile, spawn } from 'child_process';
 import inquirer from 'inquirer';
 import path from 'path';
+import { Entry, Role } from 'contensis-management-api/lib/models';
 
 import { MigrateRequest } from 'migratortron';
 import { stringify } from 'yaml';
-
-import ContensisCli, {
-  OutputOptionsConstructorArg,
-} from './ContensisCliService';
+import ContensisCli from './ContensisCliService';
+import ContensisRole from './ContensisRoleService';
+import { OutputOptionsConstructorArg } from '~/models/CliService';
 import { mapSiteConfigYaml } from '~/mappers/ContensisCliService-to-RequestHanderSiteConfigYaml';
-import { appRootDir, writeFile } from '~/providers/file-provider';
+import { appRootDir, readFile, writeFile } from '~/providers/file-provider';
 import { jsonFormatter } from '~/util/json.formatter';
 import { GitHelper } from '~/util/git';
+import { findByIdOrName } from '~/util/find';
 
-class ContensisDev extends ContensisCli {
+class ContensisDev extends ContensisRole {
   constructor(
     args: string[],
     outputOpts?: OutputOptionsConstructorArg,
@@ -23,6 +25,7 @@ class ContensisDev extends ContensisCli {
   }
 
   DevelopmentInit = async (projectHome: string, opts: any) => {
+    const { dryRun = false } = opts || {};
     const { currentEnv, currentProject, log, messages } = this;
     const contensis = await this.ConnectContensis();
 
@@ -45,12 +48,23 @@ class ContensisDev extends ContensisCli {
       // Retrieve ci workflow info
       const workflowFiles = git.workflows;
 
-      // Set variables for logging etc.
+      // Set variables for performing operations and logging etc.
       let ciFileName = git.ciFileName;
 
-      const devKey = `${git.name} development`;
-      const deployKey = `${git.name} deployment`;
+      const devKeyName = `${git.name} development`;
+      const devKeyDescription = `${git.name} [contensis-cli]`;
+      const devKeyPermissions = { blocks: [] } as Partial<Role['permissions']>;
+      let existingDevKey = apiKeyExists(devKeyName);
+
+      const deployKeyName = `${git.name} deployment`;
+      const deployKeyDescription = `${git.name} deploy [contensis-cli]`;
+      const deployKeyPermissions = { blocks: ['push', 'release'] } as Partial<
+        Role['permissions']
+      >;
+      let existingDeployKey = apiKeyExists(deployKeyName);
+
       const blockId = git.name;
+      const errors = [] as AppError[];
 
       // Start render console output
       log.raw('');
@@ -68,12 +82,12 @@ class ContensisDev extends ContensisCli {
       );
       log.raw(
         log.infoText(
-          messages.devinit.developmentKey(devKey, !!apiKeyExists(devKey))
+          messages.devinit.developmentKey(devKeyName, !!existingDevKey)
         )
       );
       log.raw(
         log.infoText(
-          messages.devinit.deploymentKey(deployKey, !!apiKeyExists(deployKey))
+          messages.devinit.deploymentKey(deployKeyName, !!existingDeployKey)
         )
       );
       log.raw('');
@@ -95,7 +109,7 @@ class ContensisDev extends ContensisCli {
       }
 
       log.raw(log.infoText(messages.devinit.ciDetails(ciFileName)));
-      log.help(messages.devinit.ciIntro(git));
+      ylog.help(messages.devinit.ciIntro(git));
 
       // Confirm prompt
       const { confirm } = await inquirer.prompt([
@@ -120,25 +134,131 @@ class ContensisDev extends ContensisCli {
       log.raw('');
 
       // Magic happens...
+      const checkpoint = (op: string) => {
+        if (errors.length) throw errors[0];
+        else log.debug(`${op} completed ok`);
+        return true;
+      };
 
       // Arrange API keys for development and deployment
-      log.success(messages.devinit.createDevKey(devKey, false));
-      log.success(messages.devinit.createDeployKey(deployKey, true));
+      const [getRolesErr, roles] = await to(contensis.roles.GetRoles());
+      if (!roles && getRolesErr) errors.push(getRolesErr);
+      checkpoint(`fetched ${roles?.length} roles`);
+      if (dryRun) {
+        checkpoint(`skip api key creation (dry-run)`);
+      } else {
+        existingDevKey = await this.CreateOrUpdateApiKey(
+          existingDevKey,
+          devKeyName,
+          devKeyDescription
+        );
+        checkpoint('dev key created');
+
+        existingDeployKey = await this.CreateOrUpdateApiKey(
+          existingDeployKey,
+          deployKeyName,
+          deployKeyDescription
+        );
+        checkpoint('deploy key created');
+
+        // Ensure dev API key is assigned to a role
+        let existingDevRole = findByIdOrName(roles || [], devKeyName, true) as
+          | Role
+          | undefined;
+        existingDevRole = await this.CreateOrUpdateRole(
+          existingDevRole,
+          devKeyName,
+          devKeyDescription,
+          { apiKeys: [devKeyName] },
+          devKeyPermissions
+        );
+        checkpoint('dev key role assigned');
+        log.success(messages.devinit.createDevKey(devKeyName, true));
+
+        // Ensure deploy API key is assigned to a role with the right permissions
+        let existingDeployRole = findByIdOrName(
+          roles || [],
+          deployKeyName,
+          true
+        ) as Role | undefined;
+        existingDeployRole = await this.CreateOrUpdateRole(
+          existingDeployRole,
+          deployKeyName,
+          deployKeyDescription,
+          { apiKeys: [deployKeyName] },
+          deployKeyPermissions
+        );
+
+        checkpoint('deploy key role assigned');
+        log.success(messages.devinit.createDeployKey(deployKeyName, true));
+        checkpoint('api keys done');
+      }
 
       // Update or create a file called .env in project home
-      log.success(messages.devinit.writeEnvFile());
-      // log.help(messages.devinit.useEnvFileTip());
+      const envContents = {
+        ALIAS: currentEnv,
+        PROJECT: currentProject,
+        ACCESS_TOKEN: accessToken,
+      };
+      const envFilePath = `${projectHome}/.env`;
+      const existingEnvFile = readFile(envFilePath);
+      const existingFileLines = (existingEnvFile || '').split('\n');
+      const envFileLines: string[] = [];
+
+      const updatedEnvKeys: string[] = [];
+      for (const ln of existingFileLines) {
+        let newline = '';
+        for (const [k, v] of Object.entries(envContents))
+          if (ln.startsWith(`${k}=`)) {
+            newline = `${k}=${v}`;
+            updatedEnvKeys.push(k);
+          }
+        envFileLines.push(newline || ln);
+      }
+      for (const addKey of existingFileLines
+        .filter(
+          efl =>
+            !updatedEnvKeys.find(uek =>
+              uek.startsWith(`${efl.split('=')?.[0]}=`)
+            ) && Object.keys(envContents).find(ck => ck === efl.split('=')?.[0])
+        )
+        .map(fl => fl.split('=')?.[0]) as (keyof typeof envContents)[]) {
+        envFileLines.push(`${addKey}=${envContents[addKey]}`);
+      }
+
+      if (dryRun) {
+        checkpoint('skip .env file update (dry-run)');
+        log.info(`.env file`);
+        log.object(envFileLines);
+      } else {
+        writeFile(envFilePath, envFileLines.join('\n'));
+        checkpoint('.env file updated');
+        log.success(messages.devinit.writeEnvFile());
+        // log.help(messages.devinit.useEnvFileTip());
+      }
 
       // Update CI file -- different for GH/GL -- create a sample one with build?
-      log.success(messages.devinit.writeCiFile(`./${ciFileName}`));
-      log.info(
-        messages.devinit.ciBlockTip(blockId, currentEnv, currentProject)
-      );
+      if (dryRun) {
+        checkpoint('skip CI file update (dry-run)');
+        log.info(`${ciFileName} file`);
+        // TODO: log what we might add to the file
+        //log.object(envFileLines);
+      } else {
+        log.success(messages.devinit.writeCiFile(`./${ciFileName}`));
+        log.info(
+          messages.devinit.ciBlockTip(blockId, currentEnv, currentProject)
+        );
+        checkpoint('CI file updated');
+      }
 
       // Echo Deployment API key to console, ask user to add secrets to repo
       log.warning(messages.devinit.addGitSecretsIntro());
       log.help(
-        messages.devinit.addGitSecretsHelp(git, '123-456', '789-012-345')
+        messages.devinit.addGitSecretsHelp(
+          git,
+          existingDeployKey?.id,
+          existingDeployKey?.sharedSecret
+        )
       );
 
       log.success(messages.devinit.success());

package/src/services/ContensisRoleService.ts

@@ -0,0 +1,84 @@
+import { Role } from 'contensis-management-api/lib/models';
+import { ApiKey, MigrateRequest } from 'migratortron';
+
+import ContensisCli from './ContensisCliService';
+import { OutputOptionsConstructorArg } from '~/models/CliService';
+
+class ContensisRole extends ContensisCli {
+  constructor(
+    args: string[],
+    outputOpts?: OutputOptionsConstructorArg,
+    contensisOpts: Partial<MigrateRequest> = {}
+  ) {
+    super(args, outputOpts, contensisOpts);
+  }
+
+  CreateOrUpdateApiKey = async (
+    existingKey: ApiKey | undefined,
+    name: string,
+    description: string
+  ) => {
+    const { contensis, currentEnv, messages } = this;
+    if (!contensis) throw new Error('shouldnt be here');
+    if (existingKey) {
+      const [err, key] = await contensis.apiKeys.UpdateKey(existingKey.id, {
+        name,
+        description,
+      });
+
+      if (err)
+        throw new Error(messages.keys.failedUpdate(currentEnv, name), {
+          cause: err,
+        });
+      return key;
+    } else {
+      const [err, key] = await contensis.apiKeys.CreateKey(name, description);
+      if (err)
+        throw new Error(messages.keys.failedCreate(currentEnv, name), {
+          cause: err,
+        });
+
+      return key;
+    }
+  };
+
+  CreateOrUpdateRole = async (
+    existingRole: Role | undefined,
+    name: string,
+    description: string,
+    assignments: Role['assignments'],
+    permissions: Role['permissions']
+  ) => {
+    const { contensis, currentEnv, messages } = this;
+    if (!contensis) throw new Error('shouldnt be here');
+
+    if (existingRole) {
+      // TODO: check is update needed?
+      const [err, updated] = await contensis.roles.UpdateRole(existingRole.id, {
+        ...existingRole,
+        assignments,
+        permissions,
+      });
+      if (err)
+        throw new Error(messages.roles.failedSet(currentEnv, name), {
+          cause: err,
+        });
+      return updated;
+    } else {
+      const [err, created] = await contensis.roles.CreateRole({
+        name,
+        description,
+        enabled: true,
+        assignments,
+        permissions,
+      } as Role);
+      if (err)
+        throw new Error(messages.roles.failedCreate(currentEnv, name), {
+          cause: err,
+        });
+
+      return created;
+    }
+  };
+}
+export default ContensisRole;

package/src/util/find.ts

@@ -0,0 +1,8 @@
+export const findByIdOrName = (arr: any[], idOrName: string, exact = false) =>
+  arr.find(
+    r =>
+      r.id === idOrName ||
+      r.name.toLowerCase() === idOrName.toLowerCase()
+  ) ||
+  (!exact &&
+    arr.find(r => r.name.toLowerCase().includes(idOrName.toLowerCase())));

package/src/util/logger.ts

@@ -2,6 +2,7 @@
 import chalk from 'chalk';
 import dateFormat from 'dateformat';
 import deepCleaner from 'deep-cleaner';
+import { ansiEscapeCodes, first, strlen } from 'printable-characters';
 // import ProgressBar from 'progress';
 import { isSysError, tryStringify } from '.';
 
@@ -88,6 +89,13 @@ export class Logger {
     else console.log(message);
     progress.current.interrupt(message);
   };
+  static debug: LogMethod = content => {
+    const message = `${Logger.getPrefix()} ${
+      Logger.isUserTerminal ? chalk.bgGrey(' ⚙ ') : '[DEBUG]'
+    } ${Logger.infoText(content)}`;
+    if (progress.active) progress.current.interrupt(message);
+    else console.log(message);
+  };
   static json: LogJsonDepthMethod = (content, depth = 9) =>
     console.dir(deepCleaner(content), { colors: true, depth });
   static mixed: LogArrayMethod = contentArray =>
@@ -214,6 +222,26 @@ export class Logger {
     if (progress.active) progress.current.interrupt(content);
     else console.log(content);
   };
+
+  static limits = (content: string, displayLength = 30) => {
+    const consoleWidth = process.stdout.columns;
+    console.info(
+      consoleWidth
+        ? content
+            .split('\n')
+            .slice(0, consoleWidth ? displayLength : undefined)
+            .map((line: string) =>
+              consoleWidth && strlen(line) > consoleWidth
+                ? first(line, consoleWidth)
+                : line
+            )
+            .join('\n')
+        : content.replace(ansiEscapeCodes, '')
+    );
+    const tableArray = content.split('\n');
+    if (consoleWidth && tableArray.length > displayLength)
+      console.info(`\n`, `- and ${tableArray.length - displayLength} more...`);
+  };
 }
 
 export const logError: LogErrorFunc = (

package/src/version.ts

@@ -1 +1 @@
-export const LIB_VERSION = "1.0.0-beta.87";
+export const LIB_VERSION = "1.0.0-beta.89";