@webiny/plugins

@webiny/plugins

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.

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");

Changelog

5.18.0-beta.4 (2021-11-23)

Bug Fixes

• api-cognito-authenticator: make sure token is a string (bfa4422)
• api-security: handle parallel calls to getPermissions (170418d)
• api-security: use storage operations in authn/authz plugins (b123cf3)
• api-security-okta: make sure token is a string (dc96794)
• add TS ignore (12129a5)
• change port to 3002 (fcf755d)
• exit if no packages detected (f3bb8c7)
• improve error logging (59b5023)
• improve error logging (eed9759)
• remove extra "s" (848b331)
• remove PORT env variable (d08b03b)
• remove unused variables (558fbb8)
• temporarily disable the new "Action" page element (c20d44b)
• use correct functions (b987fe4)
• use output.log (f4662a0)
• api-prerendering-service: remove storageOperations from db record (0b7d497)