@knocklabs/cli 0.1.0-rc.4 → 0.1.0

package/README.md

@@ -16,7 +16,7 @@ $ npm install -g @knocklabs/cli
 $ knock COMMAND
 running command...
 $ knock (--version)
-@knocklabs/cli/0.1.0-rc.4 linux-x64 node-v16.4.2
+@knocklabs/cli/0.1.0 linux-x64 node-v16.4.2
 $ knock --help [COMMAND]
 USAGE
   $ knock COMMAND
@@ -30,7 +30,6 @@ USAGE
 * [`knock commit`](#knock-commit)
 * [`knock commit promote`](#knock-commit-promote)
 * [`knock help [COMMANDS]`](#knock-help-commands)
-* [`knock ping`](#knock-ping)
 * [`knock plugins`](#knock-plugins)
 * [`knock plugins:install PLUGIN...`](#knock-pluginsinstall-plugin)
 * [`knock plugins:inspect PLUGIN...`](#knock-pluginsinspect-plugin)
@@ -40,10 +39,12 @@ USAGE
 * [`knock plugins:uninstall PLUGIN...`](#knock-pluginsuninstall-plugin-1)
 * [`knock plugins:uninstall PLUGIN...`](#knock-pluginsuninstall-plugin-2)
 * [`knock plugins update`](#knock-plugins-update)
+* [`knock translation get TRANSLATIONREF`](#knock-translation-get-translationref)
 * [`knock translation list`](#knock-translation-list)
-* [`knock translation pull`](#knock-translation-pull)
+* [`knock translation pull [TRANSLATIONREF]`](#knock-translation-pull-translationref)
 * [`knock translation push [TRANSLATIONREF]`](#knock-translation-push-translationref)
 * [`knock translation validate [TRANSLATIONREF]`](#knock-translation-validate-translationref)
+* [`knock whoami`](#knock-whoami)
 * [`knock workflow activate WORKFLOWKEY`](#knock-workflow-activate-workflowkey)
 * [`knock workflow get WORKFLOWKEY`](#knock-workflow-get-workflowkey)
 * [`knock workflow list`](#knock-workflow-list)
@@ -66,7 +67,7 @@ FLAGS
   --service-token=<value>       (required) The service token to authenticate with
 ```
 
-_See code: [dist/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.0-rc.4/dist/commands/commit/index.ts)_
+_See code: [dist/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.0/dist/commands/commit/index.ts)_
 
 ## `knock commit promote`
 
@@ -100,26 +101,6 @@ DESCRIPTION
 
 _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.9/src/commands/help.ts)_
 
-## `knock ping`
-
-Ping the Knock management API to verify access.
-
-```
-USAGE
-  $ knock ping --service-token <value>
-
-FLAGS
-  --service-token=<value>  (required) The service token to authenticate with
-
-DESCRIPTION
-  Ping the Knock management API to verify access.
-
-EXAMPLES
-  $ knock ping
-```
-
-_See code: [dist/commands/ping.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.0-rc.4/dist/commands/ping.ts)_
-
 ## `knock plugins`
 
 List installed plugins.
@@ -353,6 +334,22 @@ DESCRIPTION
   Update installed plugins.
 ```
 
+## `knock translation get TRANSLATIONREF`
+
+```
+USAGE
+  $ knock translation get TRANSLATIONREF --service-token <value> [--environment <value>] [--hide-uncommitted-changes]
+    [--json]
+
+FLAGS
+  --environment=<value>       [default: development]
+  --hide-uncommitted-changes
+  --service-token=<value>     (required) The service token to authenticate with
+
+GLOBAL FLAGS
+  --json  Format output as json.
+```
+
 ## `knock translation list`
 
 ```
@@ -372,12 +369,12 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-## `knock translation pull`
+## `knock translation pull [TRANSLATIONREF]`
 
 ```
 USAGE
-  $ knock translation pull --service-token <value> [--environment <value>] [--translations-dir <value> --all]
-    [--hide-uncommitted-changes] [--force]
+  $ knock translation pull [TRANSLATIONREF] --service-token <value> [--environment <value>] [--translations-dir
+    <value> --all] [--hide-uncommitted-changes] [--force]
 
 FLAGS
   --all
@@ -421,6 +418,21 @@ FLAGS
   --translations-dir=<value>
 ```
 
+## `knock whoami`
+
+```
+USAGE
+  $ knock whoami --service-token <value> [--json]
+
+FLAGS
+  --service-token=<value>  (required) The service token to authenticate with
+
+GLOBAL FLAGS
+  --json  Format output as json.
+```
+
+_See code: [dist/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.0/dist/commands/whoami.ts)_
+
 ## `knock workflow activate WORKFLOWKEY`
 
 ```
@@ -490,25 +502,31 @@ FLAGS
 
 ```
 USAGE
-  $ knock workflow push [WORKFLOWKEY] --service-token <value> [--environment development] [-m <value> --commit]
+  $ knock workflow push [WORKFLOWKEY] --service-token <value> [--environment development] [--workflows-dir <value>
+    --all] [-m <value> --commit]
 
 FLAGS
   -m, --commit-message=<value>  Use the given value as the commit message
+  --all
   --commit                      Push and commit the workflow(s) at the same time
   --environment=<option>        [default: development] Pushing a workflow is only allowed in the development environment
                                 <options: development>
   --service-token=<value>       (required) The service token to authenticate with
+  --workflows-dir=<value>
 ```
 
 ## `knock workflow validate [WORKFLOWKEY]`
 
 ```
 USAGE
-  $ knock workflow validate [WORKFLOWKEY] --service-token <value> [--environment development]
+  $ knock workflow validate [WORKFLOWKEY] --service-token <value> [--environment development] [--workflows-dir <value>
+    --all]
 
 FLAGS
+  --all
   --environment=<option>   [default: development] Validating a workflow is only done in the development environment
                            <options: development>
   --service-token=<value>  (required) The service token to authenticate with
+  --workflows-dir=<value>
 ```
 <!-- commandsstop -->

package/dist/commands/ping.js

@@ -18,6 +18,8 @@ class Ping extends _baseCommand.default {
         this.log(resp.data);
     }
 }
+// Deprecated, in favor of the whoami command.
+Ping.hidden = true;
 Ping.description = "Ping the Knock management API to verify access.";
 Ping.examples = [
     "<%= config.bin %> <%= command.id %>"

package/dist/commands/translation/get.js

@@ -0,0 +1,124 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: ()=>TranslationGet
+});
+const _core = require("@oclif/core");
+const _baseCommand = /*#__PURE__*/ _interopRequireDefault(require("../../lib/base-command"));
+const _date = require("../../lib/helpers/date");
+const _request = require("../../lib/helpers/request");
+const _translation = /*#__PURE__*/ _interopRequireWildcard(require("../../lib/marshal/translation"));
+function _interopRequireDefault(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+function _getRequireWildcardCache(nodeInterop) {
+    if (typeof WeakMap !== "function") return null;
+    var cacheBabelInterop = new WeakMap();
+    var cacheNodeInterop = new WeakMap();
+    return (_getRequireWildcardCache = function(nodeInterop) {
+        return nodeInterop ? cacheNodeInterop : cacheBabelInterop;
+    })(nodeInterop);
+}
+function _interopRequireWildcard(obj, nodeInterop) {
+    if (!nodeInterop && obj && obj.__esModule) {
+        return obj;
+    }
+    if (obj === null || typeof obj !== "object" && typeof obj !== "function") {
+        return {
+            default: obj
+        };
+    }
+    var cache = _getRequireWildcardCache(nodeInterop);
+    if (cache && cache.has(obj)) {
+        return cache.get(obj);
+    }
+    var newObj = {};
+    var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor;
+    for(var key in obj){
+        if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) {
+            var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null;
+            if (desc && (desc.get || desc.set)) {
+                Object.defineProperty(newObj, key, desc);
+            } else {
+                newObj[key] = obj[key];
+            }
+        }
+    }
+    newObj.default = obj;
+    if (cache) {
+        cache.set(obj, newObj);
+    }
+    return newObj;
+}
+class TranslationGet extends _baseCommand.default {
+    async run() {
+        const { args , flags  } = this.props;
+        const parsedRef = _translation.parseTranslationRef(args.translationRef);
+        if (!parsedRef) {
+            return this.error(`Invalid translation ref \`${args.translationRef}\`, use valid <locale> or <namespace>.<locale> for namespaced translations`);
+        }
+        const resp = await (0, _request.withSpinner)(()=>this.apiV1.getTranslation(this.props, parsedRef));
+        if (flags.json) return resp.data;
+        this.render(resp.data);
+    }
+    render(translation) {
+        const { translationRef  } = this.props.args;
+        const { environment: env , "hide-uncommitted-changes": commitedOnly  } = this.props.flags;
+        const qualifier = env === "development" && !commitedOnly ? "(including uncommitted)" : "";
+        this.log(`‣ Showing translation \`${translationRef}\` in \`${env}\` environment ${qualifier}\n`);
+        /*
+     * Translation table
+     */ const rows = [
+            {
+                key: "Language",
+                value: _translation.formatLanguage(translation)
+            },
+            {
+                key: "Locale",
+                value: translation.locale_code
+            },
+            {
+                key: "Namespace",
+                value: translation.namespace || "-"
+            },
+            {
+                key: "Updated at",
+                value: (0, _date.formatDate)(translation.updated_at)
+            },
+            {
+                key: "Created at",
+                value: (0, _date.formatDate)(translation.created_at)
+            }
+        ];
+        _core.CliUx.ux.table(rows, {
+            key: {
+                header: "Translation",
+                minWidth: 24
+            },
+            value: {
+                header: "",
+                minWidth: 16
+            }
+        });
+        this.log("");
+        _core.CliUx.ux.styledJSON(JSON.parse(translation.content));
+    }
+}
+TranslationGet.flags = {
+    environment: _core.Flags.string({
+        default: "development"
+    }),
+    "hide-uncommitted-changes": _core.Flags.boolean()
+};
+TranslationGet.args = [
+    {
+        name: "translationRef",
+        required: true
+    }
+];
+TranslationGet.enableJsonFlag = true;

package/dist/commands/translation/list.js

@@ -7,17 +7,56 @@ Object.defineProperty(exports, "default", {
     get: ()=>TranslationList
 });
 const _core = require("@oclif/core");
-const _localeCodes = /*#__PURE__*/ _interopRequireDefault(require("locale-codes"));
 const _baseCommand = /*#__PURE__*/ _interopRequireDefault(require("../../lib/base-command"));
 const _date = require("../../lib/helpers/date");
 const _object = require("../../lib/helpers/object");
 const _page = require("../../lib/helpers/page");
 const _request = require("../../lib/helpers/request");
+const _translation = /*#__PURE__*/ _interopRequireWildcard(require("../../lib/marshal/translation"));
 function _interopRequireDefault(obj) {
     return obj && obj.__esModule ? obj : {
         default: obj
     };
 }
+function _getRequireWildcardCache(nodeInterop) {
+    if (typeof WeakMap !== "function") return null;
+    var cacheBabelInterop = new WeakMap();
+    var cacheNodeInterop = new WeakMap();
+    return (_getRequireWildcardCache = function(nodeInterop) {
+        return nodeInterop ? cacheNodeInterop : cacheBabelInterop;
+    })(nodeInterop);
+}
+function _interopRequireWildcard(obj, nodeInterop) {
+    if (!nodeInterop && obj && obj.__esModule) {
+        return obj;
+    }
+    if (obj === null || typeof obj !== "object" && typeof obj !== "function") {
+        return {
+            default: obj
+        };
+    }
+    var cache = _getRequireWildcardCache(nodeInterop);
+    if (cache && cache.has(obj)) {
+        return cache.get(obj);
+    }
+    var newObj = {};
+    var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor;
+    for(var key in obj){
+        if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) {
+            var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null;
+            if (desc && (desc.get || desc.set)) {
+                Object.defineProperty(newObj, key, desc);
+            } else {
+                newObj[key] = obj[key];
+            }
+        }
+    }
+    newObj.default = obj;
+    if (cache) {
+        cache.set(obj, newObj);
+    }
+    return newObj;
+}
 class TranslationList extends _baseCommand.default {
     async run() {
         const resp = await this.request();
@@ -41,15 +80,16 @@ class TranslationList extends _baseCommand.default {
         /*
      * Translations list table
      */ _core.CliUx.ux.table(entries, {
+            ref: {
+                header: "Ref",
+                get: (entry)=>_translation.formatRef(entry)
+            },
             language_name: {
                 header: "Language",
-                get: (entry)=>{
-                    const language = _localeCodes.default.getByTag(entry.locale_code);
-                    return language.location ? `${language.name}, ${language.location}` : language.name;
-                }
+                get: (entry)=>_translation.formatLanguage(entry)
             },
             locale_code: {
-                header: "Locale code"
+                header: "Locale"
             },
             namespace: {
                 header: "Namespace"
@@ -57,6 +97,10 @@ class TranslationList extends _baseCommand.default {
             updated_at: {
                 header: "Updated at",
                 get: (entry)=>(0, _date.formatDate)(entry.updated_at)
+            },
+            created_at: {
+                header: "Created at",
+                get: (entry)=>(0, _date.formatDate)(entry.created_at)
             }
         });
         return this.prompt(data);

package/dist/commands/translation/pull.js

@@ -61,40 +61,76 @@ function _interopRequireWildcard(obj, nodeInterop) {
 }
 class TranslationPull extends _baseCommand.default {
     async run() {
+        const target = await _translation.ensureValidCommandTarget(this.props, this.runContext);
+        switch(target.type){
+            case "translationFile":
+                return this.pullOneTranslation(target.context);
+            case "translationDir":
+                return this.pullAllTranslationsForLocale(target.context);
+            case "translationsIndexDir":
+                return this.pullAllTranslations(target.context);
+            default:
+                throw new Error(`Invalid translation command target: ${target}`);
+        }
+    }
+    /*
+   * Pull a single translation (using TranslationFileContext)
+   */ async pullOneTranslation(targetCtx) {
         const { flags  } = this.props;
-        // TODO MKD: Enable pulling a single translation or group of translations for locale
-        return flags.all ? this.pullAllTranslations() : this.error("Must use --all to pull all translations");
+        if (targetCtx.exists) {
+            this.log(`‣ Found \`${targetCtx.ref}\` at ${targetCtx.abspath}`);
+        } else {
+            const prompt = `Create a new translation file \`${targetCtx.ref}\` at ${targetCtx.abspath}?`;
+            const input = flags.force || await (0, _ux.promptToConfirm)(prompt);
+            if (!input) return;
+        }
+        const resp = await (0, _request.withSpinner)(()=>this.apiV1.getTranslation(this.props, targetCtx));
+        await _translation.writeTranslationFile(targetCtx, resp.data);
+        const actioned = targetCtx.exists ? "updated" : "created";
+        this.log(`‣ Successfully ${actioned} \`${targetCtx.ref}\` at ${targetCtx.abspath}`);
     }
     /*
-   * Pull all translations
-   */ async pullAllTranslations() {
+   * Pull all translations for a locale (using TranslationDirContext)
+   */ async pullAllTranslationsForLocale(targetCtx) {
         const { flags  } = this.props;
-        // TODO: In the future we should default to the knock project config first
-        // if present, before defaulting to the cwd.
-        const defaultToCwd = {
-            abspath: this.runContext.cwd,
-            exists: true
+        const prompt = targetCtx.exists ? `Pull latest \`${targetCtx.key}\` translations into ${targetCtx.abspath}?\n  This will overwrite the contents of this directory.` : `Create a new \`${targetCtx.key}\` translations directory at ${targetCtx.abspath}?`;
+        const input = flags.force || await (0, _ux.promptToConfirm)(prompt);
+        if (!input) return;
+        // Fetch all translations for a given locale then write them to the local
+        // file system.
+        _ux.spinner.start(`‣ Loading`);
+        const filters = {
+            localeCode: targetCtx.key
         };
-        const targetDirCtx = flags["translations-dir"] || defaultToCwd;
-        const prompt = targetDirCtx.exists ? `Pull latest translations into ${targetDirCtx.abspath}?\n  This will overwrite the contents of this directory.` : `Create a new translations directory at ${targetDirCtx.abspath}?`;
+        const translations = await this.listAllTranslations(filters);
+        await _translation.writeTranslationFiles(targetCtx, translations);
+        _ux.spinner.stop();
+        const actioned = targetCtx.exists ? "updated" : "created";
+        this.log(`‣ Successfully ${actioned} the \`${targetCtx.key}\` translations directory at ${targetCtx.abspath}`);
+    }
+    /*
+   * Pull all translations (using DirContext)
+   */ async pullAllTranslations(targetCtx) {
+        const { flags  } = this.props;
+        const prompt = targetCtx.exists ? `Pull latest translations into ${targetCtx.abspath}?\n  This will overwrite the contents of this directory.` : `Create a new translations directory at ${targetCtx.abspath}?`;
         const input = flags.force || await (0, _ux.promptToConfirm)(prompt);
         if (!input) return;
         // Fetch all translations then write them to the local file system.
         _ux.spinner.start(`‣ Loading`);
         const translations = await this.listAllTranslations();
-        await _translation.writeTranslationsIndexDir(targetDirCtx, translations);
+        await _translation.writeTranslationFiles(targetCtx, translations);
         _ux.spinner.stop();
-        const action = targetDirCtx.exists ? "updated" : "created";
-        this.log(`‣ Successfully ${action} the translations directory at ${targetDirCtx.abspath}`);
+        const action = targetCtx.exists ? "updated" : "created";
+        this.log(`‣ Successfully ${action} the translations directory at ${targetCtx.abspath}`);
     }
-    async listAllTranslations(pageParams = {}, translationsFetchedSoFar = []) {
+    async listAllTranslations(filters = {}, pageParams = {}, translationsFetchedSoFar = []) {
         const props = (0, _object.merge)(this.props, {
             flags: {
                 ...pageParams,
                 limit: _page.MAX_PAGINATION_LIMIT
             }
         });
-        const resp = await this.apiV1.listTranslations(props);
+        const resp = await this.apiV1.listTranslations(props, filters);
         if (!(0, _request.isSuccessResp)(resp)) {
             const message = (0, _request.formatErrorRespMessage)(resp);
             this.error(new _error.ApiError(message));
@@ -104,7 +140,7 @@ class TranslationPull extends _baseCommand.default {
             ...translationsFetchedSoFar,
             ...entries
         ];
-        return pageInfo.after ? this.listAllTranslations({
+        return pageInfo.after ? this.listAllTranslations(filters, {
             after: pageInfo.after
         }, translations) : translations;
     }
@@ -122,3 +158,9 @@ TranslationPull.flags = {
     "hide-uncommitted-changes": _core.Flags.boolean(),
     force: _core.Flags.boolean()
 };
+TranslationPull.args = [
+    {
+        name: "translationRef",
+        required: false
+    }
+];

package/dist/commands/translation/push.js

@@ -62,9 +62,10 @@ function _interopRequireWildcard(obj, nodeInterop) {
 }
 class TranslationPush extends _baseCommand.default {
     async run() {
-        // First read all translation files found for the given command.
+        const { flags  } = this.props;
+        // 1. First read all translation files found for the given command.
         const target = await _translation.ensureValidCommandTarget(this.props, this.runContext);
-        const [translations, readErrors] = await _translation.readTranslationFilesForCommandTarget(target);
+        const [translations, readErrors] = await _translation.readAllForCommandTarget(target);
         if (readErrors.length > 0) {
             this.error((0, _error.formatErrors)(readErrors, {
                 prependBy: "\n\n"
@@ -73,13 +74,17 @@ class TranslationPush extends _baseCommand.default {
         if (translations.length === 0) {
             this.error(`No translation files found in ${target.context.abspath}`);
         }
-        // Then validate them all ahead of pushing them.
+        // 2. Then validate them all ahead of pushing them.
         _ux.spinner.start(`‣ Validating`);
         const apiErrors = await _validate.default.validateAll(this.apiV1, this.props, translations);
         if (apiErrors.length > 0) {
-            this.error((0, _error.formatErrors)(apiErrors));
+            this.error((0, _error.formatErrors)(apiErrors, {
+                prependBy: "\n\n"
+            }));
         }
-        // Finally push up each translation file, abort on the first error.
+        _ux.spinner.stop();
+        // 3. Finally push up each translation file, abort on the first error.
+        _ux.spinner.start(`‣ Pushing`);
         for (const translation of translations){
             // eslint-disable-next-line no-await-in-loop
             const resp = await this.apiV1.upsertTranslation(this.props, {
@@ -93,8 +98,10 @@ class TranslationPush extends _baseCommand.default {
             this.error((0, _error.formatError)(error));
         }
         _ux.spinner.stop();
+        // 4. Display a success message.
         const handledRefs = translations.map((t)=>t.ref);
-        this.log(`‣ Successfully pushed ${translations.length} translation(s):\n` + (0, _string.indentString)(handledRefs.join("\n"), 4));
+        const actioned = flags.commit ? "pushed and committed" : "pushed";
+        this.log(`‣ Successfully ${actioned} ${translations.length} translation(s):\n` + (0, _string.indentString)(handledRefs.join("\n"), 4));
     }
 }
 TranslationPush.flags = {

package/dist/commands/translation/validate.js

@@ -62,7 +62,7 @@ function _interopRequireWildcard(obj, nodeInterop) {
 class TranslationValidate extends _baseCommand.default {
     async run() {
         const target = await _translation.ensureValidCommandTarget(this.props, this.runContext);
-        const [translations, readErrors] = await _translation.readTranslationFilesForCommandTarget(target);
+        const [translations, readErrors] = await _translation.readAllForCommandTarget(target);
         if (readErrors.length > 0) {
             this.error((0, _error.formatErrors)(readErrors, {
                 prependBy: "\n\n"

package/dist/commands/whoami.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: ()=>Whoami
+});
+const _baseCommand = /*#__PURE__*/ _interopRequireDefault(require("../lib/base-command"));
+const _request = require("../lib/helpers/request");
+const _string = require("../lib/helpers/string");
+function _interopRequireDefault(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+class Whoami extends _baseCommand.default {
+    async run() {
+        const resp = await (0, _request.withSpinner)(()=>this.apiV1.whoami());
+        this.log(`‣ Successfully verified the provided service token:`);
+        const info = [
+            `Account name: ${resp.data.account_name}`,
+            `Service token name: ${resp.data.service_token_name}`
+        ];
+        this.log((0, _string.indentString)(info.join("\n"), 4));
+    }
+}
+Whoami.enableJsonFlag = true;

package/dist/commands/workflow/pull.js

@@ -78,7 +78,7 @@ class WorkflowPull extends _baseCommand.default {
         if (dirContext.exists) {
             this.log(`‣ Found \`${dirContext.key}\` at ${dirContext.abspath}`);
         } else {
-            const prompt = `Create a new workflow directory \`${dirContext.key}\`?`;
+            const prompt = `Create a new workflow directory \`${dirContext.key}\` at ${dirContext.abspath}?`;
             const input = flags.force || await (0, _ux.promptToConfirm)(prompt);
             if (!input) return;
         }