contensis-cli 1.4.1 → 1.4.2-beta.0

package/src/commands/create.ts

@@ -1,7 +1,9 @@
 import { Command } from 'commander';
 import { Project } from 'contensis-core-api';
+import { addGlobalOptions, commit } from './globalOptions';
 import { cliCommand } from '~/services/ContensisCliService';
 import { shell } from '~/shell';
+import { toApiId } from '~/util/api-ids';
 
 export const makeCreateCommand = () => {
   const create = new Command()
@@ -9,6 +11,7 @@ export const makeCreateCommand = () => {
     .description('create command')
     .addHelpText('after', `\n`)
     .showHelpAfterError(true)
+    .enablePositionalOptions()
     .exitOverride();
 
   create
@@ -38,6 +41,7 @@ export const makeCreateCommand = () => {
           description,
           primaryLanguage: opts.language,
           supportedLanguages: opts.supportedLanguages || [],
+          deliverySysExclusions: [],
         };
 
         const project = await cliCommand(
@@ -89,5 +93,119 @@ Example call:
       });
     });
 
+  create
+    .command('taggroup')
+    .description('create a new tag group')
+    .argument('<groupId>', 'the API id of the tag group to create')
+    .argument('<"Name">', 'the name of the tag group to create')
+    .argument('["Description"]', 'a description for the tag group')
+    .option(
+      '--tags <tagNames...>',
+      'a list of tag names to create under the new tag group'
+    )
+    .addOption(commit)
+    .addHelpText(
+      'after',
+      `
+  Example call:
+    > create taggroup example "Example tags" "This group is a test" 
+    > create taggroup topics "Topics" --tags Books Faces History Places Spelling \n`
+    )
+    .action(
+      async (groupId: string, name: string, description: string, opts) => {
+        const tagGroup = {
+          id: groupId,
+          name,
+          description,
+        };
+
+        await cliCommand(
+          ['create', 'taggroup', groupId, name],
+          opts
+        ).ImportTagGroups({
+          commit: opts.commit,
+          data: [tagGroup],
+          tags: opts.tags?.map((label: string) => ({
+            groupId,
+            label: { 'en-GB': label },
+            value: toApiId(label, 'camelCase', true),
+          })),
+        });
+      }
+    );
+
+  const tags = create
+    .command('tags')
+    .description('create new tags in a tag group')
+    .argument('<"Label"...>', 'create tag(s) with label(s)')
+    .passThroughOptions()
+    .option('-in --group <groupId>', 'create tags in this tag group')
+    .addOption(commit)
+    .addHelpText(
+      'after',
+      `
+    Example call:
+      > create tags "Test tag" --group example
+      > create tags Books Faces History Places Spelling -in topics \n`
+    )
+    .action(async (tagLabels: string[], opts) => {
+      const groupId = opts.group;
+      const cli = cliCommand(['create', 'tags', ...tagLabels], opts);
+
+      const language =
+        cli.env.projects.find(p => p.id === cli.env.currentProject)
+          ?.primaryLanguage || 'en-GB';
+
+      await cli.ImportTags({
+        commit: opts.commit,
+        data: tagLabels.map(label => ({
+          groupId,
+          label: { [language]: label },
+          value: toApiId(label, 'camelCase', true),
+        })),
+      });
+    });
+
+  tags
+    .command('in')
+    .description('create new tags in a tag group')
+    .argument('<groupId>', 'create tag(s) in this tag group')
+    .argument('<"Label"...>', 'create tag(s) with label(s)')
+    .addOption(commit)
+    .addHelpText(
+      'after',
+      `
+    Example call:
+      > create tags in example "Tag 1" "Second Tag" Third
+      > create tags ih topics Books Faces History Places Spelling \n`
+    )
+    .action(async (groupId: string, tagLabels: string[], opts, cmd) => {
+      // workaround for opts.commit being always false
+      // read the (shared) options that were parsed by the parent cmd
+      // https://github.com/tj/commander.js/issues/476#issuecomment-1675757628
+      const parentOptions = cmd.optsWithGlobals();
+
+      const cli = cliCommand(['create', 'tags', 'in', groupId, ...tagLabels], {
+        ...opts,
+        ...parentOptions,
+      });
+
+      const language =
+        cli.env.projects.find(p => p.id === cli.env.currentProject)
+          ?.primaryLanguage || 'en-GB';
+
+      await cli.ImportTags({
+        commit: parentOptions.commit,
+        data: tagLabels.map(label => ({
+          groupId,
+          label: { [language]: label },
+          value: toApiId(label, 'camelCase', true),
+        })),
+      });
+    });
+
+  // Add global opts for inner sub-commands
+  addGlobalOptions(tags);
+
   return create;
 };

package/src/commands/get.ts

@@ -1,6 +1,5 @@
 import { Argument, Command, Option } from 'commander';
 import { merge } from 'lodash';
-import { cliCommand } from '~/services/ContensisCliService';
 import {
   addGlobalOptions,
   assetTypes,
@@ -15,6 +14,8 @@ import {
   versionStatus,
   zenql,
 } from './globalOptions';
+import { cliCommand } from '~/services/ContensisCliService';
+import { isUuid } from '~/util/assert';
 
 export const makeGetCommand = () => {
   const program = new Command()
@@ -118,6 +119,52 @@ Example call:
       );
     });
 
+  program
+    .command('tag')
+    .description('get a tag')
+    .argument('[idOrLabel]', 'find a tag with this id or label')
+    .option('-in --group <groupId>', 'id of the tag group containing tags')
+    .option('-l --language <language>', 'find tags in the supplied language')
+    .option('-d --dependents', 'find and return tag groups for all found tags')
+    .addHelpText(
+      'after',
+      `
+    Example call:
+      > get tag "Places" --group topics
+      > get tag "Places" -in topics
+      > get tag "Lieux" --language fr-FR -in topics
+      > get tag d4267b35-0d25-41ae-bce9-eeb490c793f4
+    `
+    )
+    .action(async (idOrlabel: string, opts) => {
+      await cliCommand(['get', 'tag', idOrlabel], opts).PrintTag(
+        {
+          id: isUuid(idOrlabel) ? idOrlabel : undefined,
+          groupId: opts.group,
+          label: isUuid(idOrlabel) ? undefined : idOrlabel,
+          language: opts.language,
+        },
+        opts.dependents
+      );
+    });
+
+  program
+    .command('taggroup')
+    .description('get a tag group')
+    .argument('<groupId>', 'id of the tag group to get')
+    .addHelpText(
+      'after',
+      `
+  Example call:
+    > get taggroup topics
+  `
+    )
+    .action(async (groupId: string, opts) => {
+      await cliCommand(['get', 'taggroup', groupId], opts).PrintTagGroup(
+        groupId
+      );
+    });
+
   program
     .command('webhook')
     .description('get a webhook')

package/src/commands/import.ts

@@ -208,6 +208,92 @@ Example call:
       });
     });
 
+  program
+    .command('taggroups')
+    .description('import taggroups')
+    .argument('[query]', 'apply a filter')
+    .option('-i --id <ids...>', 'limit to the supplied tag group id(s)')
+    .addOption(commit)
+    .option(
+      '-preserve --preserve-guids',
+      'include this flag when you are importing tags that you have previously exported and wish to update'
+    )
+    .addOption(concurrency)
+    .addOption(ignoreErrors)
+    .option(
+      '--save',
+      "save the tag groups we're migrating instead of the migration preview (used with --output)"
+    )
+    .addHelpText(
+      'after',
+      `
+  Example call:
+    > import taggroups --source-cms example-dev --source-project-id microsite --zenql "sys.contentTypeId = blog"
+    > import taggroups --from-file myImportData.json --preserve-guids
+  `
+    )
+    .action(async (query: string, opts) => {
+      await cliCommand(
+        ['import', 'taggroups'],
+        opts,
+        mapContensisOpts(opts)
+      ).ImportTagGroups({
+        commit: opts.commit,
+        fromFile: opts.fromFile,
+        getBy: {
+          id: opts.id?.length === 1 ? opts.id[0] : undefined,
+          ids: opts.id?.length > 1 ? opts.id : undefined,
+          q: query,
+        },
+        save: opts.save,
+      });
+    });
+
+  program
+    .command('tags')
+    .description('import tags')
+    .option('-in --group <groupId>', 'id of the tag group containing tags')
+    .option('--label <label>', 'filter by tags that match this label')
+    .option('-l --language <language>', 'find tags in the supplied language')
+    .option('-i --id <ids...>', 'limit to the supplied tag group id(s)')
+    .addOption(commit)
+    .option(
+      '-preserve --preserve-guids',
+      'include this flag when you are importing tags that you have previously exported and wish to update'
+    )
+    .addOption(concurrency)
+    .addOption(ignoreErrors)
+    .option(
+      '--save',
+      "save the tags we're migrating instead of the migration preview (used with --output)"
+    )
+    .addHelpText(
+      'after',
+      `
+    Example call:
+      > import tags --source-cms example-dev --source-project-id microsite --group example
+      > import tags --from-file myImportData.json --preserve-guids
+    `
+    )
+    .action(async (opts) => {
+      await cliCommand(
+        ['import', 'tags'],
+        opts,
+        mapContensisOpts(opts)
+      ).ImportTags({
+        commit: opts.commit,
+        fromFile: opts.fromFile,
+        getBy: {
+          groupId: opts.group,
+          id: opts.id?.length === 1 ? opts.id[0] : undefined,
+          ids: opts.id?.length > 1 ? opts.id : undefined,
+          label: opts.label,
+          language: opts.language,
+        },
+        save: opts.save,
+      });
+    });
+
   return program;
 };
 

package/src/commands/list.ts

@@ -1,6 +1,11 @@
 import { Command } from 'commander';
 import { cliCommand } from '~/services/ContensisCliService';
-import { exportOption, mapContensisOpts, noCache } from './globalOptions';
+import {
+  addGlobalOptions,
+  exportOption,
+  mapContensisOpts,
+  noCache,
+} from './globalOptions';
 
 export const makeListCommand = () => {
   const list = new Command()
@@ -8,6 +13,7 @@ export const makeListCommand = () => {
     .description('list command')
     .addHelpText('after', `\n`)
     .showHelpAfterError(true)
+    .enablePositionalOptions()
     .exitOverride();
 
   list
@@ -156,6 +162,76 @@ Example call:
       await cliCommand(['list', 'roles'], opts).PrintRoles();
     });
 
+  const tags = list
+    .command('tags')
+    .description('print list of tags')
+    .argument('[label]', 'filter by tags that match this label')
+    .passThroughOptions()
+    .option('-in --group <groupId>', 'id of the tag group containing tags')
+    .option('-i --id <ids...>', 'limit output to the supplied tag id(s)')
+    .option('-l --language <language>', 'find tags in the supplied language')
+    .option('-d --dependents', 'find and return tag groups for all found tags')
+    .addHelpText(
+      'after',
+      `
+    Example call:
+      > list tags
+    `
+    )
+    .action(async (label, opts) => {
+      await cliCommand(['list', 'tags'], { ...opts, label }).PrintTags(
+        {
+          id: opts.id?.length === 1 ? opts.id[0] : undefined,
+          ids: opts.id?.length > 1 ? opts.id : undefined,
+          groupId: opts.group,
+          label,
+          language: opts.language,
+        },
+        opts.dependents
+      );
+    });
+
+  tags
+    .command('in')
+    .description('print list of tags in a group')
+    .argument('<groupId>', 'id of the tag group containing tags')
+    .option('--label <label>', 'filter by tags that match this label')
+    .option(
+      '-l --language <language>',
+      'find tags by a label in a specific language'
+    )
+    .addHelpText(
+      'after',
+      `
+      Example call:
+        > list tags in example
+      `
+    )
+    .action(async (groupId: string, opts) => {
+      await cliCommand(['list', 'tags', 'in'], {
+        ...opts,
+        groupId,
+      }).PrintTags({
+        ...opts,
+        groupId,
+      });
+    });
+
+  list
+    .command('taggroups')
+    .description('print list of tag groups')
+    .argument('[query]', 'filter tag groups')
+    .addHelpText(
+      'after',
+      `
+  Example call:
+    > list taggroups
+  `
+    )
+    .action(async (query, opts) => {
+      await cliCommand(['list', 'taggroups'], opts).PrintTagGroups(query);
+    });
+
   list
     .command('webhooks')
     .description('print list of webhooks')
@@ -182,5 +258,8 @@ Example call:
       await cliCommand(['list', 'workflows'], opts).PrintWorkflows();
     });
 
+  // Add global opts for inner sub-commands
+  addGlobalOptions(tags);
+
   return list;
 };

package/src/commands/remove.ts

@@ -2,7 +2,12 @@ import { Command } from 'commander';
 import { cliCommand } from '~/services/ContensisCliService';
 import { shell } from '~/shell';
 import { Logger } from '~/util/logger';
-import { commit, mapContensisOpts, zenql } from './globalOptions';
+import {
+  addGlobalOptions,
+  commit,
+  mapContensisOpts,
+  zenql,
+} from './globalOptions';
 
 export const makeRemoveCommand = () => {
   const remove = new Command()
@@ -10,6 +15,7 @@ export const makeRemoveCommand = () => {
     .description('remove command')
     .addHelpText('after', `\n`)
     .showHelpAfterError(true)
+    .enablePositionalOptions()
     .exitOverride();
 
   remove
@@ -175,5 +181,89 @@ Example call:
       ).RemoveNodes(opts.commit);
     });
 
+  remove
+    .command('taggroup')
+    .description('delete an unused tag group')
+    .argument('<groupId>', 'id of the tag group to remove')
+    .addOption(commit)
+    .addHelpText(
+      'after',
+      `
+  Example call:
+    > remove taggroup example
+  `
+    )
+    .action(async (groupId: string, opts) => {
+      await cliCommand(['remove', 'taggroup', groupId], opts).RemoveTagGroup(
+        groupId,
+        opts.commit
+      );
+    });
+
+  const tags = remove
+    .command('tags')
+    .description('delete unused tags')
+    .passThroughOptions()
+    .argument('[ids...]', 'id(s) of the tag(s) to remove')
+    .option('--all', 'delete all tags')
+    .addOption(commit)
+    .addHelpText(
+      'after',
+      `
+    Example call:
+      > remove tags d4267b35-0d25-41ae-bce9-eeb490c793f4 90a11d09-3727-45c2-a0df-86f1865828ab
+      > remove tags --all
+
+    `
+    )
+    .action(async (ids: string[], opts, cmd: Command) => {
+      if ((!ids || !ids.length) && !opts.all)
+        cmd.error('Missing one of the required options');
+
+      await cliCommand(['remove', 'tags', ...ids], opts).RemoveTags(
+        { ids: ids.length ? ids : undefined },
+        opts.commit
+      );
+    });
+
+  tags
+    .command('in')
+    .description('delete unused tags in a specific tag group')
+    .showHelpAfterError(true)
+    .argument('<groupId>', 'id of the tag group containing tags')
+    .option('--all', 'delete all tags in this group')
+    .option('--label <label>', 'delete tags that match this label')
+    .option(
+      '-l --language <language>',
+      'delete tags by a label in a specific language'
+    )
+    .addOption(commit)
+    .addHelpText(
+      'after',
+      `
+    Example call:
+      > remove tags in example --label Test
+      > remove tags in example --all
+
+    `
+    )
+    .action(async (groupId: string, opts, cmd: Command) => {
+      // workaround for opts.commit being always false
+      // read the (shared) options that were parsed by the parent cmd
+      // https://github.com/tj/commander.js/issues/476#issuecomment-1675757628
+      const parentOptions = cmd.optsWithGlobals();
+
+      if (!parentOptions.all && !opts.label)
+        cmd.error('Missing one of the required options');
+
+      await cliCommand(['remove', 'tags', 'in', groupId], opts).RemoveTags(
+        { groupId, ...opts, ...parentOptions },
+        parentOptions.commit
+      );
+    });
+
+  // Add global opts for inner sub-commands
+  addGlobalOptions(tags);
+
   return remove;
 };

package/src/localisation/en-GB.ts

@@ -115,8 +115,18 @@ export const LogMessages = {
       `[${env}] Unable to update project ${Logger.highlightText(id)}`,
   },
   migrate: {
+    commitTip: () => `Add --commit flag to commit the previewed changes`,
     preview: (verb = 'IMPORT') => `🔍 ${verb} PREVIEW 🔭`,
     commit: (verb = 'IMPORT') => `COMMITTING ${verb} ✨☄️ `,
+    imported: (
+      env: string,
+      commit: boolean,
+      entities: { [noun: string]: number }
+    ) =>
+      `${commit ? `Imported` : `Will import`} ${Object.entries(entities)
+        .map(([noun, count]) => pl(noun, count, true))
+        .join(' and ')} into ${env} environment`,
+
     models: {
       result: (
         status: keyof MigrateModelsResult['project']['contentTypes']
@@ -161,11 +171,7 @@ export const LogMessages = {
   },
   nodes: {
     imported: (env: string, commit: boolean, count: number) =>
-      `[${env}] ${commit ? `Imported` : `Will import`} ${pl(
-        'node',
-        count,
-        true
-      )}`,
+      LogMessages.migrate.imported(env, commit, { node: count }),
     failedImport: (env: string) => `[${env}] Unable to import nodes`,
     removed: (env: string, commit: boolean, root: string) =>
       `[${env}] ${commit ? `Deleted` : `Will delete`} nodes at ${root}`,
@@ -222,9 +228,10 @@ export const LogMessages = {
   },
   entries: {
     imported: (env: string, commit: boolean, entries: number, nodes = 0) =>
-      `${commit ? `Imported` : `Will import`} ${pl('entry', entries, true)}${
-        nodes > 0 ? ` and ${pl('node', nodes, true)}` : ''
-      } into ${env} environment`,
+      LogMessages.migrate.imported(env, commit, {
+        entry: entries,
+        node: nodes,
+      }),
     failedImport: (env: string) => `[${env}] Unable to import entries`,
     update: {
       preview: () => LogMessages.migrate.preview('UPDATE FIELD'),
@@ -239,7 +246,6 @@ 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`,
-    commitTip: () => `Add --commit flag to commit the previewed changes`,
   },
   keys: {
     list: (env: string) => `[${env}] API keys:`,
@@ -344,6 +350,53 @@ export const LogMessages = {
     failedRemove: (env: string, id: string) =>
       `[${env}] Unable to delete role ${Logger.highlightText(id)}`,
   },
+  taggroups: {
+    list: (env: string, length: number) =>
+      `[${env}] Retrieved ${pl('tag group', length, true)}`,
+    noList: (env: string) => `[${env}] Cannot retrieve tag groups`,
+    noneExist: () => `Create a tag group with "create taggroup <name>"`,
+    imported: (env: string, commit: boolean, groups: number, tags: number) =>
+      LogMessages.migrate.imported(env, commit, {
+        'tag group': groups,
+        tag: tags,
+      }),
+    failedGet: (env: string, name: string) =>
+      `[${env}] Unable to find a tag group ${Logger.highlightText(name)}`,
+    created: (env: string, name: string) =>
+      `[${env}] Created tag group ${Logger.highlightText(name)}\n`,
+    tip: () =>
+      `Give access to your role with "set role assignments", allow your role to do things with "set role permissions"`,
+    failedCreate: (env: string, name?: string) =>
+      `[${env}] Unable to create ${name ? `tag group ${Logger.highlightText(name)}` : 'tag groups'}`,
+    removed: (env: string, id: string, commit: boolean) =>
+      `[${env}] ${
+        commit ? `Deleted` : `Will delete`
+      } tag group ${Logger.highlightText(id)}\n`,
+    failedRemove: (env: string, id: string) =>
+      `[${env}] Unable to delete tag group ${Logger.highlightText(id)}`,
+  },
+  tags: {
+    list: (env: string, length: number) =>
+      `[${env}] Retrieved ${pl('tag', length, true)}`,
+    noList: (env: string) => `[${env}] Cannot retrieve tags`,
+    noneExist: () =>
+      `Create a tag with "create tag in <groupId> <tag label(s)...>"`,
+    imported: (env: string, commit: boolean, tags: number) =>
+      LogMessages.migrate.imported(env, commit, { tag: tags }),
+    failedGet: (env: string) => `[${env}] Unable to find tags`,
+    created: (env: string, name: string) =>
+      `[${env}] Created tag ${Logger.highlightText(name)}\n`,
+    failedCreate: (env: string, name?: string) =>
+      `[${env}] Unable to create ${name ? `tag ${Logger.highlightText(name)}` : 'tags'}`,
+    removed: (env: string, length: number, commit: boolean) =>
+      `[${env}] ${
+        !length
+          ? 'No tags to delete'
+          : `${commit ? `Deleted` : `Will delete`} ${pl('tag', length, true)}\n`
+      }`,
+    failedRemove: (env: string, length: number) =>
+      `[${env}] Unable to delete tags with ${pl('error', length)}`,
+  },
   blocks: {
     runningStatus: (status: BlockRunningStatus | 'broken') => {
       switch (status) {

package/src/models/Cache.d.ts

@@ -5,6 +5,7 @@ type SessionCache = {
     [alias: string]: EnvironmentCache;
   };
   history: string[];
+  version: string;
 };
 
 type EnvironmentCache = {
@@ -12,7 +13,7 @@ type EnvironmentCache = {
   passwordFallback?: string;
   authToken?: string;
   currentProject?: string;
-  projects: string[];
+  projects: { id: string; primaryLanguage: string }[];
   history: CliCommand[];
   versionStatus: 'latest' | 'published';
 };

package/src/providers/HttpProvider.ts

@@ -4,7 +4,7 @@ import fs from 'fs';
 import { Readable } from 'stream';
 import { finished } from 'stream/promises';
 
-import { isJson, tryParse } from '~/util';
+import { isJson, tryParse } from '~/util/assert';
 import { enhancedFetch } from '~/util/fetch';
 class HttpProvider {
   constructor() {}

package/src/providers/ManifestProvider.ts

@@ -1,4 +1,4 @@
-import { tryParse } from '~/util';
+import { tryParse } from '~/util/assert';
 import { appPath, readFile, writeFile } from './file-provider';
 
 export type CliModule = {

package/src/providers/SessionCacheProvider.ts

@@ -4,8 +4,9 @@ import clone from 'lodash/cloneDeep';
 import mergeWith from 'lodash/mergeWith';
 import unionBy from 'lodash/unionBy';
 import { appRootDir, checkDir } from './file-provider';
-import { isJson, tryParse } from '~/util';
+import { isJson, tryParse } from '~/util/assert';
 import { Logger } from '~/util/logger';
+import { LIB_VERSION } from '~/version';
 
 class SessionCacheProvider {
   private localFilePath: string;
@@ -18,6 +19,7 @@ class SessionCacheProvider {
       currentTimestamp: new Date().toISOString(),
       environments: {},
       history: [],
+      version: LIB_VERSION,
     };
     this.ReadCacheFromDisk();
   }
@@ -64,7 +66,10 @@ class SessionCacheProvider {
 
         if (Array.isArray(val)) return val.concat(src);
       });
+      
       this.cache.currentTimestamp = new Date().toISOString();
+      this.cache.version = LIB_VERSION;
+
       this.WriteCacheToDisk();
     } catch (ex: any) {
       // Problem merging cache data for update