@webiny/plugins 5.24.0 → 5.25.0-beta.2

package/Plugin.d.ts

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

package/Plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["Plugin.ts"],"names":["Plugin","constructor","type","Error","name"],"mappings":";;;;;;;;;;;AAAO,MAAeA,MAAf,CAAsB;AAIzBC,EAAAA,WAAW,GAAG;AAAA;;AACV,QAAI,CAAE,KAAKA,WAAN,CAAoCC,IAAzC,EAA+C;AAC3C,YAAMC,KAAK,CAAE,iCAAgC,KAAKF,WAAL,CAAiBG,IAAK,IAAxD,CAAX;AACH;AACJ;;AAEO,MAAJF,IAAI,GAAG;AACP,WAAQ,KAAKD,WAAN,CAAoCC,IAA3C;AACH;;AAZwB;;;8BAAPF,M","sourcesContent":["export abstract class Plugin {\n    public static readonly type: string;\n    public name?: string;\n\n    constructor() {\n        if (!(this.constructor as typeof Plugin).type) {\n            throw Error(`Missing \"type\" definition in \"${this.constructor.name}\"!`);\n        }\n    }\n\n    get type() {\n        return (this.constructor as typeof Plugin).type;\n    }\n}\n"]}

package/PluginsContainer.d.ts

@@ -3,7 +3,7 @@ export declare class PluginsContainer {
     private plugins;
     private _byTypeCache;
     constructor(...args: PluginCollection);
-    byName<T extends Plugin>(name: T["name"]): T;
+    byName<T extends Plugin>(name: T["name"]): T | null;
     byType<T extends Plugin>(type: T["type"]): T[];
     atLeastOneByType<T extends Plugin>(type: T["type"]): T[];
     oneByType<T extends Plugin>(type: T["type"]): T;

package/PluginsContainer.js

@@ -54,6 +54,14 @@ class PluginsContainer {
   }
 
   byName(name) {
+    if (!name) {
+      return null;
+    }
+    /**
+     * We can safely cast name as string, we know it is so.
+     */
+
+
     return this.plugins[name];
   }
 

package/PluginsContainer.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["PluginsContainer.ts"],"names":["isOptionsObject","item","Array","isArray","type","name","normalizeArgs","args","options","length","splice","assign","plugins","target","i","plugin","_name","skipExisting","init","PluginsContainer","constructor","register","byName","byType","_byTypeCache","from","findByType","atLeastOneByType","list","Error","oneByType","all","Object","values","unregister","filter","pl"],"mappings":";;;;;;;;;;;AACA;;AAEA,MAAMA,eAAe,GAAIC,IAAD,IAAgBA,IAAI,IAAI,CAACC,KAAK,CAACC,OAAN,CAAcF,IAAd,CAAT,IAAgC,CAACA,IAAI,CAACG,IAAtC,IAA8C,CAACH,IAAI,CAACI,IAA5F;;AACA,MAAMC,aAAa,GAAIC,IAAD,IAAiB;AACnC,MAAIC,OAAO,GAAG,EAAd,CADmC,CAGnC;;AACA,MAAIR,eAAe,CAACO,IAAI,CAACA,IAAI,CAACE,MAAL,GAAc,CAAf,CAAL,CAAnB,EAA4C;AACxC,KAACD,OAAD,IAAYD,IAAI,CAACG,MAAL,CAAY,CAAC,CAAb,EAAgB,CAAhB,CAAZ;AACH;;AAED,SAAO,CAACH,IAAD,EAAOC,OAAP,CAAP;AACH,CATD;;AAWA,MAAMG,MAAM,GAAG,CAACC,OAAD,EAAeJ,OAAf,EAA6BK,MAA7B,KAAmE;AAC9E,OAAK,IAAIC,CAAC,GAAG,CAAb,EAAgBA,CAAC,GAAGF,OAAO,CAACH,MAA5B,EAAoCK,CAAC,EAArC,EAAyC;AACrC,UAAMC,MAAM,GAAGH,OAAO,CAACE,CAAD,CAAtB;;AACA,QAAIZ,KAAK,CAACC,OAAN,CAAcY,MAAd,CAAJ,EAA2B;AACvBJ,MAAAA,MAAM,CAACI,MAAD,EAASP,OAAT,EAAkBK,MAAlB,CAAN;AACA;AACH;;AAED,QAAIR,IAAI,GAAGU,MAAM,CAACC,KAAP,IAAgBD,MAAM,CAACV,IAAlC;;AACA,QAAI,CAACA,IAAL,EAAW;AACPU,MAAAA,MAAM,CAACV,IAAP,GAAcA,IAAI,GAAG,qBAAOU,MAAM,CAACX,IAAP,GAAc,GAArB,CAArB;AACH,KAVoC,CAYrC;;;AACA,QAAI,CAACI,OAAO,CAACS,YAAT,IAAyB,CAACJ,MAAM,CAACR,IAAD,CAApC,EAA4C;AACxCQ,MAAAA,MAAM,CAACR,IAAD,CAAN,GAAeU,MAAf;AACAA,MAAAA,MAAM,CAACG,IAAP,IAAeH,MAAM,CAACG,IAAP,EAAf;AACH;AACJ;AACJ,CAnBD;;AAqBO,MAAMC,gBAAN,CAAuB;AAI1BC,EAAAA,WAAW,CAAC,GAAGb,IAAJ,EAA4B;AAAA,mDAHG,EAGH;AAAA,wDAFU,EAEV;AACnC,SAAKc,QAAL,CAAc,GAAGd,IAAjB;AACH;;AAEMe,EAAAA,MAAM,CAAmBjB,IAAnB,EAA8C;AACvD,QAAI,CAACA,IAAL,EAAW;AACP,aAAO,IAAP;AACH;AACD;AACR;AACA;;;AACQ,WAAO,KAAKO,OAAL,CAAaP,IAAb,CAAP;AACH;;AAEMkB,EAAAA,MAAM,CAAmBnB,IAAnB,EAAyC;AAClD,QAAI,KAAKoB,YAAL,CAAkBpB,IAAlB,CAAJ,EAA6B;AACzB,aAAOF,KAAK,CAACuB,IAAN,CAAW,KAAKD,YAAL,CAAkBpB,IAAlB,CAAX,CAAP;AACH;;AACD,UAAMQ,OAAO,GAAG,KAAKc,UAAL,CAAmBtB,IAAnB,CAAhB;AACA,SAAKoB,YAAL,CAAkBpB,IAAlB,IAA0BQ,OAA1B;AACA,WAAOV,KAAK,CAACuB,IAAN,CAAWb,OAAX,CAAP;AACH;;AAEMe,EAAAA,gBAAgB,CAAmBvB,IAAnB,EAAyC;AAC5D,UAAMwB,IAAI,GAAG,KAAKL,MAAL,CAAenB,IAAf,CAAb;;AACA,QAAIwB,IAAI,CAACnB,MAAL,KAAgB,CAApB,EAAuB;AACnB,YAAM,IAAIoB,KAAJ,CAAW,iCAAgCzB,IAAK,IAAhD,CAAN;AACH;;AACD,WAAOwB,IAAP;AACH;;AAEME,EAAAA,SAAS,CAAmB1B,IAAnB,EAAuC;AACnD,UAAMwB,IAAI,GAAG,KAAKD,gBAAL,CAAyBvB,IAAzB,CAAb;;AACA,QAAIwB,IAAI,CAACnB,MAAL,GAAc,CAAlB,EAAqB;AACjB,YAAM,IAAIoB,KAAJ,CACD,8CAA6CzB,IAAK,8BADjD,CAAN;AAGH;;AACD,WAAOwB,IAAI,CAAC,CAAD,CAAX;AACH;;AAEMG,EAAAA,GAAG,GAA0B;AAChC,WAAOC,MAAM,CAACC,MAAP,CAAc,KAAKrB,OAAnB,CAAP;AACH;;AAEMS,EAAAA,QAAQ,CAAC,GAAGd,IAAJ,EAAqB;AAChC;AACA,SAAKiB,YAAL,GAAoB,EAApB;AACA,UAAM,CAACZ,OAAD,EAAUJ,OAAV,IAAqBF,aAAa,CAACC,IAAD,CAAxC;AACAI,IAAAA,MAAM,CAACC,OAAD,EAAUJ,OAAV,EAAmB,KAAKI,OAAxB,CAAN;AACH;;AAEMsB,EAAAA,UAAU,CAAC7B,IAAD,EAAqB;AAClC;AACA,SAAKmB,YAAL,GAAoB,EAApB;AACA,WAAO,KAAKZ,OAAL,CAAaP,IAAb,CAAP;AACH;;AAEOqB,EAAAA,UAAU,CAAmBtB,IAAnB,EAAyC;AACvD,WAAQ4B,MAAM,CAACC,MAAP,CAAc,KAAKrB,OAAnB,CAAD,CAAqCuB,MAArC,CAA4CC,EAAE,IAAIA,EAAE,CAAChC,IAAH,KAAYA,IAA9D,CAAP;AACH;;AAhEyB","sourcesContent":["import { Plugin, PluginCollection } from \"./types\";\nimport uniqid from \"uniqid\";\n\nconst isOptionsObject = (item?: any) => item && !Array.isArray(item) && !item.type && !item.name;\nconst normalizeArgs = (args: any[]) => {\n    let options = {};\n\n    // Check if last item in the plugins array is actually an options object.\n    if (isOptionsObject(args[args.length - 1])) {\n        [options] = args.splice(-1, 1);\n    }\n\n    return [args, options];\n};\n\nconst assign = (plugins: any, options: any, target: Record<string, any>): void => {\n    for (let i = 0; i < plugins.length; i++) {\n        const plugin = plugins[i];\n        if (Array.isArray(plugin)) {\n            assign(plugin, options, target);\n            continue;\n        }\n\n        let name = plugin._name || plugin.name;\n        if (!name) {\n            plugin.name = name = uniqid(plugin.type + \"-\");\n        }\n\n        // If skip existing was set to true, and a plugin with the same name was already registered, skip registration.\n        if (!options.skipExisting || !target[name]) {\n            target[name] = plugin;\n            plugin.init && plugin.init();\n        }\n    }\n};\n\nexport class PluginsContainer {\n    private plugins: Record<string, Plugin> = {};\n    private _byTypeCache: Record<string, Plugin[]> = {};\n\n    constructor(...args: PluginCollection) {\n        this.register(...args);\n    }\n\n    public byName<T extends Plugin>(name: T[\"name\"]): T | null {\n        if (!name) {\n            return null;\n        }\n        /**\n         * We can safely cast name as string, we know it is so.\n         */\n        return this.plugins[name as string] as T;\n    }\n\n    public byType<T extends Plugin>(type: T[\"type\"]): T[] {\n        if (this._byTypeCache[type]) {\n            return Array.from(this._byTypeCache[type]) as T[];\n        }\n        const plugins = this.findByType<T>(type);\n        this._byTypeCache[type] = plugins;\n        return Array.from(plugins);\n    }\n\n    public atLeastOneByType<T extends Plugin>(type: T[\"type\"]): T[] {\n        const list = this.byType<T>(type);\n        if (list.length === 0) {\n            throw new Error(`There are no plugins by type \"${type}\".`);\n        }\n        return list;\n    }\n\n    public oneByType<T extends Plugin>(type: T[\"type\"]): T {\n        const list = this.atLeastOneByType<T>(type);\n        if (list.length > 1) {\n            throw new Error(\n                `There is a requirement for plugin of type \"${type}\" to be only one registered.`\n            );\n        }\n        return list[0];\n    }\n\n    public all<T extends Plugin>(): T[] {\n        return Object.values(this.plugins) as T[];\n    }\n\n    public register(...args: any): void {\n        // reset the cache when adding new plugins\n        this._byTypeCache = {};\n        const [plugins, options] = normalizeArgs(args);\n        assign(plugins, options, this.plugins);\n    }\n\n    public unregister(name: string): void {\n        // reset the cache when removing a plugin\n        this._byTypeCache = {};\n        delete this.plugins[name];\n    }\n\n    private findByType<T extends Plugin>(type: T[\"type\"]): T[] {\n        return (Object.values(this.plugins) as T[]).filter(pl => pl.type === type) as T[];\n    }\n}\n"]}

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["index.ts"],"names":["plugins","PluginsContainer"],"mappings":";;;;;;;;;;;;;;;;;;;AAAA;;AACA;;AAEA,MAAMA,OAAO,GAAG,IAAIC,kCAAJ,EAAhB","sourcesContent":["import { PluginsContainer } from \"./PluginsContainer\";\nimport { Plugin } from \"./Plugin\";\n\nconst plugins = new PluginsContainer();\n\nexport { Plugin, PluginsContainer, plugins };\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@webiny/plugins",
-	"version": "5.24.0",
+	"version": "5.25.0-beta.2",
 	"main": "index.js",
 	"repository": {
 		"type": "git",
@@ -13,17 +13,17 @@
 	],
 	"license": "MIT",
 	"dependencies": {
-		"@babel/runtime": "7.16.7",
+		"@babel/runtime": "7.17.7",
 		"uniqid": "5.4.0"
 	},
 	"devDependencies": {
 		"@babel/cli": "^7.16.0",
 		"@babel/core": "^7.16.0",
 		"@types/uniqid": "^5.3.2",
-		"@webiny/cli": "^5.24.0",
-		"@webiny/project-utils": "^5.24.0",
+		"@webiny/cli": "^5.25.0-beta.2",
+		"@webiny/project-utils": "^5.25.0-beta.2",
 		"rimraf": "^3.0.2",
-		"typescript": "^4.1.3"
+		"typescript": "4.5.5"
 	},
 	"publishConfig": {
 		"access": "public",
@@ -33,5 +33,5 @@
 		"build": "yarn webiny run build",
 		"watch": "yarn webiny run watch"
 	},
-	"gitHead": "be0cbfcaa9247c658c44179af7943cc5d6d71bc7"
+	"gitHead": "ed2f22976af47aea0b6b5d638f8afdc39951b014"
 }

package/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["types.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA","sourcesContent":["export { PluginsContainer } from \"./PluginsContainer\";\n\nexport type Plugin<T = Record<string, any>> = {\n    type: string;\n    name?: string;\n    init?: () => void;\n    [key: string]: any;\n} & T;\n\nexport type PluginCollection = (Plugin | PluginCollection)[];\n"]}