@knocklabs/cli 0.1.0-rc.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Knock Labs, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,377 @@
+# @knocklabs/cli
+
+A command-line interface for interacting with [Knock](https://knock.app).
+
+<!-- toc -->
+* [@knocklabs/cli](#knocklabscli)
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+
+# Usage
+
+<!-- usage -->
+```sh-session
+$ npm install -g @knocklabs/cli
+$ knock COMMAND
+running command...
+$ knock (--version)
+@knocklabs/cli/0.1.0-rc.0 darwin-arm64 node-v16.4.0
+$ knock --help [COMMAND]
+USAGE
+  $ knock COMMAND
+...
+```
+<!-- usagestop -->
+
+# Commands
+
+<!-- commands -->
+* [`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)
+* [`knock plugins:install PLUGIN...`](#knock-pluginsinstall-plugin-1)
+* [`knock plugins:link PLUGIN`](#knock-pluginslink-plugin)
+* [`knock plugins:uninstall PLUGIN...`](#knock-pluginsuninstall-plugin)
+* [`knock plugins:uninstall PLUGIN...`](#knock-pluginsuninstall-plugin-1)
+* [`knock plugins:uninstall PLUGIN...`](#knock-pluginsuninstall-plugin-2)
+* [`knock plugins update`](#knock-plugins-update)
+* [`knock workflow get WORKFLOWKEY`](#knock-workflow-get-workflowkey)
+* [`knock workflow list`](#knock-workflow-list)
+* [`knock workflow pull [WORKFLOWKEY]`](#knock-workflow-pull-workflowkey)
+* [`knock workflow push [WORKFLOWKEY]`](#knock-workflow-push-workflowkey)
+
+## `knock help [COMMANDS]`
+
+Display help for knock.
+
+```
+USAGE
+  $ knock help [COMMANDS] [-n]
+
+ARGUMENTS
+  COMMANDS  Command to show help for.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for knock.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.2/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) 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.0/dist/commands/ping.ts)_
+
+## `knock plugins`
+
+List installed plugins.
+
+```
+USAGE
+  $ knock plugins [--core]
+
+FLAGS
+  --core  Show core plugins.
+
+DESCRIPTION
+  List installed plugins.
+
+EXAMPLES
+  $ knock plugins
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.3.0/src/commands/plugins/index.ts)_
+
+## `knock plugins:install PLUGIN...`
+
+Installs a plugin into the CLI.
+
+```
+USAGE
+  $ knock plugins:install PLUGIN...
+
+ARGUMENTS
+  PLUGIN  Plugin to install.
+
+FLAGS
+  -f, --force    Run yarn install with force flag.
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Installs a plugin into the CLI.
+  Can be installed from npm or a git url.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
+  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
+  the CLI without the need to patch and update the whole CLI.
+
+
+ALIASES
+  $ knock plugins add
+
+EXAMPLES
+  $ knock plugins:install myplugin 
+
+  $ knock plugins:install https://github.com/someuser/someplugin
+
+  $ knock plugins:install someuser/someplugin
+```
+
+## `knock plugins:inspect PLUGIN...`
+
+Displays installation properties of a plugin.
+
+```
+USAGE
+  $ knock plugins:inspect PLUGIN...
+
+ARGUMENTS
+  PLUGIN  [default: .] Plugin to inspect.
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Displays installation properties of a plugin.
+
+EXAMPLES
+  $ knock plugins:inspect myplugin
+```
+
+## `knock plugins:install PLUGIN...`
+
+Installs a plugin into the CLI.
+
+```
+USAGE
+  $ knock plugins:install PLUGIN...
+
+ARGUMENTS
+  PLUGIN  Plugin to install.
+
+FLAGS
+  -f, --force    Run yarn install with force flag.
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Installs a plugin into the CLI.
+  Can be installed from npm or a git url.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
+  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
+  the CLI without the need to patch and update the whole CLI.
+
+
+ALIASES
+  $ knock plugins add
+
+EXAMPLES
+  $ knock plugins:install myplugin 
+
+  $ knock plugins:install https://github.com/someuser/someplugin
+
+  $ knock plugins:install someuser/someplugin
+```
+
+## `knock plugins:link PLUGIN`
+
+Links a plugin into the CLI for development.
+
+```
+USAGE
+  $ knock plugins:link PLUGIN
+
+ARGUMENTS
+  PATH  [default: .] path to plugin
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Links a plugin into the CLI for development.
+  Installation of a linked plugin will override a user-installed or core plugin.
+
+  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
+  command will override the user-installed or core plugin implementation. This is useful for development work.
+
+
+EXAMPLES
+  $ knock plugins:link myplugin
+```
+
+## `knock plugins:uninstall PLUGIN...`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ knock plugins:uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ knock plugins unlink
+  $ knock plugins remove
+```
+
+## `knock plugins:uninstall PLUGIN...`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ knock plugins:uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ knock plugins unlink
+  $ knock plugins remove
+```
+
+## `knock plugins:uninstall PLUGIN...`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ knock plugins:uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ knock plugins unlink
+  $ knock plugins remove
+```
+
+## `knock plugins update`
+
+Update installed plugins.
+
+```
+USAGE
+  $ knock plugins update [-h] [-v]
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Update installed plugins.
+```
+
+## `knock workflow get WORKFLOWKEY`
+
+```
+USAGE
+  $ knock workflow get [WORKFLOWKEY] --service-token <value> [--environment <value>] [--hide-uncommitted-changes]
+    [--json]
+
+FLAGS
+  --environment=<value>       [default: development]
+  --hide-uncommitted-changes
+  --service-token=<value>     (required) service token to authenticate with
+
+GLOBAL FLAGS
+  --json  Format output as json.
+```
+
+## `knock workflow list`
+
+```
+USAGE
+  $ knock workflow list --service-token <value> [--environment <value>] [--hide-uncommitted-changes] [--after
+    <value>] [--before <value>] [--limit <value>] [--json]
+
+FLAGS
+  --after=<value>
+  --before=<value>
+  --environment=<value>       [default: development]
+  --hide-uncommitted-changes
+  --limit=<value>
+  --service-token=<value>     (required) service token to authenticate with
+
+GLOBAL FLAGS
+  --json  Format output as json.
+```
+
+## `knock workflow pull [WORKFLOWKEY]`
+
+```
+USAGE
+  $ knock workflow pull [WORKFLOWKEY] --service-token <value> [--environment <value>] [--hide-uncommitted-changes]
+
+FLAGS
+  --environment=<value>       [default: development]
+  --hide-uncommitted-changes
+  --service-token=<value>     (required) service token to authenticate with
+```
+
+## `knock workflow push [WORKFLOWKEY]`
+
+```
+USAGE
+  $ knock workflow push [WORKFLOWKEY] --service-token <value> [--environment development]
+
+FLAGS
+  --environment=<option>   [default: development]
+                           <options: development>
+  --service-token=<value>  (required) service token to authenticate with
+```
+<!-- commandsstop -->

package/bin/dev

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+const path = require('path')
+const project = path.join(__dirname, '..', 'tsconfig.json')
+
+// In dev mode -> use ts-node and dev plugins
+process.env.NODE_ENV = 'development'
+
+require('ts-node').register({project})
+
+// In dev mode, always show stack traces
+oclif.settings.debug = true;
+
+// Start the CLI
+oclif.run().then(oclif.flush).catch(oclif.Errors.handle)

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\dev" %*

package/bin/run

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+oclif.run().then(require('@oclif/core/flush')).catch(require('@oclif/core/handle'))

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/dist/commands/ping.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: ()=>Ping
+});
+const _baseCommand = /*#__PURE__*/ _interopRequireDefault(require("../lib/base-command"));
+function _interopRequireDefault(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+class Ping extends _baseCommand.default {
+    async run() {
+        const resp = await this.apiV1.ping();
+        this.log(resp.data);
+    }
+}
+Ping.description = "Ping the Knock management API to verify access.";
+Ping.examples = [
+    "<%= config.bin %> <%= command.id %>"
+];

package/dist/commands/workflow/get.js

@@ -0,0 +1,161 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: ()=>WorkflowGet
+});
+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 _conditions = /*#__PURE__*/ _interopRequireWildcard(require("../../lib/marshal/conditions"));
+const _workflow = /*#__PURE__*/ _interopRequireWildcard(require("../../lib/marshal/workflow"));
+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 WorkflowGet extends _baseCommand.default {
+    async run() {
+        const resp = await (0, _request.withSpinner)(()=>this.apiV1.getWorkflow(this.props));
+        const { flags  } = this.props;
+        if (flags.json) return resp.data;
+        this.render(resp.data);
+    }
+    render(workflow) {
+        const { workflowKey  } = this.props.args;
+        const { environment: env , "hide-uncommitted-changes": commitedOnly  } = this.props.flags;
+        const qualifier = env === "development" && !commitedOnly ? "(including uncommitted)" : "";
+        this.log(`‣ Showing workflow \`${workflowKey}\` in \`${env}\` environment ${qualifier}\n`);
+        /*
+     * Workflow table
+     */ const rows = [
+            {
+                key: "Status",
+                value: _workflow.formatStatus(workflow)
+            },
+            {
+                key: "Name",
+                value: workflow.name
+            },
+            {
+                key: "Key",
+                value: workflow.key
+            },
+            {
+                key: "Description",
+                value: workflow.description || "-"
+            },
+            {
+                key: "Categories",
+                value: _workflow.formatCategories(workflow, {
+                    emptyDisplay: "-"
+                })
+            },
+            {
+                key: "Created at",
+                value: (0, _date.formatDateTime)(workflow.created_at)
+            },
+            {
+                key: "Updated at",
+                value: (0, _date.formatDateTime)(workflow.updated_at)
+            }
+        ];
+        _core.CliUx.ux.table(rows, {
+            key: {
+                header: "Workflow",
+                minWidth: 24
+            },
+            value: {
+                header: "",
+                minWidth: 24
+            }
+        });
+        this.log("");
+        if (workflow.steps.length === 0) {
+            return _core.CliUx.ux.log(" This workflow has no steps to display.");
+        }
+        /*
+     * Workflow steps table
+     */ const steps = workflow.steps.map((step, index)=>({
+                ...step,
+                index
+            }));
+        _core.CliUx.ux.table(steps, {
+            index: {
+                header: "Steps",
+                get: (step)=>step.index + 1
+            },
+            ref: {
+                header: "Ref",
+                minWidth: 18
+            },
+            type: {
+                header: "Type",
+                minWidth: 12
+            },
+            summary: {
+                header: "Summary",
+                get: (step)=>_workflow.formatStepSummary(step)
+            },
+            conditions: {
+                header: "Conditions",
+                get: (step)=>step.conditions ? _conditions.formatConditions(step.conditions) : "-"
+            }
+        });
+    }
+}
+WorkflowGet.flags = {
+    environment: _core.Flags.string({
+        default: "development"
+    }),
+    "hide-uncommitted-changes": _core.Flags.boolean()
+};
+WorkflowGet.args = [
+    {
+        name: "workflowKey",
+        required: true
+    }
+];
+WorkflowGet.enableJsonFlag = true;