@wix/realtime 1.0.17 → 1.0.19

package/cjs/build/index.d.ts

@@ -1,3 +1,7 @@
 export * as site from '@wix/sdk_realtime_site';
 export * as publisher from './publisher/publisher.context.js';
 export * as subscriber from './subscriber/subscriber.context.js';
+import type { Channel, Message, MessageHandler, Publisher, SubscriptionErrorHandler, SubscriptionHandler, SubscriptionOptions, UnsubscribeOptions } from './types.js';
+import { RealtimeError, RealtimeErrorCode } from './types.js';
+export type { Channel, Message, MessageHandler, Publisher, SubscriptionErrorHandler, SubscriptionHandler, SubscriptionOptions, UnsubscribeOptions, };
+export { RealtimeError, RealtimeErrorCode };

package/cjs/build/index.js

@@ -33,7 +33,10 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.subscriber = exports.publisher = exports.site = void 0;
+exports.RealtimeErrorCode = exports.RealtimeError = exports.subscriber = exports.publisher = exports.site = void 0;
 exports.site = __importStar(require("@wix/sdk_realtime_site"));
 exports.publisher = __importStar(require("./publisher/publisher.context.js"));
 exports.subscriber = __importStar(require("./subscriber/subscriber.context.js"));
+const types_js_1 = require("./types.js");
+Object.defineProperty(exports, "RealtimeError", { enumerable: true, get: function () { return types_js_1.RealtimeError; } });
+Object.defineProperty(exports, "RealtimeErrorCode", { enumerable: true, get: function () { return types_js_1.RealtimeErrorCode; } });

package/cjs/build/publisher/publisher.context.d.ts

@@ -12,6 +12,11 @@ import type { BuildRESTFunction, MaybeContext } from '@wix/sdk-types';
  * The client's own credentials (instanceId, metaSiteId) are used directly.
  * This ensures messages are scoped to the correct site.
  *
+ * **Contextual client (Wix-hosted) — elevation needed:**
+ * The contextual httpClient may not have sufficient permissions on its own.
+ * Wrap the call with `elevate()` to obtain the host's backend credentials.
+ *
+ * @example Manual client (self-hosted / explicit auth)
  * ```ts
  * import { publisher } from '@wix/realtime';
  * import { createClient, AppStrategy } from '@wix/sdk';
@@ -23,15 +28,15 @@ import type { BuildRESTFunction, MaybeContext } from '@wix/sdk-types';
  * await client.publisher.publish({ name: 'my-channel' }, { message: 'hello' });
  * ```
  *
- * **Contextual client (Wix-hosted) — elevation needed:**
- * The contextual httpClient may not have sufficient permissions on its own.
- * Wrap the call with `elevate()` to obtain the host's backend credentials.
- *
+ * @example Contextual client (Wix-hosted)
  * ```ts
  * import { publisher } from '@wix/realtime';
  * import { elevate } from '@wix/sdk/context';
  *
  * await elevate(publisher.publish)({ name: 'my-channel' }, { message: 'hello' });
  * ```
+ *
+ * @param channel - The channel, and optionally the resource, to publish to.
+ * @param payload - Message payload. Max: 10kb
  */
 export declare const publish: MaybeContext<BuildRESTFunction<typeof publicPublish> & typeof publicPublish>;

package/cjs/build/publisher/publisher.context.js

@@ -15,6 +15,11 @@ const rest_modules_1 = require("@wix/sdk-runtime/rest-modules");
  * The client's own credentials (instanceId, metaSiteId) are used directly.
  * This ensures messages are scoped to the correct site.
  *
+ * **Contextual client (Wix-hosted) — elevation needed:**
+ * The contextual httpClient may not have sufficient permissions on its own.
+ * Wrap the call with `elevate()` to obtain the host's backend credentials.
+ *
+ * @example Manual client (self-hosted / explicit auth)
  * ```ts
  * import { publisher } from '@wix/realtime';
  * import { createClient, AppStrategy } from '@wix/sdk';
@@ -26,15 +31,15 @@ const rest_modules_1 = require("@wix/sdk-runtime/rest-modules");
  * await client.publisher.publish({ name: 'my-channel' }, { message: 'hello' });
  * ```
  *
- * **Contextual client (Wix-hosted) — elevation needed:**
- * The contextual httpClient may not have sufficient permissions on its own.
- * Wrap the call with `elevate()` to obtain the host's backend credentials.
- *
+ * @example Contextual client (Wix-hosted)
  * ```ts
  * import { publisher } from '@wix/realtime';
  * import { elevate } from '@wix/sdk/context';
  *
  * await elevate(publisher.publish)({ name: 'my-channel' }, { message: 'hello' });
  * ```
+ *
+ * @param channel - The channel, and optionally the resource, to publish to.
+ * @param payload - Message payload. Max: 10kb
  */
 exports.publish = (0, rest_modules_1.createRESTModule)(publisher_public_js_1.publish);

package/cjs/build/subscriber/subscriber.context.d.ts

@@ -1,4 +1,81 @@
 import { subscribe as publicSubscribe, unsubscribe as publicUnsubscribe } from './subscriber.public.js';
 import type { BuildRESTFunction, MaybeContext } from '@wix/sdk-types';
+/**
+ * Subscribe to a channel. Returns a subscriptionId immediately; the
+ * actual connection is established asynchronously in the background. Use the
+ * optional `options` parameter to handle subscription lifecycle events.
+ *
+ * @example Manual client (self-hosted / explicit auth)
+ * ```ts
+ * import { subscriber } from '@wix/realtime';
+ * import { createClient, AppStrategy } from '@wix/sdk';
+ *
+ * const client = createClient({
+ *   modules: { subscriber },
+ *   auth: AppStrategy({ appId, appSecret, instanceId }),
+ * });
+ *
+ * const subscriptionId = client.subscriber.subscribe(
+ *   { name: 'my-channel' },
+ *   (message, channel) => {
+ *     console.log('Received:', message.payload);
+ *   },
+ *   {
+ *     onSubscribed: (id, isSynced) => console.log('Subscribed', id),
+ *     onSubscriptionError: (error, id) => console.error('Error', error),
+ *   },
+ * );
+ * ```
+ *
+ * @example Contextual client (Wix-hosted)
+ * ```ts
+ * import { subscriber } from '@wix/realtime';
+ *
+ * const subscriptionId = subscriber.subscribe(
+ *   { name: 'my-channel' },
+ *   (message, channel) => {
+ *     console.log('Received:', message.payload);
+ *   },
+ * );
+ * ```
+ *
+ * @param channel - The channel, and optionally the resource, to subscribe to.
+ * @param messageHandler - Callback invoked whenever a message is published to the channel.
+ * @param options - Optional lifecycle handlers for subscription events.
+ */
 export declare const subscribe: MaybeContext<BuildRESTFunction<typeof publicSubscribe> & typeof publicSubscribe>;
+/**
+ * Unsubscribe from a subscription by its ID, by channel, or both.
+ *
+ * You can unsubscribe in three ways:
+ * - By `subscriptionId` — removes a single subscription.
+ * - By `channel` — removes all subscriptions to that channel.
+ * - By both — removes the specific subscription, verifying it matches the channel.
+ *
+ * @example Manual client (self-hosted / explicit auth)
+ * ```ts
+ * import { subscriber } from '@wix/realtime';
+ * import { createClient, AppStrategy } from '@wix/sdk';
+ *
+ * const client = createClient({
+ *   modules: { subscriber },
+ *   auth: AppStrategy({ appId, appSecret, instanceId }),
+ * });
+ *
+ * // Unsubscribe by subscription ID
+ * client.subscriber.unsubscribe({ subscriptionId });
+ *
+ * // Unsubscribe from all subscriptions to a channel
+ * client.subscriber.unsubscribe({ channel: { name: 'my-channel' } });
+ * ```
+ *
+ * @example Contextual client (Wix-hosted)
+ * ```ts
+ * import { subscriber } from '@wix/realtime';
+ *
+ * subscriber.unsubscribe({ subscriptionId });
+ * ```
+ *
+ * @param options - Identifies what to unsubscribe from — by subscription ID, channel, or both.
+ */
 export declare const unsubscribe: MaybeContext<BuildRESTFunction<typeof publicUnsubscribe> & typeof publicUnsubscribe>;

package/cjs/build/subscriber/subscriber.context.js

@@ -3,5 +3,82 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.unsubscribe = exports.subscribe = void 0;
 const subscriber_public_js_1 = require("./subscriber.public.js");
 const rest_modules_1 = require("@wix/sdk-runtime/rest-modules");
+/**
+ * Subscribe to a channel. Returns a subscriptionId immediately; the
+ * actual connection is established asynchronously in the background. Use the
+ * optional `options` parameter to handle subscription lifecycle events.
+ *
+ * @example Manual client (self-hosted / explicit auth)
+ * ```ts
+ * import { subscriber } from '@wix/realtime';
+ * import { createClient, AppStrategy } from '@wix/sdk';
+ *
+ * const client = createClient({
+ *   modules: { subscriber },
+ *   auth: AppStrategy({ appId, appSecret, instanceId }),
+ * });
+ *
+ * const subscriptionId = client.subscriber.subscribe(
+ *   { name: 'my-channel' },
+ *   (message, channel) => {
+ *     console.log('Received:', message.payload);
+ *   },
+ *   {
+ *     onSubscribed: (id, isSynced) => console.log('Subscribed', id),
+ *     onSubscriptionError: (error, id) => console.error('Error', error),
+ *   },
+ * );
+ * ```
+ *
+ * @example Contextual client (Wix-hosted)
+ * ```ts
+ * import { subscriber } from '@wix/realtime';
+ *
+ * const subscriptionId = subscriber.subscribe(
+ *   { name: 'my-channel' },
+ *   (message, channel) => {
+ *     console.log('Received:', message.payload);
+ *   },
+ * );
+ * ```
+ *
+ * @param channel - The channel, and optionally the resource, to subscribe to.
+ * @param messageHandler - Callback invoked whenever a message is published to the channel.
+ * @param options - Optional lifecycle handlers for subscription events.
+ */
 exports.subscribe = (0, rest_modules_1.createRESTModule)(subscriber_public_js_1.subscribe);
+/**
+ * Unsubscribe from a subscription by its ID, by channel, or both.
+ *
+ * You can unsubscribe in three ways:
+ * - By `subscriptionId` — removes a single subscription.
+ * - By `channel` — removes all subscriptions to that channel.
+ * - By both — removes the specific subscription, verifying it matches the channel.
+ *
+ * @example Manual client (self-hosted / explicit auth)
+ * ```ts
+ * import { subscriber } from '@wix/realtime';
+ * import { createClient, AppStrategy } from '@wix/sdk';
+ *
+ * const client = createClient({
+ *   modules: { subscriber },
+ *   auth: AppStrategy({ appId, appSecret, instanceId }),
+ * });
+ *
+ * // Unsubscribe by subscription ID
+ * client.subscriber.unsubscribe({ subscriptionId });
+ *
+ * // Unsubscribe from all subscriptions to a channel
+ * client.subscriber.unsubscribe({ channel: { name: 'my-channel' } });
+ * ```
+ *
+ * @example Contextual client (Wix-hosted)
+ * ```ts
+ * import { subscriber } from '@wix/realtime';
+ *
+ * subscriber.unsubscribe({ subscriptionId });
+ * ```
+ *
+ * @param options - Identifies what to unsubscribe from — by subscription ID, channel, or both.
+ */
 exports.unsubscribe = (0, rest_modules_1.createRESTModule)(subscriber_public_js_1.unsubscribe);

package/cjs/build/subscriber/subscriber.public.d.ts

@@ -3,18 +3,10 @@ import type { HttpClient } from '@wix/sdk-types';
 interface SubscribeSignature {
     (channel: Channel, messageHandler: MessageHandler, options?: SubscriptionOptions): string;
 }
-/**
- * Subscribe to a channel. Returns a subscriptionId immediately; the
- * actual connection is established asynchronously in the background. Use the
- * optional `options` parameter to handle subscription lifecycle events.
- */
 export declare function subscribe(httpClient: HttpClient): SubscribeSignature;
 interface UnsubscribeSignature {
     (options: UnsubscribeOptions): void;
 }
-/**
- * Unsubscribe from a subscription by its ID, by channel, or both.
- */
 export declare function unsubscribe(_: HttpClient): UnsubscribeSignature;
 /** @internal Resets all module-level state. Only for use in tests. */
 export declare function _resetForTesting(): void;

package/cjs/build/subscriber/subscriber.public.js

@@ -11,11 +11,6 @@ const errors_js_1 = require("./errors.js");
 const subscription_manager_js_1 = require("./subscription-manager.js");
 const instanceConnections = new Map();
 const subscriptionManager = new subscription_manager_js_1.SubscriptionManager();
-/**
- * Subscribe to a channel. Returns a subscriptionId immediately; the
- * actual connection is established asynchronously in the background. Use the
- * optional `options` parameter to handle subscription lifecycle events.
- */
 function subscribe(httpClient) {
     return (channel, messageHandler, options) => {
         (0, errors_js_1.validateChannel)(channel);
@@ -31,9 +26,6 @@ function subscribe(httpClient) {
         return subscriptionId;
     };
 }
-/**
- * Unsubscribe from a subscription by its ID, by channel, or both.
- */
 function unsubscribe(_) {
     return ({ channel, subscriptionId }) => {
         if (!channel && !subscriptionId) {

package/cjs/build/types.d.ts

@@ -1 +1 @@
-export { RealtimeErrorCode, RealtimeError, type Channel, type Publisher, type Message, type MessageHandler, type SubscriptionHandler, type SubscriptionErrorHandler, type SubscriptionOptions, } from '@wix/realtime-common/types';
+export { RealtimeErrorCode, RealtimeError, type Channel, type Publisher, type Message, type MessageHandler, type SubscriptionHandler, type SubscriptionErrorHandler, type SubscriptionOptions, type UnsubscribeOptions, } from '@wix/realtime-common/types';