contensis-cli 1.0.0-beta.8 → 1.0.0-beta.81

package/src/commands/get.ts

@@ -1,15 +1,117 @@
 import { Argument, Command } from 'commander';
+import { merge } from 'lodash';
 import { cliCommand } from '~/services/ContensisCliService';
-import { mapContensisOpts } from './globalOptions';
+import { addGlobalOptions, mapContensisOpts } from './globalOptions';
 
 export const makeGetCommand = () => {
   const program = new Command()
     .command('get')
+    .description('get command')
+    .addHelpText('after', `\n`)
     .showHelpAfterError(true)
     .exitOverride();
 
+  program
+    .command('version')
+    .description('get current Contensis version')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > version
+`
+    )
+    .action(async opts => {
+      await cliCommand(['get', 'version'], opts).PrintContensisVersion();
+    });
+
+  program
+    .command('token')
+    .description('show a bearer token for the currently logged in user')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > get token
+`
+    )
+    .action(async opts => {
+      await cliCommand(['get', 'token'], opts).PrintBearerToken();
+    });
+
+  program
+    .command('project')
+    .description('get a project')
+    .argument('[projectId]', 'id of the project to get (default: current)')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > get project website
+`
+    )
+    .action(async (projectId: string, opts) => {
+      await cliCommand(['get', 'project', projectId], opts).PrintProject(
+        projectId
+      );
+    });
+
+  program
+    .command('role')
+    .description('get a role')
+    .argument('<roleNameOrId>', 'id or name of the role to get')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > get role "entry admin"
+`
+    )
+    .action(async (roleNameOrId: string, opts) => {
+      await cliCommand(['get', 'role', roleNameOrId], opts).PrintRole(
+        roleNameOrId
+      );
+    });
+
+  program
+    .command('webhook')
+    .description('get a webhook')
+    .argument('<webhookNameOrId...>', 'id or name of the webhook(s) to get')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > get webhook "Slack notification"
+`
+    )
+    .action(async (webhookNameOrId: string[], opts) => {
+      await cliCommand(
+        ['get', 'webhook', webhookNameOrId.join(' ')],
+        opts
+      ).PrintWebhookSubscriptions(webhookNameOrId);
+    });
+
+  program
+    .command('model')
+    .description('get a content model')
+    .argument('<contentTypeId...>', 'ids of the content models to get')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > get model podcast podcastLinks
+`
+    )
+    .action(async (modelIds: string[], opts) => {
+      await cliCommand(
+        ['get', 'model', modelIds.join(' ')],
+        opts
+      ).PrintContentModels(modelIds);
+    });
+
   program
     .command('contenttype')
+    .description('get a content type')
     .argument('<contentTypeId>', 'the API id of the content type to get')
     .addHelpText(
       'after',
@@ -19,12 +121,15 @@ Example call:
 `
     )
     .action(async (contentTypeId: string, opts) => {
-      await cliCommand(['get', 'contenttype'], opts).PrintContentType(
-        contentTypeId
-      );
+      await cliCommand(
+        ['get', 'contenttype', contentTypeId],
+        opts
+      ).PrintContentType(contentTypeId);
     });
+
   program
     .command('component')
+    .description('get a component')
     .argument('<componentId>', 'the API id of the component to get')
     .addHelpText(
       'after',
@@ -34,15 +139,19 @@ Example call:
 `
     )
     .action(async (componentId: string, opts) => {
-      await cliCommand(['get', 'component'], opts).PrintComponent(componentId);
+      await cliCommand(['get', 'component', componentId], opts).PrintComponent(
+        componentId
+      );
     });
+
   program
     .command('entries')
+    .description('get entries')
     .argument(
       '[search phrase]',
       'get entries with the search phrase, use quotes for multiple words'
     )
-    .option('-i --id <id...>', 'the entry id to get')
+    .option('-i --id <id...>', 'the entry id(s) to get')
     .option(
       '-d, --dependents',
       'find and return any dependencies of all found entries'
@@ -76,18 +185,27 @@ Example call:
 
   const block = program
     .command('block')
+    .description('get a block or block version')
     .argument('[blockId]', 'the block to get version details for')
     .argument(
       '[branch]',
       'the branch of the block to get version details for',
-      'main'
+      'default'
     )
     .argument(
       '[version]',
       'get a specific version of the block pushed to the specified branch'
     )
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > get block contensis-website
+  > get block contensis-website develop latest
+`
+    )
     .action(async (blockId: string, branch: string, version: string, opts) => {
-      await cliCommand(['get', 'block'], opts).PrintBlockVersions(
+      await cliCommand(['get', 'block', blockId], opts).PrintBlockVersions(
         blockId,
         branch,
         version
@@ -98,16 +216,17 @@ Example call:
     '[dataCenter]',
     'the datacentre of the block to get logs for'
   )
-    .choices(['hq', 'london', 'manchester'])
-    .default('hq');
+    .choices(['hq', 'london', 'manchester', 'all'])
+    .default('all');
 
   block
     .command('logs')
+    .description('get logs for a block')
     .argument('[blockId]', 'the block to get version logs for')
     .argument(
       '[branch]',
       'the branch of the block to get version details for',
-      'main'
+      'default'
     )
     .argument(
       '[version]',
@@ -115,24 +234,41 @@ Example call:
       'latest'
     )
     .addArgument(dataCenter)
+    .option('-t, --follow', 'follow block logs in near realtime', false)
     .usage('get block logs [blockId] [branch] [version] [dataCenter]')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > get block logs contensis-website default
+  > get block logs contensis-website master latest london --follow
+`
+    )
     .action(
       async (
         blockId: string,
         branch: string,
         version: string,
-        dataCenter: 'hq' | 'manchester' | 'london',
+        dataCenter: 'hq' | 'manchester' | 'london' | 'all',
         opts
       ) => {
-        await cliCommand(['get', 'block', 'logs'], opts).PrintBlockLogs(
+        const parentOpts = block.opts() || {};
+        await cliCommand(
+          ['get', 'block', 'logs'],
+          merge(opts, parentOpts)
+        ).PrintBlockLogs(
           blockId,
           branch,
           version,
-          dataCenter
+          dataCenter === 'all' ? undefined : dataCenter,
+          opts.follow as boolean
         );
       }
     );
 
+  // Add global opts for inner sub-commands
+  addGlobalOptions(block);
+
   return program;
 };
 

package/src/commands/globalOptions.ts

@@ -3,19 +3,20 @@ import { url } from '~/util';
 
 export const mapContensisOpts = (opts: any = {}) => ({
   source:
-    opts.sourceCms || opts.sourceProjectId
+    opts.sourceAlias || opts.sourceProjectId
       ? {
-          url: opts.sourceCms
-            ? url(opts.sourceCms, 'website').cms
+          url: opts.sourceAlias
+            ? url(opts.sourceAlias, 'website').cms
             : (undefined as any),
           project: opts.sourceProjectId || (undefined as any),
         }
       : undefined,
+  models: opts.modelIds,
   query:
-    opts.id || opts.phrase || opts.fields
+    opts.id || opts.entryIds || opts.phrase || opts.fields
       ? {
           fields: opts.fields,
-          includeIds: opts.id,
+          includeIds: opts.id || opts.entryIds,
           searchTerm: opts.phrase,
         }
       : undefined,
@@ -36,59 +37,59 @@ const format = new Option(
 
 /* Connect options */
 const alias = new Option(
-  '-a --alias <alias>',
+  '-a, --alias <alias>',
   'the cloud CMS alias to connect your request with'
 );
 
 export const project = new Option(
-  '-p --project-id <projectId>',
+  '-p, --project-id <projectId>',
   'the projectId to make your request with'
 );
 
 /* Authentication options */
 const user = new Option(
-  '-u --user <user>',
+  '-u, --user <user>',
   'the username to authenticate your request with'
 );
 const password = new Option(
-  '-pw --password <password>',
+  '-pw, --password <password>',
   'the password to use to login with (optional/insecure)'
 );
 const clientId = new Option(
-  '-id --client-id <clientId>',
+  '-id, --client-id <clientId>',
   'the clientId to authenticate your request with'
 );
 const sharedSecret = new Option(
-  '-s --shared-secret <sharedSecret>',
+  '-s, --shared-secret <sharedSecret>',
   'the shared secret to use when logging in with a client id'
 );
 
 /* Entry get options */
-const zenql = new Option(
+export const zenql = new Option(
   '-q, --zenql <zenql>',
   'get entries with a supplied ZenQL statement'
 );
 
-const entryId = new Option('-i --id <id...>', 'the entry id to get');
+export const entryId = new Option('-i --id <id...>', 'the entry id(s) to get');
 
 /* Import options */
 export const fromFile = new Option(
-  '-file --from-file <fromFile>',
+  '-file, --from-file <fromFile>',
   'file path to import asset(s) from'
 );
 
 export const fromCms = new Option(
-  '-source --source-alias <fromCms>',
+  '-source, --source-alias <fromCms>',
   'the cloud CMS alias to import asset(s) from'
 );
 export const fromProject = new Option(
-  '-sp --source-project-id <fromProject>',
+  '-sp, --source-project-id <fromProject>',
   'the id of the Contensis project to import asset(s) from (Default: [last connected project])'
 );
 
 export const commit = new Option(
   '--commit',
-  'omit and only add this flag when you are happy with the preview of the import'
+  'add this flag only after you have run a preview of the import and agree with the analysis'
 ).default(false);
 
 export const addConnectOptions = (program: Command) =>

package/src/commands/import.ts

@@ -1,20 +1,47 @@
-import { Argument, Command } from 'commander';
+import { Command, Option } from 'commander';
 import { cliCommand } from '~/services/ContensisCliService';
-import { url } from '~/util';
 import { commit, mapContensisOpts } from './globalOptions';
 
 export const makeImportCommand = () => {
   const program = new Command()
     .command('import')
+    .description('import command')
+    .addHelpText('after', `\n`)
     .showHelpAfterError(true)
     .exitOverride();
 
+  program
+    .command('models')
+    .description('import complete content models')
+    .argument('[modelIds...]', 'ids of the content models to import (optional)')
+    .addOption(commit)
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > import models blogPost --from-file contentmodels-backup.json
+  > import models --source-alias example-dev
+`
+    )
+    .action(async (modelIds: string[], opts) => {
+      await cliCommand(
+        ['import', 'models', modelIds.join(' ')],
+        opts,
+        mapContensisOpts({ modelIds, ...opts })
+      ).ImportContentModels({
+        fromFile: opts.fromFile,
+        commit: opts.commit,
+      });
+    });
+
   program
     .command('contenttypes')
+    .description('import content types')
     .argument(
-      '[contentTypeIds]',
+      '[contentTypeIds...]',
       'Optional list of API id(s) of the content type(s) to import'
     )
+    .addOption(commit)
     .addHelpText(
       'after',
       `
@@ -24,7 +51,11 @@ Example call:
 `
     )
     .action(async (contentTypeIds: string[], opts) => {
-      await cliCommand(['import', 'contenttypes'], opts).ImportContentTypes(
+      await cliCommand(
+        ['import', 'contenttypes'],
+        opts,
+        mapContensisOpts({ contentTypeIds, ...opts })
+      ).ImportContentTypes(
         {
           fromFile: opts.fromFile,
           commit: opts.commit,
@@ -35,10 +66,12 @@ Example call:
 
   program
     .command('components')
+    .description('import components')
     .argument(
-      '[componentIds]',
+      '[componentIds...]',
       'Optional list of API id(s) of the component(s) to import'
     )
+    .addOption(commit)
     .addHelpText(
       'after',
       `
@@ -48,7 +81,11 @@ Example call:
 `
     )
     .action(async (componentIds: string[], opts) => {
-      await cliCommand(['import', 'component'], opts).ImportComponents(
+      await cliCommand(
+        ['import', 'component'],
+        opts,
+        mapContensisOpts({ componentIds, ...opts })
+      ).ImportComponents(
         {
           fromFile: opts.fromFile,
           commit: opts.commit,
@@ -59,6 +96,7 @@ Example call:
 
   program
     .command('entries')
+    .description('import entries')
     .argument(
       '[search phrase]',
       'get entries with the search phrase, use quotes for multiple words'
@@ -68,6 +106,14 @@ Example call:
       '-preserve, --preserve-guids',
       'include this flag when you are importing entries that you have previously exported and wish to update'
     )
+    .addOption(
+      new Option(
+        '-oe, --output-entries <outputEntries>',
+        'which details of the entries included in the import to output'
+      )
+        .choices(['errors', 'changes', 'all'])
+        .default('errors')
+    )
     .addHelpText(
       'after',
       `
@@ -80,7 +126,11 @@ Example call:
         ['import', 'entries'],
         opts,
         mapContensisOpts({ phrase, ...opts })
-      ).ImportEntries({ commit: opts.commit, fromFile: opts.fromFile });
+      ).ImportEntries({
+        commit: opts.commit,
+        fromFile: opts.fromFile,
+        logOutput: opts.outputEntries,
+      });
     });
 
   return program;

package/src/commands/index.ts

@@ -3,6 +3,8 @@ import { Logger } from '~/util/logger';
 import { LIB_VERSION } from '~/version';
 import { makeConnectCommand } from './connect';
 import { makeCreateCommand } from './create';
+import { makeDiffCommand } from './diff';
+import { makeExecuteCommand } from './execute';
 import { makeGetCommand } from './get';
 import {
   addAuthenticationOptions,
@@ -29,6 +31,13 @@ const commands = () => {
           : str.trim() && Logger.help(str);
       },
     })
+    .addHelpText(
+      'after',
+      Logger.helpText`
+>> Each command has its own help - for example:
+  > login --help\n  > get --help
+`
+    )
     .exitOverride()
     .showHelpAfterError(true);
 
@@ -37,9 +46,15 @@ const commands = () => {
       program
     )
   );
+  program.addCommand(
+    addGlobalOptions(makeCreateCommand()).copyInheritedSettings(program)
+  );
+  program.addCommand(
+    addGlobalOptions(makeExecuteCommand()).copyInheritedSettings(program)
+  );
   program.addCommand(
     addGlobalOptions(
-      addImportOptions(makeCreateCommand())
+      addGetEntryOptions(addImportOptions(makeDiffCommand()))
     ).copyInheritedSettings(program)
   );
   program.addCommand(

package/src/commands/list.ts

@@ -1,20 +1,17 @@
 import { Command } from 'commander';
 import { cliCommand } from '~/services/ContensisCliService';
 
-// projects
-// content types
-// components
-// api keys
-// roles
-// webhooks
 export const makeListCommand = () => {
   const list = new Command()
     .command('list')
+    .description('list command')
+    .addHelpText('after', `\n`)
     .showHelpAfterError(true)
     .exitOverride();
 
   list
     .command('envs')
+    .description('List all previously connected environments')
     .addHelpText(
       'after',
       `
@@ -25,11 +22,38 @@ Example call:
     .action(opts => {
       cliCommand(['list', 'envs'], opts).PrintEnvironments();
     });
-  list.command('projects').action(async opts => {
-    await cliCommand(['list', 'projects'], opts).PrintProjects();
-  });
+
+  list
+    .command('projects')
+    .description('print list of projects')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > list projects
+`
+    )
+    .action(async opts => {
+      await cliCommand(['list', 'projects'], opts).PrintProjects();
+    });
+
+  list
+    .command('models')
+    .description('print list of content models')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > list models
+`
+    )
+    .action(async opts => {
+      await cliCommand(['list', 'models'], opts).PrintContentModels();
+    });
+
   list
     .command('contenttypes')
+    .description('print list of content types')
     .addHelpText(
       'after',
       `
@@ -40,8 +64,10 @@ Example call:
     .action(async opts => {
       await cliCommand(['list', 'contenttypes'], opts).PrintContentTypes();
     });
+
   list
     .command('components')
+    .description('print list of components')
     .addHelpText(
       'after',
       `
@@ -52,8 +78,10 @@ Example call:
     .action(async opts => {
       await cliCommand(['list', 'components'], opts).PrintComponents();
     });
+
   list
     .command('blocks')
+    .description('print list of content blocks')
     .addHelpText(
       'after',
       `
@@ -64,8 +92,10 @@ Example call:
     .action(async opts => {
       await cliCommand(['list', 'blocks'], opts).PrintBlocks();
     });
+
   list
     .command('keys')
+    .description('print list of API keys')
     .addHelpText(
       'after',
       `
@@ -76,14 +106,58 @@ Example call:
     .action(async opts => {
       await cliCommand(['list', 'keys'], opts).PrintApiKeys();
     });
+
+  list
+    .command('proxies')
+    .description('print list of proxies')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > list proxies
+`
+    )
+    .action(async opts => {
+      await cliCommand(['list', 'proxies'], opts).PrintProxies();
+    });
+
+  list
+    .command('renderers')
+    .description('print list of renderers')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > list renderers
+`
+    )
+    .action(async opts => {
+      await cliCommand(['list', 'renderers'], opts).PrintRenderers();
+    });
+
+  list
+    .command('roles')
+    .description('print list of roles')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > list roles
+`
+    )
+    .action(async opts => {
+      await cliCommand(['list', 'roles'], opts).PrintRoles();
+    });
+
   list
     .command('webhooks')
+    .description('print list of webhooks')
     .argument('[name]', 'find webhooks matching the supplied name')
     .option('-i --id <id...>', 'the subscription id(s) to get')
+    .addHelpText('after', `\n`)
     .action(async (name?: string, { id, ...opts }: any = {}) => {
       await cliCommand(['list', 'webhooks'], opts).PrintWebhookSubscriptions(
-        id,
-        name
+        name ? [name] : id
       );
     });
   return list;

package/src/commands/login.ts

@@ -5,13 +5,14 @@ import { shell } from '~/shell';
 export const makeLoginCommand = () => {
   const login = new Command()
     .command('login')
+    .description('login to a connected Contensis instance')
     .argument('<user/clientId>', 'the username to login with')
     .argument(
       '[password]',
       'the password to use to login with (optional/insecure)'
     )
     .option(
-      '-s --shared-secret <sharedSecret>',
+      '-s, --shared-secret <sharedSecret>',
       'the shared secret to use when logging in with a client id'
     )
     .usage('<user/clientId> [password] [-s <sharedSecret>]')
@@ -27,7 +28,7 @@ Example call:
         password,
         sharedSecret: opts.sharedSecret,
       });
-      if (token) await shell().start();
+      if (token) await shell().restart();
     });
   return login;
 };