contensis-cli 1.0.0-beta.84 → 1.0.0-beta.86

package/src/commands/get.ts

@@ -1,7 +1,14 @@
-import { Argument, Command } from 'commander';
+import { Argument, Command, Option } from 'commander';
 import { merge } from 'lodash';
 import { cliCommand } from '~/services/ContensisCliService';
-import { addGlobalOptions, mapContensisOpts } from './globalOptions';
+import {
+  addGlobalOptions,
+  assetTypes,
+  contentTypes,
+  entryId,
+  mapContensisOpts,
+  zenql,
+} from './globalOptions';
 
 export const makeGetCommand = () => {
   const program = new Command()
@@ -144,6 +151,52 @@ Example call:
       );
     });
 
+  const sharedGetEntryOptions = (command: Command) =>
+    command
+      .addOption(entryId)
+      .addOption(zenql)
+      .addOption(
+        new Option(
+          '-fi --fields <fields...>',
+          'limit the output fields on returned entries'
+        )
+      )
+      .addOption(
+        new Option(
+          '-ob --order-by <orderBy...>',
+          'field name(s) to order the results by (prefix "-" for descending)'
+        )
+      );
+
+  sharedGetEntryOptions(
+    program
+      .command('assets')
+      .description('get asset entries')
+      .argument(
+        '[search phrase]',
+        'get assets with the search phrase, use quotes for multiple words'
+      )
+      .addOption(assetTypes)
+  )
+    .option('-l --paths <paths...>', 'get assets under the given path(s)')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > get assets --zenql "sys.contentTypeId = blog" --fields sys.id sys.properties.filePath sys.properties.filename
+`
+    )
+    .action(async (phrase: string, opts) => {
+      // Maintaining a separate command for assets vs entries
+      // allows us to offer up more options when dealing with just assets
+      await cliCommand(
+        ['get', 'assets'],
+        opts,
+        mapContensisOpts({ dataFormat: 'asset', phrase, ...opts })
+      ).GetEntries({});
+    });
+
+  sharedGetEntryOptions(
   program
     .command('entries')
     .description('get entries')
@@ -151,24 +204,26 @@ Example call:
       '[search phrase]',
       'get entries with the search phrase, use quotes for multiple words'
     )
-    .option('-i --id <id...>', 'the entry id(s) to get')
+      .addOption(contentTypes)
     .option(
-      '-d, --dependents',
+        '-d --dependents',
       'find and return any dependencies of all found entries'
     )
-    .option(
-      '-fi, --fields <fields...>',
-      'limit the output fields on returned entries'
+  )
+    .addOption(
+      new Option(
+        '--data-format <dataFormat>',
+        'find and return entries of a specific data format'
     )
-    .option(
-      '-q, --zenql <zenql>',
-      'get entries with a supplied ZenQL statement'
+        .choices(['entry', 'asset', 'webpage'])
+        .default('entry')
     )
     .addHelpText(
       'after',
       `
 Example call:
   > get entries --zenql "sys.contentTypeId = blog" --fields entryTitle entryDescription sys.id --output ./blog-posts.csv --format csv
+  > get entries --content-type blog --fields entryTitle sys.version.modified --order-by -sys.version.modified
 `
     )
     .action(async (phrase: string, opts, cmd) => {

package/src/commands/globalOptions.ts

@@ -13,10 +13,23 @@ export const mapContensisOpts = (opts: any = {}) => ({
       : undefined,
   models: opts.modelIds,
   query:
-    opts.id || opts.entryIds || opts.phrase || opts.fields
+    opts.id ||
+    opts.entryIds ||
+    opts.phrase ||
+    opts.fields ||
+    opts.orderBy ||
+    opts.paths ||
+    opts.assetType ||
+    opts.contentType ||
+    opts.dataFormat
       ? {
+          assetTypes: opts.assetType,
+          contentTypeIds: opts.contentType,
+          dataFormats: opts.dataFormat ? [opts.dataFormat] : undefined,
           fields: opts.fields,
           includeIds: opts.id || opts.entryIds,
+          includePaths: opts.paths,
+          orderBy: opts.orderBy,
           searchTerm: opts.phrase,
         }
       : undefined,
@@ -26,64 +39,72 @@ export const mapContensisOpts = (opts: any = {}) => ({
 
 /* Output options */
 const output = new Option(
-  '-o, --output <output>',
+  '-o --output <output>',
   'save output to a file e.g. --output ./output.txt'
 );
 
 const format = new Option(
-  '-f, --format <format>',
+  '-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>',
+  '-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 */
 export const zenql = new Option(
-  '-q, --zenql <zenql>',
+  '-q --zenql <zenql>',
   'get entries with a supplied ZenQL statement'
 );
 
 export const entryId = new Option('-i --id <id...>', 'the entry id(s) to get');
+export const contentTypes = new Option(
+  '-c --content-type <contentType...>',
+  'get entries of these content type(s)'
+);
+export const assetTypes = new Option(
+  '-at --asset-type <assetType...>',
+  'get assets of given content type(s) e.g. image word pdf'
+);
 
 /* 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])'
 );
 
@@ -111,9 +132,17 @@ export const addImportOptions = (program: Command) => {
   }
   return program;
 };
+
+export const getEntryOptions = (command: Command) =>
+  command
+    .addOption(entryId)
+    .addOption(zenql)
+    .addOption(contentTypes)
+    .addOption(assetTypes);
+
 export const addGetEntryOptions = (program: Command) => {
   for (const command of program.commands) {
-    command.addOption(entryId).addOption(zenql);
+    getEntryOptions(command);
   }
   return program;
 };

package/src/commands/import.ts

@@ -103,12 +103,12 @@ Example call:
     )
     .addOption(commit)
     .option(
-      '-preserve, --preserve-guids',
+      '-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>',
+        '-oe --output-entries <outputEntries>',
         'which details of the entries included in the import to output'
       )
         .choices(['errors', 'changes', 'all'])

package/src/commands/login.ts

@@ -12,7 +12,7 @@ export const makeLoginCommand = () => {
       '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>]')

package/src/commands/push.ts

@@ -21,36 +21,36 @@ export const makePushCommand = () => {
     )
     .argument('[branch]', 'the branch we are pushing to')
     .option(
-      '-r, --release',
+      '-r --release',
       'whether to release the pushed block version',
       false
     )
     .option(
-      '-cid, --commit-id <commitId>',
+      '-cid --commit-id <commitId>',
       'the id of the source git commit for the supplied image uri'
     )
     .option(
-      '-cmsg, --commit-message <commitMessage>',
+      '-cmsg --commit-message <commitMessage>',
       'the git commit message for the supplied commit id'
     )
     .option(
-      '-cdt, --commit-datetime <commitDateTime>',
+      '-cdt --commit-datetime <commitDateTime>',
       'the timestamp of the source git commit for the supplied image uri'
     )
     .option(
-      '-author, --author-email <authorEmail>',
+      '-author --author-email <authorEmail>',
       'the git email address of the author of the source git commit'
     )
     .option(
-      '-committer, --committer-email <committerEmail>',
+      '-committer --committer-email <committerEmail>',
       'the git email address of the commiter of the source git commit'
     )
     .option(
-      '-repo, --repository-url <repositoryUrl>',
+      '-repo --repository-url <repositoryUrl>',
       'the url of the source repository for the supplied image uri'
     )
     .option(
-      '-pr, --provider <sourceProvider>',
+      '-pr --provider <sourceProvider>',
       'the url of the source repository for the supplied image uri'
     )
     .usage('<block-id> <image uri> [branch] [options]')

package/src/commands/set.ts

@@ -167,7 +167,7 @@ Example call:
     .description('add entry permissions to a role')
     .argument('<"Role name" or id>', 'the role name or id to update')
     .option(
-      '-contenttypes, --content-type-ids [content-type-id...]',
+      '-contenttypes --content-type-ids [content-type-id...]',
       'any content type ids to add permissions for'
     )
     .option(

package/src/mappers/ContensisCliService-to-RequestHanderSiteConfigYaml.ts

@@ -0,0 +1,44 @@
+import ContensisCli from '~/services/ContensisCliService';
+
+interface ISiteConfigYaml {
+  alias: string;
+  projectId: string;
+  accessToken: string;
+  clientId: string;
+  sharedSecret: string;
+  blocks: {
+    id: string;
+    baseUri: string;
+  }[];
+}
+
+export const mapSiteConfigYaml = async (cli: ContensisCli) => {
+  const credentials = await cli.GetCredentials(cli.env.lastUserId);
+
+  const blocks = [];
+  const blocksRaw = await cli.PrintBlocks();
+
+  for (const block of blocksRaw || []) {
+    const versions = await cli.PrintBlockVersions(
+      block.id,
+      'default',
+      'latest'
+    );
+    if (versions?.[0]) {
+      blocks.push({
+        id: versions[0].id,
+        baseUri: versions[0].previewUrl,
+      });
+    }
+  }
+
+  const siteConfig: ISiteConfigYaml = {
+    alias: cli.currentEnv,
+    projectId: cli.currentProject,
+    accessToken: '',
+    clientId: credentials?.current?.account || '',
+    sharedSecret: credentials?.current?.password || '',
+    blocks,
+  };
+  return siteConfig;
+};

package/src/services/ContensisCliService.ts

@@ -2307,7 +2307,7 @@ class ContensisCli {
 
 export const cliCommand = (
   commandArgs: string[],
-  outputOpts: OutputOptionsConstructorArg,
+  outputOpts?: OutputOptionsConstructorArg,
   contensisOpts: Partial<MigrateRequest> = {}
 ) => {
   return new ContensisCli(['', '', ...commandArgs], outputOpts, contensisOpts);

package/src/version.ts

@@ -1 +1 @@
-export const LIB_VERSION = "1.0.0-beta.84";
+export const LIB_VERSION = "1.0.0-beta.86";