@wix/realtime 1.0.17 → 1.0.18

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

@@ -61,12 +61,17 @@
                     "variant": "param",
                     "kind": 32768,
                     "flags": {},
+                    "comment": {
+                      "summary": [
+                        {
+                          "kind": "text",
+                          "text": "The channel, and optionally the resource, to publish to."
+                        }
+                      ]
+                    },
                     "type": {
                       "type": "reference",
-                      "target": {
-                        "sourceFileName": "../realtime-common/cjs/build/types.d.ts",
-                        "qualifiedName": "Channel"
-                      },
+                      "target": 43,
                       "name": "Channel",
                       "package": "@wix/realtime-common"
                     }
@@ -77,6 +82,14 @@
                     "variant": "param",
                     "kind": 32768,
                     "flags": {},
+                    "comment": {
+                      "summary": [
+                        {
+                          "kind": "text",
+                          "text": "Message payload. Max: 10kb"
+                        }
+                      ]
+                    },
                     "type": {
                       "type": "reference",
                       "target": {
@@ -332,10 +345,7 @@
                         },
                         "type": {
                           "type": "reference",
-                          "target": {
-                            "sourceFileName": "../realtime-common/cjs/build/types.d.ts",
-                            "qualifiedName": "Channel"
-                          },
+                          "target": 43,
                           "name": "Channel",
                           "package": "@wix/realtime-common"
                         }
@@ -466,10 +476,7 @@
                         },
                         "type": {
                           "type": "reference",
-                          "target": {
-                            "sourceFileName": "../realtime-common/cjs/build/types.d.ts",
-                            "qualifiedName": "Channel"
-                          },
+                          "target": 43,
                           "name": "Channel",
                           "package": "@wix/realtime-common"
                         }
@@ -793,10 +800,7 @@
                     },
                     "type": {
                       "type": "reference",
-                      "target": {
-                        "sourceFileName": "../realtime-common/cjs/build/types.d.ts",
-                        "qualifiedName": "Channel"
-                      },
+                      "target": 43,
                       "name": "Channel",
                       "package": "@wix/realtime-common"
                     }
@@ -916,6 +920,34 @@
                 "variant": "signature",
                 "kind": 4096,
                 "flags": {},
+                "comment": {
+                  "summary": [
+                    {
+                      "kind": "text",
+                      "text": "Subscribe to a channel. Returns a subscriptionId immediately; the\nactual connection is established asynchronously in the background. Use the\noptional "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`options`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": " parameter to handle subscription lifecycle events.\n\n**Manual client (self-hosted / explicit auth):**\n\n"
+                    },
+                    {
+                      "kind": "code",
+                      "text": "```ts\nimport { subscriber } from '@wix/realtime';\nimport { createClient, AppStrategy } from '@wix/sdk';\n\nconst client = createClient({\n  modules: { subscriber },\n  auth: AppStrategy({ appId, appSecret, instanceId }),\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```"
+                    },
+                    {
+                      "kind": "text",
+                      "text": "\n\n**Contextual client (Wix-hosted):**\n\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```"
+                    }
+                  ]
+                },
                 "parameters": [
                   {
                     "id": 33,
@@ -923,12 +955,17 @@
                     "variant": "param",
                     "kind": 32768,
                     "flags": {},
+                    "comment": {
+                      "summary": [
+                        {
+                          "kind": "text",
+                          "text": "The channel, and optionally the resource, to subscribe to."
+                        }
+                      ]
+                    },
                     "type": {
                       "type": "reference",
-                      "target": {
-                        "sourceFileName": "../realtime-common/cjs/build/types.d.ts",
-                        "qualifiedName": "Channel"
-                      },
+                      "target": 43,
                       "name": "Channel",
                       "package": "@wix/realtime-common"
                     }
@@ -939,12 +976,17 @@
                     "variant": "param",
                     "kind": 32768,
                     "flags": {},
+                    "comment": {
+                      "summary": [
+                        {
+                          "kind": "text",
+                          "text": "Callback invoked whenever a message is published to the channel."
+                        }
+                      ]
+                    },
                     "type": {
                       "type": "reference",
-                      "target": {
-                        "sourceFileName": "../realtime-common/cjs/build/types.d.ts",
-                        "qualifiedName": "MessageHandler"
-                      },
+                      "target": 49,
                       "name": "MessageHandler",
                       "package": "@wix/realtime-common"
                     }
@@ -957,12 +999,17 @@
                     "flags": {
                       "isOptional": true
                     },
+                    "comment": {
+                      "summary": [
+                        {
+                          "kind": "text",
+                          "text": "Optional lifecycle handlers for subscription events."
+                        }
+                      ]
+                    },
                     "type": {
                       "type": "reference",
-                      "target": {
-                        "sourceFileName": "../realtime-common/cjs/build/types.d.ts",
-                        "qualifiedName": "SubscriptionOptions"
-                      },
+                      "target": 66,
                       "name": "SubscriptionOptions",
                       "package": "@wix/realtime-common"
                     }
@@ -991,7 +1038,19 @@
                     },
                     {
                       "kind": "text",
-                      "text": " parameter to handle subscription lifecycle events."
+                      "text": " parameter to handle subscription lifecycle events.\n\n**Manual client (self-hosted / explicit auth):**\n\n"
+                    },
+                    {
+                      "kind": "code",
+                      "text": "```ts\nimport { subscriber } from '@wix/realtime';\nimport { createClient, AppStrategy } from '@wix/sdk';\n\nconst client = createClient({\n  modules: { subscriber },\n  auth: AppStrategy({ appId, appSecret, instanceId }),\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```"
+                    },
+                    {
+                      "kind": "text",
+                      "text": "\n\n**Contextual client (Wix-hosted):**\n\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```"
                     }
                   ]
                 },
@@ -1038,6 +1097,42 @@
                 "variant": "signature",
                 "kind": 4096,
                 "flags": {},
+                "comment": {
+                  "summary": [
+                    {
+                      "kind": "text",
+                      "text": "Unsubscribe from a subscription by its ID, by channel, or both.\n\nYou can unsubscribe in three 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.\n- By both — removes the specific subscription, verifying it matches the channel.\n\n**Manual client (self-hosted / explicit auth):**\n\n"
+                    },
+                    {
+                      "kind": "code",
+                      "text": "```ts\nimport { subscriber } from '@wix/realtime';\nimport { createClient, AppStrategy } from '@wix/sdk';\n\nconst client = createClient({\n  modules: { subscriber },\n  auth: AppStrategy({ appId, appSecret, instanceId }),\n});\n\n// Unsubscribe by subscription ID\nclient.subscriber.unsubscribe({ subscriptionId });\n\n// Unsubscribe from all subscriptions to a channel\nclient.subscriber.unsubscribe({ channel: { name: 'my-channel' } });\n```"
+                    },
+                    {
+                      "kind": "text",
+                      "text": "\n\n**Contextual client (Wix-hosted):**\n\n"
+                    },
+                    {
+                      "kind": "code",
+                      "text": "```ts\nimport { subscriber } from '@wix/realtime';\n\nsubscriber.unsubscribe({ subscriptionId });\n```"
+                    }
+                  ]
+                },
                 "parameters": [
                   {
                     "id": 40,
@@ -1045,12 +1140,17 @@
                     "variant": "param",
                     "kind": 32768,
                     "flags": {},
+                    "comment": {
+                      "summary": [
+                        {
+                          "kind": "text",
+                          "text": "Identifies what to unsubscribe from — by subscription ID, channel, or both."
+                        }
+                      ]
+                    },
                     "type": {
                       "type": "reference",
-                      "target": {
-                        "sourceFileName": "../realtime-common/cjs/build/types.d.ts",
-                        "qualifiedName": "UnsubscribeOptions"
-                      },
+                      "target": 69,
                       "name": "UnsubscribeOptions",
                       "package": "@wix/realtime-common"
                     }
@@ -1071,7 +1171,35 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Unsubscribe from a subscription by its ID, by channel, or both."
+                      "text": "Unsubscribe from a subscription by its ID, by channel, or both.\n\nYou can unsubscribe in three 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.\n- By both — removes the specific subscription, verifying it matches the channel.\n\n**Manual client (self-hosted / explicit auth):**\n\n"
+                    },
+                    {
+                      "kind": "code",
+                      "text": "```ts\nimport { subscriber } from '@wix/realtime';\nimport { createClient, AppStrategy } from '@wix/sdk';\n\nconst client = createClient({\n  modules: { subscriber },\n  auth: AppStrategy({ appId, appSecret, instanceId }),\n});\n\n// Unsubscribe by subscription ID\nclient.subscriber.unsubscribe({ subscriptionId });\n\n// Unsubscribe from all subscriptions to a channel\nclient.subscriber.unsubscribe({ channel: { name: 'my-channel' } });\n```"
+                    },
+                    {
+                      "kind": "text",
+                      "text": "\n\n**Contextual client (Wix-hosted):**\n\n"
+                    },
+                    {
+                      "kind": "code",
+                      "text": "```ts\nimport { subscriber } from '@wix/realtime';\n\nsubscriber.unsubscribe({ subscriptionId });\n```"
                     }
                   ]
                 },
@@ -1115,15 +1243,1157 @@
             ]
           }
         ]
-      }
-    ],
-    "groups": [
+      },
       {
-        "title": "Namespaces",
+        "id": 86,
+        "name": "RealtimeErrorCode",
+        "variant": "declaration",
+        "kind": 8,
+        "flags": {},
+        "comment": {
+          "summary": [
+            {
+              "kind": "text",
+              "text": "Error codes for realtime errors."
+            }
+          ]
+        },
         "children": [
-          23,
-          1,
-          30
+          {
+            "id": 90,
+            "name": "BadInput",
+            "variant": "declaration",
+            "kind": 16,
+            "flags": {},
+            "comment": {
+              "summary": [
+                {
+                  "kind": "text",
+                  "text": "Invalid input (e.g. bad channel name)."
+                }
+              ]
+            },
+            "type": {
+              "type": "literal",
+              "value": "BAD_INPUT"
+            }
+          },
+          {
+            "id": 88,
+            "name": "ConnectionError",
+            "variant": "declaration",
+            "kind": 16,
+            "flags": {},
+            "comment": {
+              "summary": [
+                {
+                  "kind": "text",
+                  "text": "A connection attempt failed. The client keeps retrying automatically."
+                }
+              ]
+            },
+            "type": {
+              "type": "literal",
+              "value": "CONNECTION_ERROR"
+            }
+          },
+          {
+            "id": 87,
+            "name": "Disconnected",
+            "variant": "declaration",
+            "kind": 16,
+            "flags": {},
+            "comment": {
+              "summary": [
+                {
+                  "kind": "text",
+                  "text": "The connection was closed, either intentionally or due to an error."
+                }
+              ]
+            },
+            "type": {
+              "type": "literal",
+              "value": "DISCONNECTED"
+            }
+          },
+          {
+            "id": 89,
+            "name": "SubscriptionFailed",
+            "variant": "declaration",
+            "kind": 16,
+            "flags": {},
+            "comment": {
+              "summary": [
+                {
+                  "kind": "text",
+                  "text": "The subscription request failed (e.g. authorization error)."
+                }
+              ]
+            },
+            "type": {
+              "type": "literal",
+              "value": "SUBSCRIPTION_FAILED"
+            }
+          }
+        ],
+        "groups": [
+          {
+            "title": "Enumeration Members",
+            "children": [
+              90,
+              88,
+              87,
+              89
+            ]
+          }
+        ]
+      },
+      {
+        "id": 72,
+        "name": "RealtimeError",
+        "variant": "declaration",
+        "kind": 128,
+        "flags": {},
+        "comment": {
+          "summary": [
+            {
+              "kind": "text",
+              "text": "An object representing an error."
+            }
+          ]
+        },
+        "children": [
+          {
+            "id": 73,
+            "name": "constructor",
+            "variant": "declaration",
+            "kind": 512,
+            "flags": {},
+            "signatures": [
+              {
+                "id": 74,
+                "name": "new RealtimeError",
+                "variant": "signature",
+                "kind": 16384,
+                "flags": {},
+                "parameters": [
+                  {
+                    "id": 75,
+                    "name": "errorCode",
+                    "variant": "param",
+                    "kind": 32768,
+                    "flags": {},
+                    "type": {
+                      "type": "reference",
+                      "target": 86,
+                      "name": "RealtimeErrorCode",
+                      "package": "@wix/realtime-common"
+                    }
+                  },
+                  {
+                    "id": 76,
+                    "name": "message",
+                    "variant": "param",
+                    "kind": 32768,
+                    "flags": {},
+                    "type": {
+                      "type": "intrinsic",
+                      "name": "string"
+                    }
+                  },
+                  {
+                    "id": 77,
+                    "name": "options",
+                    "variant": "param",
+                    "kind": 32768,
+                    "flags": {
+                      "isOptional": true
+                    },
+                    "type": {
+                      "type": "reflection",
+                      "declaration": {
+                        "id": 78,
+                        "name": "__type",
+                        "variant": "declaration",
+                        "kind": 65536,
+                        "flags": {},
+                        "children": [
+                          {
+                            "id": 79,
+                            "name": "channel",
+                            "variant": "declaration",
+                            "kind": 1024,
+                            "flags": {
+                              "isOptional": true
+                            },
+                            "type": {
+                              "type": "reference",
+                              "target": 43,
+                              "name": "Channel",
+                              "package": "@wix/realtime-common"
+                            }
+                          },
+                          {
+                            "id": 80,
+                            "name": "recoverable",
+                            "variant": "declaration",
+                            "kind": 1024,
+                            "flags": {
+                              "isOptional": true
+                            },
+                            "type": {
+                              "type": "intrinsic",
+                              "name": "boolean"
+                            }
+                          },
+                          {
+                            "id": 81,
+                            "name": "status",
+                            "variant": "declaration",
+                            "kind": 1024,
+                            "flags": {
+                              "isOptional": true
+                            },
+                            "type": {
+                              "type": "intrinsic",
+                              "name": "number"
+                            }
+                          }
+                        ],
+                        "groups": [
+                          {
+                            "title": "Properties",
+                            "children": [
+                              79,
+                              80,
+                              81
+                            ]
+                          }
+                        ]
+                      }
+                    }
+                  }
+                ],
+                "type": {
+                  "type": "reference",
+                  "target": 72,
+                  "name": "RealtimeError",
+                  "package": "@wix/realtime-common"
+                },
+                "overwrites": {
+                  "type": "reference",
+                  "target": -1,
+                  "name": "Error.constructor"
+                }
+              }
+            ],
+            "overwrites": {
+              "type": "reference",
+              "target": -1,
+              "name": "Error.constructor"
+            }
+          },
+          {
+            "id": 83,
+            "name": "channel",
+            "variant": "declaration",
+            "kind": 1024,
+            "flags": {
+              "isOptional": true
+            },
+            "comment": {
+              "summary": [
+                {
+                  "kind": "text",
+                  "text": "Channel related to the error."
+                }
+              ]
+            },
+            "type": {
+              "type": "reference",
+              "target": 43,
+              "name": "Channel",
+              "package": "@wix/realtime-common"
+            }
+          },
+          {
+            "id": 82,
+            "name": "errorCode",
+            "variant": "declaration",
+            "kind": 1024,
+            "flags": {},
+            "comment": {
+              "summary": [
+                {
+                  "kind": "text",
+                  "text": "Error code."
+                }
+              ]
+            },
+            "type": {
+              "type": "reference",
+              "target": 86,
+              "name": "RealtimeErrorCode",
+              "package": "@wix/realtime-common"
+            }
+          },
+          {
+            "id": 84,
+            "name": "recoverable",
+            "variant": "declaration",
+            "kind": 1024,
+            "flags": {
+              "isOptional": true
+            },
+            "comment": {
+              "summary": [
+                {
+                  "kind": "text",
+                  "text": "Whether the error is recoverable. When "
+                },
+                {
+                  "kind": "code",
+                  "text": "`true`"
+                },
+                {
+                  "kind": "text",
+                  "text": ", the client is\nautomatically attempting to reconnect. When "
+                },
+                {
+                  "kind": "code",
+                  "text": "`false`"
+                },
+                {
+                  "kind": "text",
+                  "text": ", user action\nis required (for example, the subscription must be re-created)."
+                }
+              ]
+            },
+            "type": {
+              "type": "intrinsic",
+              "name": "boolean"
+            }
+          },
+          {
+            "id": 85,
+            "name": "status",
+            "variant": "declaration",
+            "kind": 1024,
+            "flags": {
+              "isOptional": true
+            },
+            "comment": {
+              "summary": [
+                {
+                  "kind": "text",
+                  "text": "HTTP status code from the server response.\nPresent on subscription failed errors (e.g. 401, 403, 500)."
+                }
+              ]
+            },
+            "type": {
+              "type": "intrinsic",
+              "name": "number"
+            }
+          }
+        ],
+        "groups": [
+          {
+            "title": "Constructors",
+            "children": [
+              73
+            ]
+          },
+          {
+            "title": "Properties",
+            "children": [
+              83,
+              82,
+              84,
+              85
+            ]
+          }
+        ],
+        "extendedTypes": [
+          {
+            "type": "reference",
+            "target": {
+              "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
+              "qualifiedName": "Error"
+            },
+            "name": "Error",
+            "package": "typescript"
+          }
+        ]
+      },
+      {
+        "id": 43,
+        "name": "Channel",
+        "variant": "declaration",
+        "kind": 256,
+        "flags": {},
+        "comment": {
+          "summary": [
+            {
+              "kind": "text",
+              "text": "An object representing a realtime channel."
+            }
+          ]
+        },
+        "children": [
+          {
+            "id": 44,
+            "name": "name",
+            "variant": "declaration",
+            "kind": 1024,
+            "flags": {},
+            "comment": {
+              "summary": [
+                {
+                  "kind": "text",
+                  "text": "Channel name. Only alphanumeric characters, hyphens, and underscores are allowed.\nThe combined length of "
+                },
+                {
+                  "kind": "code",
+                  "text": "`name`"
+                },
+                {
+                  "kind": "text",
+                  "text": " and "
+                },
+                {
+                  "kind": "code",
+                  "text": "`resourceId`"
+                },
+                {
+                  "kind": "text",
+                  "text": " cannot exceed 140 characters."
+                }
+              ]
+            },
+            "type": {
+              "type": "intrinsic",
+              "name": "string"
+            }
+          },
+          {
+            "id": 45,
+            "name": "resourceId",
+            "variant": "declaration",
+            "kind": 1024,
+            "flags": {
+              "isOptional": true
+            },
+            "comment": {
+              "summary": [
+                {
+                  "kind": "text",
+                  "text": "ID of a specific channel resource."
+                }
+              ]
+            },
+            "type": {
+              "type": "intrinsic",
+              "name": "string"
+            }
+          }
+        ],
+        "groups": [
+          {
+            "title": "Properties",
+            "children": [
+              44,
+              45
+            ]
+          }
+        ]
+      },
+      {
+        "id": 46,
+        "name": "Message",
+        "variant": "declaration",
+        "kind": 256,
+        "flags": {},
+        "comment": {
+          "summary": [
+            {
+              "kind": "text",
+              "text": "An object representing a published message."
+            }
+          ]
+        },
+        "children": [
+          {
+            "id": 47,
+            "name": "payload",
+            "variant": "declaration",
+            "kind": 1024,
+            "flags": {},
+            "comment": {
+              "summary": [
+                {
+                  "kind": "text",
+                  "text": "Message payload.\nMax: 10kb"
+                }
+              ]
+            },
+            "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"
+            }
+          },
+          {
+            "id": 48,
+            "name": "publisher",
+            "variant": "declaration",
+            "kind": 1024,
+            "flags": {
+              "isOptional": true
+            },
+            "comment": {
+              "summary": [
+                {
+                  "kind": "text",
+                  "text": "Message publisher, if sent."
+                }
+              ]
+            },
+            "type": {
+              "type": "reference",
+              "target": 54,
+              "name": "Publisher",
+              "package": "@wix/realtime-common"
+            }
+          }
+        ],
+        "groups": [
+          {
+            "title": "Properties",
+            "children": [
+              47,
+              48
+            ]
+          }
+        ]
+      },
+      {
+        "id": 54,
+        "name": "Publisher",
+        "variant": "declaration",
+        "kind": 256,
+        "flags": {},
+        "comment": {
+          "summary": [
+            {
+              "kind": "text",
+              "text": "An object representing a publisher."
+            }
+          ]
+        },
+        "children": [
+          {
+            "id": 55,
+            "name": "id",
+            "variant": "declaration",
+            "kind": 1024,
+            "flags": {},
+            "comment": {
+              "summary": [
+                {
+                  "kind": "text",
+                  "text": "ID of the publisher."
+                }
+              ]
+            },
+            "type": {
+              "type": "intrinsic",
+              "name": "string"
+            }
+          }
+        ],
+        "groups": [
+          {
+            "title": "Properties",
+            "children": [
+              55
+            ]
+          }
+        ]
+      },
+      {
+        "id": 66,
+        "name": "SubscriptionOptions",
+        "variant": "declaration",
+        "kind": 256,
+        "flags": {},
+        "comment": {
+          "summary": [
+            {
+              "kind": "text",
+              "text": "An object containing optional lifecycle handlers for a subscription."
+            }
+          ]
+        },
+        "children": [
+          {
+            "id": 67,
+            "name": "onSubscribed",
+            "variant": "declaration",
+            "kind": 1024,
+            "flags": {
+              "isOptional": true
+            },
+            "comment": {
+              "summary": [
+                {
+                  "kind": "text",
+                  "text": "Runs when the subscription is successfully established.\n\nThis fires on the initial subscription and again every time the\nsubscription is automatically restored after a reconnection, so make\nsure your handler is idempotent.\n\nThe "
+                },
+                {
+                  "kind": "code",
+                  "text": "`isSynced`"
+                },
+                {
+                  "kind": "text",
+                  "text": " flag indicates whether the server was able to restore\nmissed messages since the last disconnection:\n\n- **First subscription** — always "
+                },
+                {
+                  "kind": "code",
+                  "text": "`false`"
+                },
+                {
+                  "kind": "text",
+                  "text": ". The client has no prior\n  message history, so the server cannot restore anything. The app\n  should load its own initial state.\n\n- **Re-subscription after reconnect, "
+                },
+                {
+                  "kind": "code",
+                  "text": "`isSynced: true`"
+                },
+                {
+                  "kind": "text",
+                  "text": "** — the server\n  found the last received message and replayed everything since.\n  No action needed from the app.\n\n- **Re-subscription after reconnect, "
+                },
+                {
+                  "kind": "code",
+                  "text": "`isSynced: false`"
+                },
+                {
+                  "kind": "text",
+                  "text": "** — the server\n  could not restore missed messages (e.g. they expired). The app\n  should resync its state independently."
+                }
+              ],
+              "blockTags": [
+                {
+                  "tag": "@param",
+                  "name": "subscriptionId",
+                  "content": [
+                    {
+                      "kind": "text",
+                      "text": "The ID of the subscription that was established."
+                    }
+                  ]
+                },
+                {
+                  "tag": "@param",
+                  "name": "isSynced",
+                  "content": [
+                    {
+                      "kind": "text",
+                      "text": "Whether the server successfully restored missed messages."
+                    }
+                  ]
+                }
+              ]
+            },
+            "type": {
+              "type": "reference",
+              "target": 61,
+              "name": "SubscriptionHandler",
+              "package": "@wix/realtime-common"
+            }
+          },
+          {
+            "id": 68,
+            "name": "onSubscriptionError",
+            "variant": "declaration",
+            "kind": 1024,
+            "flags": {
+              "isOptional": true
+            },
+            "comment": {
+              "summary": [
+                {
+                  "kind": "text",
+                  "text": "Runs when a subscription error occurs.\n\nThis handler is triggered in the following scenarios:\n\n- **Subscription failed** — Authorization failure. The subscription\n  request returned a non-2xx status. The error includes the HTTP\n  "
+                },
+                {
+                  "kind": "code",
+                  "text": "`status`"
+                },
+                {
+                  "kind": "text",
+                  "text": " code and a "
+                },
+                {
+                  "kind": "code",
+                  "text": "`message`"
+                },
+                {
+                  "kind": "text",
+                  "text": " with details. This is non-recoverable;\n  the subscription will not retry automatically.\n\n- **Disconnected** — The connection was closed, either intentionally\n  or due to an error. When caused by an error, the "
+                },
+                {
+                  "kind": "code",
+                  "text": "`recoverable`"
+                },
+                {
+                  "kind": "text",
+                  "text": " flag\n  on the error indicates whether the client will auto-reconnect\n  ("
+                },
+                {
+                  "kind": "code",
+                  "text": "`true`"
+                },
+                {
+                  "kind": "text",
+                  "text": ") or whether manual action is required ("
+                },
+                {
+                  "kind": "code",
+                  "text": "`false`"
+                },
+                {
+                  "kind": "text",
+                  "text": ", e.g. a 401\n  means the signed instance is invalid).\n\n- **Connection error** — Fired on every reconnection attempt that\n  fails. The "
+                },
+                {
+                  "kind": "code",
+                  "text": "`recoverable`"
+                },
+                {
+                  "kind": "text",
+                  "text": " flag is always "
+                },
+                {
+                  "kind": "code",
+                  "text": "`true`"
+                },
+                {
+                  "kind": "text",
+                  "text": " for these errors\n  (the client keeps retrying with exponential backoff). If the error\n  becomes non-recoverable, a disconnection with "
+                },
+                {
+                  "kind": "code",
+                  "text": "`recoverable: false`"
+                },
+                {
+                  "kind": "text",
+                  "text": "\n  is fired instead.\n\nInspect "
+                },
+                {
+                  "kind": "code",
+                  "text": "`error.recoverable`"
+                },
+                {
+                  "kind": "text",
+                  "text": " to distinguish transient errors (where\nthe client is auto-reconnecting) from permanent failures (where user\naction is required).\n\nNote: this handler may fire multiple times during a single session.\nFor example, a typical recovery flow looks like:\n"
+                },
+                {
+                  "kind": "code",
+                  "text": "`subscribed → error (recoverable) → error (recoverable) → subscribed`"
+                },
+                {
+                  "kind": "text",
+                  "text": "\nThis happens because the client automatically tries to recover itself\nafter an unexpected disconnection."
+                }
+              ],
+              "blockTags": [
+                {
+                  "tag": "@param",
+                  "name": "error",
+                  "content": [
+                    {
+                      "kind": "text",
+                      "text": "The error that occurred, including "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`errorCode`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": ",\n  "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`recoverable`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": ", and optionally "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`channel`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": " and "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`status`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": "."
+                    }
+                  ]
+                },
+                {
+                  "tag": "@param",
+                  "name": "subscriptionId",
+                  "content": [
+                    {
+                      "kind": "text",
+                      "text": "The ID of the affected subscription."
+                    }
+                  ]
+                }
+              ]
+            },
+            "type": {
+              "type": "reference",
+              "target": 56,
+              "name": "SubscriptionErrorHandler",
+              "package": "@wix/realtime-common"
+            }
+          }
+        ],
+        "groups": [
+          {
+            "title": "Properties",
+            "children": [
+              67,
+              68
+            ]
+          }
+        ]
+      },
+      {
+        "id": 69,
+        "name": "UnsubscribeOptions",
+        "variant": "declaration",
+        "kind": 256,
+        "flags": {},
+        "comment": {
+          "summary": [
+            {
+              "kind": "text",
+              "text": "An object containing options to be used when unsubscribing from a\nchannel or channel resource."
+            }
+          ]
+        },
+        "children": [
+          {
+            "id": 70,
+            "name": "channel",
+            "variant": "declaration",
+            "kind": 1024,
+            "flags": {
+              "isOptional": true
+            },
+            "comment": {
+              "summary": [
+                {
+                  "kind": "text",
+                  "text": "The channel, and optionally the resource, to\nunsubscribe from. Use this property when unsubscribing from all subscriptions to a channel\nor channel resource."
+                }
+              ]
+            },
+            "type": {
+              "type": "reference",
+              "target": 43,
+              "name": "Channel",
+              "package": "@wix/realtime-common"
+            }
+          },
+          {
+            "id": 71,
+            "name": "subscriptionId",
+            "variant": "declaration",
+            "kind": 1024,
+            "flags": {
+              "isOptional": true
+            },
+            "comment": {
+              "summary": [
+                {
+                  "kind": "text",
+                  "text": "ID of the subscription to unsubscribe from. Use this\nproperty when unsubscribing from one of multiple subscriptions to a channel or channel\nresource."
+                }
+              ]
+            },
+            "type": {
+              "type": "intrinsic",
+              "name": "string"
+            }
+          }
+        ],
+        "groups": [
+          {
+            "title": "Properties",
+            "children": [
+              70,
+              71
+            ]
+          }
+        ]
+      },
+      {
+        "id": 49,
+        "name": "MessageHandler",
+        "variant": "declaration",
+        "kind": 4194304,
+        "flags": {},
+        "type": {
+          "type": "reflection",
+          "declaration": {
+            "id": 50,
+            "name": "__type",
+            "variant": "declaration",
+            "kind": 65536,
+            "flags": {},
+            "signatures": [
+              {
+                "id": 51,
+                "name": "__type",
+                "variant": "signature",
+                "kind": 4096,
+                "flags": {},
+                "comment": {
+                  "summary": [
+                    {
+                      "kind": "text",
+                      "text": "Handles a message published to a channel or channel resource."
+                    }
+                  ]
+                },
+                "parameters": [
+                  {
+                    "id": 52,
+                    "name": "message",
+                    "variant": "param",
+                    "kind": 32768,
+                    "flags": {},
+                    "type": {
+                      "type": "reference",
+                      "target": 46,
+                      "name": "Message",
+                      "package": "@wix/realtime-common"
+                    }
+                  },
+                  {
+                    "id": 53,
+                    "name": "channel",
+                    "variant": "param",
+                    "kind": 32768,
+                    "flags": {},
+                    "type": {
+                      "type": "reference",
+                      "target": 43,
+                      "name": "Channel",
+                      "package": "@wix/realtime-common"
+                    }
+                  }
+                ],
+                "type": {
+                  "type": "intrinsic",
+                  "name": "void"
+                }
+              }
+            ]
+          }
+        }
+      },
+      {
+        "id": 56,
+        "name": "SubscriptionErrorHandler",
+        "variant": "declaration",
+        "kind": 4194304,
+        "flags": {},
+        "type": {
+          "type": "reflection",
+          "declaration": {
+            "id": 57,
+            "name": "__type",
+            "variant": "declaration",
+            "kind": 65536,
+            "flags": {},
+            "signatures": [
+              {
+                "id": 58,
+                "name": "__type",
+                "variant": "signature",
+                "kind": 4096,
+                "flags": {},
+                "comment": {
+                  "summary": [
+                    {
+                      "kind": "text",
+                      "text": "Handles a subscription error event."
+                    }
+                  ]
+                },
+                "parameters": [
+                  {
+                    "id": 59,
+                    "name": "error",
+                    "variant": "param",
+                    "kind": 32768,
+                    "flags": {},
+                    "type": {
+                      "type": "reference",
+                      "target": 72,
+                      "name": "RealtimeError",
+                      "package": "@wix/realtime-common"
+                    }
+                  },
+                  {
+                    "id": 60,
+                    "name": "subscriptionId",
+                    "variant": "param",
+                    "kind": 32768,
+                    "flags": {},
+                    "type": {
+                      "type": "intrinsic",
+                      "name": "string"
+                    }
+                  }
+                ],
+                "type": {
+                  "type": "intrinsic",
+                  "name": "void"
+                }
+              }
+            ]
+          }
+        }
+      },
+      {
+        "id": 61,
+        "name": "SubscriptionHandler",
+        "variant": "declaration",
+        "kind": 4194304,
+        "flags": {},
+        "type": {
+          "type": "reflection",
+          "declaration": {
+            "id": 62,
+            "name": "__type",
+            "variant": "declaration",
+            "kind": 65536,
+            "flags": {},
+            "signatures": [
+              {
+                "id": 63,
+                "name": "__type",
+                "variant": "signature",
+                "kind": 4096,
+                "flags": {},
+                "comment": {
+                  "summary": [
+                    {
+                      "kind": "text",
+                      "text": "Handles a successful subscription or re-subscription event."
+                    }
+                  ]
+                },
+                "parameters": [
+                  {
+                    "id": 64,
+                    "name": "subscriptionId",
+                    "variant": "param",
+                    "kind": 32768,
+                    "flags": {},
+                    "type": {
+                      "type": "intrinsic",
+                      "name": "string"
+                    }
+                  },
+                  {
+                    "id": 65,
+                    "name": "isSynced",
+                    "variant": "param",
+                    "kind": 32768,
+                    "flags": {},
+                    "type": {
+                      "type": "intrinsic",
+                      "name": "boolean"
+                    }
+                  }
+                ],
+                "type": {
+                  "type": "intrinsic",
+                  "name": "void"
+                }
+              }
+            ]
+          }
+        }
+      }
+    ],
+    "groups": [
+      {
+        "title": "Namespaces",
+        "children": [
+          23,
+          1,
+          30
+        ]
+      },
+      {
+        "title": "Enumerations",
+        "children": [
+          86
+        ]
+      },
+      {
+        "title": "Classes",
+        "children": [
+          72
+        ]
+      },
+      {
+        "title": "Interfaces",
+        "children": [
+          43,
+          46,
+          54,
+          66,
+          69
+        ]
+      },
+      {
+        "title": "Type Aliases",
+        "children": [
+          49,
+          56,
+          61
         ]
       }
     ],