contensis-cli 1.5.1-beta.5 → 1.5.1-beta.6

package/dist/util/index.js

@@ -29,6 +29,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var util_exports = {};
 __export(util_exports, {
   Logging: () => Logging,
+  splitTagGroupsInModels: () => splitTagGroupsInModels,
   splitTagsAndGroups: () => splitTagsAndGroups,
   url: () => url
 });
@@ -70,9 +71,18 @@ const splitTagsAndGroups = (tagsAndGroups = [], tags = [], groups = []) => {
     }
   }
 };
+const splitTagGroupsInModels = (mixedData = [], models = [], groups = []) => {
+  for (const item of mixedData) {
+    if ((0, import_lodash.isObject)(item) && "id" in item) {
+      if (!("dataFormat" in item)) groups.push(item);
+      else models.push(item);
+    }
+  }
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   Logging,
+  splitTagGroupsInModels,
   splitTagsAndGroups,
   url
 });

package/dist/util/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/util/index.ts"],
-  "sourcesContent": ["import { ICreateTag, ICreateTagGroup } from 'contensis-management-api';\nimport mergeWith from 'lodash/mergeWith';\nimport { Logger } from './logger';\nimport { LogMessages as enGB } from '../localisation/en-GB.js';\nimport { isObject } from 'lodash';\n\nexport const url = (alias: string, project: string) => {\n  const projectAndAlias =\n    project && project.toLowerCase() !== 'website'\n      ? `${project.toLowerCase()}-${alias}`\n      : alias;\n  return {\n    api: `https://api-${alias}.cloud.contensis.com`,\n    cms: `https://cms-${alias}.cloud.contensis.com`,\n    liveWeb: `https://live-${projectAndAlias}.cloud.contensis.com`,\n    previewWeb: `https://preview-${projectAndAlias}.cloud.contensis.com`,\n    iisWeb: `https://iis-live-${projectAndAlias}.cloud.contensis.com`,\n    iisPreviewWeb: `https://iis-preview-${projectAndAlias}.cloud.contensis.com`,\n  };\n};\n\nexport const Logging = async (language = 'en-GB') => {\n  const defaultMessages = enGB;\n  // const { LogMessages: defaultMessages } = await import(\n  //   `../localisation/en-GB.js`\n  // );\n  const localisedMessages = defaultMessages;\n\n  if (language === 'en-GB') {\n    // Using a variable import e.g. `import(`../localisation/${language}.js`);`\n    // does not play well with packaged executables\n    // So we have to hard code the import for each language individually\n  }\n  return {\n    messages: mergeWith(\n      localisedMessages,\n      defaultMessages,\n      (v, s) => v || s\n    ) as typeof defaultMessages,\n    Log: Logger,\n  };\n};\n\nexport const splitTagsAndGroups = (\n  tagsAndGroups: unknown[] = [],\n  tags: ICreateTag[] = [],\n  groups: ICreateTagGroup[] = []\n) => {\n  for (const item of tagsAndGroups) {\n    if (isObject(item) && 'id' in item) {\n      if ('name' in item) groups.push(item as ICreateTagGroup);\n      else tags.push(item as ICreateTag);\n    }\n  }\n};\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,uBAAsB;AACtB,oBAAuB;AACvB,mBAAoC;AACpC,oBAAyB;AAElB,MAAM,MAAM,CAAC,OAAe,YAAoB;AACrD,QAAM,kBACJ,WAAW,QAAQ,YAAY,MAAM,YACjC,GAAG,QAAQ,YAAY,CAAC,IAAI,KAAK,KACjC;AACN,SAAO;AAAA,IACL,KAAK,eAAe,KAAK;AAAA,IACzB,KAAK,eAAe,KAAK;AAAA,IACzB,SAAS,gBAAgB,eAAe;AAAA,IACxC,YAAY,mBAAmB,eAAe;AAAA,IAC9C,QAAQ,oBAAoB,eAAe;AAAA,IAC3C,eAAe,uBAAuB,eAAe;AAAA,EACvD;AACF;AAEO,MAAM,UAAU,OAAO,WAAW,YAAY;AACnD,QAAM,kBAAkB,aAAAA;AAIxB,QAAM,oBAAoB;AAE1B,MAAI,aAAa,SAAS;AAAA,EAI1B;AACA,SAAO;AAAA,IACL,cAAU,iBAAAC;AAAA,MACR;AAAA,MACA;AAAA,MACA,CAAC,GAAG,MAAM,KAAK;AAAA,IACjB;AAAA,IACA,KAAK;AAAA,EACP;AACF;AAEO,MAAM,qBAAqB,CAChC,gBAA2B,CAAC,GAC5B,OAAqB,CAAC,GACtB,SAA4B,CAAC,MAC1B;AACH,aAAW,QAAQ,eAAe;AAChC,YAAI,wBAAS,IAAI,KAAK,QAAQ,MAAM;AAClC,UAAI,UAAU,KAAM,QAAO,KAAK,IAAuB;AAAA,UAClD,MAAK,KAAK,IAAkB;AAAA,IACnC;AAAA,EACF;AACF;",
+  "sourcesContent": ["import { ContentType, Component } from 'contensis-core-api';\nimport { ICreateTag, ICreateTagGroup } from 'contensis-management-api';\nimport mergeWith from 'lodash/mergeWith';\nimport { Logger } from './logger';\nimport { LogMessages as enGB } from '../localisation/en-GB.js';\nimport { isObject } from 'lodash';\n\nexport const url = (alias: string, project: string) => {\n  const projectAndAlias =\n    project && project.toLowerCase() !== 'website'\n      ? `${project.toLowerCase()}-${alias}`\n      : alias;\n  return {\n    api: `https://api-${alias}.cloud.contensis.com`,\n    cms: `https://cms-${alias}.cloud.contensis.com`,\n    liveWeb: `https://live-${projectAndAlias}.cloud.contensis.com`,\n    previewWeb: `https://preview-${projectAndAlias}.cloud.contensis.com`,\n    iisWeb: `https://iis-live-${projectAndAlias}.cloud.contensis.com`,\n    iisPreviewWeb: `https://iis-preview-${projectAndAlias}.cloud.contensis.com`,\n  };\n};\n\nexport const Logging = async (language = 'en-GB') => {\n  const defaultMessages = enGB;\n  // const { LogMessages: defaultMessages } = await import(\n  //   `../localisation/en-GB.js`\n  // );\n  const localisedMessages = defaultMessages;\n\n  if (language === 'en-GB') {\n    // Using a variable import e.g. `import(`../localisation/${language}.js`);`\n    // does not play well with packaged executables\n    // So we have to hard code the import for each language individually\n  }\n  return {\n    messages: mergeWith(\n      localisedMessages,\n      defaultMessages,\n      (v, s) => v || s\n    ) as typeof defaultMessages,\n    Log: Logger,\n  };\n};\n\nexport const splitTagsAndGroups = (\n  tagsAndGroups: unknown[] = [],\n  tags: ICreateTag[] = [],\n  groups: ICreateTagGroup[] = []\n) => {\n  for (const item of tagsAndGroups) {\n    if (isObject(item) && 'id' in item) {\n      if ('name' in item) groups.push(item as ICreateTagGroup);\n      else tags.push(item as ICreateTag);\n    }\n  }\n};\n\nexport const splitTagGroupsInModels = (\n  mixedData: unknown[] = [],\n  models: (ContentType | Component)[] = [],\n  groups: ICreateTagGroup[] = []\n) => {\n  for (const item of mixedData) {\n    if (isObject(item) && 'id' in item) {\n      if (!('dataFormat' in item)) groups.push(item as ICreateTagGroup);\n      else models.push(item as ContentType | Component);\n    }\n  }\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAEA,uBAAsB;AACtB,oBAAuB;AACvB,mBAAoC;AACpC,oBAAyB;AAElB,MAAM,MAAM,CAAC,OAAe,YAAoB;AACrD,QAAM,kBACJ,WAAW,QAAQ,YAAY,MAAM,YACjC,GAAG,QAAQ,YAAY,CAAC,IAAI,KAAK,KACjC;AACN,SAAO;AAAA,IACL,KAAK,eAAe,KAAK;AAAA,IACzB,KAAK,eAAe,KAAK;AAAA,IACzB,SAAS,gBAAgB,eAAe;AAAA,IACxC,YAAY,mBAAmB,eAAe;AAAA,IAC9C,QAAQ,oBAAoB,eAAe;AAAA,IAC3C,eAAe,uBAAuB,eAAe;AAAA,EACvD;AACF;AAEO,MAAM,UAAU,OAAO,WAAW,YAAY;AACnD,QAAM,kBAAkB,aAAAA;AAIxB,QAAM,oBAAoB;AAE1B,MAAI,aAAa,SAAS;AAAA,EAI1B;AACA,SAAO;AAAA,IACL,cAAU,iBAAAC;AAAA,MACR;AAAA,MACA;AAAA,MACA,CAAC,GAAG,MAAM,KAAK;AAAA,IACjB;AAAA,IACA,KAAK;AAAA,EACP;AACF;AAEO,MAAM,qBAAqB,CAChC,gBAA2B,CAAC,GAC5B,OAAqB,CAAC,GACtB,SAA4B,CAAC,MAC1B;AACH,aAAW,QAAQ,eAAe;AAChC,YAAI,wBAAS,IAAI,KAAK,QAAQ,MAAM;AAClC,UAAI,UAAU,KAAM,QAAO,KAAK,IAAuB;AAAA,UAClD,MAAK,KAAK,IAAkB;AAAA,IACnC;AAAA,EACF;AACF;AAEO,MAAM,yBAAyB,CACpC,YAAuB,CAAC,GACxB,SAAsC,CAAC,GACvC,SAA4B,CAAC,MAC1B;AACH,aAAW,QAAQ,WAAW;AAC5B,YAAI,wBAAS,IAAI,KAAK,QAAQ,MAAM;AAClC,UAAI,EAAE,gBAAgB,MAAO,QAAO,KAAK,IAAuB;AAAA,UAC3D,QAAO,KAAK,IAA+B;AAAA,IAClD;AAAA,EACF;AACF;",
   "names": ["enGB", "mergeWith"]
 }

package/dist/version.js

@@ -21,7 +21,7 @@ __export(version_exports, {
   LIB_VERSION: () => LIB_VERSION
 });
 module.exports = __toCommonJS(version_exports);
-const LIB_VERSION = "1.5.1-beta.5";
+const LIB_VERSION = "1.5.1-beta.6";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   LIB_VERSION

package/dist/version.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/version.ts"],
-  "sourcesContent": ["export const LIB_VERSION = \"1.5.1-beta.5\";\n"],
+  "sourcesContent": ["export const LIB_VERSION = \"1.5.1-beta.6\";\n"],
   "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAO,MAAM,cAAc;",
   "names": []
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "contensis-cli",
-  "version": "1.5.1-beta.5",
+  "version": "1.5.1-beta.6",
   "description": "A fully featured Contensis command line interface with a shell UI provides simple and intuitive ways to manage or profile your content in any NodeJS terminal.",
   "repository": "https://github.com/contensis/cli",
   "homepage": "https://github.com/contensis/cli/tree/main/packages/contensis-cli#readme",

package/src/localisation/en-GB.ts

@@ -246,6 +246,7 @@ export const LogMessages = {
       `[${env}] ${commit ? `Deleted` : `Will delete`} entries`,
     failedRemove: (env: string) => `[${env}] Unable to delete entries`,
     notFound: (env: string) => `[${env}] Entries were not found`,
+    noChange: (env: string) => `[${env}] No changes to be made`,
   },
   keys: {
     list: (env: string) => `[${env}] API keys:`,
@@ -396,6 +397,7 @@ export const LogMessages = {
       }`,
     failedRemove: (env: string, length: number) =>
       `[${env}] Unable to delete tags with ${pl('error', length)}`,
+    noChange: (env: string) => `[${env}] No changes to be made`,
   },
   blocks: {
     runningStatus: (status: BlockRunningStatus | 'broken') => {

package/src/services/ContensisCliService.ts

@@ -38,7 +38,7 @@ import { readFileAsJSON } from '~/providers/file-provider';
 import SessionCacheProvider from '../providers/SessionCacheProvider';
 import CredentialProvider from '~/providers/CredentialProvider';
 
-import { splitTagsAndGroups, url } from '~/util';
+import { splitTagGroupsInModels, splitTagsAndGroups, url } from '~/util';
 import { sanitiseIds } from '~/util/api-ids';
 import {
   isPassword,
@@ -167,8 +167,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 || {};
@@ -1460,13 +1463,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));
@@ -1681,6 +1693,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 +1701,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 +1721,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 +1739,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 +1783,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 +1810,8 @@ class ContensisCli {
                             contentTypes
                               ? `contentTypes: ${contentTypes}, `
                               : ''
+                          }${
+                            tagGroups ? `tagGroups: ${tagGroups}, ` : ''
                           }${defaults ? `defaults: ${defaults}, ` : ''}${
                             dependencies ? `references: ${dependencies}, ` : ''
                           }${
@@ -1808,16 +1839,25 @@ 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 mixedData: {
+      models: (ContentType | Component)[];
+      tagGroups: ICreateTagGroup[];
+    } = { models: [], tagGroups: [] };
+
+    if (fromFile) {
+      // File may contain mix of content types, components and tag groups, separate those here
+      const fileData = fromFile ? (await readFileAsJSON(fromFile)) || [] : [];
+      splitTagGroupsInModels(fileData, mixedData.models, mixedData.tagGroups);
+    }
+    // const fileData = fromFile
+    //   ? (await readFileAsJSON<(ContentType | Component | TagGroup)[]>(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',
+      mixedData,
     });
 
     if (contensis) {
@@ -1843,6 +1883,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 +1918,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
@@ -2409,9 +2464,24 @@ 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
+        ) {
+          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));

package/src/util/index.ts

@@ -1,3 +1,4 @@
+import { ContentType, Component } from 'contensis-core-api';
 import { ICreateTag, ICreateTagGroup } from 'contensis-management-api';
 import mergeWith from 'lodash/mergeWith';
 import { Logger } from './logger';
@@ -53,3 +54,16 @@ export const splitTagsAndGroups = (
     }
   }
 };
+
+export const splitTagGroupsInModels = (
+  mixedData: unknown[] = [],
+  models: (ContentType | Component)[] = [],
+  groups: ICreateTagGroup[] = []
+) => {
+  for (const item of mixedData) {
+    if (isObject(item) && 'id' in item) {
+      if (!('dataFormat' in item)) groups.push(item as ICreateTagGroup);
+      else models.push(item as ContentType | Component);
+    }
+  }
+};

package/src/version.ts

@@ -1 +1 @@
-export const LIB_VERSION = "1.5.1-beta.5";
+export const LIB_VERSION = "1.5.1-beta.6";