@webiny/api-websockets 0.0.0-unstable.e53eceafb5

package/types.js

@@ -0,0 +1,7 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+//# sourceMappingURL=types.js.map

package/types.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["import type { DbContext } from \"@webiny/handler-db/types\";\nimport type { IWebsocketsContextObject } from \"./context/abstractions/IWebsocketsContext\";\nimport type { SecurityContext, SecurityPermission } from \"@webiny/api-security/types\";\nimport type { I18NContext } from \"@webiny/api-i18n/types\";\n\nexport type { IWebsocketsContextObject };\n\nexport interface Context extends DbContext, SecurityContext, I18NContext {\n    websockets: IWebsocketsContextObject;\n}\n\nexport interface WebsocketsPermission extends SecurityPermission {\n    name: \"websockets\";\n    rwd?: string;\n}\n"],"mappings":"","ignoreList":[]}

package/utils/middleware.d.ts

@@ -0,0 +1,5 @@
+import type { GenericRecord } from "@webiny/api/types";
+export interface MiddlewareCallable<I extends GenericRecord = GenericRecord, O extends GenericRecord = GenericRecord> {
+    (input: I, next: () => Promise<O>): Promise<O>;
+}
+export declare const middleware: <I extends GenericRecord = GenericRecord, O extends GenericRecord = GenericRecord>(functions: MiddlewareCallable<I, O>[]) => (input: I) => Promise<O>;

package/utils/middleware.js

@@ -0,0 +1,25 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.middleware = void 0;
+const middleware = functions => {
+  return async input => {
+    const chain = Array.from(functions);
+    const exec = async () => {
+      const fn = chain.shift();
+      if (!fn) {
+        return {};
+      }
+      const next = async () => {
+        return exec();
+      };
+      return fn(input, next);
+    };
+    return exec();
+  };
+};
+exports.middleware = middleware;
+
+//# sourceMappingURL=middleware.js.map

package/utils/middleware.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["middleware","functions","input","chain","Array","from","exec","fn","shift","next","exports"],"sources":["middleware.ts"],"sourcesContent":["import type { GenericRecord } from \"@webiny/api/types\";\n\nexport interface MiddlewareCallable<\n    I extends GenericRecord = GenericRecord,\n    O extends GenericRecord = GenericRecord\n> {\n    (input: I, next: () => Promise<O>): Promise<O>;\n}\n\nexport const middleware = <\n    I extends GenericRecord = GenericRecord,\n    O extends GenericRecord = GenericRecord\n>(\n    functions: MiddlewareCallable<I, O>[]\n) => {\n    return async (input: I): Promise<O> => {\n        const chain = Array.from(functions);\n        const exec = async (): Promise<O> => {\n            const fn = chain.shift();\n            if (!fn) {\n                return {} as O;\n            }\n            const next = async () => {\n                return exec();\n            };\n            return fn(input, next);\n        };\n        return exec();\n    };\n};\n"],"mappings":";;;;;;AASO,MAAMA,UAAU,GAInBC,SAAqC,IACpC;EACD,OAAO,MAAOC,KAAQ,IAAiB;IACnC,MAAMC,KAAK,GAAGC,KAAK,CAACC,IAAI,CAACJ,SAAS,CAAC;IACnC,MAAMK,IAAI,GAAG,MAAAA,CAAA,KAAwB;MACjC,MAAMC,EAAE,GAAGJ,KAAK,CAACK,KAAK,CAAC,CAAC;MACxB,IAAI,CAACD,EAAE,EAAE;QACL,OAAO,CAAC,CAAC;MACb;MACA,MAAME,IAAI,GAAG,MAAAA,CAAA,KAAY;QACrB,OAAOH,IAAI,CAAC,CAAC;MACjB,CAAC;MACD,OAAOC,EAAE,CAACL,KAAK,EAAEO,IAAI,CAAC;IAC1B,CAAC;IACD,OAAOH,IAAI,CAAC,CAAC;EACjB,CAAC;AACL,CAAC;AAACI,OAAA,CAAAV,UAAA,GAAAA,UAAA","ignoreList":[]}

package/validator/WebsocketsEventValidator.d.ts

@@ -0,0 +1,5 @@
+import type { IWebsocketsEvent, IWebsocketsEventData } from "../handler/types";
+import type { IWebsocketsEventValidator, IWebsocketsEventValidatorValidateParams } from "./abstractions/IWebsocketsEventValidator";
+export declare class WebsocketsEventValidator implements IWebsocketsEventValidator {
+    validate<T extends IWebsocketsEventData = IWebsocketsEventData>(input: IWebsocketsEventValidatorValidateParams): Promise<IWebsocketsEvent<T>>;
+}

package/validator/WebsocketsEventValidator.js

@@ -0,0 +1,85 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.WebsocketsEventValidator = void 0;
+var _zod = _interopRequireDefault(require("zod"));
+var _types = require("../handler/types");
+var _utils = require("@webiny/utils");
+const validation = _zod.default.object({
+  headers: _zod.default.object({}).passthrough().optional(),
+  requestContext: _zod.default.object({
+    connectionId: _zod.default.string(),
+    stage: _zod.default.string(),
+    connectedAt: _zod.default.number(),
+    domainName: _zod.default.string(),
+    eventType: _zod.default.enum([_types.WebsocketsEventRequestContextEventType.connect, _types.WebsocketsEventRequestContextEventType.message, _types.WebsocketsEventRequestContextEventType.disconnect]),
+    routeKey: _zod.default.string()
+  }),
+  body: _zod.default.string().transform((value, context) => {
+    if (!value) {
+      return undefined;
+    }
+    try {
+      return JSON.parse(value);
+    } catch (ex) {
+      /**
+       * We want to log the error, for easier debugging.
+       */
+      console.error(`Failed body validation: ${ex.message}`);
+      console.log(`Body: ${value}`);
+      /**
+       * And we want to add an issue to the context, so that the user knows what went wrong.
+       */
+      context.addIssue({
+        path: [],
+        message: `Invalid JSON: ${ex.message}`,
+        code: _zod.default.ZodIssueCode.custom,
+        fatal: true
+      });
+    }
+  }).optional()
+}).superRefine((output, context) => {
+  if (output.requestContext.eventType !== _types.WebsocketsEventRequestContextEventType.message) {
+    return;
+  } else if (output.body) {
+    return;
+  }
+  context.addIssue({
+    path: ["body"],
+    message: "There must be a body defined when having a message event.",
+    code: _zod.default.ZodIssueCode.custom,
+    fatal: true
+  });
+});
+const bodyValidation = _zod.default.object({
+  token: _zod.default.string(),
+  tenant: _zod.default.string(),
+  locale: _zod.default.string(),
+  messageId: _zod.default.string().nullish(),
+  action: _zod.default.string(),
+  data: _zod.default.object({}).passthrough().nullish()
+}).passthrough().optional();
+class WebsocketsEventValidator {
+  async validate(input) {
+    const result = await validation.safeParseAsync(input);
+    if (!result.success) {
+      throw (0, _utils.createZodError)(result.error);
+    }
+    const bodyResult = await bodyValidation.safeParseAsync(result.data.body);
+    if (!bodyResult.success) {
+      throw (0, _utils.createZodError)(bodyResult.error);
+    }
+    return {
+      ...result.data,
+      body: {
+        ...(bodyResult.data || {})
+      }
+    };
+  }
+}
+exports.WebsocketsEventValidator = WebsocketsEventValidator;
+
+//# sourceMappingURL=WebsocketsEventValidator.js.map

package/validator/WebsocketsEventValidator.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_zod","_interopRequireDefault","require","_types","_utils","validation","zod","object","headers","passthrough","optional","requestContext","connectionId","string","stage","connectedAt","number","domainName","eventType","enum","WebsocketsEventRequestContextEventType","connect","message","disconnect","routeKey","body","transform","value","context","undefined","JSON","parse","ex","console","error","log","addIssue","path","code","ZodIssueCode","custom","fatal","superRefine","output","bodyValidation","token","tenant","locale","messageId","nullish","action","data","WebsocketsEventValidator","validate","input","result","safeParseAsync","success","createZodError","bodyResult","exports"],"sources":["WebsocketsEventValidator.ts"],"sourcesContent":["import zod from \"zod\";\nimport type { IWebsocketsEvent, IWebsocketsEventData } from \"~/handler/types\";\nimport { WebsocketsEventRequestContextEventType } from \"~/handler/types\";\nimport type {\n    IWebsocketsEventValidator,\n    IWebsocketsEventValidatorValidateParams\n} from \"./abstractions/IWebsocketsEventValidator\";\nimport { createZodError } from \"@webiny/utils\";\n\nconst validation = zod\n    .object({\n        headers: zod.object({}).passthrough().optional(),\n        requestContext: zod.object({\n            connectionId: zod.string(),\n            stage: zod.string(),\n            connectedAt: zod.number(),\n            domainName: zod.string(),\n            eventType: zod.enum([\n                WebsocketsEventRequestContextEventType.connect,\n                WebsocketsEventRequestContextEventType.message,\n                WebsocketsEventRequestContextEventType.disconnect\n            ]),\n            routeKey: zod.string()\n        }),\n        body: zod\n            .string()\n            .transform<IWebsocketsEventData>((value, context) => {\n                if (!value) {\n                    return undefined;\n                }\n                try {\n                    return JSON.parse(value);\n                } catch (ex) {\n                    /**\n                     * We want to log the error, for easier debugging.\n                     */\n                    console.error(`Failed body validation: ${ex.message}`);\n                    console.log(`Body: ${value}`);\n                    /**\n                     * And we want to add an issue to the context, so that the user knows what went wrong.\n                     */\n                    context.addIssue({\n                        path: [],\n                        message: `Invalid JSON: ${ex.message}`,\n                        code: zod.ZodIssueCode.custom,\n                        fatal: true\n                    });\n                }\n            })\n            .optional()\n    })\n    .superRefine((output, context) => {\n        if (output.requestContext.eventType !== WebsocketsEventRequestContextEventType.message) {\n            return;\n        } else if (output.body) {\n            return;\n        }\n        context.addIssue({\n            path: [\"body\"],\n            message: \"There must be a body defined when having a message event.\",\n            code: zod.ZodIssueCode.custom,\n            fatal: true\n        });\n    });\n\nconst bodyValidation = zod\n    .object({\n        token: zod.string(),\n        tenant: zod.string(),\n        locale: zod.string(),\n        messageId: zod.string().nullish(),\n        action: zod.string(),\n        data: zod.object({}).passthrough().nullish()\n    })\n    .passthrough()\n    .optional();\n\nexport class WebsocketsEventValidator implements IWebsocketsEventValidator {\n    public async validate<T extends IWebsocketsEventData = IWebsocketsEventData>(\n        input: IWebsocketsEventValidatorValidateParams\n    ): Promise<IWebsocketsEvent<T>> {\n        const result = await validation.safeParseAsync(input);\n        if (!result.success) {\n            throw createZodError(result.error);\n        }\n        const bodyResult = await bodyValidation.safeParseAsync(result.data.body);\n        if (!bodyResult.success) {\n            throw createZodError(bodyResult.error);\n        }\n        return {\n            ...result.data,\n            body: {\n                ...((bodyResult.data || {}) as T)\n            }\n        };\n    }\n}\n"],"mappings":";;;;;;;AAAA,IAAAA,IAAA,GAAAC,sBAAA,CAAAC,OAAA;AAEA,IAAAC,MAAA,GAAAD,OAAA;AAKA,IAAAE,MAAA,GAAAF,OAAA;AAEA,MAAMG,UAAU,GAAGC,YAAG,CACjBC,MAAM,CAAC;EACJC,OAAO,EAAEF,YAAG,CAACC,MAAM,CAAC,CAAC,CAAC,CAAC,CAACE,WAAW,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EAChDC,cAAc,EAAEL,YAAG,CAACC,MAAM,CAAC;IACvBK,YAAY,EAAEN,YAAG,CAACO,MAAM,CAAC,CAAC;IAC1BC,KAAK,EAAER,YAAG,CAACO,MAAM,CAAC,CAAC;IACnBE,WAAW,EAAET,YAAG,CAACU,MAAM,CAAC,CAAC;IACzBC,UAAU,EAAEX,YAAG,CAACO,MAAM,CAAC,CAAC;IACxBK,SAAS,EAAEZ,YAAG,CAACa,IAAI,CAAC,CAChBC,6CAAsC,CAACC,OAAO,EAC9CD,6CAAsC,CAACE,OAAO,EAC9CF,6CAAsC,CAACG,UAAU,CACpD,CAAC;IACFC,QAAQ,EAAElB,YAAG,CAACO,MAAM,CAAC;EACzB,CAAC,CAAC;EACFY,IAAI,EAAEnB,YAAG,CACJO,MAAM,CAAC,CAAC,CACRa,SAAS,CAAuB,CAACC,KAAK,EAAEC,OAAO,KAAK;IACjD,IAAI,CAACD,KAAK,EAAE;MACR,OAAOE,SAAS;IACpB;IACA,IAAI;MACA,OAAOC,IAAI,CAACC,KAAK,CAACJ,KAAK,CAAC;IAC5B,CAAC,CAAC,OAAOK,EAAE,EAAE;MACT;AACpB;AACA;MACoBC,OAAO,CAACC,KAAK,CAAC,2BAA2BF,EAAE,CAACV,OAAO,EAAE,CAAC;MACtDW,OAAO,CAACE,GAAG,CAAC,SAASR,KAAK,EAAE,CAAC;MAC7B;AACpB;AACA;MACoBC,OAAO,CAACQ,QAAQ,CAAC;QACbC,IAAI,EAAE,EAAE;QACRf,OAAO,EAAE,iBAAiBU,EAAE,CAACV,OAAO,EAAE;QACtCgB,IAAI,EAAEhC,YAAG,CAACiC,YAAY,CAACC,MAAM;QAC7BC,KAAK,EAAE;MACX,CAAC,CAAC;IACN;EACJ,CAAC,CAAC,CACD/B,QAAQ,CAAC;AAClB,CAAC,CAAC,CACDgC,WAAW,CAAC,CAACC,MAAM,EAAEf,OAAO,KAAK;EAC9B,IAAIe,MAAM,CAAChC,cAAc,CAACO,SAAS,KAAKE,6CAAsC,CAACE,OAAO,EAAE;IACpF;EACJ,CAAC,MAAM,IAAIqB,MAAM,CAAClB,IAAI,EAAE;IACpB;EACJ;EACAG,OAAO,CAACQ,QAAQ,CAAC;IACbC,IAAI,EAAE,CAAC,MAAM,CAAC;IACdf,OAAO,EAAE,2DAA2D;IACpEgB,IAAI,EAAEhC,YAAG,CAACiC,YAAY,CAACC,MAAM;IAC7BC,KAAK,EAAE;EACX,CAAC,CAAC;AACN,CAAC,CAAC;AAEN,MAAMG,cAAc,GAAGtC,YAAG,CACrBC,MAAM,CAAC;EACJsC,KAAK,EAAEvC,YAAG,CAACO,MAAM,CAAC,CAAC;EACnBiC,MAAM,EAAExC,YAAG,CAACO,MAAM,CAAC,CAAC;EACpBkC,MAAM,EAAEzC,YAAG,CAACO,MAAM,CAAC,CAAC;EACpBmC,SAAS,EAAE1C,YAAG,CAACO,MAAM,CAAC,CAAC,CAACoC,OAAO,CAAC,CAAC;EACjCC,MAAM,EAAE5C,YAAG,CAACO,MAAM,CAAC,CAAC;EACpBsC,IAAI,EAAE7C,YAAG,CAACC,MAAM,CAAC,CAAC,CAAC,CAAC,CAACE,WAAW,CAAC,CAAC,CAACwC,OAAO,CAAC;AAC/C,CAAC,CAAC,CACDxC,WAAW,CAAC,CAAC,CACbC,QAAQ,CAAC,CAAC;AAER,MAAM0C,wBAAwB,CAAsC;EACvE,MAAaC,QAAQA,CACjBC,KAA8C,EAClB;IAC5B,MAAMC,MAAM,GAAG,MAAMlD,UAAU,CAACmD,cAAc,CAACF,KAAK,CAAC;IACrD,IAAI,CAACC,MAAM,CAACE,OAAO,EAAE;MACjB,MAAM,IAAAC,qBAAc,EAACH,MAAM,CAACrB,KAAK,CAAC;IACtC;IACA,MAAMyB,UAAU,GAAG,MAAMf,cAAc,CAACY,cAAc,CAACD,MAAM,CAACJ,IAAI,CAAC1B,IAAI,CAAC;IACxE,IAAI,CAACkC,UAAU,CAACF,OAAO,EAAE;MACrB,MAAM,IAAAC,qBAAc,EAACC,UAAU,CAACzB,KAAK,CAAC;IAC1C;IACA,OAAO;MACH,GAAGqB,MAAM,CAACJ,IAAI;MACd1B,IAAI,EAAE;QACF,IAAKkC,UAAU,CAACR,IAAI,IAAI,CAAC,CAAC;MAC9B;IACJ,CAAC;EACL;AACJ;AAACS,OAAA,CAAAR,wBAAA,GAAAA,wBAAA","ignoreList":[]}

package/validator/abstractions/IWebsocketsEventValidator.d.ts

@@ -0,0 +1,8 @@
+import type { IWebsocketsEvent, IWebsocketsEventData, IWebsocketsIncomingEvent } from "../../handler/types";
+export type IWebsocketsEventValidatorValidateParams = IWebsocketsIncomingEvent;
+export interface IWebsocketsEventValidator {
+    /**
+     * @throws {Error}
+     */
+    validate<T extends IWebsocketsEventData = IWebsocketsEventData>(params: IWebsocketsEventValidatorValidateParams): Promise<IWebsocketsEvent<T>>;
+}

package/validator/abstractions/IWebsocketsEventValidator.js

@@ -0,0 +1,7 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+//# sourceMappingURL=IWebsocketsEventValidator.js.map

package/validator/abstractions/IWebsocketsEventValidator.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["IWebsocketsEventValidator.ts"],"sourcesContent":["import type {\n    IWebsocketsEvent,\n    IWebsocketsEventData,\n    IWebsocketsIncomingEvent\n} from \"~/handler/types\";\n\nexport type IWebsocketsEventValidatorValidateParams = IWebsocketsIncomingEvent;\n\nexport interface IWebsocketsEventValidator {\n    /**\n     * @throws {Error}\n     */\n    validate<T extends IWebsocketsEventData = IWebsocketsEventData>(\n        params: IWebsocketsEventValidatorValidateParams\n    ): Promise<IWebsocketsEvent<T>>;\n}\n"],"mappings":"","ignoreList":[]}

package/validator/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./abstractions/IWebsocketsEventValidator";
+export * from "./WebsocketsEventValidator";

package/validator/index.js

@@ -0,0 +1,29 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _IWebsocketsEventValidator = require("./abstractions/IWebsocketsEventValidator");
+Object.keys(_IWebsocketsEventValidator).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _IWebsocketsEventValidator[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _IWebsocketsEventValidator[key];
+    }
+  });
+});
+var _WebsocketsEventValidator = require("./WebsocketsEventValidator");
+Object.keys(_WebsocketsEventValidator).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _WebsocketsEventValidator[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _WebsocketsEventValidator[key];
+    }
+  });
+});
+
+//# sourceMappingURL=index.js.map

package/validator/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_IWebsocketsEventValidator","require","Object","keys","forEach","key","exports","defineProperty","enumerable","get","_WebsocketsEventValidator"],"sources":["index.ts"],"sourcesContent":["export * from \"./abstractions/IWebsocketsEventValidator\";\nexport * from \"./WebsocketsEventValidator\";\n"],"mappings":";;;;;AAAA,IAAAA,0BAAA,GAAAC,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAH,0BAAA,EAAAI,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAL,0BAAA,CAAAK,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAT,0BAAA,CAAAK,GAAA;IAAA;EAAA;AAAA;AACA,IAAAK,yBAAA,GAAAT,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAO,yBAAA,EAAAN,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAK,yBAAA,CAAAL,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAC,yBAAA,CAAAL,GAAA;IAAA;EAAA;AAAA","ignoreList":[]}