@webiny/plugins 0.0.0-mt-1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Webiny
+
+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/Plugin.d.ts

@@ -0,0 +1,6 @@
+export declare abstract class Plugin {
+    static readonly type: string;
+    name: string;
+    constructor();
+    get type(): string;
+}

package/Plugin.js

@@ -0,0 +1,28 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Plugin = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+class Plugin {
+  constructor() {
+    (0, _defineProperty2.default)(this, "name", void 0);
+
+    if (!this.constructor.type) {
+      throw Error(`Missing "type" definition in "${this.constructor.name}"!`);
+    }
+  }
+
+  get type() {
+    return this.constructor.type;
+  }
+
+}
+
+exports.Plugin = Plugin;
+(0, _defineProperty2.default)(Plugin, "type", void 0);

package/PluginsContainer.d.ts

@@ -0,0 +1,14 @@
+import { Plugin } from "./types";
+export declare class PluginsContainer {
+    private plugins;
+    private _byTypeCache;
+    constructor(...args: any[]);
+    byName<T extends Plugin>(name: T["name"]): T;
+    byType<T extends Plugin>(type: T["type"]): T[];
+    atLeastOneByType<T extends Plugin>(type: T["type"]): T[];
+    oneByType<T extends Plugin>(type: T["type"]): T;
+    all<T extends Plugin>(): T[];
+    register(...args: any): void;
+    unregister(name: string): void;
+    private findByType;
+}

package/PluginsContainer.js

@@ -0,0 +1,113 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.PluginsContainer = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _uniqid = _interopRequireDefault(require("uniqid"));
+
+const isOptionsObject = item => item && !Array.isArray(item) && !item.type && !item.name;
+
+const normalizeArgs = args => {
+  let options = {}; // Check if last item in the plugins array is actually an options object.
+
+  if (isOptionsObject(args[args.length - 1])) {
+    [options] = args.splice(-1, 1);
+  }
+
+  return [args, options];
+};
+
+const assign = (plugins, options, target) => {
+  for (let i = 0; i < plugins.length; i++) {
+    const plugin = plugins[i];
+
+    if (Array.isArray(plugin)) {
+      assign(plugin, options, target);
+      continue;
+    }
+
+    let name = plugin._name || plugin.name;
+
+    if (!name) {
+      plugin.name = name = (0, _uniqid.default)(plugin.type + "-");
+    } // If skip existing was set to true, and a plugin with the same name was already registered, skip registration.
+
+
+    if (!options.skipExisting || !target[name]) {
+      target[name] = plugin;
+      plugin.init && plugin.init();
+    }
+  }
+};
+
+class PluginsContainer {
+  constructor(...args) {
+    (0, _defineProperty2.default)(this, "plugins", {});
+    (0, _defineProperty2.default)(this, "_byTypeCache", {});
+    this.register(...args);
+  }
+
+  byName(name) {
+    return this.plugins[name];
+  }
+
+  byType(type) {
+    if (this._byTypeCache[type]) {
+      return Array.from(this._byTypeCache[type]);
+    }
+
+    const plugins = this.findByType(type);
+    this._byTypeCache[type] = plugins;
+    return Array.from(plugins);
+  }
+
+  atLeastOneByType(type) {
+    const list = this.byType(type);
+
+    if (list.length === 0) {
+      throw new Error(`There are no plugins by type "${type}".`);
+    }
+
+    return list;
+  }
+
+  oneByType(type) {
+    const list = this.atLeastOneByType(type);
+
+    if (list.length > 1) {
+      throw new Error(`There is a requirement for plugin of type "${type}" to be only one registered.`);
+    }
+
+    return list[0];
+  }
+
+  all() {
+    return Object.values(this.plugins);
+  }
+
+  register(...args) {
+    // reset the cache when adding new plugins
+    this._byTypeCache = {};
+    const [plugins, options] = normalizeArgs(args);
+    assign(plugins, options, this.plugins);
+  }
+
+  unregister(name) {
+    // reset the cache when removing a plugin
+    this._byTypeCache = {};
+    delete this.plugins[name];
+  }
+
+  findByType(type) {
+    return Object.values(this.plugins).filter(pl => pl.type === type);
+  }
+
+}
+
+exports.PluginsContainer = PluginsContainer;

package/README.md

@@ -0,0 +1,74 @@
+# @webiny/plugins
+[![](https://img.shields.io/npm/dw/@webiny/plugins.svg)](https://www.npmjs.com/package/@webiny/plugins) 
+[![](https://img.shields.io/npm/v/@webiny/plugins.svg)](https://www.npmjs.com/package/@webiny/plugins)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
+
+A simple registry that stores all plugins in a shared object.
+The only requirement for a plugin is to have a `name` and a `type` properties. 
+The rest is entirely up to you.
+
+There is nothing spectacular going on under the hood, just a simple 
+object for storing references and a few utility functions.
+
+For more information, please visit [the official docs](https://docs.webiny.com/docs/developer-tutorials/plugins-crash-course).
+  
+## Install
+```
+npm install --save @webiny/plugins
+```
+
+Or if you prefer yarn: 
+```
+yarn add @webiny/plugins
+```
+
+## Usage
+
+### Adding a plugin
+```
+import { plugins } from "@webiny/plugins";
+
+// Add a plugin
+plugins.register({
+    name: "my-plugin",
+    type: "say-hi",
+    salute: () => "Hi!"
+});
+
+plugins.register({
+    name: "my-second-plugin",
+    type: "say-hi",
+    salute: () => "Yo!"
+});
+```
+
+### Getting plugins by type
+```
+// anywhere in your app
+import { plugins } from "@webiny/plugins";
+
+const pluginList = plugins.byType("say-hi");
+pluginList.forEach(plugin => {
+    // Call "salute" function
+    plugin.salute();
+});
+```
+
+### Getting a single plugin by name
+```
+// anywhere in your app
+import { plugins } from "@webiny/plugins";
+
+const plugin = plugins.byName("my-plugin");
+// Call "salute" function
+plugin.salute();
+```
+
+### Removing a plugin
+```
+// anywhere in your app
+import { plugins } from "@webiny/plugins";
+
+plugins.unregister("my-plugin");
+```

package/index.d.ts

@@ -0,0 +1,4 @@
+import { PluginsContainer } from "./PluginsContainer";
+import { Plugin } from "./Plugin";
+declare const plugins: PluginsContainer;
+export { Plugin, PluginsContainer, plugins };

package/index.js

@@ -0,0 +1,25 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "Plugin", {
+  enumerable: true,
+  get: function () {
+    return _Plugin.Plugin;
+  }
+});
+Object.defineProperty(exports, "PluginsContainer", {
+  enumerable: true,
+  get: function () {
+    return _PluginsContainer.PluginsContainer;
+  }
+});
+exports.plugins = void 0;
+
+var _PluginsContainer = require("./PluginsContainer");
+
+var _Plugin = require("./Plugin");
+
+const plugins = new _PluginsContainer.PluginsContainer();
+exports.plugins = plugins;

package/package.json

@@ -0,0 +1,36 @@
+{
+	"name": "@webiny/plugins",
+	"version": "0.0.0-mt-1",
+	"main": "index.js",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/webiny/webiny-js.git"
+	},
+	"description": "A simple registry that stores all plugins in a shared object.",
+	"contributors": [
+		"Pavel Denisjuk <pavel@webiny.com>",
+		"Adrian Smijulj <adrian@webiny.com>"
+	],
+	"license": "MIT",
+	"dependencies": {
+		"@babel/runtime": "7.15.4",
+		"uniqid": "5.4.0"
+	},
+	"devDependencies": {
+		"@babel/cli": "^7.5.5",
+		"@babel/core": "^7.5.5",
+		"@webiny/cli": "^0.0.0-mt-1",
+		"@webiny/project-utils": "^0.0.0-mt-1",
+		"rimraf": "^3.0.2",
+		"typescript": "^4.1.3"
+	},
+	"publishConfig": {
+		"access": "public",
+		"directory": "dist"
+	},
+	"scripts": {
+		"build": "yarn webiny run build",
+		"watch": "yarn webiny run watch"
+	},
+	"gitHead": "37736d8456a6ecb342a6c3645060bd9a3f2d4bb0"
+}

package/types.d.ts

@@ -0,0 +1,8 @@
+export { PluginsContainer } from "./PluginsContainer";
+export declare type Plugin<T = Record<string, any>> = {
+    type: string;
+    name?: string;
+    init?: () => void;
+    [key: string]: any;
+} & T;
+export declare type PluginCollection = (Plugin | PluginCollection)[];

package/types.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "PluginsContainer", {
+  enumerable: true,
+  get: function () {
+    return _PluginsContainer.PluginsContainer;
+  }
+});
+
+var _PluginsContainer = require("./PluginsContainer");