@webiny/app-websockets 6.3.0 → 6.4.0-beta.0

package/hooks/useWebsockets.js

@@ -1,11 +1,10 @@
 import { useContext } from "react";
 import { WebsocketsContext } from "../WebsocketsContextProvider.js";
-export const useWebsockets = () => {
-  const context = useContext(WebsocketsContext);
-  if (!context) {
-    throw new Error("useWebsockets must be used within a SocketsProvider");
-  }
-  return context;
+const useWebsockets = ()=>{
+    const context = useContext(WebsocketsContext);
+    if (!context) throw new Error("useWebsockets must be used within a SocketsProvider");
+    return context;
 };
+export { useWebsockets };
 
 //# sourceMappingURL=useWebsockets.js.map

package/hooks/useWebsockets.js.map

@@ -1 +1 @@
-{"version":3,"names":["useContext","WebsocketsContext","useWebsockets","context","Error"],"sources":["useWebsockets.tsx"],"sourcesContent":["import { useContext } from \"react\";\nimport { WebsocketsContext } from \"~/WebsocketsContextProvider.js\";\nimport type { IWebsocketsContext } from \"~/types.js\";\n\nexport const useWebsockets = (): IWebsocketsContext => {\n    const context = useContext(WebsocketsContext);\n    if (!context) {\n        throw new Error(\"useWebsockets must be used within a SocketsProvider\");\n    }\n    return context;\n};\n"],"mappings":"AAAA,SAASA,UAAU,QAAQ,OAAO;AAClC,SAASC,iBAAiB;AAG1B,OAAO,MAAMC,aAAa,GAAGA,CAAA,KAA0B;EACnD,MAAMC,OAAO,GAAGH,UAAU,CAACC,iBAAiB,CAAC;EAC7C,IAAI,CAACE,OAAO,EAAE;IACV,MAAM,IAAIC,KAAK,CAAC,qDAAqD,CAAC;EAC1E;EACA,OAAOD,OAAO;AAClB,CAAC","ignoreList":[]}
+{"version":3,"file":"hooks/useWebsockets.js","sources":["../../src/hooks/useWebsockets.tsx"],"sourcesContent":["import { useContext } from \"react\";\nimport { WebsocketsContext } from \"~/WebsocketsContextProvider.js\";\nimport type { IWebsocketsContext } from \"~/types.js\";\n\nexport const useWebsockets = (): IWebsocketsContext => {\n    const context = useContext(WebsocketsContext);\n    if (!context) {\n        throw new Error(\"useWebsockets must be used within a SocketsProvider\");\n    }\n    return context;\n};\n"],"names":["useWebsockets","context","useContext","WebsocketsContext","Error"],"mappings":";;AAIO,MAAMA,gBAAgB;IACzB,MAAMC,UAAUC,WAAWC;IAC3B,IAAI,CAACF,SACD,MAAM,IAAIG,MAAM;IAEpB,OAAOH;AACX"}

package/index.js

@@ -1,18 +1,15 @@
-import React from "react";
+import react from "react";
 import { Provider } from "@webiny/app";
 import { WebsocketsContextProvider } from "./WebsocketsContextProvider.js";
-const WebsocketsHoc = Component => {
-  return function WebsocketsProvider(props) {
-    return /*#__PURE__*/React.createElement(WebsocketsContextProvider, null, /*#__PURE__*/React.createElement(Component, props));
-  };
-};
-const WebsocketsExtension = () => {
-  return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Provider, {
-    hoc: WebsocketsHoc
-  }));
-};
-export const Websockets = /*#__PURE__*/React.memo(WebsocketsExtension);
 export * from "./types.js";
 export * from "./hooks/index.js";
+const WebsocketsHoc = (Component)=>function(props) {
+        return /*#__PURE__*/ react.createElement(WebsocketsContextProvider, null, /*#__PURE__*/ react.createElement(Component, props));
+    };
+const WebsocketsExtension = ()=>/*#__PURE__*/ react.createElement(react.Fragment, null, /*#__PURE__*/ react.createElement(Provider, {
+        hoc: WebsocketsHoc
+    }));
+const Websockets = /*#__PURE__*/ react.memo(WebsocketsExtension);
+export { Websockets };
 
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["React","Provider","WebsocketsContextProvider","WebsocketsHoc","Component","WebsocketsProvider","props","createElement","WebsocketsExtension","Fragment","hoc","Websockets","memo"],"sources":["index.tsx"],"sourcesContent":["import React from \"react\";\nimport { Provider } from \"@webiny/app\";\nimport { WebsocketsContextProvider } from \"~/WebsocketsContextProvider.js\";\n\nexport interface WebsocketsProviderProps {\n    children: React.ReactNode;\n}\n\nconst WebsocketsHoc = (Component: React.ComponentType<React.PropsWithChildren>) => {\n    return function WebsocketsProvider(props: WebsocketsProviderProps) {\n        return (\n            <WebsocketsContextProvider>\n                <Component {...props} />\n            </WebsocketsContextProvider>\n        );\n    };\n};\n\nconst WebsocketsExtension = () => {\n    return (\n        <>\n            <Provider hoc={WebsocketsHoc} />\n        </>\n    );\n};\n\nexport const Websockets = React.memo(WebsocketsExtension);\n\nexport * from \"./types.js\";\nexport * from \"./hooks/index.js\";\n"],"mappings":"AAAA,OAAOA,KAAK,MAAM,OAAO;AACzB,SAASC,QAAQ,QAAQ,aAAa;AACtC,SAASC,yBAAyB;AAMlC,MAAMC,aAAa,GAAIC,SAAuD,IAAK;EAC/E,OAAO,SAASC,kBAAkBA,CAACC,KAA8B,EAAE;IAC/D,oBACIN,KAAA,CAAAO,aAAA,CAACL,yBAAyB,qBACtBF,KAAA,CAAAO,aAAA,CAACH,SAAS,EAAKE,KAAQ,CACA,CAAC;EAEpC,CAAC;AACL,CAAC;AAED,MAAME,mBAAmB,GAAGA,CAAA,KAAM;EAC9B,oBACIR,KAAA,CAAAO,aAAA,CAAAP,KAAA,CAAAS,QAAA,qBACIT,KAAA,CAAAO,aAAA,CAACN,QAAQ;IAACS,GAAG,EAAEP;EAAc,CAAE,CACjC,CAAC;AAEX,CAAC;AAED,OAAO,MAAMQ,UAAU,gBAAGX,KAAK,CAACY,IAAI,CAACJ,mBAAmB,CAAC;AAEzD;AACA","ignoreList":[]}
+{"version":3,"file":"index.js","sources":["../src/index.tsx"],"sourcesContent":["import React from \"react\";\nimport { Provider } from \"@webiny/app\";\nimport { WebsocketsContextProvider } from \"~/WebsocketsContextProvider.js\";\n\nexport interface WebsocketsProviderProps {\n    children: React.ReactNode;\n}\n\nconst WebsocketsHoc = (Component: React.ComponentType<React.PropsWithChildren>) => {\n    return function WebsocketsProvider(props: WebsocketsProviderProps) {\n        return (\n            <WebsocketsContextProvider>\n                <Component {...props} />\n            </WebsocketsContextProvider>\n        );\n    };\n};\n\nconst WebsocketsExtension = () => {\n    return (\n        <>\n            <Provider hoc={WebsocketsHoc} />\n        </>\n    );\n};\n\nexport const Websockets = React.memo(WebsocketsExtension);\n\nexport * from \"./types.js\";\nexport * from \"./hooks/index.js\";\n"],"names":["WebsocketsHoc","Component","props","WebsocketsContextProvider","WebsocketsExtension","Provider","Websockets","React"],"mappings":";;;;;AAQA,MAAMA,gBAAgB,CAACC,YACZ,SAA4BC,KAA8B;QAC7D,OAAO,WAAP,GACI,oBAACC,2BAAyBA,MAAAA,WAAAA,GACtB,oBAACF,WAAcC;IAG3B;AAGJ,MAAME,sBAAsB,IACjB,WAAP,GACI,wDACI,oBAACC,UAAQA;QAAC,KAAKL;;AAKpB,MAAMM,aAAa,WAAHA,GAAGC,MAAAA,IAAU,CAACH"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@webiny/app-websockets",
-	"version": "6.3.0",
+	"version": "6.4.0-beta.0",
 	"type": "module",
 	"exports": {
 		".": "./index.js",
@@ -17,14 +17,14 @@
 	],
 	"license": "MIT",
 	"dependencies": {
-		"@webiny/app": "6.3.0",
-		"@webiny/app-admin": "6.3.0",
-		"@webiny/utils": "6.3.0",
+		"@webiny/app": "6.4.0-beta.0",
+		"@webiny/app-admin": "6.4.0-beta.0",
+		"@webiny/utils": "6.4.0-beta.0",
 		"react": "18.3.1",
 		"react-dom": "18.3.1"
 	},
 	"devDependencies": {
-		"@webiny/build-tools": "6.3.0",
+		"@webiny/build-tools": "6.4.0-beta.0",
 		"rimraf": "6.1.3",
 		"typescript": "6.0.3"
 	},
@@ -32,5 +32,5 @@
 		"access": "public",
 		"directory": "dist"
 	},
-	"gitHead": "7cefe15431dbd65504e1f58147dc9e55bcbfa693"
+	"gitHead": "a545d7529828af07d08d49c3da1bcb967483b9ce"
 }

package/types.js

@@ -1,4 +1 @@
 export * from "./domain/types.js";
-export {};
-
-//# sourceMappingURL=types.js.map

package/utils/getUrl.js

@@ -1,6 +1,7 @@
-export const getUrl = () => {
-  const websocketApiUrl = process.env.REACT_APP_WEBSOCKET_URL;
-  return !websocketApiUrl || websocketApiUrl === "undefined" ? undefined : websocketApiUrl;
+const getUrl = ()=>{
+    const websocketApiUrl = process.env.REACT_APP_WEBSOCKET_URL;
+    return websocketApiUrl && "undefined" !== websocketApiUrl ? websocketApiUrl : void 0;
 };
+export { getUrl };
 
 //# sourceMappingURL=getUrl.js.map

package/utils/getUrl.js.map

@@ -1 +1 @@
-{"version":3,"names":["getUrl","websocketApiUrl","process","env","REACT_APP_WEBSOCKET_URL","undefined"],"sources":["getUrl.ts"],"sourcesContent":["export const getUrl = (): string | undefined => {\n    const websocketApiUrl = process.env.REACT_APP_WEBSOCKET_URL;\n\n    return !websocketApiUrl || websocketApiUrl === \"undefined\" ? undefined : websocketApiUrl;\n};\n"],"mappings":"AAAA,OAAO,MAAMA,MAAM,GAAGA,CAAA,KAA0B;EAC5C,MAAMC,eAAe,GAAGC,OAAO,CAACC,GAAG,CAACC,uBAAuB;EAE3D,OAAO,CAACH,eAAe,IAAIA,eAAe,KAAK,WAAW,GAAGI,SAAS,GAAGJ,eAAe;AAC5F,CAAC","ignoreList":[]}
+{"version":3,"file":"utils/getUrl.js","sources":["../../src/utils/getUrl.ts"],"sourcesContent":["export const getUrl = (): string | undefined => {\n    const websocketApiUrl = process.env.REACT_APP_WEBSOCKET_URL;\n\n    return !websocketApiUrl || websocketApiUrl === \"undefined\" ? undefined : websocketApiUrl;\n};\n"],"names":["getUrl","websocketApiUrl","process","undefined"],"mappings":"AAAO,MAAMA,SAAS;IAClB,MAAMC,kBAAkBC,QAAQ,GAAG,CAAC,uBAAuB;IAE3D,OAAO,AAACD,mBAAmBA,AAAoB,gBAApBA,kBAA8CA,kBAAZE;AACjE"}

package/domain/abstractions/IWebsocketsAction.js.map

@@ -1 +0,0 @@
-{"version":3,"names":[],"sources":["IWebsocketsAction.ts"],"sourcesContent":["import type { IGenericData } from \"./types.js\";\n\nexport interface IWebsocketActionOnResponse<R extends IGenericData = IGenericData> {\n    (response: R | null): R | null;\n}\n\nexport interface IWebsocketsActionsTriggerParams<\n    T extends IGenericData = IGenericData,\n    R extends IGenericData = IGenericData\n> {\n    data?: T;\n    /**\n     * Does this action expect some response from the server?\n     * If defined, the response will be passed to this function.\n     */\n    onResponse?: IWebsocketActionOnResponse<R>;\n    /**\n     * How long to wait for the response?\n     * In milliseconds.\n     */\n    timeout?: number;\n}\n\nexport interface IWebsocketsAction<\n    T extends IGenericData = IGenericData,\n    R extends IGenericData = IGenericData\n> {\n    /**\n     * Trigger the action - send data to the server via Websockets.\n     * If onResponse is defined the method will wait for the response.\n     * If onResponse is not defined, the method will return null immediately.\n     */\n    trigger(params?: IWebsocketsActionsTriggerParams<T, R>): Promise<R | null>;\n}\n"],"mappings":"","ignoreList":[]}

package/domain/abstractions/IWebsocketsActions.js.map

@@ -1 +0,0 @@
-{"version":3,"names":[],"sources":["IWebsocketsActions.ts"],"sourcesContent":["import type { IWebsocketsManager } from \"./IWebsocketsManager.js\";\nimport type { IGenericData } from \"./types.js\";\n\nexport interface IWebsocketsActionsRunParams<T extends IGenericData = IGenericData> {\n    action: string;\n    data?: T;\n    timeout?: number;\n}\n\nexport interface IWebsocketsActions {\n    manager: IWebsocketsManager;\n    run<T extends IGenericData = IGenericData, R extends IGenericData = IGenericData>(\n        params: IWebsocketsActionsRunParams<T>\n    ): Promise<R | null>;\n}\n"],"mappings":"","ignoreList":[]}

package/domain/abstractions/IWebsocketsManager.js.map

@@ -1 +0,0 @@
-{"version":3,"names":[],"sources":["IWebsocketsManager.ts"],"sourcesContent":["import type {\n    IWebsocketsSubscription,\n    IWebsocketsSubscriptionCallback\n} from \"./IWebsocketsSubscriptionManager.js\";\nimport type {\n    IGenericData,\n    IWebsocketsManagerCloseEvent,\n    IWebsocketsManagerErrorEvent,\n    IWebsocketsManagerMessageEvent,\n    IWebsocketsManagerOpenEvent,\n    WebsocketsCloseCode\n} from \"./types.js\";\n\nexport interface IWebsocketManagerSendData<\n    T extends IGenericData = IGenericData\n> extends IGenericData {\n    /**\n     * A user token, which will identify the user sending the message.\n     */\n    token: string;\n    /**\n     * Current tenant.\n     */\n    tenant: string;\n    /**\n     * A unique message ID - generated on the UI side.\n     * TODO implement waiting for the message response.\n     */\n    messageId?: string;\n    /**\n     * Action being fired on the API side.\n     */\n    action: string;\n    /**\n     * Data being sent to the API. Must be an object.\n     */\n    data: T;\n}\n\nexport interface IWebsocketsManager {\n    isConnected(): boolean;\n    isClosed(): boolean;\n\n    connect(): Promise<void>;\n    close(code: WebsocketsCloseCode, reason: string): Promise<boolean>;\n    send<T extends IWebsocketManagerSendData = IWebsocketManagerSendData>(data: T): void;\n\n    onOpen(\n        cb: IWebsocketsSubscriptionCallback<IWebsocketsManagerOpenEvent>\n    ): IWebsocketsSubscription<IWebsocketsManagerOpenEvent>;\n\n    onClose(\n        cb: IWebsocketsSubscriptionCallback<IWebsocketsManagerCloseEvent>\n    ): IWebsocketsSubscription<IWebsocketsManagerCloseEvent>;\n\n    onError(\n        cb: IWebsocketsSubscriptionCallback<IWebsocketsManagerErrorEvent>\n    ): IWebsocketsSubscription<IWebsocketsManagerErrorEvent>;\n\n    onMessage<T extends IGenericData = IGenericData>(\n        cb: IWebsocketsSubscriptionCallback<IWebsocketsManagerMessageEvent<T>>\n    ): IWebsocketsSubscription<IWebsocketsManagerMessageEvent<T>>;\n}\n"],"mappings":"","ignoreList":[]}

package/domain/abstractions/IWebsocketsSubscriptionManager.js.map

@@ -1 +0,0 @@
-{"version":3,"names":[],"sources":["IWebsocketsSubscriptionManager.ts"],"sourcesContent":["import type { GenericRecord } from \"@webiny/app/types.js\";\nimport type {\n    IGenericData,\n    IWebsocketsManagerCloseEvent,\n    IWebsocketsManagerErrorEvent,\n    IWebsocketsManagerMessageEvent,\n    IWebsocketsManagerOpenEvent\n} from \"./types.js\";\n\nexport type IWebsocketManagerEvent = \"open\" | \"close\" | \"error\" | \"message\";\n\nexport interface IWebsocketsSubscriptionCallback<T> {\n    (data: T): Promise<void> | void;\n}\n\nexport interface IWebsocketsSubscription<T> {\n    cb: IWebsocketsSubscriptionCallback<T>;\n    id: string;\n    /**\n     * Remove the subscription on the message.\n     */\n    off: () => void;\n}\n\nexport interface IWebsocketsSubscriptionManagerSubscriptions<\n    T extends IGenericData = IGenericData\n> {\n    open: GenericRecord<string, IWebsocketsSubscription<IWebsocketsManagerOpenEvent>>;\n    close: GenericRecord<string, IWebsocketsSubscription<IWebsocketsManagerCloseEvent>>;\n    error: GenericRecord<string, IWebsocketsSubscription<IWebsocketsManagerErrorEvent>>;\n    message: GenericRecord<string, IWebsocketsSubscription<T>>;\n}\n\nexport interface IWebsocketsSubscriptionManager {\n    onOpen(\n        cb: IWebsocketsSubscriptionCallback<IWebsocketsManagerOpenEvent>\n    ): IWebsocketsSubscription<IWebsocketsManagerOpenEvent>;\n\n    onClose(\n        cb: IWebsocketsSubscriptionCallback<IWebsocketsManagerCloseEvent>\n    ): IWebsocketsSubscription<IWebsocketsManagerCloseEvent>;\n\n    onError(\n        cb: IWebsocketsSubscriptionCallback<IWebsocketsManagerErrorEvent>\n    ): IWebsocketsSubscription<IWebsocketsManagerErrorEvent>;\n\n    onMessage<T extends IGenericData = IGenericData>(\n        cb: IWebsocketsSubscriptionCallback<IWebsocketsManagerMessageEvent<T>>\n    ): IWebsocketsSubscription<IWebsocketsManagerMessageEvent<T>>;\n\n    triggerOnOpen(event: IWebsocketsManagerOpenEvent): Promise<void>;\n    triggerOnClose(event: IWebsocketsManagerCloseEvent): Promise<void>;\n    triggerOnError(event: IWebsocketsManagerErrorEvent): Promise<void>;\n    triggerOnMessage(event: IWebsocketsManagerMessageEvent<string>): Promise<void>;\n}\n"],"mappings":"","ignoreList":[]}

package/domain/index.js.map

@@ -1 +0,0 @@
-{"version":3,"names":[],"sources":["index.ts"],"sourcesContent":["export * from \"./WebsocketsAction.js\";\nexport * from \"./WebsocketsActions.js\";\nexport * from \"./WebsocketsConnection.js\";\nexport * from \"./WebsocketsManager.js\";\nexport * from \"./WebsocketsSubscriptionManager.js\";\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA","ignoreList":[]}

package/domain/types.js.map

@@ -1 +0,0 @@
-{"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["export type * from \"./abstractions/IWebsocketsAction.js\";\nexport type * from \"./abstractions/IWebsocketsActions.js\";\nexport * from \"./abstractions/IWebsocketsConnection.js\";\nexport type * from \"./abstractions/IWebsocketsManager.js\";\nexport type * from \"./abstractions/IWebsocketsSubscriptionManager.js\";\n\nexport * from \"./abstractions/types.js\";\n"],"mappings":"AAEA;AAIA","ignoreList":[]}

package/hooks/index.js.map

@@ -1 +0,0 @@
-{"version":3,"names":[],"sources":["index.ts"],"sourcesContent":["export * from \"./useWebsockets.js\";\n"],"mappings":"AAAA","ignoreList":[]}

package/types.js.map

@@ -1 +0,0 @@
-{"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["import type {\n    IGenericData,\n    IWebsocketsAction,\n    IWebsocketsManagerCloseEvent,\n    IWebsocketsManagerErrorEvent,\n    IWebsocketsManagerMessageEvent,\n    IWebsocketsSubscription\n} from \"~/domain/types.js\";\n\nexport * from \"./domain/types.js\";\n\nexport interface IWebsocketsContextSendCallable {\n    <T extends IGenericData = IGenericData>(action: string, data?: T, timeout?: number): void;\n}\n\nexport interface IWebsocketsContextCreateActionCallable<\n    T extends IGenericData = IGenericData,\n    R extends IGenericData = IGenericData\n> {\n    (name: string): IWebsocketsAction<T, R>;\n}\n\nexport interface ISocketsContextOnMessageCallable {\n    <T extends IncomingGenericData = IncomingGenericData>(\n        action: string,\n        cb: (data: T) => void\n    ): IWebsocketsSubscription<IWebsocketsManagerMessageEvent<T>>;\n}\n\nexport interface ISocketsContextOnErrorCallable {\n    (\n        cb: (data: IWebsocketsManagerErrorEvent) => void\n    ): IWebsocketsSubscription<IWebsocketsManagerErrorEvent>;\n}\n\nexport interface ISocketsContextOnCloseCallable {\n    (\n        cb: (data: IWebsocketsManagerCloseEvent) => void\n    ): IWebsocketsSubscription<IWebsocketsManagerCloseEvent>;\n}\n\nexport interface IWebsocketsContext {\n    send: IWebsocketsContextSendCallable;\n    createAction: IWebsocketsContextCreateActionCallable;\n    onMessage: ISocketsContextOnMessageCallable;\n    onError: ISocketsContextOnErrorCallable;\n    onClose: ISocketsContextOnCloseCallable;\n}\n\nexport interface IncomingGenericData extends IGenericData {\n    action: string;\n}\n"],"mappings":"AASA;AAAkC","ignoreList":[]}