@wix/realtime 1.0.32 → 1.0.34

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

@@ -1,10 +1,19 @@
 import { publish as publicPublish } from './publisher.public.js';
 import type { BuildRESTFunction, MaybeContext } from '@wix/sdk-types';
 /**
- * Publishes a message to a realtime channel.
+ * Publishes a message to a channel or channel resource.
  *
- * Requires a service identity (server-side only). The caller must have
- * app-level permissions to publish messages.
+ * All subscribers currently listening to the specified channel receive the
+ * message. Subscribers to a channel don't receive messages published to a
+ * resource on that channel, and vice versa.
+ *
+ * This method is backend-only and requires elevated permissions.
+ *
+ * <!-- TODO: Check whether this API is relevant for headless projects. -->
+ *
+ * > **Note:** This function requires elevated permissions and runs only on the backend.
+ * > You can also call this method from the frontend using `elevate()`.
+ * > Elevated permissions are only available for apps and service accounts.
  *
  * @example Manual client (self-hosted / explicit auth)
  * ```ts
@@ -26,7 +35,7 @@ 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
+ * @param channel - Channel, and optionally resource, to publish to.
+ * @param payload - Message payload. Max: 10 KB.
  */
 export declare const publish: MaybeContext<BuildRESTFunction<typeof publicPublish> & typeof publicPublish>;

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

@@ -4,10 +4,19 @@ exports.publish = void 0;
 const publisher_public_js_1 = require("./publisher.public.js");
 const rest_modules_1 = require("@wix/sdk-runtime/rest-modules");
 /**
- * Publishes a message to a realtime channel.
+ * Publishes a message to a channel or channel resource.
  *
- * Requires a service identity (server-side only). The caller must have
- * app-level permissions to publish messages.
+ * All subscribers currently listening to the specified channel receive the
+ * message. Subscribers to a channel don't receive messages published to a
+ * resource on that channel, and vice versa.
+ *
+ * This method is backend-only and requires elevated permissions.
+ *
+ * <!-- TODO: Check whether this API is relevant for headless projects. -->
+ *
+ * > **Note:** This function requires elevated permissions and runs only on the backend.
+ * > You can also call this method from the frontend using `elevate()`.
+ * > Elevated permissions are only available for apps and service accounts.
  *
  * @example Manual client (self-hosted / explicit auth)
  * ```ts
@@ -29,7 +38,7 @@ const rest_modules_1 = require("@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
+ * @param channel - Channel, and optionally resource, to publish to.
+ * @param payload - Message payload. Max: 10 KB.
  */
 exports.publish = (0, rest_modules_1.createRESTModule)(publisher_public_js_1.publish);

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

@@ -1,9 +1,16 @@
 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.
+ * Subscribes to a channel or channel resource.
+ *
+ * The method returns a subscription ID immediately. The connection is
+ * established asynchronously in the background. Use the `options` parameter
+ * to register lifecycle handlers that notify you when the subscription
+ * succeeds or encounters an error.
+ *
+ * If the connection drops, the client automatically attempts to reconnect
+ * and re-subscribe. The `onSubscribed` handler fires again on each
+ * successful re-subscription.
  *
  * @example Manual client (self-hosted / explicit auth)
  * ```ts
@@ -39,18 +46,21 @@ import type { BuildRESTFunction, MaybeContext } from '@wix/sdk-types';
  * );
  * ```
  *
- * @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.
+ * @param channel - Channel, and optionally resource, to subscribe to.
+ * @param messageHandler - Callback that runs whenever a message is published to the channel.
+ * @param options - 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.
+ * Removes one or more subscriptions.
  *
  * 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.
+ * - By `subscriptionId`: removes a single subscription.
+ * - By `channel`: removes all subscriptions to that channel or channel resource.
+ * - By both: removes the specific subscription, verifying it matches the channel.
+ *
+ * When the last subscription on a connection is removed, the connection
+ * closes automatically.
  *
  * @example Manual client (self-hosted / explicit auth)
  * ```ts
@@ -76,6 +86,6 @@ export declare const subscribe: MaybeContext<BuildRESTFunction<typeof publicSubs
  * subscriber.unsubscribe({ subscriptionId });
  * ```
  *
- * @param options - Identifies what to unsubscribe from — by subscription ID, channel, or both.
+ * @param options - Specifies what to unsubscribe from. At least one of `channel` or `subscriptionId` is required.
  */
 export declare const unsubscribe: MaybeContext<BuildRESTFunction<typeof publicUnsubscribe> & typeof publicUnsubscribe>;

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

@@ -4,9 +4,16 @@ 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.
+ * Subscribes to a channel or channel resource.
+ *
+ * The method returns a subscription ID immediately. The connection is
+ * established asynchronously in the background. Use the `options` parameter
+ * to register lifecycle handlers that notify you when the subscription
+ * succeeds or encounters an error.
+ *
+ * If the connection drops, the client automatically attempts to reconnect
+ * and re-subscribe. The `onSubscribed` handler fires again on each
+ * successful re-subscription.
  *
  * @example Manual client (self-hosted / explicit auth)
  * ```ts
@@ -42,18 +49,21 @@ const rest_modules_1 = require("@wix/sdk-runtime/rest-modules");
  * );
  * ```
  *
- * @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.
+ * @param channel - Channel, and optionally resource, to subscribe to.
+ * @param messageHandler - Callback that runs whenever a message is published to the channel.
+ * @param options - 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.
+ * Removes one or more subscriptions.
  *
  * 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.
+ * - By `subscriptionId`: removes a single subscription.
+ * - By `channel`: removes all subscriptions to that channel or channel resource.
+ * - By both: removes the specific subscription, verifying it matches the channel.
+ *
+ * When the last subscription on a connection is removed, the connection
+ * closes automatically.
  *
  * @example Manual client (self-hosted / explicit auth)
  * ```ts
@@ -79,6 +89,6 @@ exports.subscribe = (0, rest_modules_1.createRESTModule)(subscriber_public_js_1.
  * subscriber.unsubscribe({ subscriptionId });
  * ```
  *
- * @param options - Identifies what to unsubscribe from — by subscription ID, channel, or both.
+ * @param options - Specifies what to unsubscribe from. At least one of `channel` or `subscriptionId` is required.
  */
 exports.unsubscribe = (0, rest_modules_1.createRESTModule)(subscriber_public_js_1.unsubscribe);