@nmtjs/protocol 0.15.0-beta.37 → 0.15.0-beta.39

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 (93) hide show
  1. package/LICENSE.md +1 -1
  2. package/README.md +1 -1
  3. package/dist/client/format.d.ts +18 -13
  4. package/dist/client/format.js +1 -0
  5. package/dist/client/format.js.map +1 -0
  6. package/dist/client/index.d.ts +4 -1
  7. package/dist/client/index.js +7 -4
  8. package/dist/client/index.js.map +1 -0
  9. package/dist/client/protocol.d.ts +102 -138
  10. package/dist/client/protocol.js +7 -336
  11. package/dist/client/protocol.js.map +1 -0
  12. package/dist/client/stream.d.ts +34 -19
  13. package/dist/client/stream.js +138 -46
  14. package/dist/client/stream.js.map +1 -0
  15. package/dist/client/versions/v1.d.ts +108 -0
  16. package/dist/client/versions/v1.js +128 -0
  17. package/dist/client/versions/v1.js.map +1 -0
  18. package/dist/common/binary.d.ts +5 -6
  19. package/dist/common/binary.js +22 -9
  20. package/dist/common/binary.js.map +1 -0
  21. package/dist/common/blob.d.ts +14 -8
  22. package/dist/common/blob.js +55 -30
  23. package/dist/common/blob.js.map +1 -0
  24. package/dist/common/constants.d.ts +2 -0
  25. package/dist/common/constants.js +2 -0
  26. package/dist/common/constants.js.map +1 -0
  27. package/dist/common/enums.d.ts +17 -7
  28. package/dist/common/enums.js +34 -14
  29. package/dist/common/enums.js.map +1 -0
  30. package/dist/common/index.d.ts +2 -0
  31. package/dist/common/index.js +7 -4
  32. package/dist/common/index.js.map +1 -0
  33. package/dist/common/types.d.ts +5 -24
  34. package/dist/common/types.js +1 -0
  35. package/dist/common/types.js.map +1 -0
  36. package/dist/common/utils.d.ts +2 -0
  37. package/dist/common/utils.js +7 -0
  38. package/dist/common/utils.js.map +1 -0
  39. package/dist/server/format.d.ts +17 -23
  40. package/dist/server/format.js +13 -8
  41. package/dist/server/format.js.map +1 -0
  42. package/dist/server/index.d.ts +4 -6
  43. package/dist/server/index.js +9 -11
  44. package/dist/server/index.js.map +1 -0
  45. package/dist/server/protocol.d.ts +88 -114
  46. package/dist/server/protocol.js +5 -354
  47. package/dist/server/protocol.js.map +1 -0
  48. package/dist/server/stream.d.ts +5 -0
  49. package/dist/server/stream.js +31 -2
  50. package/dist/server/stream.js.map +1 -0
  51. package/dist/server/types.d.ts +29 -8
  52. package/dist/server/types.js +1 -0
  53. package/dist/server/types.js.map +1 -0
  54. package/dist/server/utils.d.ts +3 -6
  55. package/dist/server/utils.js +5 -4
  56. package/dist/server/utils.js.map +1 -0
  57. package/dist/server/versions/v1.d.ts +77 -0
  58. package/dist/server/versions/v1.js +119 -0
  59. package/dist/server/versions/v1.js.map +1 -0
  60. package/package.json +18 -24
  61. package/src/client/format.ts +49 -0
  62. package/src/client/index.ts +8 -0
  63. package/src/client/protocol.ts +107 -0
  64. package/src/client/stream.ts +222 -0
  65. package/src/client/versions/v1.ts +205 -0
  66. package/src/common/binary.ts +70 -0
  67. package/src/common/blob.ts +94 -0
  68. package/src/common/constants.ts +2 -0
  69. package/src/common/enums.ts +62 -0
  70. package/src/common/index.ts +6 -0
  71. package/src/common/types.ts +18 -0
  72. package/src/common/utils.ts +12 -0
  73. package/src/server/format.ts +117 -0
  74. package/src/server/index.ts +10 -0
  75. package/src/server/protocol.ts +97 -0
  76. package/src/server/stream.ts +72 -0
  77. package/src/server/types.ts +42 -0
  78. package/src/server/utils.ts +22 -0
  79. package/src/server/versions/v1.ts +198 -0
  80. package/dist/client/events.d.ts +0 -15
  81. package/dist/client/events.js +0 -28
  82. package/dist/server/api.d.ts +0 -33
  83. package/dist/server/api.js +0 -7
  84. package/dist/server/connection.d.ts +0 -25
  85. package/dist/server/connection.js +0 -22
  86. package/dist/server/constants.d.ts +0 -4
  87. package/dist/server/constants.js +0 -2
  88. package/dist/server/injectables.d.ts +0 -14
  89. package/dist/server/injectables.js +0 -22
  90. package/dist/server/registry.d.ts +0 -3
  91. package/dist/server/registry.js +0 -3
  92. package/dist/server/transport.d.ts +0 -23
  93. package/dist/server/transport.js +0 -3
@@ -1,33 +1,14 @@
1
- import type { OneOf } from '@nmtjs/common';
2
- import type { ProtocolBlob, ProtocolBlobMetadata } from './blob.ts';
1
+ import type { ProtocolBlobMetadata } from './blob.ts';
3
2
  type Stream = any;
4
3
  export interface BaseProtocolError {
5
4
  code: string;
6
5
  message: string;
7
6
  data?: any;
8
7
  }
9
- export type ProtocolRPC = {
10
- callId: number;
11
- procedure: string;
12
- payload: any;
13
- };
14
- export type ProtocolRPCResponse<T = Stream> = OneOf<[
15
- {
16
- callId: number;
17
- error: BaseProtocolError;
18
- },
19
- {
20
- callId: number;
21
- result: any;
22
- streams: Record<number, T>;
23
- }
24
- ]>;
25
- export interface EncodeRPCContext<T = Stream> {
26
- getStream: (id: number) => T;
27
- addStream: (blob: ProtocolBlob) => T;
28
- }
8
+ export type ProtocolRPCPayload = unknown;
9
+ export type ProtocolRPCResponse = unknown;
10
+ export type EncodeRPCStreams = Record<number, ProtocolBlobMetadata>;
29
11
  export interface DecodeRPCContext<T = Stream> {
30
- getStream: (id: number, callId: number) => T;
31
- addStream: (id: number, callId: number, metadata: ProtocolBlobMetadata) => T;
12
+ addStream: (id: number, metadata: ProtocolBlobMetadata) => T;
32
13
  }
33
14
  export {};
@@ -1 +1,2 @@
1
1
  export {};
2
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/common/types.ts"],"names":[],"mappings":""}
@@ -0,0 +1,2 @@
1
+ import type { ProtocolBlobInterface } from './blob.ts';
2
+ export declare const isBlobInterface: <T extends ProtocolBlobInterface>(value: any) => value is T;
@@ -0,0 +1,7 @@
1
+ import { kBlobKey } from './constants.js';
2
+ export const isBlobInterface = (value) => {
3
+ return (value &&
4
+ (typeof value === 'object' || typeof value === 'function') &&
5
+ kBlobKey in value);
6
+ };
7
+ //# sourceMappingURL=utils.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/common/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAEzC,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,KAAU,EACE,EAAE,CAAC;IACf,OAAO,CACL,KAAK;QACL,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,UAAU,CAAC;QAC1D,QAAQ,IAAI,KAAK,CAClB,CAAA;AAAA,CACF,CAAA"}
@@ -1,39 +1,33 @@
1
- import type { OneOf } from '@nmtjs/common';
2
- import type { Pattern } from '@nmtjs/core';
3
- import type { DecodeRPCContext, EncodeRPCContext, ProtocolRPC, ProtocolRPCResponse } from '../common/types.ts';
4
- import type { ProtocolClientStream, ProtocolServerStream } from './stream.ts';
1
+ import type { Pattern } from '@nmtjs/common';
2
+ import type { ProtocolBlobMetadata } from '../common/blob.ts';
3
+ import type { DecodeRPCContext, EncodeRPCStreams, ProtocolRPCPayload } from '../common/types.ts';
4
+ import type { ProtocolClientStream } from './stream.ts';
5
5
  export interface BaseServerDecoder {
6
6
  accept: Pattern[];
7
- decode(buffer: ArrayBuffer): any;
8
- decodeRPC(buffer: ArrayBuffer, context: DecodeRPCContext<ProtocolClientStream>): ProtocolRPC;
7
+ decode(buffer: ArrayBufferView): unknown;
8
+ decodeRPC(buffer: ArrayBufferView, context: DecodeRPCContext<() => ProtocolClientStream>): ProtocolRPCPayload;
9
9
  }
10
10
  export interface BaseServerEncoder {
11
11
  contentType: string;
12
- encode(data: any): ArrayBuffer;
13
- encodeRPC(rpc: OneOf<[
14
- {
15
- callId: number;
16
- error: any;
17
- },
18
- {
19
- callId: number;
20
- result: any;
21
- }
22
- ]>, context: EncodeRPCContext<ProtocolServerStream>): ArrayBuffer;
12
+ encode(data: unknown): ArrayBufferView;
13
+ encodeRPC(data: unknown, streams: EncodeRPCStreams): ArrayBufferView;
14
+ encodeBlob(streamId: number, metadata: ProtocolBlobMetadata): unknown;
23
15
  }
24
16
  export declare abstract class BaseServerFormat implements BaseServerDecoder, BaseServerEncoder {
25
17
  abstract accept: Pattern[];
26
18
  abstract contentType: string;
27
- abstract encode(data: any): ArrayBuffer;
28
- abstract encodeRPC(rpc: ProtocolRPCResponse, context: EncodeRPCContext<ProtocolServerStream>): ArrayBuffer;
29
- abstract decode(buffer: ArrayBuffer): any;
30
- abstract decodeRPC(buffer: ArrayBuffer, context: DecodeRPCContext<ProtocolClientStream>): ProtocolRPC;
19
+ abstract encode(data: unknown): ArrayBufferView;
20
+ abstract encodeRPC(data: unknown, streams: EncodeRPCStreams): ArrayBufferView;
21
+ abstract encodeBlob(streamId: number, metadata: ProtocolBlobMetadata): unknown;
22
+ abstract decode(buffer: ArrayBufferView): any;
23
+ abstract decodeRPC(buffer: ArrayBufferView, context: DecodeRPCContext<() => ProtocolClientStream>): ProtocolRPCPayload;
31
24
  }
32
25
  export declare const parseContentTypes: (types: string) => string[];
33
- export declare class ProtocolFormat {
26
+ export declare class ProtocolFormats {
34
27
  decoders: Map<Pattern, BaseServerDecoder>;
35
28
  encoders: Map<Pattern, BaseServerEncoder>;
36
- constructor(formats: BaseServerFormat[]);
29
+ default: BaseServerFormat;
30
+ constructor(formats: [BaseServerFormat, ...BaseServerFormat[]]);
37
31
  supportsDecoder(contentType: string, throwIfUnsupported?: boolean): BaseServerDecoder | null;
38
32
  supportsEncoder(contentType: string, throwIfUnsupported?: boolean): BaseServerEncoder | null;
39
33
  private supports;
@@ -1,20 +1,22 @@
1
- import { match } from '@nmtjs/core';
1
+ import { match } from '@nmtjs/common';
2
2
  export class BaseServerFormat {
3
3
  }
4
4
  export const parseContentTypes = (types) => {
5
- if (types === '*/*')
5
+ const normalized = types.trim();
6
+ if (normalized === '*/*')
6
7
  return ['*/*'];
7
- return types
8
+ return normalized
8
9
  .split(',')
10
+ .map((t) => t.trim())
9
11
  .map((t) => {
10
- const [type, ...rest] = t.split(';');
12
+ const [rawType, ...rest] = t.split(';');
11
13
  const params = new Map(rest.map((p) => p
12
14
  .trim()
13
15
  .split('=')
14
16
  .slice(0, 2)
15
- .map((p) => p.trim())));
17
+ .map((part) => part.trim())));
16
18
  return {
17
- type,
19
+ type: rawType.trim(),
18
20
  q: params.has('q') ? Number.parseFloat(params.get('q')) : 1,
19
21
  };
20
22
  })
@@ -23,14 +25,16 @@ export const parseContentTypes = (types) => {
23
25
  return 1;
24
26
  if (b.type === '*/*')
25
27
  return -1;
26
- return b.q - a.q ? -1 : 1;
28
+ return b.q - a.q;
27
29
  })
28
30
  .map((t) => t.type);
29
31
  };
30
- export class ProtocolFormat {
32
+ export class ProtocolFormats {
31
33
  decoders = new Map();
32
34
  encoders = new Map();
35
+ default;
33
36
  constructor(formats) {
37
+ this.default = formats[0];
34
38
  for (const format of formats) {
35
39
  this.encoders.set(format.contentType, format);
36
40
  for (const acceptType of format.accept) {
@@ -58,3 +62,4 @@ export class ProtocolFormat {
58
62
  return null;
59
63
  }
60
64
  }
65
+ //# sourceMappingURL=format.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"format.js","sourceRoot":"","sources":["../../src/server/format.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAA;AA0BrC,MAAM,OAAgB,gBAAgB;CAcrC;AAED,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC;IAClD,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,EAAE,CAAA;IAC/B,IAAI,UAAU,KAAK,KAAK;QAAE,OAAO,CAAC,KAAK,CAAC,CAAA;IACxC,OAAO,UAAU;SACd,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;SACpB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QACV,MAAM,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QACvC,MAAM,MAAM,GAAG,IAAI,GAAG,CACpB,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CACb,CAAC;aACE,IAAI,EAAE;aACN,KAAK,CAAC,GAAG,CAAC;aACV,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;aACX,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CACR,CACxB,CAAA;QACD,OAAO;YACL,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE;YACpB,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC,CAAC,CAAC,CAAC,CAAC;SAC7D,CAAA;IAAA,CACF,CAAC;SACD,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QACd,IAAI,CAAC,CAAC,IAAI,KAAK,KAAK;YAAE,OAAO,CAAC,CAAA;QAC9B,IAAI,CAAC,CAAC,IAAI,KAAK,KAAK;YAAE,OAAO,CAAC,CAAC,CAAA;QAC/B,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IAAA,CACjB,CAAC;SACD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;AAAA,CACtB,CAAA;AAED,MAAM,OAAO,eAAe;IAC1B,QAAQ,GAAG,IAAI,GAAG,EAA8B,CAAA;IAChD,QAAQ,GAAG,IAAI,GAAG,EAA8B,CAAA;IAEhD,OAAO,CAAkB;IAEzB,YAAY,OAAkD,EAAE;QAC9D,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;QACzB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,CAAA;YAC7C,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;gBACvC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,CAAA;YACvC,CAAC;QACH,CAAC;IAAA,CACF;IAED,eAAe,CAAC,WAAmB,EAAE,kBAAkB,GAAG,KAAK,EAAE;QAC/D,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,WAAW,EAAE,kBAAkB,CAAC,CAAA;IAAA,CACrE;IAED,eAAe,CAAC,WAAmB,EAAE,kBAAkB,GAAG,KAAK,EAAE;QAC/D,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,WAAW,EAAE,kBAAkB,CAAC,CAAA;IAAA,CACrE;IAEO,QAAQ,CACd,OAAwB,EACxB,WAAmB,EACnB,kBAAkB,GAAG,KAAK,EAChB;QACV,0EAA0E;QAC1E,MAAM,KAAK,GAAG,iBAAiB,CAAC,WAAW,CAAC,CAAA;QAE5C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,KAAK,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;gBACxC,IAAI,IAAI,KAAK,KAAK,IAAI,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC;oBAAE,OAAO,MAAM,CAAA;YAC3D,CAAC;QACH,CAAC;QAED,IAAI,kBAAkB;YACpB,MAAM,IAAI,KAAK,CAAC,8BAA8B,WAAW,EAAE,CAAC,CAAA;QAE9D,OAAO,IAAI,CAAA;IAAA,CACZ;CACF"}
@@ -1,11 +1,9 @@
1
- export * from './api.ts';
2
- export * from './connection.ts';
3
- export * from './constants.ts';
4
1
  export * from './format.ts';
5
- export * from './injectables.ts';
6
2
  export * from './protocol.ts';
7
- export * from './registry.ts';
8
3
  export * from './stream.ts';
9
- export * from './transport.ts';
10
4
  export * from './types.ts';
11
5
  export * from './utils.ts';
6
+ import { ProtocolVersion1 } from './versions/v1.ts';
7
+ export declare const versions: {
8
+ 1: ProtocolVersion1;
9
+ };
@@ -1,11 +1,9 @@
1
- export * from "./api.js";
2
- export * from "./connection.js";
3
- export * from "./constants.js";
4
- export * from "./format.js";
5
- export * from "./injectables.js";
6
- export * from "./protocol.js";
7
- export * from "./registry.js";
8
- export * from "./stream.js";
9
- export * from "./transport.js";
10
- export * from "./types.js";
11
- export * from "./utils.js";
1
+ export * from './format.js';
2
+ export * from './protocol.js';
3
+ export * from './stream.js';
4
+ export * from './types.js';
5
+ export * from './utils.js';
6
+ import { ProtocolVersion } from '../common/enums.js';
7
+ import { ProtocolVersion1 } from './versions/v1.js';
8
+ export const versions = { [ProtocolVersion.v1]: new ProtocolVersion1() };
9
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/server/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,eAAe,CAAA;AAC7B,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAE1B,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AAEnD,MAAM,CAAC,MAAM,QAAQ,GAAG,EAAE,CAAC,eAAe,CAAC,EAAE,CAAC,EAAE,IAAI,gBAAgB,EAAE,EAAE,CAAA"}
@@ -1,16 +1,7 @@
1
- import type { Callback } from '@nmtjs/common';
2
- import type { AnyInjectable, Container, Logger } from '@nmtjs/core';
3
- import type { ProtocolBlob, ProtocolBlobMetadata } from '../common/blob.ts';
4
- import type { ProtocolRPC } from '../common/types.ts';
5
- import type { ProtocolApi, ProtocolApiCallOptions } from './api.ts';
6
- import type { ConnectionOptions } from './connection.ts';
7
- import type { ProtocolFormat } from './format.ts';
8
- import type { ProtocolRegistry } from './registry.ts';
9
- import type { Transport } from './transport.ts';
10
- import type { ResolveFormatParams } from './utils.ts';
11
- import { Connection, ConnectionContext } from './connection.ts';
12
- import { ProtocolClientStream, ProtocolServerStream } from './stream.ts';
13
- export declare class ProtocolError extends Error {
1
+ import type { ClientMessageType, ProtocolVersion, ServerMessageType } from '../common/enums.ts';
2
+ import type { BaseProtocolError, EncodeRPCStreams } from '../common/types.ts';
3
+ import type { MessageContext } from './types.ts';
4
+ export declare class ProtocolError extends Error implements BaseProtocolError {
14
5
  code: string;
15
6
  data?: any;
16
7
  constructor(code: string, message?: string, data?: any);
@@ -22,107 +13,90 @@ export declare class ProtocolError extends Error {
22
13
  data: any;
23
14
  };
24
15
  }
25
- export type ProtocolConnectionTransport = {
26
- send: Transport<any>['send'];
27
- };
28
- export declare class ProtocolConnections {
29
- #private;
30
- private readonly application;
31
- constructor(application: {
32
- logger: Logger;
33
- registry: ProtocolRegistry;
34
- format: ProtocolFormat;
35
- container: Container;
36
- });
37
- get(connectionId: string): {
38
- connection: Connection;
39
- context: ConnectionContext;
40
- transport: ProtocolConnectionTransport;
41
- };
42
- add<T>(transport: ProtocolConnectionTransport, options: ConnectionOptions<T>, params: ResolveFormatParams): Promise<{
43
- connection: Connection<T>;
44
- context: ConnectionContext;
45
- }>;
46
- remove(connectionId: string): Promise<void>;
47
- initialize(connection: Connection): Promise<void>;
48
- }
49
- export declare class ProtocolClientStreams {
50
- private readonly connections;
51
- constructor(connections: ProtocolConnections);
52
- get(connectionId: string, streamId: number): ProtocolClientStream;
53
- remove(connectionId: string, streamId: number): void;
54
- add(connectionId: string, streamId: number, metadata: ProtocolBlobMetadata, read: Callback): ProtocolClientStream;
55
- push(connectionId: string, streamId: number, chunk: ArrayBuffer): void;
56
- end(connectionId: string, streamId: number): void;
57
- abort(connectionId: string, streamId: number, error?: Error): void;
58
- }
59
- export declare class ProtocolServerStreams {
60
- private readonly connections;
61
- constructor(connections: ProtocolConnections);
62
- get(connectionId: string, streamId: number): ProtocolServerStream;
63
- add(connectionId: string, streamId: number, blob: ProtocolBlob): ProtocolServerStream;
64
- remove(connectionId: string, streamId: number): void;
65
- pull(connectionId: string, streamId: number): void;
66
- abort(connectionId: string, streamId: number, error?: Error): void;
16
+ export declare abstract class ProtocolVersionInterface {
17
+ abstract version: ProtocolVersion;
18
+ abstract decodeMessage(context: MessageContext, buffer: ArrayBufferView): {
19
+ [K in keyof ClientMessageTypePayload]: {
20
+ type: K;
21
+ } & ClientMessageTypePayload[K];
22
+ }[keyof ClientMessageTypePayload];
23
+ abstract encodeMessage<T extends ServerMessageType = ServerMessageType>(context: MessageContext, messageType: T, payload: ServerMessageTypePayload[T]): ArrayBufferView;
24
+ protected encode(...chunks: (ArrayBuffer | ArrayBufferView)[]): ArrayBufferView;
67
25
  }
68
- export type ProtocolRPCOptions = {
69
- signal?: AbortSignal;
70
- provides?: [AnyInjectable, any][];
71
- validateMetadata?: ProtocolApiCallOptions['validateMetadata'];
26
+ export type ServerMessageTypePayload = {
27
+ [ServerMessageType.RpcResponse]: {
28
+ callId: number;
29
+ result: any;
30
+ streams: EncodeRPCStreams;
31
+ error: any | null;
32
+ };
33
+ [ServerMessageType.RpcStreamAbort]: {
34
+ callId: number;
35
+ reason?: string;
36
+ };
37
+ [ServerMessageType.RpcStreamEnd]: {
38
+ callId: number;
39
+ };
40
+ [ServerMessageType.RpcStreamChunk]: {
41
+ callId: number;
42
+ chunk: ArrayBufferView;
43
+ };
44
+ [ServerMessageType.RpcStreamResponse]: {
45
+ callId: number;
46
+ };
47
+ [ServerMessageType.ClientStreamAbort]: {
48
+ streamId: number;
49
+ reason?: string;
50
+ };
51
+ [ServerMessageType.ClientStreamPull]: {
52
+ streamId: number;
53
+ size: number;
54
+ };
55
+ [ServerMessageType.ServerStreamAbort]: {
56
+ streamId: number;
57
+ reason?: string;
58
+ };
59
+ [ServerMessageType.ServerStreamEnd]: {
60
+ streamId: number;
61
+ };
62
+ [ServerMessageType.ServerStreamPush]: {
63
+ streamId: number;
64
+ chunk: ArrayBufferView;
65
+ };
72
66
  };
73
- export declare class Protocol {
74
- #private;
75
- protected readonly application: {
76
- logger: Logger;
77
- format: ProtocolFormat;
78
- container: Container;
79
- registry: ProtocolRegistry;
80
- api: ProtocolApi;
81
- };
82
- protected readonly options?: {
83
- persistConnections?: {
84
- timeout: number;
85
- };
86
- } | undefined;
87
- constructor(application: {
88
- logger: Logger;
89
- format: ProtocolFormat;
90
- container: Container;
91
- registry: ProtocolRegistry;
92
- api: ProtocolApi;
93
- }, options?: {
94
- persistConnections?: {
95
- timeout: number;
67
+ export type ClientMessageTypePayload = {
68
+ [ClientMessageType.Rpc]: {
69
+ rpc: {
70
+ callId: number;
71
+ procedure: string;
72
+ payload: unknown;
73
+ streams?: EncodeRPCStreams;
96
74
  };
97
- } | undefined);
98
- call(options: ProtocolApiCallOptions): Promise<import("./api.ts").ProtocolApiCallResult>;
99
- rpc(connectionId: string, rpc: ProtocolRPC, params?: ProtocolRPCOptions): Promise<void>;
100
- rpcRaw(connectionId: string, buffer: ArrayBuffer, params?: ProtocolRPCOptions): Promise<void>;
101
- rpcAbort(connectionId: string, callId: number): void;
102
- rpcAbortRaw(connectionId: string, buffer: ArrayBuffer): void;
103
- rpcStreamAbort(connectionId: string, callId: number): void;
104
- rpcStreamAbortRaw(connectionId: string, buffer: ArrayBuffer): void;
105
- notify(): void;
106
- addConnection(transport: ProtocolConnectionTransport, options: ConnectionOptions, params: ResolveFormatParams): Promise<{
107
- connection: Connection<unknown>;
108
- context: ConnectionContext;
109
- }>;
110
- removeConnection(connectionId: string): Promise<void>;
111
- getConnection(connectionId: string): {
112
- connection: Connection;
113
- context: ConnectionContext;
114
- transport: ProtocolConnectionTransport;
115
- };
116
- initializeConnection(connection: Connection): Promise<void>;
117
- getClientStream(connectionId: string, streamId: number): ProtocolClientStream;
118
- addClientStream(connectionId: string, streamId: number, metadata: ProtocolBlobMetadata, read: Callback): ProtocolClientStream;
119
- removeClientStream(connectionId: string, streamId: number): void;
120
- pushClientStream(connectionId: string, streamId: number, chunk: ArrayBuffer): void;
121
- endClientStream(connectionId: string, streamId: number): void;
122
- abortClientStream(connectionId: string, streamId: number, error?: Error): void;
123
- getServerStream(connectionId: string, streamId: number): ProtocolServerStream;
124
- addServerStream(connectionId: string, streamId: number, blob: ProtocolBlob): ProtocolServerStream;
125
- removeServerStream(connectionId: string, streamId: number): void;
126
- pullServerStream(connectionId: string, streamId: number): void;
127
- abortServerStream(connectionId: string, streamId: number, error?: Error): void;
128
- }
75
+ };
76
+ [ClientMessageType.RpcPull]: {
77
+ callId: number;
78
+ };
79
+ [ClientMessageType.RpcAbort]: {
80
+ callId: number;
81
+ reason?: string;
82
+ };
83
+ [ClientMessageType.ClientStreamPush]: {
84
+ streamId: number;
85
+ chunk: ArrayBufferView;
86
+ };
87
+ [ClientMessageType.ClientStreamEnd]: {
88
+ streamId: number;
89
+ };
90
+ [ClientMessageType.ClientStreamAbort]: {
91
+ streamId: number;
92
+ reason?: string;
93
+ };
94
+ [ClientMessageType.ServerStreamPull]: {
95
+ streamId: number;
96
+ size: number;
97
+ };
98
+ [ClientMessageType.ServerStreamAbort]: {
99
+ streamId: number;
100
+ reason?: string;
101
+ };
102
+ };