@sw-tsdk/plugin-connector 0.1.1-next.23

package/LICENSE

@@ -0,0 +1,8 @@
+The ISC License (ISC)
+
+Copyright © SWIMLANE 2021
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+{"mode":"full","isActive":false}

package/README.md

@@ -0,0 +1,341 @@
+Integration Task CLI Plugin
+============
+![Swimlane Logo](https://swimlane.com/assets/images/swimlane-svg-logo.svg)
+
+[![Version](https://img.shields.io/npm/v/@tsdk/plugin-task)](https://npmjs.org/package/@tsdk/plugin-task)
+[![Downloads/week](https://img.shields.io/npm/dw/@tsdk/plugin-task)](https://npmjs.org/package/@tsdk/plugin-task)
+[![License](https://img.shields.io/npm/l/@tsdk/plugin-task)](https://github.com/swimlane/turbine-developer-kit/blob/main/packages/cli/package.json)
+<!-- toc -->
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+# Usage
+<!-- usage -->
+```sh-session
+$ npm install -g @sw-tsdk/plugin-connector
+$ sw-tsdk-connector COMMAND
+running command...
+$ sw-tsdk-connector (--version)
+@sw-tsdk/plugin-connector/0.1.1-next.23+038e7a6 darwin-x64 node-v16.17.0
+$ sw-tsdk-connector --help [COMMAND]
+USAGE
+  $ sw-tsdk-connector COMMAND
+...
+```
+<!-- usagestop -->
+# Commands
+<!-- commands -->
+* [`sw-tsdk-connector action:add`](#sw-tsdk-connector-actionadd)
+* [`sw-tsdk-connector action:input`](#sw-tsdk-connector-actioninput)
+* [`sw-tsdk-connector action:output`](#sw-tsdk-connector-actionoutput)
+* [`sw-tsdk-connector action:run`](#sw-tsdk-connector-actionrun)
+* [`sw-tsdk-connector asset:add`](#sw-tsdk-connector-assetadd)
+* [`sw-tsdk-connector connector:build`](#sw-tsdk-connector-connectorbuild)
+* [`sw-tsdk-connector connector:create`](#sw-tsdk-connector-connectorcreate)
+* [`sw-tsdk-connector connector:create-source`](#sw-tsdk-connector-connectorcreate-source)
+* [`sw-tsdk-connector connector:logo`](#sw-tsdk-connector-connectorlogo)
+* [`sw-tsdk-connector connector:save`](#sw-tsdk-connector-connectorsave)
+* [`sw-tsdk-connector connector:sign`](#sw-tsdk-connector-connectorsign)
+* [`sw-tsdk-connector connector:update`](#sw-tsdk-connector-connectorupdate)
+* [`sw-tsdk-connector connector:validate`](#sw-tsdk-connector-connectorvalidate)
+
+## `sw-tsdk-connector action:add`
+
+Update a connector action.
+
+```
+USAGE
+  $ sw-tsdk-connector action:add [-d <value>] [-t node_18|python_310_definition|python_3.7_swimlane] [-h]
+
+FLAGS
+  -d, --directory=<value>  [default: ./] Root directory of the repository.
+  -h, --help               Show CLI help.
+  -t, --template=<option>  [default: python_310_definition] action template to scaffold
+                           <options: node_18|python_310_definition|python_3.7_swimlane>
+
+DESCRIPTION
+  Update a connector action.
+```
+
+_See code: [lib/commands/action/add.js](https://github.com/swimlane/turbine-sdk/blob/v0.1.1-next.23+038e7a6/lib/commands/action/add.js)_
+
+## `sw-tsdk-connector action:input`
+
+Update action input schema.
+
+```
+USAGE
+  $ sw-tsdk-connector action:input [-a <value>] [-d <value>] [--amend] [--action-config-path <value>]
+    [--input-path <value> ] [-h]
+
+FLAGS
+  -a, --action=<value>          Action name to run
+  -d, --directory=<value>       [default: ./] Root directory of the repository.
+  -h, --help                    Show CLI help.
+  --action-config-path=<value>  Override path to action configuration file. Defaults to
+                                /connector/config/actions/<action>.yaml
+  --amend                       Merge with existing schema.
+  --input-path=<value>          Relative path to the output data JSON file, defaults to the task name under the data
+                                folder. ie: /data/<taskName>_output.json
+
+DESCRIPTION
+  Update action input schema.
+```
+
+_See code: [lib/commands/action/input.js](https://github.com/swimlane/turbine-sdk/blob/v0.1.1-next.23+038e7a6/lib/commands/action/input.js)_
+
+## `sw-tsdk-connector action:output`
+
+Update a connector action.
+
+```
+USAGE
+  $ sw-tsdk-connector action:output [-a <value>] [-d <value>] [--action-config-path <value>] [--amend]
+    [--output-path <value> ] [-h]
+
+FLAGS
+  -a, --action=<value>          Action name to run
+  -d, --directory=<value>       [default: ./] Root directory of the repository.
+  -h, --help                    Show CLI help.
+  --action-config-path=<value>  Override path to action configuration file. Defaults to /connector/config/<action>.yaml
+  --amend                       Merge with existing schema.
+  --output-path=<value>         Relative path to the output data JSON file, defaults to the task name under the data
+                                folder. ie: /data/<taskName>_output.json
+
+DESCRIPTION
+  Update a connector action.
+```
+
+_See code: [lib/commands/action/output.js](https://github.com/swimlane/turbine-sdk/blob/v0.1.1-next.23+038e7a6/lib/commands/action/output.js)_
+
+## `sw-tsdk-connector action:run`
+
+Runs a connector action. (Defaults to current image version in local repository).
+
+```
+USAGE
+  $ sw-tsdk-connector action:run [-a <value>] [-d <value>] [--input-path <value>] [--output-path <value>]
+    [--error-path <value>] [--asset-path <value>] [-i <value> | --build | --latest] [--template
+    python_3.7|node_18|python_310_definition] [-f ] [-h]
+
+FLAGS
+  -a, --action=<value>     Action name to run
+  -d, --directory=<value>  [default: ./] Root directory of the repository.
+  -f, --force-rebuild      forces nocache on the image build
+  -h, --help               Show CLI help.
+  -i, --image=<value>      The connector image to run.
+  --asset-path=<value>     File to asset data JSON file, defaults to /data/asset.json
+  --build                  Builds image and runs it.
+  --error-path=<value>     File to write the errors to, defaults to /data/<action>_error.json
+  --input-path=<value>     File to input data JSON file, defaults to /data/<action>.json
+  --latest                 Use the latest release image from quay.
+  --output-path=<value>    File to write the outputs to, defaults to /data/<action>_output.json
+  --template=<option>      [default: python_310_definition] connector template
+                           <options: python_3.7|node_18|python_310_definition>
+
+DESCRIPTION
+  Runs a connector action. (Defaults to current image version in local repository).
+```
+
+_See code: [lib/commands/action/run.js](https://github.com/swimlane/turbine-sdk/blob/v0.1.1-next.23+038e7a6/lib/commands/action/run.js)_
+
+## `sw-tsdk-connector asset:add`
+
+Update a connector action.
+
+```
+USAGE
+  $ sw-tsdk-connector asset:add [-d <value>] [-s custom|apikey|client_credentials|basic|bearer] [-h]
+
+FLAGS
+  -d, --directory=<value>  [default: ./] Root directory of the repository.
+  -h, --help               Show CLI help.
+  -s, --scheme=<option>    asset template to scaffold
+                           <options: custom|apikey|client_credentials|basic|bearer>
+
+DESCRIPTION
+  Update a connector action.
+```
+
+_See code: [lib/commands/asset/add.js](https://github.com/swimlane/turbine-sdk/blob/v0.1.1-next.23+038e7a6/lib/commands/asset/add.js)_
+
+## `sw-tsdk-connector connector:build`
+
+Builds a local docker image of the connector.
+
+```
+USAGE
+  $ sw-tsdk-connector connector:build --template python_3.7_swimlane|node_18|python_310_definition [-d <value>]
+    [--save] [-f] [-h]
+
+FLAGS
+  -d, --directory=<value>  [default: ./] root directory of the repository.
+  -f, --force-rebuild      forces nocache on the image build
+  -h, --help               Show CLI help.
+  --save                   saves docker image as tar in local directory.
+  --template=<option>      (required) [default: python_310_definition] connector language
+                           <options: python_3.7_swimlane|node_18|python_310_definition>
+
+DESCRIPTION
+  Builds a local docker image of the connector.
+```
+
+_See code: [lib/commands/connector/build.js](https://github.com/swimlane/turbine-sdk/blob/v0.1.1-next.23+038e7a6/lib/commands/connector/build.js)_
+
+## `sw-tsdk-connector connector:create`
+
+Scaffold a new connector
+
+```
+USAGE
+  $ sw-tsdk-connector connector:create [-d <value>] [-t node_18|python_310_definition|python_3.7_swimlane]
+    [--skip-repo] [--vendor <value>] [--product <value>] [--keywords <value>] [--description <value>] [--logoPath
+    <value>] [--author <value>] [--authorEmail <value>] [--homepage <value>] [-h]
+
+FLAGS
+  -d, --directory=<value>  [default: ./] root directory for where to store connectors, the connector directory will be
+                           generated.
+  -h, --help               Show CLI help.
+  -t, --template=<option>  [default: python_310_definition] connector template to scaffold
+                           <options: node_18|python_310_definition|python_3.7_swimlane>
+  --author=<value>         Connector Author
+  --authorEmail=<value>    Connector Author Email
+  --description=<value>    Description (e.g. CrowdStrike Host Query API)
+  --homepage=<value>       Connector Author Support URL
+  --keywords=<value>       Please enter keyword (Comma-Separated)
+  --logoPath=<value>       URL or absolute path to logo file
+  --product=<value>        Product (e.g. Falcon)
+  --skip-repo              skips the repository creation process
+  --vendor=<value>         Vendor (e.g. CrowdStrike)
+
+DESCRIPTION
+  Scaffold a new connector
+```
+
+_See code: [lib/commands/connector/create.js](https://github.com/swimlane/turbine-sdk/blob/v0.1.1-next.23+038e7a6/lib/commands/connector/create.js)_
+
+## `sw-tsdk-connector connector:create-source`
+
+Generates 11x source from 10x
+
+```
+USAGE
+  $ sw-tsdk-connector connector:create-source [-d <value>] [-h]
+
+FLAGS
+  -d, --directory=<value>  [default: ./] root directory of the repository.
+  -h, --help               Show CLI help.
+
+DESCRIPTION
+  Generates 11x source from 10x
+```
+
+_See code: [lib/commands/connector/create-source.js](https://github.com/swimlane/turbine-sdk/blob/v0.1.1-next.23+038e7a6/lib/commands/connector/create-source.js)_
+
+## `sw-tsdk-connector connector:logo`
+
+Update a connector.
+
+```
+USAGE
+  $ sw-tsdk-connector connector:logo -p <value> [-d <value>] [-h]
+
+FLAGS
+  -d, --directory=<value>  [default: .] root directory of the connector folder.
+  -h, --help               Show CLI help.
+  -p, --path=<value>       (required) path or URL to product logo in PNG format.
+
+DESCRIPTION
+  Update a connector.
+```
+
+_See code: [lib/commands/connector/logo.js](https://github.com/swimlane/turbine-sdk/blob/v0.1.1-next.23+038e7a6/lib/commands/connector/logo.js)_
+
+## `sw-tsdk-connector connector:save`
+
+Save a docker image locally as .tar.gz
+
+```
+USAGE
+  $ sw-tsdk-connector connector:save -o <value> -i <value> [-d <value>] [-s] [-h]
+
+FLAGS
+  -d, --directory=<value>  [default: .] Root directory of the repo.
+  -h, --help               Show CLI help.
+  -i, --image=<value>      (required) image to save.
+  -o, --output=<value>     (required) output file to where to store the image.
+  -s, --skip-pull          skips pulling the image
+
+DESCRIPTION
+  Save a docker image locally as .tar.gz
+```
+
+_See code: [lib/commands/connector/save.js](https://github.com/swimlane/turbine-sdk/blob/v0.1.1-next.23+038e7a6/lib/commands/connector/save.js)_
+
+## `sw-tsdk-connector connector:sign`
+
+Builds a local docker image of the connector.
+
+```
+USAGE
+  $ sw-tsdk-connector connector:sign --image <value> --key-name <value> [-d <value>] [--signing-password <value>]
+    [--save] [--registry <value>] [-h]
+
+FLAGS
+  -d, --directory=<value>     [default: ./] root directory of the repository.
+  -h, --help                  Show CLI help.
+  --image=<value>             (required) image name to sign
+  --key-name=<value>          (required) name used for the key (default: username)
+  --registry=<value>          [default: localhost:50000] registry to use for signing
+  --save                      saves docker image as tar in local directory.
+  --signing-password=<value>  password used for the private key
+
+DESCRIPTION
+  Builds a local docker image of the connector.
+```
+
+_See code: [lib/commands/connector/sign.js](https://github.com/swimlane/turbine-sdk/blob/v0.1.1-next.23+038e7a6/lib/commands/connector/sign.js)_
+
+## `sw-tsdk-connector connector:update`
+
+Update a connector.
+
+```
+USAGE
+  $ sw-tsdk-connector connector:update [-d <value>] [-v <value>] [-f <value>] [-h]
+
+FLAGS
+  -d, --directory=<value>      [default: .] root directory of the connector folder.
+  -f, --manifest-path=<value>  [default: /connector/connector.yaml] connector manifest path relative to directory.
+  -h, --help                   Show CLI help.
+  -v, --version=<value>        new version of the connector.
+
+DESCRIPTION
+  Update a connector.
+```
+
+_See code: [lib/commands/connector/update.js](https://github.com/swimlane/turbine-sdk/blob/v0.1.1-next.23+038e7a6/lib/commands/connector/update.js)_
+
+## `sw-tsdk-connector connector:validate`
+
+Use to validate an integration
+
+```
+USAGE
+  $ sw-tsdk-connector connector:validate -c <value> [-h] [-i <value>] [--key <value> --signed] [-s] [-d <value>]
+
+FLAGS
+  -c, --connector=<value>  (required) connector to validate (relative to directory)
+  -d, --directory=<value>  [default: ./] current directory to mount
+  -h, --help               Show CLI help.
+  -i, --image=<value>      image to use
+  -s, --skip-pull          skips pulling the image
+  --key=<value>            public key for verfication
+  --signed                 validates a signed connector
+
+DESCRIPTION
+  Use to validate an integration
+```
+
+_See code: [lib/commands/connector/validate.js](https://github.com/swimlane/turbine-sdk/blob/v0.1.1-next.23+038e7a6/lib/commands/connector/validate.js)_
+<!-- commandsstop -->

package/lib/commands/action/add.d.ts

@@ -0,0 +1,10 @@
+import { Base } from '@sw-tsdk/core';
+export declare class Add extends Base {
+    static description: string;
+    static flags: {
+        directory: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        template: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
+    };
+    run(): Promise<void>;
+}

package/lib/commands/action/add.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Add = void 0;
+const tslib_1 = require("tslib");
+/* eslint-disable camelcase */
+const core_1 = require("@oclif/core");
+const core_2 = require("@sw-tsdk/core");
+const node_path_1 = require("node:path");
+const fs_extra_1 = require("fs-extra");
+const node_process_1 = tslib_1.__importDefault(require("node:process"));
+const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
+const snake_case_1 = require("snake-case");
+const connector_1 = require("@sw-tsdk/connector");
+const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
+// noinspection JSUnusedGlobalSymbols
+class Add extends core_2.Base {
+    async run() {
+        const { flags, } = await this.parse(Add);
+        let { directory, } = flags;
+        const { template, } = flags;
+        directory = (0, node_path_1.resolve)(directory || node_process_1.default.cwd());
+        const masterQuestions = [{
+                type: 'input',
+                name: 'title',
+                message: 'Action Title (e.g. Get Alerts)',
+            },
+            {
+                type: 'input',
+                name: 'description',
+                message: 'Description (e.g. CrowdStrike Host Query API)',
+            },
+            {
+                type: 'input',
+                name: 'endpoint',
+                message: 'entire endpoint after URL (e.g. api/v3/search)',
+            },
+            {
+                type: 'input',
+                name: 'method',
+                message: 'Connector template and language.',
+                choices: ['GET', 'POST', 'PUT', 'DELETE', 'HEAD', 'CONNECT', 'OPTIONS', 'TRACE'],
+                default: 'GET',
+            }];
+        const answers = await inquirer_1.default.prompt(masterQuestions);
+        const action = {
+            schema: 'action/1',
+            title: answers.title,
+            name: (0, snake_case_1.snakeCase)(answers.title),
+            description: answers.description,
+            inputs: {
+                type: 'object',
+                properties: {},
+                required: [],
+            },
+            output: {},
+            meta: {},
+        };
+        core_1.CliUx.ux.action.start('Scaffolding new action');
+        switch (template) {
+            case 'python_310_definition':
+                // Update input defaults.
+                action.inputs = connector_1.pythonDefinitionInputDefaults;
+                action.meta = {
+                    endpoint: answers.endpoint || '',
+                    method: answers.method,
+                };
+                break;
+        }
+        const actionPath = (0, node_path_1.join)(directory, 'connector', 'config', 'actions', `${action.name}.yaml`);
+        await (0, fs_extra_1.writeFile)(actionPath, js_yaml_1.default.dump(action));
+        core_1.CliUx.ux.action.stop();
+    }
+}
+exports.Add = Add;
+Add.description = 'Update a connector action.';
+Add.flags = Object.assign(Object.assign({}, core_2.Base.flags), { directory: core_1.Flags.string({
+        char: 'd',
+        description: 'Root directory of the repository.',
+        default: './',
+    }), template: core_1.Flags.string({
+        char: 't',
+        description: 'action template to scaffold',
+        default: 'python_310_definition',
+        options: ['node_18', 'python_310_definition', 'python_3.7_swimlane'],
+    }), help: core_1.Flags.help({
+        char: 'h',
+    }) });
+//# sourceMappingURL=add.js.map

package/lib/commands/action/add.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"add.js","sourceRoot":"","sources":["../../../src/commands/action/add.ts"],"names":[],"mappings":";;;;AAAA,8BAA8B;AAC9B,sCAAwC;AACxC,wCAAkC;AAClC,yCAAuC;AACvC,uCAAkC;AAClC,wEAAkC;AAClC,8DAA0B;AAC1B,2CAAoC;AAEpC,kDAAgE;AAEhE,gEAA+B;AAE/B,qCAAqC;AACrC,MAAa,GAAI,SAAQ,WAAI;IAqB3B,KAAK,CAAC,GAAG;QACP,MAAM,EACJ,KAAK,GACN,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAEzB,IAAI,EACF,SAAS,GACV,GAAG,KAAK,CAAA;QAET,MAAM,EACJ,QAAQ,GACT,GAAG,KAAK,CAAA;QAET,SAAS,GAAG,IAAA,mBAAO,EAAC,SAAS,IAAI,sBAAO,CAAC,GAAG,EAAE,CAAC,CAAA;QAC/C,MAAM,eAAe,GAAQ,CAAC;gBAC5B,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,OAAO;gBACb,OAAO,EAAE,gCAAgC;aAC1C;YACD;gBACE,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,aAAa;gBACnB,OAAO,EAAE,+CAA+C;aACzD;YACD;gBACE,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,UAAU;gBAChB,OAAO,EAAE,gDAAgD;aAC1D;YACD;gBACE,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,kCAAkC;gBAC3C,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC;gBAChF,OAAO,EAAE,KAAK;aACf,CAAC,CAAA;QAEF,MAAM,OAAO,GAAoB,MAAM,kBAAQ,CAAC,MAAM,CAAC,eAAe,CAAC,CAAA;QAEvE,MAAM,MAAM,GAA4B;YACtC,MAAM,EAAE,UAAU;YAClB,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,IAAI,EAAE,IAAA,sBAAS,EAAC,OAAO,CAAC,KAAK,CAAC;YAC9B,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,MAAM,EAAE;gBACN,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE,EAAE;gBACd,QAAQ,EAAE,EAAE;aACb;YACD,MAAM,EAAE,EAAE;YACV,IAAI,EAAE,EAAE;SACT,CAAA;QAED,YAAK,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAA;QAC/C,QAAQ,QAAQ,EAAE;YAClB,KAAK,uBAAuB;gBAC1B,yBAAyB;gBACzB,MAAM,CAAC,MAAM,GAAG,yCAA6B,CAAA;gBAE7C,MAAM,CAAC,IAAI,GAAG;oBACZ,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,EAAE;oBAChC,MAAM,EAAE,OAAO,CAAC,MAAM;iBACvB,CAAA;gBACD,MAAK;SACN;QAED,MAAM,UAAU,GAAG,IAAA,gBAAI,EACrB,SAAS,EACT,WAAW,EACX,QAAQ,EACR,SAAS,EACT,GAAG,MAAM,CAAC,IAAI,OAAO,CAAC,CAAA;QACxB,MAAM,IAAA,oBAAS,EAAC,UAAU,EAAE,iBAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAA;QAC9C,YAAK,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAA;IACxB,CAAC;;AA/FH,kBAgGC;AA/FQ,eAAW,GAAG,4BAA4B,CAAA;AAE1C,SAAK,mCACP,WAAI,CAAC,KAAK,KACb,SAAS,EAAE,YAAK,CAAC,MAAM,CAAC;QACtB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,mCAAmC;QAChD,OAAO,EAAE,IAAI;KACd,CAAC,EACF,QAAQ,EAAE,YAAK,CAAC,MAAM,CAAC;QACrB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,6BAA6B;QAC1C,OAAO,EAAE,uBAAuB;QAChC,OAAO,EAAE,CAAC,SAAS,EAAE,uBAAuB,EAAE,qBAAqB,CAAC;KACrE,CAAC,EACF,IAAI,EAAE,YAAK,CAAC,IAAI,CAAC;QACf,IAAI,EAAE,GAAG;KACV,CAAC,IACH"}

package/lib/commands/action/input.d.ts

@@ -0,0 +1,13 @@
+import { Base } from '@sw-tsdk/core';
+export declare class Input extends Base {
+    static description: string;
+    static flags: {
+        action: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        directory: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        amend: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        'action-config-path': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        'input-path': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
+    };
+    run(): Promise<void>;
+}

package/lib/commands/action/input.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Input = void 0;
+const tslib_1 = require("tslib");
+const core_1 = require("@oclif/core");
+const core_2 = require("@sw-tsdk/core");
+const node_path_1 = require("node:path");
+const fs_extra_1 = require("fs-extra");
+const node_process_1 = tslib_1.__importDefault(require("node:process"));
+const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
+const connector_1 = require("@sw-tsdk/connector");
+const common_1 = require("../../common");
+// noinspection JSUnusedGlobalSymbols
+class Input extends core_2.Base {
+    async run() {
+        const { flags, } = await this.parse(Input);
+        let { directory, 'input-path': inputPath, 'action-config-path': actionConfigPath, action, } = flags;
+        const { amend, } = flags;
+        directory = (0, node_path_1.resolve)(directory || node_process_1.default.cwd());
+        // ensure directory path
+        try {
+            await fs_extra_1.promises.access(directory);
+        }
+        catch (_a) {
+            this.error(`Could not access ${directory}`);
+        }
+        // select action if not provided.
+        if (!action) {
+            action = await (0, common_1.chooseAction)(directory);
+        }
+        actionConfigPath = actionConfigPath || (0, node_path_1.join)(directory, 'connector', 'config', 'actions', `${action}.yaml`);
+        const actionConfig = await js_yaml_1.default.load(await (0, fs_extra_1.readFile)(actionConfigPath, 'utf-8'));
+        core_1.CliUx.ux.action.start('Updating output schema');
+        inputPath = inputPath || (0, node_path_1.join)(directory, 'data', `${action}.json`);
+        const inputData = await (0, fs_extra_1.readJson)(inputPath);
+        const inputSchema = await (0, connector_1.generateSchema)('inputs', inputData, connector_1.schemaDefaults);
+        // remove unnecessary top level attributes
+        delete inputSchema.inputs.title;
+        delete inputSchema.inputs.examples;
+        if (amend) {
+            Object.assign(actionConfig.inputs, inputSchema.inputs);
+        }
+        else {
+            actionConfig.inputs = inputSchema.inputs;
+        }
+        await (0, fs_extra_1.writeFile)(actionConfigPath, js_yaml_1.default.dump(actionConfig, { noRefs: true }));
+        core_1.CliUx.ux.action.stop();
+    }
+}
+exports.Input = Input;
+Input.description = 'Update action input schema.';
+Input.flags = Object.assign(Object.assign({}, core_2.Base.flags), { action: core_1.Flags.string({
+        char: 'a',
+        description: 'Action name to run',
+    }), directory: core_1.Flags.string({
+        char: 'd',
+        description: 'Root directory of the repository.',
+        default: './',
+    }), amend: core_1.Flags.boolean({
+        description: 'Merge with existing schema.',
+    }), 'action-config-path': core_1.Flags.string({
+        description: 'Override path to action configuration file. Defaults to /connector/config/actions/<action>.yaml',
+    }), 'input-path': core_1.Flags.string({
+        description: 'Relative path to the output data JSON file, defaults to the task name under the data folder. ie: /data/<taskName>_output.json',
+        dependsOn: ['update-output-schema'],
+    }), help: core_1.Flags.help({
+        char: 'h',
+    }) });
+//# sourceMappingURL=input.js.map

package/lib/commands/action/input.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"input.js","sourceRoot":"","sources":["../../../src/commands/action/input.ts"],"names":[],"mappings":";;;;AAAA,sCAAwC;AACxC,wCAAkC;AAClC,yCAAuC;AACvC,uCAAgE;AAChE,wEAAkC;AAClC,8DAA0B;AAK1B,kDAAiE;AACjE,yCAAyC;AAEzC,qCAAqC;AACrC,MAAa,KAAM,SAAQ,WAAI;IA6B7B,KAAK,CAAC,GAAG;QACP,MAAM,EACJ,KAAK,GACN,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;QAE3B,IAAI,EACF,SAAS,EACT,YAAY,EAAE,SAAS,EACvB,oBAAoB,EAAE,gBAAgB,EACtC,MAAM,GACP,GAAG,KAAK,CAAA;QAET,MAAM,EACJ,KAAK,GACN,GAAG,KAAK,CAAA;QAET,SAAS,GAAG,IAAA,mBAAO,EAAC,SAAS,IAAI,sBAAO,CAAC,GAAG,EAAE,CAAC,CAAA;QAE/C,wBAAwB;QACxB,IAAI;YACF,MAAM,mBAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;SACjC;QAAC,WAAM;YACN,IAAI,CAAC,KAAK,CAAC,oBAAoB,SAAS,EAAE,CAAC,CAAA;SAC5C;QAED,iCAAiC;QACjC,IAAI,CAAC,MAAM,EAAE;YACX,MAAM,GAAG,MAAM,IAAA,qBAAY,EAAC,SAAS,CAAC,CAAA;SACvC;QAED,gBAAgB,GAAG,gBAAgB,IAAI,IAAA,gBAAI,EAAC,SAAS,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,MAAM,OAAO,CAAC,CAAA;QAC1G,MAAM,YAAY,GAAG,MAAM,iBAAI,CAAC,IAAI,CAAC,MAAM,IAAA,mBAAQ,EAAC,gBAAgB,EAAE,OAAO,CAAC,CAA4B,CAAA;QAE1G,YAAK,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAA;QAC/C,SAAS,GAAG,SAAS,IAAK,IAAA,gBAAI,EAAC,SAAS,EAAE,MAAM,EAAE,GAAG,MAAM,OAAO,CAAC,CAAA;QACnE,MAAM,SAAS,GAAG,MAAM,IAAA,mBAAQ,EAAC,SAAS,CAAC,CAAA;QAC3C,MAAM,WAAW,GAAG,MAAM,IAAA,0BAAc,EAAC,QAAQ,EAAE,SAAS,EAAE,0BAAc,CAA8C,CAAA;QAC1H,0CAA0C;QAC1C,OAAO,WAAW,CAAC,MAAM,CAAC,KAAK,CAAA;QAC/B,OAAO,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAA;QAElC,IAAI,KAAK,EAAE;YACT,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;SACvD;aAAM;YACL,YAAY,CAAC,MAAM,GAAG,WAAW,CAAC,MAAM,CAAA;SACzC;QAED,MAAM,IAAA,oBAAS,EAAC,gBAAgB,EAAE,iBAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAC,MAAM,EAAE,IAAI,EAAC,CAAC,CAAC,CAAA;QAC1E,YAAK,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAA;IACxB,CAAC;;AA9EH,sBA+EC;AA9EQ,iBAAW,GAAG,6BAA6B,CAAA;AAE3C,WAAK,mCACP,WAAI,CAAC,KAAK,KACb,MAAM,EAAE,YAAK,CAAC,MAAM,CAAC;QACnB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,oBAAoB;KAClC,CAAC,EACF,SAAS,EAAE,YAAK,CAAC,MAAM,CAAC;QACtB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,mCAAmC;QAChD,OAAO,EAAE,IAAI;KACd,CAAC,EACF,KAAK,EAAE,YAAK,CAAC,OAAO,CAAC;QACnB,WAAW,EAAE,6BAA6B;KAC3C,CAAC,EACF,oBAAoB,EAAE,YAAK,CAAC,MAAM,CAAC;QACjC,WAAW,EAAE,iGAAiG;KAC/G,CAAC,EACF,YAAY,EAAE,YAAK,CAAC,MAAM,CAAC;QACzB,WAAW,EAAE,+HAA+H;QAC5I,SAAS,EAAE,CAAC,sBAAsB,CAAC;KACpC,CAAC,EACF,IAAI,EAAE,YAAK,CAAC,IAAI,CAAC;QACf,IAAI,EAAE,GAAG;KACV,CAAC,IACH"}

package/lib/commands/action/output.d.ts

@@ -0,0 +1,13 @@
+import { Base } from '@sw-tsdk/core';
+export declare class Output extends Base {
+    static description: string;
+    static flags: {
+        action: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        directory: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        'action-config-path': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        amend: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        'output-path': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
+    };
+    run(): Promise<void>;
+}

package/lib/commands/action/output.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Output = void 0;
+const tslib_1 = require("tslib");
+const core_1 = require("@oclif/core");
+const core_2 = require("@sw-tsdk/core");
+const node_path_1 = require("node:path");
+const fs_extra_1 = require("fs-extra");
+const node_process_1 = tslib_1.__importDefault(require("node:process"));
+const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
+const connector_1 = require("@sw-tsdk/connector");
+const common_1 = require("../../common");
+// noinspection JSUnusedGlobalSymbols
+class Output extends core_2.Base {
+    async run() {
+        const { flags, } = await this.parse(Output);
+        let { directory, 'output-path': outputPath, 'action-config-path': actionConfigPath, action, } = flags;
+        const { amend, } = flags;
+        directory = (0, node_path_1.resolve)(directory || node_process_1.default.cwd());
+        // ensure directory path
+        try {
+            await fs_extra_1.promises.access(directory);
+        }
+        catch (_a) {
+            this.error(`Could not access ${directory}`);
+        }
+        // select action if not provided.
+        if (!action) {
+            action = await (0, common_1.chooseAction)(directory);
+        }
+        actionConfigPath = actionConfigPath || (0, node_path_1.join)(directory, 'connector', 'config', 'actions', `${action}.yaml`);
+        const actionConfig = await js_yaml_1.default.load(await (0, fs_extra_1.readFile)(actionConfigPath, 'utf-8'));
+        core_1.CliUx.ux.action.start('Updating output schema');
+        outputPath = outputPath || (0, node_path_1.join)(directory, 'data', `${action}_output.json`);
+        const outputData = await (0, fs_extra_1.readJson)(outputPath);
+        const outputSchema = await (0, connector_1.generateSchema)('output', outputData, connector_1.schemaDefaults);
+        // remove unnecessary top level attributes
+        delete outputSchema.output.title;
+        if (amend) {
+            Object.assign(actionConfig.output, outputSchema.output);
+        }
+        else {
+            actionConfig.output = outputSchema.output;
+        }
+        await (0, fs_extra_1.writeFile)(actionConfigPath, js_yaml_1.default.dump(actionConfig, { noRefs: true }));
+        core_1.CliUx.ux.action.stop();
+    }
+}
+exports.Output = Output;
+Output.description = 'Update a connector action.';
+Output.flags = Object.assign(Object.assign({}, core_2.Base.flags), { action: core_1.Flags.string({
+        char: 'a',
+        description: 'Action name to run',
+    }), directory: core_1.Flags.string({
+        char: 'd',
+        description: 'Root directory of the repository.',
+        default: './',
+    }), 'action-config-path': core_1.Flags.string({
+        description: 'Override path to action configuration file. Defaults to /connector/config/<action>.yaml',
+    }), amend: core_1.Flags.boolean({
+        description: 'Merge with existing schema.',
+    }), 'output-path': core_1.Flags.string({
+        description: 'Relative path to the output data JSON file, defaults to the task name under the data folder. ie: /data/<taskName>_output.json',
+        dependsOn: ['update-output-schema'],
+    }), help: core_1.Flags.help({
+        char: 'h',
+    }) });
+//# sourceMappingURL=output.js.map

package/lib/commands/action/output.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"output.js","sourceRoot":"","sources":["../../../src/commands/action/output.ts"],"names":[],"mappings":";;;;AAAA,sCAAwC;AACxC,wCAAkC;AAClC,yCAAuC;AACvC,uCAAgE;AAChE,wEAAkC;AAClC,8DAA0B;AAK1B,kDAAiE;AACjE,yCAAyC;AAEzC,qCAAqC;AACrC,MAAa,MAAO,SAAQ,WAAI;IA6B9B,KAAK,CAAC,GAAG;QACP,MAAM,EACJ,KAAK,GACN,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;QAE5B,IAAI,EACF,SAAS,EACT,aAAa,EAAE,UAAU,EACzB,oBAAoB,EAAE,gBAAgB,EACtC,MAAM,GACP,GAAG,KAAK,CAAA;QAET,MAAM,EACJ,KAAK,GACN,GAAG,KAAK,CAAA;QAET,SAAS,GAAG,IAAA,mBAAO,EAAC,SAAS,IAAI,sBAAO,CAAC,GAAG,EAAE,CAAC,CAAA;QAE/C,wBAAwB;QACxB,IAAI;YACF,MAAM,mBAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;SACjC;QAAC,WAAM;YACN,IAAI,CAAC,KAAK,CAAC,oBAAoB,SAAS,EAAE,CAAC,CAAA;SAC5C;QAED,iCAAiC;QACjC,IAAI,CAAC,MAAM,EAAE;YACX,MAAM,GAAG,MAAM,IAAA,qBAAY,EAAC,SAAS,CAAC,CAAA;SACvC;QAED,gBAAgB,GAAG,gBAAgB,IAAI,IAAA,gBAAI,EAAC,SAAS,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,MAAM,OAAO,CAAC,CAAA;QAE1G,MAAM,YAAY,GAAG,MAAM,iBAAI,CAAC,IAAI,CAAC,MAAM,IAAA,mBAAQ,EAAC,gBAAgB,EAAE,OAAO,CAAC,CAA4B,CAAA;QAE1G,YAAK,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAA;QAC/C,UAAU,GAAG,UAAU,IAAK,IAAA,gBAAI,EAAC,SAAS,EAAE,MAAM,EAAE,GAAG,MAAM,cAAc,CAAC,CAAA;QAC5E,MAAM,UAAU,GAAG,MAAM,IAAA,mBAAQ,EAAC,UAAU,CAAC,CAAA;QAC7C,MAAM,YAAY,GAAG,MAAM,IAAA,0BAAc,EAAC,QAAQ,EAAE,UAAU,EAAE,0BAAc,CAA8C,CAAA;QAC5H,0CAA0C;QAC1C,OAAO,YAAY,CAAC,MAAM,CAAC,KAAK,CAAA;QAChC,IAAI,KAAK,EAAE;YACT,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC,CAAA;SACxD;aAAM;YACL,YAAY,CAAC,MAAM,GAAG,YAAY,CAAC,MAAM,CAAA;SAC1C;QAED,MAAM,IAAA,oBAAS,EAAC,gBAAgB,EAAE,iBAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAC,MAAM,EAAE,IAAI,EAAC,CAAC,CAAC,CAAA;QAC1E,YAAK,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAA;IACxB,CAAC;;AA7EH,wBA8EC;AA7EQ,kBAAW,GAAG,4BAA4B,CAAA;AAE1C,YAAK,mCACP,WAAI,CAAC,KAAK,KACb,MAAM,EAAE,YAAK,CAAC,MAAM,CAAC;QACnB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,oBAAoB;KAClC,CAAC,EACF,SAAS,EAAE,YAAK,CAAC,MAAM,CAAC;QACtB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,mCAAmC;QAChD,OAAO,EAAE,IAAI;KACd,CAAC,EACF,oBAAoB,EAAE,YAAK,CAAC,MAAM,CAAC;QACjC,WAAW,EAAE,yFAAyF;KACvG,CAAC,EACF,KAAK,EAAE,YAAK,CAAC,OAAO,CAAC;QACnB,WAAW,EAAE,6BAA6B;KAC3C,CAAC,EACF,aAAa,EAAE,YAAK,CAAC,MAAM,CAAC;QAC1B,WAAW,EAAE,+HAA+H;QAC5I,SAAS,EAAE,CAAC,sBAAsB,CAAC;KACpC,CAAC,EACF,IAAI,EAAE,YAAK,CAAC,IAAI,CAAC;QACf,IAAI,EAAE,GAAG;KACV,CAAC,IACH"}

package/lib/commands/action/run.d.ts

@@ -0,0 +1,23 @@
+import { Base } from '@sw-tsdk/core';
+export declare class Run extends Base {
+    static description: string;
+    static flags: {
+        action: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        directory: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        'input-path': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        'output-path': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        'error-path': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        'asset-path': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        image: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        latest: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        build: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        template: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        'compile-override': import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        'runner-override': import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        'runtime-override': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        'force-rebuild': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        platform: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
+    };
+    run(): Promise<void>;
+}