@wix/realtime 1.0.48 → 1.0.52

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

@@ -15,13 +15,95 @@
         "children": [
           {
             "id": 53,
+            "name": "PublishChannel",
+            "variant": "declaration",
+            "kind": 256,
+            "flags": {},
+            "comment": {
+              "summary": [
+                {
+                  "kind": "text",
+                  "text": "Realtime broadcast published channel. Publishers send messages to channels and subscribers listen to them."
+                }
+              ]
+            },
+            "children": [
+              {
+                "id": 54,
+                "name": "name",
+                "variant": "declaration",
+                "kind": 1024,
+                "flags": {},
+                "comment": {
+                  "summary": [
+                    {
+                      "kind": "text",
+                      "text": "Channel name.\n\n> **Notes:**\n> - Supports only alphanumeric characters, hyphens, and underscores.\n> - The combined length of "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`name`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": " and "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`resourceId`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": " can't exceed 140 characters."
+                    }
+                  ]
+                },
+                "type": {
+                  "type": "intrinsic",
+                  "name": "string"
+                }
+              },
+              {
+                "id": 55,
+                "name": "resourceId",
+                "variant": "declaration",
+                "kind": 1024,
+                "flags": {
+                  "isOptional": true
+                },
+                "comment": {
+                  "summary": [
+                    {
+                      "kind": "text",
+                      "text": "Resource ID.\n\nResources are independent sub-channels in a channel. A subscriber listening to a resource doesn't receive messages published to the parent channel, and vice versa."
+                    }
+                  ]
+                },
+                "type": {
+                  "type": "intrinsic",
+                  "name": "string"
+                }
+              }
+            ],
+            "groups": [
+              {
+                "title": "Properties",
+                "children": [
+                  54,
+                  55
+                ]
+              }
+            ]
+          },
+          {
+            "id": 56,
             "name": "publish",
             "variant": "declaration",
             "kind": 64,
             "flags": {},
             "signatures": [
               {
-                "id": 54,
+                "id": 57,
                 "name": "publish",
                 "variant": "signature",
                 "kind": 4096,
@@ -109,7 +191,7 @@
                 },
                 "parameters": [
                   {
-                    "id": 55,
+                    "id": 58,
                     "name": "channel",
                     "variant": "param",
                     "kind": 32768,
@@ -124,13 +206,13 @@
                     },
                     "type": {
                       "type": "reference",
-                      "target": 31,
-                      "name": "Channel",
+                      "target": 53,
+                      "name": "PublishChannel",
                       "package": "@wix/realtime-common"
                     }
                   },
                   {
-                    "id": 56,
+                    "id": 59,
                     "name": "payload",
                     "variant": "param",
                     "kind": 32768,
@@ -181,7 +263,7 @@
                 }
               },
               {
-                "id": 57,
+                "id": 60,
                 "name": "publish",
                 "variant": "signature",
                 "kind": 4096,
@@ -269,7 +351,7 @@
                 },
                 "parameters": [
                   {
-                    "id": 58,
+                    "id": 61,
                     "name": "httpClient",
                     "variant": "param",
                     "kind": 32768,
@@ -300,10 +382,16 @@
         ],
         "groups": [
           {
-            "title": "Functions",
+            "title": "Interfaces",
             "children": [
               53
             ]
+          },
+          {
+            "title": "Functions",
+            "children": [
+              56
+            ]
           }
         ]
       },
@@ -1973,1533 +2061,1244 @@
         ]
       },
       {
-        "id": 59,
+        "id": 62,
         "name": "subscriber",
         "variant": "declaration",
         "kind": 4,
         "flags": {},
         "children": [
           {
-            "id": 60,
-            "name": "subscribe",
+            "id": 107,
+            "name": "RealtimeErrorCode",
             "variant": "declaration",
-            "kind": 64,
+            "kind": 8,
             "flags": {},
-            "signatures": [
+            "comment": {
+              "summary": [
+                {
+                  "kind": "text",
+                  "text": "Error codes."
+                }
+              ]
+            },
+            "children": [
               {
-                "id": 61,
-                "name": "subscribe",
-                "variant": "signature",
-                "kind": 4096,
+                "id": 111,
+                "name": "BadInput",
+                "variant": "declaration",
+                "kind": 16,
                 "flags": {},
                 "comment": {
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Subscribes to a channel or resource.\n\nThe method attempts to establish a subscription to the specified channel or resource. It returns the subscription ID immediately while the subscription is attempted in the background.\n\nUse the "
-                    },
+                      "text": "Invalid input such as a channel name with unsupported characters."
+                    }
+                  ]
+                },
+                "type": {
+                  "type": "literal",
+                  "value": "BAD_INPUT"
+                }
+              },
+              {
+                "id": 109,
+                "name": "ConnectionError",
+                "variant": "declaration",
+                "kind": 16,
+                "flags": {},
+                "comment": {
+                  "summary": [
                     {
-                      "kind": "code",
-                      "text": "`options`"
-                    },
+                      "kind": "text",
+                      "text": "Connection attempt failed. Wix automatically attempts to establish the subscription."
+                    }
+                  ]
+                },
+                "type": {
+                  "type": "literal",
+                  "value": "CONNECTION_ERROR"
+                }
+              },
+              {
+                "id": 108,
+                "name": "Disconnected",
+                "variant": "declaration",
+                "kind": 16,
+                "flags": {},
+                "comment": {
+                  "summary": [
                     {
                       "kind": "text",
-                      "text": " parameter to register handlers that run whenever the subscription succeeds or generates an error. For some errors, the subscription is re-attempted automatically. The "
+                      "text": "Connection closed intentionally or due to an error. Check "
                     },
                     {
                       "kind": "code",
-                      "text": "`onSubscribed()`"
+                      "text": "`error.recoverable`"
                     },
                     {
                       "kind": "text",
-                      "text": " handler runs on every successful re-subscription.\n\nLearn more about the [subscription lifecycle](https://dev.wix.com/docs/sdk/core-modules/realtime/realtime/subscriber/introduction#core-modules_realtime_realtime_subscriber_subscription-lifecycle)."
-                    }
-                  ],
-                  "blockTags": [
-                    {
-                      "tag": "@example",
-                      "content": [
-                        {
-                          "kind": "text",
-                          "text": "Subscribe to a channel\n"
-                        },
-                        {
-                          "kind": "code",
-                          "text": "```ts\nimport { subscriber } from '@wix/realtime';\n\nconst subscriptionId = subscriber.subscribe(\n  { name: 'my-channel' },\n  (message, channel) => {\n    console.log('Received:', message.payload);\n  },\n);\n```"
-                        }
-                      ]
-                    },
-                    {
-                      "tag": "@example",
-                      "content": [
-                        {
-                          "kind": "text",
-                          "text": "Subscribe to a channel: Self-hosted\n"
-                        },
-                        {
-                          "kind": "code",
-                          "text": "```ts\nimport { createClient } from '@wix/sdk';\nimport { subscriber } from '@wix/realtime';\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: { subscriber },\n  // Include the auth strategy and host as relevant\n});\n\nconst subscriptionId = client.subscriber.subscribe(\n  { name: 'my-channel' },\n  (message, channel) => {\n    console.log('Received:', message.payload);\n  },\n  {\n    onSubscribed: (id, isSynced) => console.log('Subscribed', id),\n    onSubscriptionError: (error, id) => console.error('Error', error),\n  },\n);\n```"
-                        }
-                      ]
-                    },
-                    {
-                      "tag": "@requiredField",
-                      "content": [
-                        {
-                          "kind": "text",
-                          "text": "channel"
-                        }
-                      ]
-                    },
-                    {
-                      "tag": "@requiredField",
-                      "content": [
-                        {
-                          "kind": "text",
-                          "text": "messageHandler"
-                        }
-                      ]
+                      "text": " to determine whether the client is attempting to reconnect."
                     }
                   ]
                 },
-                "parameters": [
-                  {
-                    "id": 62,
-                    "name": "channel",
-                    "variant": "param",
-                    "kind": 32768,
-                    "flags": {},
-                    "comment": {
-                      "summary": [
-                        {
-                          "kind": "text",
-                          "text": "Channel and resource to subscribe to."
-                        }
-                      ]
-                    },
-                    "type": {
-                      "type": "reference",
-                      "target": 73,
-                      "name": "SubscribeChannel",
-                      "package": "@wix/realtime-common"
-                    }
-                  },
-                  {
-                    "id": 63,
-                    "name": "messageHandler",
-                    "variant": "param",
-                    "kind": 32768,
-                    "flags": {},
-                    "comment": {
-                      "summary": [
-                        {
-                          "kind": "text",
-                          "text": "Handler that runs whenever a message is published to the channel or resource."
-                        }
-                      ]
-                    },
-                    "type": {
-                      "type": "reference",
-                      "target": 80,
-                      "name": "MessageHandler",
-                      "package": "@wix/realtime-common"
-                    }
-                  },
-                  {
-                    "id": 64,
-                    "name": "options",
-                    "variant": "param",
-                    "kind": 32768,
-                    "flags": {
-                      "isOptional": true
-                    },
-                    "comment": {
-                      "summary": [
-                        {
-                          "kind": "text",
-                          "text": "[Lifecycle handlers](https://dev.wix.com/docs/sdk/core-modules/realtime/realtime/subscriber/introduction#core-modules_realtime_realtime_subscriber_subscription-lifecycle) for subscription events."
-                        }
-                      ]
-                    },
-                    "type": {
-                      "type": "reference",
-                      "target": 97,
-                      "name": "SubscriptionOptions",
-                      "package": "@wix/realtime-common"
-                    }
-                  }
-                ],
                 "type": {
-                  "type": "intrinsic",
-                  "name": "string"
+                  "type": "literal",
+                  "value": "DISCONNECTED"
                 }
               },
               {
-                "id": 65,
-                "name": "subscribe",
-                "variant": "signature",
-                "kind": 4096,
+                "id": 110,
+                "name": "SubscriptionFailed",
+                "variant": "declaration",
+                "kind": 16,
                 "flags": {},
                 "comment": {
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Subscribes to a channel or resource.\n\nThe method attempts to establish a subscription to the specified channel or resource. It returns the subscription ID immediately while the subscription is attempted in the background.\n\nUse the "
-                    },
-                    {
-                      "kind": "code",
-                      "text": "`options`"
-                    },
-                    {
-                      "kind": "text",
-                      "text": " parameter to register handlers that run whenever the subscription succeeds or generates an error. For some errors, the subscription is re-attempted automatically. The "
-                    },
-                    {
-                      "kind": "code",
-                      "text": "`onSubscribed()`"
-                    },
-                    {
-                      "kind": "text",
-                      "text": " handler runs on every successful re-subscription.\n\nLearn more about the [subscription lifecycle](https://dev.wix.com/docs/sdk/core-modules/realtime/realtime/subscriber/introduction#core-modules_realtime_realtime_subscriber_subscription-lifecycle)."
-                    }
-                  ],
-                  "blockTags": [
-                    {
-                      "tag": "@example",
-                      "content": [
-                        {
-                          "kind": "text",
-                          "text": "Subscribe to a channel\n"
-                        },
-                        {
-                          "kind": "code",
-                          "text": "```ts\nimport { subscriber } from '@wix/realtime';\n\nconst subscriptionId = subscriber.subscribe(\n  { name: 'my-channel' },\n  (message, channel) => {\n    console.log('Received:', message.payload);\n  },\n);\n```"
-                        }
-                      ]
-                    },
-                    {
-                      "tag": "@example",
-                      "content": [
-                        {
-                          "kind": "text",
-                          "text": "Subscribe to a channel: Self-hosted\n"
-                        },
-                        {
-                          "kind": "code",
-                          "text": "```ts\nimport { createClient } from '@wix/sdk';\nimport { subscriber } from '@wix/realtime';\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: { subscriber },\n  // Include the auth strategy and host as relevant\n});\n\nconst subscriptionId = client.subscriber.subscribe(\n  { name: 'my-channel' },\n  (message, channel) => {\n    console.log('Received:', message.payload);\n  },\n  {\n    onSubscribed: (id, isSynced) => console.log('Subscribed', id),\n    onSubscriptionError: (error, id) => console.error('Error', error),\n  },\n);\n```"
-                        }
-                      ]
-                    },
-                    {
-                      "tag": "@requiredField",
-                      "content": [
-                        {
-                          "kind": "text",
-                          "text": "channel"
-                        }
-                      ]
-                    },
-                    {
-                      "tag": "@requiredField",
-                      "content": [
-                        {
-                          "kind": "text",
-                          "text": "messageHandler"
-                        }
-                      ]
+                      "text": "Subscription request rejected, for example, due to an authorization failure. This error is non-recoverable."
                     }
                   ]
                 },
-                "parameters": [
+                "type": {
+                  "type": "literal",
+                  "value": "SUBSCRIPTION_FAILED"
+                }
+              }
+            ],
+            "groups": [
+              {
+                "title": "Enumeration Members",
+                "children": [
+                  111,
+                  109,
+                  108,
+                  110
+                ]
+              }
+            ]
+          },
+          {
+            "id": 93,
+            "name": "RealtimeError",
+            "variant": "declaration",
+            "kind": 128,
+            "flags": {},
+            "comment": {
+              "summary": [
+                {
+                  "kind": "text",
+                  "text": "Error thrown by a subscription or connection."
+                }
+              ]
+            },
+            "children": [
+              {
+                "id": 94,
+                "name": "constructor",
+                "variant": "declaration",
+                "kind": 512,
+                "flags": {},
+                "signatures": [
                   {
-                    "id": 66,
-                    "name": "httpClient",
-                    "variant": "param",
-                    "kind": 32768,
+                    "id": 95,
+                    "name": "new RealtimeError",
+                    "variant": "signature",
+                    "kind": 16384,
                     "flags": {},
+                    "parameters": [
+                      {
+                        "id": 96,
+                        "name": "errorCode",
+                        "variant": "param",
+                        "kind": 32768,
+                        "flags": {},
+                        "type": {
+                          "type": "reference",
+                          "target": 107,
+                          "name": "RealtimeErrorCode",
+                          "package": "@wix/realtime-common"
+                        }
+                      },
+                      {
+                        "id": 97,
+                        "name": "message",
+                        "variant": "param",
+                        "kind": 32768,
+                        "flags": {},
+                        "type": {
+                          "type": "intrinsic",
+                          "name": "string"
+                        }
+                      },
+                      {
+                        "id": 98,
+                        "name": "options",
+                        "variant": "param",
+                        "kind": 32768,
+                        "flags": {
+                          "isOptional": true
+                        },
+                        "type": {
+                          "type": "reflection",
+                          "declaration": {
+                            "id": 99,
+                            "name": "__type",
+                            "variant": "declaration",
+                            "kind": 65536,
+                            "flags": {},
+                            "children": [
+                              {
+                                "id": 100,
+                                "name": "channel",
+                                "variant": "declaration",
+                                "kind": 1024,
+                                "flags": {
+                                  "isOptional": true
+                                },
+                                "type": {
+                                  "type": "reference",
+                                  "target": 63,
+                                  "name": "SubscribeChannel",
+                                  "package": "@wix/realtime-common"
+                                }
+                              },
+                              {
+                                "id": 101,
+                                "name": "recoverable",
+                                "variant": "declaration",
+                                "kind": 1024,
+                                "flags": {
+                                  "isOptional": true
+                                },
+                                "type": {
+                                  "type": "intrinsic",
+                                  "name": "boolean"
+                                }
+                              },
+                              {
+                                "id": 102,
+                                "name": "status",
+                                "variant": "declaration",
+                                "kind": 1024,
+                                "flags": {
+                                  "isOptional": true
+                                },
+                                "type": {
+                                  "type": "intrinsic",
+                                  "name": "number"
+                                }
+                              }
+                            ],
+                            "groups": [
+                              {
+                                "title": "Properties",
+                                "children": [
+                                  100,
+                                  101,
+                                  102
+                                ]
+                              }
+                            ]
+                          }
+                        }
+                      }
+                    ],
                     "type": {
                       "type": "reference",
-                      "target": {
-                        "sourceFileName": "../../node_modules/@wix/sdk-types/build/index.d.ts",
-                        "qualifiedName": "HttpClient"
-                      },
-                      "name": "HttpClient",
-                      "package": "@wix/sdk-types"
+                      "target": 93,
+                      "name": "RealtimeError",
+                      "package": "@wix/realtime-common"
+                    },
+                    "overwrites": {
+                      "type": "reference",
+                      "target": -1,
+                      "name": "Error.constructor"
                     }
                   }
                 ],
+                "overwrites": {
+                  "type": "reference",
+                  "target": -1,
+                  "name": "Error.constructor"
+                }
+              },
+              {
+                "id": 104,
+                "name": "channel",
+                "variant": "declaration",
+                "kind": 1024,
+                "flags": {
+                  "isOptional": true
+                },
+                "comment": {
+                  "summary": [
+                    {
+                      "kind": "text",
+                      "text": "Channel that caused the error."
+                    }
+                  ]
+                },
                 "type": {
                   "type": "reference",
-                  "target": {
-                    "sourceFileName": "src/subscriber/subscriber.public.ts",
-                    "qualifiedName": "SubscribeSignature"
-                  },
-                  "name": "SubscribeSignature",
-                  "package": "@wix/realtime"
+                  "target": 63,
+                  "name": "SubscribeChannel",
+                  "package": "@wix/realtime-common"
                 }
-              }
-            ]
-          },
-          {
-            "id": 67,
-            "name": "unsubscribe",
-            "variant": "declaration",
-            "kind": 64,
-            "flags": {},
-            "signatures": [
+              },
               {
-                "id": 68,
-                "name": "unsubscribe",
-                "variant": "signature",
-                "kind": 4096,
+                "id": 103,
+                "name": "errorCode",
+                "variant": "declaration",
+                "kind": 1024,
                 "flags": {},
                 "comment": {
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Removes 1 or more subscriptions.\n\nYou can unsubscribe in 3 ways:\n- By "
+                      "text": "Error code."
+                    }
+                  ]
+                },
+                "type": {
+                  "type": "reference",
+                  "target": 107,
+                  "name": "RealtimeErrorCode",
+                  "package": "@wix/realtime-common"
+                }
+              },
+              {
+                "id": 105,
+                "name": "recoverable",
+                "variant": "declaration",
+                "kind": 1024,
+                "flags": {
+                  "isOptional": true
+                },
+                "comment": {
+                  "summary": [
+                    {
+                      "kind": "text",
+                      "text": "Whether the error is automatically recoverable.\n\nWhen "
                     },
                     {
                       "kind": "code",
-                      "text": "`subscriptionId`"
+                      "text": "`true`"
                     },
                     {
                       "kind": "text",
-                      "text": ": removes a single subscription.\n- By "
+                      "text": ", the client automatically attempts to reconnect. When "
                     },
                     {
                       "kind": "code",
-                      "text": "`channel`"
+                      "text": "`false`"
                     },
                     {
                       "kind": "text",
-                      "text": ": removes all subscriptions to that channel or resource.\n- By both: removes the specific subscription, verifying it matches the channel.\n\nWhen the last subscription on a connection is removed, the connection\ncloses automatically."
-                    }
-                  ],
-                  "blockTags": [
-                    {
-                      "tag": "@example",
-                      "content": [
-                        {
-                          "kind": "text",
-                          "text": "Remove the specified subscription.\n"
-                        },
-                        {
-                          "kind": "code",
-                          "text": "```ts\nimport { subscriber } from '@wix/realtime';\n\nsubscriber.unsubscribe({ subscriptionId });\n```"
-                        }
-                      ]
+                      "text": ", you must attempt to re-subscribe manually.\n\nDefault: "
                     },
                     {
-                      "tag": "@example",
-                      "content": [
-                        {
-                          "kind": "text",
-                          "text": "Remove the specified subscription: Self-hosted\n"
-                        },
-                        {
-                          "kind": "code",
-                          "text": "```ts\nimport { subscriber } 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: { subscriber },\n  // Include the auth strategy and host as relevant\n});\n\n// Remove the specified subscription\nclient.subscriber.unsubscribe({ subscriptionId });\n\n// Remove all subscriptions from the specified channel\nclient.subscriber.unsubscribe({ channel: { name: 'my-channel' } });\n```"
-                        }
-                      ]
+                      "kind": "code",
+                      "text": "`false`"
                     },
                     {
-                      "tag": "@requiredField",
-                      "content": [
-                        {
-                          "kind": "text",
-                          "text": "options"
-                        }
-                      ]
+                      "kind": "text",
+                      "text": "."
                     }
                   ]
                 },
-                "parameters": [
-                  {
-                    "id": 69,
-                    "name": "options",
-                    "variant": "param",
-                    "kind": 32768,
-                    "flags": {},
-                    "comment": {
-                      "summary": [
-                        {
-                          "kind": "text",
-                          "text": "Unsubscribe details. You must specify "
-                        },
-                        {
-                          "kind": "code",
-                          "text": "`channel`"
-                        },
-                        {
-                          "kind": "text",
-                          "text": ", "
-                        },
-                        {
-                          "kind": "code",
-                          "text": "`subscriptionId`"
-                        },
-                        {
-                          "kind": "text",
-                          "text": ", or both."
-                        }
-                      ]
-                    },
-                    "type": {
-                      "type": "reference",
-                      "target": 100,
-                      "name": "UnsubscribeOptions",
-                      "package": "@wix/realtime-common"
-                    }
-                  }
-                ],
                 "type": {
-                  "type": "intrinsic",
-                  "name": "void"
-                }
-              },
-              {
-                "id": 70,
-                "name": "unsubscribe",
-                "variant": "signature",
-                "kind": 4096,
-                "flags": {},
-                "comment": {
-                  "summary": [
-                    {
-                      "kind": "text",
-                      "text": "Removes 1 or more subscriptions.\n\nYou can unsubscribe in 3 ways:\n- By "
-                    },
-                    {
-                      "kind": "code",
-                      "text": "`subscriptionId`"
-                    },
-                    {
-                      "kind": "text",
-                      "text": ": removes a single subscription.\n- By "
-                    },
-                    {
-                      "kind": "code",
-                      "text": "`channel`"
-                    },
-                    {
-                      "kind": "text",
-                      "text": ": removes all subscriptions to that channel or resource.\n- By both: removes the specific subscription, verifying it matches the channel.\n\nWhen the last subscription on a connection is removed, the connection\ncloses automatically."
-                    }
-                  ],
-                  "blockTags": [
-                    {
-                      "tag": "@example",
-                      "content": [
-                        {
-                          "kind": "text",
-                          "text": "Remove the specified subscription.\n"
-                        },
-                        {
-                          "kind": "code",
-                          "text": "```ts\nimport { subscriber } from '@wix/realtime';\n\nsubscriber.unsubscribe({ subscriptionId });\n```"
-                        }
-                      ]
-                    },
-                    {
-                      "tag": "@example",
-                      "content": [
-                        {
-                          "kind": "text",
-                          "text": "Remove the specified subscription: Self-hosted\n"
-                        },
-                        {
-                          "kind": "code",
-                          "text": "```ts\nimport { subscriber } 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: { subscriber },\n  // Include the auth strategy and host as relevant\n});\n\n// Remove the specified subscription\nclient.subscriber.unsubscribe({ subscriptionId });\n\n// Remove all subscriptions from the specified channel\nclient.subscriber.unsubscribe({ channel: { name: 'my-channel' } });\n```"
-                        }
-                      ]
-                    },
-                    {
-                      "tag": "@requiredField",
-                      "content": [
-                        {
-                          "kind": "text",
-                          "text": "options"
-                        }
-                      ]
-                    }
-                  ]
-                },
-                "parameters": [
-                  {
-                    "id": 71,
-                    "name": "_",
-                    "variant": "param",
-                    "kind": 32768,
-                    "flags": {},
-                    "type": {
-                      "type": "reference",
-                      "target": {
-                        "sourceFileName": "../../node_modules/@wix/sdk-types/build/index.d.ts",
-                        "qualifiedName": "HttpClient"
-                      },
-                      "name": "HttpClient",
-                      "package": "@wix/sdk-types"
-                    }
-                  }
-                ],
-                "type": {
-                  "type": "reference",
-                  "target": {
-                    "sourceFileName": "src/subscriber/subscriber.public.ts",
-                    "qualifiedName": "UnsubscribeSignature"
-                  },
-                  "name": "UnsubscribeSignature",
-                  "package": "@wix/realtime"
-                }
-              }
-            ]
-          }
-        ],
-        "groups": [
-          {
-            "title": "Functions",
-            "children": [
-              60,
-              67
-            ]
-          }
-        ]
-      },
-      {
-        "id": 117,
-        "name": "RealtimeErrorCode",
-        "variant": "declaration",
-        "kind": 8,
-        "flags": {},
-        "comment": {
-          "summary": [
-            {
-              "kind": "text",
-              "text": "Error codes."
-            }
-          ]
-        },
-        "children": [
-          {
-            "id": 121,
-            "name": "BadInput",
-            "variant": "declaration",
-            "kind": 16,
-            "flags": {},
-            "comment": {
-              "summary": [
-                {
-                  "kind": "text",
-                  "text": "Invalid input such as a channel name with unsupported characters."
-                }
-              ]
-            },
-            "type": {
-              "type": "literal",
-              "value": "BAD_INPUT"
-            }
-          },
-          {
-            "id": 119,
-            "name": "ConnectionError",
-            "variant": "declaration",
-            "kind": 16,
-            "flags": {},
-            "comment": {
-              "summary": [
-                {
-                  "kind": "text",
-                  "text": "Connection attempt failed. Wix automatically attempts to establish the subscription."
-                }
-              ]
-            },
-            "type": {
-              "type": "literal",
-              "value": "CONNECTION_ERROR"
-            }
-          },
-          {
-            "id": 118,
-            "name": "Disconnected",
-            "variant": "declaration",
-            "kind": 16,
-            "flags": {},
-            "comment": {
-              "summary": [
-                {
-                  "kind": "text",
-                  "text": "Connection closed intentionally or due to an error. Check "
-                },
-                {
-                  "kind": "code",
-                  "text": "`error.recoverable`"
-                },
-                {
-                  "kind": "text",
-                  "text": " to determine whether the client is attempting to reconnect."
-                }
-              ]
-            },
-            "type": {
-              "type": "literal",
-              "value": "DISCONNECTED"
-            }
-          },
-          {
-            "id": 120,
-            "name": "SubscriptionFailed",
-            "variant": "declaration",
-            "kind": 16,
-            "flags": {},
-            "comment": {
-              "summary": [
-                {
-                  "kind": "text",
-                  "text": "Subscription request rejected, for example, due to an authorization failure. This error is non-recoverable."
-                }
-              ]
-            },
-            "type": {
-              "type": "literal",
-              "value": "SUBSCRIPTION_FAILED"
-            }
-          }
-        ],
-        "groups": [
-          {
-            "title": "Enumeration Members",
-            "children": [
-              121,
-              119,
-              118,
-              120
-            ]
-          }
-        ]
-      },
-      {
-        "id": 103,
-        "name": "RealtimeError",
-        "variant": "declaration",
-        "kind": 128,
-        "flags": {},
-        "comment": {
-          "summary": [
-            {
-              "kind": "text",
-              "text": "Error thrown by a subscription or connection."
-            }
-          ]
-        },
-        "children": [
-          {
-            "id": 104,
-            "name": "constructor",
-            "variant": "declaration",
-            "kind": 512,
-            "flags": {},
-            "signatures": [
-              {
-                "id": 105,
-                "name": "new RealtimeError",
-                "variant": "signature",
-                "kind": 16384,
-                "flags": {},
-                "parameters": [
-                  {
-                    "id": 106,
-                    "name": "errorCode",
-                    "variant": "param",
-                    "kind": 32768,
-                    "flags": {},
-                    "type": {
-                      "type": "reference",
-                      "target": 117,
-                      "name": "RealtimeErrorCode",
-                      "package": "@wix/realtime-common"
-                    }
-                  },
-                  {
-                    "id": 107,
-                    "name": "message",
-                    "variant": "param",
-                    "kind": 32768,
-                    "flags": {},
-                    "type": {
-                      "type": "intrinsic",
-                      "name": "string"
-                    }
-                  },
-                  {
-                    "id": 108,
-                    "name": "options",
-                    "variant": "param",
-                    "kind": 32768,
-                    "flags": {
-                      "isOptional": true
-                    },
-                    "type": {
-                      "type": "reflection",
-                      "declaration": {
-                        "id": 109,
-                        "name": "__type",
-                        "variant": "declaration",
-                        "kind": 65536,
-                        "flags": {},
-                        "children": [
-                          {
-                            "id": 110,
-                            "name": "channel",
-                            "variant": "declaration",
-                            "kind": 1024,
-                            "flags": {
-                              "isOptional": true
-                            },
-                            "type": {
-                              "type": "reference",
-                              "target": 73,
-                              "name": "SubscribeChannel",
-                              "package": "@wix/realtime-common"
-                            }
-                          },
-                          {
-                            "id": 111,
-                            "name": "recoverable",
-                            "variant": "declaration",
-                            "kind": 1024,
-                            "flags": {
-                              "isOptional": true
-                            },
-                            "type": {
-                              "type": "intrinsic",
-                              "name": "boolean"
-                            }
-                          },
-                          {
-                            "id": 112,
-                            "name": "status",
-                            "variant": "declaration",
-                            "kind": 1024,
-                            "flags": {
-                              "isOptional": true
-                            },
-                            "type": {
-                              "type": "intrinsic",
-                              "name": "number"
-                            }
-                          }
-                        ],
-                        "groups": [
-                          {
-                            "title": "Properties",
-                            "children": [
-                              110,
-                              111,
-                              112
-                            ]
-                          }
-                        ]
-                      }
-                    }
-                  }
-                ],
-                "type": {
-                  "type": "reference",
-                  "target": 103,
-                  "name": "RealtimeError",
-                  "package": "@wix/realtime-common"
-                },
-                "overwrites": {
-                  "type": "reference",
-                  "target": -1,
-                  "name": "Error.constructor"
-                }
-              }
-            ],
-            "overwrites": {
-              "type": "reference",
-              "target": -1,
-              "name": "Error.constructor"
-            }
-          },
-          {
-            "id": 114,
-            "name": "channel",
-            "variant": "declaration",
-            "kind": 1024,
-            "flags": {
-              "isOptional": true
-            },
-            "comment": {
-              "summary": [
-                {
-                  "kind": "text",
-                  "text": "Channel that caused the error."
-                }
-              ]
-            },
-            "type": {
-              "type": "reference",
-              "target": 73,
-              "name": "SubscribeChannel",
-              "package": "@wix/realtime-common"
-            }
-          },
-          {
-            "id": 113,
-            "name": "errorCode",
-            "variant": "declaration",
-            "kind": 1024,
-            "flags": {},
-            "comment": {
-              "summary": [
-                {
-                  "kind": "text",
-                  "text": "Error code."
-                }
-              ]
-            },
-            "type": {
-              "type": "reference",
-              "target": 117,
-              "name": "RealtimeErrorCode",
-              "package": "@wix/realtime-common"
-            }
-          },
-          {
-            "id": 115,
-            "name": "recoverable",
-            "variant": "declaration",
-            "kind": 1024,
-            "flags": {
-              "isOptional": true
-            },
-            "comment": {
-              "summary": [
-                {
-                  "kind": "text",
-                  "text": "Whether the error is automatically recoverable.\n\nWhen "
-                },
-                {
-                  "kind": "code",
-                  "text": "`true`"
-                },
-                {
-                  "kind": "text",
-                  "text": ", the client automatically attempts to reconnect. When "
-                },
-                {
-                  "kind": "code",
-                  "text": "`false`"
-                },
-                {
-                  "kind": "text",
-                  "text": ", you must attempt to re-subscribe manually.\n\nDefault: "
-                },
-                {
-                  "kind": "code",
-                  "text": "`false`"
-                },
-                {
-                  "kind": "text",
-                  "text": "."
-                }
-              ]
-            },
-            "type": {
-              "type": "intrinsic",
-              "name": "boolean"
-            }
-          },
-          {
-            "id": 116,
-            "name": "status",
-            "variant": "declaration",
-            "kind": 1024,
-            "flags": {
-              "isOptional": true
-            },
-            "comment": {
-              "summary": [
-                {
-                  "kind": "text",
-                  "text": "[HTTP status code](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/troubleshooting/about-errors#http-status-codes).\n\nReturned only when "
-                },
-                {
-                  "kind": "code",
-                  "text": "`errorCode`"
-                },
-                {
-                  "kind": "text",
-                  "text": " is "
+                  "type": "intrinsic",
+                  "name": "boolean"
+                }
+              },
+              {
+                "id": 106,
+                "name": "status",
+                "variant": "declaration",
+                "kind": 1024,
+                "flags": {
+                  "isOptional": true
                 },
-                {
-                  "kind": "code",
-                  "text": "`SUBSCRIPTION_FAILED`"
+                "comment": {
+                  "summary": [
+                    {
+                      "kind": "text",
+                      "text": "[HTTP status code](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/troubleshooting/about-errors#http-status-codes).\n\nReturned only when "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`errorCode`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": " is "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`SUBSCRIPTION_FAILED`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": "."
+                    }
+                  ]
                 },
-                {
-                  "kind": "text",
-                  "text": "."
+                "type": {
+                  "type": "intrinsic",
+                  "name": "number"
                 }
-              ]
-            },
-            "type": {
-              "type": "intrinsic",
-              "name": "number"
-            }
-          }
-        ],
-        "groups": [
-          {
-            "title": "Constructors",
-            "children": [
-              104
+              }
+            ],
+            "groups": [
+              {
+                "title": "Constructors",
+                "children": [
+                  94
+                ]
+              },
+              {
+                "title": "Properties",
+                "children": [
+                  104,
+                  103,
+                  105,
+                  106
+                ]
+              }
+            ],
+            "extendedTypes": [
+              {
+                "type": "reference",
+                "target": {
+                  "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
+                  "qualifiedName": "Error"
+                },
+                "name": "Error",
+                "package": "typescript"
+              }
             ]
           },
           {
-            "title": "Properties",
-            "children": [
-              114,
-              113,
-              115,
-              116
-            ]
-          }
-        ],
-        "extendedTypes": [
-          {
-            "type": "reference",
-            "target": {
-              "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
-              "qualifiedName": "Error"
-            },
-            "name": "Error",
-            "package": "typescript"
-          }
-        ]
-      },
-      {
-        "id": 77,
-        "name": "Message",
-        "variant": "declaration",
-        "kind": 256,
-        "flags": {},
-        "comment": {
-          "summary": [
-            {
-              "kind": "text",
-              "text": "Message received on a channel."
-            }
-          ]
-        },
-        "children": [
-          {
-            "id": 78,
-            "name": "payload",
+            "id": 67,
+            "name": "Message",
             "variant": "declaration",
-            "kind": 1024,
+            "kind": 256,
             "flags": {},
             "comment": {
               "summary": [
                 {
                   "kind": "text",
-                  "text": "Message payload that contains the published data.\n\nMax: 10 KB."
+                  "text": "Message received on a channel."
                 }
               ]
             },
-            "type": {
-              "type": "reference",
-              "target": {
-                "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
-                "qualifiedName": "Record"
+            "children": [
+              {
+                "id": 68,
+                "name": "payload",
+                "variant": "declaration",
+                "kind": 1024,
+                "flags": {},
+                "comment": {
+                  "summary": [
+                    {
+                      "kind": "text",
+                      "text": "Message payload that contains the published data.\n\nMax: 10 KB."
+                    }
+                  ]
+                },
+                "type": {
+                  "type": "reference",
+                  "target": {
+                    "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
+                    "qualifiedName": "Record"
+                  },
+                  "typeArguments": [
+                    {
+                      "type": "intrinsic",
+                      "name": "string"
+                    },
+                    {
+                      "type": "intrinsic",
+                      "name": "any"
+                    }
+                  ],
+                  "name": "Record",
+                  "package": "typescript"
+                }
               },
-              "typeArguments": [
-                {
-                  "type": "intrinsic",
-                  "name": "string"
+              {
+                "id": 69,
+                "name": "publisher",
+                "variant": "declaration",
+                "kind": 1024,
+                "flags": {
+                  "isOptional": true
                 },
-                {
-                  "type": "intrinsic",
-                  "name": "any"
+                "comment": {
+                  "summary": [
+                    {
+                      "kind": "text",
+                      "text": "Publisher details.\n\nReturned only when the publisher's identity is available."
+                    }
+                  ]
+                },
+                "type": {
+                  "type": "reference",
+                  "target": 75,
+                  "name": "Publisher",
+                  "package": "@wix/realtime-common"
                 }
-              ],
-              "name": "Record",
-              "package": "typescript"
-            }
+              }
+            ],
+            "groups": [
+              {
+                "title": "Properties",
+                "children": [
+                  68,
+                  69
+                ]
+              }
+            ]
           },
           {
-            "id": 79,
-            "name": "publisher",
+            "id": 75,
+            "name": "Publisher",
             "variant": "declaration",
-            "kind": 1024,
-            "flags": {
-              "isOptional": true
-            },
+            "kind": 256,
+            "flags": {},
             "comment": {
               "summary": [
                 {
                   "kind": "text",
-                  "text": "Publisher details.\n\nReturned only when the publisher's identity is available."
+                  "text": "Publisher details."
                 }
               ]
             },
-            "type": {
-              "type": "reference",
-              "target": 85,
-              "name": "Publisher",
-              "package": "@wix/realtime-common"
-            }
-          }
-        ],
-        "groups": [
-          {
-            "title": "Properties",
             "children": [
-              78,
-              79
+              {
+                "id": 76,
+                "name": "id",
+                "variant": "declaration",
+                "kind": 1024,
+                "flags": {},
+                "comment": {
+                  "summary": [
+                    {
+                      "kind": "text",
+                      "text": "Publisher ID."
+                    }
+                  ]
+                },
+                "type": {
+                  "type": "intrinsic",
+                  "name": "string"
+                }
+              }
+            ],
+            "groups": [
+              {
+                "title": "Properties",
+                "children": [
+                  76
+                ]
+              }
             ]
-          }
-        ]
-      },
-      {
-        "id": 85,
-        "name": "Publisher",
-        "variant": "declaration",
-        "kind": 256,
-        "flags": {},
-        "comment": {
-          "summary": [
-            {
-              "kind": "text",
-              "text": "Publisher details."
-            }
-          ]
-        },
-        "children": [
+          },
           {
-            "id": 86,
-            "name": "id",
+            "id": 63,
+            "name": "SubscribeChannel",
             "variant": "declaration",
-            "kind": 1024,
+            "kind": 256,
             "flags": {},
             "comment": {
               "summary": [
                 {
                   "kind": "text",
-                  "text": "Publisher ID."
+                  "text": "Realtime broadcast subscribed channel. Subscribers listen to messages published to channels."
                 }
               ]
             },
-            "type": {
-              "type": "intrinsic",
-              "name": "string"
-            }
-          }
-        ],
-        "groups": [
-          {
-            "title": "Properties",
             "children": [
-              86
-            ]
-          }
-        ]
-      },
-      {
-        "id": 73,
-        "name": "SubscribeChannel",
-        "variant": "declaration",
-        "kind": 256,
-        "flags": {},
-        "comment": {
-          "summary": [
-            {
-              "kind": "text",
-              "text": "Realtime broadcast subscribed channel. Subscribers listen to messages published to channels."
-            }
-          ]
-        },
-        "children": [
-          {
-            "id": 74,
-            "name": "appId",
-            "variant": "declaration",
-            "kind": 1024,
-            "flags": {
-              "isOptional": true
-            },
-            "comment": {
-              "summary": [
-                {
-                  "kind": "text",
-                  "text": "App ID of the channel owner.\n\nSet this to subscribe to a channel owned by a different app (cross-app subscription). When omitted, the channel is assumed to be owned by the caller's app.\n\nThe channel owner must implement the "
-                },
-                {
-                  "kind": "code",
-                  "text": "`REALTIME_PERMISSIONS_PROVIDER`"
-                },
-                {
-                  "kind": "text",
-                  "text": " SPI to authorize cross-app subscriptions; otherwise the subscription is denied.\n\nUse "
-                },
-                {
-                  "kind": "code",
-                  "text": "`WIX_APPS`"
+              {
+                "id": 66,
+                "name": "appId",
+                "variant": "declaration",
+                "kind": 1024,
+                "flags": {
+                  "isOptional": true
                 },
-                {
-                  "kind": "text",
-                  "text": " from "
+                "comment": {
+                  "summary": [
+                    {
+                      "kind": "text",
+                      "text": "ID of the app that manages the channel you want to subscribe to.\n\nTo subscribe to a channel managed by another Wix app installed on the site, specify that app's ID. When empty, you subscribe to channels managed by the current app or by the site's backend code.\n\nLearn more about [cross-app subscriptions](https://dev.wix.com/docs/sdk/core-modules/realtime/realtime/introduction#cross-app-subscriptions).\n\n> **Note**: The app that manages the channel must implement the [Realtime Permissions Provider](https://dev.wix.com/docs/sdk/core-modules/realtime/extensions/realtime-permissions-provider/introduction) service plugin to authorize cross-app subscriptions."
+                    }
+                  ]
                 },
-                {
-                  "kind": "code",
-                  "text": "`@wix/essentials`"
+                "type": {
+                  "type": "intrinsic",
+                  "name": "string"
+                }
+              },
+              {
+                "id": 64,
+                "name": "name",
+                "variant": "declaration",
+                "kind": 1024,
+                "flags": {},
+                "comment": {
+                  "summary": [
+                    {
+                      "kind": "text",
+                      "text": "Channel name.\n\n> **Notes:**\n> - Supports only alphanumeric characters, hyphens, and underscores.\n> - The combined length of "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`name`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": " and "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`resourceId`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": " can't exceed 140 characters."
+                    }
+                  ]
                 },
-                {
-                  "kind": "text",
-                  "text": " to reference well-known Wix app IDs."
+                "type": {
+                  "type": "intrinsic",
+                  "name": "string"
                 }
-              ]
-            },
-            "type": {
-              "type": "intrinsic",
-              "name": "string"
-            }
-          },
-          {
-            "id": 75,
-            "name": "name",
-            "variant": "declaration",
-            "kind": 1024,
-            "flags": {},
-            "comment": {
-              "summary": [
-                {
-                  "kind": "text",
-                  "text": "Channel name.\n\n> **Notes:**\n> - Supports only alphanumeric characters, hyphens, and underscores.\n> - The combined length of "
-                },
-                {
-                  "kind": "code",
-                  "text": "`name`"
-                },
-                {
-                  "kind": "text",
-                  "text": " and "
+              },
+              {
+                "id": 65,
+                "name": "resourceId",
+                "variant": "declaration",
+                "kind": 1024,
+                "flags": {
+                  "isOptional": true
                 },
-                {
-                  "kind": "code",
-                  "text": "`resourceId`"
+                "comment": {
+                  "summary": [
+                    {
+                      "kind": "text",
+                      "text": "Resource ID.\n\nResources are independent sub-channels in a channel. A subscriber listening to a resource doesn't receive messages published to the parent channel, and vice versa."
+                    }
+                  ]
                 },
-                {
-                  "kind": "text",
-                  "text": " can't exceed 140 characters."
+                "type": {
+                  "type": "intrinsic",
+                  "name": "string"
                 }
-              ]
-            },
-            "type": {
-              "type": "intrinsic",
-              "name": "string"
-            },
-            "inheritedFrom": {
-              "type": "reference",
-              "target": -1,
-              "name": "PublishChannel.name"
-            }
+              }
+            ],
+            "groups": [
+              {
+                "title": "Properties",
+                "children": [
+                  66,
+                  64,
+                  65
+                ]
+              }
+            ]
           },
           {
-            "id": 76,
-            "name": "resourceId",
+            "id": 87,
+            "name": "SubscriptionOptions",
             "variant": "declaration",
-            "kind": 1024,
-            "flags": {
-              "isOptional": true
-            },
+            "kind": 256,
+            "flags": {},
             "comment": {
               "summary": [
                 {
                   "kind": "text",
-                  "text": "Resource ID.\n\nResources are independent sub-channels in a channel. A subscriber listening to a resource doesn't receive messages published to the parent channel, and vice versa."
+                  "text": "Subscription status handlers that run whenever a subscription is established, re-established, or fails."
                 }
               ]
             },
-            "type": {
-              "type": "intrinsic",
-              "name": "string"
-            },
-            "inheritedFrom": {
-              "type": "reference",
-              "target": -1,
-              "name": "PublishChannel.resourceId"
-            }
-          }
-        ],
-        "groups": [
-          {
-            "title": "Properties",
             "children": [
-              74,
-              75,
-              76
-            ]
-          }
-        ],
-        "extendedTypes": [
-          {
-            "type": "reference",
-            "target": 72,
-            "name": "PublishChannel",
-            "package": "@wix/realtime-common"
-          }
-        ]
-      },
-      {
-        "id": 97,
-        "name": "SubscriptionOptions",
-        "variant": "declaration",
-        "kind": 256,
-        "flags": {},
-        "comment": {
-          "summary": [
-            {
-              "kind": "text",
-              "text": "Subscription status handlers that run whenever a subscription is established, re-established, or fails."
-            }
-          ]
-        },
-        "children": [
-          {
-            "id": 98,
-            "name": "onSubscribed",
-            "variant": "declaration",
-            "kind": 1024,
-            "flags": {
-              "isOptional": true
-            },
-            "comment": {
-              "summary": [
-                {
-                  "kind": "text",
-                  "text": "Runs whenever the subscription is successfully established or re-established after a prior failure. To avoid unnecessary actions, make the handler idempotent.\n\nThe "
-                },
-                {
-                  "kind": "code",
-                  "text": "`isSynced`"
+              {
+                "id": 88,
+                "name": "onSubscribed",
+                "variant": "declaration",
+                "kind": 1024,
+                "flags": {
+                  "isOptional": true
                 },
-                {
-                  "kind": "text",
-                  "text": " parameter indicates whether missed messages were restored."
-                }
-              ],
-              "blockTags": [
-                {
-                  "tag": "@param",
-                  "name": "subscriptionId",
-                  "content": [
+                "comment": {
+                  "summary": [
+                    {
+                      "kind": "text",
+                      "text": "Runs whenever the subscription is successfully established or re-established after a prior failure. To avoid unnecessary actions, make the handler idempotent.\n\nThe "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`isSynced`"
+                    },
                     {
                       "kind": "text",
-                      "text": "ID of the subscription."
+                      "text": " parameter indicates whether missed messages were restored."
+                    }
+                  ],
+                  "blockTags": [
+                    {
+                      "tag": "@param",
+                      "name": "subscriptionId",
+                      "content": [
+                        {
+                          "kind": "text",
+                          "text": "ID of the subscription."
+                        }
+                      ]
+                    },
+                    {
+                      "tag": "@param",
+                      "name": "isSynced",
+                      "content": [
+                        {
+                          "kind": "text",
+                          "text": "Whether the server successfully restored missed messages since the last disconnection.\n\nThe value of this parameter depends on the scenario:\n\n- When subscribing for the first time, "
+                        },
+                        {
+                          "kind": "code",
+                          "text": "`isSynced`"
+                        },
+                        {
+                          "kind": "text",
+                          "text": " is "
+                        },
+                        {
+                          "kind": "code",
+                          "text": "`false`"
+                        },
+                        {
+                          "kind": "text",
+                          "text": ", as there are no prior messages to restore. In this scenario, load your initial state independently.\n\n- When re-subscribing and all messages were successfully restored, "
+                        },
+                        {
+                          "kind": "code",
+                          "text": "`isSynced`"
+                        },
+                        {
+                          "kind": "text",
+                          "text": " is "
+                        },
+                        {
+                          "kind": "code",
+                          "text": "`true`"
+                        },
+                        {
+                          "kind": "text",
+                          "text": ". No further action is necessary.\n\n- When re-subscribing but some messages weren't restored, "
+                        },
+                        {
+                          "kind": "code",
+                          "text": "`isSynced`"
+                        },
+                        {
+                          "kind": "text",
+                          "text": " is "
+                        },
+                        {
+                          "kind": "code",
+                          "text": "`false`"
+                        },
+                        {
+                          "kind": "text",
+                          "text": ". The server is unable to restore all missed messages. In this scenario, you need to resync your state independently.\n\n<!-- TODO: Document server-side buffer limits for message replay. -->"
+                        }
+                      ]
                     }
                   ]
                 },
-                {
-                  "tag": "@param",
-                  "name": "isSynced",
-                  "content": [
+                "type": {
+                  "type": "reference",
+                  "target": 77,
+                  "name": "SubscriptionHandler",
+                  "package": "@wix/realtime-common"
+                }
+              },
+              {
+                "id": 89,
+                "name": "onSubscriptionError",
+                "variant": "declaration",
+                "kind": 1024,
+                "flags": {
+                  "isOptional": true
+                },
+                "comment": {
+                  "summary": [
                     {
                       "kind": "text",
-                      "text": "Whether the server successfully restored missed messages since the last disconnection.\n\nThe value of this parameter depends on the scenario:\n\n- When subscribing for the first time, "
+                      "text": "Runs when a subscription error occurs. It can run multiple times in a single session.\n\nThis handler runs in the following scenarios:\n\n- **Subscription failed**: The subscription request was rejected, for example, due to an authorization failure. This error is non-recoverable, so the subscription isn't automatically re-attempted.\n\n- **Subscription disconnected**: The connection between the subscriber and publisher was closed. Check "
                     },
                     {
                       "kind": "code",
-                      "text": "`isSynced`"
+                      "text": "`error.recoverable`"
                     },
                     {
                       "kind": "text",
-                      "text": " is "
+                      "text": ":\n   - When "
                     },
                     {
                       "kind": "code",
-                      "text": "`false`"
+                      "text": "`true`"
                     },
                     {
                       "kind": "text",
-                      "text": ", as there are no prior messages to restore. In this scenario, load your initial state independently.\n\n- When re-subscribing and all messages were successfully restored, "
+                      "text": ", the error is recoverable. The subscription is automatically re-attempted. No further action necessary.\n   - When "
                     },
                     {
                       "kind": "code",
-                      "text": "`isSynced`"
+                      "text": "`false`"
                     },
                     {
                       "kind": "text",
-                      "text": " is "
+                      "text": ", the error isn't recoverable. Establish the subscription again.\n\n- **Connection error**: Runs on each failed subscription attempt. The "
                     },
                     {
                       "kind": "code",
-                      "text": "`true`"
+                      "text": "`error.recoverable`"
                     },
                     {
                       "kind": "text",
-                      "text": ". No further action is necessary.\n\n- When re-subscribing but some messages weren't restored, "
+                      "text": " flag is always "
                     },
                     {
                       "kind": "code",
-                      "text": "`isSynced`"
+                      "text": "`true`"
                     },
                     {
                       "kind": "text",
-                      "text": " is "
-                    },
+                      "text": ", as the subscription is re-established."
+                    }
+                  ],
+                  "blockTags": [
                     {
-                      "kind": "code",
-                      "text": "`false`"
+                      "tag": "@param",
+                      "name": "error",
+                      "content": [
+                        {
+                          "kind": "text",
+                          "text": "Error that occurred. Check "
+                        },
+                        {
+                          "kind": "code",
+                          "text": "`errorCode`"
+                        },
+                        {
+                          "kind": "text",
+                          "text": " and "
+                        },
+                        {
+                          "kind": "code",
+                          "text": "`recoverable`"
+                        },
+                        {
+                          "kind": "text",
+                          "text": " to determine the type and whether manual action is required."
+                        }
+                      ]
                     },
                     {
-                      "kind": "text",
-                      "text": ". The server is unable to restore all missed messages. In this scenario, you need to resync your state independently.\n\n<!-- TODO: Document server-side buffer limits for message replay. -->"
+                      "tag": "@param",
+                      "name": "subscriptionId",
+                      "content": [
+                        {
+                          "kind": "text",
+                          "text": "ID of the subscription that generated the error."
+                        }
+                      ]
                     }
                   ]
+                },
+                "type": {
+                  "type": "reference",
+                  "target": 82,
+                  "name": "SubscriptionErrorHandler",
+                  "package": "@wix/realtime-common"
                 }
-              ]
-            },
-            "type": {
-              "type": "reference",
-              "target": 92,
-              "name": "SubscriptionHandler",
-              "package": "@wix/realtime-common"
-            }
+              }
+            ],
+            "groups": [
+              {
+                "title": "Properties",
+                "children": [
+                  88,
+                  89
+                ]
+              }
+            ]
           },
           {
-            "id": 99,
-            "name": "onSubscriptionError",
+            "id": 90,
+            "name": "UnsubscribeOptions",
             "variant": "declaration",
-            "kind": 1024,
-            "flags": {
-              "isOptional": true
-            },
+            "kind": 256,
+            "flags": {},
             "comment": {
               "summary": [
                 {
                   "kind": "text",
-                  "text": "Runs when a subscription error occurs. It can run multiple times in a single session.\n\nThis handler runs in the following scenarios:\n\n- **Subscription failed**: The subscription request was rejected, for example, due to an authorization failure. This error is non-recoverable, so the subscription isn't automatically re-attempted.\n\n- **Subscription disconnected**: The connection between the subscriber and publisher was closed. Check "
-                },
-                {
-                  "kind": "code",
-                  "text": "`error.recoverable`"
-                },
-                {
-                  "kind": "text",
-                  "text": ":\n   - When "
+                  "text": "Unsubscribe options. Specify "
                 },
                 {
                   "kind": "code",
-                  "text": "`true`"
+                  "text": "`channel`"
                 },
                 {
                   "kind": "text",
-                  "text": ", the error is recoverable. The subscription is automatically re-attempted. No further action necessary.\n   - When "
+                  "text": ", "
                 },
                 {
                   "kind": "code",
-                  "text": "`false`"
+                  "text": "`subscriptionId`"
                 },
                 {
                   "kind": "text",
-                  "text": ", the error isn't recoverable. Establish the subscription again.\n\n- **Connection error**: Runs on each failed subscription attempt. The "
+                  "text": ", or both:\n\n- To remove all subscriptions from a channel, specify the channel in "
                 },
                 {
                   "kind": "code",
-                  "text": "`error.recoverable`"
+                  "text": "`channel.name`"
                 },
                 {
                   "kind": "text",
-                  "text": " flag is always "
+                  "text": ".\n- To remove a single subscription, specify the "
                 },
                 {
                   "kind": "code",
-                  "text": "`true`"
+                  "text": "`subscriptionId`"
                 },
                 {
                   "kind": "text",
-                  "text": ", as the subscription is re-established."
+                  "text": ".\n- To remove a single subscription with channel verification, specify both. This removes the specified subscription only if it listens to the specified channel."
                 }
-              ],
-              "blockTags": [
-                {
-                  "tag": "@param",
-                  "name": "error",
-                  "content": [
-                    {
-                      "kind": "text",
-                      "text": "Error that occurred. Check "
-                    },
-                    {
-                      "kind": "code",
-                      "text": "`errorCode`"
-                    },
-                    {
-                      "kind": "text",
-                      "text": " and "
-                    },
-                    {
-                      "kind": "code",
-                      "text": "`recoverable`"
-                    },
+              ]
+            },
+            "children": [
+              {
+                "id": 91,
+                "name": "channel",
+                "variant": "declaration",
+                "kind": 1024,
+                "flags": {
+                  "isOptional": true
+                },
+                "comment": {
+                  "summary": [
                     {
                       "kind": "text",
-                      "text": " to determine the type and whether manual action is required."
+                      "text": "Channel or resource to unsubscribe from.\n\nWhen empty, the subscription is removed without verifying that it belongs to the channel."
                     }
                   ]
                 },
-                {
-                  "tag": "@param",
-                  "name": "subscriptionId",
-                  "content": [
+                "type": {
+                  "type": "reference",
+                  "target": 63,
+                  "name": "SubscribeChannel",
+                  "package": "@wix/realtime-common"
+                }
+              },
+              {
+                "id": 92,
+                "name": "subscriptionId",
+                "variant": "declaration",
+                "kind": 1024,
+                "flags": {
+                  "isOptional": true
+                },
+                "comment": {
+                  "summary": [
                     {
                       "kind": "text",
-                      "text": "ID of the subscription that generated the error."
+                      "text": "ID of the subscription to remove.\n\nWhen empty, all subscriptions to the specified channel are removed."
                     }
                   ]
+                },
+                "type": {
+                  "type": "intrinsic",
+                  "name": "string"
                 }
-              ]
-            },
+              }
+            ],
+            "groups": [
+              {
+                "title": "Properties",
+                "children": [
+                  91,
+                  92
+                ]
+              }
+            ]
+          },
+          {
+            "id": 70,
+            "name": "MessageHandler",
+            "variant": "declaration",
+            "kind": 4194304,
+            "flags": {},
             "type": {
-              "type": "reference",
-              "target": 87,
-              "name": "SubscriptionErrorHandler",
-              "package": "@wix/realtime-common"
+              "type": "reflection",
+              "declaration": {
+                "id": 71,
+                "name": "__type",
+                "variant": "declaration",
+                "kind": 65536,
+                "flags": {},
+                "signatures": [
+                  {
+                    "id": 72,
+                    "name": "__type",
+                    "variant": "signature",
+                    "kind": 4096,
+                    "flags": {},
+                    "comment": {
+                      "summary": [
+                        {
+                          "kind": "text",
+                          "text": "Runs when a message is published to a channel or resource the subscriber listens to."
+                        }
+                      ]
+                    },
+                    "parameters": [
+                      {
+                        "id": 73,
+                        "name": "message",
+                        "variant": "param",
+                        "kind": 32768,
+                        "flags": {},
+                        "comment": {
+                          "summary": [
+                            {
+                              "kind": "text",
+                              "text": "Published message."
+                            }
+                          ]
+                        },
+                        "type": {
+                          "type": "reference",
+                          "target": 67,
+                          "name": "Message",
+                          "package": "@wix/realtime-common"
+                        }
+                      },
+                      {
+                        "id": 74,
+                        "name": "channel",
+                        "variant": "param",
+                        "kind": 32768,
+                        "flags": {},
+                        "comment": {
+                          "summary": [
+                            {
+                              "kind": "text",
+                              "text": "Channel the message was published to."
+                            }
+                          ]
+                        },
+                        "type": {
+                          "type": "reference",
+                          "target": 63,
+                          "name": "SubscribeChannel",
+                          "package": "@wix/realtime-common"
+                        }
+                      }
+                    ],
+                    "type": {
+                      "type": "intrinsic",
+                      "name": "void"
+                    }
+                  }
+                ]
+              }
             }
-          }
-        ],
-        "groups": [
+          },
           {
-            "title": "Properties",
-            "children": [
-              98,
-              99
-            ]
-          }
-        ]
-      },
-      {
-        "id": 100,
-        "name": "UnsubscribeOptions",
-        "variant": "declaration",
-        "kind": 256,
-        "flags": {},
-        "comment": {
-          "summary": [
-            {
-              "kind": "text",
-              "text": "Unsubscribe options. Specify "
-            },
-            {
-              "kind": "code",
-              "text": "`channel`"
-            },
-            {
-              "kind": "text",
-              "text": ", "
-            },
-            {
-              "kind": "code",
-              "text": "`subscriptionId`"
-            },
-            {
-              "kind": "text",
-              "text": ", or both:\n\n- To remove all subscriptions from a channel, specify the channel in "
-            },
-            {
-              "kind": "code",
-              "text": "`channel.name`"
-            },
-            {
-              "kind": "text",
-              "text": ".\n- To remove a single subscription, specify the "
-            },
-            {
-              "kind": "code",
-              "text": "`subscriptionId`"
-            },
-            {
-              "kind": "text",
-              "text": ".\n- To remove a single subscription with channel verification, specify both. This removes the specified subscription only if it listens to the specified channel."
+            "id": 82,
+            "name": "SubscriptionErrorHandler",
+            "variant": "declaration",
+            "kind": 4194304,
+            "flags": {},
+            "type": {
+              "type": "reflection",
+              "declaration": {
+                "id": 83,
+                "name": "__type",
+                "variant": "declaration",
+                "kind": 65536,
+                "flags": {},
+                "signatures": [
+                  {
+                    "id": 84,
+                    "name": "__type",
+                    "variant": "signature",
+                    "kind": 4096,
+                    "flags": {},
+                    "comment": {
+                      "summary": [
+                        {
+                          "kind": "text",
+                          "text": "Runs when a subscription error occurs."
+                        }
+                      ]
+                    },
+                    "parameters": [
+                      {
+                        "id": 85,
+                        "name": "error",
+                        "variant": "param",
+                        "kind": 32768,
+                        "flags": {},
+                        "comment": {
+                          "summary": [
+                            {
+                              "kind": "text",
+                              "text": "Error that occurred."
+                            }
+                          ]
+                        },
+                        "type": {
+                          "type": "reference",
+                          "target": 93,
+                          "name": "RealtimeError",
+                          "package": "@wix/realtime-common"
+                        }
+                      },
+                      {
+                        "id": 86,
+                        "name": "subscriptionId",
+                        "variant": "param",
+                        "kind": 32768,
+                        "flags": {},
+                        "comment": {
+                          "summary": [
+                            {
+                              "kind": "text",
+                              "text": "ID of the subscription that generated the error."
+                            }
+                          ]
+                        },
+                        "type": {
+                          "type": "intrinsic",
+                          "name": "string"
+                        }
+                      }
+                    ],
+                    "type": {
+                      "type": "intrinsic",
+                      "name": "void"
+                    }
+                  }
+                ]
+              }
             }
-          ]
-        },
-        "children": [
+          },
           {
-            "id": 101,
-            "name": "channel",
+            "id": 77,
+            "name": "SubscriptionHandler",
             "variant": "declaration",
-            "kind": 1024,
-            "flags": {
-              "isOptional": true
-            },
-            "comment": {
-              "summary": [
-                {
-                  "kind": "text",
-                  "text": "Channel or resource to unsubscribe from.\n\nWhen empty, the subscription is removed without verifying that it belongs to the channel."
-                }
-              ]
-            },
+            "kind": 4194304,
+            "flags": {},
             "type": {
-              "type": "reference",
-              "target": 73,
-              "name": "SubscribeChannel",
-              "package": "@wix/realtime-common"
+              "type": "reflection",
+              "declaration": {
+                "id": 78,
+                "name": "__type",
+                "variant": "declaration",
+                "kind": 65536,
+                "flags": {},
+                "signatures": [
+                  {
+                    "id": 79,
+                    "name": "__type",
+                    "variant": "signature",
+                    "kind": 4096,
+                    "flags": {},
+                    "comment": {
+                      "summary": [
+                        {
+                          "kind": "text",
+                          "text": "Runs when a subscription is successfully established or re-established.\n\nWhen a subscription fails and is re-established, the subscriber might not receive all messages published during the failure. The "
+                        },
+                        {
+                          "kind": "code",
+                          "text": "`isSynced`"
+                        },
+                        {
+                          "kind": "text",
+                          "text": " flag indicates whether all missed messages were successfully delivered.\n\n<!-- TODO: Document server-side buffer limits for message replay. -->"
+                        }
+                      ]
+                    },
+                    "parameters": [
+                      {
+                        "id": 80,
+                        "name": "subscriptionId",
+                        "variant": "param",
+                        "kind": 32768,
+                        "flags": {},
+                        "comment": {
+                          "summary": [
+                            {
+                              "kind": "text",
+                              "text": "Subscription ID."
+                            }
+                          ]
+                        },
+                        "type": {
+                          "type": "intrinsic",
+                          "name": "string"
+                        }
+                      },
+                      {
+                        "id": 81,
+                        "name": "isSynced",
+                        "variant": "param",
+                        "kind": 32768,
+                        "flags": {},
+                        "comment": {
+                          "summary": [
+                            {
+                              "kind": "text",
+                              "text": "Whether the message history was fully restored."
+                            }
+                          ]
+                        },
+                        "type": {
+                          "type": "intrinsic",
+                          "name": "boolean"
+                        }
+                      }
+                    ],
+                    "type": {
+                      "type": "intrinsic",
+                      "name": "void"
+                    }
+                  }
+                ]
+              }
             }
           },
           {
-            "id": 102,
-            "name": "subscriptionId",
-            "variant": "declaration",
-            "kind": 1024,
-            "flags": {
-              "isOptional": true
-            },
-            "comment": {
-              "summary": [
-                {
-                  "kind": "text",
-                  "text": "ID of the subscription to remove.\n\nWhen empty, all subscriptions to the specified channel are removed."
-                }
-              ]
-            },
-            "type": {
-              "type": "intrinsic",
-              "name": "string"
-            }
-          }
-        ],
-        "groups": [
-          {
-            "title": "Properties",
-            "children": [
-              101,
-              102
-            ]
-          }
-        ]
-      },
-      {
-        "id": 80,
-        "name": "MessageHandler",
-        "variant": "declaration",
-        "kind": 4194304,
-        "flags": {},
-        "type": {
-          "type": "reflection",
-          "declaration": {
-            "id": 81,
-            "name": "__type",
+            "id": 112,
+            "name": "subscribe",
             "variant": "declaration",
-            "kind": 65536,
+            "kind": 64,
             "flags": {},
             "signatures": [
               {
-                "id": 82,
-                "name": "__type",
+                "id": 113,
+                "name": "subscribe",
                 "variant": "signature",
                 "kind": 4096,
                 "flags": {},
@@ -3507,14 +3306,76 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Runs when a message is published to a channel or resource the subscriber listens to."
+                      "text": "Subscribes to a channel or resource.\n\nThe method attempts to establish a subscription to the specified channel or resource. It returns the subscription ID immediately while the subscription is attempted in the background.\n\nUse the "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`options`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": " parameter to register handlers that run whenever the subscription succeeds or generates an error. For some errors, the subscription is re-attempted automatically. The "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`onSubscribed()`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": " handler runs on every successful re-subscription.\n\nLearn more about the [subscription lifecycle](https://dev.wix.com/docs/sdk/core-modules/realtime/realtime/subscriber/introduction#core-modules_realtime_realtime_subscriber_subscription-lifecycle)."
+                    }
+                  ],
+                  "blockTags": [
+                    {
+                      "tag": "@example",
+                      "content": [
+                        {
+                          "kind": "text",
+                          "text": "Subscribe to a channel\n"
+                        },
+                        {
+                          "kind": "code",
+                          "text": "```ts\nimport { subscriber } from '@wix/realtime';\n\nconst subscriptionId = subscriber.subscribe(\n  { name: 'my-channel' },\n  (message, channel) => {\n    console.log('Received:', message.payload);\n  },\n);\n```"
+                        }
+                      ]
+                    },
+                    {
+                      "tag": "@example",
+                      "content": [
+                        {
+                          "kind": "text",
+                          "text": "Subscribe to a channel: Self-hosted\n"
+                        },
+                        {
+                          "kind": "code",
+                          "text": "```ts\nimport { createClient } from '@wix/sdk';\nimport { subscriber } from '@wix/realtime';\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: { subscriber },\n  // Include the auth strategy and host as relevant\n});\n\nconst subscriptionId = client.subscriber.subscribe(\n  { name: 'my-channel' },\n  (message, channel) => {\n    console.log('Received:', message.payload);\n  },\n  {\n    onSubscribed: (id, isSynced) => console.log('Subscribed', id),\n    onSubscriptionError: (error, id) => console.error('Error', error),\n  },\n);\n```"
+                        }
+                      ]
+                    },
+                    {
+                      "tag": "@requiredField",
+                      "content": [
+                        {
+                          "kind": "text",
+                          "text": "channel"
+                        }
+                      ]
+                    },
+                    {
+                      "tag": "@requiredField",
+                      "content": [
+                        {
+                          "kind": "text",
+                          "text": "messageHandler"
+                        }
+                      ]
                     }
                   ]
                 },
                 "parameters": [
                   {
-                    "id": 83,
-                    "name": "message",
+                    "id": 114,
+                    "name": "channel",
                     "variant": "param",
                     "kind": 32768,
                     "flags": {},
@@ -3522,20 +3383,20 @@
                       "summary": [
                         {
                           "kind": "text",
-                          "text": "Published message."
+                          "text": "Channel and resource to subscribe to."
                         }
                       ]
                     },
                     "type": {
                       "type": "reference",
-                      "target": 77,
-                      "name": "Message",
+                      "target": 63,
+                      "name": "SubscribeChannel",
                       "package": "@wix/realtime-common"
                     }
                   },
                   {
-                    "id": 84,
-                    "name": "channel",
+                    "id": 115,
+                    "name": "messageHandler",
                     "variant": "param",
                     "kind": 32768,
                     "flags": {},
@@ -3543,73 +3404,162 @@
                       "summary": [
                         {
                           "kind": "text",
-                          "text": "Channel the message was published to."
+                          "text": "Handler that runs whenever a message is published to the channel or resource."
                         }
                       ]
                     },
                     "type": {
                       "type": "reference",
-                      "target": 73,
-                      "name": "SubscribeChannel",
+                      "target": 70,
+                      "name": "MessageHandler",
+                      "package": "@wix/realtime-common"
+                    }
+                  },
+                  {
+                    "id": 116,
+                    "name": "options",
+                    "variant": "param",
+                    "kind": 32768,
+                    "flags": {
+                      "isOptional": true
+                    },
+                    "comment": {
+                      "summary": [
+                        {
+                          "kind": "text",
+                          "text": "[Lifecycle handlers](https://dev.wix.com/docs/sdk/core-modules/realtime/realtime/subscriber/introduction#core-modules_realtime_realtime_subscriber_subscription-lifecycle) for subscription events."
+                        }
+                      ]
+                    },
+                    "type": {
+                      "type": "reference",
+                      "target": 87,
+                      "name": "SubscriptionOptions",
                       "package": "@wix/realtime-common"
                     }
                   }
                 ],
                 "type": {
                   "type": "intrinsic",
-                  "name": "void"
+                  "name": "string"
+                }
+              },
+              {
+                "id": 117,
+                "name": "subscribe",
+                "variant": "signature",
+                "kind": 4096,
+                "flags": {},
+                "comment": {
+                  "summary": [
+                    {
+                      "kind": "text",
+                      "text": "Subscribes to a channel or resource.\n\nThe method attempts to establish a subscription to the specified channel or resource. It returns the subscription ID immediately while the subscription is attempted in the background.\n\nUse the "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`options`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": " parameter to register handlers that run whenever the subscription succeeds or generates an error. For some errors, the subscription is re-attempted automatically. The "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`onSubscribed()`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": " handler runs on every successful re-subscription.\n\nLearn more about the [subscription lifecycle](https://dev.wix.com/docs/sdk/core-modules/realtime/realtime/subscriber/introduction#core-modules_realtime_realtime_subscriber_subscription-lifecycle)."
+                    }
+                  ],
+                  "blockTags": [
+                    {
+                      "tag": "@example",
+                      "content": [
+                        {
+                          "kind": "text",
+                          "text": "Subscribe to a channel\n"
+                        },
+                        {
+                          "kind": "code",
+                          "text": "```ts\nimport { subscriber } from '@wix/realtime';\n\nconst subscriptionId = subscriber.subscribe(\n  { name: 'my-channel' },\n  (message, channel) => {\n    console.log('Received:', message.payload);\n  },\n);\n```"
+                        }
+                      ]
+                    },
+                    {
+                      "tag": "@example",
+                      "content": [
+                        {
+                          "kind": "text",
+                          "text": "Subscribe to a channel: Self-hosted\n"
+                        },
+                        {
+                          "kind": "code",
+                          "text": "```ts\nimport { createClient } from '@wix/sdk';\nimport { subscriber } from '@wix/realtime';\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: { subscriber },\n  // Include the auth strategy and host as relevant\n});\n\nconst subscriptionId = client.subscriber.subscribe(\n  { name: 'my-channel' },\n  (message, channel) => {\n    console.log('Received:', message.payload);\n  },\n  {\n    onSubscribed: (id, isSynced) => console.log('Subscribed', id),\n    onSubscriptionError: (error, id) => console.error('Error', error),\n  },\n);\n```"
+                        }
+                      ]
+                    },
+                    {
+                      "tag": "@requiredField",
+                      "content": [
+                        {
+                          "kind": "text",
+                          "text": "channel"
+                        }
+                      ]
+                    },
+                    {
+                      "tag": "@requiredField",
+                      "content": [
+                        {
+                          "kind": "text",
+                          "text": "messageHandler"
+                        }
+                      ]
+                    }
+                  ]
+                },
+                "parameters": [
+                  {
+                    "id": 118,
+                    "name": "httpClient",
+                    "variant": "param",
+                    "kind": 32768,
+                    "flags": {},
+                    "type": {
+                      "type": "reference",
+                      "target": {
+                        "sourceFileName": "../../node_modules/@wix/sdk-types/build/index.d.ts",
+                        "qualifiedName": "HttpClient"
+                      },
+                      "name": "HttpClient",
+                      "package": "@wix/sdk-types"
+                    }
+                  }
+                ],
+                "type": {
+                  "type": "reference",
+                  "target": {
+                    "sourceFileName": "src/subscriber/subscriber.public.ts",
+                    "qualifiedName": "SubscribeSignature"
+                  },
+                  "name": "SubscribeSignature",
+                  "package": "@wix/realtime"
                 }
               }
             ]
-          }
-        }
-      },
-      {
-        "id": 72,
-        "name": "PublishChannel",
-        "variant": "declaration",
-        "kind": 4194304,
-        "flags": {},
-        "comment": {
-          "summary": [
-            {
-              "kind": "text",
-              "text": "Realtime broadcast published channel. Publishers send messages to channels and subscribers listen to them."
-            }
-          ]
-        },
-        "type": {
-          "type": "reference",
-          "target": 31,
-          "name": "Channel",
-          "package": "@wix/realtime-common"
-        },
-        "extendedBy": [
+          },
           {
-            "type": "reference",
-            "target": 73,
-            "name": "SubscribeChannel"
-          }
-        ]
-      },
-      {
-        "id": 87,
-        "name": "SubscriptionErrorHandler",
-        "variant": "declaration",
-        "kind": 4194304,
-        "flags": {},
-        "type": {
-          "type": "reflection",
-          "declaration": {
-            "id": 88,
-            "name": "__type",
+            "id": 119,
+            "name": "unsubscribe",
             "variant": "declaration",
-            "kind": 65536,
+            "kind": 64,
             "flags": {},
             "signatures": [
               {
-                "id": 89,
-                "name": "__type",
+                "id": 120,
+                "name": "unsubscribe",
                 "variant": "signature",
                 "kind": 4096,
                 "flags": {},
@@ -3617,35 +3567,67 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Runs when a subscription error occurs."
+                      "text": "Removes 1 or more subscriptions.\n\nYou can unsubscribe in 3 ways:\n- By "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`subscriptionId`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": ": removes a single subscription.\n- By "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`channel`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": ": removes all subscriptions to that channel or resource.\n- By both: removes the specific subscription, verifying it matches the channel.\n\nWhen the last subscription on a connection is removed, the connection\ncloses automatically."
                     }
-                  ]
-                },
-                "parameters": [
-                  {
-                    "id": 90,
-                    "name": "error",
-                    "variant": "param",
-                    "kind": 32768,
-                    "flags": {},
-                    "comment": {
-                      "summary": [
+                  ],
+                  "blockTags": [
+                    {
+                      "tag": "@example",
+                      "content": [
                         {
                           "kind": "text",
-                          "text": "Error that occurred."
+                          "text": "Remove the specified subscription.\n"
+                        },
+                        {
+                          "kind": "code",
+                          "text": "```ts\nimport { subscriber } from '@wix/realtime';\n\nsubscriber.unsubscribe({ subscriptionId });\n```"
                         }
                       ]
                     },
-                    "type": {
-                      "type": "reference",
-                      "target": 103,
-                      "name": "RealtimeError",
-                      "package": "@wix/realtime-common"
+                    {
+                      "tag": "@example",
+                      "content": [
+                        {
+                          "kind": "text",
+                          "text": "Remove the specified subscription: Self-hosted\n"
+                        },
+                        {
+                          "kind": "code",
+                          "text": "```ts\nimport { subscriber } 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: { subscriber },\n  // Include the auth strategy and host as relevant\n});\n\n// Remove the specified subscription\nclient.subscriber.unsubscribe({ subscriptionId });\n\n// Remove all subscriptions from the specified channel\nclient.subscriber.unsubscribe({ channel: { name: 'my-channel' } });\n```"
+                        }
+                      ]
+                    },
+                    {
+                      "tag": "@requiredField",
+                      "content": [
+                        {
+                          "kind": "text",
+                          "text": "options"
+                        }
+                      ]
                     }
-                  },
+                  ]
+                },
+                "parameters": [
                   {
-                    "id": 91,
-                    "name": "subscriptionId",
+                    "id": 121,
+                    "name": "options",
                     "variant": "param",
                     "kind": 32768,
                     "flags": {},
@@ -3653,13 +3635,31 @@
                       "summary": [
                         {
                           "kind": "text",
-                          "text": "ID of the subscription that generated the error."
+                          "text": "Unsubscribe details. You must specify "
+                        },
+                        {
+                          "kind": "code",
+                          "text": "`channel`"
+                        },
+                        {
+                          "kind": "text",
+                          "text": ", "
+                        },
+                        {
+                          "kind": "code",
+                          "text": "`subscriptionId`"
+                        },
+                        {
+                          "kind": "text",
+                          "text": ", or both."
                         }
                       ]
                     },
                     "type": {
-                      "type": "intrinsic",
-                      "name": "string"
+                      "type": "reference",
+                      "target": 90,
+                      "name": "UnsubscribeOptions",
+                      "package": "@wix/realtime-common"
                     }
                   }
                 ],
@@ -3667,29 +3667,10 @@
                   "type": "intrinsic",
                   "name": "void"
                 }
-              }
-            ]
-          }
-        }
-      },
-      {
-        "id": 92,
-        "name": "SubscriptionHandler",
-        "variant": "declaration",
-        "kind": 4194304,
-        "flags": {},
-        "type": {
-          "type": "reflection",
-          "declaration": {
-            "id": 93,
-            "name": "__type",
-            "variant": "declaration",
-            "kind": 65536,
-            "flags": {},
-            "signatures": [
+              },
               {
-                "id": 94,
-                "name": "__type",
+                "id": 122,
+                "name": "unsubscribe",
                 "variant": "signature",
                 "kind": 4096,
                 "flags": {},
@@ -3697,66 +3678,133 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Runs when a subscription is successfully established or re-established.\n\nWhen a subscription fails and is re-established, the subscriber might not receive all messages published during the failure. The "
+                      "text": "Removes 1 or more subscriptions.\n\nYou can unsubscribe in 3 ways:\n- By "
                     },
                     {
                       "kind": "code",
-                      "text": "`isSynced`"
+                      "text": "`subscriptionId`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": ": removes a single subscription.\n- By "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`channel`"
                     },
                     {
                       "kind": "text",
-                      "text": " flag indicates whether all missed messages were successfully delivered.\n\n<!-- TODO: Document server-side buffer limits for message replay. -->"
+                      "text": ": removes all subscriptions to that channel or resource.\n- By both: removes the specific subscription, verifying it matches the channel.\n\nWhen the last subscription on a connection is removed, the connection\ncloses automatically."
                     }
-                  ]
-                },
-                "parameters": [
-                  {
-                    "id": 95,
-                    "name": "subscriptionId",
-                    "variant": "param",
-                    "kind": 32768,
-                    "flags": {},
-                    "comment": {
-                      "summary": [
+                  ],
+                  "blockTags": [
+                    {
+                      "tag": "@example",
+                      "content": [
                         {
                           "kind": "text",
-                          "text": "Subscription ID."
+                          "text": "Remove the specified subscription.\n"
+                        },
+                        {
+                          "kind": "code",
+                          "text": "```ts\nimport { subscriber } from '@wix/realtime';\n\nsubscriber.unsubscribe({ subscriptionId });\n```"
                         }
                       ]
                     },
-                    "type": {
-                      "type": "intrinsic",
-                      "name": "string"
-                    }
-                  },
-                  {
-                    "id": 96,
-                    "name": "isSynced",
-                    "variant": "param",
-                    "kind": 32768,
-                    "flags": {},
-                    "comment": {
-                      "summary": [
+                    {
+                      "tag": "@example",
+                      "content": [
                         {
                           "kind": "text",
-                          "text": "Whether the message history was fully restored."
+                          "text": "Remove the specified subscription: Self-hosted\n"
+                        },
+                        {
+                          "kind": "code",
+                          "text": "```ts\nimport { subscriber } 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: { subscriber },\n  // Include the auth strategy and host as relevant\n});\n\n// Remove the specified subscription\nclient.subscriber.unsubscribe({ subscriptionId });\n\n// Remove all subscriptions from the specified channel\nclient.subscriber.unsubscribe({ channel: { name: 'my-channel' } });\n```"
                         }
                       ]
                     },
+                    {
+                      "tag": "@requiredField",
+                      "content": [
+                        {
+                          "kind": "text",
+                          "text": "options"
+                        }
+                      ]
+                    }
+                  ]
+                },
+                "parameters": [
+                  {
+                    "id": 123,
+                    "name": "_",
+                    "variant": "param",
+                    "kind": 32768,
+                    "flags": {},
                     "type": {
-                      "type": "intrinsic",
-                      "name": "boolean"
+                      "type": "reference",
+                      "target": {
+                        "sourceFileName": "../../node_modules/@wix/sdk-types/build/index.d.ts",
+                        "qualifiedName": "HttpClient"
+                      },
+                      "name": "HttpClient",
+                      "package": "@wix/sdk-types"
                     }
                   }
                 ],
                 "type": {
-                  "type": "intrinsic",
-                  "name": "void"
+                  "type": "reference",
+                  "target": {
+                    "sourceFileName": "src/subscriber/subscriber.public.ts",
+                    "qualifiedName": "UnsubscribeSignature"
+                  },
+                  "name": "UnsubscribeSignature",
+                  "package": "@wix/realtime"
                 }
               }
             ]
           }
-        }
+        ],
+        "groups": [
+          {
+            "title": "Enumerations",
+            "children": [
+              107
+            ]
+          },
+          {
+            "title": "Classes",
+            "children": [
+              93
+            ]
+          },
+          {
+            "title": "Interfaces",
+            "children": [
+              67,
+              75,
+              63,
+              87,
+              90
+            ]
+          },
+          {
+            "title": "Type Aliases",
+            "children": [
+              70,
+              82,
+              77
+            ]
+          },
+          {
+            "title": "Functions",
+            "children": [
+              112,
+              119
+            ]
+          }
+        ]
       }
     ],
     "groups": [
@@ -3765,38 +3813,7 @@
         "children": [
           52,
           1,
-          59
-        ]
-      },
-      {
-        "title": "Enumerations",
-        "children": [
-          117
-        ]
-      },
-      {
-        "title": "Classes",
-        "children": [
-          103
-        ]
-      },
-      {
-        "title": "Interfaces",
-        "children": [
-          77,
-          85,
-          73,
-          97,
-          100
-        ]
-      },
-      {
-        "title": "Type Aliases",
-        "children": [
-          80,
-          72,
-          87,
-          92
+          62
         ]
       }
     ],