contensis-cli 1.0.0-beta.53 → 1.0.0-beta.54

package/src/commands/get.ts

@@ -1,214 +1,214 @@
-import { Argument, Command } from 'commander';
-import { cliCommand } from '~/services/ContensisCliService';
-import { mapContensisOpts } from './globalOptions';
-
-export const makeGetCommand = () => {
-  const program = new Command()
-    .command('get')
-    .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('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('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',
-      `
-Example call:
-  > get contenttype {contentTypeId} -o content-type-backup.json
-`
-    )
-    .action(async (contentTypeId: string, opts) => {
-      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',
-      `
-Example call:
-  > get component {componentId} -o component-backup.json
-`
-    )
-    .action(async (componentId: string, opts) => {
-      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(s) to get')
-    .option(
-      '-d, --dependents',
-      'find and return any dependencies of all found entries'
-    )
-    .option(
-      '-fi, --fields <fields...>',
-      'limit the output fields on returned entries'
-    )
-    .option(
-      '-q, --zenql <zenql>',
-      'get entries with a supplied ZenQL statement'
-    )
-    .addHelpText(
-      'after',
-      `
-Example call:
-  > get entries --zenql "sys.contentTypeId = blog" --fields entryTitle entryDescription sys.id --output ./blog-posts.csv --format csv
-`
-    )
-    .action(async (phrase: string, opts, cmd) => {
-      // console.log('phrase: ', phrase, '\nopts:', JSON.stringify(opts, null, 2));
-      // console.log('opts:', JSON.stringify(opts, null, 2));
-      await cliCommand(
-        ['get', 'entries'],
-        opts,
-        mapContensisOpts({ phrase, ...opts })
-      ).GetEntries({
-        withDependents: opts.dependents,
-      });
-    });
-
-  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'
-    )
-    .argument(
-      '[version]',
-      'get a specific version of the block pushed to the specified branch'
-    )
-    .addHelpText(
-      'after',
-      `
-Example call:
-  > get block contensis-website master latest
-`
-    )
-    .action(async (blockId: string, branch: string, version: string, opts) => {
-      await cliCommand(['get', 'block'], opts).PrintBlockVersions(
-        blockId,
-        branch,
-        version
-      );
-    });
-
-  const dataCenter = new Argument(
-    '[dataCenter]',
-    'the datacentre of the block to get logs for'
-  )
-    .choices(['hq', 'london', 'manchester'])
-    .default('hq');
-
-  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'
-    )
-    .argument(
-      '[version]',
-      'the version of the block pushed to the branch to get logs for',
-      'latest'
-    )
-    .addArgument(dataCenter)
-    .usage('get block logs [blockId] [branch] [version] [dataCenter]')
-    .addHelpText(
-      'after',
-      `
-Example call:
-  > get block logs contensis-website master
-  > get block logs contensis-website master latest london
-`
-    )
-    .action(
-      async (
-        blockId: string,
-        branch: string,
-        version: string,
-        dataCenter: 'hq' | 'manchester' | 'london',
-        opts
-      ) => {
-        await cliCommand(['get', 'block', 'logs'], opts).PrintBlockLogs(
-          blockId,
-          branch,
-          version,
-          dataCenter
-        );
-      }
-    );
-
-  return program;
-};
-
-export const get = makeGetCommand();
+import { Argument, Command } from 'commander';
+import { cliCommand } from '~/services/ContensisCliService';
+import { mapContensisOpts } from './globalOptions';
+
+export const makeGetCommand = () => {
+  const program = new Command()
+    .command('get')
+    .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('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('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',
+      `
+Example call:
+  > get contenttype {contentTypeId} -o content-type-backup.json
+`
+    )
+    .action(async (contentTypeId: string, opts) => {
+      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',
+      `
+Example call:
+  > get component {componentId} -o component-backup.json
+`
+    )
+    .action(async (componentId: string, opts) => {
+      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(s) to get')
+    .option(
+      '-d, --dependents',
+      'find and return any dependencies of all found entries'
+    )
+    .option(
+      '-fi, --fields <fields...>',
+      'limit the output fields on returned entries'
+    )
+    .option(
+      '-q, --zenql <zenql>',
+      'get entries with a supplied ZenQL statement'
+    )
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > get entries --zenql "sys.contentTypeId = blog" --fields entryTitle entryDescription sys.id --output ./blog-posts.csv --format csv
+`
+    )
+    .action(async (phrase: string, opts, cmd) => {
+      // console.log('phrase: ', phrase, '\nopts:', JSON.stringify(opts, null, 2));
+      // console.log('opts:', JSON.stringify(opts, null, 2));
+      await cliCommand(
+        ['get', 'entries'],
+        opts,
+        mapContensisOpts({ phrase, ...opts })
+      ).GetEntries({
+        withDependents: opts.dependents,
+      });
+    });
+
+  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'
+    )
+    .argument(
+      '[version]',
+      'get a specific version of the block pushed to the specified branch'
+    )
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > get block contensis-website master latest
+`
+    )
+    .action(async (blockId: string, branch: string, version: string, opts) => {
+      await cliCommand(['get', 'block'], opts).PrintBlockVersions(
+        blockId,
+        branch,
+        version
+      );
+    });
+
+  const dataCenter = new Argument(
+    '[dataCenter]',
+    'the datacentre of the block to get logs for'
+  )
+    .choices(['hq', 'london', 'manchester'])
+    .default('hq');
+
+  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'
+    )
+    .argument(
+      '[version]',
+      'the version of the block pushed to the branch to get logs for',
+      'latest'
+    )
+    .addArgument(dataCenter)
+    .usage('get block logs [blockId] [branch] [version] [dataCenter]')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > get block logs contensis-website master
+  > get block logs contensis-website master latest london
+`
+    )
+    .action(
+      async (
+        blockId: string,
+        branch: string,
+        version: string,
+        dataCenter: 'hq' | 'manchester' | 'london',
+        opts
+      ) => {
+        await cliCommand(['get', 'block', 'logs'], opts).PrintBlockLogs(
+          blockId,
+          branch,
+          version,
+          dataCenter
+        );
+      }
+    );
+
+  return program;
+};
+
+export const get = makeGetCommand();

package/src/commands/globalOptions.ts

@@ -1,127 +1,127 @@
-import { Command, Option } from 'commander';
-import { url } from '~/util';
-
-export const mapContensisOpts = (opts: any = {}) => ({
-  source:
-    opts.sourceAlias || opts.sourceProjectId
-      ? {
-          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.entryIds || opts.phrase || opts.fields
-      ? {
-          fields: opts.fields,
-          includeIds: opts.id || opts.entryIds,
-          searchTerm: opts.phrase,
-        }
-      : undefined,
-  zenQL: opts.zenql,
-  transformGuids: !opts.preserveGuids,
-});
-
-/* Output options */
-const output = new Option(
-  '-o, --output <output>',
-  'save output to a file e.g. --output ./output.txt'
-);
-
-const format = new Option(
-  '-f, --format <format>',
-  'format output as csv, json, xml or table (default)'
-).choices(['csv', 'json', 'xml', 'table']);
-
-/* Connect options */
-const alias = new Option(
-  '-a, --alias <alias>',
-  'the cloud CMS alias to connect your request with'
-);
-
-export const project = new Option(
-  '-p, --project-id <projectId>',
-  'the projectId to make your request with'
-);
-
-/* Authentication options */
-const user = new Option(
-  '-u, --user <user>',
-  'the username to authenticate your request with'
-);
-const password = new Option(
-  '-pw, --password <password>',
-  'the password to use to login with (optional/insecure)'
-);
-const clientId = new Option(
-  '-id, --client-id <clientId>',
-  'the clientId to authenticate your request with'
-);
-const sharedSecret = new Option(
-  '-s, --shared-secret <sharedSecret>',
-  'the shared secret to use when logging in with a client id'
-);
-
-/* Entry get options */
-export const zenql = new Option(
-  '-q, --zenql <zenql>',
-  'get entries with a supplied ZenQL statement'
-);
-
-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 path to import asset(s) from'
-);
-
-export const fromCms = new Option(
-  '-source, --source-alias <fromCms>',
-  'the cloud CMS alias to import asset(s) from'
-);
-export const fromProject = new Option(
-  '-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',
-  '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) =>
-  program.addOption(alias.hideHelp()).addOption(project.hideHelp());
-
-export const addAuthenticationOptions = (program: Command) =>
-  program
-    .addOption(user.hideHelp())
-    .addOption(password.hideHelp())
-    .addOption(clientId.hideHelp())
-    .addOption(sharedSecret.hideHelp());
-
-const addOutputAndFormatOptions = (program: Command) =>
-  program.addOption(output).addOption(format);
-
-export const addImportOptions = (program: Command) => {
-  for (const command of program.commands) {
-    command.addOption(fromFile).addOption(fromCms).addOption(fromProject);
-  }
-  return program;
-};
-export const addGetEntryOptions = (program: Command) => {
-  for (const command of program.commands) {
-    command.addOption(entryId).addOption(zenql);
-  }
-  return program;
-};
-export const addGlobalOptions = (program: Command) => {
-  for (const command of program.commands) {
-    addOutputAndFormatOptions(command);
-    addConnectOptions(command);
-    addAuthenticationOptions(command);
-  }
-  return program;
-};
+import { Command, Option } from 'commander';
+import { url } from '~/util';
+
+export const mapContensisOpts = (opts: any = {}) => ({
+  source:
+    opts.sourceAlias || opts.sourceProjectId
+      ? {
+          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.entryIds || opts.phrase || opts.fields
+      ? {
+          fields: opts.fields,
+          includeIds: opts.id || opts.entryIds,
+          searchTerm: opts.phrase,
+        }
+      : undefined,
+  zenQL: opts.zenql,
+  transformGuids: !opts.preserveGuids,
+});
+
+/* Output options */
+const output = new Option(
+  '-o, --output <output>',
+  'save output to a file e.g. --output ./output.txt'
+);
+
+const format = new Option(
+  '-f, --format <format>',
+  'format output as csv, json, xml or table (default)'
+).choices(['csv', 'json', 'xml', 'table']);
+
+/* Connect options */
+const alias = new Option(
+  '-a, --alias <alias>',
+  'the cloud CMS alias to connect your request with'
+);
+
+export const project = new Option(
+  '-p, --project-id <projectId>',
+  'the projectId to make your request with'
+);
+
+/* Authentication options */
+const user = new Option(
+  '-u, --user <user>',
+  'the username to authenticate your request with'
+);
+const password = new Option(
+  '-pw, --password <password>',
+  'the password to use to login with (optional/insecure)'
+);
+const clientId = new Option(
+  '-id, --client-id <clientId>',
+  'the clientId to authenticate your request with'
+);
+const sharedSecret = new Option(
+  '-s, --shared-secret <sharedSecret>',
+  'the shared secret to use when logging in with a client id'
+);
+
+/* Entry get options */
+export const zenql = new Option(
+  '-q, --zenql <zenql>',
+  'get entries with a supplied ZenQL statement'
+);
+
+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 path to import asset(s) from'
+);
+
+export const fromCms = new Option(
+  '-source, --source-alias <fromCms>',
+  'the cloud CMS alias to import asset(s) from'
+);
+export const fromProject = new Option(
+  '-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',
+  '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) =>
+  program.addOption(alias.hideHelp()).addOption(project.hideHelp());
+
+export const addAuthenticationOptions = (program: Command) =>
+  program
+    .addOption(user.hideHelp())
+    .addOption(password.hideHelp())
+    .addOption(clientId.hideHelp())
+    .addOption(sharedSecret.hideHelp());
+
+const addOutputAndFormatOptions = (program: Command) =>
+  program.addOption(output).addOption(format);
+
+export const addImportOptions = (program: Command) => {
+  for (const command of program.commands) {
+    command.addOption(fromFile).addOption(fromCms).addOption(fromProject);
+  }
+  return program;
+};
+export const addGetEntryOptions = (program: Command) => {
+  for (const command of program.commands) {
+    command.addOption(entryId).addOption(zenql);
+  }
+  return program;
+};
+export const addGlobalOptions = (program: Command) => {
+  for (const command of program.commands) {
+    addOutputAndFormatOptions(command);
+    addConnectOptions(command);
+    addAuthenticationOptions(command);
+  }
+  return program;
+};