contensis-cli 1.0.0-beta.5

package/src/commands/login.ts

@@ -0,0 +1,33 @@
+import { Command } from 'commander';
+import { cliCommand } from '~/services/ContensisCliService';
+import { shell } from '~/shell';
+
+export const makeLoginCommand = () => {
+  const login = new Command()
+    .command('login')
+    .argument('<user/clientId>', 'the username to login with')
+    .argument(
+      '[password]',
+      'the password to use to login with (optional/insecure)'
+    )
+    .option(
+      '-s --shared-secret <sharedSecret>',
+      'the shared secret to use when logging in with a client id'
+    )
+    .usage('<user/clientId> [password] [-s <sharedSecret>]')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > login myuserid\n  -- or --\n  > login {clientId} -s {sharedSecret}
+`
+    )
+    .action(async (user, password, opts) => {
+      const token = await cliCommand(['login', user]).Login(user, {
+        password,
+        sharedSecret: opts.sharedSecret,
+      });
+      if (token) await shell().start();
+    });
+  return login;
+};

package/src/commands/push.ts

@@ -0,0 +1,120 @@
+import { Command } from 'commander';
+import mapJson from 'jsonpath-mapper';
+import { PushBlockParams } from 'migratortron';
+import { cliCommand } from '~/services/ContensisCliService';
+
+export const makePushCommand = () => {
+  const push = new Command()
+    .command('push')
+    .showHelpAfterError(true)
+    .exitOverride();
+
+  push
+    .command('block')
+    .argument('<block-id>', 'the name of the block to push to')
+    .argument(
+      '<image uri:tag>',
+      'the uri and tag of the container image to push as a block (tag default: latest)'
+    )
+    .argument('[branch]', 'the branch we are pushing to')
+    .option(
+      '-r, --release',
+      'whether to release the pushed block version',
+      false
+    )
+    .option(
+      '-cid, --commit-id <commitId>',
+      'the id of the source git commit for the supplied image uri'
+    )
+    .option(
+      '-cmsg, --commit-message <commitMessage>',
+      'the git commit message for the supplied commit id'
+    )
+    .option(
+      '-cdt, --commit-datetime <commitDateTime>',
+      'the timestamp of the source git commit for the supplied image uri'
+    )
+    .option(
+      '-author, --author-email <authorEmail>',
+      'the git email address of the author of the source git commit'
+    )
+    .option(
+      '-committer, --committer-email <committerEmail>',
+      'the git email address of the commiter of the source git commit'
+    )
+    .option(
+      '-repo, --repository-url <repositoryUrl>',
+      'the url of the source repository for the supplied image uri'
+    )
+    .option(
+      '-pr, --provider <sourceProvider>',
+      'the url of the source repository for the supplied image uri'
+    )
+    .usage('<block-id> <image uri> [branch] [options]')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > push block contensis-app ghcr.io/contensis/contensis-app/build-4359 master --release\n`
+    )
+    .action(async (blockId: string, imageUri: string, branch: string, opts) => {
+      const cli = cliCommand(['push', 'block', blockId], opts);
+      const mapSourceVars = {
+        blockId,
+        imageUri,
+        branch,
+        ...opts,
+        ...process.env,
+      };
+
+      const blockRequest = mapJson(mapSourceVars, {
+        autoRelease: { $path: 'release', $default: () => false },
+        id: ['blockId'],
+        image: () => {
+          const lastIndexOfColon = imageUri.lastIndexOf(':');
+          return {
+            uri: imageUri.slice(0, lastIndexOfColon),
+            tag: imageUri.slice(lastIndexOfColon + 1) || 'latest',
+          };
+        },
+        projectId: () => cli.env.currentProject || '',
+        source: {
+          provider: {
+            $path: ['provider'],
+            $return: (provider: string, { GITHUB_ACTIONS, GITLAB_CI }) => {
+              if (provider) return provider;
+              if (GITHUB_ACTIONS) return 'Github';
+              else if (GITLAB_CI) return 'GitlabSelfHosted';
+            },
+          },
+          repositoryUrl: {
+            $path: ['repositoryUrl', 'CI_PROJECT_URL', 'GITHUB_REPOSITORY'],
+            $formatting: (url: string, { GITHUB_ACTIONS }) => {
+              if (GITHUB_ACTIONS) url = `https://github.com/${url}`;
+
+              if (url && !url.endsWith('.git')) return `${url}.git`;
+              return url;
+            },
+          },
+          branch: ['branch', 'CI_COMMIT_REF_NAME', 'GITHUB_REF_NAME'],
+          commit: {
+            id: ['commitId', 'CI_COMMIT_SHORT_SHA', 'GITHUB_SHA'],
+            message: ['commitMessage', 'CI_COMMIT_MESSAGE'], // ${{ github.event.head_commit.message }}
+            dateTime: ['commitDatetime', 'CI_COMMIT_TIMESTAMP'], // ${{ github.event.head_commit.timestamp }}
+            authorEmail: ['authorEmail', 'GITLAB_USER_EMAIL', 'GITHUB_ACTOR'], // ${{ github.event.head_commit.author.email }}
+            committerEmail: [
+              'committerEmail',
+              'GITLAB_USER_EMAIL',
+              'GITHUB_TRIGGERING_ACTOR',
+            ], // ${{ github.event.head_commit.committer.email }}
+          },
+        },
+      }) as PushBlockParams;
+
+      await cli.PushBlock(blockRequest);
+
+      // console.log(process.env);
+    });
+
+  return push;
+};

package/src/commands/remove.ts

@@ -0,0 +1,77 @@
+import { Command } from 'commander';
+import { cliCommand } from '~/services/ContensisCliService';
+import { shell } from '~/shell';
+import { commit, mapContensisOpts } from './globalOptions';
+
+export const makeRemoveCommand = () => {
+  const remove = new Command()
+    .command('remove')
+    .showHelpAfterError(true)
+    .exitOverride();
+
+  remove
+    .command('project')
+    .argument('<projectId>', 'the project id to delete')
+    .usage('<projectId>')
+    .action(async (projectId, opts) => {
+      const project = await cliCommand(
+        ['remove', 'project', projectId],
+        opts
+      ).SetProject(projectId);
+      if (project) await shell().start();
+    });
+  remove
+    .command('key')
+    .argument('<id>', 'the id of the API key to delete')
+    .usage('<id>')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > remove key 4ceb9575-28d3-4d5b-a77b-5e5221e603dd
+`
+    )
+    .action(async (id, opts) => {
+      await cliCommand(['remove', 'key', id], opts).RemoveApiKey(id);
+    });
+
+  remove
+    .command('components')
+    .argument('<id...>', 'the id(s) of the components to delete')
+    .addOption(commit)
+    .usage('<id> [--commit]')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > remove components addressComponent
+`
+    )
+    .action(async (id: string[], opts) => {
+      await cliCommand(
+        ['remove', 'components', id.join(', ')],
+        opts
+      ).RemoveComponents(id, opts.commit);
+    });
+
+  remove
+    .command('contenttypes')
+    .argument('<id...>', 'the id(s) of the content types to delete')
+    .addOption(commit)
+    .usage('<id> [--commit]')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > remove contenttypes blogPost
+`
+    )
+    .action(async (id: string[], opts) => {
+      await cliCommand(
+        ['remove', 'contenttypes', id.join(', ')],
+        opts
+      ).RemoveContentTypes(id, opts.commit);
+    });
+
+  return remove;
+};

package/src/commands/set.ts

@@ -0,0 +1,40 @@
+import { Argument, Command } from 'commander';
+import { cliCommand } from '~/services/ContensisCliService';
+import { shell } from '~/shell';
+
+export const makeSetCommand = () => {
+  const set = new Command()
+    .command('set')
+    .showHelpAfterError(true)
+    .exitOverride();
+  set
+    .command('project')
+    .argument('<projectId>', 'the project id to work with')
+    .usage('<projectId>')
+    .action(async projectId => {
+      const project = await cliCommand([
+        'set',
+        'project',
+        projectId,
+      ]).SetProject(projectId);
+      if (project) await shell().start();
+    });
+  set
+    .command('version')
+    .addArgument(
+      new Argument('<versionStatus>', 'content version status')
+        .choices(['latest', 'published'])
+        .default('latest')
+    )
+    .usage('<latest/published>')
+    .action(async versionStatus => {
+      const success = await cliCommand([
+        'set',
+        'version',
+        versionStatus,
+      ]).SetVersion(versionStatus);
+      if (success) await shell().start();
+    });
+
+  return set;
+};

package/src/index.ts

@@ -0,0 +1,19 @@
+import commands from './commands';
+import { logError } from './util/logger';
+import ContensisCli from './services/ContensisCliService';
+import { jsonFormatter } from './util/json.formatter';
+// new ContensisCli(process.argv).DoCommandTasksAsync();
+
+// This is the CLI part of the app
+const program = commands();
+program
+  .parseAsync(process.argv)
+  .then(() => {
+    ContensisCli.quit();
+  })
+  .catch((err: any) => {
+    if (!err.name?.includes('CommanderError'))
+      logError(err, `CLI ${err.toString()}`);
+    ContensisCli.quit(err);
+  });
+//.exitOverride(() => console.log('exit override!!!'));

package/src/localisation/en-GB.ts

@@ -0,0 +1,211 @@
+import { BlockRunningStatus, 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`,
+    help: () =>
+      'Press [CTRL]+[C] or type "quit" to return to your system shell\nPress [TAB] for suggestions\n',
+    suggestions: () =>
+      `\n${Logger.errorText('>>')} Press [TAB] for suggestions\n`,
+    autocomplete: () => `\n${Logger.errorText('>>')} Available commands:`,
+    unknownError: () => `Something went wrong...`,
+    fileOutput: (format = 'json', path?: string) =>
+      `Output ${format} file: ${Logger.infoText(path)}\n`,
+    noFileOutput: () => `No output written\n`,
+  },
+  command: {
+    notKnown: (command: string) => `${command} is not known`,
+  },
+  envs: {
+    found: (num: number) =>
+      `environments store found containing ${num} environment${
+        num === 1 ? '' : 's'
+      }`,
+    tip: () =>
+      `Connect to a Contensis cloud instance using "contensis connect {cms alias}"`,
+  },
+  connect: {
+    command: {
+      name: () => 'connect',
+      example: () => `Example call:\n  > connect example-dev`,
+    },
+    args: {
+      alias: {
+        name: () => '<alias>',
+        description: () => 'the Contensis Cloud alias to connect with',
+      },
+    },
+    noEnv: () => `Cannot connect - no environment alias specified`,
+    unreachable: (url: string, status: number) =>
+      `Cannot reach ${url}${status ? ` - status ${status}` : ''}`,
+    connected: (env: string) => `Current environment set to "${env}"`,
+    help: () =>
+      `Connect to a Contensis cloud instance using "contensis connect {cms alias}"`,
+    projects: () => `Available projects:`,
+    noProjects: () => `Cannot retrieve projects list`,
+    tip: () =>
+      `Introduce yourself with "login {username}" or "login {clientId} -s {secret}" or by passing credentials as options with your command`,
+  },
+  login: {
+    command: {
+      name: () => 'login',
+      usage: () => `<user/clientId> [password] [-s <sharedSecret>]`,
+      example: () =>
+        `Example call:\n  > login myuserid\n  -- or --\n  > login {clientId} -s {sharedSecret}`,
+    },
+    args: {
+      user: {
+        name: () => '<user/clientId>',
+        description: () => 'the username to login with',
+      },
+      password: {
+        name: () => '[password]',
+        description: () =>
+          'the password to use to login with (optional/insecure)',
+      },
+      secret: {
+        name: () => '-s --sharedSecret <sharedSecret>',
+        description: () =>
+          'the shared secret to use when logging in with a client id',
+      },
+    },
+    passwordPrompt: (env: string, userId: string) =>
+      `Enter password for ${userId}@${env}:`,
+    failed: (env: string, userId: string) =>
+      `Unable to login to ${env} as ${userId}`,
+    success: (env: string, userId: string) =>
+      `User ${userId} connected to ${env} successfully\n`,
+    insecurePassword: () =>
+      `Could not connect to local keystore - your password could be stored unencrypted!`,
+    noEnv: () => `No environment set, use "contensis connect {alias}" first`,
+    noUserId: () => `No user id specified`,
+  },
+  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}"`,
+  },
+  entries: {
+    migrateStatus: (status: MigrateStatus) => {
+      switch (status) {
+        case 'no change':
+          return Logger.successText;
+        case 'create':
+        case 'two-pass':
+        case 'update':
+        case 'delete':
+          return Logger.warningText;
+        case 'error':
+        case 'not found':
+          return Logger.errorText;
+        default:
+          return Logger.infoText;
+      }
+    },
+    removed: (env: string, id: string, commit: boolean) =>
+      `[${env}] ${commit ? `Deleted` : `Will delete`} entry "${id}"`,
+    failedRemove: (env: string, id: string) =>
+      `[${env}] Unable to delete entry "${id}"`,
+    notFound: (id: string) => `Entry "${id}" 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}"`,
+    failedCreate: (env: string, name: string) =>
+      `[${env}] Unable to create API key "${name}"`,
+    removed: (env: string, id: string) => `[${env}] Deleted API key "${id}"`,
+    failedRemove: (env: string, id: string) =>
+      `[${env}] Unable to delete API key "${id}"`,
+  },
+  blocks: {
+    runningStatus: (status: BlockRunningStatus | 'broken') => {
+      switch (status) {
+        case 'available':
+          return Logger.successText(status);
+        case 'pending':
+        case 'starting':
+        case 'stopped':
+          return Logger.warningText(status);
+        case 'degraded':
+        case 'faulted':
+        case 'broken':
+          return Logger.errorText(status);
+        default:
+          return Logger.infoText(status);
+      }
+    },
+    get: (env: string) => `[${env}] Block versions:`,
+    list: (env: string, projectId?: string) =>
+      `[${env}] Blocks in project ${projectId}:`,
+    noList: (env: string, projectId?: string) =>
+      `[${env}] Cannot retrieve blocks in project ${projectId}`,
+    tryPush: (id: string, branch: string, env: string, projectId?: string) =>
+      `[${env}] Request to push block "${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}`,
+    failedPush: (id: string, env: string, projectId?: string) =>
+      `[${env}] Unable to push block "${id}" in project ${projectId}`,
+    deleted: (id: string, env: string, projectId?: string) =>
+      `[${env}] Deleted block "${id}" in project ${projectId}`,
+    failedDelete: (id: string, env: string, projectId?: string) =>
+      `[${env}] Unable to delete block "${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}"`,
+    failedCreate: (env: string, name: string) =>
+      `[${env}] Unable to create Webhook subscription "${name}"`,
+    deleted: (env: string, id: string) =>
+      `[${env}] Deleted Webhook subscription "${id}"`,
+    failedDelete: (env: string, id: string) =>
+      `[${env}] Unable to delete Webhook subscription "${id}"`,
+  },
+};

package/src/models/AppError.d.ts

@@ -0,0 +1,40 @@
+type AppError = (Error & ApiErrorResponse) | ApiErrorResponse;
+
+type InnerDataArray = [
+  {
+    field: string;
+    message: string;
+  }
+];
+
+type ApiErrorResponse = {
+  name?: string;
+  error?: { code: string; message: string };
+  code?: string;
+  type?: string;
+  timeout?: number;
+  status?: number;
+  statusText?: string;
+  url?: string;
+  data?:
+    | {
+        logId: string;
+        message: string;
+        data: InnerDataArray;
+        type: string;
+      }
+    | any;
+};
+
+type MappedError = {
+  status: number;
+  statusText?: string;
+  url?: string;
+  message: string;
+  name?: string;
+  code?: string;
+  type?: string;
+  logId?: string;
+  data?: InnerDataArray | any;
+  stack?: string;
+};

package/src/models/Cache.d.ts

@@ -0,0 +1,25 @@
+type SessionCache = {
+  currentEnvironment?: string;
+  currentTimestamp: string;
+  environments: {
+    [alias: string]: EnvironmentCache;
+  };
+  history: string[];
+};
+
+type EnvironmentCache = {
+  lastUserId: string;
+  passwordFallback?: string;
+  authToken?: string;
+  currentProject?: string;
+  projects: string[];
+  history: CliCommand[];
+  versionStatus: 'latest' | 'published';
+};
+
+type CliCommand = {
+  createdDate: string;
+  createdUserId: string;
+  commandText: string;
+  result?: any;
+};

package/src/models/JsModules.d.ts

@@ -0,0 +1 @@
+declare module 'inquirer-command-prompt';

package/src/providers/CredentialProvider.ts

@@ -0,0 +1,88 @@
+import keytar from 'keytar';
+import to from 'await-to-js';
+import { Logger } from '~/util/logger';
+
+const SERVICE_NAME = 'contensis-cli';
+
+interface Remarks {
+  secure: boolean;
+}
+
+class CredentialProvider {
+  private serviceId: string;
+  private userId: string = '';
+  private passwordFallback?: string;
+
+  current: {
+    account: string;
+    password: string;
+  } | null = null;
+  remarks: Remarks = { secure: false };
+
+  constructor(
+    { userId, alias }: { userId: string; alias?: string },
+    passwordFallback?: string
+  ) {
+    this.serviceId =
+      typeof alias !== 'undefined' ? `${SERVICE_NAME}_${alias}` : SERVICE_NAME;
+    this.userId = userId;
+    this.passwordFallback = passwordFallback;
+  }
+
+  Init = async (): Promise<[Error, CredentialProvider]> => {
+    const [err, stored] = (await to(
+      keytar.findCredentials(this.serviceId)
+    )) as [
+      Error,
+      {
+        account: string;
+        password: string;
+      }[]
+    ];
+    if (err && this.passwordFallback) {
+      this.current = { account: this.userId, password: this.passwordFallback };
+      // this.remarks = { secure: false };
+    }
+    if (!err) {
+      this.remarks = { secure: true };
+      this.current =
+        stored?.find(
+          u => u?.account?.toLowerCase() === this.userId.toLowerCase()
+        ) || null;
+    }
+    return [err, this];
+  };
+
+  Save = async (password: string) => {
+    const [err] = await to(
+      keytar.setPassword(this.serviceId, this.userId, password)
+    );
+
+    if (!err) Logger.info(`${this.serviceId} - credentials saved`);
+    return err && !this.passwordFallback ? err : true;
+  };
+
+  Delete = async () => {
+    if (this.passwordFallback) {
+      this.passwordFallback = undefined;
+      return true;
+    } else {
+      const [err] = await to(
+        keytar.deletePassword(this.serviceId, this.userId)
+      );
+
+      Logger.warning(`${this.serviceId} - invalid credentials removed`);
+      return err || true;
+    }
+  };
+
+  // GetPassword = async () => {
+  //   const [err, password] = await to(
+  //     keytar.getPassword(this.serviceId, this.userId)
+  //   );
+
+  //   return err || password;
+  // };
+}
+
+export default CredentialProvider;