@wix/realtime 1.0.16 → 1.0.18

package/es/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/es/build/index.js

@@ -1,3 +1,5 @@
 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 { RealtimeError, RealtimeErrorCode } from './types.js';
+export { RealtimeError, RealtimeErrorCode };

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

@@ -33,5 +33,8 @@ import type { BuildRESTFunction, MaybeContext } from '@wix/sdk-types';
  *
  * 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/es/build/publisher/publisher.context.js

@@ -33,5 +33,8 @@ import { createRESTModule } from '@wix/sdk-runtime/rest-modules';
  *
  * 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 const publish = /*#__PURE__*/ createRESTModule(publicPublish);

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

@@ -1,4 +1,85 @@
 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.
+ *
+ * **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),
+ *   },
+ * );
+ * ```
+ *
+ * **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.
+ *
+ * **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' } });
+ * ```
+ *
+ * **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/es/build/subscriber/subscriber.context.js

@@ -1,4 +1,85 @@
 import { subscribe as publicSubscribe, unsubscribe as publicUnsubscribe, } from './subscriber.public.js';
 import { createRESTModule } from '@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.
+ *
+ * **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),
+ *   },
+ * );
+ * ```
+ *
+ * **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 const subscribe = /*#__PURE__*/ createRESTModule(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.
+ *
+ * **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' } });
+ * ```
+ *
+ * **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 const unsubscribe = /*#__PURE__*/ createRESTModule(publicUnsubscribe);

package/es/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/es/build/subscriber/subscriber.public.js

@@ -6,11 +6,6 @@ import { missingChannelOrSubscriptionId, channelMismatch, disconnectedError, con
 import { SubscriptionManager } from './subscription-manager.js';
 const instanceConnections = new Map();
 const subscriptionManager = new 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.
- */
 export function subscribe(httpClient) {
     return (channel, messageHandler, options) => {
         validateChannel(channel);
@@ -26,9 +21,6 @@ export function subscribe(httpClient) {
         return subscriptionId;
     };
 }
-/**
- * Unsubscribe from a subscription by its ID, by channel, or both.
- */
 export function unsubscribe(_) {
     return ({ channel, subscriptionId }) => {
         if (!channel && !subscriptionId) {

package/es/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';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/realtime",
-  "version": "1.0.16",
+  "version": "1.0.18",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -30,33 +30,40 @@
   },
   "files": [
     "es",
+    "dist",
     "types",
     "cjs"
   ],
   "dependencies": {
     "@wix/auto_sdk_duplexer_publisher": "^1.0.10",
     "@wix/duplexer-js": "^2.0.6",
-    "@wix/realtime-common": "1.0.0",
+    "@wix/realtime-common": "1.0.1",
     "@wix/sdk": "^1.21.4",
     "@wix/sdk-runtime": "^1.0.9",
     "@wix/sdk-types": "^1.17.5",
-    "@wix/sdk_realtime_site": "1.0.16",
+    "@wix/sdk_realtime_site": "1.0.17",
     "uuid": "^11.1.0"
   },
   "devDependencies": {
+    "@wix/docs-ts-model": "^1.54.0",
     "typescript": "^5.7.3",
     "vitest": "^3.0.5"
   },
   "scripts": {
-    "build": "tsc -p tsconfig.json && tsc -p tsconfig.cjs.json",
+    "build": "tsc -p tsconfig.json && tsc -p tsconfig.cjs.json && npm run docs",
+    "docs": "docs-ts-model --disableSources --entryPoint src/index.ts",
     "test": "vitest run"
   },
   "wix": {
     "artifact": {
       "groupId": "com.wixpress.sdk",
       "artifactId": "realtime",
+      "targets": {
+        "static": true,
+        "build-docs": true
+      },
       "isRootPublicSdk": true
     }
   },
-  "falconPackageHash": "c9c9fdd807cf8de849e3fa8047ca30f2b255ee52cd0f24cfe4570299"
+  "falconPackageHash": "fe8c2a94e3d494c7683d22a3b4943a1e3883c91df788345d96d1425c"
 }