contensis-cli 1.0.0-beta.5 → 1.0.0-beta.50

package/src/commands/remove.ts

@@ -1,27 +1,33 @@
 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`)
     .action(async (projectId, opts) => {
       const project = await cliCommand(
         ['remove', 'project', projectId],
         opts
       ).SetProject(projectId);
-      if (project) await shell().start();
+      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(
@@ -37,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]')
@@ -49,13 +56,14 @@ Example call:
     )
     .action(async (id: string[], opts) => {
       await cliCommand(
-        ['remove', 'components', id.join(', ')],
+        ['remove', 'components', id.join(' ')],
         opts
       ).RemoveComponents(id, opts.commit);
     });
 
   remove
     .command('contenttypes')
+    .description('delete content types')
     .argument('<id...>', 'the id(s) of the content types to delete')
     .addOption(commit)
     .usage('<id> [--commit]')
@@ -68,7 +76,7 @@ Example call:
     )
     .action(async (id: string[], opts) => {
       await cliCommand(
-        ['remove', 'contenttypes', id.join(', ')],
+        ['remove', 'contenttypes', id.join(' ')],
         opts
       ).RemoveContentTypes(id, opts.commit);
     });

package/src/commands/set.ts

@@ -5,35 +5,91 @@ 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',
+      `
+Example call:
+  > set project website\n`
+    )
     .action(async projectId => {
-      const project = await cliCommand([
+      const nextProjectId = cliCommand([
         'set',
         'project',
         projectId,
       ]).SetProject(projectId);
-      if (project) await shell().start();
+      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'])
         .default('latest')
     )
     .usage('<latest/published>')
+    .addHelpText('after', `\n`)
     .action(async versionStatus => {
-      const success = await cliCommand([
-        'set',
-        'version',
-        versionStatus,
-      ]).SetVersion(versionStatus);
-      if (success) await shell().start();
+      const success = cliCommand(['set', 'version', versionStatus]).SetVersion(
+        versionStatus
+      );
+      if (success) await shell().restart();
     });
 
   return set;

package/src/localisation/en-GB.ts

@@ -1,12 +1,16 @@
-import { BlockRunningStatus, MigrateStatus } from 'migratortron';
+import {
+  BlockRunningStatus,
+  MigrateModelsResult,
+  MigrateStatus,
+} from 'migratortron';
 import { Logger } from '~/util/logger';
 
 export const LogMessages = {
   app: {
     contensis: () => 'Contensis',
     quit: () => `Goodbye 👋\n`,
-    startup: () =>
-      `© 2001-${new Date().getFullYear()} Zengenti 🇬🇧. \n - Creators of Contensis and purveyors of other fine software\n\n👋 Welcome to the contensis-cli\n`,
+    startup: (version: string) =>
+      `v${version} © 2001-${new Date().getFullYear()} Zengenti 🇬🇧. \n - Creators of Contensis and purveyors of other fine software\n\n👋 Welcome to the contensis-cli\n`,
     help: () =>
       'Press [CTRL]+[C] or type "quit" to return to your system shell\nPress [TAB] for suggestions\n',
     suggestions: () =>
@@ -73,8 +77,10 @@ export const LogMessages = {
           'the shared secret to use when logging in with a client id',
       },
     },
-    passwordPrompt: (env: string, userId: string) =>
-      `Enter password for ${userId}@${env}:`,
+    passwordPrompt: (env?: string, userId?: string) =>
+      userId
+        ? `Enter password for ${userId}@${env}:`
+        : `Please enter a password`,
     failed: (env: string, userId: string) =>
       `Unable to login to ${env} as ${userId}`,
     success: (env: string, userId: string) =>
@@ -87,49 +93,38 @@ export const LogMessages = {
   projects: {
     list: () => `Available projects:`,
     noList: () => `Cannot retrieve projects list`,
-    set: (projectId: string) => `Current project is set to "${projectId}"`,
-    failedSet: (projectId: string) => `Project "${projectId}" not found`,
-  },
-  contenttypes: {
-    list: (projectId: string) => `Content types in "${projectId}":`,
-    noList: (projectId: string) =>
-      `[${projectId}] Cannot retrieve content types list`,
-    get: (projectId: string, contentTypeId: string) =>
-      `[${projectId}] Content type "${contentTypeId}"`,
-    failedGet: (projectId: string, contentTypeId: string) =>
-      `[${projectId}] Unable to get content type "${contentTypeId}"`,
-    created: (projectId: string, componentId: string, status?: string) =>
-      `[${projectId}] Content type ${status}d "${componentId}"`,
-    removed: (env: string, id: string, commit: boolean) =>
-      `[${env}] ${commit ? `Deleted` : `Will delete`} content type "${id}"`,
-    failedRemove: (env: string, id: string) =>
-      `[${env}] Unable to delete content type "${id}"`,
-  },
-  components: {
-    list: (projectId: string) => `Components in "${projectId}":`,
-    noList: (projectId: string) =>
-      `[${projectId}] Cannot retrieve components list`,
-    get: (projectId: string, componentId: string) =>
-      `[${projectId}] Component "${componentId}"`,
-    failedGet: (projectId: string, componentId: string) =>
-      `[${projectId}] Unable to get component "${componentId}"`,
-    created: (projectId: string, componentId: string, status?: string) =>
-      `[${projectId}] Component ${status}d "${componentId}"`,
-    removed: (env: string, id: string, commit: boolean) =>
-      `[${env}] ${commit ? `Deleted` : `Will delete`} component "${id}"`,
-    failedRemove: (env: string, id: string) =>
-      `[${env}] Unable to delete component "${id}"`,
-  },
-  version: {
-    set: (env: string, versionStatus: string) =>
-      `[${env}] Content version status set to "${versionStatus}"`,
-    invalid: (versionStatus: string) =>
-      `Content version status "${versionStatus}" is not valid, allowed values are "published" or "latest".`,
-    noEnv: () =>
-      `No Contensis environment set, connect to your Contensis cloud instance using "contensis connect {cms alias}"`,
+    set: (projectId: string) =>
+      `Current project is set to ${Logger.highlightText(projectId)}`,
+    failedSet: (projectId: string) =>
+      `Project ${Logger.highlightText(projectId)} not found`,
+    tip: () =>
+      `You need to set your current working project with "set project {projectId}"`,
+    created: (env: string, id: string) =>
+      `[${env}] Created project ${Logger.highlightText(id)}`,
+    failedCreate: (env: string, id: string) =>
+      `[${env}] Unable to create project ${Logger.highlightText(id)}`,
+    updated: (env: string, id: string) =>
+      `[${env}] Updated project ${Logger.highlightText(id)}`,
+    failedUpdate: (env: string, id: string) =>
+      `[${env}] Unable to update project ${Logger.highlightText(id)}`,
   },
-  entries: {
-    migrateStatus: (status: MigrateStatus) => {
+  migrate: {
+    models: {
+      result: (
+        status: keyof MigrateModelsResult['project']['contentTypes']
+      ) => {
+        switch (status) {
+          case 'created':
+          case 'updated':
+            return Logger.successText;
+          case 'errors':
+            return Logger.errorText;
+          default:
+            return Logger.infoText;
+        }
+      },
+    },
+    status: (status: MigrateStatus) => {
       switch (status) {
         case 'no change':
           return Logger.successText;
@@ -145,23 +140,75 @@ export const LogMessages = {
           return Logger.infoText;
       }
     },
+  },
+  models: {
+    list: (projectId: string) =>
+      `Content models in ${Logger.highlightText(projectId)}:`,
+    noList: (projectId: string) =>
+      `[${projectId}] Cannot retrieve content models`,
+    get: (projectId: string, id: string) =>
+      `[${projectId}] Content models ${Logger.infoText(`[ ${id} ]`)}`,
+    failedGet: (projectId: string, id: string) =>
+      `[${projectId}] Unable to get content models ${Logger.highlightText(id)}`,
+  },
+  contenttypes: {
+    list: (projectId: string) =>
+      `Content types in ${Logger.highlightText(projectId)}:`,
+    get: (projectId: string, id: string) =>
+      `[${projectId}] Content type ${Logger.highlightText(id)}`,
+    failedGet: (projectId: string, id: string) =>
+      `[${projectId}] Unable to get content type ${Logger.highlightText(id)}`,
+    created: (projectId: string, id: string, status?: string) =>
+      `[${projectId}] Content type ${status}d ${Logger.highlightText(id)}`,
+    removed: (env: string, id: string, commit: boolean) =>
+      `[${env}] ${
+        commit ? `Deleted` : `Will delete`
+      } content type ${Logger.highlightText(id)}`,
+    failedRemove: (env: string, id: string) =>
+      `[${env}] Unable to delete content type ${Logger.highlightText(id)}`,
+  },
+  components: {
+    list: (projectId: string) =>
+      `Components in ${Logger.highlightText(projectId)}:`,
+    get: (projectId: string, id: string) =>
+      `[${projectId}] Component ${Logger.highlightText(id)}`,
+    failedGet: (projectId: string, id: string) =>
+      `[${projectId}] Unable to get component ${Logger.highlightText(id)}`,
+    created: (projectId: string, id: string, status?: string) =>
+      `[${projectId}] Component ${status}d ${Logger.highlightText(id)}`,
     removed: (env: string, id: string, commit: boolean) =>
-      `[${env}] ${commit ? `Deleted` : `Will delete`} entry "${id}"`,
+      `[${env}] ${
+        commit ? `Deleted` : `Will delete`
+      } component ${Logger.highlightText(id)}`,
     failedRemove: (env: string, id: string) =>
-      `[${env}] Unable to delete entry "${id}"`,
-    notFound: (id: string) => `Entry "${id}" not found`,
+      `[${env}] Unable to delete component ${Logger.highlightText(id)}`,
+  },
+  version: {
+    set: (env: string, versionStatus: string) =>
+      `[${env}] Content version status set to "${versionStatus}"`,
+    invalid: (versionStatus: string) =>
+      `Content version status "${versionStatus}" is not valid, allowed values are "published" or "latest".`,
+    noEnv: () =>
+      `No Contensis environment set, connect to your Contensis cloud instance using "contensis connect {cms alias}"`,
+  },
+  entries: {
+    removed: (env: string, commit: boolean) =>
+      `[${env}] ${commit ? `Deleted` : `Will delete`} entries`,
+    failedRemove: (env: string) => `[${env}] Unable to delete entries`,
+    notFound: (env: string) => `[${env}] Entries were not found`,
     commitTip: () => `  Add --commit flag to commit the previewed changes`,
   },
   keys: {
     list: (env: string) => `[${env}] API keys:`,
     noList: (env: string) => `[${env}] Cannot retrieve API`,
     created: (env: string, name: string) =>
-      `[${env}] Created API key "${name}"`,
+      `[${env}] Created API key ${Logger.highlightText(name)}`,
     failedCreate: (env: string, name: string) =>
-      `[${env}] Unable to create API key "${name}"`,
-    removed: (env: string, id: string) => `[${env}] Deleted API key "${id}"`,
+      `[${env}] Unable to create API key ${Logger.highlightText(name)}`,
+    removed: (env: string, id: string) =>
+      `[${env}] Deleted API key ${Logger.highlightText(id)}`,
     failedRemove: (env: string, id: string) =>
-      `[${env}] Unable to delete API key "${id}"`,
+      `[${env}] Unable to delete API key ${Logger.highlightText(id)}`,
   },
   blocks: {
     runningStatus: (status: BlockRunningStatus | 'broken') => {
@@ -180,32 +227,63 @@ export const LogMessages = {
           return Logger.infoText(status);
       }
     },
-    get: (env: string) => `[${env}] Block versions:`,
+    get: (id: string, env: string, projectId?: string) =>
+      `[${env}] Block ${id} in project ${projectId}:`,
     list: (env: string, projectId?: string) =>
       `[${env}] Blocks in project ${projectId}:`,
     noList: (env: string, projectId?: string) =>
       `[${env}] Cannot retrieve blocks in project ${projectId}`,
+    getLogs: (id: string, branch: string, env: string, projectId?: string) =>
+      `[${env}] Requesting logs from block ${Logger.highlightText(
+        id
+      )} in branch ${branch} in project ${projectId}`,
+    failedGetLogs: (id: string, env: string, projectId?: string) =>
+      `[${env}] Unable to fetch block logs for ${Logger.highlightText(
+        id
+      )} in project ${projectId}`,
     tryPush: (id: string, branch: string, env: string, projectId?: string) =>
-      `[${env}] Request to push block "${id}" in branch ${branch} in project ${projectId}`,
+      `[${env}] Request to push block ${Logger.highlightText(
+        id
+      )} in branch ${branch} in project ${projectId}`,
     pushed: (id: string, branch: string, env: string, projectId?: string) =>
-      `[${env}] Pushed block "${id}" in branch ${branch} in project ${projectId}`,
+      `[${env}] Pushed block ${Logger.highlightText(
+        id
+      )} in branch ${branch} in project ${projectId}`,
     failedPush: (id: string, env: string, projectId?: string) =>
-      `[${env}] Unable to push block "${id}" in project ${projectId}`,
+      `[${env}] Unable to push block ${Logger.highlightText(
+        id
+      )} in project ${projectId}`,
+    released: (id: string, env: string, projectId?: string) =>
+      `[${env}] Released block ${Logger.highlightText(
+        id
+      )} in project ${projectId}`,
+    failedRelease: (id: string, env: string, projectId?: string) =>
+      `[${env}] Unable to release block ${Logger.highlightText(
+        id
+      )} in project ${projectId}`,
     deleted: (id: string, env: string, projectId?: string) =>
-      `[${env}] Deleted block "${id}" in project ${projectId}`,
+      `[${env}] Deleted block ${Logger.highlightText(
+        id
+      )} in project ${projectId}`,
     failedDelete: (id: string, env: string, projectId?: string) =>
-      `[${env}] Unable to delete block "${id}" in project ${projectId}`,
+      `[${env}] Unable to delete block ${Logger.highlightText(
+        id
+      )} in project ${projectId}`,
   },
   webhooks: {
     list: (env: string) => `[${env}] Webhook subscriptions:`,
     noList: (env: string) => `[${env}] Cannot retrieve webhook subscriptions`,
     created: (env: string, name: string) =>
-      `[${env}] Created Webhook subscription "${name}"`,
+      `[${env}] Created Webhook subscription ${Logger.highlightText(name)}`,
     failedCreate: (env: string, name: string) =>
-      `[${env}] Unable to create Webhook subscription "${name}"`,
+      `[${env}] Unable to create Webhook subscription ${Logger.highlightText(
+        name
+      )}`,
     deleted: (env: string, id: string) =>
-      `[${env}] Deleted Webhook subscription "${id}"`,
+      `[${env}] Deleted Webhook subscription ${Logger.highlightText(id)}`,
     failedDelete: (env: string, id: string) =>
-      `[${env}] Unable to delete Webhook subscription "${id}"`,
+      `[${env}] Unable to delete Webhook subscription ${Logger.highlightText(
+        id
+      )}`,
   },
 };

package/src/providers/CredentialProvider.ts

@@ -10,6 +10,7 @@ interface Remarks {
 
 class CredentialProvider {
   private serviceId: string;
+  private keytar!: typeof keytar;
   private userId: string = '';
   private passwordFallback?: string;
 
@@ -29,9 +30,34 @@ class CredentialProvider {
     this.passwordFallback = passwordFallback;
   }
 
+  Import = async () => {
+    try {
+      this.keytar = (await import('keytar')).default;
+    } catch (ex) {
+      this.keytar = {
+        findCredentials: async () => {
+          throw ex;
+        },
+        getPassword: async () => {
+          throw ex;
+        },
+        findPassword: async () => {
+          throw ex;
+        },
+        setPassword: async () => {
+          throw ex;
+        },
+        deletePassword: async () => {
+          throw ex;
+        },
+      };
+    }
+  };
+
   Init = async (): Promise<[Error, CredentialProvider]> => {
+    await this.Import();
     const [err, stored] = (await to(
-      keytar.findCredentials(this.serviceId)
+      this.keytar.findCredentials(this.serviceId)
     )) as [
       Error,
       {
@@ -40,8 +66,10 @@ class CredentialProvider {
       }[]
     ];
     if (err && this.passwordFallback) {
-      this.current = { account: this.userId, password: this.passwordFallback };
-      // this.remarks = { secure: false };
+      this.current = {
+        account: this.userId,
+        password: this.passwordFallback,
+      };
     }
     if (!err) {
       this.remarks = { secure: true };
@@ -49,16 +77,21 @@ class CredentialProvider {
         stored?.find(
           u => u?.account?.toLowerCase() === this.userId.toLowerCase()
         ) || null;
+
+      if (!this.current && this.passwordFallback) {
+        await this.Save(this.passwordFallback);
+        return await this.Init();
+      }
     }
     return [err, this];
   };
 
   Save = async (password: string) => {
     const [err] = await to(
-      keytar.setPassword(this.serviceId, this.userId, password)
+      this.keytar.setPassword(this.serviceId, this.userId, password)
     );
 
-    if (!err) Logger.info(`${this.serviceId} - credentials saved`);
+    // if (!err) Logger.info(`${this.serviceId} - credentials saved`);
     return err && !this.passwordFallback ? err : true;
   };
 
@@ -68,7 +101,7 @@ class CredentialProvider {
       return true;
     } else {
       const [err] = await to(
-        keytar.deletePassword(this.serviceId, this.userId)
+        this.keytar.deletePassword(this.serviceId, this.userId)
       );
 
       Logger.warning(`${this.serviceId} - invalid credentials removed`);

package/src/providers/SessionCacheProvider.ts

@@ -3,7 +3,8 @@ import path from 'path';
 import clone from 'lodash/cloneDeep';
 import mergeWith from 'lodash/mergeWith';
 import unionBy from 'lodash/unionBy';
-import { isJson, tryParse, tryStringify } from '~/util';
+import { appRootDir } from './file-provider';
+import { isJson, tryParse } from '~/util';
 import { Logger } from '~/util/logger';
 
 class SessionCacheProvider {
@@ -11,7 +12,7 @@ class SessionCacheProvider {
   private cache = {} as SessionCache;
 
   constructor() {
-    this.localFilePath = path.join(__dirname, '../../environments.json');
+    this.localFilePath = path.join(appRootDir, 'environments.json');
     this.cache = {
       currentTimestamp: new Date().toISOString(),
       environments: {},
@@ -69,6 +70,32 @@ class SessionCacheProvider {
     }
     return this.Get();
   };
+
+  UpdateEnv = (
+    updateContent: Partial<EnvironmentCache>,
+    env = this.cache.currentEnvironment,
+    setCurrentEnv = true
+  ) => {
+    try {
+      const environment = this.cache.environments[env || ''];
+
+      this.cache.environments[env || ''] = {
+        ...environment,
+        ...updateContent,
+      };
+      this.Update({
+        currentEnvironment: setCurrentEnv ? env : this.cache.currentEnvironment,
+        environments: this.cache.environments,
+      });
+    } catch (ex: any) {
+      // Problem merging cache data for update
+      Logger.error(
+        `Problem updating environment "${env}" in environments.json`
+      );
+      Logger.error(ex);
+    }
+    return this.Get();
+  };
 }
 
 export default SessionCacheProvider;

package/src/providers/file-provider.ts

@@ -1,8 +1,11 @@
 import fs from 'fs';
+import { homedir } from 'os';
 import path from 'path';
-import { path as appRoot } from 'app-root-path';
 import { tryParse } from '~/util';
 
+const userHomeDir = homedir();
+export const appRootDir = path.join(userHomeDir, '.contensis/');
+
 export const readJsonFile = <T>(filePath: string) => {
   const file = readFile(filePath);
   if (file) return tryParse(file) as T | string;
@@ -42,8 +45,8 @@ export const removeFile = (filePath: string) => {
 };
 
 export const moveFile = (file: string, fromPath: string, toPath: string) => {
-  const from = path.join(appRoot, `${fromPath}${file}`);
-  const to = path.join(appRoot, `${toPath}${file}`);
+  const from = path.join(appRootDir, `${fromPath}${file}`);
+  const to = path.join(appRootDir, `${toPath}${file}`);
   if (fs.existsSync(from)) {
     checkDir(toPath);
     // if (!fs.existsSync(toPath)) fs.mkdirSync(toPath, { recursive: true });
@@ -69,4 +72,5 @@ export const checkDir = (filePath: string) => {
     fs.mkdirSync(directoryPath, { recursive: true });
 };
 
-export const localPath = (filePath: string) => path.join(appRoot, filePath);
+export const localPath = (filePath: string) =>
+  path.isAbsolute(filePath) ? filePath : path.join(appRootDir, filePath);