@webiny/handler-client 0.0.0-ee-vpcs.549378cf03

package/HandlerClient.d.ts

@@ -0,0 +1,12 @@
+import { InvokeArgs, ClientContext } from "./types";
+declare class HandlerClient {
+    private readonly plugin;
+    /**
+     * We need the default plugin to later on fetch another plugin than initially selected.
+     * If name of the required plugin is not the default one, fetch new one.
+     */
+    private readonly default;
+    constructor(context: ClientContext);
+    invoke<TInvokeArgsPayload = any, TResponse = any>(params: InvokeArgs<TInvokeArgsPayload>): Promise<TResponse>;
+}
+export default HandlerClient;

package/HandlerClient.js

@@ -0,0 +1,101 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _error = _interopRequireDefault(require("@webiny/error"));
+
+var _HandlerClientPlugin = require("./HandlerClientPlugin");
+
+const defaultPluginName = "handler-client";
+
+const getPluginFetcher = context => {
+  const pl = new _HandlerClientPlugin.HandlerClientPlugin({
+    invoke: async params => {
+      const {
+        name,
+        payload,
+        await: useAwait
+      } = params;
+      const plugin = context.plugins.byName(name);
+
+      if (!plugin) {
+        throw new _error.default(`Could not find "${name}" handler plugin.`);
+      }
+
+      const promise = plugin.invoke(payload);
+
+      if (useAwait === false) {
+        return null;
+      }
+
+      return promise;
+    }
+  });
+  pl.name = defaultPluginName;
+  return pl;
+};
+
+const getHandlerClientPlugin = context => {
+  const plugin = context.plugins.byName("handler-client");
+
+  if (plugin) {
+    return plugin;
+  } // If not specified, use a fallback plugin that fetches different handlers via plugins.
+  // This might also be useful for testing purposes.
+
+
+  return getPluginFetcher(context);
+};
+
+class HandlerClient {
+  /**
+   * We need the default plugin to later on fetch another plugin than initially selected.
+   * If name of the required plugin is not the default one, fetch new one.
+   */
+  constructor(context) {
+    (0, _defineProperty2.default)(this, "plugin", void 0);
+    (0, _defineProperty2.default)(this, "default", void 0);
+    this.plugin = getHandlerClientPlugin(context);
+    this.default = getPluginFetcher(context);
+  }
+
+  async invoke(params) {
+    let plugin = this.plugin;
+
+    if (plugin.canHandle && plugin.canHandle(params) === false) {
+      plugin = this.default;
+    }
+
+    try {
+      return await plugin.invoke(params);
+    } catch (ex) {
+      /**
+       * We collect error that was caught and the description of the invoke, if any.
+       */
+      const data = {
+        error: {
+          message: ex.message,
+          data: ex.data,
+          code: ex.code
+        }
+      };
+
+      if (params.description) {
+        data.description = params.description;
+      }
+
+      throw new _error.default(`An error occurred while trying to invoke another handler with the following params: ${JSON.stringify(params, null, 2)}`, "INVOKE_ERROR", data);
+    }
+  }
+
+}
+
+var _default = HandlerClient;
+exports.default = _default;

package/HandlerClient.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["defaultPluginName","getPluginFetcher","context","pl","HandlerClientPlugin","invoke","params","name","payload","await","useAwait","plugin","plugins","byName","WebinyError","promise","getHandlerClientPlugin","HandlerClient","constructor","default","canHandle","ex","data","error","message","code","description","JSON","stringify"],"sources":["HandlerClient.ts"],"sourcesContent":["import WebinyError from \"@webiny/error\";\nimport { HandlerClientHandlerPlugin, InvokeArgs, ClientContext } from \"./types\";\nimport { HandlerClientPlugin } from \"~/HandlerClientPlugin\";\n\nconst defaultPluginName = \"handler-client\";\n\nconst getPluginFetcher = (context: ClientContext): HandlerClientPlugin => {\n    const pl = new HandlerClientPlugin({\n        invoke: async params => {\n            const { name, payload, await: useAwait } = params;\n            const plugin = context.plugins.byName<HandlerClientHandlerPlugin>(name);\n            if (!plugin) {\n                throw new WebinyError(`Could not find \"${name}\" handler plugin.`);\n            }\n\n            const promise = plugin.invoke(payload);\n            if (useAwait === false) {\n                return null;\n            }\n\n            return promise;\n        }\n    });\n    pl.name = defaultPluginName;\n    return pl;\n};\n\nconst getHandlerClientPlugin = (context: ClientContext): HandlerClientPlugin => {\n    const plugin = context.plugins.byName<HandlerClientPlugin>(\"handler-client\");\n    if (plugin) {\n        return plugin;\n    }\n    // If not specified, use a fallback plugin that fetches different handlers via plugins.\n    // This might also be useful for testing purposes.\n    return getPluginFetcher(context);\n};\n\nclass HandlerClient {\n    private readonly plugin: HandlerClientPlugin;\n    /**\n     * We need the default plugin to later on fetch another plugin than initially selected.\n     * If name of the required plugin is not the default one, fetch new one.\n     */\n    private readonly default: HandlerClientPlugin;\n\n    constructor(context: ClientContext) {\n        this.plugin = getHandlerClientPlugin(context);\n        this.default = getPluginFetcher(context);\n    }\n\n    public async invoke<TInvokeArgsPayload = any, TResponse = any>(\n        params: InvokeArgs<TInvokeArgsPayload>\n    ): Promise<TResponse> {\n        let plugin: HandlerClientPlugin = this.plugin;\n        if (plugin.canHandle && plugin.canHandle(params) === false) {\n            plugin = this.default;\n        }\n        try {\n            return await plugin.invoke(params);\n        } catch (ex) {\n            /**\n             * We collect error that was caught and the description of the invoke, if any.\n             */\n            const data: Record<string, any> = {\n                error: {\n                    message: ex.message,\n                    data: ex.data,\n                    code: ex.code\n                }\n            };\n            if (params.description) {\n                data.description = params.description;\n            }\n            throw new WebinyError(\n                `An error occurred while trying to invoke another handler with the following params: ${JSON.stringify(\n                    params,\n                    null,\n                    2\n                )}`,\n                \"INVOKE_ERROR\",\n                data\n            );\n        }\n    }\n}\n\nexport default HandlerClient;\n"],"mappings":";;;;;;;;;;;AAAA;;AAEA;;AAEA,MAAMA,iBAAiB,GAAG,gBAA1B;;AAEA,MAAMC,gBAAgB,GAAIC,OAAD,IAAiD;EACtE,MAAMC,EAAE,GAAG,IAAIC,wCAAJ,CAAwB;IAC/BC,MAAM,EAAE,MAAMC,MAAN,IAAgB;MACpB,MAAM;QAAEC,IAAF;QAAQC,OAAR;QAAiBC,KAAK,EAAEC;MAAxB,IAAqCJ,MAA3C;MACA,MAAMK,MAAM,GAAGT,OAAO,CAACU,OAAR,CAAgBC,MAAhB,CAAmDN,IAAnD,CAAf;;MACA,IAAI,CAACI,MAAL,EAAa;QACT,MAAM,IAAIG,cAAJ,CAAiB,mBAAkBP,IAAK,mBAAxC,CAAN;MACH;;MAED,MAAMQ,OAAO,GAAGJ,MAAM,CAACN,MAAP,CAAcG,OAAd,CAAhB;;MACA,IAAIE,QAAQ,KAAK,KAAjB,EAAwB;QACpB,OAAO,IAAP;MACH;;MAED,OAAOK,OAAP;IACH;EAd8B,CAAxB,CAAX;EAgBAZ,EAAE,CAACI,IAAH,GAAUP,iBAAV;EACA,OAAOG,EAAP;AACH,CAnBD;;AAqBA,MAAMa,sBAAsB,GAAId,OAAD,IAAiD;EAC5E,MAAMS,MAAM,GAAGT,OAAO,CAACU,OAAR,CAAgBC,MAAhB,CAA4C,gBAA5C,CAAf;;EACA,IAAIF,MAAJ,EAAY;IACR,OAAOA,MAAP;EACH,CAJ2E,CAK5E;EACA;;;EACA,OAAOV,gBAAgB,CAACC,OAAD,CAAvB;AACH,CARD;;AAUA,MAAMe,aAAN,CAAoB;EAEhB;AACJ;AACA;AACA;EAGIC,WAAW,CAAChB,OAAD,EAAyB;IAAA;IAAA;IAChC,KAAKS,MAAL,GAAcK,sBAAsB,CAACd,OAAD,CAApC;IACA,KAAKiB,OAAL,GAAelB,gBAAgB,CAACC,OAAD,CAA/B;EACH;;EAEkB,MAANG,MAAM,CACfC,MADe,EAEG;IAClB,IAAIK,MAA2B,GAAG,KAAKA,MAAvC;;IACA,IAAIA,MAAM,CAACS,SAAP,IAAoBT,MAAM,CAACS,SAAP,CAAiBd,MAAjB,MAA6B,KAArD,EAA4D;MACxDK,MAAM,GAAG,KAAKQ,OAAd;IACH;;IACD,IAAI;MACA,OAAO,MAAMR,MAAM,CAACN,MAAP,CAAcC,MAAd,CAAb;IACH,CAFD,CAEE,OAAOe,EAAP,EAAW;MACT;AACZ;AACA;MACY,MAAMC,IAAyB,GAAG;QAC9BC,KAAK,EAAE;UACHC,OAAO,EAAEH,EAAE,CAACG,OADT;UAEHF,IAAI,EAAED,EAAE,CAACC,IAFN;UAGHG,IAAI,EAAEJ,EAAE,CAACI;QAHN;MADuB,CAAlC;;MAOA,IAAInB,MAAM,CAACoB,WAAX,EAAwB;QACpBJ,IAAI,CAACI,WAAL,GAAmBpB,MAAM,CAACoB,WAA1B;MACH;;MACD,MAAM,IAAIZ,cAAJ,CACD,uFAAsFa,IAAI,CAACC,SAAL,CACnFtB,MADmF,EAEnF,IAFmF,EAGnF,CAHmF,CAIrF,EALA,EAMF,cANE,EAOFgB,IAPE,CAAN;IASH;EACJ;;AA9Ce;;eAiDLL,a"}

package/HandlerClientPlugin.d.ts

@@ -0,0 +1,18 @@
+import { Plugin } from "@webiny/plugins/Plugin";
+import { InvokeArgs } from "./types";
+interface HandlerClientPluginCallable<Payload = Record<string, any>, Response = any> {
+    (params: InvokeArgs<Payload>): Promise<Response>;
+}
+export interface HandlerClientPluginParams {
+    invoke: HandlerClientPluginCallable;
+    canUse?: (params: InvokeArgs) => boolean;
+}
+export declare class HandlerClientPlugin extends Plugin {
+    static type: string;
+    private readonly _invoke;
+    private readonly canUse?;
+    constructor({ invoke, canUse }: HandlerClientPluginParams);
+    canHandle(params: InvokeArgs): boolean;
+    invoke<Payload = any, Response = any>(params: InvokeArgs<Payload>): Promise<Response>;
+}
+export {};

package/HandlerClientPlugin.js

@@ -0,0 +1,41 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.HandlerClientPlugin = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _Plugin = require("@webiny/plugins/Plugin");
+
+class HandlerClientPlugin extends _Plugin.Plugin {
+  constructor({
+    invoke,
+    canUse
+  }) {
+    super();
+    (0, _defineProperty2.default)(this, "_invoke", void 0);
+    (0, _defineProperty2.default)(this, "canUse", void 0);
+    this._invoke = invoke;
+    this.canUse = canUse;
+  }
+
+  canHandle(params) {
+    if (!this.canUse) {
+      return true;
+    }
+
+    return this.canUse(params);
+  }
+
+  invoke(params) {
+    return this._invoke(params);
+  }
+
+}
+
+exports.HandlerClientPlugin = HandlerClientPlugin;
+(0, _defineProperty2.default)(HandlerClientPlugin, "type", "handler-client");

package/HandlerClientPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["HandlerClientPlugin","Plugin","constructor","invoke","canUse","_invoke","canHandle","params"],"sources":["HandlerClientPlugin.ts"],"sourcesContent":["import { Plugin } from \"@webiny/plugins/Plugin\";\nimport { InvokeArgs } from \"~/types\";\n\ninterface HandlerClientPluginCallable<Payload = Record<string, any>, Response = any> {\n    (params: InvokeArgs<Payload>): Promise<Response>;\n}\n\nexport interface HandlerClientPluginParams {\n    invoke: HandlerClientPluginCallable;\n    canUse?: (params: InvokeArgs) => boolean;\n}\n\nexport class HandlerClientPlugin extends Plugin {\n    public static override type = \"handler-client\";\n\n    private readonly _invoke: HandlerClientPluginCallable;\n    private readonly canUse?: (params: InvokeArgs) => boolean;\n\n    public constructor({ invoke, canUse }: HandlerClientPluginParams) {\n        super();\n        this._invoke = invoke;\n        this.canUse = canUse;\n    }\n\n    public canHandle(params: InvokeArgs): boolean {\n        if (!this.canUse) {\n            return true;\n        }\n        return this.canUse(params);\n    }\n\n    public invoke<Payload = any, Response = any>(params: InvokeArgs<Payload>): Promise<Response> {\n        return this._invoke(params);\n    }\n}\n"],"mappings":";;;;;;;;;;;AAAA;;AAYO,MAAMA,mBAAN,SAAkCC,cAAlC,CAAyC;EAMrCC,WAAW,CAAC;IAAEC,MAAF;IAAUC;EAAV,CAAD,EAAgD;IAC9D;IAD8D;IAAA;IAE9D,KAAKC,OAAL,GAAeF,MAAf;IACA,KAAKC,MAAL,GAAcA,MAAd;EACH;;EAEME,SAAS,CAACC,MAAD,EAA8B;IAC1C,IAAI,CAAC,KAAKH,MAAV,EAAkB;MACd,OAAO,IAAP;IACH;;IACD,OAAO,KAAKA,MAAL,CAAYG,MAAZ,CAAP;EACH;;EAEMJ,MAAM,CAAgCI,MAAhC,EAAgF;IACzF,OAAO,KAAKF,OAAL,CAAaE,MAAb,CAAP;EACH;;AArB2C;;;8BAAnCP,mB,UACqB,gB"}

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/README.md

@@ -0,0 +1,19 @@
+# @webiny/handler-client
+[![](https://img.shields.io/npm/dw/@webiny/handler-client.svg)](https://www.npmjs.com/package/@webiny/handler-client) 
+[![](https://img.shields.io/npm/v/@webiny/handler-client.svg)](https://www.npmjs.com/package/@webiny/handler-client)
+[![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)
+
+The base package for building Webiny and React powered web apps.
+
+For more information, please visit [the official docs](https://docs.webiny.com/docs/webiny/introduction). 
+  
+## Install
+```
+npm install --save @webiny/handler-client
+```
+
+Or if you prefer yarn: 
+```
+yarn add @webiny/handler-client
+```

package/index.d.ts

@@ -0,0 +1,7 @@
+import { ClientContext } from "./types";
+export * from "./HandlerClientPlugin";
+export declare const createHandlerClient: () => {
+    type: string;
+    name: string;
+    apply(context: ClientContext): Promise<void>;
+};

package/index.js

@@ -0,0 +1,39 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _exportNames = {
+  createHandlerClient: true
+};
+exports.createHandlerClient = void 0;
+
+var _HandlerClient = _interopRequireDefault(require("./HandlerClient"));
+
+var _HandlerClientPlugin = require("./HandlerClientPlugin");
+
+Object.keys(_HandlerClientPlugin).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _HandlerClientPlugin[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _HandlerClientPlugin[key];
+    }
+  });
+});
+
+const createHandlerClient = () => ({
+  type: "context",
+  name: "handler-client.context",
+
+  async apply(context) {
+    context.handlerClient = new _HandlerClient.default(context);
+  }
+
+});
+
+exports.createHandlerClient = createHandlerClient;

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["createHandlerClient","type","name","apply","context","handlerClient","HandlerClient"],"sources":["index.ts"],"sourcesContent":["import HandlerClient from \"./HandlerClient\";\nimport { ClientContext } from \"~/types\";\n\nexport * from \"./HandlerClientPlugin\";\n\nexport const createHandlerClient = () => ({\n    type: \"context\",\n    name: \"handler-client.context\",\n    async apply(context: ClientContext) {\n        context.handlerClient = new HandlerClient(context);\n    }\n});\n"],"mappings":";;;;;;;;;;;;AAAA;;AAGA;;AAAA;EAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA;;AAEO,MAAMA,mBAAmB,GAAG,OAAO;EACtCC,IAAI,EAAE,SADgC;EAEtCC,IAAI,EAAE,wBAFgC;;EAGtC,MAAMC,KAAN,CAAYC,OAAZ,EAAoC;IAChCA,OAAO,CAACC,aAAR,GAAwB,IAAIC,sBAAJ,CAAkBF,OAAlB,CAAxB;EACH;;AALqC,CAAP,CAA5B"}

package/package.json

@@ -0,0 +1,44 @@
+{
+	"name": "@webiny/handler-client",
+	"version": "0.0.0-ee-vpcs.549378cf03",
+	"main": "index.js",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/webiny/webiny-js.git"
+	},
+	"description": "A package that contains plugins for developing Webiny API in the AWS cloud.",
+	"contributors": [
+		"Pavel Denisjuk <pavel@webiny.com>",
+		"Sven Al Hamad <sven@webiny.com>",
+		"Adrian Smijulj <adrian@webiny.com>"
+	],
+	"license": "MIT",
+	"dependencies": {
+		"@babel/runtime": "7.19.0",
+		"@webiny/api": "0.0.0-ee-vpcs.549378cf03",
+		"@webiny/error": "0.0.0-ee-vpcs.549378cf03",
+		"@webiny/plugins": "0.0.0-ee-vpcs.549378cf03"
+	},
+	"devDependencies": {
+		"@babel/cli": "^7.19.3",
+		"@babel/core": "^7.19.3",
+		"@babel/preset-env": "^7.19.4",
+		"@babel/preset-typescript": "^7.18.6",
+		"@webiny/cli": "^0.0.0-ee-vpcs.549378cf03",
+		"@webiny/project-utils": "^0.0.0-ee-vpcs.549378cf03",
+		"babel-plugin-lodash": "^3.3.4",
+		"jest": "^28.1.0",
+		"merge": "^1.2.1",
+		"rimraf": "^3.0.2",
+		"typescript": "4.7.4"
+	},
+	"publishConfig": {
+		"access": "public",
+		"directory": "dist"
+	},
+	"scripts": {
+		"build": "yarn webiny run build",
+		"watch": "yarn webiny run watch"
+	},
+	"gitHead": "549378cf03fcd27845fc3fa23d1dc6b32896f630"
+}

package/types.d.ts

@@ -0,0 +1,16 @@
+import HandlerClient from "./HandlerClient";
+import { Plugin } from "@webiny/plugins/types";
+import { Context } from "@webiny/api/types";
+export declare type InvokeArgs<TInvokeArgsPayload = any> = {
+    name: string;
+    payload?: TInvokeArgsPayload;
+    await?: boolean;
+    description?: string;
+};
+export declare type HandlerClientHandlerPlugin = Plugin & {
+    type: "handler-client-handler";
+    invoke: <TArgs = Record<string, any>, TResponse = Record<string, any>>(params: TArgs) => TResponse | Promise<TResponse>;
+};
+export interface ClientContext extends Context {
+    handlerClient: HandlerClient;
+}

package/types.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/types.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["import HandlerClient from \"./HandlerClient\";\nimport { Plugin } from \"@webiny/plugins/types\";\nimport { Context } from \"@webiny/api/types\";\n\nexport type InvokeArgs<TInvokeArgsPayload = any> = {\n    name: string;\n    payload?: TInvokeArgsPayload;\n    await?: boolean;\n    description?: string;\n};\n\nexport type HandlerClientHandlerPlugin = Plugin & {\n    type: \"handler-client-handler\";\n    invoke: <TArgs = Record<string, any>, TResponse = Record<string, any>>(\n        params: TArgs\n    ) => TResponse | Promise<TResponse>;\n};\n\nexport interface ClientContext extends Context {\n    handlerClient: HandlerClient;\n}\n"],"mappings":""}