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

package/src/services/ContensisCliService.ts

@@ -28,17 +28,17 @@ import {
 import ContensisAuthService from './ContensisAuthService';
 
 import { LogMessages } from '~/localisation/en-GB';
+import { MixedFileData } from '~/mappers/MixedFileData';
 import {
   CliUrls,
   OutputFormat,
   OutputOptionsConstructorArg,
 } from '~/models/CliService';
 
-import { readFileAsJSON } from '~/providers/file-provider';
 import SessionCacheProvider from '../providers/SessionCacheProvider';
 import CredentialProvider from '~/providers/CredentialProvider';
 
-import { splitTagsAndGroups, url } from '~/util';
+import { url } from '~/util';
 import { sanitiseIds } from '~/util/api-ids';
 import {
   isPassword,
@@ -67,16 +67,6 @@ import { promiseDelay } from '~/util/timers';
 import { GetTagsArgs } from 'migratortron/dist/services/TagsMigrationService';
 import { GetTagGroupsArgs } from 'migratortron/dist/services/TagGroupsMigrationService';
 
-type ImportDataType =
-  | 'entries'
-  | 'contentTypes'
-  | 'components'
-  | 'models'
-  | 'nodes'
-  | 'tagGroups'
-  | 'tags'
-  | 'user-input';
-
 let insecurePasswordWarningShown = false;
 
 class ContensisCli {
@@ -167,8 +157,11 @@ class ContensisCli {
     }
 
     this.format = outputOpts?.format;
-    this.output =
-      outputOpts?.output && path.join(process.cwd(), outputOpts.output);
+    this.output = outputOpts?.output
+      ? path.isAbsolute(outputOpts.output)
+        ? outputOpts.output
+        : path.join(process.cwd(), outputOpts.output)
+      : undefined;
 
     const currentEnvironment = outputOpts?.alias || this.currentEnv;
     const environments = this.cache.environments || {};
@@ -341,27 +334,21 @@ class ContensisCli {
 
   ConnectContensisImport = async ({
     commit = false,
+    noSource = false,
     fromFile,
-    importDataType,
     importData,
-    mixedData,
   }: {
     commit?: boolean;
+    noSource?: boolean;
     fromFile?: string;
-    importDataType?: ImportDataType;
-    importData?: any[];
-    mixedData?: {
-      [K in ImportDataType]?: any[];
-    };
+    importData?: MixedFileData;
   }) => {
-    const source: 'contensis' | 'file' =
-      fromFile || importData || mixedData ? 'file' : 'contensis';
+    const source: 'contensis' | 'user-input' =
+      fromFile || importData || noSource ? 'user-input' : 'contensis';
 
-    const fileData =
-      importData || (fromFile ? (await readFileAsJSON(fromFile)) || [] : []);
-
-    if (typeof fileData === 'string')
-      throw new Error(`Import file format must be of type JSON`);
+    const mixedData = fromFile
+      ? await new MixedFileData().readFile(fromFile)
+      : importData;
 
     const { contensisOpts, currentEnv, env, log, messages, sourceAlias } = this;
     const environments = this.cache.environments || {};
@@ -402,7 +389,7 @@ class ContensisCli {
       const cachedTargetPassword = targetCredentials?.current?.password;
 
       if (cachedSourcePassword && cachedTargetPassword) {
-        if (source === 'file' || importDataType === 'user-input') {
+        if (source === 'user-input') {
           this.contensis = new ContensisMigrationService(
             {
               concurrency: 2,
@@ -417,7 +404,6 @@ class ContensisCli {
                 targetProjects: [env.currentProject || ''],
                 assetHostname: this.urls?.previewWeb,
               },
-              ...(importDataType ? { [importDataType]: fileData } : {}),
               ...(mixedData || {}),
             },
             !commit
@@ -1172,14 +1158,17 @@ class ContensisCli {
   }) => {
     const { currentEnv, currentProject, log, messages } = this;
 
+    let importData;
+    if (tags) {
+      importData = new MixedFileData();
+      importData.tags = tags;
+      importData.tagGroups = data || [];
+    }
+
     const contensis = await this.ConnectContensisImport({
       commit,
       fromFile,
-      importDataType: tags ? 'user-input' : 'tagGroups',
-      mixedData: {
-        tagGroups: data,
-        tags: tags,
-      },
+      importData,
     });
 
     if (contensis) {
@@ -1301,10 +1290,7 @@ class ContensisCli {
       });
 
       if (Array.isArray(result)) {
-        let tags: ICreateTag[] = [];
-        const groups: ICreateTagGroup[] = [];
-        if (withDependents) splitTagsAndGroups(result, tags, groups);
-        else tags = result;
+        const { tags, tagGroups } = new MixedFileData(result);
 
         log.success(messages.tags.list(currentEnv, tags.length));
 
@@ -1315,11 +1301,13 @@ class ContensisCli {
               log.raw('');
               log.object(tag);
             }
-            if (groups.length) {
+            if (tagGroups.length) {
               log.raw('');
-              log.success(messages.taggroups.list(currentEnv, groups.length));
+              log.success(
+                messages.taggroups.list(currentEnv, tagGroups.length)
+              );
 
-              for (const group of groups) {
+              for (const group of tagGroups) {
                 log.raw('');
                 log.object(group);
               }
@@ -1343,25 +1331,22 @@ class ContensisCli {
       });
 
       if (Array.isArray(result)) {
-        let tags: Tag[] = [];
-        const groups: TagGroup[] = [];
-        if (withDependents) splitTagsAndGroups(result, tags, groups);
-        else tags = result;
+        const { tags, tagGroups } = new MixedFileData(result);
         log.success(messages.tags.list(currentEnv, tags.length));
 
         if (!tags.length) log.help(messages.tags.noneExist());
 
         await this.HandleFormattingAndOutput(result, () => {
           // print the tags to console
-          for (const { version, ...tag } of tags) {
+          for (const { version, ...tag } of tags as Tag[]) {
             log.raw('');
             log.object(tag);
           }
-          if (groups.length) {
+          if (tagGroups.length) {
             log.raw('');
-            log.success(messages.taggroups.list(currentEnv, groups.length));
+            log.success(messages.taggroups.list(currentEnv, tagGroups.length));
 
-            for (const { version, ...group } of groups) {
+            for (const { version, ...group } of tagGroups as TagGroup[]) {
               log.raw('');
               log.object(group);
             }
@@ -1388,30 +1373,23 @@ class ContensisCli {
   }) => {
     const { currentEnv, currentProject, log, messages } = this;
 
-    const mixedData: {
-      tags: ICreateTag[];
-      tagGroups: ICreateTagGroup[];
-    } = { tags: [], tagGroups: [] };
+    let importData;
 
     if (data) {
-      mixedData.tags = data;
-      mixedData.tagGroups = [...new Set(data.map(t => t.groupId))].map(
+      importData = new MixedFileData();
+      importData.tags = data;
+      importData.tagGroups = [...new Set(data.map(t => t.groupId))].map(
         id =>
           ({
             id,
           }) as ICreateTagGroup
       );
     }
-    if (fromFile) {
-      // File may contain mix of tags and tag groups, separate those here
-      const fileData = fromFile ? (await readFileAsJSON(fromFile)) || [] : [];
-      splitTagsAndGroups(fileData, mixedData.tags, mixedData.tagGroups);
-    }
 
     const contensis = await this.ConnectContensisImport({
       commit,
-      importDataType: 'tags',
-      mixedData,
+      fromFile,
+      importData,
     });
 
     if (contensis) {
@@ -1460,13 +1438,22 @@ class ContensisCli {
           log.help(messages.migrate.commitTip());
         }
       } else {
-        log.error(
-          messages.tags.failedCreate(
-            currentEnv,
-            data?.length === 1 ? data?.[0].label['en-GB'] : undefined
-          ),
-          err
-        );
+        const noChanges =
+          result?.tagsToMigrate?.[currentProject]?.['no change'] &&
+          result?.tagsToMigrate?.[currentProject].totalCount === 0 &&
+          result?.groupsToMigrate?.[currentProject].totalCount === 0;
+
+        if (noChanges && !err && !result.errors?.length) {
+          log.help(messages.tags.noChange(currentEnv));
+        } else {
+          log.error(
+            messages.tags.failedCreate(
+              currentEnv,
+              data?.length === 1 ? data?.[0].label['en-GB'] : undefined
+            ),
+            err
+          );
+        }
       }
     } else {
       log.warning(messages.models.noList(currentProject));
@@ -1480,7 +1467,7 @@ class ContensisCli {
     this.contensisOpts.concurrency = 1;
     const contensis = await this.ConnectContensisImport({
       commit,
-      importDataType: 'user-input', // 'user-input' import type does not require a source cms
+      noSource: true,
     });
     if (contensis) {
       log.line();
@@ -1681,6 +1668,7 @@ class ContensisCli {
       const models = await contensis.models.contentModels();
       const contentTypes = await contensis.models.contentTypes();
       const components = await contensis.models.components();
+      const tagGroups = await contensis.models.tagGroups();
 
       // Models to output to console
       const returnModels = modelIds?.length
@@ -1688,11 +1676,11 @@ class ContensisCli {
             modelIds.some(id => id.toLowerCase() === m.id.toLowerCase())
           )
         : undefined;
-      const exportResources: (ContentType | Component)[] = [];
+      const exportResources: (ContentType | Component | TagGroup)[] = [];
 
       if (opts.export) {
-        // Generate a list of contentTypeIds and componentIds from all models
-        // and dependencies
+        // Generate a list of contentTypeIds, componentIds and tagGroupIds from all models
+        // and their dependencies
         const contentTypeIds = Array.from(
           new Set([
             ...(returnModels || models || []).map(m => m.id),
@@ -1708,9 +1696,16 @@ class ContensisCli {
               .flat()
           )
         );
+        const tagGroupIds = Array.from(
+          new Set(
+            (returnModels || models || [])
+              .map(m => m.dependencies?.tagGroups?.map(g => g[0]) || [])
+              .flat()
+          )
+        );
 
-        // Create an array of all the content types and component definitions
-        // we will use this when outputting to a file
+        // Create an array of all the content types, component and tag group
+        // definitions, we will use this when outputting to a file
         exportResources.push(
           ...contentTypes.filter(c =>
             contentTypeIds
@@ -1719,6 +1714,9 @@ class ContensisCli {
           ),
           ...components.filter(c =>
             componentIds.map(i => i.toLowerCase()).includes(c.id.toLowerCase())
+          ),
+          ...tagGroups.filter(g =>
+            tagGroupIds.map(i => i.toLowerCase()).includes(g.id.toLowerCase())
           )
         );
       }
@@ -1760,17 +1758,23 @@ class ContensisCli {
               for (const model of models) {
                 const components = model.components?.length || 0;
                 const contentTypes = model.contentTypes?.length || 0;
+                const tagGroups = model.tagGroups?.length || 0;
                 const defaults =
                   (model.defaults?.length || 0) + (model.nodes?.length || 0);
                 const dependencies =
                   (model.dependencies?.components?.length || 0) +
-                  (model.dependencies?.contentTypes?.length || 0);
+                  (model.dependencies?.contentTypes?.length || 0) +
+                  (model.dependencies?.tagGroups?.length || 0);
                 const dependencyOf =
                   (model.dependencyOf?.components?.length || 0) +
                   (model.dependencyOf?.contentTypes?.length || 0);
 
                 const hasAny =
-                  components + contentTypes + dependencies + dependencyOf;
+                  components +
+                  contentTypes +
+                  tagGroups +
+                  dependencies +
+                  dependencyOf;
                 log.raw(
                   `  - ${log.highlightText(log.boldText(model.id))} ${
                     hasAny
@@ -1781,6 +1785,8 @@ class ContensisCli {
                             contentTypes
                               ? `contentTypes: ${contentTypes}, `
                               : ''
+                          }${
+                            tagGroups ? `tagGroups: ${tagGroups}, ` : ''
                           }${defaults ? `defaults: ${defaults}, ` : ''}${
                             dependencies ? `references: ${dependencies}, ` : ''
                           }${
@@ -1808,16 +1814,9 @@ class ContensisCli {
   }) => {
     const { currentProject, log, messages } = this;
 
-    const fileData = fromFile
-      ? (await readFileAsJSON<(ContentType | Component)[]>(fromFile)) || []
-      : [];
-    if (typeof fileData === 'string')
-      throw new Error(`Import file format must be of type JSON`);
-
     const contensis = await this.ConnectContensisImport({
       commit,
       fromFile,
-      importDataType: 'models',
     });
 
     if (contensis) {
@@ -1843,6 +1842,10 @@ class ContensisCli {
             if (!result.components) log.info(`- None returned\n`);
             else printModelMigrationAnalysis(this, result.components);
 
+            if (result.tagGroups && Object.keys(result.tagGroups).length) {
+              log.raw(log.boldText(`\nTag Groups:`));
+              printModelMigrationAnalysis(this, result.tagGroups);
+            }
             if (result.defaults && Object.keys(result.defaults).length) {
               log.raw(log.boldText(`\nDefaults:`));
               printModelMigrationAnalysis(this, result.defaults);
@@ -1874,6 +1877,17 @@ class ContensisCli {
                 modelsResult[currentProject].components
               );
             }
+            if (
+              Object.values(modelsResult[currentProject].tagGroups || {}).some(
+                r => r.length > 0
+              )
+            ) {
+              log.raw(log.boldText(`\nTag Groups:`));
+              printModelMigrationResult(
+                this,
+                modelsResult[currentProject].tagGroups
+              );
+            }
             if (
               Object.values(modelsResult[currentProject].defaults || {}).some(
                 r => r.length > 0
@@ -1958,7 +1972,7 @@ class ContensisCli {
     const { currentProject, log, messages } = this;
     const contensis = await this.ConnectContensisImport({
       commit,
-      importDataType: 'user-input', // 'user-input' import type does not require a source cms
+      noSource: true,
     });
     if (contensis) {
       const [err, result] = await contensis.DeleteContentTypes(contentTypeIds);
@@ -1981,6 +1995,7 @@ class ContensisCli {
         );
         // print the results to console
         await this.HandleFormattingAndOutput(result, log.object);
+        if (!commit) log.help(messages.migrate.commitTip());
       }
     }
   };
@@ -1997,23 +2012,18 @@ class ContensisCli {
   ) => {
     const { currentProject, log, messages } = this;
 
-    let fileData = fromFile
-      ? (await readFileAsJSON<ContentType[]>(fromFile)) || []
-      : [];
-    if (typeof fileData === 'string')
-      throw new Error(`Import file format must be of type JSON`);
-
-    if (!Array.isArray(fileData)) fileData = [fileData];
+    let importData;
+    if (fromFile) importData = await new MixedFileData().readFile(fromFile);
 
     const contensis = await this.ConnectContensisImport({
       commit,
-      importDataType: fromFile ? 'user-input' : undefined,
+      noSource: !!fromFile,
     });
 
     if (contensis) {
       if (fromFile)
         // Pass each content type to the target repo
-        for (const contentType of fileData) {
+        for (const contentType of importData.models) {
           // Fix invalid data
           contentType.projectId = currentProject;
           delete contentType.uuid;
@@ -2042,6 +2052,7 @@ class ContensisCli {
         );
         await this.HandleFormattingAndOutput(result, log.object);
       }
+      if (!commit) log.help(messages.migrate.commitTip());
     }
   };
 
@@ -2055,22 +2066,16 @@ class ContensisCli {
   ) => {
     const { log } = this;
 
-    let fileData = fromFile
-      ? (await readFileAsJSON<ContentType[]>(fromFile)) || []
-      : [];
-    if (typeof fileData === 'string')
-      throw new Error(`Import file format must be of type JSON`);
-
-    if (!Array.isArray(fileData)) fileData = [fileData];
+    let importData;
+    if (fromFile) importData = await new MixedFileData().readFile(fromFile);
 
-    const contensis = await this.ConnectContensisImport({
-      fromFile,
-      importDataType: 'models',
-    });
+    const contensis = await this.ConnectContensisImport({ fromFile });
 
     if (contensis) {
       const [err, result] = (await to(
-        contensis.models.Diff(fileData.length ? fileData : modelIds)
+        contensis.models.Diff(
+          importData.models.length ? importData.models : modelIds
+        )
       )) as [Error | null, ContentTypesResult | undefined];
 
       if (err) log.error(err.message, err);
@@ -2144,10 +2149,12 @@ class ContensisCli {
 
   RemoveComponents = async (componentIds: string[], commit = false) => {
     const { currentProject, log, messages } = this;
+
     const contensis = await this.ConnectContensisImport({
       commit,
-      importDataType: 'user-input', // 'user-input' import type does not require a source cms
+      noSource: true,
     });
+
     if (contensis) {
       const [err, result] = await contensis.DeleteContentTypes(
         undefined,
@@ -2172,6 +2179,8 @@ class ContensisCli {
         );
         // print the results to console
         await this.HandleFormattingAndOutput(result, log.object);
+
+        if (!commit) log.help(messages.migrate.commitTip());
       }
     }
   };
@@ -2188,23 +2197,18 @@ class ContensisCli {
   ) => {
     const { currentProject, log, messages } = this;
 
-    let fileData = fromFile
-      ? (await readFileAsJSON<Component[]>(fromFile)) || []
-      : [];
-    if (typeof fileData === 'string')
-      throw new Error(`Import file format must be of type JSON`);
-
-    if (!Array.isArray(fileData)) fileData = [fileData];
+    let importData;
+    if (fromFile) importData = await new MixedFileData().readFile(fromFile);
 
     const contensis = await this.ConnectContensisImport({
       commit,
-      importDataType: fromFile ? 'user-input' : undefined,
+      noSource: !!fromFile,
     });
 
     if (contensis) {
       // Pass each component to the target repo
       if (fromFile)
-        for (const component of fileData) {
+        for (const component of importData.models) {
           // Fix invalid data
           component.projectId = currentProject;
           delete component.uuid;
@@ -2233,6 +2237,7 @@ class ContensisCli {
         );
         await this.HandleFormattingAndOutput(result, log.object);
       }
+      if (!commit) log.help(messages.migrate.commitTip());
     }
   };
 
@@ -2242,7 +2247,7 @@ class ContensisCli {
     this.contensisOpts.concurrency = 1;
     const contensis = await this.ConnectContensisImport({
       commit,
-      importDataType: 'user-input', // 'user-input' import type does not require a source cms
+      noSource: true,
     });
 
     if (contensis) {
@@ -2332,11 +2337,13 @@ class ContensisCli {
   }) => {
     const { currentEnv, currentProject, log, messages } = this;
 
+    let importData;
+    if (data) importData = new MixedFileData(data);
+
     const contensis = await this.ConnectContensisImport({
       commit,
       fromFile,
-      importDataType: 'entries',
-      importData: data,
+      importData,
     });
 
     if (contensis) {
@@ -2351,13 +2358,16 @@ class ContensisCli {
 
       if (err) logError(err);
       else {
-        const { entries, nodes } = contensis.content.targets[currentProject];
+        const { entries, nodes, tags } =
+          contensis.content.targets[currentProject];
 
         const output = saveEntries
-          ? // include entries and dependent nodes when saving entries
+          ? // include entries and dependent nodes (or tags) when saving entries
             [
               entries.migrate?.map(me => me.toJSON()) || [],
               nodes.migrateNodes.map(mn => mn.node),
+              tags.migrateTags.map(mt => mt.toJSON()),
+              tags.migrateGroups.map(mg => mg.toJSON()),
             ].flat()
           : result;
         await this.HandleFormattingAndOutput(output, () => {
@@ -2401,7 +2411,12 @@ class ContensisCli {
               ? (result.nodesResult?.created || 0) +
                   (result.nodesResult?.updated || 0)
               : (result.nodesToMigrate?.[currentProject]
-                  .totalCount as number) || 0
+                  .totalCount as number) || 0,
+            commit
+              ? (result.tagsResult?.created || 0) +
+                  (result.tagsResult?.updated || 0)
+              : (result.tagsToMigrate?.[currentProject].totalCount as number) ||
+                  0
           )
         );
         if (!commit) {
@@ -2409,9 +2424,25 @@ class ContensisCli {
           log.help(messages.migrate.commitTip());
         }
       } else {
-        log.error(messages.entries.failedImport(currentEnv), err);
-        if (!result?.entriesToMigrate?.[currentProject]?.totalCount)
-          log.help(messages.entries.notFound(currentEnv));
+        const noChanges =
+          Object.values(result?.entriesToMigrate?.[currentProject] || {}).every(
+            status =>
+              typeof status === 'number' || (status['no change'] || 0) > 0
+          ) && result?.entriesToMigrate?.[currentProject].totalCount === 0;
+
+        if (
+          noChanges &&
+          !err &&
+          !result?.migrateResult?.errors &&
+          !result?.nodesResult?.errors &&
+          !result?.tagsResult?.errors
+        ) {
+          log.help(messages.entries.noChange(currentEnv));
+        } 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));
@@ -2435,7 +2466,6 @@ class ContensisCli {
     const contensis = await this.ConnectContensisImport({
       commit,
       fromFile,
-      importDataType: 'entries',
     });
 
     if (contensis) {
@@ -2516,7 +2546,6 @@ class ContensisCli {
     const contensis = await this.ConnectContensisImport({
       commit,
       fromFile,
-      importDataType: 'entries',
     });
 
     if (contensis) {
@@ -2623,7 +2652,6 @@ class ContensisCli {
     const contensis = await this.ConnectContensisImport({
       commit,
       fromFile,
-      importDataType: 'nodes',
     });
 
     if (contensis) {
@@ -2698,7 +2726,7 @@ class ContensisCli {
     const { currentEnv, currentProject, log, messages } = this;
     const contensis = await this.ConnectContensisImport({
       commit,
-      importDataType: 'user-input', // 'user-input' import type does not require a source cms
+      noSource: true,
     });
 
     if (contensis) {

package/src/util/console.printer.ts

@@ -140,14 +140,14 @@ export const printEntriesMigrateResult = (
       string,
       any,
     ][]) {
+      const projectStatus = Object.entries(
+        Object.entries(entryStatus[currentProject])[0]
+      )[1][1] as any;
       if (
         showAll ||
         (showChanged &&
-          (
-            Object.entries(
-              Object.entries(entryStatus[currentProject])[0]
-            )[1][1] as any
-          ).status !== 'no change')
+          projectStatus.status !== 'no change' &&
+          projectStatus.status !== 'ignore')
       ) {
         console.log(
           log.infoText(
@@ -215,7 +215,8 @@ export const printEntriesMigrateResult = (
       const existingPercent = ((existingCount / count) * 100).toFixed(0);
       const noChangeOrTotalEntriesCount =
         typeof migrateStatusAndCount !== 'number'
-          ? migrateStatusAndCount?.['no change'] || 0
+          ? (migrateStatusAndCount?.['no change'] || 0) +
+            (migrateStatusAndCount?.['ignore'] || 0)
           : migrateStatusAndCount;
 
       const changedPercentage = (
@@ -273,8 +274,8 @@ export const printEntriesMigrateResult = (
     console.log(
       `  - ${log.errorText(`errors: ${migrateResult.errors.length}`)}\n`
     );
-    for (const error of migrateResult.errors)
-      log.error(error.message, null, '');
+    // for (const error of migrateResult.errors)
+    //   log.error(error.message, null, '');
   }
 };
 
@@ -434,7 +435,7 @@ export const printModelMigrationAnalysis = (
             )}`;
           if (projectDetails.error)
             errorOutput += `      ${log.highlightText(
-              `error::`
+              `error:`
             )} ${log.errorText(projectDetails.error)}`;
         }
       }