contensis-cli 1.0.0-beta.46 → 1.0.0-beta.48

package/src/commands/get.ts

@@ -11,7 +11,7 @@ export const makeGetCommand = () => {
 
   program
     .command('version')
-    .description('Get current Contensis version')
+    .description('get current Contensis version')
     .addHelpText(
       'after',
       `
@@ -23,9 +23,26 @@ Example call:
       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')
+    .description('get a content model')
     .argument('<contentTypeId...>', 'ids of the content models to get')
     .addHelpText(
       'after',
@@ -43,7 +60,7 @@ Example call:
 
   program
     .command('contenttype')
-    .description('Get a content type')
+    .description('get a content type')
     .argument('<contentTypeId>', 'the API id of the content type to get')
     .addHelpText(
       'after',
@@ -61,7 +78,7 @@ Example call:
 
   program
     .command('component')
-    .description('Get a component')
+    .description('get a component')
     .argument('<componentId>', 'the API id of the component to get')
     .addHelpText(
       'after',
@@ -78,7 +95,7 @@ Example call:
 
   program
     .command('entries')
-    .description('Get entries')
+    .description('get entries')
     .argument(
       '[search phrase]',
       'get entries with the search phrase, use quotes for multiple words'
@@ -117,7 +134,7 @@ Example call:
 
   const block = program
     .command('block')
-    .description('Get a block or block version')
+    .description('get a block or block version')
     .argument('[blockId]', 'the block to get version details for')
     .argument(
       '[branch]',
@@ -152,7 +169,7 @@ Example call:
 
   block
     .command('logs')
-    .description('Get logs for a block')
+    .description('get logs for a block')
     .argument('[blockId]', 'the block to get version logs for')
     .argument(
       '[branch]',

package/src/commands/list.ts

@@ -4,6 +4,7 @@ import { cliCommand } from '~/services/ContensisCliService';
 export const makeListCommand = () => {
   const list = new Command()
     .command('list')
+    .description('list command')
     .addHelpText('after', `\n`)
     .showHelpAfterError(true)
     .exitOverride();
@@ -24,14 +25,14 @@ Example call:
 
   list
     .command('projects')
-    .description('Print list of projects')
+    .description('print list of projects')
     .action(async opts => {
       await cliCommand(['list', 'projects'], opts).PrintProjects();
     });
 
   list
     .command('models')
-    .description('Print list of content models')
+    .description('print list of content models')
     .addHelpText(
       'after',
       `
@@ -45,7 +46,7 @@ Example call:
 
   list
     .command('contenttypes')
-    .description('Print list of content types')
+    .description('print list of content types')
     .addHelpText(
       'after',
       `
@@ -59,7 +60,7 @@ Example call:
 
   list
     .command('components')
-    .description('Print list of components')
+    .description('print list of components')
     .addHelpText(
       'after',
       `
@@ -73,7 +74,7 @@ Example call:
 
   list
     .command('blocks')
-    .description('Print list of content blocks')
+    .description('print list of content blocks')
     .addHelpText(
       'after',
       `
@@ -87,7 +88,7 @@ Example call:
 
   list
     .command('keys')
-    .description('Print list of API keys')
+    .description('print list of API keys')
     .addHelpText(
       'after',
       `
@@ -101,7 +102,7 @@ Example call:
 
   list
     .command('webhooks')
-    .description('Print list of 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`)

package/src/commands/push.ts

@@ -6,12 +6,14 @@ import { cliCommand } from '~/services/ContensisCliService';
 export const makePushCommand = () => {
   const push = new Command()
     .command('push')
+    .description('push command')
     .addHelpText('after', `\n`)
     .showHelpAfterError(true)
     .exitOverride();
 
   push
     .command('block')
+    .description('push a block')
     .argument('<block-id>', 'the name of the block to push to')
     .argument(
       '<image uri:tag>',

package/src/commands/release.ts

@@ -4,12 +4,14 @@ import { cliCommand } from '~/services/ContensisCliService';
 export const makeReleaseCommand = () => {
   const release = new Command()
     .command('release')
+    .description('release command')
     .addHelpText('after', `\n`)
     .showHelpAfterError(true)
     .exitOverride();
 
   release
     .command('block')
+    .description('release a block version')
     .argument('<block-id>', 'the name of the block to release')
     .argument('<version>', 'the block version to release')
     .usage('<block-id> <version>')

package/src/commands/remove.ts

@@ -1,17 +1,19 @@
 import { Command } from 'commander';
 import { cliCommand } from '~/services/ContensisCliService';
 import { shell } from '~/shell';
-import { commit, mapContensisOpts } from './globalOptions';
+import { commit, mapContensisOpts, zenql } from './globalOptions';
 
 export const makeRemoveCommand = () => {
   const remove = new Command()
     .command('remove')
+    .description('remove command')
     .addHelpText('after', `\n`)
     .showHelpAfterError(true)
     .exitOverride();
 
   remove
     .command('project')
+    .description('remove an entire project')
     .argument('<projectId>', 'the project id to delete')
     .usage('<projectId>')
     .addHelpText('after', `\n`)
@@ -22,8 +24,10 @@ export const makeRemoveCommand = () => {
       ).SetProject(projectId);
       if (project) await shell().restart();
     });
+
   remove
     .command('key')
+    .description('remove api key')
     .argument('<id>', 'the id of the API key to delete')
     .usage('<id>')
     .addHelpText(
@@ -39,6 +43,7 @@ Example call:
 
   remove
     .command('components')
+    .description('delete components')
     .argument('<id...>', 'the id(s) of the components to delete')
     .addOption(commit)
     .usage('<id> [--commit]')
@@ -58,6 +63,7 @@ Example call:
 
   remove
     .command('contenttypes')
+    .description('delete content types')
     .argument('<id...>', 'the id(s) of the content types to delete')
     .addOption(commit)
     .usage('<id> [--commit]')

package/src/commands/set.ts

@@ -5,22 +5,79 @@ import { shell } from '~/shell';
 export const makeSetCommand = () => {
   const set = new Command()
     .command('set')
+    .description('set command')
     .addHelpText('after', `\n`)
     .showHelpAfterError(true)
     .exitOverride();
-  set
+
+  const project = set
     .command('project')
+    .description('set current working project')
     .argument('<projectId>', 'the project id to work with')
     .usage('<projectId>')
-    .addHelpText('after', `\n`)
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > set project website\n`
+    )
     .action(async projectId => {
-      const project = cliCommand(['set', 'project', projectId]).SetProject(
-        projectId
-      );
-      if (project) await shell().restart();
+      const nextProjectId = cliCommand([
+        'set',
+        'project',
+        projectId,
+      ]).SetProject(projectId);
+      if (nextProjectId) await shell().restart();
     });
+
+  project
+    .command('name')
+    .description('update project name')
+    .argument('<"Project name">', 'update the current project name')
+    .usage('<"Project name">')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > set project name "Project name"\n`
+    )
+    .action(async (name: string, opts) => {
+      const success = await cliCommand(
+        ['set', 'project', 'name'],
+        opts
+      ).UpdateProject({
+        name,
+      });
+      if (success) await shell().restart();
+    });
+
+  project
+    .command('description')
+    .description('update project description')
+    .argument(
+      '<"Project description">',
+      'update the current project description'
+    )
+    .usage('<"Project description">')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > set project description "Description of project"\n`
+    )
+    .action(async (description: string, opts) => {
+      const success = await cliCommand(
+        ['set', 'project', 'description'],
+        opts
+      ).UpdateProject({
+        description,
+      });
+      if (success) await shell().restart();
+    });
+
   set
     .command('version')
+    .description('set content version')
     .addArgument(
       new Argument('<versionStatus>', 'content version status')
         .choices(['latest', 'published'])

package/src/services/ContensisCliService.ts

@@ -643,6 +643,32 @@ class ContensisCli {
     }
   };
 
+  PrintProject = async (projectId = this.currentProject) => {
+    const { log, messages, session } = this;
+    const contensis = await this.ConnectContensis();
+
+    if (contensis) {
+      // Retrieve projects list for env
+      const [projectsErr, projects] = await to(
+        contensis.projects.GetSourceProjects()
+      );
+
+      const foundProject = projects?.find(
+        p => p.id.toLowerCase() === projectId.toLowerCase()
+      );
+
+      if (foundProject) {
+        log.raw('');
+        this.HandleFormattingAndOutput(foundProject, log.object);
+      }
+
+      if (projectsErr) {
+        log.error(messages.projects.noList());
+        log.error(projectsErr.message);
+      }
+    }
+  };
+
   SetProject = (projectId = 'website') => {
     const { env, log, messages, session } = this;
     let nextProjectId: string | undefined;
@@ -811,25 +837,28 @@ class ContensisCli {
     }
   };
 
-  UpdateProject = async (project: Project) => {
-    const { currentEnv, log, messages } = this;
+  UpdateProject = async (project: Partial<Project>) => {
+    const { currentEnv, currentProject, log, messages } = this;
     const contensis = await this.ConnectContensis();
 
     if (contensis) {
-      const [err, updated] = await contensis.projects.UpdateProject(project);
+      const [err, updated] = await contensis.projects.UpdateProject({
+        id: currentProject,
+        ...project,
+      });
 
       if (updated) {
-        log.success(messages.projects.updated(currentEnv, project.id));
+        log.success(messages.projects.updated(currentEnv, currentProject));
 
-        this.HandleFormattingAndOutput(updated, () => {
-          // print the projects to console
-          this.PrintProjects();
-        });
-        return project.id;
+        this.HandleFormattingAndOutput(updated, log.object);
+        return updated.id;
       }
 
       if (err) {
-        log.error(messages.projects.failedUpdate(currentEnv, project.id), err);
+        log.error(
+          messages.projects.failedUpdate(currentEnv, currentProject),
+          err
+        );
       }
     }
   };

package/src/shell.ts

@@ -143,6 +143,7 @@ class ContensisShell {
         'get component',
         'get entries',
         'get model',
+        'get project',
         'get version',
         'import contenttypes',
         'import components',

package/src/version.ts

@@ -1 +1 @@
-export const LIB_VERSION = "1.0.0-beta.46";
+export const LIB_VERSION = "1.0.0-beta.48";