@sw-tsdk/plugin-connector 2.17.4 → 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.17.4 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
@@ -31,6 +31,10 @@ USAGE
 * [`sw-tsdk-connector action:generate:output`](#sw-tsdk-connector-actiongenerateoutput)
 * [`sw-tsdk-connector action:run:local`](#sw-tsdk-connector-actionrunlocal)
 * [`sw-tsdk-connector asset:add`](#sw-tsdk-connector-assetadd)
+* [`sw-tsdk-connector component:create`](#sw-tsdk-connector-componentcreate)
+* [`sw-tsdk-connector component:logo`](#sw-tsdk-connector-componentlogo)
+* [`sw-tsdk-connector component:ssp`](#sw-tsdk-connector-componentssp)
+* [`sw-tsdk-connector component:update`](#sw-tsdk-connector-componentupdate)
 * [`sw-tsdk-connector connector:build`](#sw-tsdk-connector-connectorbuild)
 * [`sw-tsdk-connector connector:create`](#sw-tsdk-connector-connectorcreate)
 * [`sw-tsdk-connector connector:create:openapi`](#sw-tsdk-connector-connectorcreateopenapi)
@@ -39,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`
 
@@ -58,7 +65,7 @@ DESCRIPTION
   Update a connector action.
 ```
 
-_See code: [lib/commands/action/add.js](https://github.com/swimlane/turbine-sdk/blob/v2.17.4/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`
 
@@ -83,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.17.4/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`
 
@@ -108,7 +115,7 @@ DESCRIPTION
   Update action input schema.
 ```
 
-_See code: [lib/commands/action/generate/input.js](https://github.com/swimlane/turbine-sdk/blob/v2.17.4/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`
 
@@ -132,7 +139,7 @@ DESCRIPTION
   Update a connector action.
 ```
 
-_See code: [lib/commands/action/generate/output.js](https://github.com/swimlane/turbine-sdk/blob/v2.17.4/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`
 
@@ -161,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.17.4/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`
 
@@ -182,7 +189,101 @@ DESCRIPTION
   Update a connector action.
 ```
 
-_See code: [lib/commands/asset/add.js](https://github.com/swimlane/turbine-sdk/blob/v2.17.4/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`
+
+Scaffold a new Component
+
+```
+USAGE
+  $ sw-tsdk-connector component:create [-d <value>] [--componentType <value>] [--vendor <value>] [--componentName
+    <value>] [--keywords <value>] [--description <value>] [--logoPath <value>] [--sspPath <value>] [--author <value>]
+    [--authorEmail <value>] [--homepage <value>] [-h]
+
+FLAGS
+  -d, --directory=<value>  [default: ./] root directory for where to store Component.
+  -h, --help               Show CLI help.
+  --author=<value>         Component Author
+  --authorEmail=<value>    Component Author Email
+  --componentName=<value>  Component Name (e.g. Alert Ingestion)
+  --componentType=<value>  Component Type (e.g. classic)
+  --description=<value>    Description (e.g. CrowdStrike Alert Ingestion Component)
+  --homepage=<value>       Component Author Support URL
+  --keywords=<value>       Enter keywords
+  --logoPath=<value>       URL or absolute path to logo file
+  --sspPath=<value>        absolute path to .ssp file
+  --vendor=<value>         Vendor (e.g. CrowdStrike)
+
+DESCRIPTION
+  Scaffold a new Component
+```
+
+_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`
+
+Update a Component logo.
+
+```
+USAGE
+  $ sw-tsdk-connector component:logo [-d <value>] [-t <value>] [-n <value>] [-p <value>] [-h]
+
+FLAGS
+  -d, --directory=<value>      [default: ./] root directory of the component folder.
+  -h, --help                   Show CLI help.
+  -n, --componentName=<value>  Component Name (e.g. google_alert_ingestion)
+  -p, --logoPath=<value>       path or URL to product logo in PNG format.
+  -t, --componentType=<value>  Component Type (e.g. classic)
+
+DESCRIPTION
+  Update a Component logo.
+```
+
+_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`
+
+Update an SSP.
+
+```
+USAGE
+  $ sw-tsdk-connector component:ssp [-d <value>] [-t <value>] [-n <value>] [-p <value>] [-h]
+
+FLAGS
+  -d, --directory=<value>      [default: ./] root directory of the component folder.
+  -h, --help                   Show CLI help.
+  -n, --componentName=<value>  Component Name (e.g. google_alert_ingestion)
+  -p, --sspPath=<value>        Absolute path to .SSP file
+  -t, --componentType=<value>  Component Type (e.g. classic)
+
+DESCRIPTION
+  Update an SSP.
+```
+
+_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`
+
+Update Component Version.
+
+```
+USAGE
+  $ sw-tsdk-connector component:update [-d <value>] [-v <value>] [-t <value>] [-n <value>] [-f <value>] [-h]
+
+FLAGS
+  -d, --directory=<value>      [default: .] root directory of the all Components
+  -f, --manifestPath=<value>   [default: manifest.yml] Component manifest path relative to directory.
+  -h, --help                   Show CLI help.
+  -n, --componentName=<value>  Component Name (e.g. google_alert_ingestion)
+  -t, --componentType=<value>  Component Type (e.g. classic)
+  -v, --version=<value>        new version of the component.
+
+DESCRIPTION
+  Update Component Version.
+```
+
+_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`
 
@@ -212,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.17.4/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`
 
@@ -244,7 +345,7 @@ DESCRIPTION
   Scaffold a new connector
 ```
 
-_See code: [lib/commands/connector/create.js](https://github.com/swimlane/turbine-sdk/blob/v2.17.4/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`
 
@@ -273,7 +374,7 @@ DESCRIPTION
   Scaffold a new connector
 ```
 
-_See code: [lib/commands/connector/create/openapi.js](https://github.com/swimlane/turbine-sdk/blob/v2.17.4/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`
 
@@ -291,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.17.4/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`
 
@@ -310,7 +411,7 @@ DESCRIPTION
   Update a connector.
 ```
 
-_See code: [lib/commands/connector/logo.js](https://github.com/swimlane/turbine-sdk/blob/v2.17.4/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`
 
@@ -335,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.17.4/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`
 
@@ -355,7 +456,7 @@ DESCRIPTION
   Update a connector.
 ```
 
-_See code: [lib/commands/connector/update.js](https://github.com/swimlane/turbine-sdk/blob/v2.17.4/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`
 
@@ -378,5 +479,66 @@ DESCRIPTION
   Use to validate an integration
 ```
 
-_See code: [lib/commands/connector/validate.js](https://github.com/swimlane/turbine-sdk/blob/v2.17.4/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/component/create.d.ts

@@ -0,0 +1,34 @@
+import { Base } from '@sw-tsdk/core';
+export interface ComponentManifest {
+    schema: string;
+    componentType: string;
+    vendor: string;
+    name: string;
+    author: string;
+    bugs: string;
+    iconImage: string;
+    description: string;
+    homepage: string;
+    license: string;
+    title: string;
+    version: string;
+    keywords: string[];
+}
+export declare class Create extends Base {
+    static description: string;
+    static flags: {
+        directory: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        componentType: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        vendor: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        componentName: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        keywords: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        description: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        logoPath: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        sspPath: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        author: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        authorEmail: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        homepage: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
+    };
+    run(): Promise<void>;
+}

package/lib/commands/component/create.js

@@ -0,0 +1,168 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Create = void 0;
+const tslib_1 = require("tslib");
+const core_1 = require("@oclif/core");
+const connector_1 = require("@sw-tsdk/connector");
+const core_2 = require("@sw-tsdk/core");
+const fs_extra_1 = require("fs-extra");
+const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
+const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
+const fs = tslib_1.__importStar(require("node:fs"));
+const node_fs_1 = require("node:fs");
+const path = tslib_1.__importStar(require("node:path"));
+const node_path_1 = require("node:path");
+const snake_case_1 = require("snake-case");
+const common_1 = require("../../common");
+// noinspection JSUnusedGlobalSymbols
+class Create extends core_2.Base {
+    async run() {
+        const { flags } = await this.parse(Create);
+        let { directory } = flags;
+        directory = (0, node_path_1.resolve)(directory || process.cwd());
+        try {
+            await node_fs_1.promises.access(directory);
+        }
+        catch {
+            this.error(`Could not access ${directory}`);
+        }
+        const masterQuestions = [{
+                type: 'list',
+                name: 'componentType',
+                message: 'Choose Component Type',
+                choices: common_1.contentCategories,
+            },
+            {
+                type: 'input',
+                name: 'vendor',
+                message: 'Vendor (e.g. CrowdStrike)',
+            },
+            {
+                type: 'input',
+                name: 'componentName',
+                message: 'Component Name (e.g. Alert Ingestion)',
+            },
+            {
+                type: 'input',
+                name: 'description',
+                message: 'Description (e.g. CrowdStrike Alert Ingestion Component)',
+            },
+            {
+                type: 'list',
+                name: 'keywords',
+                message: 'Choose a category (Comma-separated)',
+                choices: common_1.connectorCategories,
+            },
+            {
+                type: 'input',
+                name: 'logoPath',
+                message: 'URL or absolute path to logo file',
+            },
+            {
+                type: 'input',
+                name: 'sspPath',
+                message: 'Absolute path to .ssp file',
+            },
+            {
+                type: 'input',
+                name: 'author',
+                message: 'Integration Author',
+                default: 'Swimlane',
+            },
+            {
+                type: 'input',
+                name: 'authorEmail',
+                message: 'Integration Author Email',
+                default: 'info@swimlane.com',
+            },
+            {
+                type: 'input',
+                name: 'homepage',
+                message: 'Author URL',
+                default: 'https://swimlane.com',
+            }];
+        const filteredQuestions = masterQuestions.filter(q => !flags[q.name]);
+        const answers = Object.assign(await inquirer_1.default.prompt(filteredQuestions), flags);
+        const componentType = answers.componentType;
+        const errors = [];
+        if (!answers.vendor) {
+            errors.push('Vendor Field is required.');
+        }
+        if (!answers.componentName) {
+            errors.push('Component Name  is required.');
+        }
+        const name = (0, snake_case_1.snakeCase)(`${answers.vendor} ${answers.componentName}`.toLocaleLowerCase());
+        const componentDirectory = (0, node_path_1.join)(directory, componentType, `${name}`);
+        await (0, fs_extra_1.ensureDir)(componentDirectory);
+        const component = {
+            vendor: answers.vendor,
+            name: name,
+            schema: 'component/1',
+            author: answers.author,
+            bugs: '',
+            iconImage: '../image/logo.png',
+            description: answers.description,
+            homepage: answers.homepage,
+            license: 'AGPL-3.0',
+            title: await (0, connector_1.titleCaseString)(`${answers.vendor} ${answers.componentName}`),
+            version: '0.0.0',
+            componentType: componentType,
+            keywords: answers.keywords.split(',').map(x => x.trim()),
+        };
+        core_1.ux.action.start('Generating folder structure.');
+        if (answers.logoPath?.endsWith('.png') || answers.logoPath?.endsWith('.jpg') || answers.logoPath?.endsWith('.jpeg')) {
+            core_1.ux.action.start('Processing Logo');
+            await (0, connector_1.updateImage)(componentDirectory, answers.logoPath);
+            core_1.ux.action.stop();
+        }
+        else {
+            core_1.ux.action.stop();
+            errors.push('Invalid logo file provided');
+        }
+        if (answers.sspPath?.endsWith('.ssp')) {
+            core_1.ux.action.start('Processing SSP File');
+            const destinationPath = path.join(componentDirectory, `${name}.ssp`);
+            await fs.promises.copyFile(answers.sspPath, destinationPath);
+            core_1.ux.action.stop();
+        }
+        else {
+            errors.push('Invalid ssp file provided');
+        }
+        if (errors.length > 0) {
+            core_1.ux.action.stop();
+            return this.error(errors.join('\n'));
+        }
+        const manifestFilePath = (0, node_path_1.join)(componentDirectory, 'manifest.yml');
+        await (0, fs_extra_1.writeFile)(manifestFilePath, js_yaml_1.default.dump(component, {
+            indent: 2,
+            noRefs: true,
+        }));
+        await (0, fs_extra_1.writeFile)((0, node_path_1.join)(componentDirectory, 'external.yml'), '', 'utf8');
+        await (0, fs_extra_1.writeFile)((0, node_path_1.join)(componentDirectory, 'README.md'), 'Description will be updated shortly.', 'utf8');
+        await (0, fs_extra_1.writeFile)((0, node_path_1.join)(componentDirectory, 'EXTERNAL_README.md'), 'Description will be updated shortly.', 'utf8');
+        await (0, fs_extra_1.writeFile)((0, node_path_1.join)(componentDirectory, 'documentation.README.md'), 'Description will be updated shortly.', 'utf8');
+        core_1.ux.action.stop();
+    }
+}
+exports.Create = Create;
+Create.description = 'Scaffold a new Component';
+Create.flags = {
+    ...core_2.Base.flags,
+    directory: core_1.Flags.string({
+        char: 'd',
+        description: 'root directory for where to store Component.',
+        default: './',
+    }),
+    componentType: core_1.Flags.string({ description: 'Component Type (e.g. classic)' }),
+    vendor: core_1.Flags.string({ description: 'Vendor (e.g. CrowdStrike)' }),
+    componentName: core_1.Flags.string({ description: 'Component Name (e.g. Alert Ingestion)' }),
+    keywords: core_1.Flags.string({ description: 'Enter keywords' }),
+    description: core_1.Flags.string({ description: 'Description (e.g. CrowdStrike Alert Ingestion Component)' }),
+    logoPath: core_1.Flags.string({ description: 'URL or absolute path to logo file' }),
+    sspPath: core_1.Flags.string({ description: 'absolute path to .ssp file' }),
+    author: core_1.Flags.string({ description: 'Component Author' }),
+    authorEmail: core_1.Flags.string({ description: 'Component Author Email' }),
+    homepage: core_1.Flags.string({ description: 'Component Author Support URL' }),
+    help: core_1.Flags.help({ char: 'h' }),
+};
+//# sourceMappingURL=create.js.map

package/lib/commands/component/create.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create.js","sourceRoot":"","sources":["../../../src/commands/component/create.ts"],"names":[],"mappings":";;;;AAAA,sCAAqC;AACrC,kDAA+D;AAC/D,wCAAkC;AAClC,uCAA6C;AAC7C,gEAA+B;AAC/B,8DAA0B;AAC1B,oDAA6B;AAC7B,qCAAgC;AAChC,wDAAiC;AACjC,yCAAuC;AACvC,2CAAoC;AACpC,yCAAmE;AAkBnE,qCAAqC;AACrC,MAAa,MAAO,SAAQ,WAAI;IAuB9B,KAAK,CAAC,GAAG;QACP,MAAM,EAAC,KAAK,EAAC,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;QAExC,IAAI,EAAC,SAAS,EAAC,GAAG,KAAK,CAAA;QACvB,SAAS,GAAG,IAAA,mBAAO,EAAC,SAAS,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC,CAAA;QAE/C,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,eAAe,GAAG,CAAC;gBACvB,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,eAAe;gBACrB,OAAO,EAAE,uBAAuB;gBAChC,OAAO,EAAE,0BAAiB;aAC3B;YACD;gBACE,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,2BAA2B;aACrC;YACD;gBACE,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,eAAe;gBACrB,OAAO,EAAE,uCAAuC;aACjD;YACD;gBACE,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,aAAa;gBACnB,OAAO,EAAE,0DAA0D;aACpE;YACD;gBACE,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,UAAU;gBAChB,OAAO,EAAE,qCAAqC;gBAC9C,OAAO,EAAE,4BAAmB;aAC7B;YACD;gBACE,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,UAAU;gBAChB,OAAO,EAAE,mCAAmC;aAC7C;YACD;gBACE,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,4BAA4B;aACtC;YACD;gBACE,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,oBAAoB;gBAC7B,OAAO,EAAE,UAAU;aACpB;YACD;gBACE,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,aAAa;gBACnB,OAAO,EAAE,0BAA0B;gBACnC,OAAO,EAAE,mBAAmB;aAC7B;YACD;gBACE,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,UAAU;gBAChB,OAAO,EAAE,YAAY;gBACrB,OAAO,EAAE,sBAAsB;aAChC,CAAC,CAAA;QACF,MAAM,iBAAiB,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAE,KAA6B,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;QAC9F,MAAM,OAAO,GAAuB,MAAM,CAAC,MAAM,CAAC,MAAM,kBAAQ,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,KAAK,CAAC,CAAA;QAClG,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,CAAA;QAE3C,MAAM,MAAM,GAAa,EAAE,CAAA;QAE3B,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;YACnB,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAA;SACzC;QAED,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE;YAC1B,MAAM,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAA;SAC5C;QAED,MAAM,IAAI,GAAW,IAAA,sBAAS,EAAC,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC,iBAAiB,EAAE,CAAC,CAAA;QAEhG,MAAM,kBAAkB,GAAG,IAAA,gBAAI,EAAC,SAAS,EAAE,aAAa,EAAE,GAAG,IAAI,EAAE,CAAC,CAAA;QACpE,MAAM,IAAA,oBAAS,EAAC,kBAAkB,CAAC,CAAA;QAEnC,MAAM,SAAS,GAAsB;YACnC,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,aAAa;YACrB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,IAAI,EAAE,EAAE;YACR,SAAS,EAAE,mBAAmB;YAC9B,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,MAAM,IAAA,2BAAe,EAAC,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;YAC1E,OAAO,EAAE,OAAO;YAChB,aAAa,EAAE,aAAa;YAC5B,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;SACzD,CAAA;QAED,SAAE,CAAC,MAAM,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAA;QAE/C,IAAI,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,EAAE;YACnH,SAAE,CAAC,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAA;YAClC,MAAM,IAAA,uBAAW,EAAC,kBAAkB,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;YACvD,SAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAA;SACjB;aAAM;YACL,SAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAA;YAChB,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAA;SAC1C;QAED,IAAI,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAE;YACrC,SAAE,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAA;YAEtC,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,GAAG,IAAI,MAAM,CAAC,CAAA;YACpE,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,eAAe,CAAC,CAAA;YAC5D,SAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAA;SACjB;aAAM;YACL,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAA;SACzC;QAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;YACrB,SAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAA;YAChB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;SACrC;QAED,MAAM,gBAAgB,GAAG,IAAA,gBAAI,EAAC,kBAAkB,EAAE,cAAc,CAAC,CAAA;QACjE,MAAM,IAAA,oBAAS,EAAC,gBAAgB,EAAE,iBAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACrD,MAAM,EAAE,CAAC;YACT,MAAM,EAAE,IAAI;SACb,CAAC,CAAC,CAAA;QACH,MAAM,IAAA,oBAAS,EAAC,IAAA,gBAAI,EAAC,kBAAkB,EAAE,cAAc,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,CAAA;QACrE,MAAM,IAAA,oBAAS,EAAC,IAAA,gBAAI,EAAC,kBAAkB,EAAE,WAAW,CAAC,EAAE,sCAAsC,EAAE,MAAM,CAAC,CAAA;QACtG,MAAM,IAAA,oBAAS,EAAC,IAAA,gBAAI,EAAC,kBAAkB,EAAE,oBAAoB,CAAC,EAAE,sCAAsC,EAAE,MAAM,CAAC,CAAA;QAC/G,MAAM,IAAA,oBAAS,EAAC,IAAA,gBAAI,EAAC,kBAAkB,EAAE,yBAAyB,CAAC,EAAE,sCAAsC,EAAE,MAAM,CAAC,CAAA;QAEpH,SAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAA;IAClB,CAAC;;AAlKH,wBAmKC;AAlKQ,kBAAW,GAAG,0BAA0B,CAAA;AAExC,YAAK,GAAG;IACb,GAAG,WAAI,CAAC,KAAK;IACb,SAAS,EAAE,YAAK,CAAC,MAAM,CAAC;QACtB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,8CAA8C;QAC3D,OAAO,EAAE,IAAI;KACd,CAAC;IACF,aAAa,EAAE,YAAK,CAAC,MAAM,CAAC,EAAC,WAAW,EAAE,+BAA+B,EAAC,CAAC;IAC3E,MAAM,EAAE,YAAK,CAAC,MAAM,CAAC,EAAC,WAAW,EAAE,2BAA2B,EAAC,CAAC;IAChE,aAAa,EAAE,YAAK,CAAC,MAAM,CAAC,EAAC,WAAW,EAAE,uCAAuC,EAAC,CAAC;IACnF,QAAQ,EAAE,YAAK,CAAC,MAAM,CAAC,EAAC,WAAW,EAAE,gBAAgB,EAAC,CAAC;IACvD,WAAW,EAAE,YAAK,CAAC,MAAM,CAAC,EAAC,WAAW,EAAE,0DAA0D,EAAC,CAAC;IACpG,QAAQ,EAAE,YAAK,CAAC,MAAM,CAAC,EAAC,WAAW,EAAE,mCAAmC,EAAC,CAAC;IAC1E,OAAO,EAAE,YAAK,CAAC,MAAM,CAAC,EAAC,WAAW,EAAE,4BAA4B,EAAC,CAAC;IAClE,MAAM,EAAE,YAAK,CAAC,MAAM,CAAC,EAAC,WAAW,EAAE,kBAAkB,EAAC,CAAC;IACvD,WAAW,EAAE,YAAK,CAAC,MAAM,CAAC,EAAC,WAAW,EAAE,wBAAwB,EAAC,CAAC;IAClE,QAAQ,EAAE,YAAK,CAAC,MAAM,CAAC,EAAC,WAAW,EAAE,8BAA8B,EAAC,CAAC;IACrE,IAAI,EAAE,YAAK,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,GAAG,EAAC,CAAC;CAC9B,CAAA"}

package/lib/commands/component/logo.d.ts

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

package/lib/commands/component/logo.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Logo = void 0;
+const tslib_1 = require("tslib");
+const core_1 = require("@oclif/core");
+const connector_1 = require("@sw-tsdk/connector");
+const core_2 = require("@sw-tsdk/core");
+const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
+const node_path_1 = require("node:path");
+const common_1 = require("../../common");
+// noinspection JSUnusedGlobalSymbols
+class Logo extends core_2.Base {
+    async run() {
+        const { flags } = await this.parse(Logo);
+        let { directory } = flags;
+        directory = (0, node_path_1.resolve)(directory || process.cwd());
+        const masterQuestions = [
+            {
+                type: 'input',
+                name: 'logoPath',
+                message: 'URL or absolute path to logo file',
+            },
+        ];
+        const componentTypeSelected = await (0, common_1.chooseComponentType)();
+        const componentNameSelected = await (0, common_1.chooseComponentName)(directory, componentTypeSelected);
+        const filteredQuestions = masterQuestions.filter(q => !flags[q.name]);
+        const answers = Object.assign(await inquirer_1.default.prompt(filteredQuestions), flags);
+        const componentDirectory = (0, node_path_1.join)(directory, componentTypeSelected, componentNameSelected);
+        if (answers.logoPath?.endsWith('.png') || answers.logoPath?.endsWith('.jpg') || answers.logoPath?.endsWith('.jpeg')) {
+            core_1.ux.action.start('Updating Logo');
+            await (0, connector_1.updateImage)(componentDirectory, answers.logoPath);
+            core_1.ux.action.stop();
+        }
+        else {
+            core_1.ux.action.stop();
+            this.error('Invalid logo file provided');
+        }
+    }
+}
+exports.Logo = Logo;
+Logo.description = 'Update a Component logo.';
+Logo.flags = {
+    ...core_2.Base.flags,
+    directory: core_1.Flags.string({
+        char: 'd',
+        description: 'root directory of the component folder.',
+        default: './',
+    }),
+    componentType: core_1.Flags.string({
+        description: 'Component Type (e.g. classic)',
+        char: 't',
+    }),
+    componentName: core_1.Flags.string({
+        description: 'Component Name (e.g. google_alert_ingestion)',
+        char: 'n',
+    }),
+    logoPath: core_1.Flags.string({
+        char: 'p',
+        description: 'path or URL to product logo in PNG format.',
+    }),
+    help: core_1.Flags.help({ char: 'h' }),
+};
+//# sourceMappingURL=logo.js.map

package/lib/commands/component/logo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logo.js","sourceRoot":"","sources":["../../../src/commands/component/logo.ts"],"names":[],"mappings":";;;;AAAA,sCAAqC;AACrC,kDAA8C;AAC9C,wCAAkC;AAClC,gEAA+B;AAC/B,yCAAuC;AAEvC,yCAAqE;AAGrE,qCAAqC;AACrC,MAAa,IAAK,SAAQ,WAAI;IAyB1B,KAAK,CAAC,GAAG;QACP,MAAM,EAAC,KAAK,EAAC,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QAEtC,IAAI,EAAC,SAAS,EAAC,GAAG,KAAK,CAAA;QACvB,SAAS,GAAG,IAAA,mBAAO,EAAC,SAAS,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC,CAAA;QAE/C,MAAM,eAAe,GAAG;YACtB;gBACE,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,UAAU;gBAChB,OAAO,EAAE,mCAAmC;aAC7C;SACF,CAAA;QAED,MAAM,qBAAqB,GAAG,MAAM,IAAA,4BAAmB,GAAE,CAAA;QACzD,MAAM,qBAAqB,GAAG,MAAM,IAAA,4BAAmB,EAAC,SAAS,EAAE,qBAAqB,CAAC,CAAA;QACzF,MAAM,iBAAiB,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAE,KAA6B,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;QAC9F,MAAM,OAAO,GAAsB,MAAM,CAAC,MAAM,CAAC,MAAM,kBAAQ,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,KAAK,CAAC,CAAA;QAEjG,MAAM,kBAAkB,GAAG,IAAA,gBAAI,EAAC,SAAS,EAAE,qBAAqB,EAAE,qBAAqB,CAAC,CAAA;QAExF,IAAI,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,EAAE;YACnH,SAAE,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAA;YAChC,MAAM,IAAA,uBAAW,EAAC,kBAAkB,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;YACvD,SAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAA;SACjB;aAAM;YACL,SAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAA;YAChB,IAAI,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAA;SACzC;IACH,CAAC;;AAtDL,oBAuDC;AAtDU,gBAAW,GAAG,0BAA0B,CAAA;AAExC,UAAK,GAAG;IACb,GAAG,WAAI,CAAC,KAAK;IACb,SAAS,EAAE,YAAK,CAAC,MAAM,CAAC;QACtB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,yCAAyC;QACtD,OAAO,EAAE,IAAI;KACd,CAAC;IACF,aAAa,EAAE,YAAK,CAAC,MAAM,CAAC;QAC1B,WAAW,EAAE,+BAA+B;QAC5C,IAAI,EAAE,GAAG;KACV,CAAC;IACF,aAAa,EAAE,YAAK,CAAC,MAAM,CAAC;QAC1B,WAAW,EAAE,8CAA8C;QAC3D,IAAI,EAAE,GAAG;KACV,CAAC;IACF,QAAQ,EAAE,YAAK,CAAC,MAAM,CAAC;QACrB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,4CAA4C;KAC1D,CAAC;IACF,IAAI,EAAE,YAAK,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,GAAG,EAAC,CAAC;CAC9B,CAAA"}

package/lib/commands/component/ssp.d.ts

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