@typetron/websockets 0.3.13 → 0.4.0-rc6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/index.d.ts +22 -22
  2. package/index.d.ts.map +1 -1
  3. package/index.js +74 -78
  4. package/index.js.map +1 -1
  5. package/package.json +43 -43
  6. package/Readme.md +0 -86
package/index.d.ts CHANGED
@@ -1,23 +1,23 @@
1
- import { Observable, ReplaySubject, Subject } from 'rxjs';
2
- import { EventRequest, EventErrorResponse, EventResponse } from '@typetron/framework/Router/Websockets/types';
3
- export declare class Websocket {
4
- url: string;
5
- protocols?: string | string[] | undefined;
6
- socket?: WebSocket;
7
- eventMessages$: Subject<EventResponse<unknown>>;
8
- queuedEvents$: ReplaySubject<EventRequest>;
9
- errors$: Subject<EventErrorResponse<"">>;
10
- onConnectCallback: Function;
11
- constructor(url: string, protocols?: string | string[] | undefined);
12
- get isConnected(): boolean;
13
- connect(url?: string, protocols?: string | string[]): void;
14
- onConnect(callback: Function): void;
15
- reconnect(): void;
16
- emit<T>(event: string, request?: EventRequest['message']): void;
17
- on<T>(event: string): Observable<T>;
18
- onError({ except }: {
19
- except?: string[];
20
- }): Observable<EventResponse<unknown>>;
21
- request<T>(event: string, message?: EventRequest['message']): Promise<T>;
22
- }
1
+ import { Observable, ReplaySubject, Subject } from 'rxjs';
2
+ import { EventErrorResponse, EventRequest, EventResponse } from '@typetron/framework/Router/Websockets/types';
3
+ export declare class Websocket {
4
+ url: string;
5
+ protocols?: string | string[] | undefined;
6
+ socket?: WebSocket;
7
+ eventMessages$: Subject<EventResponse<unknown>>;
8
+ queuedEvents$: ReplaySubject<EventRequest>;
9
+ errors$: Subject<EventErrorResponse>;
10
+ onConnectCallback: () => void;
11
+ constructor(url: string, protocols?: string | string[] | undefined);
12
+ get isConnected(): boolean;
13
+ connect(url?: string, protocols?: string | string[]): void;
14
+ onConnect(callback: () => void): void;
15
+ reconnect(): void;
16
+ emit<T>(event: string, request?: EventRequest['message']): void;
17
+ on<T>(event: string): Observable<T>;
18
+ onError({ except }: {
19
+ except?: string[];
20
+ }): Observable<EventResponse<unknown>>;
21
+ request<T>(event: string, message?: EventRequest['message']): Promise<T>;
22
+ }
23
23
  //# sourceMappingURL=index.d.ts.map
package/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAM,aAAa,EAAE,OAAO,EAAc,MAAM,MAAM,CAAA;AAEzE,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,aAAa,EAA0B,MAAM,6CAA6C,CAAA;AAErI,qBAAa,SAAS;IASC,GAAG,EAAE,MAAM;IAAS,SAAS,CAAC;IARjD,MAAM,CAAC,EAAE,SAAS,CAAA;IAElB,cAAc,kCAAwC;IACtD,aAAa,8BAAoC;IAEjD,OAAO,kCAAoC;IAC3C,iBAAiB,EAAE,QAAQ,CAAA;gBAER,GAAG,EAAE,MAAM,EAAS,SAAS,CAAC,+BAAmB;IAIpE,IAAI,WAAW,YAEd;IAED,OAAO,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI;IAqB1D,SAAS,CAAC,QAAQ,EAAE,QAAQ;IAI5B,SAAS,IAAI,IAAI;IAQjB,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC,GAAG,IAAI;IAK/D,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,GAAG,UAAU,CAAC,CAAC,CAAC;IAenC,OAAO,CAAC,EAAC,MAAM,EAAC,EAAE;QAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;KAAC,GAAG,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAIpE,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;CASjF"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAM,aAAa,EAAE,OAAO,EAAc,MAAM,MAAM,CAAA;AAEzE,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,aAAa,EAA0B,MAAM,6CAA6C,CAAA;AAErI,qBAAa,SAAS;IAQC,GAAG,EAAE,MAAM;IAAS,SAAS,CAAC;IAPjD,MAAM,CAAC,EAAE,SAAS,CAAA;IAElB,cAAc,kCAAwC;IACtD,aAAa,8BAAoC;IACjD,OAAO,8BAAoC;IAC3C,iBAAiB,EAAE,MAAM,IAAI,CAAA;gBAEV,GAAG,EAAE,MAAM,EAAS,SAAS,CAAC,+BAAmB;IAIpE,IAAI,WAAW,YAEd;IAED,OAAO,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI;IAqB1D,SAAS,CAAC,QAAQ,EAAE,MAAM,IAAI;IAI9B,SAAS,IAAI,IAAI;IAQjB,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC,GAAG,IAAI;IAK/D,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,GAAG,UAAU,CAAC,CAAC,CAAC;IAenC,OAAO,CAAC,EAAC,MAAM,EAAC,EAAE;QAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;KAAC,GAAG,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAIpE,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;CASjF"}
package/index.js CHANGED
@@ -1,79 +1,75 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.Websocket = void 0;
4
- const rxjs_1 = require("rxjs");
5
- const operators_1 = require("rxjs/operators");
6
- const types_1 = require("@typetron/framework/Router/Websockets/types");
7
- class Websocket {
8
- constructor(url, protocols) {
9
- this.url = url;
10
- this.protocols = protocols;
11
- this.eventMessages$ = new rxjs_1.Subject();
12
- this.queuedEvents$ = new rxjs_1.ReplaySubject();
13
- // @ts-ignore
14
- this.errors$ = new rxjs_1.Subject();
15
- this.connect(url, protocols);
16
- }
17
- get isConnected() {
18
- var _a;
19
- return ((_a = this.socket) === null || _a === void 0 ? void 0 : _a.readyState) === WebSocket.OPEN;
20
- }
21
- connect(url, protocols) {
22
- const socket = new WebSocket(url !== null && url !== void 0 ? url : this.url, protocols !== null && protocols !== void 0 ? protocols : this.protocols);
23
- this.socket = socket;
24
- socket.onmessage = (event) => {
25
- const message = JSON.parse(event.data);
26
- this.eventMessages$.next(message);
27
- };
28
- socket.onopen = () => {
29
- var _a;
30
- (_a = this.onConnectCallback) === null || _a === void 0 ? void 0 : _a.call(this);
31
- this.queuedEvents$.subscribe(message => {
32
- socket.send(JSON.stringify(message));
33
- });
34
- };
35
- socket.onclose = (event) => {
36
- this.queuedEvents$ = new rxjs_1.ReplaySubject();
37
- this.reconnect();
38
- };
39
- }
40
- onConnect(callback) {
41
- this.onConnectCallback = callback;
42
- }
43
- reconnect() {
44
- var _a;
45
- if (((_a = this.socket) === null || _a === void 0 ? void 0 : _a.readyState) === WebSocket.CLOSED) {
46
- window.setTimeout(() => {
47
- this.connect(this.url, this.protocols);
48
- }, 1000);
49
- }
50
- }
51
- emit(event, request) {
52
- const eventMessage = { event, message: request };
53
- this.queuedEvents$.next(eventMessage);
54
- }
55
- on(event) {
56
- return this.eventMessages$.pipe(operators_1.filter(eventMessage => eventMessage.event === event), operators_1.switchMap(eventMessage => {
57
- if (eventMessage.status === types_1.WebsocketMessageStatus.Error) {
58
- // @ts-ignore
59
- this.errors$.next(eventMessage);
60
- return rxjs_1.throwError(eventMessage);
61
- }
62
- return rxjs_1.of(eventMessage);
63
- }), operators_1.map(eventMessage => eventMessage.message));
64
- }
65
- onError({ except }) {
66
- return this.errors$.pipe(operators_1.filter(eventMessage => !(except || []).includes(eventMessage.event)));
67
- }
68
- async request(event, message) {
69
- this.emit(event, message);
70
- return new Promise((resolve, reject) => {
71
- this.on(event).pipe(operators_1.take(1)).subscribe({
72
- next: resolve,
73
- error: reject
74
- });
75
- });
76
- }
77
- }
78
- exports.Websocket = Websocket;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.Websocket = void 0;
4
+ const rxjs_1 = require("rxjs");
5
+ const operators_1 = require("rxjs/operators");
6
+ const types_1 = require("@typetron/framework/Router/Websockets/types");
7
+ class Websocket {
8
+ constructor(url, protocols) {
9
+ this.url = url;
10
+ this.protocols = protocols;
11
+ this.eventMessages$ = new rxjs_1.Subject();
12
+ this.queuedEvents$ = new rxjs_1.ReplaySubject();
13
+ this.errors$ = new rxjs_1.Subject();
14
+ this.connect(url, protocols);
15
+ }
16
+ get isConnected() {
17
+ return this.socket?.readyState === WebSocket.OPEN;
18
+ }
19
+ connect(url, protocols) {
20
+ const socket = new WebSocket(url ?? this.url, protocols ?? this.protocols);
21
+ this.socket = socket;
22
+ socket.onmessage = (event) => {
23
+ const message = JSON.parse(event.data);
24
+ this.eventMessages$.next(message);
25
+ };
26
+ socket.onopen = () => {
27
+ this.onConnectCallback?.();
28
+ this.queuedEvents$.subscribe(message => {
29
+ socket.send(JSON.stringify(message));
30
+ });
31
+ };
32
+ socket.onclose = (event) => {
33
+ this.queuedEvents$ = new rxjs_1.ReplaySubject();
34
+ this.reconnect();
35
+ };
36
+ }
37
+ onConnect(callback) {
38
+ this.onConnectCallback = callback;
39
+ }
40
+ reconnect() {
41
+ if (this.socket?.readyState === WebSocket.CLOSED) {
42
+ window.setTimeout(() => {
43
+ this.connect(this.url, this.protocols);
44
+ }, 1000);
45
+ }
46
+ }
47
+ emit(event, request) {
48
+ const eventMessage = { event, message: request };
49
+ this.queuedEvents$.next(eventMessage);
50
+ }
51
+ on(event) {
52
+ return this.eventMessages$.pipe((0, operators_1.filter)(eventMessage => eventMessage.event === event), (0, operators_1.switchMap)(eventMessage => {
53
+ if (eventMessage.status === types_1.WebsocketMessageStatus.Error) {
54
+ // @ts-ignore
55
+ this.errors$.next(eventMessage);
56
+ return (0, rxjs_1.throwError)(eventMessage);
57
+ }
58
+ return (0, rxjs_1.of)(eventMessage);
59
+ }), (0, operators_1.map)(eventMessage => eventMessage.message));
60
+ }
61
+ onError({ except }) {
62
+ return this.errors$.pipe((0, operators_1.filter)(eventMessage => !(except || []).includes(eventMessage.event)));
63
+ }
64
+ async request(event, message) {
65
+ this.emit(event, message);
66
+ return new Promise((resolve, reject) => {
67
+ this.on(event).pipe((0, operators_1.take)(1)).subscribe({
68
+ next: resolve,
69
+ error: reject
70
+ });
71
+ });
72
+ }
73
+ }
74
+ exports.Websocket = Websocket;
79
75
  //# sourceMappingURL=index.js.map
package/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,+BAAyE;AACzE,8CAA6D;AAC7D,uEAAqI;AAErI,MAAa,SAAS;IASlB,YAAmB,GAAW,EAAS,SAA6B;QAAjD,QAAG,GAAH,GAAG,CAAQ;QAAS,cAAS,GAAT,SAAS,CAAoB;QANpE,mBAAc,GAAG,IAAI,cAAO,EAA0B,CAAA;QACtD,kBAAa,GAAG,IAAI,oBAAa,EAAgB,CAAA;QACjD,aAAa;QACb,YAAO,GAAG,IAAI,cAAO,EAAsB,CAAA;QAIvC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,SAAS,CAAC,CAAA;IAChC,CAAC;IAED,IAAI,WAAW;;QACX,OAAO,OAAA,IAAI,CAAC,MAAM,0CAAE,UAAU,MAAK,SAAS,CAAC,IAAI,CAAA;IACrD,CAAC;IAED,OAAO,CAAC,GAAY,EAAE,SAA6B;QAC/C,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC,GAAG,aAAH,GAAG,cAAH,GAAG,GAAI,IAAI,CAAC,GAAG,EAAE,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,IAAI,CAAC,SAAS,CAAC,CAAA;QAC1E,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QAEpB,MAAM,CAAC,SAAS,GAAG,CAAC,KAAK,EAAE,EAAE;YACzB,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YACtC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACrC,CAAC,CAAA;QACD,MAAM,CAAC,MAAM,GAAG,GAAG,EAAE;;YACjB,MAAA,IAAI,CAAC,iBAAiB,+CAAtB,IAAI,EAAsB;YAC1B,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE;gBACnC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAA;YACxC,CAAC,CAAC,CAAA;QACN,CAAC,CAAA;QAED,MAAM,CAAC,OAAO,GAAG,CAAC,KAAK,EAAE,EAAE;YACvB,IAAI,CAAC,aAAa,GAAG,IAAI,oBAAa,EAAgB,CAAA;YACtD,IAAI,CAAC,SAAS,EAAE,CAAA;QACpB,CAAC,CAAA;IACL,CAAC;IAED,SAAS,CAAC,QAAkB;QACxB,IAAI,CAAC,iBAAiB,GAAG,QAAQ,CAAA;IACrC,CAAC;IAED,SAAS;;QACL,IAAI,OAAA,IAAI,CAAC,MAAM,0CAAE,UAAU,MAAK,SAAS,CAAC,MAAM,EAAE;YAC9C,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE;gBACnB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;YAC1C,CAAC,EAAE,IAAI,CAAC,CAAA;SACX;IACL,CAAC;IAED,IAAI,CAAI,KAAa,EAAE,OAAiC;QACpD,MAAM,YAAY,GAAiB,EAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAC,CAAA;QAC5D,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;IACzC,CAAC;IAED,EAAE,CAAI,KAAa;QACf,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC3B,kBAAM,CAAC,YAAY,CAAC,EAAE,CAAC,YAAY,CAAC,KAAK,KAAK,KAAK,CAAC,EACpD,qBAAS,CAAC,YAAY,CAAC,EAAE;YACrB,IAAI,YAAY,CAAC,MAAM,KAAK,8BAAsB,CAAC,KAAK,EAAE;gBACtD,aAAa;gBACb,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAkC,CAAC,CAAA;gBACrD,OAAO,iBAAU,CAAC,YAAY,CAAC,CAAA;aAClC;YACD,OAAO,SAAE,CAAC,YAAY,CAAC,CAAA;QAC3B,CAAC,CAAC,EACF,eAAG,CAAC,YAAY,CAAC,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,CAC3B,CAAA;IACtB,CAAC;IAED,OAAO,CAAC,EAAC,MAAM,EAAsB;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAM,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IAClG,CAAC;IAED,KAAK,CAAC,OAAO,CAAI,KAAa,EAAE,OAAiC;QAC7D,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;QACzB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,EAAE,CAAI,KAAK,CAAC,CAAC,IAAI,CAAC,gBAAI,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;gBACtC,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,MAAM;aAChB,CAAC,CAAA;QACN,CAAC,CAAC,CAAA;IACN,CAAC;CACJ;AAnFD,8BAmFC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,+BAAyE;AACzE,8CAA6D;AAC7D,uEAAqI;AAErI,MAAa,SAAS;IAQlB,YAAmB,GAAW,EAAS,SAA6B;QAAjD,QAAG,GAAH,GAAG,CAAQ;QAAS,cAAS,GAAT,SAAS,CAAoB;QALpE,mBAAc,GAAG,IAAI,cAAO,EAA0B,CAAA;QACtD,kBAAa,GAAG,IAAI,oBAAa,EAAgB,CAAA;QACjD,YAAO,GAAG,IAAI,cAAO,EAAsB,CAAA;QAIvC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,SAAS,CAAC,CAAA;IAChC,CAAC;IAED,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,MAAM,EAAE,UAAU,KAAK,SAAS,CAAC,IAAI,CAAA;IACrD,CAAC;IAED,OAAO,CAAC,GAAY,EAAE,SAA6B;QAC/C,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,EAAE,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC,CAAA;QAC1E,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QAEpB,MAAM,CAAC,SAAS,GAAG,CAAC,KAAK,EAAE,EAAE;YACzB,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YACtC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACrC,CAAC,CAAA;QACD,MAAM,CAAC,MAAM,GAAG,GAAG,EAAE;YACjB,IAAI,CAAC,iBAAiB,EAAE,EAAE,CAAA;YAC1B,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE;gBACnC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAA;YACxC,CAAC,CAAC,CAAA;QACN,CAAC,CAAA;QAED,MAAM,CAAC,OAAO,GAAG,CAAC,KAAK,EAAE,EAAE;YACvB,IAAI,CAAC,aAAa,GAAG,IAAI,oBAAa,EAAgB,CAAA;YACtD,IAAI,CAAC,SAAS,EAAE,CAAA;QACpB,CAAC,CAAA;IACL,CAAC;IAED,SAAS,CAAC,QAAoB;QAC1B,IAAI,CAAC,iBAAiB,GAAG,QAAQ,CAAA;IACrC,CAAC;IAED,SAAS;QACL,IAAI,IAAI,CAAC,MAAM,EAAE,UAAU,KAAK,SAAS,CAAC,MAAM,EAAE;YAC9C,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE;gBACnB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;YAC1C,CAAC,EAAE,IAAI,CAAC,CAAA;SACX;IACL,CAAC;IAED,IAAI,CAAI,KAAa,EAAE,OAAiC;QACpD,MAAM,YAAY,GAAiB,EAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAC,CAAA;QAC5D,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;IACzC,CAAC;IAED,EAAE,CAAI,KAAa;QACf,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC3B,IAAA,kBAAM,EAAC,YAAY,CAAC,EAAE,CAAC,YAAY,CAAC,KAAK,KAAK,KAAK,CAAC,EACpD,IAAA,qBAAS,EAAC,YAAY,CAAC,EAAE;YACrB,IAAI,YAAY,CAAC,MAAM,KAAK,8BAAsB,CAAC,KAAK,EAAE;gBACtD,aAAa;gBACb,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAkC,CAAC,CAAA;gBACrD,OAAO,IAAA,iBAAU,EAAC,YAAY,CAAC,CAAA;aAClC;YACD,OAAO,IAAA,SAAE,EAAC,YAAY,CAAC,CAAA;QAC3B,CAAC,CAAC,EACF,IAAA,eAAG,EAAC,YAAY,CAAC,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,CAC3B,CAAA;IACtB,CAAC;IAED,OAAO,CAAC,EAAC,MAAM,EAAsB;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,kBAAM,EAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IAClG,CAAC;IAED,KAAK,CAAC,OAAO,CAAI,KAAa,EAAE,OAAiC;QAC7D,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;QACzB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,EAAE,CAAI,KAAK,CAAC,CAAC,IAAI,CAAC,IAAA,gBAAI,EAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;gBACtC,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,MAAM;aAChB,CAAC,CAAA;QACN,CAAC,CAAC,CAAA;IACN,CAAC;CACJ;AAlFD,8BAkFC"}
package/package.json CHANGED
@@ -1,43 +1,43 @@
1
- {
2
- "name": "@typetron/websockets",
3
- "description": "Typetron Websockets library",
4
- "keywords": [
5
- "websockets",
6
- "typetron",
7
- "nodejs",
8
- " typescript",
9
- "real-time",
10
- "realtime"
11
- ],
12
- "license": "MIT",
13
- "version": "0.3.13",
14
- "author": {
15
- "email": "ionel@typetron.org",
16
- "name": "Ionel Lupu"
17
- },
18
- "scripts": {
19
- "build": "tsc"
20
- },
21
- "engines": {
22
- "node": ">= 12.13.0"
23
- },
24
- "peerDependencies": {
25
- "rxjs": "~7.4.0"
26
- },
27
- "dependencies": {
28
- "@typetron/framework": "^0.3.11"
29
- },
30
- "devDependencies": {
31
- "typescript": "4.1.6"
32
- },
33
- "repository": {
34
- "type": "git",
35
- "url": "https://github.com/typetron/websockets.git"
36
- },
37
- "files": [
38
- "**/*.ts",
39
- "**/*.js",
40
- "**/*.ts.map",
41
- "**/*.js.map"
42
- ]
43
- }
1
+ {
2
+ "name": "@typetron/websockets",
3
+ "description": "Typetron Websockets library",
4
+ "keywords": [
5
+ "websockets",
6
+ "typetron",
7
+ "nodejs",
8
+ " typescript",
9
+ "real-time",
10
+ "realtime"
11
+ ],
12
+ "license": "MIT",
13
+ "version": "0.4.0-rc6",
14
+ "author": {
15
+ "email": "ionel@typetron.org",
16
+ "name": "Ionel Lupu"
17
+ },
18
+ "scripts": {
19
+ "build": "tsc"
20
+ },
21
+ "engines": {
22
+ "node": ">= 12.13.0"
23
+ },
24
+ "peerDependencies": {
25
+ "rxjs": "~7.8.1"
26
+ },
27
+ "dependencies": {
28
+ "@typetron/framework": "0.4.0-rc6"
29
+ },
30
+ "devDependencies": {
31
+ "typescript": "5.2.2"
32
+ },
33
+ "repository": {
34
+ "type": "git",
35
+ "url": "https://github.com/typetron/websockets.git"
36
+ },
37
+ "files": [
38
+ "**/*.ts",
39
+ "**/*.js",
40
+ "**/*.ts.map",
41
+ "**/*.js.map"
42
+ ]
43
+ }
package/Readme.md DELETED
@@ -1,86 +0,0 @@
1
- # Typetron WebSockets
2
-
3
- This library is used to easily listen and emit WebSockets event from the browser client to a Typetron app.
4
-
5
- #### Installation
6
-
7
- ```bash
8
- $ npm install @typetron/websockets
9
- ```
10
-
11
- Note: you need to have a module loader in your app for this to work (webpack, rollup, babel, parcel, etc.)
12
-
13
- #### Listening for events
14
-
15
- You can listen to a WebSocket event sent from the server using the _on('Event name')_ method like this on the socket
16
- connection:
17
-
18
- ```ts
19
- socket.on('eventName').subscribe(response => {
20
- console.log('Backend response', response)
21
- })
22
- socket.on<User>('user.update').subscribe(user => {
23
- console.log('User updated', user)
24
- })
25
- ```
26
-
27
- The _on_ method will return an observable (see [RxJS](https://rxjs.dev/) for more details) that you can use to subscribe
28
- to.
29
-
30
- #### Emitting events
31
-
32
- If you want to signal the server with and event or when you want to send some data to it, you can use the _emit('event
33
- name', data)_ method:
34
-
35
- ```ts
36
- socket.emit('eventName');
37
- socket.emit('eventName', "my message here");
38
- socket.emit('eventName', {my: {message: "here"}});
39
- ```
40
-
41
- Be aware that if you are expecting a response from the backend, you need to subscribe to the same event (or the event
42
- the server is emitting to) using the _.on_ method.
43
-
44
- #### Emitting and listening for server response
45
-
46
- If you want to make a single "request" to the server, meaning that you want to emit and wait for a response at the same
47
- time, you can use the _request('event name', data?)_ method. This will essentially make an _emit_ and listen to its
48
- response using the _on_ method for you:
49
-
50
- ```ts
51
- const users = await socket.request<User[]>('users.list')
52
- const savedUser = await socket.request<User>('users.save', {name: 'John'})
53
- ```
54
-
55
- #### Message format of the WebSocket events
56
-
57
- The Typetron WebSocket server uses a specific message format when exchanging information between it and the clients.
58
- These message have the following format:
59
- _When sending a message:_
60
-
61
- ```json
62
- {
63
- "event": "event name",
64
- "message": {
65
- // optional
66
- "body": "content sent to the controllers",
67
- "parameters": [
68
- "param1",
69
- "param1"
70
- ]
71
- // controller method parameters (optional)
72
- }
73
- }
74
- ```
75
-
76
- _When receiving a message:_
77
-
78
- ```json
79
- {
80
- "event": "event name",
81
- "status": "OK"
82
- // or "Error",
83
- "message": "backend response"
84
- // optional
85
- }
86
- ```