contensis-cli 1.3.1-beta.0 → 1.3.1-beta.10

package/src/commands/globalOptions.ts

@@ -16,6 +16,7 @@ export const mapContensisOpts = (opts: any = {}): MigrateRequest => ({
       : undefined,
   models: opts.modelIds,
   copyField: opts.copyField,
+  updateField: opts.updateField,
   // convert various cli options into MigrateRequest.query format
   query:
     opts.id ||
@@ -49,6 +50,7 @@ export const mapContensisOpts = (opts: any = {}): MigrateRequest => ({
   noCache: !opts.cache, // arg is inverted automatically from `--no-cache` to `cache: false`
   includeDefaults: opts.defaults, // arg is inverted automatically from `--no-defaults` to `defaults: false`
   concurrency: opts.concurrency ? Number(opts.concurrency) : undefined,
+  noPublish: !opts.publish, // arg is inverted automatically from `--no-publish` to `publish: false`
 });
 
 /* Output options */
@@ -59,8 +61,8 @@ const output = new Option(
 
 const format = new Option(
   '-f --format <format>',
-  'format output as csv, json, xml or table (default)'
-).choices(['csv', 'json', 'xml', 'table']);
+  'format output as csv, json, html, xml or default'
+).choices(['csv', 'json', 'html', 'xml', 'table']);
 
 /* Connect options */
 const alias = new Option(
@@ -177,7 +179,12 @@ export const concurrency = new Option(
 
 export const noCache = new Option(
   '--no-cache',
-  'add this flag to ignore internal cache and rebuild all resources from scratch'
+  'ignore internal cache and rebuild all resources from scratch'
+);
+
+export const noPublish = new Option(
+  '--no-publish',
+  "don't publish created or updated entries"
 );
 
 export const addConnectOptions = (program: Command) =>

package/src/commands/import.ts

@@ -10,6 +10,7 @@ import {
   latest,
   mapContensisOpts,
   noCache,
+  noPublish,
   outputDetail,
   saveEntries,
   versionStatus,
@@ -139,6 +140,7 @@ Example call:
     .addOption(outputDetail)
     .addOption(ignoreErrors)
     .addOption(noCache)
+    .addOption(noPublish)
     .addOption(saveEntries)
     .addHelpText(
       'after',

package/src/commands/index.ts

@@ -20,6 +20,7 @@ import { makeLoginCommand } from './login';
 import { makePushCommand } from './push';
 import { makeRemoveCommand } from './remove';
 import { makeSetCommand } from './set';
+import { makeUpdateCommand } from './update';
 
 const commands = () => {
   const program = new Command()
@@ -89,6 +90,9 @@ const commands = () => {
   program.addCommand(
     addConnectOptions(makeSetCommand()).copyInheritedSettings(program)
   );
+  program.addCommand(
+    addGlobalOptions(makeUpdateCommand()).copyInheritedSettings(program)
+  );
 
   return program;
 };

package/src/commands/push.ts

@@ -1,7 +1,18 @@
 import { Command } from 'commander';
 import mapJson from 'jsonpath-mapper';
-import { PushBlockParams } from 'migratortron';
+import { generateGuid, PushBlockParams } from 'migratortron';
+import path from 'path';
+import { Asset } from 'contensis-delivery-api';
 import { cliCommand } from '~/services/ContensisCliService';
+import {
+  commit,
+  mapContensisOpts,
+  noPublish,
+  outputDetail,
+  saveEntries,
+} from './globalOptions';
+import { jsonFormatter } from '~/util/json.formatter';
+import { cwdPath } from '~/providers/file-provider';
 
 export const makePushCommand = () => {
   const push = new Command()
@@ -11,6 +22,119 @@ export const makePushCommand = () => {
     .showHelpAfterError(true)
     .exitOverride();
 
+  push
+    .command('asset')
+    .description('push an asset')
+    .argument('<content-type-id>', 'the content type id of the asset to push')
+    .argument(
+      '<title>',
+      'the title of the asset as it appears in the cms (use quotes)'
+    )
+    .argument(
+      '[description]',
+      'the description or altText of the asset (use quotes)'
+    )
+    .option(
+      '-from --from-file <fromFile>',
+      'the local file path of the source asset'
+    )
+    .option('-url --from-url <fromUrl>', 'the full url of the source asset')
+    .option(
+      '-to --target-file-path <targetFilePath>',
+      'the file path in the cms project to push the asset to e.g. "/asset-library/"'
+    )
+    .option(
+      '-name --target-file-name <targetFileName>',
+      'set the file name in the cms project'
+    )
+    .option('-i --id <id>', 'push the asset with a specific guid')
+    .addOption(commit)
+    .addOption(noPublish)
+    .addOption(outputDetail)
+    .addOption(saveEntries)
+    .usage('<content-type-id> <title> [description] [options]')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > push asset pdf "Example file" "An example of a PDF asset" --from-file example.pdf --target-file-path /asset-library/pdf/\n`
+    )
+    .action(
+      async (
+        contentTypeId: string,
+        title: string,
+        description: string,
+        opts
+      ) => {
+        const cli = cliCommand(
+          ['push', 'asset', contentTypeId, title, description],
+          opts,
+          mapContensisOpts({ preserveGuids: true, ...opts, id: undefined })
+        );
+        const mapSourceVars = {
+          contentTypeId,
+          title,
+          description,
+          ...opts,
+        };
+
+        const assetEntry: Asset = mapJson(mapSourceVars, {
+          entryTitle: 'title',
+          title: 'title',
+          entryDescription: 'description',
+          description: 'description',
+          altText: ({ contentTypeId, description }) =>
+            contentTypeId === 'image' ? description : undefined,
+          sys: {
+            dataFormat: () => 'asset',
+            contentTypeId: 'contentTypeId',
+            id: 'id',
+            isPublished: () => true, // can be overridden by !opts.publish
+            properties: {
+              filename: {
+                $path: ['targetFileName', 'fromFile', 'fromUrl'],
+                $formatting: (nameOrPath: string) => {
+                  return path.basename(nameOrPath);
+                },
+              },
+              filePath: {
+                $path: 'targetFilePath',
+                $default: (_, { fromFile, fromUrl }) => {
+                  const toPosixPath = (windowsPath: string) =>
+                    windowsPath.replace(/^(\w):|\\+/g, '/$1');
+
+                  return path.dirname(
+                    toPosixPath(fromFile || fromUrl.split(':/')[1])
+                  );
+                },
+              },
+            },
+            uri: {
+              $path: ['fromFile', 'fromUrl'],
+              $formatting: (from: string) =>
+                from?.startsWith('http') ? from : cwdPath(from),
+            },
+          },
+        });
+
+        if (!assetEntry.sys.id)
+          assetEntry.sys.id = generateGuid(
+            cli.currentEnv,
+            cli.currentProject,
+            `${assetEntry.sys.contentTypeId}-${assetEntry.sys.properties.filePath.replaceAll('/', '').toLowerCase()}-${assetEntry.sys.properties.filename.toLowerCase()}`
+          );
+
+        console.log(jsonFormatter(assetEntry));
+
+        await cli.ImportEntries({
+          commit: opts.commit,
+          logOutput: opts.outputDetail,
+          saveEntries: opts.saveEntries,
+          data: [assetEntry],
+        });
+      }
+    );
+
   push
     .command('block')
     .description('push a block')

package/src/commands/remove.ts

@@ -12,6 +12,26 @@ export const makeRemoveCommand = () => {
     .showHelpAfterError(true)
     .exitOverride();
 
+  remove
+    .command('env')
+    .description('Remove a previously connected environment from the CLI')
+    .argument('<alias>', 'the Contensis Cloud alias to remove')
+    .usage('<alias>')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > remove env ludlow-uni-dev
+`
+    )
+    .action(async (alias: string, opts) => {
+      const currentEnvironment = await cliCommand(
+        ['remove', 'env', alias],
+        opts
+      ).RemoveEnvironment(alias);
+      if (!currentEnvironment) await shell().restart();
+    });
+
   remove
     .command('project')
     .description('remove an entire project')

package/src/commands/update.ts

@@ -0,0 +1,84 @@
+import { Command } from 'commander';
+import { UpdateField } from 'migratortron';
+import { cliCommand } from '~/services/ContensisCliService';
+import {
+  commit,
+  concurrency,
+  entryId,
+  ignoreErrors,
+  latest,
+  mapContensisOpts,
+  noCache,
+  noPublish,
+  outputDetail,
+  saveEntries,
+  versionStatus,
+  zenql,
+} from './globalOptions';
+
+export const makeUpdateCommand = () => {
+  const update = new Command()
+    .command('update')
+    .description('update command')
+    .addHelpText('after', `\n`)
+    .showHelpAfterError(true)
+    .exitOverride();
+
+  update
+    .command('field')
+    .description('find and replace within entry fields')
+    .argument('<fieldId>', 'the id of the field to update')
+    .argument(
+      '<find>',
+      'the string to find within each entry/field (surround a phrase in double quotes)'
+    )
+    .argument(
+      '<replace>',
+      'the string to replace with (surround a phrase in double quotes)'
+    )
+    .addOption(commit)
+    .addOption(concurrency)
+    .addOption(ignoreErrors)
+    .addOption(outputDetail.default('changes'))
+    .addOption(noCache)
+    .addOption(noPublish)
+    .option(
+      '--search <phrase>',
+      'get entries with the search phrase, use quotes for multiple words'
+    )
+    .addOption(entryId)
+    .addOption(zenql)
+    .addOption(latest)
+    .addOption(versionStatus)
+    .addOption(saveEntries)
+    .usage('<fieldId> <find> <replace> (all arguments required)')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > update field authorName "Emma Smith" "Emma Davies" --zenql "sys.contentTypeId=blog"\n`
+    )
+    .action(
+      async (fieldId: string, find: string, replace: string, opts: any) => {
+        const updateField: UpdateField = {
+          fieldId,
+          find,
+          replace,
+        };
+
+        return await cliCommand(
+          ['update', 'field', fieldId, find, replace],
+          opts,
+          mapContensisOpts({ updateField, ...opts })
+        ).UpdateEntryField({
+          commit: opts.commit,
+          fromFile: opts.fromFile,
+          logOutput: opts.outputDetail,
+          saveEntries: opts.saveEntries,
+        });
+      }
+    );
+
+  return update;
+};
+

package/src/factories/RequestHandlerFactory.ts

@@ -218,7 +218,7 @@ export class RequestHandlerFactory {
     const { manifest, messages, moduleInfo } = this;
 
     if (moduleInfo.install && moduleInfo.version !== moduleInfo.install) {
-      let { apply } =
+      const { apply } =
         moduleInfo.version === '*'
           ? { apply: true }
           : await inquirer.prompt({

package/src/localisation/en-GB.ts

@@ -30,7 +30,11 @@ export const LogMessages = {
   },
   envs: {
     found: (num: number) =>
-      `environments store found containing ${pl('environment', num, true)}`,
+      `Environments store found containing ${pl('environment', num, true)}`,
+    notFound: (alias: string) =>
+      `Environment ${Logger.highlightText(alias)} was not found in session cache`,
+    removed: (alias: string) =>
+      `Removed environment ${Logger.highlightText(alias)} from session cache`,
     tip: () =>
       `Connect to a Contensis cloud instance using "contensis connect {cms alias}"`,
   },
@@ -111,6 +115,8 @@ export const LogMessages = {
       `[${env}] Unable to update project ${Logger.highlightText(id)}`,
   },
   migrate: {
+    preview: (verb = 'IMPORT') => `🔍 ${verb} PREVIEW 🔭`,
+    commit: (verb = 'IMPORT') => `COMMITTING ${verb} ✨☄️ `,
     models: {
       result: (
         status: keyof MigrateModelsResult['project']['contentTypes']
@@ -220,6 +226,15 @@ export const LogMessages = {
         nodes > 0 ? ` and ${pl('node', nodes, true)}` : ''
       } into ${env} environment`,
     failedImport: (env: string) => `[${env}] Unable to import entries`,
+    update: {
+      preview: () => LogMessages.migrate.preview('UPDATE FIELD'),
+      commit: () => LogMessages.migrate.preview('FIELD UPDATES'),
+      success: (env: string, commit: boolean, entries: number, nodes = 0) =>
+        `${commit ? `Updated` : `Will update`} ${pl('entry', entries, true)}${
+          nodes > 0 ? ` and ${pl('node', nodes, true)}` : ''
+        } in ${env} environment`,
+      failed: (env: string) => `[${env}] Unable to update any entries`,
+    },
     removed: (env: string, commit: boolean) =>
       `[${env}] ${commit ? `Deleted` : `Will delete`} entries`,
     failedRemove: (env: string) => `[${env}] Unable to delete entries`,

package/src/models/CliService.d.ts

@@ -9,7 +9,7 @@ export type CliUrls =
     }
   | undefined;
 
-export type OutputFormat = 'json' | 'csv' | 'xml';
+export type OutputFormat = 'json' | 'csv' | 'html' | 'xml';
 
 export type OutputOptions = {
   format?: OutputFormat;

package/src/providers/CredentialProvider.ts

@@ -54,12 +54,12 @@ class CredentialProvider {
     }
   };
 
-  Init = async (): Promise<[Error, CredentialProvider]> => {
+  Init = async (): Promise<[Error | null, CredentialProvider]> => {
     await this.Import();
 
     const [err, stored] = (await to(
       this.keytar.getPassword(this.serviceId, this.userId)
-    )) as [Error, string];
+    )) as [Error | null, string];
 
     if (err && this.passwordFallback) {
       this.current = {

package/src/providers/SessionCacheProvider.ts

@@ -29,16 +29,18 @@ class SessionCacheProvider {
       } else {
         this.WriteCacheToDisk();
       }
-    } catch (ex) {
+    } catch (ex: any) {
       // Problem reading or parsing cache file
+      Logger.error(ex);
     }
   };
 
   private WriteCacheToDisk = () => {
     try {
       fs.writeFileSync(this.localFilePath, JSON.stringify(this.cache, null, 2));
-    } catch (ex) {
+    } catch (ex: any) {
       // Problem writing session cache to file
+      Logger.error(ex);
     }
   };
 
@@ -96,6 +98,28 @@ class SessionCacheProvider {
     }
     return this.Get();
   };
+
+  RemoveEnv = (env: string) => {
+    try {
+      const environment = this.cache.environments[env || ''];
+      if (environment) delete this.cache.environments[env || ''];
+
+      this.Update({
+        currentEnvironment:
+          this.cache.currentEnvironment === env
+            ? ''
+            : this.cache.currentEnvironment,
+        environments: this.cache.environments,
+      });
+    } catch (ex: any) {
+      // Problem merging cache data for update
+      Logger.error(
+        `Problem removing environment "${env}" in environments.json`
+      );
+      Logger.error(ex);
+    }
+    return this.Get();
+  };
 }
 
 export default SessionCacheProvider;