@rocket.chat/ddp-client 0.0.2-rc.0 → 0.0.2-rc.1

package/dist/types/DDPClient.d.ts

@@ -0,0 +1,112 @@
+import type { IncomingPayload } from './IncomingPayload';
+import type { RemoveListener } from './RemoveListener';
+import type { ConnectedPayload, FailedPayload } from './connectionPayloads';
+import type { MethodPayload, ResultPayload, UpdatedPayload } from './methodsPayloads';
+import type { NosubPayload, PublicationPayloads, ServerPublicationPayloads } from './publicationPayloads';
+export interface DDPDispatchOptions {
+    wait?: boolean;
+}
+/**
+ * A low-level DDP client that can be used to communicate with a DDP server.
+ */
+export interface DDPClient {
+    /**
+     * Invokes a remote method.
+     * @param method The name of the method to invoke.
+     * @param params The parameters to pass to the method.
+     * @param options The options to pass to the method.
+     * @returns A string representing the method call.
+     */
+    call(method: string, params: any[], options?: DDPDispatchOptions): MethodPayload;
+    /**
+     * Subscribes to a queue of stream messages.
+     * @param name The name of the queue to subscribe to.
+     * @param params The parameters that the queue takes.
+     * @returns A string representing the subscription id.
+     */
+    subscribe(name: string, params: any[]): string;
+    /**
+     * Subscribes to a queue of stream messages.
+     * @param id arbitrary id to use for the subscription
+     * @param name The name of the queue to subscribe to.
+     * @param params The parameters that the queue takes.
+     * @returns A string representing the subscription id.
+     */
+    subscribeWithId(id: string, name: string, params: any[]): string;
+    /**
+     * Unsubscribes from a queue of stream messages.
+     * @param id The id of the subscription to unsubscribe from.
+     */
+    unsubscribe(id: string): void;
+    /**
+     * Handles a message received from the server.
+     */
+    handleMessage(serialized: string): void;
+    /**
+     * Registers a callback to be called every time a message is sent to the server.
+     */
+    onDispatchMessage(callback: (msg: string) => void): RemoveListener;
+    /**
+     * Sends a connect message to the server.
+     */
+    connect(): void;
+    /**
+     * Registers a callback to be called once after the subscription is ready or rejected.
+     * @param id The id of the subscription.
+     * @param callback The callback to be called.
+     * @returns A function to unregister the callback.
+     */
+    onPublish(name: string, callback: (payload: ServerPublicationPayloads) => void): RemoveListener;
+    /**
+     * Registers a callback to be called once after the method is resolved or rejected.
+     * @param id The id of the method.
+     * @param callback The callback to be called.
+     * @returns A function to unregister the callback.
+     */
+    onResult(id: string, callback: (payload: ResultPayload) => void): RemoveListener;
+    /**
+     * Registers a callback to be called every time the subscription is updated.
+     * @param id The id of the subscription.
+     * @param callback The callback to be called.
+     * @returns A function to unregister the callback.
+     */
+    onUpdate(id: string, callback: (payload: UpdatedPayload) => void): RemoveListener;
+    /**
+     * Registers a callback to be called once after the subscription is stopped.
+     * @param id The id of the subscription.
+     * @param callback The callback to be called.
+     * @returns A function to unregister the callback.
+     */
+    onNoSub(id: string, callback: (payload: NosubPayload) => void): RemoveListener;
+    /**
+     * Registers a callback to be called every time a new document is added/updated/removed from the collection.
+     * @param name The name of the collection.
+     * @param callback The callback to be called.
+     * @returns A function to unregister the callback.
+     */
+    onCollection(name: string, callback: (payload: PublicationPayloads) => void): RemoveListener;
+    /**
+     * Registers a callback to be called once after the connection is established or rejected.
+     * @param callback The callback to be called.
+     * @returns A function to unregister the callback.
+     */
+    onConnection(callback: (payload: ConnectedPayload | FailedPayload) => void): RemoveListener;
+    /**
+     * Registers a callback to be called every time a message is received.
+     * @param callback The callback to be called.
+     * @returns A function to unregister the callback.
+     */
+    onMessage(callback: (payload: IncomingPayload) => void): RemoveListener;
+    /**
+     * Registers a callback to be called once after a message is received.
+     * @param callback The callback to be called.
+     * @returns A function to unregister the callback.
+     */
+    onceMessage(callback: (payload: IncomingPayload) => void): RemoveListener;
+    /**
+     * Sends a ping message to the server.
+     * @returns nothing
+     */
+    ping(id?: string): void;
+}
+//# sourceMappingURL=DDPClient.d.ts.map

package/dist/types/DDPClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DDPClient.d.ts","sourceRoot":"","sources":["../../src/types/DDPClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAC5E,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACtF,OAAO,KAAK,EAAE,YAAY,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAE1G,MAAM,WAAW,kBAAkB;IAClC,IAAI,CAAC,EAAE,OAAO,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACzB;;;;;;OAMG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,aAAa,CAAC;IAEjF;;;;;OAKG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;IAE/C;;;;;;OAMG;IACH,eAAe,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;IAEjE;;;OAGG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAExC;;OAEG;IACH,iBAAiB,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,GAAG,cAAc,CAAC;IAEnE;;OAEG;IACH,OAAO,IAAI,IAAI,CAAC;IAEhB;;;;;OAKG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,IAAI,GAAG,cAAc,CAAC;IAEhG;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,aAAa,KAAK,IAAI,GAAG,cAAc,CAAC;IAEjF;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,GAAG,cAAc,CAAC;IAElF;;;;;OAKG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,YAAY,KAAK,IAAI,GAAG,cAAc,CAAC;IAE/E;;;;;OAKG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,mBAAmB,KAAK,IAAI,GAAG,cAAc,CAAC;IAE7F;;;;OAIG;IACH,YAAY,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,gBAAgB,GAAG,aAAa,KAAK,IAAI,GAAG,cAAc,CAAC;IAE5F;;;;OAIG;IACH,SAAS,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,IAAI,GAAG,cAAc,CAAC;IAExE;;;;OAIG;IACH,WAAW,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,IAAI,GAAG,cAAc,CAAC;IAE1E;;;OAGG;IACH,IAAI,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB"}

package/dist/types/DDPClient.js

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

package/dist/types/DDPClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DDPClient.js","sourceRoot":"","sources":["../../src/types/DDPClient.ts"],"names":[],"mappings":""}

package/dist/types/IncomingPayload.d.ts

@@ -0,0 +1,9 @@
+import type { ConnectedPayload, FailedPayload } from './connectionPayloads';
+import type { PingPayload, PongPayload } from './heartbeatsPayloads';
+import type { ServerMethodPayloads } from './methodsPayloads';
+import type { ServerPublicationPayloads } from './publicationPayloads';
+/**
+ * @category incoming
+ */
+export type IncomingPayload = PingPayload | PongPayload | ServerPublicationPayloads | ServerMethodPayloads | ConnectedPayload | FailedPayload;
+//# sourceMappingURL=IncomingPayload.d.ts.map

package/dist/types/IncomingPayload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IncomingPayload.d.ts","sourceRoot":"","sources":["../../src/types/IncomingPayload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAC5E,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACrE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,eAAe,GACxB,WAAW,GACX,WAAW,GACX,yBAAyB,GACzB,oBAAoB,GACpB,gBAAgB,GAChB,aAAa,CAAC"}

package/dist/types/IncomingPayload.js

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

package/dist/types/IncomingPayload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IncomingPayload.js","sourceRoot":"","sources":["../../src/types/IncomingPayload.ts"],"names":[],"mappings":""}

package/dist/types/OutgoingPayload.d.ts

@@ -0,0 +1,9 @@
+import type { ConnectPayload } from './connectionPayloads';
+import type { PingPayload, PongPayload } from './heartbeatsPayloads';
+import type { MethodPayload } from './methodsPayloads';
+import type { ClientPublicationPayloads } from './publicationPayloads';
+/**
+ * @category outgoing
+ */
+export type OutgoingPayload = PingPayload | PongPayload | ConnectPayload | ClientPublicationPayloads | MethodPayload;
+//# sourceMappingURL=OutgoingPayload.d.ts.map

package/dist/types/OutgoingPayload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OutgoingPayload.d.ts","sourceRoot":"","sources":["../../src/types/OutgoingPayload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACrE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,WAAW,GAAG,WAAW,GAAG,cAAc,GAAG,yBAAyB,GAAG,aAAa,CAAC"}

package/dist/types/OutgoingPayload.js

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

package/dist/types/OutgoingPayload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OutgoingPayload.js","sourceRoot":"","sources":["../../src/types/OutgoingPayload.ts"],"names":[],"mappings":""}

package/dist/types/RemoveListener.d.ts

@@ -0,0 +1,2 @@
+export type RemoveListener = () => void;
+//# sourceMappingURL=RemoveListener.d.ts.map

package/dist/types/RemoveListener.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RemoveListener.d.ts","sourceRoot":"","sources":["../../src/types/RemoveListener.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC"}

package/dist/types/RemoveListener.js

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

package/dist/types/RemoveListener.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RemoveListener.js","sourceRoot":"","sources":["../../src/types/RemoveListener.ts"],"names":[],"mappings":""}

package/dist/types/SDK.d.ts

@@ -0,0 +1,14 @@
+import type { RestClient } from '@rocket.chat/api-client';
+import type { ClientStream } from './ClientStream';
+import type { Connection } from '../Connection';
+import type { TimeoutControl } from '../TimeoutControl';
+import type { Account } from './Account';
+export interface SDK {
+    stream(name: string, params: unknown[], cb: (...data: unknown[]) => void): ReturnType<ClientStream['subscribe']>;
+    connection: Connection;
+    account: Account;
+    client: ClientStream;
+    timeoutControl: TimeoutControl;
+    rest: RestClient;
+}
+//# sourceMappingURL=SDK.d.ts.map

package/dist/types/SDK.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SDK.d.ts","sourceRoot":"","sources":["../../src/types/SDK.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAkBzC,MAAM,WAAW,GAAG;IACnB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,GAAG,UAAU,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC;IAEjH,UAAU,EAAE,UAAU,CAAC;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,YAAY,CAAC;IAErB,cAAc,EAAE,cAAc,CAAC;IAC/B,IAAI,EAAE,UAAU,CAAC;CACjB"}

package/dist/types/SDK.js

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

package/dist/types/SDK.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SDK.js","sourceRoot":"","sources":["../../src/types/SDK.ts"],"names":[],"mappings":""}

package/dist/types/Subscription.d.ts

@@ -0,0 +1,12 @@
+import type { ServerPublicationPayloads } from './publicationPayloads';
+export interface Subscription {
+    stop: () => void;
+    ready: () => Promise<void>;
+    isReady: boolean;
+    onChange: (cb: (arg: ServerPublicationPayloads) => void) => void;
+    id: string;
+    params: any[];
+    name: string;
+    error?: unknown;
+}
+//# sourceMappingURL=Subscription.d.ts.map

package/dist/types/Subscription.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Subscription.d.ts","sourceRoot":"","sources":["../../src/types/Subscription.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAEvE,MAAM,WAAW,YAAY;IAC5B,IAAI,EAAE,MAAM,IAAI,CAAC;IACjB,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,yBAAyB,KAAK,IAAI,KAAK,IAAI,CAAC;IACjE,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,GAAG,EAAE,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,OAAO,CAAC;CAChB"}

package/dist/types/Subscription.js

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

package/dist/types/Subscription.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Subscription.js","sourceRoot":"","sources":["../../src/types/Subscription.ts"],"names":[],"mappings":""}

package/dist/types/connectionPayloads.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @category outgoing
+ */
+export type ConnectPayload = {
+    msg: 'connect';
+    /** previous DDP session identifier (if trying to reconnect to an existing DDP session) */
+    session?: string;
+    /** the proposed protocol version */
+    version: string;
+    /** protocol versions supported by the client, in order of preference */
+    support: string[];
+};
+/**
+ * @category incoming
+ */
+export type ConnectedPayload = {
+    msg: 'connected';
+    /** an identifier for the DDP session */
+    session: string;
+};
+/**
+ * @category incoming
+ */
+export type FailedPayload = {
+    msg: 'failed';
+    /** a suggested protocol version to connect with */
+    version: string;
+};
+//# sourceMappingURL=connectionPayloads.d.ts.map

package/dist/types/connectionPayloads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"connectionPayloads.d.ts","sourceRoot":"","sources":["../../src/types/connectionPayloads.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC5B,GAAG,EAAE,SAAS,CAAC;IACf,0FAA0F;IAC1F,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oCAAoC;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,wEAAwE;IACxE,OAAO,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC9B,GAAG,EAAE,WAAW,CAAC;IACjB,wCAAwC;IACxC,OAAO,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC3B,GAAG,EAAE,QAAQ,CAAC;IACd,mDAAmD;IACnD,OAAO,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/dist/types/connectionPayloads.js

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

package/dist/types/connectionPayloads.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"connectionPayloads.js","sourceRoot":"","sources":["../../src/types/connectionPayloads.ts"],"names":[],"mappings":""}

package/dist/types/heartbeatsPayloads.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @category incoming | outgoing
+ *
+ * At any time after the connection is established either side may send a ping message. The other side
+ * must respond with a pong message as soon as possible.
+ */
+export type PingPayload = {
+    msg: 'ping';
+    /** identifier used to correlate with response */
+    id?: string;
+};
+/**
+ * @category incoming | outgoing
+ *
+ * The pong message is sent in response to a ping message. If the ping message included an id field,
+ * the pong message must include the same id field.
+ */
+export type PongPayload = {
+    msg: 'pong';
+    /** identifier as received in the ping message */
+    id?: string;
+};
+//# sourceMappingURL=heartbeatsPayloads.d.ts.map

package/dist/types/heartbeatsPayloads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"heartbeatsPayloads.d.ts","sourceRoot":"","sources":["../../src/types/heartbeatsPayloads.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,iDAAiD;IACjD,EAAE,CAAC,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,iDAAiD;IACjD,EAAE,CAAC,EAAE,MAAM,CAAC;CACZ,CAAC"}

package/dist/types/heartbeatsPayloads.js

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

package/dist/types/heartbeatsPayloads.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"heartbeatsPayloads.js","sourceRoot":"","sources":["../../src/types/heartbeatsPayloads.ts"],"names":[],"mappings":""}

package/dist/types/methods.d.ts

@@ -0,0 +1,13 @@
+export interface ServerMethods {
+    resetPassword(token: string, password: string): {
+        token: string;
+    };
+    setUserPassword(password: string): void;
+    sendConfirmationEmail(to: string): boolean;
+    checkRegistrationSecretURL(hash: string): boolean;
+}
+export type ServerMethodName = keyof ServerMethods;
+export type ServerMethodParameters<MethodName extends ServerMethodName> = Parameters<ServerMethods[MethodName]>;
+export type ServerMethodReturn<MethodName extends ServerMethodName> = Awaited<ReturnType<ServerMethods[MethodName]>>;
+export type ServerMethodFunction<MethodName extends ServerMethodName> = (...args: ServerMethodParameters<MethodName>) => Promise<ServerMethodReturn<MethodName>>;
+//# sourceMappingURL=methods.d.ts.map

package/dist/types/methods.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"methods.d.ts","sourceRoot":"","sources":["../../src/types/methods.ts"],"names":[],"mappings":"AACA,MAAM,WAAW,aAAa;IAC7B,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAClE,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC;IAC3C,0BAA0B,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;CAClD;AAED,MAAM,MAAM,gBAAgB,GAAG,MAAM,aAAa,CAAC;AAEnD,MAAM,MAAM,sBAAsB,CAAC,UAAU,SAAS,gBAAgB,IAAI,UAAU,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC;AAEhH,MAAM,MAAM,kBAAkB,CAAC,UAAU,SAAS,gBAAgB,IAAI,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;AAErH,MAAM,MAAM,oBAAoB,CAAC,UAAU,SAAS,gBAAgB,IAAI,CACvE,GAAG,IAAI,EAAE,sBAAsB,CAAC,UAAU,CAAC,KACvC,OAAO,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC,CAAC"}

package/dist/types/methods.js

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

package/dist/types/methods.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"methods.js","sourceRoot":"","sources":["../../src/types/methods.ts"],"names":[],"mappings":""}

package/dist/types/methodsPayloads.d.ts

@@ -0,0 +1,43 @@
+/**
+ * @category outgoing
+ */
+export type MethodPayload = {
+    msg: 'method';
+    /** method name */
+    method: string;
+    /** EJSON parameters to the method */
+    params: any[];
+    /** an arbitrary client-determined identifier for this method call */
+    id: string;
+    /** an arbitrary client-determined seed for pseudo-random generators */
+    randomSeed?: Record<string, unknown>;
+};
+/**
+ * @category incoming
+ */
+export type ResultPayload = {
+    msg: 'result';
+    /** the id passed to `'method'` */
+    id: string;
+    /** an error thrown by the method (or method-not-found) */
+    error?: unknown;
+    /** the EJSON return value of the method, if any */
+    result?: any;
+};
+/**
+ * @category incoming
+ */
+export type UpdatedPayload = {
+    msg: 'updated';
+    /** array of method ids; all of whose writes have been reflected in data messages */
+    methods: string[];
+};
+/**
+ * @category outgoing
+ */
+export type ClientMethodPayloads = MethodPayload;
+/**
+ * @category incoming
+ */
+export type ServerMethodPayloads = ResultPayload | UpdatedPayload;
+//# sourceMappingURL=methodsPayloads.d.ts.map

package/dist/types/methodsPayloads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"methodsPayloads.d.ts","sourceRoot":"","sources":["../../src/types/methodsPayloads.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC3B,GAAG,EAAE,QAAQ,CAAC;IACd,kBAAkB;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,qCAAqC;IACrC,MAAM,EAAE,GAAG,EAAE,CAAC;IACd,qEAAqE;IACrE,EAAE,EAAE,MAAM,CAAC;IACX,uEAAuE;IACvE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACrC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC3B,GAAG,EAAE,QAAQ,CAAC;IACd,kCAAkC;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,0DAA0D;IAC1D,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,mDAAmD;IACnD,MAAM,CAAC,EAAE,GAAG,CAAC;CACb,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC5B,GAAG,EAAE,SAAS,CAAC;IACf,oFAAoF;IACpF,OAAO,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAAC;AAEjD;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,aAAa,GAAG,cAAc,CAAC"}

package/dist/types/methodsPayloads.js

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

package/dist/types/methodsPayloads.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"methodsPayloads.js","sourceRoot":"","sources":["../../src/types/methodsPayloads.ts"],"names":[],"mappings":""}

package/dist/types/publicationPayloads.d.ts

@@ -0,0 +1,110 @@
+/**
+ * @category outgoing
+ */
+export type SubscribePayload = {
+    msg: 'sub';
+    /** an arbitrary client-determined identifier for this subscription */
+    id: string;
+    /** the name of the subscription */
+    name: string;
+    /** parameters to the subscription */
+    params?: any[];
+};
+/**
+ * @category outgoing
+ */
+export type UnsubscribePayload = {
+    msg: 'unsub';
+    /** the id passed to `'sub'` */
+    id: string;
+};
+/**
+ * @category outgoing
+ */
+export type ClientPublicationPayloads = SubscribePayload | UnsubscribePayload;
+/**
+ * @category incoming
+ */
+export type NosubPayload = {
+    msg: 'nosub';
+    /** the id passed to `'sub'` */
+    id: string;
+    /** an error thrown by the subscription (or sub-not-found) */
+    error?: unknown;
+};
+/**
+ * @category incoming
+ */
+export type AddedPayload = {
+    msg: 'added';
+    /** the name of the collection */
+    collection: string;
+    /** the document ID */
+    id: string;
+    /** the document fields */
+    fields?: Record<string, any>;
+};
+/**
+ * @category incoming
+ */
+export type ChangedPayload = {
+    msg: 'changed';
+    /** the name of the collection */
+    collection: string;
+    /** the document ID */
+    id: string;
+    /** the document fields */
+    fields?: Record<string, any>;
+    /** the document fields to delete */
+    cleared?: string[];
+};
+/**
+ * @category incoming
+ */
+export type RemovedPayload = {
+    msg: 'removed';
+    /** the name of the collection */
+    collection: string;
+    /** the document ID */
+    id: string;
+};
+/**
+ * @category incoming
+ */
+export type ReadyPayload = {
+    msg: 'ready';
+    /** the ids passed to `'sub'` which have sent their initial batch of data */
+    subs: string[];
+};
+/**
+ * @category incoming
+ */
+export type AddedBeforePayload = {
+    msg: 'addedBefore';
+    /** the name of the collection */
+    collection: string;
+    /** the document ID */
+    id: string;
+    /** the document fields */
+    fields?: Record<string, any>;
+    /** the document ID to add the document before, or `null` to add at the end */
+    before: string | null;
+};
+/**
+ * @category incoming
+ */
+export type MovedBeforePayload = {
+    msg: 'movedBefore';
+    /** the name of the collection */
+    collection: string;
+    /** the document ID */
+    id: string;
+    /** the document ID to move the document before, or `null` to move to the end */
+    before: string | null;
+};
+/**
+ * @category incoming
+ */
+export type ServerPublicationPayloads = NosubPayload | AddedPayload | ChangedPayload | RemovedPayload | ReadyPayload | AddedBeforePayload | MovedBeforePayload;
+export type PublicationPayloads = AddedPayload | ChangedPayload | RemovedPayload;
+//# sourceMappingURL=publicationPayloads.d.ts.map

package/dist/types/publicationPayloads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"publicationPayloads.d.ts","sourceRoot":"","sources":["../../src/types/publicationPayloads.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC9B,GAAG,EAAE,KAAK,CAAC;IACX,sEAAsE;IACtE,EAAE,EAAE,MAAM,CAAC;IACX,mCAAmC;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,qCAAqC;IACrC,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAChC,GAAG,EAAE,OAAO,CAAC;IACb,+BAA+B;IAC/B,EAAE,EAAE,MAAM,CAAC;CACX,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,gBAAgB,GAAG,kBAAkB,CAAC;AAE9E;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IAC1B,GAAG,EAAE,OAAO,CAAC;IACb,+BAA+B;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,6DAA6D;IAC7D,KAAK,CAAC,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IAC1B,GAAG,EAAE,OAAO,CAAC;IACb,iCAAiC;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,sBAAsB;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,0BAA0B;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC5B,GAAG,EAAE,SAAS,CAAC;IACf,iCAAiC;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,sBAAsB;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,0BAA0B;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC7B,oCAAoC;IACpC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC5B,GAAG,EAAE,SAAS,CAAC;IACf,iCAAiC;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,sBAAsB;IACtB,EAAE,EAAE,MAAM,CAAC;CACX,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IAC1B,GAAG,EAAE,OAAO,CAAC;IACb,4EAA4E;IAC5E,IAAI,EAAE,MAAM,EAAE,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAChC,GAAG,EAAE,aAAa,CAAC;IACnB,iCAAiC;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,sBAAsB;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,0BAA0B;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC7B,8EAA8E;IAC9E,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB,CAAC;AAOF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAChC,GAAG,EAAE,aAAa,CAAC;IACnB,iCAAiC;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,sBAAsB;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,gFAAgF;IAChF,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAClC,YAAY,GACZ,YAAY,GACZ,cAAc,GACd,cAAc,GACd,YAAY,GACZ,kBAAkB,GAClB,kBAAkB,CAAC;AAEtB,MAAM,MAAM,mBAAmB,GAAG,YAAY,GAAG,cAAc,GAAG,cAAc,CAAC"}

package/dist/types/publicationPayloads.js

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

package/dist/types/publicationPayloads.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"publicationPayloads.js","sourceRoot":"","sources":["../../src/types/publicationPayloads.ts"],"names":[],"mappings":""}