@twilio/flex-plugin-webpack 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,15 @@
+![npm](https://img.shields.io/npm/v/flex-plugin-webpack.svg?style=square)
+![npm](https://img.shields.io/npm/dt/flex-plugin-webpack.svg?style=square)
+[![NpmLicense](https://img.shields.io/npm/l/flex-plugin-webpack.svg?style=square)](../../LICENSE)
+
+# Flex Plugin Webpack
+
+To be filled
+
+## 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/dist/compiler.d.ts

@@ -0,0 +1,34 @@
+import { SyncHook } from 'tapable';
+import webpack, { Compiler as WebpackCompiler, Configuration } from 'webpack';
+import { OnCompileCompletePayload } from './devServer/ipcServer';
+import { OnRemotePlugins } from './devServer/pluginServer';
+import CompilerHooks = webpack.compilation.CompilerHooks;
+interface Hook extends CompilerHooks {
+    tsCompiled: SyncHook<string[], string[]>;
+}
+export interface Compiler extends WebpackCompiler {
+    hooks: Hook;
+}
+declare type OnCompile = (payload: OnCompileCompletePayload) => void;
+interface CompilerRenderer {
+    onCompile: OnCompile;
+    onRemotePlugins: OnRemotePlugins;
+}
+declare const _default: (config: Configuration, devServer: boolean, isJavaScriptServer: boolean, onCompile: OnCompile) => Compiler;
+/**
+ * Creates a webpack compiler
+ *
+ * @param config      the Webpack configuration
+ * @param devServer   whether to run the devserver or not
+ * @param type        the webpack compile type
+ * @param localPlugins  the names of plugins to run locally
+ */
+export default _default;
+/**
+ * Prints the errors and warnings or a successful message when compilation finishes
+ * @param port    the port the server is running on
+ * @param localPlugins the local plugins running
+ * @param showSuccessMsg    whether to show succecss message or not
+ * @param hasRemote         whether there are any remote plugins
+ */
+export declare const compilerRenderer: (port: number, localPlugins: string[], showSuccessMsg: boolean, hasRemote: boolean) => CompilerRenderer;

package/dist/compiler.js

@@ -0,0 +1,223 @@
+"use strict";
+/* istanbul ignore file */
+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 __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from) {
+    for (var i = 0, il = from.length, j = to.length; i < il; i++, j++)
+        to[j] = from[i];
+    return to;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compilerRenderer = void 0;
+var flex_dev_utils_1 = require("@twilio/flex-dev-utils");
+var errors_1 = require("@twilio/flex-dev-utils/dist/errors");
+var tapable_1 = require("tapable");
+var fork_ts_checker_webpack_plugin_1 = __importDefault(require("fork-ts-checker-webpack-plugin"));
+var typescript_compile_error_formatter_1 = __importDefault(require("@k88/typescript-compile-error-formatter"));
+var webpack_1 = __importDefault(require("webpack"));
+var fs_1 = require("@twilio/flex-dev-utils/dist/fs");
+var format_webpack_messages_1 = __importDefault(require("@k88/format-webpack-messages"));
+var urls_1 = require("@twilio/flex-dev-utils/dist/urls");
+var prints_1 = require("./prints");
+// Holds all compilation errors
+var results = {};
+/**
+ * Creates a webpack compiler
+ *
+ * @param config      the Webpack configuration
+ * @param devServer   whether to run the devserver or not
+ * @param type        the webpack compile type
+ * @param localPlugins  the names of plugins to run locally
+ */
+/* istanbul ignore next */
+exports.default = (function (config, devServer, isJavaScriptServer, onCompile) {
+    flex_dev_utils_1.logger.debug('Creating webpack compiler');
+    try {
+        var compiler_1 = webpack_1.default(config);
+        compiler_1.hooks.tsCompiled = new tapable_1.SyncHook(['warnings', 'errors']);
+        // For build, we don't need to tap into any hooks
+        if (!devServer) {
+            return compiler_1;
+        }
+        var tsMessagesPromise_1;
+        var tsMessagesResolver_1;
+        if (fs_1.getPaths().app.isTSProject()) {
+            compiler_1.hooks.beforeCompile.tap('beforeCompile', function () {
+                tsMessagesPromise_1 = new Promise(function (resolve) {
+                    tsMessagesResolver_1 = function (msgs) { return resolve(msgs); };
+                });
+            });
+            fork_ts_checker_webpack_plugin_1.default.getCompilerHooks(compiler_1).receive.tap('afterTSCheck', function (diagnostics, lints) {
+                var allMsgs = __spreadArray(__spreadArray([], __read(diagnostics)), __read(lints));
+                var format = function (issue) { return issue.file + "\n" + typescript_compile_error_formatter_1.default(issue); };
+                if (tsMessagesResolver_1) {
+                    tsMessagesResolver_1({
+                        errors: allMsgs.filter(function (msg) { return msg.severity === 'error'; }).map(format),
+                        warnings: allMsgs.filter(function (msg) { return msg.severity === 'warning'; }).map(format),
+                    });
+                }
+            });
+        }
+        // invalid is `bundle invalidated` and is invoked when files are modified in dev-server.
+        compiler_1.hooks.invalid.tap('invalid', function () {
+            flex_dev_utils_1.logger.clearTerminal();
+            flex_dev_utils_1.logger.info("Re-compiling **" + fs_1.getPaths().app.name + "**");
+        });
+        compiler_1.hooks.done.tap('done', function (stats) { return __awaiter(void 0, void 0, void 0, function () {
+            var result, delayedMsg, messages, config;
+            var _a, _b, _c, _d;
+            return __generator(this, function (_e) {
+                switch (_e.label) {
+                    case 0:
+                        result = stats.toJson({ all: false, errors: true, warnings: true });
+                        if (!(fs_1.getPaths().app.isTSProject() && !stats.hasErrors())) return [3 /*break*/, 2];
+                        delayedMsg = setTimeout(function () {
+                            flex_dev_utils_1.logger.notice('Waiting for Typescript check results...');
+                        }, 100);
+                        return [4 /*yield*/, tsMessagesPromise_1];
+                    case 1:
+                        messages = _e.sent();
+                        clearTimeout(delayedMsg);
+                        // Push ts-compile errors into compiler
+                        (_a = result.errors).push.apply(_a, __spreadArray([], __read(messages.errors)));
+                        (_b = stats.compilation.errors).push.apply(_b, __spreadArray([], __read(messages.errors)));
+                        (_c = result.warnings).push.apply(_c, __spreadArray([], __read(messages.warnings)));
+                        (_d = stats.compilation.warnings).push.apply(_d, __spreadArray([], __read(messages.warnings)));
+                        compiler_1.hooks.tsCompiled.call(messages.warnings, messages.errors);
+                        _e.label = 2;
+                    case 2:
+                        config = fs_1.readRunPluginsJson();
+                        // Add the plugin to the loaded plugins configuration file
+                        if (isJavaScriptServer) {
+                            config.loadedPlugins.push(fs_1.getPaths().app.name);
+                            fs_1.writeJSONFile(config, fs_1.getCliPaths().localPluginsJsonPath);
+                        }
+                        // Check to see if the plugin is the last bundle to be loaded
+                        onCompile({
+                            result: result,
+                            appName: fs_1.getPaths().app.name,
+                            lastPluginBundle: config.plugins.length === config.loadedPlugins.length,
+                        });
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        return compiler_1;
+    }
+    catch (err) {
+        throw new errors_1.FlexPluginError("Failed to create a webpack compiler: " + err.message);
+    }
+});
+/**
+ * Prints the errors and warnings or a successful message when compilation finishes
+ * @param port    the port the server is running on
+ * @param localPlugins the local plugins running
+ * @param showSuccessMsg    whether to show succecss message or not
+ * @param hasRemote         whether there are any remote plugins
+ */
+var compilerRenderer = function (port, localPlugins, showSuccessMsg, hasRemote) {
+    var _a = urls_1.getLocalAndNetworkUrls(port), local = _a.local, network = _a.network;
+    var remotePlugins = [];
+    var serverSuccessful = function (list) {
+        list.forEach(function (l) {
+            if (!remotePlugins.some(function (r) { return r.name === l.name; })) {
+                remotePlugins.push(l);
+            }
+        });
+        flex_dev_utils_1.logger.clearTerminal();
+        prints_1.devServerSuccessful(local, network, localPlugins, remotePlugins, hasRemote);
+    };
+    return {
+        onRemotePlugins: serverSuccessful,
+        onCompile: function (_a) {
+            var result = _a.result, appName = _a.appName;
+            flex_dev_utils_1.logger.clearTerminal();
+            results[appName] = result;
+            var isSuccessful = Object.values(results).every(function (r) { return r.errors.length === 0 && r.warnings.length === 0; });
+            if (isSuccessful) {
+                if (showSuccessMsg) {
+                    serverSuccessful([]);
+                }
+                return;
+            }
+            Object.keys(results).forEach(function (name) {
+                var formatted = format_webpack_messages_1.default({
+                    errors: results[name].errors,
+                    warnings: results[name].warnings,
+                });
+                // Only show errors if both exist
+                if (results[name].errors.length) {
+                    /*
+                     * Most errors are duplicate of the same error
+                     * So only show the first error
+                     */
+                    formatted.errors.length = 1;
+                    flex_dev_utils_1.logger.error("Failed to compile plugin " + flex_dev_utils_1.logger.colors.red.bold(name) + ".");
+                    flex_dev_utils_1.logger.info(formatted.errors.join('\n'));
+                    flex_dev_utils_1.logger.newline();
+                    return;
+                }
+                if (results[name].warnings.length) {
+                    flex_dev_utils_1.logger.warning("Compiled plugin " + flex_dev_utils_1.logger.colors.yellow.bold(name) + " with warning(s).");
+                    flex_dev_utils_1.logger.info(formatted.warnings.join('\n'));
+                    flex_dev_utils_1.logger.newline();
+                }
+            });
+        },
+    };
+};
+exports.compilerRenderer = compilerRenderer;
+//# sourceMappingURL=compiler.js.map

package/dist/compiler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"compiler.js","sourceRoot":"","sources":["../src/compiler.ts"],"names":[],"mappings":";AAAA,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAE1B,yDAAoE;AACpE,6DAAqE;AACrE,mCAAmC;AACnC,kGAAwE;AACxE,+GAAqF;AACrF,oDAA8E;AAC9E,qDAA0G;AAC1G,yFAAiE;AACjE,yDAA0E;AAI1E,mCAA+C;AAwB/C,+BAA+B;AAC/B,IAAM,OAAO,GAAoB,EAAE,CAAC;AAEpC;;;;;;;GAOG;AACH,0BAA0B;AAC1B,mBAAe,UACb,MAAqB,EACrB,SAAkB,EAClB,kBAA2B,EAC3B,SAAoB;IAEpB,uBAAM,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAE1C,IAAI;QACF,IAAM,UAAQ,GAAG,iBAAO,CAAC,MAAM,CAAa,CAAC;QAC7C,UAAQ,CAAC,KAAK,CAAC,UAAU,GAAG,IAAI,kBAAQ,CAAC,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC;QAEjE,iDAAiD;QACjD,IAAI,CAAC,SAAS,EAAE;YACd,OAAO,UAAQ,CAAC;SACjB;QACD,IAAI,mBAA6C,CAAC;QAClD,IAAI,oBAA+D,CAAC;QAEpE,IAAI,aAAQ,EAAE,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE;YAChC,UAAQ,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,eAAe,EAAE;gBAChD,mBAAiB,GAAG,IAAI,OAAO,CAAC,UAAC,OAAO;oBACtC,oBAAkB,GAAG,UAAC,IAAuB,IAAK,OAAA,OAAO,CAAC,IAAI,CAAC,EAAb,CAAa,CAAC;gBAClE,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YAEH,wCAA0B,CAAC,gBAAgB,CAAC,UAAQ,CAAC,CAAC,OAAO,CAAC,GAAG,CAC/D,cAAc,EACd,UAAC,WAAoB,EAAE,KAAc;gBACnC,IAAM,OAAO,0CAAO,WAAW,WAAK,KAAK,EAAC,CAAC;gBAC3C,IAAM,MAAM,GAAG,UAAC,KAAY,IAAK,OAAG,KAAK,CAAC,IAAI,UAAK,4CAAmB,CAAC,KAAK,CAAG,EAA9C,CAA8C,CAAC;gBAEhF,IAAI,oBAAkB,EAAE;oBACtB,oBAAkB,CAAC;wBACjB,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,UAAC,GAAG,IAAK,OAAA,GAAG,CAAC,QAAQ,KAAK,OAAO,EAAxB,CAAwB,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC;wBACrE,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,UAAC,GAAG,IAAK,OAAA,GAAG,CAAC,QAAQ,KAAK,SAAS,EAA1B,CAA0B,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC;qBAC1E,CAAC,CAAC;iBACJ;YACH,CAAC,CACF,CAAC;SACH;QAED,wFAAwF;QACxF,UAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE;YACpC,uBAAM,CAAC,aAAa,EAAE,CAAC;YACvB,uBAAM,CAAC,IAAI,CAAC,oBAAkB,aAAQ,EAAE,CAAC,GAAG,CAAC,IAAI,OAAI,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;QAEH,UAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,UAAO,KAAK;;;;;;wBACpC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;6BAEtE,CAAA,aAAQ,EAAE,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAA,EAAlD,wBAAkD;wBAC9C,UAAU,GAAG,UAAU,CAAC;4BAC5B,uBAAM,CAAC,MAAM,CAAC,yCAAyC,CAAC,CAAC;wBAC3D,CAAC,EAAE,GAAG,CAAC,CAAC;wBACS,qBAAM,mBAAiB,EAAA;;wBAAlC,QAAQ,GAAG,SAAuB;wBACxC,YAAY,CAAC,UAAU,CAAC,CAAC;wBAEzB,uCAAuC;wBACvC,CAAA,KAAA,MAAM,CAAC,MAAM,CAAA,CAAC,IAAI,oCAAI,QAAQ,CAAC,MAAM,IAAE;wBACvC,CAAA,KAAA,KAAK,CAAC,WAAW,CAAC,MAAM,CAAA,CAAC,IAAI,oCAAI,QAAQ,CAAC,MAAM,IAAE;wBAClD,CAAA,KAAA,MAAM,CAAC,QAAQ,CAAA,CAAC,IAAI,oCAAI,QAAQ,CAAC,QAAQ,IAAE;wBAC3C,CAAA,KAAA,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAA,CAAC,IAAI,oCAAI,QAAQ,CAAC,QAAQ,IAAE;wBAEtD,UAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;;;wBAG/D,MAAM,GAAG,uBAAkB,EAAE,CAAC;wBAEpC,0DAA0D;wBAC1D,IAAI,kBAAkB,EAAE;4BACtB,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,aAAQ,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;4BAC/C,kBAAa,CAAC,MAAM,EAAE,gBAAW,EAAE,CAAC,oBAAoB,CAAC,CAAC;yBAC3D;wBAED,6DAA6D;wBAC7D,SAAS,CAAC;4BACR,MAAM,QAAA;4BACN,OAAO,EAAE,aAAQ,EAAE,CAAC,GAAG,CAAC,IAAI;4BAC5B,gBAAgB,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,KAAK,MAAM,CAAC,aAAa,CAAC,MAAM;yBACxE,CAAC,CAAC;;;;aACJ,CAAC,CAAC;QAEH,OAAO,UAAQ,CAAC;KACjB;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAI,wBAAe,CAAC,0CAAwC,GAAG,CAAC,OAAS,CAAC,CAAC;KAClF;AACH,CAAC,EAAC;AAEF;;;;;;GAMG;AACI,IAAM,gBAAgB,GAAG,UAC9B,IAAY,EACZ,YAAsB,EACtB,cAAuB,EACvB,SAAkB;IAEZ,IAAA,KAAqB,6BAAsB,CAAC,IAAI,CAAC,EAA/C,KAAK,WAAA,EAAE,OAAO,aAAiC,CAAC;IACxD,IAAM,aAAa,GAAa,EAAE,CAAC;IACnC,IAAM,gBAAgB,GAAG,UAAC,IAAc;QACtC,IAAI,CAAC,OAAO,CAAC,UAAC,CAAC;YACb,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,EAAjB,CAAiB,CAAC,EAAE;gBACjD,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;aACvB;QACH,CAAC,CAAC,CAAC;QAEH,uBAAM,CAAC,aAAa,EAAE,CAAC;QACvB,4BAAmB,CAAC,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,SAAS,CAAC,CAAC;IAC9E,CAAC,CAAC;IAEF,OAAO;QACL,eAAe,EAAE,gBAAgB;QACjC,SAAS,EAAE,UAAC,EAAmB;gBAAjB,MAAM,YAAA,EAAE,OAAO,aAAA;YAC3B,uBAAM,CAAC,aAAa,EAAE,CAAC;YACvB,OAAO,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC;YAE1B,IAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAhD,CAAgD,CAAC,CAAC;YAC3G,IAAI,YAAY,EAAE;gBAChB,IAAI,cAAc,EAAE;oBAClB,gBAAgB,CAAC,EAAE,CAAC,CAAC;iBACtB;gBACD,OAAO;aACR;YAED,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,UAAC,IAAI;gBAChC,IAAM,SAAS,GAAG,iCAAqB,CAAC;oBACtC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM;oBAC5B,QAAQ,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,QAAQ;iBACjC,CAAC,CAAC;gBAEH,iCAAiC;gBACjC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE;oBAC/B;;;uBAGG;oBACH,SAAS,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;oBAE5B,uBAAM,CAAC,KAAK,CAAC,8BAA4B,uBAAM,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,MAAG,CAAC,CAAC;oBAC1E,uBAAM,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;oBACzC,uBAAM,CAAC,OAAO,EAAE,CAAC;oBACjB,OAAO;iBACR;gBAED,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE;oBACjC,uBAAM,CAAC,OAAO,CAAC,qBAAmB,uBAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,sBAAmB,CAAC,CAAC;oBACtF,uBAAM,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;oBAC3C,uBAAM,CAAC,OAAO,EAAE,CAAC;iBAClB;YACH,CAAC,CAAC,CAAC;QACL,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AA7DW,QAAA,gBAAgB,oBA6D3B"}

package/dist/devServer/ipcServer.d.ts

@@ -0,0 +1,83 @@
+import webpack from 'webpack';
+import ToJsonOutput = webpack.Stats.ToJsonOutput;
+export declare enum IPCType {
+    onCompileComplete = "onCompileComplete",
+    onDevServerCrashed = "onDevServerCrashed",
+    onEmitAllCompilesComplete = "onEmitAllCompilesComplete"
+}
+export interface OnCompileCompletePayload {
+    result: ToJsonOutput;
+    appName: string;
+    lastPluginBundle: boolean;
+}
+export interface OnDevServerCrashedPayload {
+    exception: {
+        message: string;
+        stack?: string;
+    };
+}
+export interface IPCPayload {
+    onCompileComplete: OnCompileCompletePayload;
+    onDevServerCrashed: OnDevServerCrashedPayload;
+    onEmitAllCompilesComplete: unknown;
+}
+declare type MessageCallback<T extends IPCType> = (payload: IPCPayload[T]) => void;
+export declare const isServerRunning: () => boolean;
+export declare const isClientConnected: () => boolean;
+/**
+ * Processes the emit queue
+ * @private
+ */
+export declare const _processEmitQueue: () => Promise<void>;
+/**
+ * Processes the on server message
+ * @param data
+ * @private
+ */
+export declare const _onServerMessage: (data: {
+    payload: unknown;
+    type: string;
+}) => void;
+/**
+ * Processes on client connected
+ * @private
+ */
+export declare const _onClientConnected: () => Promise<void>;
+/**
+ * Emits to the server
+ * @param type      the event type
+ * @param payload   the event payload
+ * @private
+ */
+export declare const _emitToServer: <T extends IPCType>(type: T, payload: IPCPayload[T]) => Promise<void>;
+/**
+ * Starts an IPC server
+ */
+export declare const startIPCServer: () => void;
+/**
+ * Starts an IPC Client
+ */
+export declare const startIPCClient: () => void;
+/**
+ * onMessage event for the IPC server
+ * @param type
+ * @param callback
+ */
+export declare const onIPCServerMessage: <T extends IPCType>(type: T, callback: MessageCallback<T>) => void;
+/**
+ * Emits to the server that all of the JS Bundles have completed compiling
+ * @param payload
+ * @returns
+ */
+export declare const emitAllCompilesComplete: () => Promise<void>;
+/**
+ * Emits a compilation complete event
+ * @param payload
+ */
+export declare const emitCompileComplete: (payload: OnCompileCompletePayload) => Promise<void>;
+/**
+ * Emits a dev-server failed event
+ * @param error
+ */
+export declare const emitDevServerCrashed: (error: Error) => Promise<void>;
+export {};

package/dist/devServer/ipcServer.js

@@ -0,0 +1,227 @@
+"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 });
+exports.emitDevServerCrashed = exports.emitCompileComplete = exports.emitAllCompilesComplete = exports.onIPCServerMessage = exports.startIPCClient = exports.startIPCServer = exports._emitToServer = exports._onClientConnected = exports._onServerMessage = exports._processEmitQueue = exports.isClientConnected = exports.isServerRunning = exports.IPCType = void 0;
+var node_ipc_1 = __importDefault(require("node-ipc"));
+var flex_dev_utils_1 = require("@twilio/flex-dev-utils");
+var IPCType;
+(function (IPCType) {
+    IPCType["onCompileComplete"] = "onCompileComplete";
+    IPCType["onDevServerCrashed"] = "onDevServerCrashed";
+    IPCType["onEmitAllCompilesComplete"] = "onEmitAllCompilesComplete";
+})(IPCType = exports.IPCType || (exports.IPCType = {}));
+node_ipc_1.default.config.id = 'twilio.flex.plugin-builder';
+node_ipc_1.default.config.retry = 1500;
+node_ipc_1.default.config.silent = !flex_dev_utils_1.env.isDebug();
+var _isServerRunning = false;
+var _isClientConnected = false;
+/* istanbul ignore next */
+var isServerRunning = function () { return _isServerRunning; };
+exports.isServerRunning = isServerRunning;
+/* istanbul ignore next */
+var isClientConnected = function () { return _isClientConnected; };
+exports.isClientConnected = isClientConnected;
+var clientNode = null;
+var messageCallbacks = {};
+/*
+ * This is used only to set the type of this queue
+ * This is the only way to get dynamic typing in TS :(
+ */
+var getEmitItem = function (type, payload) { return ({ type: type, payload: payload }); };
+var emitQueue = [getEmitItem()].slice(1);
+/**
+ * Processes the emit queue
+ * @private
+ */
+/* istanbul ignore next */
+var _processEmitQueue = function () { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        if (!exports.isClientConnected()) {
+            return [2 /*return*/];
+        }
+        while (emitQueue.length) {
+            clientNode.emit('message', emitQueue.pop());
+        }
+        return [2 /*return*/];
+    });
+}); };
+exports._processEmitQueue = _processEmitQueue;
+/**
+ * Processes the on server message
+ * @param data
+ * @private
+ */
+var _onServerMessage = function (data) {
+    if (!data.type) {
+        flex_dev_utils_1.logger.error('IPC got an unexpected message: ', data);
+        return;
+    }
+    Object.keys(messageCallbacks)
+        .filter(function (type) { return type === data.type; })
+        .forEach(function (type) {
+        var _a;
+        if (messageCallbacks[type]) {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            (_a = messageCallbacks[type]) === null || _a === void 0 ? void 0 : _a.forEach(function (cb) { return cb(data.payload); });
+        }
+    });
+};
+exports._onServerMessage = _onServerMessage;
+/**
+ * Processes on client connected
+ * @private
+ */
+var _onClientConnected = function () { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                _isClientConnected = true;
+                return [4 /*yield*/, exports._processEmitQueue()];
+            case 1:
+                _a.sent();
+                return [2 /*return*/];
+        }
+    });
+}); };
+exports._onClientConnected = _onClientConnected;
+/**
+ * Emits to the server
+ * @param type      the event type
+ * @param payload   the event payload
+ * @private
+ */
+var _emitToServer = function (type, payload) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                emitQueue.push({ type: type, payload: payload });
+                return [4 /*yield*/, exports._processEmitQueue()];
+            case 1:
+                _a.sent();
+                return [2 /*return*/];
+        }
+    });
+}); };
+exports._emitToServer = _emitToServer;
+/**
+ * Starts an IPC server
+ */
+var startIPCServer = function () {
+    if (exports.isServerRunning()) {
+        return;
+    }
+    node_ipc_1.default.serve(function () { return node_ipc_1.default.server.on('message', exports._onServerMessage); });
+    node_ipc_1.default.server.start();
+    _isServerRunning = true;
+};
+exports.startIPCServer = startIPCServer;
+/**
+ * Starts an IPC Client
+ */
+var startIPCClient = function () {
+    if (exports.isClientConnected()) {
+        return;
+    }
+    node_ipc_1.default.connectTo(node_ipc_1.default.config.id, function () {
+        clientNode = node_ipc_1.default.of[node_ipc_1.default.config.id];
+        clientNode.on('connect', exports._onClientConnected);
+    });
+};
+exports.startIPCClient = startIPCClient;
+/**
+ * onMessage event for the IPC server
+ * @param type
+ * @param callback
+ */
+/* istanbul ignore next */
+var onIPCServerMessage = function (type, callback) {
+    if (!(type in messageCallbacks)) {
+        messageCallbacks[type] = [];
+    }
+    // @ts-ignore
+    messageCallbacks[type].push(callback);
+};
+exports.onIPCServerMessage = onIPCServerMessage;
+/**
+ * Emits to the server that all of the JS Bundles have completed compiling
+ * @param payload
+ * @returns
+ */
+var emitAllCompilesComplete = function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+    return [2 /*return*/, exports._emitToServer(IPCType.onEmitAllCompilesComplete, {})];
+}); }); };
+exports.emitAllCompilesComplete = emitAllCompilesComplete;
+/**
+ * Emits a compilation complete event
+ * @param payload
+ */
+var emitCompileComplete = function (payload) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [4 /*yield*/, exports._emitToServer(IPCType.onCompileComplete, payload)];
+            case 1:
+                _a.sent();
+                if (!payload.lastPluginBundle) return [3 /*break*/, 3];
+                return [4 /*yield*/, exports.emitAllCompilesComplete()];
+            case 2:
+                _a.sent();
+                _a.label = 3;
+            case 3: return [2 /*return*/];
+        }
+    });
+}); };
+exports.emitCompileComplete = emitCompileComplete;
+/**
+ * Emits a dev-server failed event
+ * @param error
+ */
+var emitDevServerCrashed = function (error) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, exports._emitToServer(IPCType.onDevServerCrashed, {
+                exception: {
+                    message: error.message,
+                    stack: error.stack,
+                },
+            })];
+    });
+}); };
+exports.emitDevServerCrashed = emitDevServerCrashed;
+//# sourceMappingURL=ipcServer.js.map

package/dist/devServer/ipcServer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ipcServer.js","sourceRoot":"","sources":["../../src/devServer/ipcServer.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sDAA2B;AAC3B,yDAAqD;AAUrD,IAAY,OAIX;AAJD,WAAY,OAAO;IACjB,kDAAuC,CAAA;IACvC,oDAAyC,CAAA;IACzC,kEAAuD,CAAA;AACzD,CAAC,EAJW,OAAO,GAAP,eAAO,KAAP,eAAO,QAIlB;AAwBD,kBAAG,CAAC,MAAM,CAAC,EAAE,GAAG,4BAA4B,CAAC;AAC7C,kBAAG,CAAC,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC;AACxB,kBAAG,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,oBAAG,CAAC,OAAO,EAAE,CAAC;AAEnC,IAAI,gBAAgB,GAAY,KAAK,CAAC;AACtC,IAAI,kBAAkB,GAAY,KAAK,CAAC;AACxC,0BAA0B;AACnB,IAAM,eAAe,GAAG,cAAe,OAAA,gBAAgB,EAAhB,CAAgB,CAAC;AAAlD,QAAA,eAAe,mBAAmC;AAC/D,0BAA0B;AACnB,IAAM,iBAAiB,GAAG,cAAe,OAAA,kBAAkB,EAAlB,CAAkB,CAAC;AAAtD,QAAA,iBAAiB,qBAAqC;AAEnE,IAAI,UAAU,GAAkB,IAAI,CAAC;AACrC,IAAM,gBAAgB,GAAqB,EAAE,CAAC;AAE9C;;;GAGG;AACH,IAAM,WAAW,GAAG,UAAoB,IAAQ,EAAE,OAAuB,IAAK,OAAA,CAAC,EAAE,IAAI,MAAA,EAAE,OAAO,SAAA,EAAE,CAAC,EAAnB,CAAmB,CAAC;AAClG,IAAM,SAAS,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAE3C;;;GAGG;AACH,0BAA0B;AACnB,IAAM,iBAAiB,GAAG;;QAC/B,IAAI,CAAC,yBAAiB,EAAE,EAAE;YACxB,sBAAO;SACR;QAED,OAAO,SAAS,CAAC,MAAM,EAAE;YACtB,UAAqB,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,GAAG,EAAE,CAAC,CAAC;SACzD;;;KACF,CAAC;AARW,QAAA,iBAAiB,qBAQ5B;AAEF;;;;GAIG;AACI,IAAM,gBAAgB,GAAG,UAAC,IAAwC;IACvE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;QACd,uBAAM,CAAC,KAAK,CAAC,iCAAiC,EAAE,IAAI,CAAC,CAAC;QACtD,OAAO;KACR;IAED,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC;SAC1B,MAAM,CAAC,UAAC,IAAI,IAAK,OAAA,IAAI,KAAK,IAAI,CAAC,IAAI,EAAlB,CAAkB,CAAC;SACpC,OAAO,CAAC,UAAC,IAAI;;QACZ,IAAI,gBAAgB,CAAC,IAAe,CAAC,EAAE;YACrC,8DAA8D;YAC9D,MAAA,gBAAgB,CAAC,IAAe,CAAC,0CAAE,OAAO,CAAC,UAAC,EAAwB,IAAK,OAAA,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,EAAhB,CAAgB,CAAC,CAAC;SAC5F;IACH,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AAdW,QAAA,gBAAgB,oBAc3B;AAEF;;;GAGG;AACI,IAAM,kBAAkB,GAAG;;;;gBAChC,kBAAkB,GAAG,IAAI,CAAC;gBAC1B,qBAAM,yBAAiB,EAAE,EAAA;;gBAAzB,SAAyB,CAAC;;;;KAC3B,CAAC;AAHW,QAAA,kBAAkB,sBAG7B;AAEF;;;;;GAKG;AACI,IAAM,aAAa,GAAG,UAA0B,IAAO,EAAE,OAAsB;;;;gBACpF,SAAS,CAAC,IAAI,CAAC,EAAE,IAAI,MAAA,EAAE,OAAO,SAAA,EAAE,CAAC,CAAC;gBAClC,qBAAM,yBAAiB,EAAE,EAAA;;gBAAzB,SAAyB,CAAC;;;;KAC3B,CAAC;AAHW,QAAA,aAAa,iBAGxB;AAEF;;GAEG;AACI,IAAM,cAAc,GAAG;IAC5B,IAAI,uBAAe,EAAE,EAAE;QACrB,OAAO;KACR;IAED,kBAAG,CAAC,KAAK,CAAC,cAAM,OAAA,kBAAG,CAAC,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,wBAAgB,CAAC,EAA1C,CAA0C,CAAC,CAAC;IAC5D,kBAAG,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;IAEnB,gBAAgB,GAAG,IAAI,CAAC;AAC1B,CAAC,CAAC;AATW,QAAA,cAAc,kBASzB;AAEF;;GAEG;AACI,IAAM,cAAc,GAAG;IAC5B,IAAI,yBAAiB,EAAE,EAAE;QACvB,OAAO;KACR;IAED,kBAAG,CAAC,SAAS,CAAC,kBAAG,CAAC,MAAM,CAAC,EAAE,EAAE;QAC3B,UAAU,GAAG,kBAAG,CAAC,EAAE,CAAC,kBAAG,CAAC,MAAM,CAAC,EAAE,CAAW,CAAC;QAC7C,UAAU,CAAC,EAAE,CAAC,SAAS,EAAE,0BAAkB,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AATW,QAAA,cAAc,kBASzB;AAEF;;;;GAIG;AACH,0BAA0B;AACnB,IAAM,kBAAkB,GAAG,UAAoB,IAAO,EAAE,QAA4B;IACzF,IAAI,CAAC,CAAC,IAAI,IAAI,gBAAgB,CAAC,EAAE;QAC/B,gBAAgB,CAAC,IAAe,CAAC,GAAG,EAAE,CAAC;KACxC;IACD,aAAa;IACb,gBAAgB,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AACxC,CAAC,CAAC;AANW,QAAA,kBAAkB,sBAM7B;AAEF;;;;GAIG;AACI,IAAM,uBAAuB,GAAG;IAA2B,sBAAA,qBAAa,CAAC,OAAO,CAAC,yBAAyB,EAAE,EAAE,CAAC,EAAA;SAAA,CAAC;AAA1G,QAAA,uBAAuB,2BAAmF;AAEvH;;;GAGG;AACI,IAAM,mBAAmB,GAAG,UAAO,OAAiC;;;oBACzE,qBAAM,qBAAa,CAAC,OAAO,CAAC,iBAAiB,EAAE,OAAO,CAAC,EAAA;;gBAAvD,SAAuD,CAAC;qBACpD,OAAO,CAAC,gBAAgB,EAAxB,wBAAwB;gBAC1B,qBAAM,+BAAuB,EAAE,EAAA;;gBAA/B,SAA+B,CAAC;;;;;KAEnC,CAAC;AALW,QAAA,mBAAmB,uBAK9B;AAEF;;;GAGG;AACI,IAAM,oBAAoB,GAAG,UAAO,KAAY;;QACrD,sBAAA,qBAAa,CAAC,OAAO,CAAC,kBAAkB,EAAE;gBACxC,SAAS,EAAE;oBACT,OAAO,EAAE,KAAK,CAAC,OAAO;oBACtB,KAAK,EAAE,KAAK,CAAC,KAAK;iBACnB;aACF,CAAC,EAAA;;KAAA,CAAC;AANQ,QAAA,oBAAoB,wBAM5B"}