contensis-cli 1.3.1-beta.0 → 1.3.1-beta.10

package/src/services/ContensisCliService.ts

@@ -15,7 +15,6 @@ import {
   SourceCms,
   ContentTypesResult,
   Model,
-  MigrateModelsResult,
   BlockActionType,
   logEntitiesTable,
 } from 'migratortron';
@@ -51,6 +50,7 @@ import {
   printNodesMigrateResult,
 } from '~/util/console.printer';
 import { csvFormatter } from '~/util/csv.formatter';
+import { htmlFormatter } from '~/util/html.formatter';
 import { jsonFormatter, limitFields } from '~/util/json.formatter';
 import { xmlFormatter } from '~/util/xml.formatter';
 import { isDebug } from '~/util/debug';
@@ -108,7 +108,7 @@ class ContensisCli {
     const environments = this.cache.environments || {};
 
     if (!currentEnvironment) return {} as EnvironmentCache;
-    else if (!!environments[currentEnvironment])
+    else if (environments[currentEnvironment])
       return environments[currentEnvironment];
     else {
       return {
@@ -127,6 +127,7 @@ class ContensisCli {
   ) {
     // console.log('args: ', JSON.stringify(args, null, 2));
 
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     const [exe, script, verb = '', noun = '', ...restArgs] = args;
     this.verb = verb?.toLowerCase();
     this.noun = noun?.toLowerCase();
@@ -199,7 +200,7 @@ class ContensisCli {
   PrintEnvironments = async () => {
     const { log, messages } = this;
     const { currentEnvironment, environments = {} } = this.cache;
-    const envKeys = Object.keys(environments);
+    const envKeys = Object.keys(environments).sort();
     log.success(messages.envs.found(envKeys.length));
     await this.HandleFormattingAndOutput(envKeys, () => {
       // print the envKeys to console
@@ -212,6 +213,38 @@ class ContensisCli {
     }
   };
 
+  RemoveEnvironment = async (env: string) => {
+    const { log, messages, session } = this;
+    const { currentEnvironment, environments = {} } = this.cache;
+    const envKeys = Object.keys(environments);
+    log.success(messages.envs.found(envKeys.length));
+    if (environments[env]) {
+      // remove env from cache
+      session.RemoveEnv(env);
+      // remove credentials
+      const lastUserId = environments[env].lastUserId;
+      if (lastUserId) {
+        const [err, credentials] = await new CredentialProvider({
+          userId: environments[env].lastUserId,
+          alias: env,
+        }).Init();
+        if (!err && credentials) await credentials.Delete();
+      }
+      log.success(messages.envs.removed(env));
+      // support the output and format options - exporting the history for the
+      // removed alias
+      await this.HandleFormattingAndOutput(environments[env], () => log.line());
+    } else {
+      log.warning(messages.envs.notFound(env));
+    }
+
+    const nextCurrentEnv =
+      currentEnvironment === env ? undefined : currentEnvironment;
+    if (envKeys.length === 0 || !nextCurrentEnv) log.help(messages.envs.tip());
+
+    return nextCurrentEnv;
+  };
+
   Connect = async (environment: string) => {
     const { log, messages, session } = this;
 
@@ -219,6 +252,7 @@ class ContensisCli {
       this.currentEnv = environment;
       this.urls = url(environment, 'website');
 
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
       const [fetchErr, response] = await to(fetch(this.urls.cms));
       if (response && response?.status < 400) {
         log.success(messages.connect.connected(environment));
@@ -291,6 +325,7 @@ class ContensisCli {
     commit = false,
     fromFile,
     importDataType,
+    importData,
   }: {
     commit?: boolean;
     fromFile?: string;
@@ -301,10 +336,13 @@ class ContensisCli {
       | 'models'
       | 'nodes'
       | 'user-input';
+    importData?: any[];
   }) => {
-    const source: 'contensis' | 'file' = fromFile ? 'file' : 'contensis';
+    const source: 'contensis' | 'file' =
+      fromFile || importData ? 'file' : 'contensis';
 
-    const fileData = fromFile ? (await readFileAsJSON(fromFile)) || [] : [];
+    const fileData =
+      importData || (fromFile ? (await readFileAsJSON(fromFile)) || [] : []);
 
     if (typeof fileData === 'string')
       throw new Error(`Import file format must be of type JSON`);
@@ -463,7 +501,7 @@ class ContensisCli {
         isPassword(this.env.passwordFallback) ||
         '';
 
-    const { log, messages } = this;
+    const { messages } = this;
 
     if (userId) {
       const { currentEnv, env } = this;
@@ -589,7 +627,7 @@ class ContensisCli {
     if (contensis) {
       // Retrieve token for env
       const [error, token] = await to(
-        contensis.content.sourceRepo.repo.BearerToken()
+        contensis.content.source.repo.BearerToken()
       );
       if (token) {
         // Print bearer token to console
@@ -621,8 +659,8 @@ class ContensisCli {
           currentProject && currentProject !== 'null'
             ? currentProject
             : projects.some(p => p.id === 'website')
-            ? 'website'
-            : undefined;
+              ? 'website'
+              : undefined;
 
         session.UpdateEnv({
           projects: projects.map(p => p.id),
@@ -641,6 +679,7 @@ class ContensisCli {
             try {
               color = chalk.keyword((project as any).color);
             } catch (ex) {
+              Logger.debug(`${ex}`);
               color = chalk.white;
             }
             console.log(
@@ -671,7 +710,7 @@ class ContensisCli {
   };
 
   PrintProject = async (projectId = this.currentProject) => {
-    const { log, messages, session } = this;
+    const { log, messages } = this;
     const contensis = await this.ConnectContensis();
 
     if (contensis) {
@@ -816,7 +855,7 @@ class ContensisCli {
     const contensis = await this.ConnectContensis({ commit: true });
 
     if (contensis) {
-      const [err, key] = await contensis.apiKeys.RemoveKey(id);
+      const [err] = await contensis.apiKeys.RemoveKey(id);
 
       if (!err) {
         log.success(messages.keys.removed(currentEnv, id));
@@ -1040,7 +1079,7 @@ class ContensisCli {
     if (contensis) {
       // Retrieve workflows list for env
       const [workflowsErr, workflows] =
-        await contensis.content.sourceRepo.workflows.GetWorkflows();
+        await contensis.content.source.workflows.GetWorkflows();
 
       if (Array.isArray(workflows)) {
         log.success(messages.workflows.list(currentEnv));
@@ -1106,7 +1145,7 @@ class ContensisCli {
     if (contensis) {
       // Retrieve workflows list for env
       const [workflowsErr, workflows] =
-        await contensis.content.sourceRepo.workflows.GetWorkflows();
+        await contensis.content.source.workflows.GetWorkflows();
 
       if (Array.isArray(workflows)) {
         log.success(messages.workflows.list(currentEnv));
@@ -1330,9 +1369,9 @@ class ContensisCli {
     if (contensis) {
       log.line();
       if (contensis.isPreview) {
-        console.log(log.successText(` -- IMPORT PREVIEW -- `));
+        log.success(messages.migrate.preview());
       } else {
-        console.log(log.warningText(` *** COMMITTING IMPORT *** `));
+        log.warning(messages.migrate.commit());
       }
 
       const [migrateErr, result] = await contensis.MigrateContentModels();
@@ -1525,10 +1564,9 @@ class ContensisCli {
           contentType.projectId = currentProject;
           delete contentType.uuid;
 
-          const [err, created, createStatus] =
-            await contensis.models.targetRepos[
-              currentProject
-            ].repo.UpsertContentType(false, contentType);
+          const [err, , createStatus] = await contensis.models.targets[
+            currentProject
+          ].repo.UpsertContentType(false, contentType);
 
           if (err) log.error(err.message, err);
           if (createStatus) {
@@ -1717,10 +1755,9 @@ class ContensisCli {
           component.projectId = currentProject;
           delete component.uuid;
 
-          const [err, created, createStatus] =
-            await contensis.models.targetRepos[
-              currentProject
-            ].repo.UpsertComponent(false, component);
+          const [err, , createStatus] = await contensis.models.targets[
+            currentProject
+          ].repo.UpsertComponent(false, component);
 
           if (err) log.error(err.message, err);
           if (createStatus) {
@@ -1801,15 +1838,23 @@ class ContensisCli {
       // Add a full sys.uri to asset entries
       // Add sys.metadata.exportCms
       // Add sys.metadata.exportProjectId
+      const nodes = contensis.content.source.nodes.raw;
+      const combinedOutput = [...entries, ...nodes];
 
-      await this.HandleFormattingAndOutput(entries, () =>
+      await this.HandleFormattingAndOutput(combinedOutput, () => {
         // print the entries to console
         logEntitiesTable({
           entries,
           projectId: currentProject,
           fields: contensis.payload.query?.fields,
-        })
-      );
+        });
+        if (nodes.length)
+          logEntitiesTable({
+            nodes,
+            projectId: currentProject,
+            fields: contensis.payload.query?.fields,
+          });
+      });
     } else {
       log.warning(messages.models.noList(currentProject));
       log.help(messages.connect.tip());
@@ -1821,11 +1866,13 @@ class ContensisCli {
     fromFile,
     logOutput,
     saveEntries,
+    data,
   }: {
     commit: boolean;
-    fromFile: string;
+    fromFile?: string;
     logOutput: string;
     saveEntries: boolean;
+    data?: any[];
   }) => {
     const { currentEnv, currentProject, log, messages } = this;
 
@@ -1833,14 +1880,15 @@ class ContensisCli {
       commit,
       fromFile,
       importDataType: 'entries',
+      importData: data,
     });
 
     if (contensis) {
       log.line();
       if (contensis.isPreview) {
-        console.log(log.successText(` -- IMPORT PREVIEW -- `));
+        log.success(messages.migrate.preview());
       } else {
-        console.log(log.warningText(` *** COMMITTING IMPORT *** `));
+        log.warning(messages.migrate.commit());
       }
 
       const [err, result] = await contensis.MigrateEntries();
@@ -1850,7 +1898,11 @@ class ContensisCli {
         const { entries, nodes } = contensis.content.targets[currentProject];
 
         const output = saveEntries
-          ? entries.migrate?.map(me => me.toJSON())
+          ? // include entries and dependent nodes when saving entries
+            [
+              entries.migrate?.map(me => me.toJSON()) || [],
+              nodes.migrateNodes.map(mn => mn.node),
+            ].flat()
           : result;
         await this.HandleFormattingAndOutput(output, () => {
           // print the migrateResult to console
@@ -1859,7 +1911,10 @@ class ContensisCli {
             showDiff: logOutput === 'all' || logOutput === 'changes',
             showChanged: logOutput === 'changes',
           });
-          if (['all', 'changes'].includes(logOutput))
+          if (
+            ['all', 'changes'].includes(logOutput) &&
+            nodes.migrateNodes.length
+          )
             printNodeTreeOutput(
               this,
               {
@@ -1930,9 +1985,9 @@ class ContensisCli {
     if (contensis) {
       log.line();
       if (contensis.isPreview) {
-        console.log(log.successText(` -- IMPORT PREVIEW -- `));
+        log.success(messages.migrate.preview());
       } else {
-        console.log(log.warningText(` *** COMMITTING IMPORT *** `));
+        log.warning(messages.migrate.commit());
       }
 
       const [err, result] = await to(
@@ -1989,6 +2044,87 @@ class ContensisCli {
     }
   };
 
+  UpdateEntryField = async ({
+    commit,
+    fromFile,
+    logOutput,
+    saveEntries,
+  }: {
+    commit: boolean;
+    fromFile: string;
+    logOutput: string;
+    saveEntries: boolean;
+  }) => {
+    const { currentEnv, currentProject, log, messages } = this;
+
+    const contensis = await this.ConnectContensisImport({
+      commit,
+      fromFile,
+      importDataType: 'entries',
+    });
+
+    if (contensis) {
+      log.line();
+      if (contensis.isPreview) {
+        log.success(messages.entries.update.preview());
+      } else {
+        log.warning(messages.entries.update.commit());
+      }
+
+      const [err, result] = await to(
+        contensis.content.update.UpdateFieldContent()
+      );
+
+      if (err) logError(err);
+      if (result) {
+        const output = saveEntries
+          ? contensis.content.update.targets[
+              currentProject
+            ].entries.migrate?.map(me => me.toJSON())
+          : result;
+        await this.HandleFormattingAndOutput(output, () => {
+          // print the migrateResult to console
+          printEntriesMigrateResult(this, result, {
+            action: 'update',
+            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.update.success(
+            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.update.failed(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();
@@ -2000,7 +2136,7 @@ class ContensisCli {
         log.error(messages.nodes.failedGet(currentProject), err);
         return;
       }
-      const root = contensis.nodes.sourceRepo.nodes.tree;
+      const root = contensis.nodes.source.nodes.tree;
 
       log.success(messages.nodes.get(currentProject, rootPath, depth));
 
@@ -2037,9 +2173,9 @@ class ContensisCli {
     if (contensis) {
       log.line();
       if (contensis.isPreview) {
-        console.log(log.successText(` -- IMPORT PREVIEW -- `));
+        log.success(messages.migrate.preview());
       } else {
-        console.log(log.warningText(` *** COMMITTING IMPORT *** `));
+        log.warning(messages.migrate.commit());
       }
 
       const [err, result] = await contensis.MigrateNodes();
@@ -2049,8 +2185,7 @@ class ContensisCli {
         await this.HandleFormattingAndOutput(result, () => {
           // print the migrateResult to console
           const migrateTree =
-            contensis.nodes.targetRepos[currentProject].nodes
-              .migrateNodesTreeView;
+            contensis.nodes.targets[currentProject].nodes.migrateNodesTreeView;
           printNodeTreeOutput(this, migrateTree, logOutput, logLimit);
           printNodesMigrateResult(this, result, {
             showAll: logOutput === 'all',
@@ -2075,8 +2210,8 @@ class ContensisCli {
       ) {
         let totalCount: number;
         if (commit) {
-          let created = typeof nodesCreated === 'number' ? nodesCreated : 0;
-          let updated = typeof nodesUpdated === 'number' ? nodesUpdated : 0;
+          const created = typeof nodesCreated === 'number' ? nodesCreated : 0;
+          const updated = typeof nodesUpdated === 'number' ? nodesUpdated : 0;
 
           totalCount = created + updated;
         } else {
@@ -2122,8 +2257,7 @@ class ContensisCli {
           // print the migrateResult to console
           printNodeTreeOutput(
             this,
-            contensis.nodes.targetRepos[currentProject].nodes
-              .migrateNodesTreeView
+            contensis.nodes.targets[currentProject].nodes.migrateNodesTreeView
           );
           // printNodesMigrateResult(this, result, {
           //   action: 'delete',
@@ -2368,9 +2502,8 @@ class ContensisCli {
     const contensis = await this.ConnectContensis();
     if (contensis) {
       // Push new block version
-      const [err, blockVersion] = await contensis.blocks.PushBlockVersion(
-        block
-      );
+      const [err, blockVersion] =
+        await contensis.blocks.PushBlockVersion(block);
       if (!err) {
         log.success(
           messages.blocks.pushed(
@@ -2447,9 +2580,8 @@ class ContensisCli {
 
       // If action is release and version is latest, find the latest version number
       if (action === 'release' && version === 'latest') {
-        const [getErr, blockVersion] = await this.GetLatestBlockVersion(
-          blockId
-        );
+        const [getErr, blockVersion] =
+          await this.GetLatestBlockVersion(blockId);
 
         if (getErr) {
           // Log error getting latest block version no
@@ -2562,7 +2694,7 @@ class ContensisCli {
           stopFollowing();
         });
 
-        let delay = promiseDelay(5 * 1000, null);
+        const delay = promiseDelay(5 * 1000, null);
         const stopFollowing = () => {
           following = false;
           delay.cancel();
@@ -2666,6 +2798,7 @@ class ContensisCli {
     }
   };
 
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   PrintRenderers = async (rendererId?: string) => {
     const { currentEnv, env, log, messages } = this;
     const contensis = await this.ConnectContensis();
@@ -2722,6 +2855,9 @@ class ContensisCli {
     } else if (format === 'csv') {
       log.raw('');
       log.raw(log.infoText(await csvFormatter(limitFields(obj, fields))));
+    } else if (format === 'html') {
+      log.raw('');
+      log.raw(log.infoText(htmlFormatter(limitFields(obj, fields))));
     } else if (format === 'xml') {
       log.raw('');
       log.raw(log.infoText(xmlFormatter(limitFields(obj, fields))));
@@ -2736,6 +2872,8 @@ class ContensisCli {
       const isText = !tryParse(obj) && typeof obj === 'string';
       if (format === 'csv') {
         writeString = await csvFormatter(limitFields(obj, fields));
+      } else if (format === 'html') {
+        writeString = htmlFormatter(limitFields(obj, fields));
       } else if (format === 'xml') {
         writeString = xmlFormatter(limitFields(obj, fields));
       } else

package/src/services/ContensisDevService.ts

@@ -58,7 +58,7 @@ class ContensisDev extends ContensisRole {
           return pattern.test(blockId);
         } else return false;
       };
-      let { blockId } = await inquirer.prompt({
+      const { blockId } = await inquirer.prompt({
         name: 'blockId',
         type: 'input',
         prefix: '🧱',
@@ -275,7 +275,7 @@ class ContensisDev extends ContensisRole {
 
       const envFilePath = `${projectHome}/.env`;
       const existingEnvFile = readFile(envFilePath);
-      let existingEnvFileArray = (existingEnvFile || '')
+      const existingEnvFileArray = (existingEnvFile || '')
         .split('\n')
         .filter(l => !!l);
 

package/src/shell.ts

@@ -14,6 +14,7 @@ import { LIB_VERSION } from './version';
 class ContensisShell {
   private currentEnvironment!: string;
   private emptyInputCounter: number = 0;
+  private cache!: SessionCache;
   private env!: EnvironmentCache;
   private firstStart = true;
   private userId: string = '';
@@ -22,12 +23,12 @@ class ContensisShell {
 
   private refreshEnvironment = () => {
     // Reload any persisted changes from the disk cache
-    const {
-      cache: { currentEnvironment = '', environments = {} },
-    } = new ContensisCli([]);
+    const { cache } = new ContensisCli([]);
+    this.cache = cache; // read the cache to pre-load suggestions
     // console.log(`refreshing env w/${currentEnvironment}`);
-    this.currentEnvironment = currentEnvironment;
-    this.env = environments[currentEnvironment];
+    this.currentEnvironment = cache.currentEnvironment || '';
+    const environments = cache.environments || {};
+    this.env = environments[this.currentEnvironment];
 
     // Reload logging here to support changing language
     Logging('en-GB').then(({ messages, Log }) => {
@@ -128,12 +129,21 @@ class ContensisShell {
         },
       },
       'connect',
+      ...Object.keys(this.cache.environments || {}).map(
+        alias => `connect ${alias}`
+      ),
       'list envs',
+      'remove env',
       'quit',
     ];
 
     if (currentEnvironment)
-      availableCommands.push('login', 'list projects', 'set project');
+      availableCommands.push(
+        'login',
+        'list projects',
+        'set project',
+        ...(this.env?.projects || []).map(project => `set project ${project}`)
+      );
     if (userId)
       availableCommands.push(
         'copy field',
@@ -176,6 +186,7 @@ class ContensisShell {
         'list roles',
         'list webhooks',
         'list workflows',
+        'push asset',
         'push block',
         'remove components',
         'remove contenttypes',
@@ -189,7 +200,8 @@ class ContensisShell {
         'set role description',
         'set role assignments',
         'set role enabled',
-        'set role permissions'
+        'set role permissions',
+        'update field'
       );
 
     const prompt = inquirer.createPromptModule();
@@ -243,9 +255,8 @@ class ContensisShell {
                     : JSON.stringify(ex, null, 2)
                 }`
               );
-          } finally {
-            return this.contensisPrompt();
           }
+          return this.contensisPrompt();
         }
       })
       .catch((err: Error) => {