@wix/realtime 1.0.16 → 1.0.18

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

@@ -0,0 +1,2406 @@
+{
+  "typeDocModel": {
+    "id": 0,
+    "name": "@wix/realtime",
+    "variant": "project",
+    "kind": 1,
+    "flags": {},
+    "children": [
+      {
+        "id": 23,
+        "name": "publisher",
+        "variant": "declaration",
+        "kind": 4,
+        "flags": {},
+        "children": [
+          {
+            "id": 24,
+            "name": "publish",
+            "variant": "declaration",
+            "kind": 64,
+            "flags": {},
+            "signatures": [
+              {
+                "id": 25,
+                "name": "publish",
+                "variant": "signature",
+                "kind": 4096,
+                "flags": {},
+                "comment": {
+                  "summary": [
+                    {
+                      "kind": "text",
+                      "text": "Publishes a message to a realtime channel.\n\nMust be called from a backend function (server-to-server) as it requires\napp-level permissions to publish messages via the Duplexer API.\n\nThere are two ways to use this function depending on the Wix client type:\n\n**Manual client (self-hosted / explicit auth) — no elevation needed:**\nThe client's own credentials (instanceId, metaSiteId) are used directly.\nThis ensures messages are scoped to the correct site.\n\n"
+                    },
+                    {
+                      "kind": "code",
+                      "text": "```ts\nimport { publisher } from '@wix/realtime';\nimport { createClient, AppStrategy } from '@wix/sdk';\n\nconst client = createClient({\n  modules: { publisher },\n  auth: AppStrategy({ appId, appSecret, instanceId }),\n});\nawait client.publisher.publish({ name: 'my-channel' }, { message: 'hello' });\n```"
+                    },
+                    {
+                      "kind": "text",
+                      "text": "\n\n**Contextual client (Wix-hosted) — elevation needed:**\nThe contextual httpClient may not have sufficient permissions on its own.\nWrap the call with "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`elevate()`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": " to obtain the host's backend credentials.\n\n"
+                    },
+                    {
+                      "kind": "code",
+                      "text": "```ts\nimport { publisher } from '@wix/realtime';\nimport { elevate } from '@wix/sdk/context';\n\nawait elevate(publisher.publish)({ name: 'my-channel' }, { message: 'hello' });\n```"
+                    }
+                  ]
+                },
+                "parameters": [
+                  {
+                    "id": 26,
+                    "name": "channel",
+                    "variant": "param",
+                    "kind": 32768,
+                    "flags": {},
+                    "comment": {
+                      "summary": [
+                        {
+                          "kind": "text",
+                          "text": "The channel, and optionally the resource, to publish to."
+                        }
+                      ]
+                    },
+                    "type": {
+                      "type": "reference",
+                      "target": 43,
+                      "name": "Channel",
+                      "package": "@wix/realtime-common"
+                    }
+                  },
+                  {
+                    "id": 27,
+                    "name": "payload",
+                    "variant": "param",
+                    "kind": 32768,
+                    "flags": {},
+                    "comment": {
+                      "summary": [
+                        {
+                          "kind": "text",
+                          "text": "Message payload. Max: 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"
+                    }
+                  }
+                ],
+                "type": {
+                  "type": "reference",
+                  "target": {
+                    "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
+                    "qualifiedName": "Promise"
+                  },
+                  "typeArguments": [
+                    {
+                      "type": "intrinsic",
+                      "name": "void"
+                    }
+                  ],
+                  "name": "Promise",
+                  "package": "typescript"
+                }
+              },
+              {
+                "id": 28,
+                "name": "publish",
+                "variant": "signature",
+                "kind": 4096,
+                "flags": {},
+                "comment": {
+                  "summary": [
+                    {
+                      "kind": "text",
+                      "text": "Publishes a message to a realtime channel.\n\nMust be called from a backend function (server-to-server) as it requires\napp-level permissions to publish messages via the Duplexer API.\n\nThere are two ways to use this function depending on the Wix client type:\n\n**Manual client (self-hosted / explicit auth) — no elevation needed:**\nThe client's own credentials (instanceId, metaSiteId) are used directly.\nThis ensures messages are scoped to the correct site.\n\n"
+                    },
+                    {
+                      "kind": "code",
+                      "text": "```ts\nimport { publisher } from '@wix/realtime';\nimport { createClient, AppStrategy } from '@wix/sdk';\n\nconst client = createClient({\n  modules: { publisher },\n  auth: AppStrategy({ appId, appSecret, instanceId }),\n});\nawait client.publisher.publish({ name: 'my-channel' }, { message: 'hello' });\n```"
+                    },
+                    {
+                      "kind": "text",
+                      "text": "\n\n**Contextual client (Wix-hosted) — elevation needed:**\nThe contextual httpClient may not have sufficient permissions on its own.\nWrap the call with "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`elevate()`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": " to obtain the host's backend credentials.\n\n"
+                    },
+                    {
+                      "kind": "code",
+                      "text": "```ts\nimport { publisher } from '@wix/realtime';\nimport { elevate } from '@wix/sdk/context';\n\nawait elevate(publisher.publish)({ name: 'my-channel' }, { message: 'hello' });\n```"
+                    }
+                  ]
+                },
+                "parameters": [
+                  {
+                    "id": 29,
+                    "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/publisher/publisher.public.ts",
+                    "qualifiedName": "PublishSignature"
+                  },
+                  "name": "PublishSignature",
+                  "package": "@wix/realtime"
+                }
+              }
+            ]
+          }
+        ],
+        "groups": [
+          {
+            "title": "Functions",
+            "children": [
+              24
+            ]
+          }
+        ]
+      },
+      {
+        "id": 1,
+        "name": "site",
+        "variant": "declaration",
+        "kind": 4,
+        "flags": {},
+        "children": [
+          {
+            "id": 7,
+            "name": "PermissionsRouter",
+            "variant": "declaration",
+            "kind": 256,
+            "flags": {},
+            "comment": {
+              "summary": [
+                {
+                  "kind": "text",
+                  "text": "IPermissionsRouter"
+                }
+              ],
+              "blockTags": [
+                {
+                  "tag": "@summary",
+                  "content": [
+                    {
+                      "kind": "text",
+                      "text": "A router for defining and checking permissions."
+                    }
+                  ]
+                },
+                {
+                  "tag": "@description",
+                  "content": [
+                    {
+                      "kind": "text",
+                      "text": "Use the permissions router to define the permissions you want to grant to subscribers\n on channels or channel resources. You can set permissions on the channel and channel\n resource level. If you do not define permissions for a particular channel resource,\n that resource inherits the permissions of its parent channel.\n\n Typically you use the permissions router in the **realtime-permissions.js** file in\n your site's backend to:\n\n + Set default permissions for all channels and channel resources where no explicit\n   permissions are defined.\n + Add permissions logic for specific channels or channel resources.\n + Check the permissions for a specific subscriber on a specific channel.\n\n > **Note:** Although it is recommended, you do not need to use the permissions router to set permissions. You can also define all your permissions logic in the ["
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`realtime_check_permission()`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": "](#realtime_check_permission) function."
+                    }
+                  ]
+                }
+              ]
+            },
+            "children": [
+              {
+                "id": 8,
+                "name": "add",
+                "variant": "declaration",
+                "kind": 2048,
+                "flags": {},
+                "signatures": [
+                  {
+                    "id": 9,
+                    "name": "add",
+                    "variant": "signature",
+                    "kind": 4096,
+                    "flags": {},
+                    "comment": {
+                      "summary": [],
+                      "blockTags": [
+                        {
+                          "tag": "@function",
+                          "content": [
+                            {
+                              "kind": "text",
+                              "text": "add"
+                            }
+                          ]
+                        },
+                        {
+                          "tag": "@summary",
+                          "content": [
+                            {
+                              "kind": "text",
+                              "text": "Sets a permissions handler for a specific channel or channel resource."
+                            }
+                          ]
+                        },
+                        {
+                          "tag": "@description",
+                          "content": [
+                            {
+                              "kind": "text",
+                              "text": "The handler set by the "
+                            },
+                            {
+                              "kind": "code",
+                              "text": "`add()`"
+                            },
+                            {
+                              "kind": "text",
+                              "text": " function is used for permission checks by the permissions\n router for the channel or channel resource specified in the "
+                            },
+                            {
+                              "kind": "code",
+                              "text": "`channel`"
+                            },
+                            {
+                              "kind": "text",
+                              "text": " property.\n\n Adding a handler to a specific channel without a specified resource adds a handler for\n all permissions checks on the channel and all permissions checks on any of the channel's\n resources that do not have their own permissions handlers.\n\n For example, suppose you have the following channel, resources, and permissions:\n\n + channel: A, permissions: handler X is specified using the "
+                            },
+                            {
+                              "kind": "code",
+                              "text": "`add()`"
+                            },
+                            {
+                              "kind": "text",
+                              "text": " function\n + channel: A, resource: 1, permissions: handler Y is specified using the "
+                            },
+                            {
+                              "kind": "code",
+                              "text": "`add()`"
+                            },
+                            {
+                              "kind": "text",
+                              "text": " function\n + channel: A, resource: 2, permissions: no handler is specified\n\n\n Permissions will be checked as follows:\n\n + A: use handler X\n + A, 1: use handler Y\n + A, 2: use handler X"
+                            }
+                          ]
+                        }
+                      ]
+                    },
+                    "parameters": [
+                      {
+                        "id": 10,
+                        "name": "channel",
+                        "variant": "param",
+                        "kind": 32768,
+                        "flags": {},
+                        "comment": {
+                          "summary": [
+                            {
+                              "kind": "text",
+                              "text": "The channel, and optionally the resource, to publish to."
+                            }
+                          ]
+                        },
+                        "type": {
+                          "type": "reference",
+                          "target": 43,
+                          "name": "Channel",
+                          "package": "@wix/realtime-common"
+                        }
+                      },
+                      {
+                        "id": 11,
+                        "name": "permissionHandler",
+                        "variant": "param",
+                        "kind": 32768,
+                        "flags": {},
+                        "comment": {
+                          "summary": [
+                            {
+                              "kind": "text",
+                              "text": "Handles setting of permissions for a subscriber on a channel or\n channel resource."
+                            }
+                          ]
+                        },
+                        "type": {
+                          "type": "reference",
+                          "target": {
+                            "sourceFileName": "../site/cjs/build/types.d.ts",
+                            "qualifiedName": "PermissionHandler"
+                          },
+                          "name": "PermissionHandler",
+                          "package": "@wix/sdk_realtime_site"
+                        }
+                      }
+                    ],
+                    "type": {
+                      "type": "intrinsic",
+                      "name": "void"
+                    }
+                  }
+                ]
+              },
+              {
+                "id": 15,
+                "name": "check",
+                "variant": "declaration",
+                "kind": 2048,
+                "flags": {},
+                "signatures": [
+                  {
+                    "id": 16,
+                    "name": "check",
+                    "variant": "signature",
+                    "kind": 4096,
+                    "flags": {},
+                    "comment": {
+                      "summary": [],
+                      "blockTags": [
+                        {
+                          "tag": "@function",
+                          "content": [
+                            {
+                              "kind": "text",
+                              "text": "check"
+                            }
+                          ]
+                        },
+                        {
+                          "tag": "@summary",
+                          "content": [
+                            {
+                              "kind": "text",
+                              "text": "Checks the permissions for a subscriber on a channel or channel resource."
+                            }
+                          ]
+                        },
+                        {
+                          "tag": "@description",
+                          "content": [
+                            {
+                              "kind": "text",
+                              "text": "The "
+                            },
+                            {
+                              "kind": "code",
+                              "text": "`check()`"
+                            },
+                            {
+                              "kind": "text",
+                              "text": " function returns a Promise that resolves to the permissions for the\n specified user on the specified channel or channel resource.\n\n The check is performed as follows:\n\n 1. If a permissions handler for the specified channel or channel resource exists,\n    it's invoked and its result is returned.\n 1. If no handler is found for the specified channel resource, but a handler\n    exists for the resource's channel, it's invoked and its result is returned.\n 1. If no handler is found for the specified channel, but a default permissions handler\n    exists, it's invoked and its result is returned.\n 1. If the default handler has not been found, the default permissions are returned.\n\n    The default permissions are:\n    "
+                            },
+                            {
+                              "kind": "code",
+                              "text": "`{\"read\": true}`"
+                            },
+                            {
+                              "kind": "text",
+                              "text": "\n\n\n This function is typically called in the body of the\n ["
+                            },
+                            {
+                              "kind": "code",
+                              "text": "`realtime_check_permission()`"
+                            },
+                            {
+                              "kind": "text",
+                              "text": "](https://dev.wix.com/docs/sdk/backend-modules/realtime/site/realtime-check-permission) function like so:\n\n "
+                            },
+                            {
+                              "kind": "code",
+                              "text": "```JavaScript\n export function realtime_check_permission(channel, subscriber) {\n   return permissionsRouter.check(channel,subscriber);\n }\n ```"
+                            }
+                          ]
+                        },
+                        {
+                          "tag": "@returns",
+                          "content": []
+                        }
+                      ]
+                    },
+                    "parameters": [
+                      {
+                        "id": 17,
+                        "name": "channel",
+                        "variant": "param",
+                        "kind": 32768,
+                        "flags": {},
+                        "comment": {
+                          "summary": [
+                            {
+                              "kind": "text",
+                              "text": "The channel, and optionally the resource, to publish to."
+                            }
+                          ]
+                        },
+                        "type": {
+                          "type": "reference",
+                          "target": 43,
+                          "name": "Channel",
+                          "package": "@wix/realtime-common"
+                        }
+                      },
+                      {
+                        "id": 18,
+                        "name": "subscriber",
+                        "variant": "param",
+                        "kind": 32768,
+                        "flags": {},
+                        "comment": {
+                          "summary": [
+                            {
+                              "kind": "text",
+                              "text": "The subscriber to grant permissions to."
+                            }
+                          ]
+                        },
+                        "type": {
+                          "type": "reference",
+                          "target": {
+                            "sourceFileName": "../realtime-common/cjs/build/types.d.ts",
+                            "qualifiedName": "Subscriber"
+                          },
+                          "name": "Subscriber",
+                          "package": "@wix/realtime-common"
+                        }
+                      }
+                    ],
+                    "type": {
+                      "type": "reference",
+                      "target": {
+                        "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
+                        "qualifiedName": "Promise"
+                      },
+                      "typeArguments": [
+                        {
+                          "type": "reflection",
+                          "declaration": {
+                            "id": 19,
+                            "name": "__type",
+                            "variant": "declaration",
+                            "kind": 65536,
+                            "flags": {},
+                            "children": [
+                              {
+                                "id": 20,
+                                "name": "read",
+                                "variant": "declaration",
+                                "kind": 1024,
+                                "flags": {},
+                                "type": {
+                                  "type": "intrinsic",
+                                  "name": "boolean"
+                                }
+                              },
+                              {
+                                "id": 21,
+                                "name": "write",
+                                "variant": "declaration",
+                                "kind": 1024,
+                                "flags": {},
+                                "type": {
+                                  "type": "intrinsic",
+                                  "name": "boolean"
+                                }
+                              }
+                            ],
+                            "groups": [
+                              {
+                                "title": "Properties",
+                                "children": [
+                                  20,
+                                  21
+                                ]
+                              }
+                            ]
+                          }
+                        }
+                      ],
+                      "name": "Promise",
+                      "package": "typescript"
+                    }
+                  }
+                ]
+              },
+              {
+                "id": 12,
+                "name": "default",
+                "variant": "declaration",
+                "kind": 2048,
+                "flags": {},
+                "signatures": [
+                  {
+                    "id": 13,
+                    "name": "default",
+                    "variant": "signature",
+                    "kind": 4096,
+                    "flags": {},
+                    "comment": {
+                      "summary": [],
+                      "blockTags": [
+                        {
+                          "tag": "@function",
+                          "content": [
+                            {
+                              "kind": "text",
+                              "text": "default"
+                            }
+                          ]
+                        },
+                        {
+                          "tag": "@summary",
+                          "content": [
+                            {
+                              "kind": "text",
+                              "text": "Sets a permissions handler for default permissions."
+                            }
+                          ]
+                        },
+                        {
+                          "tag": "@description",
+                          "content": [
+                            {
+                              "kind": "text",
+                              "text": "The handler set by the "
+                            },
+                            {
+                              "kind": "code",
+                              "text": "`default()`"
+                            },
+                            {
+                              "kind": "text",
+                              "text": " function is used for permission checks by the permissions\n router for all channels where an explicit handler has not been added. For channel resources,\n if no explicit handler has been set, the resource will inherit the permissions of its parent\n channel.\n\n For example, suppose you have the following channel, resources, and permissions:\n\n + channel: A, permissions: no handler specified\n + channel: A, resource: 1, permissions: no handler specified\n + channel: A, resource: 2, permissions: handler is specified\n\n\n Permissions will be checked as follows:\n\n + A: use the handler set by "
+                            },
+                            {
+                              "kind": "code",
+                              "text": "`default()`"
+                            },
+                            {
+                              "kind": "text",
+                              "text": " function\n + A, 1: use the handler set by "
+                            },
+                            {
+                              "kind": "code",
+                              "text": "`default()`"
+                            },
+                            {
+                              "kind": "text",
+                              "text": " function\n + A, 2: use the handler set by "
+                            },
+                            {
+                              "kind": "code",
+                              "text": "`add()`"
+                            },
+                            {
+                              "kind": "text",
+                              "text": " function for this resource\n\n\n If no default handler is set, subscribers to channels without explicit permissions handlers will\n receive the following permissions:\n "
+                            },
+                            {
+                              "kind": "code",
+                              "text": "`{\"read\": true}`"
+                            }
+                          ]
+                        }
+                      ]
+                    },
+                    "parameters": [
+                      {
+                        "id": 14,
+                        "name": "permissionHandler",
+                        "variant": "param",
+                        "kind": 32768,
+                        "flags": {},
+                        "comment": {
+                          "summary": [
+                            {
+                              "kind": "text",
+                              "text": "Handles setting of permissions for a subscriber on a channel or\n channel resource."
+                            }
+                          ]
+                        },
+                        "type": {
+                          "type": "reference",
+                          "target": {
+                            "sourceFileName": "../site/cjs/build/types.d.ts",
+                            "qualifiedName": "PermissionHandler"
+                          },
+                          "name": "PermissionHandler",
+                          "package": "@wix/sdk_realtime_site"
+                        }
+                      }
+                    ],
+                    "type": {
+                      "type": "intrinsic",
+                      "name": "void"
+                    }
+                  }
+                ]
+              }
+            ],
+            "groups": [
+              {
+                "title": "Methods",
+                "children": [
+                  8,
+                  15,
+                  12
+                ]
+              }
+            ]
+          },
+          {
+            "id": 22,
+            "name": "permissionsRouter",
+            "variant": "declaration",
+            "kind": 32,
+            "flags": {
+              "isConst": true
+            },
+            "comment": {
+              "summary": [
+                {
+                  "kind": "text",
+                  "text": "Implementation of the IPermissionsRouter interface."
+                }
+              ]
+            },
+            "type": {
+              "type": "reference",
+              "target": 7,
+              "name": "PermissionsRouter",
+              "package": "@wix/sdk_realtime_site"
+            }
+          },
+          {
+            "id": 2,
+            "name": "publish",
+            "variant": "declaration",
+            "kind": 64,
+            "flags": {
+              "isPublic": true
+            },
+            "signatures": [
+              {
+                "id": 3,
+                "name": "publish",
+                "variant": "signature",
+                "kind": 4096,
+                "flags": {},
+                "comment": {
+                  "summary": [
+                    {
+                      "kind": "text",
+                      "text": "The "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`publish()`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": " function publishes a message to the specified channel or\n channel resource.\n\n When site visitors subscribe to a channel, they do not\n receive messages published to a resource on that same channel. Similarly,\n when site visitors subscribe to a channel resource, they do not\n receive messages published to that same channel without a specified resource.\n\n To publish a message to specific users only, specify the users by ID in\n the "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`PublishOptions`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": " object sent to the "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`options`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": " parameter.\n\n To include the ID of the user who triggered the publish in the published message,\n set the "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`includePublisher`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": " property of the "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`PublishOptions`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": " object to "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`true`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": "."
+                    }
+                  ]
+                },
+                "parameters": [
+                  {
+                    "id": 4,
+                    "name": "channel",
+                    "variant": "param",
+                    "kind": 32768,
+                    "flags": {},
+                    "comment": {
+                      "summary": [
+                        {
+                          "kind": "text",
+                          "text": "The channel, and optionally the resource, to publish to."
+                        }
+                      ]
+                    },
+                    "type": {
+                      "type": "reference",
+                      "target": 43,
+                      "name": "Channel",
+                      "package": "@wix/realtime-common"
+                    }
+                  },
+                  {
+                    "id": 5,
+                    "name": "payload",
+                    "variant": "param",
+                    "kind": 32768,
+                    "flags": {},
+                    "comment": {
+                      "summary": [
+                        {
+                          "kind": "text",
+                          "text": "Message payload. <br /><br /> Max: 10kb"
+                        }
+                      ]
+                    },
+                    "type": {
+                      "type": "intrinsic",
+                      "name": "any"
+                    }
+                  },
+                  {
+                    "id": 6,
+                    "name": "options",
+                    "variant": "param",
+                    "kind": 32768,
+                    "flags": {
+                      "isOptional": true
+                    },
+                    "comment": {
+                      "summary": [
+                        {
+                          "kind": "text",
+                          "text": "Options to use when publishing."
+                        }
+                      ]
+                    },
+                    "type": {
+                      "type": "reference",
+                      "target": {
+                        "sourceFileName": "../realtime-common/cjs/build/types.d.ts",
+                        "qualifiedName": "PublishOptions"
+                      },
+                      "name": "PublishOptions",
+                      "package": "@wix/realtime-common"
+                    }
+                  }
+                ],
+                "type": {
+                  "type": "union",
+                  "types": [
+                    {
+                      "type": "intrinsic",
+                      "name": "void"
+                    },
+                    {
+                      "type": "reference",
+                      "target": {
+                        "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
+                        "qualifiedName": "Promise"
+                      },
+                      "typeArguments": [
+                        {
+                          "type": "intrinsic",
+                          "name": "void"
+                        }
+                      ],
+                      "name": "Promise",
+                      "package": "typescript"
+                    }
+                  ]
+                }
+              }
+            ]
+          }
+        ],
+        "groups": [
+          {
+            "title": "Interfaces",
+            "children": [
+              7
+            ]
+          },
+          {
+            "title": "Variables",
+            "children": [
+              22
+            ]
+          },
+          {
+            "title": "Functions",
+            "children": [
+              2
+            ]
+          }
+        ]
+      },
+      {
+        "id": 30,
+        "name": "subscriber",
+        "variant": "declaration",
+        "kind": 4,
+        "flags": {},
+        "children": [
+          {
+            "id": 31,
+            "name": "subscribe",
+            "variant": "declaration",
+            "kind": 64,
+            "flags": {},
+            "signatures": [
+              {
+                "id": 32,
+                "name": "subscribe",
+                "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,
+                    "name": "channel",
+                    "variant": "param",
+                    "kind": 32768,
+                    "flags": {},
+                    "comment": {
+                      "summary": [
+                        {
+                          "kind": "text",
+                          "text": "The channel, and optionally the resource, to subscribe to."
+                        }
+                      ]
+                    },
+                    "type": {
+                      "type": "reference",
+                      "target": 43,
+                      "name": "Channel",
+                      "package": "@wix/realtime-common"
+                    }
+                  },
+                  {
+                    "id": 34,
+                    "name": "messageHandler",
+                    "variant": "param",
+                    "kind": 32768,
+                    "flags": {},
+                    "comment": {
+                      "summary": [
+                        {
+                          "kind": "text",
+                          "text": "Callback invoked whenever a message is published to the channel."
+                        }
+                      ]
+                    },
+                    "type": {
+                      "type": "reference",
+                      "target": 49,
+                      "name": "MessageHandler",
+                      "package": "@wix/realtime-common"
+                    }
+                  },
+                  {
+                    "id": 35,
+                    "name": "options",
+                    "variant": "param",
+                    "kind": 32768,
+                    "flags": {
+                      "isOptional": true
+                    },
+                    "comment": {
+                      "summary": [
+                        {
+                          "kind": "text",
+                          "text": "Optional lifecycle handlers for subscription events."
+                        }
+                      ]
+                    },
+                    "type": {
+                      "type": "reference",
+                      "target": 66,
+                      "name": "SubscriptionOptions",
+                      "package": "@wix/realtime-common"
+                    }
+                  }
+                ],
+                "type": {
+                  "type": "intrinsic",
+                  "name": "string"
+                }
+              },
+              {
+                "id": 36,
+                "name": "subscribe",
+                "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": 37,
+                    "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": 38,
+            "name": "unsubscribe",
+            "variant": "declaration",
+            "kind": 64,
+            "flags": {},
+            "signatures": [
+              {
+                "id": 39,
+                "name": "unsubscribe",
+                "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,
+                    "name": "options",
+                    "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": 69,
+                      "name": "UnsubscribeOptions",
+                      "package": "@wix/realtime-common"
+                    }
+                  }
+                ],
+                "type": {
+                  "type": "intrinsic",
+                  "name": "void"
+                }
+              },
+              {
+                "id": 41,
+                "name": "unsubscribe",
+                "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": 42,
+                    "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": [
+              31,
+              38
+            ]
+          }
+        ]
+      },
+      {
+        "id": 86,
+        "name": "RealtimeErrorCode",
+        "variant": "declaration",
+        "kind": 8,
+        "flags": {},
+        "comment": {
+          "summary": [
+            {
+              "kind": "text",
+              "text": "Error codes for realtime errors."
+            }
+          ]
+        },
+        "children": [
+          {
+            "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
+        ]
+      }
+    ],
+    "packageName": "@wix/realtime",
+    "symbolIdMap": {}
+  },
+  "appendices": {},
+  "standaloneTypes": {},
+  "metadata": {}
+}