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

package/src/commands/create.ts

@@ -1,70 +1,70 @@
-import { Command } from 'commander';
-import { Project } from 'contensis-core-api';
-import { cliCommand } from '~/services/ContensisCliService';
-import { shell } from '~/shell';
-
-export const makeCreateCommand = () => {
-  const create = new Command()
-    .command('create')
-    .description('create command')
-    .addHelpText('after', `\n`)
-    .showHelpAfterError(true)
-    .exitOverride();
-
-  create
-    .command('project')
-    .description('create a new project')
-    .argument('<projectId>', 'the id of the project to create')
-    .argument('<name>', 'the name of the project to create')
-    .argument('[description]', 'optional description of the project')
-    .option(
-      '-l, --language',
-      'the default language of the project to create',
-      'en-GB'
-    )
-    .option(
-      '-langs, --supported-languages <langs...>',
-      'space separated list of other supported languages'
-    )
-    .usage(
-      'projectId "Project name" ["Description of project"] --language en-GB --supported-languages es-ES de-DE nl-NL'
-    )
-    .addHelpText('after', `\n`)
-    .action(
-      async (projectId: string, name: string, description = '', opts: any) => {
-        const createProject: Project = {
-          id: projectId,
-          name,
-          description,
-          primaryLanguage: opts.language,
-          supportedLanguages: opts.supportedLanguages || [],
-        };
-
-        const project = await cliCommand(
-          ['create', 'project', projectId],
-          opts
-        ).CreateProject(createProject);
-        if (project) await shell().restart();
-      }
-    );
-  create
-    .command('key')
-    .description('create a new api key')
-    .argument('<"key name">', 'the name of the key to create')
-    .argument('["description"]', 'provide a description for the key (optional)')
-    .usage('<"key name"> ["description"] (both args in "double quotes")')
-    .addHelpText(
-      'after',
-      `
-Example call:
-  > create key "my new key" "Created key for demonstration"\n`
-    )
-    .action(async (name: string, description: string, opts: any) => {
-      await cliCommand(['create', 'key', name], opts).CreateApiKey(
-        name,
-        description
-      );
-    });
-
-  return create;
-};
+import { Command } from 'commander';
+import { Project } from 'contensis-core-api';
+import { cliCommand } from '~/services/ContensisCliService';
+import { shell } from '~/shell';
+
+export const makeCreateCommand = () => {
+  const create = new Command()
+    .command('create')
+    .description('create command')
+    .addHelpText('after', `\n`)
+    .showHelpAfterError(true)
+    .exitOverride();
+
+  create
+    .command('project')
+    .description('create a new project')
+    .argument('<projectId>', 'the id of the project to create')
+    .argument('<name>', 'the name of the project to create')
+    .argument('[description]', 'optional description of the project')
+    .option(
+      '-l, --language',
+      'the default language of the project to create',
+      'en-GB'
+    )
+    .option(
+      '-langs, --supported-languages <langs...>',
+      'space separated list of other supported languages'
+    )
+    .usage(
+      'projectId "Project name" ["Description of project"] --language en-GB --supported-languages es-ES de-DE nl-NL'
+    )
+    .addHelpText('after', `\n`)
+    .action(
+      async (projectId: string, name: string, description = '', opts: any) => {
+        const createProject: Project = {
+          id: projectId,
+          name,
+          description,
+          primaryLanguage: opts.language,
+          supportedLanguages: opts.supportedLanguages || [],
+        };
+
+        const project = await cliCommand(
+          ['create', 'project', projectId],
+          opts
+        ).CreateProject(createProject);
+        if (project) await shell().restart();
+      }
+    );
+  create
+    .command('key')
+    .description('create a new api key')
+    .argument('<"key name">', 'the name of the key to create')
+    .argument('["description"]', 'provide a description for the key (optional)')
+    .usage('<"key name"> ["description"] (both args in "double quotes")')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > create key "my new key" "Created key for demonstration"\n`
+    )
+    .action(async (name: string, description: string, opts: any) => {
+      await cliCommand(['create', 'key', name], opts).CreateApiKey(
+        name,
+        description
+      );
+    });
+
+  return create;
+};

package/src/commands/diff.ts

@@ -1,41 +1,41 @@
-import { Command } from 'commander';
-import { cliCommand } from '~/services/ContensisCliService';
-import { mapContensisOpts } from './globalOptions';
-
-export const makeDiffCommand = () => {
-  const release = new Command()
-    .command('diff')
-    .description('diff command')
-    .addHelpText('after', `\n`)
-    .showHelpAfterError(true)
-    .exitOverride();
-
-  release
-    .command('models')
-    .description('differences with content models')
-    .argument(
-      '[model-ids...]',
-      'ids of any content types or components to diff (optional)'
-    )
-    .usage('[model-ids...]')
-    .addHelpText(
-      'after',
-      `
-Example call:
-  > diff models blogPost\n`
-    )
-    .action(async (modelIds: string[] = [], opts) => {
-      await cliCommand(
-        ['diff', 'models', modelIds.join(' ')],
-        opts,
-        mapContensisOpts({ modelIds, ...opts })
-      ).DiffModels(
-        {
-          ...opts,
-        },
-        modelIds
-      );
-    });
-
-  return release;
-};
+import { Command } from 'commander';
+import { cliCommand } from '~/services/ContensisCliService';
+import { mapContensisOpts } from './globalOptions';
+
+export const makeDiffCommand = () => {
+  const release = new Command()
+    .command('diff')
+    .description('diff command')
+    .addHelpText('after', `\n`)
+    .showHelpAfterError(true)
+    .exitOverride();
+
+  release
+    .command('models')
+    .description('differences with content models')
+    .argument(
+      '[model-ids...]',
+      'ids of any content types or components to diff (optional)'
+    )
+    .usage('[model-ids...]')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > diff models blogPost\n`
+    )
+    .action(async (modelIds: string[] = [], opts) => {
+      await cliCommand(
+        ['diff', 'models', modelIds.join(' ')],
+        opts,
+        mapContensisOpts({ modelIds, ...opts })
+      ).DiffModels(
+        {
+          ...opts,
+        },
+        modelIds
+      );
+    });
+
+  return release;
+};

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();