@twilio/create-flex-plugin 5.0.0

package/LICENSE

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

package/README.md

@@ -0,0 +1,132 @@
+[![Version](https://img.shields.io/npm/v/create-flex-plugin.svg?style=square)](https://www.npmjs.com/package/create-flex-plugin)
+[![Download](https://img.shields.io/npm/dt/create-flex-plugin.svg?style=square)](https://www.npmjs.com/package/create-flex-plugin)
+[![License](https://img.shields.io/npm/l/create-flex-plugin.svg?style=square)](../../LICENSE)
+
+# Create Flex Plugin
+
+Command-line tool to create, develop and build a new Twilio Flex Plugin.
+
+## Usage
+
+There is a variety of ways to use/install. The quickest way is:
+
+```bash
+npm init flex-plugin plugin-demo
+cd plugin-demo
+npm start
+```
+
+### How to install/run using `npm`
+
+#### Using `npm`:
+
+```bash
+# Via npm init
+npm init flex-plugin plugin-demo
+
+# Via npx
+npx create-flex-plugin plugin-demo
+
+# Install globally
+npm install -g create-flex-plugin
+create-flex-plugin plugin-demo
+```
+
+#### Using `yarn`:
+
+```bash
+# Via npm init
+npm init flex-plugin plugin-demo --yarn
+
+# Via npx
+npx create-flex-plugin plugin-demo --yarn
+
+# Install globally
+npm install -g create-flex-plugin
+create-flex-plugin plugin-demo --yarn
+```
+
+_Note_: Support for `yarn` only exists for `@twilio/flex-ui > 1.18.0`. If you are upgrading from an older version of the plugin-builder, you'll need to add add `react-emotion` and pin it to `9.2.6`.
+
+### Command line arguments:
+
+```
+create-flex-plugin <name>
+
+Creates a new Twilio Flex Plugin project
+
+Arguments:
+name    Name of your plugin. Needs to start with `plugin-`
+
+Options:
+  --accountSid, -a  The Account SID for your Flex Project
+  --runtimeUrl, -r  The URL to your Twilio Flex Runtime
+  --template, -t    A GitHub URL that contains your template
+  --typescript, -s  Create a typescript project
+  --install         Auto-install dependencies                   [boolean] [default: false]
+  --yarn, -y        Use yarn 
+  -h, --help        Show help                                   [boolean] [default: false]
+  -v, --version     Show version number                         [boolean] [default: false]
+```
+
+### Creating a Plugin from Custom Template
+
+When creating a new plugin, you may provide a `--template` URL to a GitHub repo containing the source code of a Flex plugin. Create Flex Plugin will copy over the entire content from the directory, including all scripts, files and directories that are not part of the src folder. The repo has to be a valid node repository which means that it expects files such as `package.json`, `.gitignore`, `README.md`, etc to be present.
+
+#### Template Directory Hierarchy
+
+Your GitHub project should be
+```
+/
+     src/
+      index.js
+      ...
+    ...
+```
+
+Create Flex Plugin will copy over the content from the directory, and expects an `index.js` in the src folder. We will also provide a `public/` folder and a `package.json` but you may override these by including them in your base GitHub repo.
+
+See [flex-plugin-template-sample](https://github.com/ktalebian/flex-plugin-template-sample) for a basic example and 
+[plugin-agent-autoresponse](github.com/johnfischelli/plugin-agent-autoresponse) for a more complete example.
+
+#### Version Support
+
+The `--template` link can contain a reference, which can be a `tag` or a `branch` name. For example 
+
+```bash
+create-flex-plugin <plugin-name> --template https://github.com/ktalebian/flex-plugin-template-sample/tree/1.0.0
+```
+
+would use the tagged version `1.0.0`, while
+
+```bash
+create-flex-plugin <plugin-name> --template https://github.com/ktalebian/flex-plugin-template-sample/tree/master
+```
+
+would use the `master` branch.
+
+## Contributing
+
+Make sure to follow the instructions in the [main repository](https://github.com/twilio/flex-plugin-builder#contributing) to set up the project.
+
+```bash
+# Install dependencies and link local packages with each other
+cd packages/create-flex-plugin
+npx lerna bootstrap
+
+# Run tests
+npm test
+
+# To execute your local version the CLI
+npm link
+create-flex-plugin --help
+```
+
+## Contributors
+
+Thank you to all the lovely contributors to this project. Please check the main repository to see [all contributors](https://github.com/twilio/flex-plugin-builder#contributors).
+
+## License
+
+[MIT](../../LICENSE)
+

package/bin/create-flex-plugin

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+
+'use strict';
+
+require = require('esm')(module /*, options*/);
+
+const CLI = require('../dist').default;
+const cli = new CLI();
+
+cli.parse(...process.argv.slice(2));

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { default } from './lib/cli';
+export { default as CreateFlexPlugin } from './lib/create-flex-plugin';

package/dist/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateFlexPlugin = exports.default = void 0;
+/* eslint-disable import/no-unused-modules */
+var updateNotifier_1 = require("@twilio/flex-dev-utils/dist/updateNotifier");
+updateNotifier_1.checkForUpdate();
+var cli_1 = require("./lib/cli");
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return __importDefault(cli_1).default; } });
+var create_flex_plugin_1 = require("./lib/create-flex-plugin");
+Object.defineProperty(exports, "CreateFlexPlugin", { enumerable: true, get: function () { return __importDefault(create_flex_plugin_1).default; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,6CAA6C;AAC7C,6EAA4E;AAE5E,+BAAc,EAAE,CAAC;AAEjB,iCAAoC;AAA3B,+GAAA,OAAO,OAAA;AAChB,+DAAuE;AAA9D,uIAAA,OAAO,OAAoB"}

package/dist/lib/cli.d.ts

@@ -0,0 +1,26 @@
+import { Options } from 'yargs';
+export interface CLIArguments {
+    accountSid?: string;
+    a?: string;
+    runtimeUrl?: string;
+    r?: string;
+    install?: boolean;
+    i?: boolean;
+    name?: string;
+    yarn?: boolean;
+    y?: boolean;
+    template?: string;
+    t?: string;
+    typescript?: boolean;
+    s?: boolean;
+}
+export default class CLI {
+    static description: string;
+    static flags: {
+        [key: string]: Options;
+    };
+    private readonly parser;
+    constructor(cwd?: string);
+    parse: (...args: string[]) => Promise<void>;
+    private init;
+}

package/dist/lib/cli.js

@@ -0,0 +1,128 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var yargs_1 = __importDefault(require("yargs"));
+var flex_dev_utils_1 = require("@twilio/flex-dev-utils");
+var create_flex_plugin_1 = require("./create-flex-plugin");
+var usage = flex_dev_utils_1.multilineString('Creates a new Twilio Flex Plugin project', '', 'Arguments:', 'name\tName of your plugin.');
+var CLI = /** @class */ (function () {
+    function CLI(cwd) {
+        var _this = this;
+        this.parse = function () {
+            var args = [];
+            for (var _i = 0; _i < arguments.length; _i++) {
+                args[_i] = arguments[_i];
+            }
+            return __awaiter(_this, void 0, void 0, function () {
+                var argv;
+                var _this = this;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0:
+                            argv = this.parser.parse(args);
+                            return [4 /*yield*/, flex_dev_utils_1.runner(function () { return __awaiter(_this, void 0, void 0, function () { return __generator(this, function (_a) {
+                                    return [2 /*return*/, create_flex_plugin_1.createFlexPlugin(argv)];
+                                }); }); })];
+                        case 1:
+                            _a.sent();
+                            flex_dev_utils_1.exit(0);
+                            return [2 /*return*/];
+                    }
+                });
+            });
+        };
+        this.init = function () {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            _this.parser.usage('$0 <name>', usage, CLI.flags);
+        };
+        this.parser = yargs_1.default([], cwd);
+        this.init();
+    }
+    CLI.description = usage;
+    CLI.flags = {
+        typescript: {
+            alias: 's',
+            type: 'boolean',
+            describe: 'Create a TypeScript project',
+            default: false,
+        },
+        template: {
+            alias: 't',
+            type: 'string',
+            describe: 'A GitHub URL that contains your template',
+            default: '',
+        },
+        accountSid: {
+            alias: 'a',
+            type: 'string',
+            describe: 'The Account SID for your Flex Project',
+            default: '',
+        },
+        runtimeUrl: {
+            alias: 'r',
+            type: 'boolean',
+            default: false,
+            describe: 'The URL to your Twilio Flex Runtime',
+        },
+        install: {
+            alias: 'i',
+            type: 'boolean',
+            default: false,
+            describe: 'Auto-install dependencies',
+        },
+        yarn: {
+            alias: 'y',
+            type: 'boolean',
+            default: false,
+            describe: 'Use yarn as your dependency manager',
+        },
+        help: {
+            alias: 'h',
+            description: usage,
+        },
+        version: {
+            alias: 'v',
+        },
+    };
+    return CLI;
+}());
+exports.default = CLI;
+//# sourceMappingURL=cli.js.map

package/dist/lib/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../src/lib/cli.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,gDAA6C;AAC7C,yDAAuE;AAEvE,2DAA6E;AAE7E,IAAM,KAAK,GAAG,gCAAe,CAC3B,0CAA0C,EAC1C,EAAE,EACF,YAAY,EACZ,4BAA4B,CAC7B,CAAC;AAkBF;IAmDE,aAAY,GAAY;QAAxB,iBAIC;QAEM,UAAK,GAAG;YAAO,cAAiB;iBAAjB,UAAiB,EAAjB,qBAAiB,EAAjB,IAAiB;gBAAjB,yBAAiB;;;;;;;;4BAC/B,IAAI,GAAiB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;4BAEnD,qBAAM,uBAAM,CAAC;oCAAY,sBAAA,qCAAgB,CAAC,IAA2B,CAAC,EAAA;yCAAA,CAAC,EAAA;;4BAAvE,SAAuE,CAAC;4BACxE,qBAAI,CAAC,CAAC,CAAC,CAAC;;;;;SACT,CAAC;QAEM,SAAI,GAAG;YACb,8DAA8D;YAC9D,KAAI,CAAC,MAAM,CAAC,KAAK,CAAM,WAAW,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;QACxD,CAAC,CAAC;QAfA,IAAI,CAAC,MAAM,GAAG,eAAK,CAAC,EAAE,EAAE,GAAG,CAAuB,CAAC;QAEnD,IAAI,CAAC,IAAI,EAAE,CAAC;IACd,CAAC;IAtDa,eAAW,GAAG,KAAK,CAAC;IAEpB,SAAK,GAA+B;QAChD,UAAU,EAAE;YACV,KAAK,EAAE,GAAG;YACV,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,6BAA6B;YACvC,OAAO,EAAE,KAAK;SACf;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,GAAG;YACV,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,0CAA0C;YACpD,OAAO,EAAE,EAAE;SACZ;QACD,UAAU,EAAE;YACV,KAAK,EAAE,GAAG;YACV,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,uCAAuC;YACjD,OAAO,EAAE,EAAE;SACZ;QACD,UAAU,EAAE;YACV,KAAK,EAAE,GAAG;YACV,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,qCAAqC;SAChD;QACD,OAAO,EAAE;YACP,KAAK,EAAE,GAAG;YACV,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,2BAA2B;SACtC;QACD,IAAI,EAAE;YACJ,KAAK,EAAE,GAAG;YACV,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,qCAAqC;SAChD;QACD,IAAI,EAAE;YACJ,KAAK,EAAE,GAAG;YACV,WAAW,EAAE,KAAK;SACnB;QACD,OAAO,EAAE;YACP,KAAK,EAAE,GAAG;SACX;KACF,CAAC;IAqBJ,UAAC;CAAA,AApED,IAoEC;kBApEoB,GAAG"}

package/dist/lib/commands.d.ts

@@ -0,0 +1,22 @@
+import { FlexPluginArguments } from './create-flex-plugin';
+/**
+ * Install dependencies
+ *
+ * @param config {FlexPluginArguments} the plugin argument
+ * @return {string} the stdout of the execution
+ */
+export declare const installDependencies: (config: FlexPluginArguments) => Promise<string>;
+/**
+ * Appends className to the configuration
+ *
+ * @param config {FlexPluginArguments}  the plugin configuration
+ * @return {FlexPluginArguments} the updated configuration
+ */
+export declare const setupConfiguration: (config: FlexPluginArguments) => FlexPluginArguments;
+/**
+ * Downloads content from GitHub
+ *
+ * @param url {string}                  the GitHub url
+ * @param dir {string}                  the temp directory to save the downloaded file to
+ */
+export declare const downloadFromGitHub: (url: string, dir: string) => Promise<void>;

package/dist/lib/commands.js

@@ -0,0 +1,128 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.downloadFromGitHub = exports.setupConfiguration = exports.installDependencies = void 0;
+var fs_1 = require("@twilio/flex-dev-utils/dist/fs");
+var spawn_1 = require("@twilio/flex-dev-utils/dist/spawn");
+var lodash_1 = require("@twilio/flex-dev-utils/dist/lodash");
+var github = __importStar(require("../utils/github"));
+// eslint-disable-next-line @typescript-eslint/no-var-requires, global-require, @typescript-eslint/no-require-imports
+var pkg = require(fs_1.findUp(__filename, 'package.json'));
+/**
+ * Install dependencies
+ *
+ * @param config {FlexPluginArguments} the plugin argument
+ * @return {string} the stdout of the execution
+ */
+var installDependencies = function (config) { return __awaiter(void 0, void 0, void 0, function () {
+    var shellCmd, args, options, _a, stdout, exitCode, stderr;
+    return __generator(this, function (_b) {
+        switch (_b.label) {
+            case 0:
+                shellCmd = config.yarn ? 'yarn' : 'npm';
+                args = ['install'];
+                options = {
+                    cwd: config.targetDirectory,
+                    shell: process.env.SHELL,
+                };
+                return [4 /*yield*/, spawn_1.spawn(shellCmd, args, options)];
+            case 1:
+                _a = _b.sent(), stdout = _a.stdout, exitCode = _a.exitCode, stderr = _a.stderr;
+                if (exitCode === 1) {
+                    throw new Error(stderr);
+                }
+                return [2 /*return*/, stdout];
+        }
+    });
+}); };
+exports.installDependencies = installDependencies;
+/**
+ * Appends className to the configuration
+ *
+ * @param config {FlexPluginArguments}  the plugin configuration
+ * @return {FlexPluginArguments} the updated configuration
+ */
+var setupConfiguration = function (config) {
+    var name = config.name || '';
+    config.pluginClassName = lodash_1.upperFirst(lodash_1.camelCase(name)).replace('Plugin', '') + "Plugin";
+    config.pluginNamespace = name.toLowerCase().replace('plugin-', '');
+    config.runtimeUrl = config.runtimeUrl || 'http://localhost:3000';
+    config.targetDirectory = fs_1.resolveCwd(name);
+    config.flexSdkVersion = pkg.devDependencies['@twilio/flex-ui'];
+    config.pluginScriptsVersion = pkg.devDependencies['@twilio/flex-plugin-scripts'];
+    return config;
+};
+exports.setupConfiguration = setupConfiguration;
+/**
+ * Downloads content from GitHub
+ *
+ * @param url {string}                  the GitHub url
+ * @param dir {string}                  the temp directory to save the downloaded file to
+ */
+var downloadFromGitHub = function (url, dir) { return __awaiter(void 0, void 0, void 0, function () {
+    var info;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [4 /*yield*/, github.parseGitHubUrl(url)];
+            case 1:
+                info = _a.sent();
+                return [2 /*return*/, github.downloadRepo(info, dir)];
+        }
+    });
+}); };
+exports.downloadFromGitHub = downloadFromGitHub;
+//# sourceMappingURL=commands.js.map

package/dist/lib/commands.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commands.js","sourceRoot":"","sources":["../../src/lib/commands.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qDAAoE;AACpE,2DAA0D;AAC1D,6DAA2E;AAE3E,sDAA0C;AAG1C,qHAAqH;AACrH,IAAM,GAAG,GAAG,OAAO,CAAC,WAAM,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC,CAAC;AAExD;;;;;GAKG;AACI,IAAM,mBAAmB,GAAG,UAAO,MAA2B;;;;;gBAC7D,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC;gBACxC,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC;gBACnB,OAAO,GAAG;oBACd,GAAG,EAAE,MAAM,CAAC,eAAe;oBAC3B,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,KAAK;iBACzB,CAAC;gBAEmC,qBAAM,aAAK,CAAC,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC,EAAA;;gBAAnE,KAA+B,SAAoC,EAAjE,MAAM,YAAA,EAAE,QAAQ,cAAA,EAAE,MAAM,YAAA;gBAEhC,IAAI,QAAQ,KAAK,CAAC,EAAE;oBAClB,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;iBACzB;gBAED,sBAAO,MAAM,EAAC;;;KACf,CAAC;AAfW,QAAA,mBAAmB,uBAe9B;AAEF;;;;;GAKG;AACI,IAAM,kBAAkB,GAAG,UAAC,MAA2B;IAC5D,IAAM,IAAI,GAAG,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;IAE/B,MAAM,CAAC,eAAe,GAAM,mBAAU,CAAC,kBAAS,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,WAAQ,CAAC;IACtF,MAAM,CAAC,eAAe,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IACnE,MAAM,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,IAAI,uBAAuB,CAAC;IACjE,MAAM,CAAC,eAAe,GAAG,eAAU,CAAC,IAAI,CAAC,CAAC;IAC1C,MAAM,CAAC,cAAc,GAAG,GAAG,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC;IAC/D,MAAM,CAAC,oBAAoB,GAAG,GAAG,CAAC,eAAe,CAAC,6BAA6B,CAAC,CAAC;IAEjF,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAXW,QAAA,kBAAkB,sBAW7B;AAEF;;;;;GAKG;AACI,IAAM,kBAAkB,GAAG,UAAO,GAAW,EAAE,GAAW;;;;oBAClD,qBAAM,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,EAAA;;gBAAvC,IAAI,GAAG,SAAgC;gBAE7C,sBAAO,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,GAAG,CAAC,EAAC;;;KACvC,CAAC;AAJW,QAAA,kBAAkB,sBAI7B"}

package/dist/lib/create-flex-plugin.d.ts

@@ -0,0 +1,28 @@
+import { CLIArguments } from './cli';
+export interface FlexPluginArguments extends CLIArguments {
+    name: string;
+    targetDirectory: string;
+    flexSdkVersion: string;
+    pluginScriptsVersion: string;
+    pluginClassName: string;
+    pluginNamespace: string;
+}
+/**
+ * Runs the NPM Installation
+ * @param config {FlexPluginArguments}  the configuration
+ * @private
+ */
+export declare const _install: (config: FlexPluginArguments) => Promise<boolean>;
+/**
+ * Creates all the directories and copies the templates over
+ *
+ * @param config {FlexPluginArguments}  the configuration
+ * @private
+ */
+export declare const _scaffold: (config: FlexPluginArguments) => Promise<boolean>;
+/**
+ * Creates a Flex Plugin from the {@link FlexPluginArguments}
+ * @param config {FlexPluginArguments} the configuration
+ */
+export declare const createFlexPlugin: (config: FlexPluginArguments) => Promise<void>;
+export default createFlexPlugin;