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

package/src/models/CliService.d.ts

@@ -1,3 +1,13 @@
+export type CliUrls =
+  | {
+      api: string;
+      cms: string;
+      liveWeb: string;
+      previewWeb: string;
+      iisWeb: string;
+      iisPreviewWeb: string;
+    }
+  | undefined;
 
 export type OutputFormat = 'json' | 'csv' | 'xml';
 

package/src/services/ContensisCliService.ts

@@ -4,6 +4,7 @@ import fs from 'fs';
 import inquirer from 'inquirer';
 import fetch from 'node-fetch';
 import path from 'path';
+import clone from 'rfdc';
 
 import { Component, ContentType, Project } from 'contensis-core-api';
 import { Role } from 'contensis-management-api/lib/models';
@@ -22,7 +23,11 @@ import {
 import ContensisAuthService from './ContensisAuthService';
 
 import { LogMessages } from '~/localisation/en-GB';
-import { OutputFormat, OutputOptionsConstructorArg } from '~/models/CliService';
+import {
+  CliUrls,
+  OutputFormat,
+  OutputOptionsConstructorArg,
+} from '~/models/CliService';
 
 import { readFileAsJSON } from '~/providers/file-provider';
 import SessionCacheProvider from '../providers/SessionCacheProvider';
@@ -78,16 +83,7 @@ class ContensisCli {
 
   sourceAlias?: string;
   targetEnv?: string;
-  urls:
-    | {
-        api: string;
-        cms: string;
-        liveWeb: string;
-        previewWeb: string;
-        iisWeb: string;
-        iisPreviewWeb: string;
-      }
-    | undefined;
+  urls: CliUrls;
   log = Logger;
   messages = LogMessages;
 
@@ -1183,7 +1179,7 @@ class ContensisCli {
 
   PrintContentModels = async (
     modelIds: string[] = [],
-    printRequiredBy?: boolean
+    opts: { export?: boolean; printRequiredBy?: boolean }
   ) => {
     const { currentProject, log, messages } = this;
     const contensis = await this.ConnectContensis();
@@ -1199,62 +1195,72 @@ class ContensisCli {
             modelIds.some(id => id.toLowerCase() === m.id.toLowerCase())
           )
         : undefined;
+      const exportResources: (ContentType | Component)[] = [];
+
+      if (opts.export) {
+        // Generate a list of contentTypeIds and componentIds from all models
+        // and dependencies
+        const contentTypeIds = Array.from(
+          new Set([
+            ...(returnModels || models || []).map(m => m.id),
+            ...(returnModels || models || [])
+              .map(m => m.dependencies?.contentTypes?.map(c => c[0]) || [])
+              .flat(),
+          ])
+        );
+        const componentIds = Array.from(
+          new Set(
+            (returnModels || models || [])
+              .map(m => m.dependencies?.components?.map(c => c[0]) || [])
+              .flat()
+          )
+        );
 
-      // Generate a list of contentTypeIds and componentIds from all models
-      // and dependencies
-      const contentTypeIds = Array.from(
-        new Set([
-          ...(returnModels || models || []).map(m => m.id),
-          ...(returnModels || models || [])
-            .map(m => m.dependencies?.contentTypes?.map(c => c[0]) || [])
-            .flat(),
-        ])
-      );
-      const componentIds = Array.from(
-        new Set(
-          (returnModels || models || [])
-            .map(m => m.dependencies?.components?.map(c => c[0]) || [])
-            .flat()
-        )
-      );
-
-      // Create an array of all the content types and component definitions
-      // we will use this when outputting to a file
-      const contentModelBackup = [
-        ...contentTypes.filter(c =>
-          contentTypeIds.map(i => i.toLowerCase()).includes(c.id.toLowerCase())
-        ),
-        ...components.filter(c =>
-          componentIds.map(i => i.toLowerCase()).includes(c.id.toLowerCase())
-        ),
-      ];
+        // Create an array of all the content types and component definitions
+        // we will use this when outputting to a file
+        exportResources.push(
+          ...contentTypes.filter(c =>
+            contentTypeIds
+              .map(i => i.toLowerCase())
+              .includes(c.id.toLowerCase())
+          ),
+          ...components.filter(c =>
+            componentIds.map(i => i.toLowerCase()).includes(c.id.toLowerCase())
+          )
+        );
+      }
 
       if (Array.isArray(returnModels)) {
         log.success(messages.models.list(currentProject));
-        await this.HandleFormattingAndOutput(contentModelBackup, () => {
-          // print the content models to console
-          for (const model of returnModels) {
-            if (!printRequiredBy) {
-              // truncate parts of the output
-              delete model.dependencyOf;
-              if (model.dependencies?.contentTypes)
-                model.dependencies.contentTypes.forEach(id => (id[1] = []));
-              if (model.dependencies?.components)
-                model.dependencies.components.forEach(id => (id[1] = []));
-            }
+        await this.HandleFormattingAndOutput(
+          opts.export ? exportResources : returnModels,
+          () => {
+            // print the content models to console
+            for (const model of returnModels) {
+              // create a clone of each model to safely modify
+              const draft = clone()(model);
+              if (!opts.printRequiredBy) {
+                // truncate parts of the output
+                delete draft.dependencyOf;
+                if (draft.dependencies?.contentTypes)
+                  draft.dependencies.contentTypes.forEach(id => id.pop());
+                if (draft.dependencies?.components)
+                  draft.dependencies.components.forEach(id => id.pop());
+              }
 
+              log.raw('');
+              log.object(draft);
+            }
             log.raw('');
-            log.object(model);
           }
-          log.raw('');
-        });
+        );
       } else {
         log.success(
           messages.models.get(currentProject, models?.length.toString() || '0')
         );
         log.raw('');
         if (models?.length) {
-          await this.HandleFormattingAndOutput(contentModelBackup, () => {
+          await this.HandleFormattingAndOutput(exportResources, () => {
             // print the content models to console
             for (const model of models) {
               const components = model.components?.length || 0;
@@ -1784,10 +1790,11 @@ class ContensisCli {
 
       if (err) logError(err);
       else {
+        const { migrateEntries, nodes } =
+          contensis.content.targets[currentProject];
+
         const output = saveEntries
-          ? contensis.content.targets[currentProject].migrateEntries?.map(
-              me => me.finalEntry
-            )
+          ? migrateEntries?.map(me => me.finalEntry)
           : result;
         await this.HandleFormattingAndOutput(output, () => {
           // print the migrateResult to console
@@ -1796,6 +1803,16 @@ class ContensisCli {
             showDiff: logOutput === 'all' || logOutput === 'changes',
             showChanged: logOutput === 'changes',
           });
+          if (['all', 'changes'].includes(logOutput))
+            printNodeTreeOutput(
+              this,
+              {
+                ...nodes.rootAncestor,
+                status: 'no change',
+                children: nodes.migrateNodes as any,
+              },
+              logOutput
+            );
         });
       }
       if (
@@ -1812,7 +1829,12 @@ class ContensisCli {
             commit
               ? (result.migrateResult?.created || 0) +
                   (result.migrateResult?.updated || 0)
-              : result.entriesToMigrate[currentProject].totalCount
+              : result.entriesToMigrate[currentProject].totalCount,
+            commit
+              ? (result.nodesResult?.created || 0) +
+                  (result.nodesResult?.updated || 0)
+              : (result.nodesToMigrate?.[currentProject]
+                  .totalCount as number) || 0
           )
         );
         if (!commit) {
@@ -1965,13 +1987,14 @@ class ContensisCli {
       }
 
       const [err, result] = await contensis.MigrateNodes();
-      const migrateTree =
-        contensis.nodes.targetRepos[currentProject].nodes.migrateNodesTreeView;
 
       if (err) log.raw(``);
       else
         await this.HandleFormattingAndOutput(result, () => {
           // print the migrateResult to console
+          const migrateTree =
+            contensis.nodes.targetRepos[currentProject].nodes
+              .migrateNodesTreeView;
           printNodeTreeOutput(this, migrateTree, logOutput, logLimit);
           printNodesMigrateResult(this, result, {
             showAll: logOutput === 'all',

package/src/util/console.printer.ts

@@ -5,6 +5,7 @@ import { Logger, addNewLines } from './logger';
 import {
   BlockVersion,
   CopyFieldResult,
+  EntriesMigrationResult,
   EntriesResult,
   MigrateModelsResult,
   MigrateNodesTree,
@@ -116,8 +117,8 @@ export const printBlockVersion = (
 };
 
 export const printEntriesMigrateResult = (
-  { log, messages, currentProject }: ContensisCli,
-  migrateResult: EntriesResult | CopyFieldResult,
+  service: ContensisCli,
+  migrateResult: EntriesMigrationResult | EntriesResult | CopyFieldResult,
   {
     action = 'import',
     showDiff = false,
@@ -131,7 +132,7 @@ export const printEntriesMigrateResult = (
   } = {}
 ) => {
   console.log(``);
-
+  const { log, messages, currentProject } = service;
   for (const [contentTypeId, entryRes] of Object.entries(
     migrateResult.entriesToMigrate.entryIds
   ) as [string, any]) {
@@ -229,6 +230,14 @@ export const printEntriesMigrateResult = (
         ? log.successText
         : log.warningText;
 
+      if (isTotalCountRow && 'nodes' in migrateResult) {
+        printNodesMigrateResult(service, migrateResult, {
+          showAll,
+          showDiff,
+          showChanged,
+          isEntriesMigration: true,
+        });
+      }
       console.log(
         `  - ${
           isTotalCountRow
@@ -267,22 +276,24 @@ export const printEntriesMigrateResult = (
 
 export const printNodesMigrateResult = (
   { log, currentProject }: ContensisCli,
-  migrateResult: NodesResult,
+  migrateResult: EntriesMigrationResult | NodesResult,
   {
     action = 'import',
     logLimit = 50,
     showDiff = false,
     showAll = false,
     showChanged = false,
+    isEntriesMigration = false,
   }: {
     action?: 'import' | 'delete';
     logLimit?: number;
     showDiff?: boolean;
     showAll?: boolean;
     showChanged?: boolean;
+    isEntriesMigration?: boolean;
   } = {}
 ) => {
-  log.raw(``);
+  if (!isEntriesMigration) log.raw(``);
   for (const [projectId, counts] of Object.entries(migrateResult.nodes || {})) {
     const importTitle =
       action === 'delete'
@@ -292,14 +303,13 @@ export const printNodesMigrateResult = (
               ? `from project ${log.highlightText(projectId)} `
               : ''
           }to ${log.boldText(log.warningText(currentProject))}`;
-    log.help(importTitle);
+    if (!isEntriesMigration) log.help(importTitle);
 
     const migrateStatusAndCount = migrateResult.nodesToMigrate[
       currentProject
     ] as ProjectNodesToMigrate;
 
-    const existingCount =
-      migrateResult.existing?.[currentProject]?.totalCount || 0;
+    const existingCount = migrateResult.nodes?.[projectId]?.totalCount || 0;
 
     const totalCount = Object.keys(migrateResult.nodesToMigrate.nodeIds).length;
     const existingPercent = counts.totalCount
@@ -320,25 +330,28 @@ export const printNodesMigrateResult = (
     const changedColor =
       changedPercentage === '100' ? log.successText : log.warningText;
 
-    console.log(
-      `  - ${log.highlightText(
-        `totalCount: ${migrateStatusAndCount.totalCount}`
-      )}${
-        changedPercentage === '100'
-          ? ''
-          : existingColor(` [existing: ${`${existingPercent}%`}]`)
-      }${
-        existingPercent === '0'
-          ? ''
-          : changedColor(
-              ` ${
-                changedPercentage === '100'
-                  ? 'up to date'
-                  : `[needs update: ${100 - Number(changedPercentage)}%]`
-              }`
-            )
-      }`
-    );
+    if (!isEntriesMigration || migrateStatusAndCount.totalCount > 0)
+      console.log(
+        `  - ${log.highlightText(
+          `${isEntriesMigration ? '  + nodes' : 'totalCount'}: ${
+            migrateStatusAndCount.totalCount
+          }`
+        )}${
+          changedPercentage === '100'
+            ? ''
+            : existingColor(` [existing: ${`${existingPercent}%`}]`)
+        }${
+          existingPercent === '0'
+            ? ''
+            : changedColor(
+                ` ${
+                  changedPercentage === '100'
+                    ? 'up to date'
+                    : `[needs update: ${100 - Number(changedPercentage)}%]`
+                }`
+              )
+        }`
+      );
   }
   if (migrateResult.errors?.length) {
     console.log(
@@ -468,7 +481,7 @@ export const printModelMigrationResult = (
 
 export const printNodeTreeOutput = (
   { log, messages }: ContensisCli,
-  root: Node | MigrateNodesTree | undefined,
+  root: Node | Partial<MigrateNodesTree> | undefined,
   logDetail = 'errors',
   logLimit = 1000
 ) => {
@@ -496,7 +509,7 @@ export const printNodeTreeOutput = (
   log.line();
 
   const outputNode = (
-    node: Node | MigrateNodesTree,
+    node: Partial<Node | MigrateNodesTree>,
     spaces: string,
     isRoot = false
   ) => {
@@ -506,6 +519,7 @@ export const printNodeTreeOutput = (
     const changesOutput =
       logDetail === 'changes' &&
       'status' in node &&
+      node.status &&
       ['create', 'update'].includes(node.status);
 
     const diffOutput =
@@ -514,7 +528,7 @@ export const printNodeTreeOutput = (
       node.diff?.replaceAll('\n', '');
 
     return `${
-      'status' in node
+      'status' in node && node.status
         ? `${statusColour(node.status)(
             node.status.substring(0, 1).toUpperCase()
           )} `
@@ -531,8 +545,10 @@ export const printNodeTreeOutput = (
         : 'standardText'
     ](
       'isCanonical' in node && node.isCanonical
-        ? log.boldText(fullOutput || isRoot ? node.path : `/${node.slug}`)
-        : fullOutput || isRoot
+        ? log.boldText(
+            fullOutput || isRoot || !node.slug ? node.path : `/${node.slug}`
+          )
+        : fullOutput || isRoot || !node.slug
         ? node.path
         : `/${node.slug}`
     )}${node.entry ? ` ${log.helpText(node.entry.sys.contentTypeId)}` : ''}${
@@ -540,7 +556,7 @@ export const printNodeTreeOutput = (
     } ${'displayName' in node ? log.infoText(node.displayName) : ''}${
       fullOutput || (changesOutput && node.id !== node.originalId)
         ? `~n  ${log.infoText(`id:`)} ${
-            node.id === node.originalId
+            !('originalId' in node) || node.id === node.originalId
               ? node.id
               : `${node.id} ${log.infoText(`<= ${node.originalId}`)}`
           }`
@@ -551,6 +567,7 @@ export const printNodeTreeOutput = (
       node.parentId
         ? `~n  ${log.infoText(
             `parentId: ${
+              !('originalParentId' in node) ||
               node.parentId === node.originalParentId
                 ? node.parentId
                 : `${node.parentId} <= ${node.originalParentId}`
@@ -575,7 +592,10 @@ export const printNodeTreeOutput = (
     }`;
   };
 
-  const outputChildren = (node: Node | undefined, depth = 2) => {
+  const outputChildren = (
+    node: Partial<Node | MigrateNodesTree> | undefined,
+    depth = 2
+  ) => {
     let str = '';
     for (const child of ((node as any)?.children || []) as Node[]) {
       str += `${outputNode(child, Array(depth + 1).join('  '))}\n`;

package/src/util/csv.formatter.ts

@@ -13,26 +13,42 @@ export const csvFormatter = async <T>(entries: T | T[]) => {
 
   // Parse the flattened object to csv
   // const csv = stringify(flatEntries, { header: true });
+  // Create an exhaustive list of columns from the entries array
+  const columns = new Set<string>(flatEntries.map(e => Object.keys(e)).flat());
   const csv = await new Promise<string>((resolve, reject) => {
-    stringify(flatEntries, { header: true }, (err, data) => {
-      if (err) reject(err);
-      resolve(data);
-    });
+    stringify(
+      flatEntries,
+      {
+        header: true,
+        cast: { boolean: (value, context) => `${value}` },
+        columns: [...columns],
+      },
+      (err, data) => {
+        if (err) reject(err);
+        resolve(data);
+      }
+    );
   });
   return csv;
 };
 
 export const csvToJson = async <T = any>(data: string): Promise<T[]> => {
-  // return parse(data, {
-  //   columns: true,
-  //   skip_empty_lines: true,
-  // });
   return new Promise((resolve, reject) => {
     parse(
       data,
       {
         columns: true,
         skip_empty_lines: true,
+        cast: (value, context) => {
+          if (context.header || context.column === 'sys.version.versionNo')
+            return value;
+          if (value === '') return undefined;
+          try {
+            return JSON.parse(value);
+          } catch (e) {
+            return value;
+          }
+        },
       },
       (err, records) => {
         if (err) reject(err);

package/src/util/json.formatter.ts

@@ -7,11 +7,13 @@ export const jsonFormatter = <T>(obj: T, fields?: string[]) =>
 
 // Flatten a JSON object such as an entry so there are no
 // nested object and the keys are presented like "sys.version.versionNo": "1.0"
-export const flattenObject = (obj: any) => flatten(cleaner(obj, ['workflow']));
+export const flattenObject = (obj: any) =>
+  flatten(cleaner(obj, ['workflow']), { maxDepth: 99 });
 
 // Unflatten a JSON object such as an entry so the arrays and
 // nested objects are reconstructed - the opposite of flattenObject
-export const unflattenObject = (obj: any) => unflatten(obj);
+export const unflattenObject = (obj: any) =>
+  unflatten(obj, { overwrite: true });
 
 // Will limit and sort an object's keys by an array of supplied fields
 export const limitFields = (obj: any, fields?: string[]): any => {

package/src/version.ts

@@ -1 +1 @@
-export const LIB_VERSION = "1.2.2-beta.0";
+export const LIB_VERSION = "1.2.2-beta.10";