@sw-tsdk/plugin-connector 2.18.0 → 2.19.0

package/README.md

@@ -16,7 +16,7 @@ $ npm install -g @sw-tsdk/plugin-connector
 $ sw-tsdk-connector COMMAND
 running command...
 $ sw-tsdk-connector (--version)
-@sw-tsdk/plugin-connector/2.18.0 linux-x64 node-v16.20.2
+@sw-tsdk/plugin-connector/2.19.0 linux-x64 node-v16.20.2
 $ sw-tsdk-connector --help [COMMAND]
 USAGE
   $ sw-tsdk-connector COMMAND
@@ -43,6 +43,9 @@ USAGE
 * [`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 description:action`](#sw-tsdk-connector-descriptionaction)
+* [`sw-tsdk-connector description:actions`](#sw-tsdk-connector-descriptionactions)
+* [`sw-tsdk-connector description:connector`](#sw-tsdk-connector-descriptionconnector)
 
 ## `sw-tsdk-connector action:add`
 
@@ -62,7 +65,7 @@ DESCRIPTION
   Update a connector action.
 ```
 
-_See code: [lib/commands/action/add.js](https://github.com/swimlane/turbine-sdk/blob/v2.18.0/lib/commands/action/add.js)_
+_See code: [lib/commands/action/add.js](https://github.com/swimlane/turbine-sdk/blob/v2.19.0/lib/commands/action/add.js)_
 
 ## `sw-tsdk-connector action:generate:data`
 
@@ -87,7 +90,7 @@ DESCRIPTION
   Use to test a task in an integration
 ```
 
-_See code: [lib/commands/action/generate/data.js](https://github.com/swimlane/turbine-sdk/blob/v2.18.0/lib/commands/action/generate/data.js)_
+_See code: [lib/commands/action/generate/data.js](https://github.com/swimlane/turbine-sdk/blob/v2.19.0/lib/commands/action/generate/data.js)_
 
 ## `sw-tsdk-connector action:generate:input`
 
@@ -112,7 +115,7 @@ DESCRIPTION
   Update action input schema.
 ```
 
-_See code: [lib/commands/action/generate/input.js](https://github.com/swimlane/turbine-sdk/blob/v2.18.0/lib/commands/action/generate/input.js)_
+_See code: [lib/commands/action/generate/input.js](https://github.com/swimlane/turbine-sdk/blob/v2.19.0/lib/commands/action/generate/input.js)_
 
 ## `sw-tsdk-connector action:generate:output`
 
@@ -136,7 +139,7 @@ DESCRIPTION
   Update a connector action.
 ```
 
-_See code: [lib/commands/action/generate/output.js](https://github.com/swimlane/turbine-sdk/blob/v2.18.0/lib/commands/action/generate/output.js)_
+_See code: [lib/commands/action/generate/output.js](https://github.com/swimlane/turbine-sdk/blob/v2.19.0/lib/commands/action/generate/output.js)_
 
 ## `sw-tsdk-connector action:run:local`
 
@@ -165,7 +168,7 @@ DESCRIPTION
   Runs a connector action. (Defaults to current image version in local repository).
 ```
 
-_See code: [lib/commands/action/run/local.js](https://github.com/swimlane/turbine-sdk/blob/v2.18.0/lib/commands/action/run/local.js)_
+_See code: [lib/commands/action/run/local.js](https://github.com/swimlane/turbine-sdk/blob/v2.19.0/lib/commands/action/run/local.js)_
 
 ## `sw-tsdk-connector asset:add`
 
@@ -186,7 +189,7 @@ DESCRIPTION
   Update a connector action.
 ```
 
-_See code: [lib/commands/asset/add.js](https://github.com/swimlane/turbine-sdk/blob/v2.18.0/lib/commands/asset/add.js)_
+_See code: [lib/commands/asset/add.js](https://github.com/swimlane/turbine-sdk/blob/v2.19.0/lib/commands/asset/add.js)_
 
 ## `sw-tsdk-connector component:create`
 
@@ -216,7 +219,7 @@ DESCRIPTION
   Scaffold a new Component
 ```
 
-_See code: [lib/commands/component/create.js](https://github.com/swimlane/turbine-sdk/blob/v2.18.0/lib/commands/component/create.js)_
+_See code: [lib/commands/component/create.js](https://github.com/swimlane/turbine-sdk/blob/v2.19.0/lib/commands/component/create.js)_
 
 ## `sw-tsdk-connector component:logo`
 
@@ -237,7 +240,7 @@ DESCRIPTION
   Update a Component logo.
 ```
 
-_See code: [lib/commands/component/logo.js](https://github.com/swimlane/turbine-sdk/blob/v2.18.0/lib/commands/component/logo.js)_
+_See code: [lib/commands/component/logo.js](https://github.com/swimlane/turbine-sdk/blob/v2.19.0/lib/commands/component/logo.js)_
 
 ## `sw-tsdk-connector component:ssp`
 
@@ -258,7 +261,7 @@ DESCRIPTION
   Update an SSP.
 ```
 
-_See code: [lib/commands/component/ssp.js](https://github.com/swimlane/turbine-sdk/blob/v2.18.0/lib/commands/component/ssp.js)_
+_See code: [lib/commands/component/ssp.js](https://github.com/swimlane/turbine-sdk/blob/v2.19.0/lib/commands/component/ssp.js)_
 
 ## `sw-tsdk-connector component:update`
 
@@ -280,7 +283,7 @@ DESCRIPTION
   Update Component Version.
 ```
 
-_See code: [lib/commands/component/update.js](https://github.com/swimlane/turbine-sdk/blob/v2.18.0/lib/commands/component/update.js)_
+_See code: [lib/commands/component/update.js](https://github.com/swimlane/turbine-sdk/blob/v2.19.0/lib/commands/component/update.js)_
 
 ## `sw-tsdk-connector connector:build`
 
@@ -310,7 +313,7 @@ DESCRIPTION
   Builds a local docker image of the connector.
 ```
 
-_See code: [lib/commands/connector/build.js](https://github.com/swimlane/turbine-sdk/blob/v2.18.0/lib/commands/connector/build.js)_
+_See code: [lib/commands/connector/build.js](https://github.com/swimlane/turbine-sdk/blob/v2.19.0/lib/commands/connector/build.js)_
 
 ## `sw-tsdk-connector connector:create`
 
@@ -342,7 +345,7 @@ DESCRIPTION
   Scaffold a new connector
 ```
 
-_See code: [lib/commands/connector/create.js](https://github.com/swimlane/turbine-sdk/blob/v2.18.0/lib/commands/connector/create.js)_
+_See code: [lib/commands/connector/create.js](https://github.com/swimlane/turbine-sdk/blob/v2.19.0/lib/commands/connector/create.js)_
 
 ## `sw-tsdk-connector connector:create:openapi`
 
@@ -371,7 +374,7 @@ DESCRIPTION
   Scaffold a new connector
 ```
 
-_See code: [lib/commands/connector/create/openapi.js](https://github.com/swimlane/turbine-sdk/blob/v2.18.0/lib/commands/connector/create/openapi.js)_
+_See code: [lib/commands/connector/create/openapi.js](https://github.com/swimlane/turbine-sdk/blob/v2.19.0/lib/commands/connector/create/openapi.js)_
 
 ## `sw-tsdk-connector connector:create:source`
 
@@ -389,7 +392,7 @@ DESCRIPTION
   Generates 11x source from 10x
 ```
 
-_See code: [lib/commands/connector/create/source.js](https://github.com/swimlane/turbine-sdk/blob/v2.18.0/lib/commands/connector/create/source.js)_
+_See code: [lib/commands/connector/create/source.js](https://github.com/swimlane/turbine-sdk/blob/v2.19.0/lib/commands/connector/create/source.js)_
 
 ## `sw-tsdk-connector connector:logo`
 
@@ -408,7 +411,7 @@ DESCRIPTION
   Update a connector.
 ```
 
-_See code: [lib/commands/connector/logo.js](https://github.com/swimlane/turbine-sdk/blob/v2.18.0/lib/commands/connector/logo.js)_
+_See code: [lib/commands/connector/logo.js](https://github.com/swimlane/turbine-sdk/blob/v2.19.0/lib/commands/connector/logo.js)_
 
 ## `sw-tsdk-connector connector:sign`
 
@@ -433,7 +436,7 @@ DESCRIPTION
   Builds a local docker image of the connector.
 ```
 
-_See code: [lib/commands/connector/sign.js](https://github.com/swimlane/turbine-sdk/blob/v2.18.0/lib/commands/connector/sign.js)_
+_See code: [lib/commands/connector/sign.js](https://github.com/swimlane/turbine-sdk/blob/v2.19.0/lib/commands/connector/sign.js)_
 
 ## `sw-tsdk-connector connector:update`
 
@@ -453,7 +456,7 @@ DESCRIPTION
   Update a connector.
 ```
 
-_See code: [lib/commands/connector/update.js](https://github.com/swimlane/turbine-sdk/blob/v2.18.0/lib/commands/connector/update.js)_
+_See code: [lib/commands/connector/update.js](https://github.com/swimlane/turbine-sdk/blob/v2.19.0/lib/commands/connector/update.js)_
 
 ## `sw-tsdk-connector connector:validate`
 
@@ -476,5 +479,66 @@ DESCRIPTION
   Use to validate an integration
 ```
 
-_See code: [lib/commands/connector/validate.js](https://github.com/swimlane/turbine-sdk/blob/v2.18.0/lib/commands/connector/validate.js)_
+_See code: [lib/commands/connector/validate.js](https://github.com/swimlane/turbine-sdk/blob/v2.19.0/lib/commands/connector/validate.js)_
+
+## `sw-tsdk-connector description:action`
+
+Use to generate action description
+
+```
+USAGE
+  $ sw-tsdk-connector description:action [-h] [-i <value>] [-s] [-d <value>] [-a <value>]
+
+FLAGS
+  -a, --action=<value>     Generate description for specific action
+  -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
+
+DESCRIPTION
+  Use to generate action description
+```
+
+_See code: [lib/commands/description/action.js](https://github.com/swimlane/turbine-sdk/blob/v2.19.0/lib/commands/description/action.js)_
+
+## `sw-tsdk-connector description:actions`
+
+Use to generate description for all actions
+
+```
+USAGE
+  $ sw-tsdk-connector description:actions [-h] [-i <value>] [-s] [-d <value>]
+
+FLAGS
+  -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
+
+DESCRIPTION
+  Use to generate description for all actions
+```
+
+_See code: [lib/commands/description/actions.js](https://github.com/swimlane/turbine-sdk/blob/v2.19.0/lib/commands/description/actions.js)_
+
+## `sw-tsdk-connector description:connector`
+
+Use to generate connector descriptions
+
+```
+USAGE
+  $ sw-tsdk-connector description:connector [-h] [-i <value>] [-s] [-d <value>]
+
+FLAGS
+  -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
+
+DESCRIPTION
+  Use to generate connector descriptions
+```
+
+_See code: [lib/commands/description/connector.js](https://github.com/swimlane/turbine-sdk/blob/v2.19.0/lib/commands/description/connector.js)_
 <!-- commandsstop -->

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

@@ -0,0 +1,12 @@
+import { Base } from '@sw-tsdk/core';
+export declare class Action extends Base {
+    static description: string;
+    static flags: {
+        help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
+        image: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        'skip-pull': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        directory: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        action: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/lib/commands/description/action.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Action = void 0;
+const core_1 = require("@oclif/core");
+const node_path_1 = require("node:path");
+const docker_1 = require("@sw-tsdk/docker");
+const core_2 = require("@oclif/core");
+const node_fs_1 = require("node:fs");
+const core_3 = require("@sw-tsdk/core");
+const common_1 = require("../../common");
+// noinspection JSUnusedGlobalSymbols
+class Action extends core_3.Base {
+    async run() {
+        const { flags } = await this.parse(Action);
+        const { 'skip-pull': skipPull, action, } = flags;
+        let { image } = flags;
+        let { directory } = flags;
+        directory = (0, node_path_1.resolve)(directory);
+        const typeOfContent = 'action';
+        if (!image) {
+            image = `${docker_1.DockerDefaults.SdkTurbineContentDescriptionImage}`;
+        }
+        try {
+            await node_fs_1.promises.access(directory);
+        }
+        catch {
+            this.error(`Could not access ${directory}`);
+        }
+        const docker = new docker_1.Docker();
+        core_2.ux.action.start('Checking for docker...');
+        await docker.ping();
+        core_2.ux.action.stop();
+        if (!skipPull) {
+            core_2.ux.action.start(`Pulling image (${image})...`);
+            await docker.pullImage(image);
+            core_2.ux.action.stop();
+        }
+        const actionToExecute = action || await (0, common_1.chooseAction)(directory);
+        const bindings = [`${directory}:/app/content`];
+        const commands = ['main.py'];
+        commands.push('-t', typeOfContent, '-a', actionToExecute);
+        const envVars = [
+            `OPENAI_API_KEY=${process.env.OPENAI_API_KEY}`,
+            `OPENAI_ORGANIZATION=${process.env.OPENAI_ORGANIZATION}`,
+        ];
+        const createOptions = {
+            Cmd: commands,
+            HostConfig: {
+                AutoRemove: false,
+                Binds: bindings,
+            },
+            Env: envVars,
+        };
+        core_2.ux.action.start('Generating Action Description...');
+        const outputStream = (0, core_3.writableNoopStream)();
+        const errorStream = (0, core_3.writableNoopStream)();
+        const success = await docker.runImage(image, createOptions, outputStream, errorStream);
+        core_2.ux.action.stop();
+        if (!success) {
+            core_2.Errors.exit(1);
+        }
+    }
+}
+exports.Action = Action;
+Action.description = 'Use to generate action description';
+Action.flags = {
+    ...core_3.Base.flags,
+    help: core_1.Flags.help({ char: 'h' }),
+    image: core_1.Flags.string({
+        char: 'i',
+        description: 'image to use',
+    }),
+    'skip-pull': core_1.Flags.boolean({
+        char: 's',
+        description: 'skips pulling the image',
+    }),
+    directory: core_1.Flags.string({
+        char: 'd',
+        description: 'current directory to mount',
+        default: './',
+    }),
+    action: core_1.Flags.string({
+        char: 'a',
+        description: 'Generate description for specific action',
+    }),
+};
+//# sourceMappingURL=action.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"action.js","sourceRoot":"","sources":["../../../src/commands/description/action.ts"],"names":[],"mappings":";;;AAAA,sCAAiC;AACjC,yCAAiC;AACjC,4CAAsD;AACtD,sCAAsC;AACtC,qCAAgC;AAChC,wCAAsD;AACtD,yCAAyC;AAEzC,qCAAqC;AACrC,MAAa,MAAO,SAAQ,WAAI;IAyB9B,KAAK,CAAC,GAAG;QACP,MAAM,EAAC,KAAK,EAAC,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;QACxC,MAAM,EACJ,WAAW,EAAE,QAAQ,EAAE,MAAM,GAC9B,GAAG,KAAK,CAAA;QACT,IAAI,EAAC,KAAK,EAAC,GAAG,KAAK,CAAA;QAEnB,IAAI,EAAC,SAAS,EAAC,GAAG,KAAK,CAAA;QACvB,SAAS,GAAG,IAAA,mBAAO,EAAC,SAAS,CAAC,CAAA;QAE9B,MAAM,aAAa,GAAG,QAAQ,CAAA;QAC9B,IAAI,CAAC,KAAK,EAAE;YACV,KAAK,GAAG,GAAG,uBAAc,CAAC,iCAAiC,EAAE,CAAA;SAC9D;QAED,IAAI;YACF,MAAM,kBAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;SACjC;QAAC,MAAM;YACN,IAAI,CAAC,KAAK,CAAC,oBAAoB,SAAS,EAAE,CAAC,CAAA;SAC5C;QAED,MAAM,MAAM,GAAG,IAAI,eAAM,EAAE,CAAA;QAC3B,SAAE,CAAC,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAA;QACzC,MAAM,MAAM,CAAC,IAAI,EAAE,CAAA;QACnB,SAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAA;QAEhB,IAAI,CAAC,QAAQ,EAAE;YACb,SAAE,CAAC,MAAM,CAAC,KAAK,CAAC,kBAAkB,KAAK,MAAM,CAAC,CAAA;YAE9C,MAAM,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;YAC7B,SAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAA;SACjB;QAED,MAAM,eAAe,GAAG,MAAM,IAAI,MAAM,IAAA,qBAAY,EAAC,SAAS,CAAC,CAAA;QAE/D,MAAM,QAAQ,GAAG,CAAC,GAAG,SAAS,eAAe,CAAC,CAAA;QAC9C,MAAM,QAAQ,GAAG,CAAC,SAAS,CAAC,CAAA;QAE5B,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,eAAe,CAAC,CAAA;QAEzD,MAAM,OAAO,GAAG;YACd,kBAAkB,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE;YAC9C,uBAAuB,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE;SACzD,CAAA;QAED,MAAM,aAAa,GAAG;YACpB,GAAG,EAAE,QAAQ;YACb,UAAU,EAAE;gBACV,UAAU,EAAE,KAAK;gBACjB,KAAK,EAAE,QAAQ;aAChB;YACD,GAAG,EAAE,OAAO;SACb,CAAA;QAED,SAAE,CAAC,MAAM,CAAC,KAAK,CAAC,kCAAkC,CAAC,CAAA;QACnD,MAAM,YAAY,GAAG,IAAA,yBAAkB,GAAE,CAAA;QACzC,MAAM,WAAW,GAAG,IAAA,yBAAkB,GAAE,CAAA;QACxC,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,QAAQ,CACnC,KAAK,EACL,aAAa,EACb,YAAY,EACZ,WAAW,CACZ,CAAA;QACD,SAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAA;QAChB,IAAI,CAAC,OAAO,EAAE;YACZ,aAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;SACf;IACH,CAAC;;AA5FH,wBA6FC;AA5FQ,kBAAW,GAAG,oCAAoC,CAAC;AAEnD,YAAK,GAAG;IACb,GAAG,WAAI,CAAC,KAAK;IACb,IAAI,EAAE,YAAK,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,GAAG,EAAC,CAAC;IAC7B,KAAK,EAAE,YAAK,CAAC,MAAM,CAAC;QAClB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,cAAc;KAC5B,CAAC;IACF,WAAW,EAAE,YAAK,CAAC,OAAO,CAAC;QACzB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,yBAAyB;KACvC,CAAC;IACF,SAAS,EAAE,YAAK,CAAC,MAAM,CAAC;QACtB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,4BAA4B;QACzC,OAAO,EAAE,IAAI;KACd,CAAC;IACF,MAAM,EAAE,YAAK,CAAC,MAAM,CAAC;QACnB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,0CAA0C;KACxD,CAAC;CACH,CAAC"}

package/lib/commands/description/actions.d.ts

@@ -0,0 +1,11 @@
+import { Base } from '@sw-tsdk/core';
+export declare class Actions extends Base {
+    static description: string;
+    static flags: {
+        help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
+        image: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        'skip-pull': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        directory: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/lib/commands/description/actions.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Actions = void 0;
+const core_1 = require("@oclif/core");
+const node_path_1 = require("node:path");
+const docker_1 = require("@sw-tsdk/docker");
+const core_2 = require("@oclif/core");
+const node_fs_1 = require("node:fs");
+const core_3 = require("@sw-tsdk/core");
+// noinspection JSUnusedGlobalSymbols
+class Actions extends core_3.Base {
+    async run() {
+        const { flags } = await this.parse(Actions);
+        const { 'skip-pull': skipPull, } = flags;
+        let { image } = flags;
+        let { directory } = flags;
+        directory = (0, node_path_1.resolve)(directory);
+        const typeOfContent = 'actions';
+        if (!image) {
+            image = `${docker_1.DockerDefaults.SdkTurbineContentDescriptionImage}`;
+        }
+        try {
+            await node_fs_1.promises.access(directory);
+        }
+        catch {
+            this.error(`Could not access ${directory}`);
+        }
+        const docker = new docker_1.Docker();
+        core_2.ux.action.start('Checking for docker...');
+        await docker.ping();
+        core_2.ux.action.stop();
+        if (!skipPull) {
+            core_2.ux.action.start(`Pulling image (${image})...`);
+            await docker.pullImage(image);
+            core_2.ux.action.stop();
+        }
+        const bindings = [`${directory}:/app/content`];
+        const commands = ['main.py'];
+        commands.push('-t', typeOfContent);
+        const envVars = [
+            `OPENAI_API_KEY=${process.env.OPENAI_API_KEY}`,
+            `OPENAI_ORGANIZATION=${process.env.OPENAI_ORGANIZATION}`,
+        ];
+        const createOptions = {
+            Cmd: commands,
+            HostConfig: {
+                AutoRemove: false,
+                Binds: bindings,
+            },
+            Env: envVars,
+        };
+        core_2.ux.action.start('Generating Actions Description...');
+        const outputStream = (0, core_3.writableNoopStream)();
+        const errorStream = (0, core_3.writableNoopStream)();
+        const success = await docker.runImage(image, createOptions, outputStream, errorStream);
+        core_2.ux.action.stop();
+        if (!success) {
+            core_2.Errors.exit(1);
+        }
+    }
+}
+exports.Actions = Actions;
+Actions.description = 'Use to generate description for all actions';
+Actions.flags = {
+    ...core_3.Base.flags,
+    help: core_1.Flags.help({ char: 'h' }),
+    image: core_1.Flags.string({
+        char: 'i',
+        description: 'image to use',
+    }),
+    'skip-pull': core_1.Flags.boolean({
+        char: 's',
+        description: 'skips pulling the image',
+    }),
+    directory: core_1.Flags.string({
+        char: 'd',
+        description: 'current directory to mount',
+        default: './',
+    }),
+};
+//# sourceMappingURL=actions.js.map

package/lib/commands/description/actions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.js","sourceRoot":"","sources":["../../../src/commands/description/actions.ts"],"names":[],"mappings":";;;AAAA,sCAAiC;AACjC,yCAAiC;AACjC,4CAAsD;AACtD,sCAAsC;AACtC,qCAAgC;AAChC,wCAAsD;AAEtD,qCAAqC;AACrC,MAAa,OAAQ,SAAQ,WAAI;IAqB/B,KAAK,CAAC,GAAG;QACP,MAAM,EAAC,KAAK,EAAC,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QACzC,MAAM,EACJ,WAAW,EAAE,QAAQ,GACtB,GAAG,KAAK,CAAA;QACT,IAAI,EAAC,KAAK,EAAC,GAAG,KAAK,CAAA;QAEnB,IAAI,EAAC,SAAS,EAAC,GAAG,KAAK,CAAA;QACvB,SAAS,GAAG,IAAA,mBAAO,EAAC,SAAS,CAAC,CAAA;QAE9B,MAAM,aAAa,GAAG,SAAS,CAAA;QAC/B,IAAI,CAAC,KAAK,EAAE;YACV,KAAK,GAAG,GAAG,uBAAc,CAAC,iCAAiC,EAAE,CAAA;SAC9D;QAED,IAAI;YACF,MAAM,kBAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;SACjC;QAAC,MAAM;YACN,IAAI,CAAC,KAAK,CAAC,oBAAoB,SAAS,EAAE,CAAC,CAAA;SAC5C;QAED,MAAM,MAAM,GAAG,IAAI,eAAM,EAAE,CAAA;QAC3B,SAAE,CAAC,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAA;QACzC,MAAM,MAAM,CAAC,IAAI,EAAE,CAAA;QACnB,SAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAA;QAEhB,IAAI,CAAC,QAAQ,EAAE;YACb,SAAE,CAAC,MAAM,CAAC,KAAK,CAAC,kBAAkB,KAAK,MAAM,CAAC,CAAA;YAE9C,MAAM,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;YAC7B,SAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAA;SACjB;QAED,MAAM,QAAQ,GAAG,CAAC,GAAG,SAAS,eAAe,CAAC,CAAA;QAC9C,MAAM,QAAQ,GAAG,CAAC,SAAS,CAAC,CAAA;QAE5B,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,aAAa,CAAC,CAAA;QAElC,MAAM,OAAO,GAAG;YACd,kBAAkB,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE;YAC9C,uBAAuB,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE;SACzD,CAAA;QAED,MAAM,aAAa,GAAG;YACpB,GAAG,EAAE,QAAQ;YACb,UAAU,EAAE;gBACV,UAAU,EAAE,KAAK;gBACjB,KAAK,EAAE,QAAQ;aAChB;YACD,GAAG,EAAE,OAAO;SACb,CAAA;QAED,SAAE,CAAC,MAAM,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAA;QACpD,MAAM,YAAY,GAAG,IAAA,yBAAkB,GAAE,CAAA;QACzC,MAAM,WAAW,GAAG,IAAA,yBAAkB,GAAE,CAAA;QACxC,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,QAAQ,CACnC,KAAK,EACL,aAAa,EACb,YAAY,EACZ,WAAW,CACZ,CAAA;QACD,SAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAA;QAChB,IAAI,CAAC,OAAO,EAAE;YACZ,aAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;SACf;IACH,CAAC;;AAtFH,0BAuFC;AAtFQ,mBAAW,GAAG,6CAA6C,CAAC;AAE5D,aAAK,GAAG;IACb,GAAG,WAAI,CAAC,KAAK;IACb,IAAI,EAAE,YAAK,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,GAAG,EAAC,CAAC;IAC7B,KAAK,EAAE,YAAK,CAAC,MAAM,CAAC;QAClB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,cAAc;KAC5B,CAAC;IACF,WAAW,EAAE,YAAK,CAAC,OAAO,CAAC;QACzB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,yBAAyB;KACvC,CAAC;IACF,SAAS,EAAE,YAAK,CAAC,MAAM,CAAC;QACtB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,4BAA4B;QACzC,OAAO,EAAE,IAAI;KACd,CAAC;CACH,CAAC"}

package/lib/commands/description/connector.d.ts

@@ -0,0 +1,11 @@
+import { Base } from '@sw-tsdk/core';
+export declare class Connector extends Base {
+    static description: string;
+    static flags: {
+        help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
+        image: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        'skip-pull': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        directory: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/lib/commands/description/connector.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Connector = void 0;
+const core_1 = require("@oclif/core");
+const node_path_1 = require("node:path");
+const docker_1 = require("@sw-tsdk/docker");
+const core_2 = require("@oclif/core");
+const node_fs_1 = require("node:fs");
+const core_3 = require("@sw-tsdk/core");
+// noinspection JSUnusedGlobalSymbols
+class Connector extends core_3.Base {
+    async run() {
+        const { flags } = await this.parse(Connector);
+        const { 'skip-pull': skipPull, } = flags;
+        let { image } = flags;
+        let { directory } = flags;
+        directory = (0, node_path_1.resolve)(directory);
+        const typeOfContent = 'connector';
+        if (!image) {
+            image = `${docker_1.DockerDefaults.SdkTurbineContentDescriptionImage}`;
+        }
+        try {
+            await node_fs_1.promises.access(directory);
+        }
+        catch {
+            this.error(`Could not access ${directory}`);
+        }
+        const docker = new docker_1.Docker();
+        core_2.ux.action.start('Checking for docker...');
+        await docker.ping();
+        core_2.ux.action.stop();
+        if (!skipPull) {
+            core_2.ux.action.start(`Pulling image (${image})...`);
+            await docker.pullImage(image);
+            core_2.ux.action.stop();
+        }
+        const bindings = [`${directory}:/app/content`];
+        const commands = ['main.py'];
+        commands.push('-t', typeOfContent);
+        const envVars = [
+            `OPENAI_API_KEY=${process.env.OPENAI_API_KEY}`,
+            `OPENAI_ORGANIZATION=${process.env.OPENAI_ORGANIZATION}`,
+        ];
+        const createOptions = {
+            Cmd: commands,
+            HostConfig: {
+                AutoRemove: false,
+                Binds: bindings,
+            },
+            Env: envVars,
+        };
+        core_2.ux.action.start('Generating Connector Description...');
+        const outputStream = (0, core_3.writableNoopStream)();
+        const errorStream = (0, core_3.writableNoopStream)();
+        const success = await docker.runImage(image, createOptions, outputStream, errorStream);
+        core_2.ux.action.stop();
+        if (!success) {
+            core_2.Errors.exit(1);
+        }
+    }
+}
+exports.Connector = Connector;
+Connector.description = 'Use to generate connector descriptions';
+Connector.flags = {
+    ...core_3.Base.flags,
+    help: core_1.Flags.help({ char: 'h' }),
+    image: core_1.Flags.string({
+        char: 'i',
+        description: 'image to use',
+    }),
+    'skip-pull': core_1.Flags.boolean({
+        char: 's',
+        description: 'skips pulling the image',
+    }),
+    directory: core_1.Flags.string({
+        char: 'd',
+        description: 'current directory to mount',
+        default: './',
+    }),
+};
+//# sourceMappingURL=connector.js.map

package/lib/commands/description/connector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"connector.js","sourceRoot":"","sources":["../../../src/commands/description/connector.ts"],"names":[],"mappings":";;;AAAA,sCAAiC;AACjC,yCAAiC;AACjC,4CAAsD;AACtD,sCAAsC;AACtC,qCAAgC;AAChC,wCAAsD;AAEtD,qCAAqC;AACrC,MAAa,SAAU,SAAQ,WAAI;IAqBjC,KAAK,CAAC,GAAG;QACP,MAAM,EAAC,KAAK,EAAC,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;QAC3C,MAAM,EACJ,WAAW,EAAE,QAAQ,GACtB,GAAG,KAAK,CAAA;QACT,IAAI,EAAC,KAAK,EAAC,GAAG,KAAK,CAAA;QAEnB,IAAI,EAAC,SAAS,EAAC,GAAG,KAAK,CAAA;QACvB,SAAS,GAAG,IAAA,mBAAO,EAAC,SAAS,CAAC,CAAA;QAE9B,MAAM,aAAa,GAAG,WAAW,CAAA;QACjC,IAAI,CAAC,KAAK,EAAE;YACV,KAAK,GAAG,GAAG,uBAAc,CAAC,iCAAiC,EAAE,CAAA;SAC9D;QAED,IAAI;YACF,MAAM,kBAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;SACjC;QAAC,MAAM;YACN,IAAI,CAAC,KAAK,CAAC,oBAAoB,SAAS,EAAE,CAAC,CAAA;SAC5C;QAED,MAAM,MAAM,GAAG,IAAI,eAAM,EAAE,CAAA;QAC3B,SAAE,CAAC,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAA;QACzC,MAAM,MAAM,CAAC,IAAI,EAAE,CAAA;QACnB,SAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAA;QAEhB,IAAI,CAAC,QAAQ,EAAE;YACb,SAAE,CAAC,MAAM,CAAC,KAAK,CAAC,kBAAkB,KAAK,MAAM,CAAC,CAAA;YAE9C,MAAM,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;YAC7B,SAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAA;SACjB;QAED,MAAM,QAAQ,GAAG,CAAC,GAAG,SAAS,eAAe,CAAC,CAAA;QAC9C,MAAM,QAAQ,GAAG,CAAC,SAAS,CAAC,CAAA;QAE5B,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,aAAa,CAAC,CAAA;QAElC,MAAM,OAAO,GAAG;YACd,kBAAkB,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE;YAC9C,uBAAuB,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE;SACzD,CAAA;QAED,MAAM,aAAa,GAAG;YACpB,GAAG,EAAE,QAAQ;YACb,UAAU,EAAE;gBACV,UAAU,EAAE,KAAK;gBACjB,KAAK,EAAE,QAAQ;aAChB;YACD,GAAG,EAAE,OAAO;SACb,CAAA;QAED,SAAE,CAAC,MAAM,CAAC,KAAK,CAAC,qCAAqC,CAAC,CAAA;QACtD,MAAM,YAAY,GAAG,IAAA,yBAAkB,GAAE,CAAA;QACzC,MAAM,WAAW,GAAG,IAAA,yBAAkB,GAAE,CAAA;QACxC,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,QAAQ,CACnC,KAAK,EACL,aAAa,EACb,YAAY,EACZ,WAAW,CACZ,CAAA;QACD,SAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAA;QAChB,IAAI,CAAC,OAAO,EAAE;YACZ,aAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;SACf;IACH,CAAC;;AAtFH,8BAuFC;AAtFQ,qBAAW,GAAG,wCAAwC,CAAC;AAEvD,eAAK,GAAG;IACb,GAAG,WAAI,CAAC,KAAK;IACb,IAAI,EAAE,YAAK,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,GAAG,EAAC,CAAC;IAC7B,KAAK,EAAE,YAAK,CAAC,MAAM,CAAC;QAClB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,cAAc;KAC5B,CAAC;IACF,WAAW,EAAE,YAAK,CAAC,OAAO,CAAC;QACzB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,yBAAyB;KACvC,CAAC;IACF,SAAS,EAAE,YAAK,CAAC,MAAM,CAAC;QACtB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,4BAA4B;QACzC,OAAO,EAAE,IAAI;KACd,CAAC;CACH,CAAC"}

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.18.0",
+  "version": "2.19.0",
   "commands": {
     "action:add": {
       "id": "action:add",
@@ -757,6 +757,136 @@
       },
       "args": {}
     },
+    "description:action": {
+      "id": "description:action",
+      "description": "Use to generate action description",
+      "strict": true,
+      "pluginName": "@sw-tsdk/plugin-connector",
+      "pluginAlias": "@sw-tsdk/plugin-connector",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {
+        "help": {
+          "name": "help",
+          "type": "boolean",
+          "char": "h",
+          "description": "Show CLI help.",
+          "allowNo": false
+        },
+        "image": {
+          "name": "image",
+          "type": "option",
+          "char": "i",
+          "description": "image to use",
+          "multiple": false
+        },
+        "skip-pull": {
+          "name": "skip-pull",
+          "type": "boolean",
+          "char": "s",
+          "description": "skips pulling the image",
+          "allowNo": false
+        },
+        "directory": {
+          "name": "directory",
+          "type": "option",
+          "char": "d",
+          "description": "current directory to mount",
+          "multiple": false,
+          "default": "./"
+        },
+        "action": {
+          "name": "action",
+          "type": "option",
+          "char": "a",
+          "description": "Generate description for specific action",
+          "multiple": false
+        }
+      },
+      "args": {}
+    },
+    "description:actions": {
+      "id": "description:actions",
+      "description": "Use to generate description for all actions",
+      "strict": true,
+      "pluginName": "@sw-tsdk/plugin-connector",
+      "pluginAlias": "@sw-tsdk/plugin-connector",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {
+        "help": {
+          "name": "help",
+          "type": "boolean",
+          "char": "h",
+          "description": "Show CLI help.",
+          "allowNo": false
+        },
+        "image": {
+          "name": "image",
+          "type": "option",
+          "char": "i",
+          "description": "image to use",
+          "multiple": false
+        },
+        "skip-pull": {
+          "name": "skip-pull",
+          "type": "boolean",
+          "char": "s",
+          "description": "skips pulling the image",
+          "allowNo": false
+        },
+        "directory": {
+          "name": "directory",
+          "type": "option",
+          "char": "d",
+          "description": "current directory to mount",
+          "multiple": false,
+          "default": "./"
+        }
+      },
+      "args": {}
+    },
+    "description:connector": {
+      "id": "description:connector",
+      "description": "Use to generate connector descriptions",
+      "strict": true,
+      "pluginName": "@sw-tsdk/plugin-connector",
+      "pluginAlias": "@sw-tsdk/plugin-connector",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {
+        "help": {
+          "name": "help",
+          "type": "boolean",
+          "char": "h",
+          "description": "Show CLI help.",
+          "allowNo": false
+        },
+        "image": {
+          "name": "image",
+          "type": "option",
+          "char": "i",
+          "description": "image to use",
+          "multiple": false
+        },
+        "skip-pull": {
+          "name": "skip-pull",
+          "type": "boolean",
+          "char": "s",
+          "description": "skips pulling the image",
+          "allowNo": false
+        },
+        "directory": {
+          "name": "directory",
+          "type": "option",
+          "char": "d",
+          "description": "current directory to mount",
+          "multiple": false,
+          "default": "./"
+        }
+      },
+      "args": {}
+    },
     "action:generate:data": {
       "id": "action:generate:data",
       "description": "Use to test a task in an integration",

package/package.json

@@ -6,10 +6,10 @@
   "dependencies": {
     "@apidevtools/json-schema-ref-parser": "10.1.0",
     "@oclif/core": "2.8.5",
-    "@sw-tsdk/common": "^2.18.0",
-    "@sw-tsdk/connector": "^2.18.0",
-    "@sw-tsdk/core": "^2.18.0",
-    "@sw-tsdk/docker": "^2.18.0",
+    "@sw-tsdk/common": "^2.19.0",
+    "@sw-tsdk/connector": "^2.19.0",
+    "@sw-tsdk/core": "^2.19.0",
+    "@sw-tsdk/docker": "^2.19.0",
     "@swimlane/connector-interfaces": "1.11.0",
     "@swimlane/cosign": "1.4.1",
     "@swimlane/docker-reference": "2.0.1",
@@ -67,6 +67,12 @@
       },
       "connectors": {
         "description": "Local connectors commands"
+      },
+      "component": {
+        "description": "Local component commands"
+      },
+      "description": {
+        "description": "Local description commands"
       }
     }
   },
@@ -89,6 +95,6 @@
     "posttest": "yarn lint",
     "dev:setup": "npm link"
   },
-  "version": "2.18.0",
-  "gitHead": "e6a84357aa223deda77b786a7633c63b0d9c7158"
+  "version": "2.19.0",
+  "gitHead": "bc3713cc4df54c48dff7e8bf2444cc0cfb1cb7e7"
 }