@wix/realtime 1.0.58 → 1.0.60

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

@@ -17,7 +17,8 @@ export type { PublishChannel } from '@wix/realtime-common/types';
  * import { publisher } from '@wix/realtime';
  * import { elevate } from '@wix/sdk/context';
  *
- * await elevate(publisher.publish)({ name: 'my-channel' }, { message: 'hello' });
+ * const elevatedPublish = elevate(publisher.publish);
+ * await elevatedPublish({ name: 'my-channel' }, { text: 'hello' });
  * ```
  *
  * @example Publish a message to the specified channel: Self-hosted
@@ -33,7 +34,7 @@ export type { PublishChannel } from '@wix/realtime-common/types';
  *   // Include the auth strategy and host as relevant
  * });
  *
- * await client.publisher.publish({ name: 'my-channel' }, { message: 'hello' });
+ * await client.publisher.publish({ name: 'my-channel' }, { text: 'hello' });
  * ```
  *
  * @param channel - Channel and resource to publish to.

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

@@ -19,7 +19,8 @@ const rest_modules_1 = require("@wix/sdk-runtime/rest-modules");
  * import { publisher } from '@wix/realtime';
  * import { elevate } from '@wix/sdk/context';
  *
- * await elevate(publisher.publish)({ name: 'my-channel' }, { message: 'hello' });
+ * const elevatedPublish = elevate(publisher.publish);
+ * await elevatedPublish({ name: 'my-channel' }, { text: 'hello' });
  * ```
  *
  * @example Publish a message to the specified channel: Self-hosted
@@ -35,7 +36,7 @@ const rest_modules_1 = require("@wix/sdk-runtime/rest-modules");
  *   // Include the auth strategy and host as relevant
  * });
  *
- * await client.publisher.publish({ name: 'my-channel' }, { message: 'hello' });
+ * await client.publisher.publish({ name: 'my-channel' }, { text: 'hello' });
  * ```
  *
  * @param channel - Channel and resource to publish to.

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

@@ -8,6 +8,7 @@ export declare function invalidChannel(channel: Channel): RealtimeError;
 export declare function validateChannel(channel: Channel): void;
 export declare function disconnectedError(recoverable?: boolean, message?: string): RealtimeError;
 export declare function connectError(recoverable?: boolean, message?: string): RealtimeError;
+export declare function subscribeTimedOut(channel: SubscribeChannel, timeoutMs: number): RealtimeError;
 export declare function subscribeFailed(channel: SubscribeChannel, payload?: {
     status?: number;
     message?: string;

package/cjs/build/subscriber/errors.js

@@ -9,6 +9,7 @@ exports.invalidChannel = invalidChannel;
 exports.validateChannel = validateChannel;
 exports.disconnectedError = disconnectedError;
 exports.connectError = connectError;
+exports.subscribeTimedOut = subscribeTimedOut;
 exports.subscribeFailed = subscribeFailed;
 exports.resubscribeFailed = resubscribeFailed;
 exports.subscribeError = subscribeError;
@@ -72,6 +73,15 @@ function disconnectedError(recoverable, message) {
 function connectError(recoverable, message) {
     return new types_1.RealtimeError(types_1.RealtimeErrorCode.ConnectionError, message || 'connection error', { recoverable });
 }
+function subscribeTimedOut(channel, timeoutMs) {
+    const target = channel.resourceId
+        ? `"${channel.name}" / "${channel.resourceId}"`
+        : `"${channel.name}"`;
+    return new types_1.RealtimeError(types_1.RealtimeErrorCode.ConnectionError, `Subscription to ${target} did not connect within ${timeoutMs}ms. The realtime ` +
+        `socket has not been established — commonly a page served over http:// dialing ` +
+        `ws:// to a TLS-only host, or a blocked/offline network. The client keeps retrying, ` +
+        `so this may still succeed.`, { channel, recoverable: true });
+}
 function subscriptionFailed(prefix, channel, payload) {
     let msg = `${prefix} failed`;
     if (payload?.message) {

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

@@ -143,6 +143,8 @@ function cleanupConnectionIfIdle(socketAppId, siteId) {
         closeConnection(socketAppId, siteId);
     }
 }
+// Surface a stalled initial subscription after this long, via onSubscriptionError.
+const SUBSCRIBE_TIMEOUT_MS = 10_000;
 function getOrCreateConnection(httpClient, socketAppId, siteId) {
     const key = socketKey(socketAppId, siteId);
     const existing = instanceConnections.get(key);
@@ -206,8 +208,11 @@ async function setupSubscription(httpClient, subscriptionId, channel, messageHan
                 publisher: publisher?.uid ? { id: publisher.uid } : undefined,
             }, channel);
         };
+        // Cleared on subscribe success/failure; armed just after subscribe below.
+        let subscribeTimeout;
         // --- callback definitions (hoisted above subscribe for #6 race fix) ---
         function onSubscribeSucceeded(payload) {
+            clearTimeout(subscribeTimeout);
             subscribedChannel.off(realtime_common_1.DUPLEXER_EVENTS.subscriptionFailed, onSubscribeFailed);
             // If the subscription was removed (via unsubscribe) while waiting for
             // the duplexer to confirm, clean up the duplexer channel to avoid a
@@ -256,6 +261,7 @@ async function setupSubscription(httpClient, subscriptionId, channel, messageHan
             });
         }
         function onSubscribeFailed(payload) {
+            clearTimeout(subscribeTimeout);
             subscribedChannel.off(realtime_common_1.DUPLEXER_EVENTS.subscriptionSucceeded, onSubscribeSucceeded);
             const failedEntry = subscriptionManager.get(subscriptionId);
             subscriptionManager.delete(subscriptionId);
@@ -269,6 +275,14 @@ async function setupSubscription(httpClient, subscriptionId, channel, messageHan
         });
         subscribedChannel.once(realtime_common_1.DUPLEXER_EVENTS.subscriptionSucceeded, onSubscribeSucceeded);
         subscribedChannel.once(realtime_common_1.DUPLEXER_EVENTS.subscriptionFailed, onSubscribeFailed);
+        // If neither success nor failure fires in time, report a recoverable timeout
+        // but keep the subscription alive so a late connect can still succeed.
+        subscribeTimeout = setTimeout(() => {
+            const entry = subscriptionManager.get(subscriptionId);
+            if (entry && !entry.channelEmitter) {
+                entry.onSubscriptionError?.((0, errors_js_1.subscribeTimedOut)(channel, SUBSCRIBE_TIMEOUT_MS), subscriptionId);
+            }
+        }, SUBSCRIBE_TIMEOUT_MS);
     }
     catch (error) {
         const sub = subscriptionManager.get(subscriptionId);

package/dist/statics/docs-ts-model.json

@@ -125,7 +125,7 @@
                         },
                         {
                           "kind": "code",
-                          "text": "```ts\nimport { publisher } from '@wix/realtime';\nimport { elevate } from '@wix/sdk/context';\n\nawait elevate(publisher.publish)({ name: 'my-channel' }, { message: 'hello' });\n```"
+                          "text": "```ts\nimport { publisher } from '@wix/realtime';\nimport { elevate } from '@wix/sdk/context';\n\nconst elevatedPublish = elevate(publisher.publish);\nawait elevatedPublish({ name: 'my-channel' }, { text: 'hello' });\n```"
                         }
                       ]
                     },
@@ -138,7 +138,7 @@
                         },
                         {
                           "kind": "code",
-                          "text": "```ts\nimport { publisher } from '@wix/realtime';\nimport { createClient } from '@wix/sdk';\n\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst client = createClient({\n  modules: { publisher },\n  // Include the auth strategy and host as relevant\n});\n\nawait client.publisher.publish({ name: 'my-channel' }, { message: 'hello' });\n```"
+                          "text": "```ts\nimport { publisher } from '@wix/realtime';\nimport { createClient } from '@wix/sdk';\n\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst client = createClient({\n  modules: { publisher },\n  // Include the auth strategy and host as relevant\n});\n\nawait client.publisher.publish({ name: 'my-channel' }, { text: 'hello' });\n```"
                         }
                       ]
                     },
@@ -285,7 +285,7 @@
                         },
                         {
                           "kind": "code",
-                          "text": "```ts\nimport { publisher } from '@wix/realtime';\nimport { elevate } from '@wix/sdk/context';\n\nawait elevate(publisher.publish)({ name: 'my-channel' }, { message: 'hello' });\n```"
+                          "text": "```ts\nimport { publisher } from '@wix/realtime';\nimport { elevate } from '@wix/sdk/context';\n\nconst elevatedPublish = elevate(publisher.publish);\nawait elevatedPublish({ name: 'my-channel' }, { text: 'hello' });\n```"
                         }
                       ]
                     },
@@ -298,7 +298,7 @@
                         },
                         {
                           "kind": "code",
-                          "text": "```ts\nimport { publisher } from '@wix/realtime';\nimport { createClient } from '@wix/sdk';\n\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst client = createClient({\n  modules: { publisher },\n  // Include the auth strategy and host as relevant\n});\n\nawait client.publisher.publish({ name: 'my-channel' }, { message: 'hello' });\n```"
+                          "text": "```ts\nimport { publisher } from '@wix/realtime';\nimport { createClient } from '@wix/sdk';\n\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst client = createClient({\n  modules: { publisher },\n  // Include the auth strategy and host as relevant\n});\n\nawait client.publisher.publish({ name: 'my-channel' }, { text: 'hello' });\n```"
                         }
                       ]
                     },

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

@@ -17,7 +17,8 @@ export type { PublishChannel } from '@wix/realtime-common/types';
  * import { publisher } from '@wix/realtime';
  * import { elevate } from '@wix/sdk/context';
  *
- * await elevate(publisher.publish)({ name: 'my-channel' }, { message: 'hello' });
+ * const elevatedPublish = elevate(publisher.publish);
+ * await elevatedPublish({ name: 'my-channel' }, { text: 'hello' });
  * ```
  *
  * @example Publish a message to the specified channel: Self-hosted
@@ -33,7 +34,7 @@ export type { PublishChannel } from '@wix/realtime-common/types';
  *   // Include the auth strategy and host as relevant
  * });
  *
- * await client.publisher.publish({ name: 'my-channel' }, { message: 'hello' });
+ * await client.publisher.publish({ name: 'my-channel' }, { text: 'hello' });
  * ```
  *
  * @param channel - Channel and resource to publish to.

package/es/build/publisher/publisher.context.js

@@ -16,7 +16,8 @@ import { createRESTModule } from '@wix/sdk-runtime/rest-modules';
  * import { publisher } from '@wix/realtime';
  * import { elevate } from '@wix/sdk/context';
  *
- * await elevate(publisher.publish)({ name: 'my-channel' }, { message: 'hello' });
+ * const elevatedPublish = elevate(publisher.publish);
+ * await elevatedPublish({ name: 'my-channel' }, { text: 'hello' });
  * ```
  *
  * @example Publish a message to the specified channel: Self-hosted
@@ -32,7 +33,7 @@ import { createRESTModule } from '@wix/sdk-runtime/rest-modules';
  *   // Include the auth strategy and host as relevant
  * });
  *
- * await client.publisher.publish({ name: 'my-channel' }, { message: 'hello' });
+ * await client.publisher.publish({ name: 'my-channel' }, { text: 'hello' });
  * ```
  *
  * @param channel - Channel and resource to publish to.

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

@@ -8,6 +8,7 @@ export declare function invalidChannel(channel: Channel): RealtimeError;
 export declare function validateChannel(channel: Channel): void;
 export declare function disconnectedError(recoverable?: boolean, message?: string): RealtimeError;
 export declare function connectError(recoverable?: boolean, message?: string): RealtimeError;
+export declare function subscribeTimedOut(channel: SubscribeChannel, timeoutMs: number): RealtimeError;
 export declare function subscribeFailed(channel: SubscribeChannel, payload?: {
     status?: number;
     message?: string;

package/es/build/subscriber/errors.js

@@ -58,6 +58,15 @@ export function disconnectedError(recoverable, message) {
 export function connectError(recoverable, message) {
     return new RealtimeError(RealtimeErrorCode.ConnectionError, message || 'connection error', { recoverable });
 }
+export function subscribeTimedOut(channel, timeoutMs) {
+    const target = channel.resourceId
+        ? `"${channel.name}" / "${channel.resourceId}"`
+        : `"${channel.name}"`;
+    return new RealtimeError(RealtimeErrorCode.ConnectionError, `Subscription to ${target} did not connect within ${timeoutMs}ms. The realtime ` +
+        `socket has not been established — commonly a page served over http:// dialing ` +
+        `ws:// to a TLS-only host, or a blocked/offline network. The client keeps retrying, ` +
+        `so this may still succeed.`, { channel, recoverable: true });
+}
 function subscriptionFailed(prefix, channel, payload) {
     let msg = `${prefix} failed`;
     if (payload?.message) {

package/es/build/subscriber/subscriber.public.js

@@ -3,7 +3,7 @@ import { DUPLEXER_EVENTS, MESSAGE_EVENT_NAME, getAppInfoFromAuthToken, tokenToAp
 import { v4 as uuidv4 } from 'uuid';
 import { resolveDuplexerChannelName } from '../channel-utils.js';
 import { DUPLEXER_HOST_URL } from '../constants.js';
-import { missingChannelOrSubscriptionId, channelMismatch, channelAppIdMismatch, unsubscribeRequiresAppId, unknownChannelAppId, disconnectedError, connectError, subscribeFailed, resubscribeFailed, subscribeError, validateChannel, } from './errors.js';
+import { missingChannelOrSubscriptionId, channelMismatch, channelAppIdMismatch, unsubscribeRequiresAppId, unknownChannelAppId, disconnectedError, connectError, subscribeFailed, resubscribeFailed, subscribeError, subscribeTimedOut, validateChannel, } from './errors.js';
 import { SubscriptionManager } from './subscription-manager.js';
 function socketKey(socketAppId, siteId) {
     return `${socketAppId}:${siteId}`;
@@ -138,6 +138,8 @@ function cleanupConnectionIfIdle(socketAppId, siteId) {
         closeConnection(socketAppId, siteId);
     }
 }
+// Surface a stalled initial subscription after this long, via onSubscriptionError.
+const SUBSCRIBE_TIMEOUT_MS = 10_000;
 function getOrCreateConnection(httpClient, socketAppId, siteId) {
     const key = socketKey(socketAppId, siteId);
     const existing = instanceConnections.get(key);
@@ -201,8 +203,11 @@ async function setupSubscription(httpClient, subscriptionId, channel, messageHan
                 publisher: publisher?.uid ? { id: publisher.uid } : undefined,
             }, channel);
         };
+        // Cleared on subscribe success/failure; armed just after subscribe below.
+        let subscribeTimeout;
         // --- callback definitions (hoisted above subscribe for #6 race fix) ---
         function onSubscribeSucceeded(payload) {
+            clearTimeout(subscribeTimeout);
             subscribedChannel.off(DUPLEXER_EVENTS.subscriptionFailed, onSubscribeFailed);
             // If the subscription was removed (via unsubscribe) while waiting for
             // the duplexer to confirm, clean up the duplexer channel to avoid a
@@ -251,6 +256,7 @@ async function setupSubscription(httpClient, subscriptionId, channel, messageHan
             });
         }
         function onSubscribeFailed(payload) {
+            clearTimeout(subscribeTimeout);
             subscribedChannel.off(DUPLEXER_EVENTS.subscriptionSucceeded, onSubscribeSucceeded);
             const failedEntry = subscriptionManager.get(subscriptionId);
             subscriptionManager.delete(subscriptionId);
@@ -264,6 +270,14 @@ async function setupSubscription(httpClient, subscriptionId, channel, messageHan
         });
         subscribedChannel.once(DUPLEXER_EVENTS.subscriptionSucceeded, onSubscribeSucceeded);
         subscribedChannel.once(DUPLEXER_EVENTS.subscriptionFailed, onSubscribeFailed);
+        // If neither success nor failure fires in time, report a recoverable timeout
+        // but keep the subscription alive so a late connect can still succeed.
+        subscribeTimeout = setTimeout(() => {
+            const entry = subscriptionManager.get(subscriptionId);
+            if (entry && !entry.channelEmitter) {
+                entry.onSubscriptionError?.(subscribeTimedOut(channel, SUBSCRIBE_TIMEOUT_MS), subscriptionId);
+            }
+        }, SUBSCRIBE_TIMEOUT_MS);
     }
     catch (error) {
         const sub = subscriptionManager.get(subscriptionId);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/realtime",
-  "version": "1.0.58",
+  "version": "1.0.60",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -43,7 +43,7 @@
   "dependencies": {
     "@wix/auto_sdk_duplexer_publisher": "^1.0.10",
     "@wix/auto_sdk_duplexer_realtime-permissions-provider": "^1.0.3",
-    "@wix/duplexer-js": "^2.0.6",
+    "@wix/duplexer-js": "^2.0.11",
     "@wix/realtime-common": "1.0.21",
     "@wix/sdk": "^1.21.4",
     "@wix/sdk-runtime": "^1.0.9",
@@ -72,5 +72,5 @@
       "isRootPublicSdk": true
     }
   },
-  "falconPackageHash": "c267e028556d885cfdf1aaf4198bd6fa301f290af81fbbb5b9575dbc"
+  "falconPackageHash": "f348b697ba9d7cf1e635ee58ddc37776af77932d9faee97e4b637d5d"
 }