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

package/lib/templates/python_310_definition/template/docs/README.md

@@ -0,0 +1,38 @@
+## Overview
+
+A brief description goes here. Be sure to provide an overview of what the plugin does. Include description of the
+product being integrated, plus use cases/value prop of the Swimlane integration.
+
+## Prerequisites
+
+Prerequisites, everything outside of the plugin itself. This should include info on how to
+configure the device (API Key, Perms, ect)
+
+## Capabilities
+
+This plugin provides the following capabilities:
+
+* Capabilities
+* Go
+* Here
+* e.g. Manage Firewall Policies instead of listing each individual tasks
+
+### Limitations
+
+Include information about known limitations here, including supported or minimum versions, especially
+known unsupported versions.
+
+## Asset Setup
+
+The content here should discuss asset setup in a conversational manner. Be sure to include any known login
+ and test connection errors.
+
+## Tasks Setup
+Special task setup as needed depending on plugin, exclude if empty.
+
+Known available allowed input options from enum type selection
+
+## Notes
+
+* Any other notes not fitting other sections go here.
+* Any reference URLs to external docs or other resources

package/lib/types/connector-types.d.ts

@@ -0,0 +1,29 @@
+import { ConnectorManifest } from '@swimlane/connector-interfaces';
+export interface enhancedConnectorManifest extends ConnectorManifest {
+    meta: {
+        imageRepository: string;
+    };
+}
+export declare type ConnectorQuestions = {
+    vendor: string;
+    product: string;
+    family: string;
+    description: string;
+    logoPath?: string;
+    template: string;
+    author: string;
+    authorEmail: string;
+    homepage: string;
+};
+export declare type ActionQuestions = {
+    title: string;
+    method?: string;
+    endpoint?: string;
+    description: string;
+};
+export declare const repoBaseTemplateMap: {
+    [index: string]: any;
+};
+export declare const codacyBaseRepoMap: {
+    [index: string]: any;
+};

package/lib/types/connector-types.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.codacyBaseRepoMap = exports.repoBaseTemplateMap = void 0;
+exports.repoBaseTemplateMap = {
+    'python_3.7_swimlane': 'connector-python-template',
+    python_310_definition: 'connector-python-definition-template',
+    node_18: 'connector-node-template',
+};
+exports.codacyBaseRepoMap = {
+    'python_3.7_swimlane': 'python_connectors',
+    python_310_definition: 'python_connectors',
+    node_18: '',
+};
+//# sourceMappingURL=connector-types.js.map

package/lib/types/connector-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"connector-types.js","sourceRoot":"","sources":["../../src/types/connector-types.ts"],"names":[],"mappings":";;;AA4Ba,QAAA,mBAAmB,GAA0B;IACxD,qBAAqB,EAAE,2BAA2B;IAClD,qBAAqB,EAAE,sCAAsC;IAC7D,OAAO,EAAE,yBAAyB;CACnC,CAAA;AAEY,QAAA,iBAAiB,GAA0B;IACtD,qBAAqB,EAAE,mBAAmB;IAC1C,qBAAqB,EAAE,mBAAmB;IAC1C,OAAO,EAAE,EAAE;CACZ,CAAA"}

package/lib/types/index.d.ts

@@ -0,0 +1 @@
+export * from './connector-types';

package/lib/types/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./connector-types"), exports);
+//# sourceMappingURL=index.js.map

package/lib/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;AAAA,4DAAiC"}

package/oclif.manifest.json

@@ -0,0 +1 @@
+{"version":"0.1.1-next.23+038e7a6","commands":{"action:add":{"id":"action:add","description":"Update a connector action.","strict":true,"pluginName":"@sw-tsdk/plugin-connector","pluginAlias":"@sw-tsdk/plugin-connector","pluginType":"core","aliases":[],"flags":{"directory":{"name":"directory","type":"option","char":"d","description":"Root directory of the repository.","multiple":false,"default":"./"},"template":{"name":"template","type":"option","char":"t","description":"action template to scaffold","multiple":false,"options":["node_18","python_310_definition","python_3.7_swimlane"],"default":"python_310_definition"},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[]},"action:input":{"id":"action:input","description":"Update action input schema.","strict":true,"pluginName":"@sw-tsdk/plugin-connector","pluginAlias":"@sw-tsdk/plugin-connector","pluginType":"core","aliases":[],"flags":{"action":{"name":"action","type":"option","char":"a","description":"Action name to run","multiple":false},"directory":{"name":"directory","type":"option","char":"d","description":"Root directory of the repository.","multiple":false,"default":"./"},"amend":{"name":"amend","type":"boolean","description":"Merge with existing schema.","allowNo":false},"action-config-path":{"name":"action-config-path","type":"option","description":"Override path to action configuration file. Defaults to /connector/config/actions/<action>.yaml","multiple":false},"input-path":{"name":"input-path","type":"option","description":"Relative path to the output data JSON file, defaults to the task name under the data folder. ie: /data/<taskName>_output.json","multiple":false,"dependsOn":["update-output-schema"]},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[]},"action:output":{"id":"action:output","description":"Update a connector action.","strict":true,"pluginName":"@sw-tsdk/plugin-connector","pluginAlias":"@sw-tsdk/plugin-connector","pluginType":"core","aliases":[],"flags":{"action":{"name":"action","type":"option","char":"a","description":"Action name to run","multiple":false},"directory":{"name":"directory","type":"option","char":"d","description":"Root directory of the repository.","multiple":false,"default":"./"},"action-config-path":{"name":"action-config-path","type":"option","description":"Override path to action configuration file. Defaults to /connector/config/<action>.yaml","multiple":false},"amend":{"name":"amend","type":"boolean","description":"Merge with existing schema.","allowNo":false},"output-path":{"name":"output-path","type":"option","description":"Relative path to the output data JSON file, defaults to the task name under the data folder. ie: /data/<taskName>_output.json","multiple":false,"dependsOn":["update-output-schema"]},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[]},"action:run":{"id":"action:run","description":"Runs a connector action. (Defaults to current image version in local repository).","strict":true,"pluginName":"@sw-tsdk/plugin-connector","pluginAlias":"@sw-tsdk/plugin-connector","pluginType":"core","aliases":[],"flags":{"action":{"name":"action","type":"option","char":"a","description":"Action name to run","multiple":false},"directory":{"name":"directory","type":"option","char":"d","description":"Root directory of the repository.","multiple":false,"default":"./"},"input-path":{"name":"input-path","type":"option","description":"File to input data JSON file, defaults to /data/<action>.json","multiple":false},"output-path":{"name":"output-path","type":"option","description":"File to write the outputs to, defaults to /data/<action>_output.json","multiple":false},"error-path":{"name":"error-path","type":"option","description":"File to write the errors to, defaults to /data/<action>_error.json","multiple":false},"asset-path":{"name":"asset-path","type":"option","description":"File to asset data JSON file, defaults to /data/asset.json","multiple":false},"image":{"name":"image","type":"option","char":"i","description":"The connector image to run.","multiple":false,"exclusive":["build","latest"]},"latest":{"name":"latest","type":"boolean","description":"Use the latest release image from quay.","allowNo":false,"exclusive":["build","image"]},"build":{"name":"build","type":"boolean","description":"Builds image and runs it.","allowNo":false,"exclusive":["latest","image"]},"template":{"name":"template","type":"option","description":"connector template","multiple":false,"options":["python_3.7","node_18","python_310_definition"],"default":"python_310_definition"},"compile-override":{"name":"compile-override","type":"option","hidden":true,"multiple":false,"default":"Compile.Dockerfile"},"runner-override":{"name":"runner-override","type":"option","hidden":true,"multiple":false,"default":"Runner.Dockerfile"},"runtime-override":{"name":"runtime-override","type":"option","hidden":true,"multiple":false,"dependsOn":["build"]},"force-rebuild":{"name":"force-rebuild","type":"boolean","char":"f","description":"forces nocache on the image build","allowNo":false,"dependsOn":["build"]},"platform":{"name":"platform","type":"option","hidden":true,"multiple":false,"default":"linux/amd64"},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[]},"asset:add":{"id":"asset:add","description":"Update a connector action.","strict":true,"pluginName":"@sw-tsdk/plugin-connector","pluginAlias":"@sw-tsdk/plugin-connector","pluginType":"core","aliases":[],"flags":{"directory":{"name":"directory","type":"option","char":"d","description":"Root directory of the repository.","multiple":false,"default":"./"},"scheme":{"name":"scheme","type":"option","char":"s","description":"asset template to scaffold","multiple":false,"options":["custom","apikey","client_credentials","basic","bearer"]},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[]},"connector:build":{"id":"connector:build","description":"Builds a local docker image of the connector.","strict":true,"pluginName":"@sw-tsdk/plugin-connector","pluginAlias":"@sw-tsdk/plugin-connector","pluginType":"core","aliases":[],"flags":{"template":{"name":"template","type":"option","description":"connector language","required":true,"multiple":false,"options":["python_3.7_swimlane","node_18","python_310_definition"],"default":"python_310_definition"},"compile-override":{"name":"compile-override","type":"option","hidden":true,"multiple":false,"default":"Compile.Dockerfile"},"runner-override":{"name":"runner-override","type":"option","hidden":true,"multiple":false,"default":"Runner.Dockerfile"},"runtime-override":{"name":"runtime-override","type":"option","hidden":true,"multiple":false},"directory":{"name":"directory","type":"option","char":"d","description":"root directory of the repository.","multiple":false,"default":"./"},"save":{"name":"save","type":"boolean","description":"saves docker image as tar in local directory.","allowNo":false},"squash":{"name":"squash","type":"boolean","description":"squashes the docker layers.","hidden":true,"allowNo":false},"force-rebuild":{"name":"force-rebuild","type":"boolean","char":"f","description":"forces nocache on the image build","allowNo":false},"platform":{"name":"platform","type":"option","hidden":true,"multiple":false,"default":"linux/amd64"},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[]},"connector:create-source":{"id":"connector:create-source","description":"Generates 11x source from 10x","strict":true,"pluginName":"@sw-tsdk/plugin-connector","pluginAlias":"@sw-tsdk/plugin-connector","pluginType":"core","aliases":[],"flags":{"directory":{"name":"directory","type":"option","char":"d","description":"root directory of the repository.","multiple":false,"default":"./"},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[]},"connector:create":{"id":"connector:create","description":"Scaffold a new connector","strict":true,"pluginName":"@sw-tsdk/plugin-connector","pluginAlias":"@sw-tsdk/plugin-connector","pluginType":"core","aliases":[],"flags":{"directory":{"name":"directory","type":"option","char":"d","description":"root directory for where to store connectors, the connector directory will be generated.","multiple":false,"default":"./"},"template":{"name":"template","type":"option","char":"t","description":"connector template to scaffold","multiple":false,"options":["node_18","python_310_definition","python_3.7_swimlane"],"default":"python_310_definition"},"skip-repo":{"name":"skip-repo","type":"boolean","description":"skips the repository creation process","allowNo":false},"clientId":{"name":"clientId","type":"option","char":"c","description":"client id of the authentication app","hidden":true,"multiple":false,"default":"0d418a5615c458b0b593"},"vendor":{"name":"vendor","type":"option","description":"Vendor (e.g. CrowdStrike)","multiple":false},"product":{"name":"product","type":"option","description":"Product (e.g. Falcon)","multiple":false},"keywords":{"name":"keywords","type":"option","description":"Please enter keyword (Comma-Separated)","multiple":false},"description":{"name":"description","type":"option","description":"Description (e.g. CrowdStrike Host Query API)","multiple":false},"logoPath":{"name":"logoPath","type":"option","description":"URL or absolute path to logo file","multiple":false},"author":{"name":"author","type":"option","description":"Connector Author","multiple":false},"authorEmail":{"name":"authorEmail","type":"option","description":"Connector Author Email","multiple":false},"homepage":{"name":"homepage","type":"option","description":"Connector Author Support URL","multiple":false},"repo-base-template":{"name":"repo-base-template","type":"option","char":"t","description":"github base template override to create repo from.","hidden":true,"multiple":false,"default":"connector-python-definition-template"},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[]},"connector:logo":{"id":"connector:logo","description":"Update a connector.","strict":true,"pluginName":"@sw-tsdk/plugin-connector","pluginAlias":"@sw-tsdk/plugin-connector","pluginType":"core","aliases":[],"flags":{"directory":{"name":"directory","type":"option","char":"d","description":"root directory of the connector folder.","multiple":false,"default":"."},"path":{"name":"path","type":"option","char":"p","description":"path or URL to product logo in PNG format.","required":true,"multiple":false},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[]},"connector:save":{"id":"connector:save","description":"Save a docker image locally as .tar.gz","strict":true,"pluginName":"@sw-tsdk/plugin-connector","pluginAlias":"@sw-tsdk/plugin-connector","pluginType":"core","aliases":[],"flags":{"directory":{"name":"directory","type":"option","char":"d","description":"Root directory of the repo.","multiple":false,"default":"."},"output":{"name":"output","type":"option","char":"o","description":"output file to where to store the image.","required":true,"multiple":false},"image":{"name":"image","type":"option","char":"i","description":"image to save.","required":true,"multiple":false},"skip-pull":{"name":"skip-pull","type":"boolean","char":"s","description":"skips pulling the image","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[]},"connector:sign":{"id":"connector:sign","description":"Builds a local docker image of the connector.","strict":true,"pluginName":"@sw-tsdk/plugin-connector","pluginAlias":"@sw-tsdk/plugin-connector","pluginType":"core","aliases":[],"flags":{"directory":{"name":"directory","type":"option","char":"d","description":"root directory of the repository.","multiple":false,"default":"./"},"image":{"name":"image","type":"option","description":"image name to sign","required":true,"multiple":false},"signing-password":{"name":"signing-password","type":"option","description":"password used for the private key","multiple":false,"default":""},"save":{"name":"save","type":"boolean","description":"saves docker image as tar in local directory.","allowNo":false},"key-name":{"name":"key-name","type":"option","description":"name used for the key (default: username)","required":true,"multiple":false},"skip-upload":{"name":"skip-upload","type":"boolean","hidden":true,"allowNo":false},"registry":{"name":"registry","type":"option","description":"registry to use for signing","multiple":false,"default":"localhost:50000"},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[]},"connector:update":{"id":"connector:update","description":"Update a connector.","strict":true,"pluginName":"@sw-tsdk/plugin-connector","pluginAlias":"@sw-tsdk/plugin-connector","pluginType":"core","aliases":[],"flags":{"directory":{"name":"directory","type":"option","char":"d","description":"root directory of the connector folder.","multiple":false,"default":"."},"version":{"name":"version","type":"option","char":"v","description":"new version of the connector.","multiple":false},"manifest-path":{"name":"manifest-path","type":"option","char":"f","description":"connector manifest path relative to directory.","multiple":false,"default":"/connector/connector.yaml"},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[]},"connector:validate":{"id":"connector:validate","description":"Use to validate an integration","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},"connector":{"name":"connector","type":"option","char":"c","description":"connector to validate (relative to directory)","required":true,"multiple":false},"signed":{"name":"signed","type":"boolean","description":"validates a signed connector","allowNo":false},"key":{"name":"key","type":"option","description":"public key for verfication","multiple":false,"dependsOn":["signed"],"exclusive":["skip-verification"]},"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":[]}}}

package/package.json

@@ -0,0 +1,91 @@
+{
+  "author": "Swimlane",
+  "bugs": {
+    "url": "https://github.com/swimlane/turbine-sdk/issues"
+  },
+  "dependencies": {
+    "@oclif/core": "1.16.4",
+    "@sw-tsdk/common": "^0.1.1-next.23+038e7a6",
+    "@sw-tsdk/connector": "^0.1.1-next.23+038e7a6",
+    "@sw-tsdk/core": "^0.1.1-next.23+038e7a6",
+    "@sw-tsdk/docker": "^0.1.1-next.23+038e7a6",
+    "@swimlane/connector-interfaces": "1.8.5-rc3",
+    "@swimlane/cosign": "1.3.0",
+    "@swimlane/docker-reference": "0.0.15",
+    "fs-extra": "10.0.1",
+    "handlebars": "4.7.7",
+    "inquirer": "8.2.2",
+    "inquirer-autocomplete-prompt": "2.0.0",
+    "js-yaml": "4.1.0",
+    "json-schema-typed": "7.0.3",
+    "listr2": "4.0.5",
+    "noop-stream": "1.0.0",
+    "npmlog": "6.0.1",
+    "semver": "7.3.6",
+    "snake-case": "3.0.4",
+    "tslib": "2.3.1"
+  },
+  "description": "Plugin for managing connectors.",
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "files": [
+    "/npm-shrinkwrap.json",
+    "/oclif.manifest.json",
+    "/yarn.lock",
+    "lib"
+  ],
+  "homepage": "https://github.com/swimlane/turbine-sdk#readme",
+  "keywords": [
+    "oclif-plugin"
+  ],
+  "license": "ISC",
+  "main": "lib/index.js",
+  "name": "@sw-tsdk/plugin-connector",
+  "directories": {
+    "templates": "./lib/templates",
+    "lib": "lib"
+  },
+  "oclif": {
+    "commands": "./lib/commands",
+    "bin": "sw-tsdk-connector",
+    "devPlugins": [
+      "@oclif/plugin-help"
+    ],
+    "topics": {
+      "connector": {
+        "description": "Local connector commands"
+      },
+      "action": {
+        "description": "Local connector action commands"
+      },
+      "asset": {
+        "description": "Local connector asset commands"
+      },
+      "connectors": {
+        "description": "Local connectors commands"
+      }
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/swimlane/turbine-sdk.git"
+  },
+  "scripts": {
+    "build": "rm -rf lib && tsc && yarn copy-files",
+    "lint": "eslint . --ext .ts --config .eslintrc",
+    "copy-files": "recursive-copy **/templates/ lib/templates",
+    "pretest": "tsc -p test --noEmit",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "prepack": "yarn build && oclif manifest && oclif readme",
+    "version": "oclif readme",
+    "test": "echo NO TESTS",
+    "posttest": "yarn lint",
+    "link": "yarn link"
+  },
+  "version": "0.1.1-next.23+038e7a6",
+  "gitHead": "038e7a68d45b2d93f39c7f7b2edce9798019007e"
+}