@wix/realtime 1.0.33 → 1.0.35

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

@@ -38,7 +38,7 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Publishes a message to a realtime channel.\n\nRequires a service identity (server-side only). The caller must have\napp-level permissions to publish messages."
+                      "text": "Publishes a message to a channel or resource.\n\nThe method publishes a message to all subscriptions on the specified channel or resource. Channels and resources are isolated, so subscribers to a channel don't receive messages published to a resource. Similarly, subscribers to a resource don't receive messages published to the parent channel.\n\n> **Authentication**\n>\n> This method may require higher-level permissions than the caller has, based on their [identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities) and [roles and permissions](https://support.wix.com/en/article/roles-permissions-overview). In these cases, you can ensure the method is called with the required level of authorization by using [elevated permissions](https://dev.wix.com/docs/api-reference/articles/authentication/about-elevated-permissions).\n\n<!-- TODO: Check whether this API is relevant for headless projects. -->"
                     }
                   ],
                   "blockTags": [
@@ -47,11 +47,11 @@
                       "content": [
                         {
                           "kind": "text",
-                          "text": "Manual client (self-hosted / explicit auth)\n"
+                          "text": "Publish a message to the specified channel\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```"
+                          "text": "```ts\nimport { publisher } from '@wix/realtime';\nimport { elevate } from '@wix/sdk/context';\n\nawait elevate(publisher.publish)({ name: 'my-channel' }, { message: 'hello' });\n```"
                         }
                       ]
                     },
@@ -60,11 +60,11 @@
                       "content": [
                         {
                           "kind": "text",
-                          "text": "Contextual client (Wix-hosted)\n"
+                          "text": "Publish a message to the specified channel: Self-hosted\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```"
+                          "text": "```ts\nimport { publisher } from '@wix/realtime';\nimport { createClient } from '@wix/sdk';\n\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst client = createClient({\n  modules: { publisher },\n  // Include the auth strategy and host as relevant\n});\n\nawait client.publisher.publish({ name: 'my-channel' }, { message: 'hello' });\n```"
                         }
                       ]
                     }
@@ -81,7 +81,7 @@
                       "summary": [
                         {
                           "kind": "text",
-                          "text": "The channel, and optionally the resource, to publish to."
+                          "text": "Channel or resource to publish to."
                         }
                       ]
                     },
@@ -102,7 +102,7 @@
                       "summary": [
                         {
                           "kind": "text",
-                          "text": "Message payload. Max: 10kb"
+                          "text": "Message payload. Max: 10 KB."
                         }
                       ]
                     },
@@ -153,7 +153,7 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Publishes a message to a realtime channel.\n\nRequires a service identity (server-side only). The caller must have\napp-level permissions to publish messages."
+                      "text": "Publishes a message to a channel or resource.\n\nThe method publishes a message to all subscriptions on the specified channel or resource. Channels and resources are isolated, so subscribers to a channel don't receive messages published to a resource. Similarly, subscribers to a resource don't receive messages published to the parent channel.\n\n> **Authentication**\n>\n> This method may require higher-level permissions than the caller has, based on their [identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities) and [roles and permissions](https://support.wix.com/en/article/roles-permissions-overview). In these cases, you can ensure the method is called with the required level of authorization by using [elevated permissions](https://dev.wix.com/docs/api-reference/articles/authentication/about-elevated-permissions).\n\n<!-- TODO: Check whether this API is relevant for headless projects. -->"
                     }
                   ],
                   "blockTags": [
@@ -162,11 +162,11 @@
                       "content": [
                         {
                           "kind": "text",
-                          "text": "Manual client (self-hosted / explicit auth)\n"
+                          "text": "Publish a message to the specified channel\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```"
+                          "text": "```ts\nimport { publisher } from '@wix/realtime';\nimport { elevate } from '@wix/sdk/context';\n\nawait elevate(publisher.publish)({ name: 'my-channel' }, { message: 'hello' });\n```"
                         }
                       ]
                     },
@@ -175,11 +175,11 @@
                       "content": [
                         {
                           "kind": "text",
-                          "text": "Contextual client (Wix-hosted)\n"
+                          "text": "Publish a message to the specified channel: Self-hosted\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```"
+                          "text": "```ts\nimport { publisher } from '@wix/realtime';\nimport { createClient } from '@wix/sdk';\n\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst client = createClient({\n  modules: { publisher },\n  // Include the auth strategy and host as relevant\n});\n\nawait client.publisher.publish({ name: 'my-channel' }, { message: 'hello' });\n```"
                         }
                       ]
                     }
@@ -249,7 +249,7 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "A router for defining and checking permissions.\n\nUse 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 ["
+                      "text": "Realtime permissions router.\n\nDefines which subscribers can receive messages on specific channels or resources. You can set permissions at the channel level as well as the resource level. When a resource isn't assigned explicit permissions, it inherits the permissions of its parent channel.\n\nUse the permissions router in the **realtime-permissions.js** file in the site's backend to:\n\n- Set default permissions for all channels that don't have explicit permissions.\n- Add permissions logic for specific channels or resources.\n- Check permissions for a subscriber on a channel or resource.\n\n> **Note:** You can also define permissions directly in the "
                     },
                     {
                       "kind": "code",
@@ -257,7 +257,7 @@
                     },
                     {
                       "kind": "text",
-                      "text": "](#realtime_check_permission) function."
+                      "text": " hook."
                     }
                   ]
                 },
@@ -279,23 +279,7 @@
                           "summary": [
                             {
                               "kind": "text",
-                              "text": "Sets a permissions handler for a specific channel or channel resource.\n\nThe 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 "
+                              "text": "Sets a permissions handler for a specific channel or resource.\n\nAdding a handler to a channel without specifying a resource applies the\nhandler to the channel itself and to any of its resources that don't have\ntheir own handler.\n\nFor example, given the following setup:\n\n+ channel: A, permissions: handler X (set with "
                             },
                             {
                               "kind": "code",
@@ -303,7 +287,7 @@
                             },
                             {
                               "kind": "text",
-                              "text": " function\n + channel: A, resource: 1, permissions: handler Y is specified using the "
+                              "text": ")\n+ channel: A, resource: 1, permissions: handler Y (set with "
                             },
                             {
                               "kind": "code",
@@ -311,7 +295,7 @@
                             },
                             {
                               "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"
+                              "text": ")\n+ channel: A, resource: 2, permissions: no handler\n\nPermissions are checked as follows:\n\n+ A: handler X\n+ A, resource 1: handler Y\n+ A, resource 2: handler X (inherited from channel)"
                             }
                           ],
                           "blockTags": [
@@ -364,7 +348,7 @@
                               "summary": [
                                 {
                                   "kind": "text",
-                                  "text": "Channel or channel resource to add a permissions handler for."
+                                  "text": "Channel or resource to set a permissions handler for."
                                 }
                               ]
                             },
@@ -385,7 +369,7 @@
                               "summary": [
                                 {
                                   "kind": "text",
-                                  "text": "The name of the\n function or the function expression to use when checking permissions for the specified channel."
+                                  "text": "Handler to run when checking permissions for the specified channel."
                                 }
                               ]
                             },
@@ -441,15 +425,7 @@
                           "summary": [
                             {
                               "kind": "text",
-                              "text": "Checks the permissions for a subscriber on a channel or channel resource.\n\nThe "
-                            },
-                            {
-                              "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    "
+                              "text": "Checks permissions for a subscriber on a channel or resource.\n\nThe resolution chain is:\n\n1. If a handler exists for the specified channel or resource, it runs and\n   its result is returned.\n1. If no handler exists for the resource, the parent channel's handler\n   runs instead.\n1. If no channel handler exists, the default handler runs.\n1. If no default handler is set, the built-in default permissions are\n   returned: "
                             },
                             {
                               "kind": "code",
@@ -457,7 +433,7 @@
                             },
                             {
                               "kind": "text",
-                              "text": "\n\n\n This function is typically called in the body of the\n ["
+                              "text": ".\n\nTypically, call this method in the body of the "
                             },
                             {
                               "kind": "code",
@@ -465,11 +441,11 @@
                             },
                             {
                               "kind": "text",
-                              "text": "](#realtime_check_permission) function like so:\n\n "
+                              "text": "\nfunction:\n\n"
                             },
                             {
                               "kind": "code",
-                              "text": "```JavaScript\n export function realtime_check_permission(channel, subscriber) {\n   return permissionsRouter.check(channel,subscriber);\n }\n ```"
+                              "text": "```JavaScript\nexport function realtime_check_permission(channel, subscriber) {\n  return permissionsRouter.check(channel, subscriber);\n}\n```"
                             }
                           ],
                           "blockTags": [
@@ -514,7 +490,7 @@
                               "content": [
                                 {
                                   "kind": "text",
-                                  "text": "The permissions granted to the subscriber on the channel or channel resource."
+                                  "text": "Permissions granted to the subscriber for the specified channel or resource."
                                 }
                               ]
                             },
@@ -549,7 +525,7 @@
                               "summary": [
                                 {
                                   "kind": "text",
-                                  "text": "Channel to check permissions for."
+                                  "text": "Channel or resource to check permissions for."
                                 }
                               ]
                             },
@@ -630,43 +606,39 @@
                           "summary": [
                             {
                               "kind": "text",
-                              "text": "Sets a permissions handler for default permissions.\n\nThe handler set by the "
+                              "text": "Sets the default permissions handler.\n\nThe default handler runs for all channels and resources where no explicit\nhandler has been added with "
                             },
                             {
                               "kind": "code",
-                              "text": "`default()`"
+                              "text": "`add()`"
                             },
                             {
                               "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 "
+                              "text": ". Resources without their own handler\ninherit the parent channel's handler before falling back to the default.\n\nFor example, given the following setup:\n\n+ channel: A, permissions: no handler\n+ channel: A, resource: 1, permissions: no handler\n+ channel: A, resource: 2, permissions: handler set with "
                             },
                             {
                               "kind": "code",
-                              "text": "`default()`"
+                              "text": "`add()`"
                             },
                             {
                               "kind": "text",
-                              "text": " function\n + A, 1: use the handler set by "
+                              "text": "\n\nPermissions are checked as follows:\n\n+ A: default handler\n+ A, resource 1: default handler\n+ A, resource 2: handler set with "
                             },
                             {
                               "kind": "code",
-                              "text": "`default()`"
+                              "text": "`add()`"
                             },
                             {
                               "kind": "text",
-                              "text": " function\n + A, 2: use the handler set by "
+                              "text": "\n\nIf no default handler is set, the built-in default permissions are used:\n"
                             },
                             {
                               "kind": "code",
-                              "text": "`add()`"
+                              "text": "`{\"read\": true}`"
                             },
                             {
                               "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}`"
+                              "text": "."
                             }
                           ],
                           "blockTags": [
@@ -701,7 +673,7 @@
                               "summary": [
                                 {
                                   "kind": "text",
-                                  "text": "The name of the\n function or the function expression to use when checking default permissions."
+                                  "text": "Handler to run when checking default permissions."
                                 }
                               ]
                             },
@@ -757,7 +729,15 @@
                           "summary": [
                             {
                               "kind": "text",
-                              "text": "undefined\n\nHandles setting of permissions for a subscriber on a channel or\n channel resource."
+                              "text": "Determines the permissions for a subscriber on a channel or resource. Return a "
+                            },
+                            {
+                              "kind": "code",
+                              "text": "`ChannelPermissions`"
+                            },
+                            {
+                              "kind": "text",
+                              "text": " object to grant or deny access."
                             }
                           ],
                           "blockTags": [
@@ -828,7 +808,7 @@
                               "summary": [
                                 {
                                   "kind": "text",
-                                  "text": "The channel to grant permissions to."
+                                  "text": "Channel or resource being checked."
                                 }
                               ]
                             },
@@ -849,7 +829,7 @@
                               "summary": [
                                 {
                                   "kind": "text",
-                                  "text": "The subscriber to grant permissions to."
+                                  "text": "Subscriber whose permissions are being checked."
                                 }
                               ]
                             },
@@ -911,23 +891,7 @@
                       "summary": [
                         {
                           "kind": "text",
-                          "text": "Sets a permissions handler for a specific channel or channel resource.\n\nThe 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 "
+                          "text": "Sets a permissions handler for a specific channel or resource.\n\nAdding a handler to a channel without specifying a resource applies the\nhandler to the channel itself and to any of its resources that don't have\ntheir own handler.\n\nFor example, given the following setup:\n\n+ channel: A, permissions: handler X (set with "
                         },
                         {
                           "kind": "code",
@@ -935,7 +899,7 @@
                         },
                         {
                           "kind": "text",
-                          "text": " function\n + channel: A, resource: 1, permissions: handler Y is specified using the "
+                          "text": ")\n+ channel: A, resource: 1, permissions: handler Y (set with "
                         },
                         {
                           "kind": "code",
@@ -943,7 +907,7 @@
                         },
                         {
                           "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"
+                          "text": ")\n+ channel: A, resource: 2, permissions: no handler\n\nPermissions are checked as follows:\n\n+ A: handler X\n+ A, resource 1: handler Y\n+ A, resource 2: handler X (inherited from channel)"
                         }
                       ],
                       "blockTags": [
@@ -996,7 +960,7 @@
                           "summary": [
                             {
                               "kind": "text",
-                              "text": "Channel or channel resource to add a permissions handler for."
+                              "text": "Channel or resource to set a permissions handler for."
                             }
                           ]
                         },
@@ -1017,7 +981,7 @@
                           "summary": [
                             {
                               "kind": "text",
-                              "text": "The name of the\n function or the function expression to use when checking permissions for the specified channel."
+                              "text": "Function to run when checking permissions for the specified channel."
                             }
                           ]
                         },
@@ -1064,15 +1028,7 @@
                       "summary": [
                         {
                           "kind": "text",
-                          "text": "Checks the permissions for a subscriber on a channel or channel resource.\n\nThe "
-                        },
-                        {
-                          "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    "
+                          "text": "Checks the permissions for a subscriber on a channel or resource.\n\nThe resolution chain is:\n\n1. If a handler exists for the specified channel or resource, it runs and\n   its result is returned.\n1. If no handler exists for the resource, the parent channel's handler\n   runs instead.\n1. If no channel handler exists, the default handler runs.\n1. If no default handler is set, the built-in default permissions are\n   returned: "
                         },
                         {
                           "kind": "code",
@@ -1080,7 +1036,7 @@
                         },
                         {
                           "kind": "text",
-                          "text": "\n\n\n This function is typically called in the body of the\n ["
+                          "text": ".\n\nTypically, call this method in the body of the "
                         },
                         {
                           "kind": "code",
@@ -1088,11 +1044,11 @@
                         },
                         {
                           "kind": "text",
-                          "text": "](#realtime_check_permission) function like so:\n\n "
+                          "text": "\nfunction:\n\n"
                         },
                         {
                           "kind": "code",
-                          "text": "```JavaScript\n export function realtime_check_permission(channel, subscriber) {\n   return permissionsRouter.check(channel,subscriber);\n }\n ```"
+                          "text": "```JavaScript\nexport function realtime_check_permission(channel, subscriber) {\n  return permissionsRouter.check(channel, subscriber);\n}\n```"
                         }
                       ],
                       "blockTags": [
@@ -1137,7 +1093,7 @@
                           "content": [
                             {
                               "kind": "text",
-                              "text": "The permissions granted to the subscriber on the channel or channel resource."
+                              "text": "Permissions granted to the subscriber for the specified channel or resource."
                             }
                           ]
                         },
@@ -1172,7 +1128,7 @@
                           "summary": [
                             {
                               "kind": "text",
-                              "text": "Channel to check permissions for."
+                              "text": "Channel or resource to check permissions for."
                             }
                           ]
                         },
@@ -1242,43 +1198,39 @@
                       "summary": [
                         {
                           "kind": "text",
-                          "text": "Sets a permissions handler for default permissions.\n\nThe handler set by the "
+                          "text": "Sets the default permissions handler.\n\nThe default handler runs for all channels and resources where no explicit\nhandler has been added with "
                         },
                         {
                           "kind": "code",
-                          "text": "`default()`"
+                          "text": "`add()`"
                         },
                         {
                           "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 "
+                          "text": ". Resources without their own handler\ninherit the parent channel's handler before falling back to the default.\n\nFor example, given the following setup:\n\n+ channel: A, permissions: no handler\n+ channel: A, resource: 1, permissions: no handler\n+ channel: A, resource: 2, permissions: handler set with "
                         },
                         {
                           "kind": "code",
-                          "text": "`default()`"
+                          "text": "`add()`"
                         },
                         {
                           "kind": "text",
-                          "text": " function\n + A, 1: use the handler set by "
+                          "text": "\n\nPermissions are checked as follows:\n\n+ A: default handler\n+ A, resource 1: default handler\n+ A, resource 2: handler set with "
                         },
                         {
                           "kind": "code",
-                          "text": "`default()`"
+                          "text": "`add()`"
                         },
                         {
                           "kind": "text",
-                          "text": " function\n + A, 2: use the handler set by "
+                          "text": "\n\nIf no default handler is set, the built-in default permissions are used:\n"
                         },
                         {
                           "kind": "code",
-                          "text": "`add()`"
+                          "text": "`{\"read\": true}`"
                         },
                         {
                           "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}`"
+                          "text": "."
                         }
                       ],
                       "blockTags": [
@@ -1313,7 +1265,7 @@
                           "summary": [
                             {
                               "kind": "text",
-                              "text": "The name of the\n function or the function expression to use when checking default permissions."
+                              "text": "Function to run when checking default permissions."
                             }
                           ]
                         },
@@ -1366,7 +1318,7 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "An object representing a realtime channel."
+                  "text": "Realtime broadcast channel. Publishers send messages to channels and subscribers listen to them."
                 }
               ]
             },
@@ -1381,7 +1333,7 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Channel name. Only alphanumeric characters, hyphens, and underscores are allowed.\nThe combined length of "
+                      "text": "Channel name.\n\n> **Notes:**\n> - Supports only alphanumeric characters, hyphens, and underscores.\n> - The combined length of "
                     },
                     {
                       "kind": "code",
@@ -1397,7 +1349,7 @@
                     },
                     {
                       "kind": "text",
-                      "text": " cannot exceed 140 characters."
+                      "text": " can't exceed 140 characters."
                     }
                   ]
                 },
@@ -1418,7 +1370,7 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "ID of a specific channel resource."
+                      "text": "Resource ID.\n\nResources are isolated sub-channels in a channel. A subscriber listening to a resource doesn't receive messages published to the parent channel, and vice versa."
                     }
                   ]
                 },
@@ -1448,7 +1400,7 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "An object containing permission settings for a channel."
+                  "text": "Permissions for a subscriber on a channel or resource."
                 }
               ]
             },
@@ -1465,7 +1417,7 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Whether the subscriber has read permissions. Defaults to "
+                      "text": "Whether the subscriber can receive messages on the channel.\n\nDefault: "
                     },
                     {
                       "kind": "code",
@@ -1581,7 +1533,7 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "An object representing a channel subscriber."
+                  "text": "Subscriber to a channel or resource.\n\nWix checks [subscriber permissions](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/realtime-check-permission) before they can listen to messages."
                 }
               ]
             },
@@ -1596,7 +1548,7 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "The subscriber's user ID."
+                      "text": "Subscriber ID."
                     }
                   ],
                   "blockTags": [
@@ -1626,7 +1578,7 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "The type of subscriber."
+                      "text": "Subscriber identity type.\n\nLearn more about [Wix identities](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities)."
                     }
                   ],
                   "blockTags": [
@@ -1674,7 +1626,7 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "Returns the realtime permissions router.\n\nUse 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 ["
+                  "text": "Realtime permissions router.\n\nDefines which subscribers can receive messages on specific channels or resources. You can set permissions at the channel level as well as the resource level. When a resource isn't assigned explicit permissions, it inherits the permissions of its parent channel.\n\nUse the permissions router in the **realtime-permissions.js** file in the site's backend to:\n\n- Set default permissions for all channels that don't have explicit permissions.\n- Add permissions logic for specific channels or resources.\n- Check permissions for a subscriber on a channel or resource.\n\n> **Note:** You can also define permissions directly in the ["
                 },
                 {
                   "kind": "code",
@@ -1682,7 +1634,7 @@
                 },
                 {
                   "kind": "text",
-                  "text": "](#realtime_check_permission) function."
+                  "text": "](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/realtime-check-permission) hook."
                 }
               ],
               "blockTags": [
@@ -1721,23 +1673,7 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Publishes a message to a channel or channel resource.\n\nThe "
-                    },
-                    {
-                      "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 "
+                      "text": "Publishes a message to a channel or resource.\n\nSubscribers to a channel don't receive messages published to a resource on\nthat channel, and vice versa.\n\nTo publish a message to specific users only, specify the users by ID in\nthe "
                     },
                     {
                       "kind": "code",
@@ -1745,7 +1681,7 @@
                     },
                     {
                       "kind": "text",
-                      "text": " parameter.\n\n To include the ID of the user who triggered the publish in the published message,\n set the "
+                      "text": " parameter. To include the publisher's identity in the message,\nset "
                     },
                     {
                       "kind": "code",
@@ -1753,23 +1689,23 @@
                     },
                     {
                       "kind": "text",
-                      "text": " property of the "
+                      "text": " to "
                     },
                     {
                       "kind": "code",
-                      "text": "`PublishOptions`"
+                      "text": "`true`"
                     },
                     {
                       "kind": "text",
-                      "text": " object to "
+                      "text": " in the "
                     },
                     {
                       "kind": "code",
-                      "text": "`true`"
+                      "text": "`options`"
                     },
                     {
                       "kind": "text",
-                      "text": "."
+                      "text": " parameter."
                     }
                   ],
                   "blockTags": [
@@ -1782,11 +1718,11 @@
                         },
                         {
                           "kind": "code",
-                          "text": "`publisher.publish`"
+                          "text": "`publisher.publish()`"
                         },
                         {
                           "kind": "text",
-                          "text": " from "
+                          "text": " from the "
                         },
                         {
                           "kind": "code",
@@ -1794,7 +1730,7 @@
                         },
                         {
                           "kind": "text",
-                          "text": " instead."
+                          "text": " module instead."
                         }
                       ]
                     },
@@ -1839,15 +1775,7 @@
                       "content": [
                         {
                           "kind": "text",
-                          "text": "When the message is published to the channel or channel resource, "
-                        },
-                        {
-                          "kind": "code",
-                          "text": "`void`"
-                        },
-                        {
-                          "kind": "text",
-                          "text": " is returned. Does not indicate that the message was received."
+                          "text": "Resolves when the message is published. Doesn't indicate that the message was received by subscribers."
                         }
                       ]
                     }
@@ -1864,7 +1792,7 @@
                       "summary": [
                         {
                           "kind": "text",
-                          "text": "The channel, and optionally the resource, to\n publish to."
+                          "text": "Channel, and optionally resource, to publish to."
                         }
                       ]
                     },
@@ -1885,7 +1813,7 @@
                       "summary": [
                         {
                           "kind": "text",
-                          "text": "Message payload.\n Max: 10kb"
+                          "text": "Message payload. Max: 10 KB."
                         }
                       ]
                     },
@@ -1906,7 +1834,7 @@
                       "summary": [
                         {
                           "kind": "text",
-                          "text": "Options to use when publishing."
+                          "text": "Options for publishing, such as targeting specific users."
                         }
                       ]
                     },
@@ -1953,47 +1881,47 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Checks permissions for a subscriber on a channel or channel resource.\n\nThe "
+                      "text": "Checks permissions for a subscriber on a channel or resource.\n\nThis handler runs automatically whenever a new subscription is attempted. Define it as a named export in the **realtime-permissions.js** file in the site's backend.\n\n> **Notes:**\n>\n> - When this handler isn't defined, all subscribers are assigned the default permissions of "
                     },
                     {
                       "kind": "code",
-                      "text": "`realtime_check_permission`"
+                      "text": "`\"read\": true`"
                     },
                     {
                       "kind": "text",
-                      "text": " hook is triggered when a site visitor subscribes\n to a channel to check what permissions the subscriber will have.\n\n The "
+                      "text": ".\n> - When previewing the site, "
                     },
                     {
                       "kind": "code",
-                      "text": "`realtime_check_permission()`"
+                      "text": "`read`"
                     },
                     {
                       "kind": "text",
-                      "text": " function is not a function that you call from\n your code. You define the function in a file named **realtime-permissions.js**\n in your site's Backend section.\n\n\n\n__Important:__\n- If this function isn't defined, all subscribers will receive the default permissions: "
+                      "text": " permissions are always set to "
                     },
                     {
                       "kind": "code",
-                      "text": "`{\"read\": true}`"
+                      "text": "`true`"
                     },
                     {
                       "kind": "text",
-                      "text": ".\n- In Wix Studio, you don't need to define this function, but you must create a backend file named **realtime-permissions.js**. Without this file, subscriptions will fail.\n\n\n\n\n Implement permissions logic for channels and subscribers by either:\n\n + Including all permissions logic in the body of this function.\n + Use the "
+                      "text": ".\n> - In Wix Studio, you don't need to define this handler. However, you must create the **realtime-permissions.js** file. Without it, all subscriptions fail.\n\nYou can set up permissions logic by:\n\n- Including all permissions logic directly in the handler body.\n- Defining permissions logic per channel or resource with "
                     },
                     {
                       "kind": "code",
-                      "text": "`PermissionsRouter`"
+                      "text": "`permissionsRouter.add()`"
                     },
                     {
                       "kind": "text",
-                      "text": " to add permissions\n   logic per channel. Then call ["
+                      "text": ", then calling "
                     },
                     {
                       "kind": "code",
-                      "text": "`check()`"
+                      "text": "`permissionsRouter.check()`"
                     },
                     {
                       "kind": "text",
-                      "text": "](https://dev.wix.com/docs/sdk/backend-modules/realtime/site/permissions-router/check) in the body of\n   this function and return the permissions object it returns.\n\n\n> **Note:** When previewing your site, permissions for read are always granted."
+                      "text": " to evaluate each subscription request."
                     }
                   ],
                   "blockTags": [
@@ -2038,7 +1966,7 @@
                       "content": [
                         {
                           "kind": "text",
-                          "text": "The permissions granted to the subscriber on the channel or channel resource."
+                          "text": "Permissions granted to the subscriber for the specified channel or resource."
                         }
                       ]
                     },
@@ -2073,7 +2001,7 @@
                       "summary": [
                         {
                           "kind": "text",
-                          "text": "The channel, and optionally the resource,\n to check permissions for."
+                          "text": "Channel and resource to check permissions for."
                         }
                       ]
                     },
@@ -2094,7 +2022,7 @@
                       "summary": [
                         {
                           "kind": "text",
-                          "text": "The subscriber to check permissions\n for."
+                          "text": "Subscriber to check permissions for."
                         }
                       ]
                     },
@@ -2182,7 +2110,7 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Subscribe to a channel. Returns a subscriptionId immediately; the\nactual connection is established asynchronously in the background. Use the\noptional "
+                      "text": "Subscribes to a channel or resource.\n\nThe method attempts to establish a subscription to the specified channel or resource. While the subscription is attempted asynchronously, the method returns the subscription ID immediately.\n\nUse the "
                     },
                     {
                       "kind": "code",
@@ -2190,7 +2118,15 @@
                     },
                     {
                       "kind": "text",
-                      "text": " parameter to handle subscription lifecycle events."
+                      "text": " parameter to register handlers that run whenever the subscription succeeds or generates an error. For some errors, the subscription is re-attempted automatically. The "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`onSubscribed()`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": " handler runs on every successful re-subscription."
                     }
                   ],
                   "blockTags": [
@@ -2199,11 +2135,11 @@
                       "content": [
                         {
                           "kind": "text",
-                          "text": "Manual client (self-hosted / explicit auth)\n"
+                          "text": "Subscribe to a channel\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```"
+                          "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```"
                         }
                       ]
                     },
@@ -2212,11 +2148,11 @@
                       "content": [
                         {
                           "kind": "text",
-                          "text": "Contextual client (Wix-hosted)\n"
+                          "text": "Subscribe to a channel: Self-hosted\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```"
+                          "text": "```ts\nimport { createClient } from '@wix/sdk';\nimport { subscriber } from '@wix/realtime';\n\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst client = createClient({\n  modules: { subscriber },\n  // Include the auth strategy and host as relevant\n});\n\nconst subscriptionId = client.subscriber.subscribe(\n  { name: 'my-channel' },\n  (message, channel) => {\n    console.log('Received:', message.payload);\n  },\n  {\n    onSubscribed: (id, isSynced) => console.log('Subscribed', id),\n    onSubscriptionError: (error, id) => console.error('Error', error),\n  },\n);\n```"
                         }
                       ]
                     }
@@ -2233,7 +2169,7 @@
                       "summary": [
                         {
                           "kind": "text",
-                          "text": "The channel, and optionally the resource, to subscribe to."
+                          "text": "Channel, and optionally resource, to subscribe to."
                         }
                       ]
                     },
@@ -2254,7 +2190,7 @@
                       "summary": [
                         {
                           "kind": "text",
-                          "text": "Callback invoked whenever a message is published to the channel."
+                          "text": "Callback that runs whenever a message is published to the channel."
                         }
                       ]
                     },
@@ -2277,7 +2213,7 @@
                       "summary": [
                         {
                           "kind": "text",
-                          "text": "Optional lifecycle handlers for subscription events."
+                          "text": "Lifecycle handlers for subscription events."
                         }
                       ]
                     },
@@ -2304,7 +2240,7 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Subscribe to a channel. Returns a subscriptionId immediately; the\nactual connection is established asynchronously in the background. Use the\noptional "
+                      "text": "Subscribes to a channel or resource.\n\nThe method attempts to establish a subscription to the specified channel or resource. While the subscription is attempted asynchronously, the method returns the subscription ID immediately.\n\nUse the "
                     },
                     {
                       "kind": "code",
@@ -2312,7 +2248,15 @@
                     },
                     {
                       "kind": "text",
-                      "text": " parameter to handle subscription lifecycle events."
+                      "text": " parameter to register handlers that run whenever the subscription succeeds or generates an error. For some errors, the subscription is re-attempted automatically. The "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`onSubscribed()`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": " handler runs on every successful re-subscription."
                     }
                   ],
                   "blockTags": [
@@ -2321,11 +2265,11 @@
                       "content": [
                         {
                           "kind": "text",
-                          "text": "Manual client (self-hosted / explicit auth)\n"
+                          "text": "Subscribe to a channel\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```"
+                          "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```"
                         }
                       ]
                     },
@@ -2334,11 +2278,11 @@
                       "content": [
                         {
                           "kind": "text",
-                          "text": "Contextual client (Wix-hosted)\n"
+                          "text": "Subscribe to a channel: Self-hosted\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```"
+                          "text": "```ts\nimport { createClient } from '@wix/sdk';\nimport { subscriber } from '@wix/realtime';\n\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst client = createClient({\n  modules: { subscriber },\n  // Include the auth strategy and host as relevant\n});\n\nconst subscriptionId = client.subscriber.subscribe(\n  { name: 'my-channel' },\n  (message, channel) => {\n    console.log('Received:', message.payload);\n  },\n  {\n    onSubscribed: (id, isSynced) => console.log('Subscribed', id),\n    onSubscriptionError: (error, id) => console.error('Error', error),\n  },\n);\n```"
                         }
                       ]
                     }
@@ -2391,7 +2335,7 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Unsubscribe from a subscription by its ID, by channel, or both.\n\nYou can unsubscribe in three ways:\n- By "
+                      "text": "Removes 1 or more subscriptions.\n\nYou can unsubscribe in 3 ways:\n- By "
                     },
                     {
                       "kind": "code",
@@ -2399,7 +2343,7 @@
                     },
                     {
                       "kind": "text",
-                      "text": " — removes a single subscription.\n- By "
+                      "text": ": removes a single subscription.\n- By "
                     },
                     {
                       "kind": "code",
@@ -2407,7 +2351,7 @@
                     },
                     {
                       "kind": "text",
-                      "text": " — removes all subscriptions to that channel.\n- By both — removes the specific subscription, verifying it matches the channel."
+                      "text": ": removes all subscriptions to that channel or resource.\n- By both: removes the specific subscription, verifying it matches the channel.\n\nWhen the last subscription on a connection is removed, the connection\ncloses automatically."
                     }
                   ],
                   "blockTags": [
@@ -2416,11 +2360,11 @@
                       "content": [
                         {
                           "kind": "text",
-                          "text": "Manual client (self-hosted / explicit auth)\n"
+                          "text": "Remove the specified subscription.\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```"
+                          "text": "```ts\nimport { subscriber } from '@wix/realtime';\n\nsubscriber.unsubscribe({ subscriptionId });\n```"
                         }
                       ]
                     },
@@ -2429,11 +2373,11 @@
                       "content": [
                         {
                           "kind": "text",
-                          "text": "Contextual client (Wix-hosted)\n"
+                          "text": "Remove the specified subscription: Self-hosted\n"
                         },
                         {
                           "kind": "code",
-                          "text": "```ts\nimport { subscriber } from '@wix/realtime';\n\nsubscriber.unsubscribe({ subscriptionId });\n```"
+                          "text": "```ts\nimport { subscriber } from '@wix/realtime';\nimport { createClient } from '@wix/sdk';\n\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst client = createClient({\n  modules: { subscriber },\n  // Include the auth strategy and host as relevant\n});\n\n// Remove the specified subscription\nclient.subscriber.unsubscribe({ subscriptionId });\n\n// Remove all subscriptions from the specified channel\nclient.subscriber.unsubscribe({ channel: { name: 'my-channel' } });\n```"
                         }
                       ]
                     }
@@ -2450,7 +2394,23 @@
                       "summary": [
                         {
                           "kind": "text",
-                          "text": "Identifies what to unsubscribe from — by subscription ID, channel, or both."
+                          "text": "Unsubscribe information. You must specify "
+                        },
+                        {
+                          "kind": "code",
+                          "text": "`channel`"
+                        },
+                        {
+                          "kind": "text",
+                          "text": ", "
+                        },
+                        {
+                          "kind": "code",
+                          "text": "`subscriptionId`"
+                        },
+                        {
+                          "kind": "text",
+                          "text": ", or both."
                         }
                       ]
                     },
@@ -2477,7 +2437,7 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Unsubscribe from a subscription by its ID, by channel, or both.\n\nYou can unsubscribe in three ways:\n- By "
+                      "text": "Removes 1 or more subscriptions.\n\nYou can unsubscribe in 3 ways:\n- By "
                     },
                     {
                       "kind": "code",
@@ -2485,7 +2445,7 @@
                     },
                     {
                       "kind": "text",
-                      "text": " — removes a single subscription.\n- By "
+                      "text": ": removes a single subscription.\n- By "
                     },
                     {
                       "kind": "code",
@@ -2493,7 +2453,7 @@
                     },
                     {
                       "kind": "text",
-                      "text": " — removes all subscriptions to that channel.\n- By both — removes the specific subscription, verifying it matches the channel."
+                      "text": ": removes all subscriptions to that channel or resource.\n- By both: removes the specific subscription, verifying it matches the channel.\n\nWhen the last subscription on a connection is removed, the connection\ncloses automatically."
                     }
                   ],
                   "blockTags": [
@@ -2502,11 +2462,11 @@
                       "content": [
                         {
                           "kind": "text",
-                          "text": "Manual client (self-hosted / explicit auth)\n"
+                          "text": "Remove the specified subscription.\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```"
+                          "text": "```ts\nimport { subscriber } from '@wix/realtime';\n\nsubscriber.unsubscribe({ subscriptionId });\n```"
                         }
                       ]
                     },
@@ -2515,11 +2475,11 @@
                       "content": [
                         {
                           "kind": "text",
-                          "text": "Contextual client (Wix-hosted)\n"
+                          "text": "Remove the specified subscription: Self-hosted\n"
                         },
                         {
                           "kind": "code",
-                          "text": "```ts\nimport { subscriber } from '@wix/realtime';\n\nsubscriber.unsubscribe({ subscriptionId });\n```"
+                          "text": "```ts\nimport { subscriber } from '@wix/realtime';\nimport { createClient } from '@wix/sdk';\n\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst client = createClient({\n  modules: { subscriber },\n  // Include the auth strategy and host as relevant\n});\n\n// Remove the specified subscription\nclient.subscriber.unsubscribe({ subscriptionId });\n\n// Remove all subscriptions from the specified channel\nclient.subscriber.unsubscribe({ channel: { name: 'my-channel' } });\n```"
                         }
                       ]
                     }
@@ -2576,7 +2536,7 @@
           "summary": [
             {
               "kind": "text",
-              "text": "Error codes for realtime errors."
+              "text": "Error codes."
             }
           ]
         },
@@ -2591,7 +2551,7 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "Invalid input (e.g. bad channel name)."
+                  "text": "Invalid input such as a channel name with unsupported characters."
                 }
               ]
             },
@@ -2610,7 +2570,7 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "A connection attempt failed. The client keeps retrying automatically."
+                  "text": "Connection attempt failed. Wix automatically attempts to establish the subscription."
                 }
               ]
             },
@@ -2629,7 +2589,15 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "The connection was closed, either intentionally or due to an error."
+                  "text": "Connection closed intentionally or due to an error. Check "
+                },
+                {
+                  "kind": "code",
+                  "text": "`error.recoverable`"
+                },
+                {
+                  "kind": "text",
+                  "text": " to determine whether the client is attempting to reconnect. Learn more about [realtime SDK errors](ADDLINK)."
                 }
               ]
             },
@@ -2648,7 +2616,7 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "The subscription request failed (e.g. authorization error)."
+                  "text": "Subscription request rejected, for example, due to an authorization failure. This error is non-recoverable."
                 }
               ]
             },
@@ -2680,7 +2648,7 @@
           "summary": [
             {
               "kind": "text",
-              "text": "An object representing an error."
+              "text": "Error thrown by a subscription or connection."
             }
           ]
         },
@@ -2827,7 +2795,7 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "Channel related to the error."
+                  "text": "Channel that caused the error."
                 }
               ]
             },
@@ -2871,7 +2839,7 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "Whether the error is recoverable. When "
+                  "text": "Whether the error is automatically recoverable.\n\nWhen "
                 },
                 {
                   "kind": "code",
@@ -2879,7 +2847,7 @@
                 },
                 {
                   "kind": "text",
-                  "text": ", the client is\nautomatically attempting to reconnect. When "
+                  "text": ", the client automatically attempts to reconnect. When "
                 },
                 {
                   "kind": "code",
@@ -2887,7 +2855,15 @@
                 },
                 {
                   "kind": "text",
-                  "text": ", user action\nis required (for example, the subscription must be re-created)."
+                  "text": ", you must attempt to re-subscribe manually.\n\nDefault: "
+                },
+                {
+                  "kind": "code",
+                  "text": "`false`"
+                },
+                {
+                  "kind": "text",
+                  "text": "."
                 }
               ]
             },
@@ -2908,7 +2884,23 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "HTTP status code from the server response.\nPresent on subscription failed errors (e.g. 401, 403, 500)."
+                  "text": "[HTTP status code](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/troubleshooting/about-errors#http-status-codes).\n\nReturned only when "
+                },
+                {
+                  "kind": "code",
+                  "text": "`errorCode`"
+                },
+                {
+                  "kind": "text",
+                  "text": " is "
+                },
+                {
+                  "kind": "code",
+                  "text": "`SUBSCRIPTION_FAILED`"
+                },
+                {
+                  "kind": "text",
+                  "text": "."
                 }
               ]
             },
@@ -2957,7 +2949,7 @@
           "summary": [
             {
               "kind": "text",
-              "text": "An object representing a published message."
+              "text": "Message received on a channel."
             }
           ]
         },
@@ -2972,7 +2964,7 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "Message payload.\nMax: 10kb"
+                  "text": "Message payload that contains the published data.\n\nMax: 10 KB."
                 }
               ]
             },
@@ -3008,7 +3000,7 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "Message publisher, if sent."
+                  "text": "Publisher details.\n\nReturned only when the publisher's identity is available."
                 }
               ]
             },
@@ -3040,7 +3032,7 @@
           "summary": [
             {
               "kind": "text",
-              "text": "An object representing a publisher."
+              "text": "Publisher details."
             }
           ]
         },
@@ -3055,7 +3047,7 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "ID of the publisher."
+                  "text": "Publisher ID.\n\n<!-- TODO: Where does the caller get the publisher ID? -->"
                 }
               ]
             },
@@ -3084,7 +3076,7 @@
           "summary": [
             {
               "kind": "text",
-              "text": "An object containing optional lifecycle handlers for a subscription."
+              "text": "Subscription status handlers that run whenever a subscription is established, re-established, or fails."
             }
           ]
         },
@@ -3101,7 +3093,7 @@
               "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 "
+                  "text": "Runs whenever the subscription is successfully established or re-established after a prior failure. To avoid unnecessary actions, make the handler idempotent.\n\nThe "
                 },
                 {
                   "kind": "code",
@@ -3109,31 +3101,7 @@
                 },
                 {
                   "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."
+                  "text": " parameter indicates whether missed messages were restored."
                 }
               ],
               "blockTags": [
@@ -3143,7 +3111,7 @@
                   "content": [
                     {
                       "kind": "text",
-                      "text": "The ID of the subscription that was established."
+                      "text": "ID of the subscription."
                     }
                   ]
                 },
@@ -3153,7 +3121,55 @@
                   "content": [
                     {
                       "kind": "text",
-                      "text": "Whether the server successfully restored missed messages."
+                      "text": "Whether the server successfully restored missed messages since the last disconnection.\n\nThe value of this parameter depends on the scenario:\n\n- When subscribing for the first time, "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`isSynced`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": " is "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`false`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": ", as there are no prior messages to restore. In this scenario, load your initial state independently.\n\n- When re-subscribing and all messages were successfully restored, "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`isSynced`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": " is "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`true`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": ". No further action is necessary.\n\n- When re-subscribing but some messages weren't restored, "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`isSynced`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": " is "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`false`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": ". The server is unable to restore all missed messages. In this scenario, you need to resync your state independently.\n\n<!-- TODO: Document server-side buffer limits for message replay. -->"
                     }
                   ]
                 }
@@ -3178,31 +3194,15 @@
               "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 "
+                  "text": "Runs when a subscription error occurs. It can run multiple times in a single session.\n\nThis handler runs in the following scenarios:\n\n- **Subscription failed**: The subscription request was rejected, for example, due to an authorization failure. This error is non-recoverable, so the subscription isn't automatically re-attempted.\n\n- **Subscription disconnected**: The connection between the subscriber and publisher was closed. Check "
                 },
                 {
                   "kind": "code",
-                  "text": "`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`"
+                  "text": "`error.recoverable`"
                 },
                 {
                   "kind": "text",
-                  "text": " flag\n  on the error indicates whether the client will auto-reconnect\n  ("
+                  "text": ":\n   - When "
                 },
                 {
                   "kind": "code",
@@ -3210,7 +3210,7 @@
                 },
                 {
                   "kind": "text",
-                  "text": ") or whether manual action is required ("
+                  "text": ", the error is recoverable. The subscription is automatically re-attempted. No further action necessary.\n   - When "
                 },
                 {
                   "kind": "code",
@@ -3218,11 +3218,11 @@
                 },
                 {
                   "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 "
+                  "text": ", the error isn't recoverable. Establish the subscription again.\n\n- **Connection error**: Runs on each failed subscription attempt. The "
                 },
                 {
                   "kind": "code",
-                  "text": "`recoverable`"
+                  "text": "`error.recoverable`"
                 },
                 {
                   "kind": "text",
@@ -3234,31 +3234,7 @@
                 },
                 {
                   "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."
+                  "text": ", as the subscription is re-established."
                 }
               ],
               "blockTags": [
@@ -3268,39 +3244,23 @@
                   "content": [
                     {
                       "kind": "text",
-                      "text": "The error that occurred, including "
+                      "text": "Error that occurred. Check "
                     },
                     {
                       "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`"
+                      "text": "`recoverable`"
                     },
                     {
                       "kind": "text",
-                      "text": "."
+                      "text": " to determine the type and whether manual action is required."
                     }
                   ]
                 },
@@ -3310,7 +3270,7 @@
                   "content": [
                     {
                       "kind": "text",
-                      "text": "The ID of the affected subscription."
+                      "text": "ID of the subscription that generated the error."
                     }
                   ]
                 }
@@ -3344,7 +3304,39 @@
           "summary": [
             {
               "kind": "text",
-              "text": "An object containing options to be used when unsubscribing from a\nchannel or channel resource."
+              "text": "Unsubscribe options. Specify "
+            },
+            {
+              "kind": "code",
+              "text": "`channel`"
+            },
+            {
+              "kind": "text",
+              "text": ", "
+            },
+            {
+              "kind": "code",
+              "text": "`subscriptionId`"
+            },
+            {
+              "kind": "text",
+              "text": ", or both:\n\n- To remove all subscriptions from a channel, specify the channel in "
+            },
+            {
+              "kind": "code",
+              "text": "`channel.name`"
+            },
+            {
+              "kind": "text",
+              "text": ".\n- To remove a single subscription, specify the "
+            },
+            {
+              "kind": "code",
+              "text": "`subscriptionId`"
+            },
+            {
+              "kind": "text",
+              "text": ".\n- To remove a single subscription with channel verification, specify both. This removes the specified subscription only if it listens to the specified channel."
             }
           ]
         },
@@ -3361,7 +3353,7 @@
               "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."
+                  "text": "Channel or resource to unsubscribe from.\n\nWhen empty, the subscription is removed without verifying that it belongs to the channel."
                 }
               ]
             },
@@ -3384,7 +3376,7 @@
               "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."
+                  "text": "ID of the subscription to remove.\n\nWhen empty, all subscriptions to the specified channel are removed."
                 }
               ]
             },
@@ -3429,7 +3421,7 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Handles a message published to a channel or channel resource."
+                      "text": "Runs when a message is published to a channel or resource the subscriber listens to."
                     }
                   ]
                 },
@@ -3440,6 +3432,14 @@
                     "variant": "param",
                     "kind": 32768,
                     "flags": {},
+                    "comment": {
+                      "summary": [
+                        {
+                          "kind": "text",
+                          "text": "Published message."
+                        }
+                      ]
+                    },
                     "type": {
                       "type": "reference",
                       "target": 73,
@@ -3453,6 +3453,14 @@
                     "variant": "param",
                     "kind": 32768,
                     "flags": {},
+                    "comment": {
+                      "summary": [
+                        {
+                          "kind": "text",
+                          "text": "Channel the message was published to."
+                        }
+                      ]
+                    },
                     "type": {
                       "type": "reference",
                       "target": 31,
@@ -3495,7 +3503,7 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Handles a subscription error event."
+                      "text": "Runs when a subscription error occurs."
                     }
                   ]
                 },
@@ -3506,6 +3514,14 @@
                     "variant": "param",
                     "kind": 32768,
                     "flags": {},
+                    "comment": {
+                      "summary": [
+                        {
+                          "kind": "text",
+                          "text": "Error that occurred."
+                        }
+                      ]
+                    },
                     "type": {
                       "type": "reference",
                       "target": 99,
@@ -3519,6 +3535,14 @@
                     "variant": "param",
                     "kind": 32768,
                     "flags": {},
+                    "comment": {
+                      "summary": [
+                        {
+                          "kind": "text",
+                          "text": "ID of the subscription that generated the error."
+                        }
+                      ]
+                    },
                     "type": {
                       "type": "intrinsic",
                       "name": "string"
@@ -3559,7 +3583,15 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Handles a successful subscription or re-subscription event."
+                      "text": "Runs when a subscription is successfully established or re-established.\n\nWhen a subscription fails and is re-established, the subscriber might not receive all messages published during the failure. The "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`isSynced`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": " flag indicates whether all missed messages were successfully delivered.\n\nLearn more about [realtime SDK errors](ADDLINK).\n<!-- TODO: Document server-side buffer limits for message replay. -->"
                     }
                   ]
                 },
@@ -3570,6 +3602,14 @@
                     "variant": "param",
                     "kind": 32768,
                     "flags": {},
+                    "comment": {
+                      "summary": [
+                        {
+                          "kind": "text",
+                          "text": "Subscription ID."
+                        }
+                      ]
+                    },
                     "type": {
                       "type": "intrinsic",
                       "name": "string"
@@ -3581,6 +3621,14 @@
                     "variant": "param",
                     "kind": 32768,
                     "flags": {},
+                    "comment": {
+                      "summary": [
+                        {
+                          "kind": "text",
+                          "text": "Whether the message history was fully restored."
+                        }
+                      ]
+                    },
                     "type": {
                       "type": "intrinsic",
                       "name": "boolean"
@@ -3646,11 +3694,11 @@
     "symbolIdMap": {}
   },
   "appendices": {
-    "/site": [
+    "/": [
       {
         "type": "GUIDE",
         "title": "Introduction",
-        "src": "# Introduction\n\n> **Note:** This API is only intended for use in [site development](https://dev.wix.com/docs/sdk/articles/get-started/about-site-development).\n\nUsing the Realtime API you can create channels and channel resources where messages\ncan be published. Site visitors who subscribe to a channel receive the\nmessages published to that channel. When a message is received you can handle the message any\nway you choose, such as displaying the contents of the message or changing the state\nof page elements depending on the contents of the message. You can also manage the\npermissions of who can read from specific channels.\n\nThe `@wix/realtime` module is used in conjunction with the [`@wix/site-realtime`](https://dev.wix.com/docs/sdk/frontend-modules/site-realtime/introduction) module.\n\nGet hands-on experience with the Realtime API on our [Hello Realtime](https://www.wix.com/velo/example/hello-realtime) example page.\n\nTypical uses of the Realtime API include implementing a messaging system or\nas an alternative to using a polling mechanism.\n\nThe Realtime API uses the following terminology:\n\n+ **Channel**: A specific channel on which messages are published. Each channel\n  has a unique name. Site visitors can subscribe to a channel to receive the \n  messages that are published on it. When site visitors subscribe to a channel, they do not \n  receive messages published to a resource on that same channel.\n+ **Channel resource**: A subchannel on which messages are published. Subchannels\n  can share a name with a channel and other subchannels, but they have a unique\n  resource ID. When site visitors subscribe to a channel resource, they do not \n  receive messages published to that same channel without a specified resource.\n  Channel resources inherit their parent channel's permissions, unless specified\n  otherwise.\n+ **Message**: A message published on a channel or channel resource. A message can\n  be of any type, such as a string, number, or object. Channel subscribers receive\n  the messages published on the channel.\n+ **Publish**: Sending a message over a channel or channel resource.\n+ **Subscribe**: A site visitor subscribes to receive the messages published on a \n  channel or channel resource.\n+ **Permissions router**: The permissions router is used to define the permissions\n  you want to grant to subscribers on channels and channel resources.\n+ **Permissions handler**: Handles a permissions check for a specific user on a \n  specific channel or channel resource.\n\nFor a tutorial on using the Realtime API, see \n[Sending Messages with the Realtime API](https://dev.wix.com/docs/develop-websites/articles/code-tutorials/wix-editor-elements/sending-messages-with-the-realtime-api).\n"
+        "src": "---\narticleType: intro\n---\n\n# About the Realtime APIs\n\nThe Realtime APIs let you send and receive messages between a site backend and connected clients in real time. When a backend service publishes messages to a channel, clients subscribed to that channel receive them instantly.\n\nWith the Realtime APIs, you can:\n\n- Publish messages from the backend to channels and channel resources.\n- Subscribe to channels and resources to receive messages on connected clients.\n- Control which subscribers receive messages on specific channels or channel resources.\n\nThe Realtime APIs consist of the following modules that work together:\n\n- [**Publisher**](ADDLINK): Backend module that sends messages to channels.\n- [**Site**](ADDLINK): Backend module that manages subscriber permissions.\n- [**Subscriber**](ADDLINK): Client module that listens to channels and receives messages.\n\n## How the modules work together\n\nThe Publisher sends a message to a channel or channel resource. The Site module checks whether each subscriber has permission to listen on that channel. Subscribers that have the appropriate permissions receive the message in real time.\n\nA typical flow looks like this:\n\n1. Define permissions in the **realtime-permissions.js** in the site's backend using the [Site API](ADDLINK).\n2. A client subscribes to a channel or channel resource using the [Subscriber API](ADDLINK).\n3. The `realtime_check_permission` hook checks the subscriber's permissions.\n4. The [Publisher](ADDLINK) publishes a message to the channel.\n5. The subscriber receives the message.\n\n## Channels and channel resources\n\nChannels are the mechanism by which publishers send messages to subscribers. Each channel has a unique name and can contain resources that act as sub-channels. Clients can subscribe to a channel or resource. When a publisher sends a message, subscribers receive the messages instantly if they have the appropriate permissions.\n\nChannels and resources are strictly isolated: subscribing to a channel doesn't include messages published to a resource on that channel, and subscribing to a resource doesn't include messages published to the parent channel.\n\n## Publisher\n\nThe [Publisher API](ADDLINK) is a backend module that sends messages to subscribers listening to the specified channel or resource.\n\nLearn more about [publishing messages](ADDLINK).\n\n## Site\n\nThe [Site API](ADDLINK) controls subscriber permissions. It determines which subscribers can receive messages on specific channels and resources.\n\nLearn more about [permissions in the Site API](ADDLINK).\n\n<!-- ### Permissions\n\nPermissions can be set at the channel level or the resource level. They determine whether subscribers can receive messages published to that channel or resource. \n\nYou can define permissions by adding a **realtime-permissions.js** file in a site's backend and setting up the [`realtime_check_permission` hook](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/realtime-check-permission). You can include all permissions logic directly in the hook, or use the [Permissions Router API](ADDLINK) to organize permissions logic per channel and resource. \n\nPermissions follow a cascading pattern:\n\n- When the specified resource [doesn't have a permissions handler](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/permissions-router/add), the handler for its parent channel runs. \n- When the specified channel doesn't have a permissions handler, the [default permissions handler](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/permissions-router/default) runs. \n- When no default handler is set, all subscribers receive the default permissions of `{\"read\": true}`.\n\nLearn more about [setting up permissions](ADDLINK). -->\n\n## Subscribers\n\nA subscriber is a client that listens to a channel or resource. When a message is published to a channel or resource, all subscribers with [the appropriate permissions](ADDLINK) receive the message. \n\nYou can set up dedicated handlers for incoming messages, subscription successes, and subscription failures.\n\nLearn more about the [Subscriber API](ADDLINK).\n\n<!-- ### Subscription lifecycle\n\nWhile subscribing is asynchronous, the `subscribe()` method returns a subscription ID immediately, but the connection is established in the background. Subscribers can use the subscription ID to [unsubscribe](ADDLINK) at a later time. \n\nYou can register lifecycle handlers to respond when the subscription succeeds or fails. The [`onSubscribed` handler](ADDLINK) runs on every successful connection, including automatic re-subscriptions attempted after network interruptions. The [`onSubscriptionError` handler](ADDLINK) runs whenever an error occurs. \n\nLearn more about the [Subscriber API](ADDLINK).\n\n### Subscription errors\n\nSubscription errors are caused by the subscription being rejected or by connection or reconnection failures. While some errors are automatically recoverable, some require manual handling. \n\nLearn more about [handling subscription errors](ADDLINK). -->\n\n## Before you begin\n\nIt's important to note the following points before starting to code:\n\n- Messages are ephemeral. They don't persist across sessions.\n- When previewing the site, `read` permissions are always `true`.\n<!-- TODO: Document channel/subscription limits per site/app. -->\n\n## Use cases\n\n- [Send notifications to connected clients](ADDLINK).\n- [Broadcast data updates in real time](ADDLINK).\n- [Push state changes to a live dashboard](ADDLINK).\n\n## Terminology\n\n- **Channel**: Named broadcast channel that publishers send messages to and subscribers listen on.\n- **Resource**: Isolated sub-channel in a channel. Messages on a resource are isolated from messages on its parent channel.\n- **Message**: Data published to a channel or resource.\n- **Publisher**: Service that sends messages to subscribers.\n- **Subscriber**: Client that listens for messages on a channel or resource.\n- **Subscription**: Active connection between a subscriber and a channel or resource, identified by a subscription ID.\n\n"
       },
       {
         "type": "GUIDE",
@@ -3658,6 +3706,27 @@
         "src": "# Setup\n\n@package_metadata:@wix/realtime\n\nTo use the Realtime API, install the `@wix/realtime` package.\n\n#### Install the package\n\nFollow the installation instructions for your development environment.\n\n| Development environment | Installation method |\n|--|--|\n| Wix sites (editor or IDE) | Use the [package manager](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-in-the-editor). |\n| Wix sites (local IDE) | Run ` wix install @wix/realtime` using the [Wix CLI](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-with-the-wix-cli).|\n\n#### Import the package\n\nTo import the package in your code:\n\n```js\nimport { site } from `@wix/realtime`;\n```"
       }
     ],
+    "/publisher": [
+      {
+        "type": "GUIDE",
+        "title": "Introduction",
+        "src": "---\narticleType: intro\n---\n\n# About the Publisher API\n\nThe Publisher API is a backend module for sending messages to [channels and resources](ADDLINK). [Subscribers](ADDLINK) with suitable [permissions](ADDLINK) receive these messages instantly. Channels and resources are isolated, so messages sent to a channel are not published to a resource, and vice versa.\n\nLearn more [about the Realtime APIs](ADDLINK).\n\n<!-- TODO check that elevation note appears in method description -->\n<!-- TODO: Check whether this API is relevant for headless projects. -->\n\n## Before you begin\n\nIt's important to note the following points before starting to code:\n\n- Messages aren't queued. When no subscribers are listening, the message is dropped.\n- Messages don't persist across sessions.\n\n## Use cases\n\n- [Send notifications to connected clients](ADDLINK).\n- [Broadcast data updates in real time](ADDLINK).\n- [Push state changes to a live dashboard](ADDLINK).\n\n@sdk_package_setup\n"
+      }
+    ],
+    "/subscriber": [
+      {
+        "type": "GUIDE",
+        "title": "Introduction",
+        "src": "---\narticleType: intro\n---\n\n# About the Subscriber API\n\nThe Subscriber API allows users to subscribe to [channels and resources](ADDLINK). When a [Publisher](ADDLINK) sends messages, subscribers with suitable permissions receive them in real time. Channels and resources are isolated, so messages sent to a channel aren't published to a resource, and vice versa.\n\nLearn more [about the Realtime APIs](ADDLINK).\n\nWith the Subscriber API, you can:\n\n- Subscribe or unsubscribe from a channel or resource.\n- Respond to subscription successes, connection errors, and incoming messages with dedicated handlers.\n\n## Subscription lifecycle\n\nWhile subscribing is asynchronous, the `subscribe()` method returns a subscription ID immediately, but the connection is established in the background. Subscribers can use the subscription ID to [unsubscribe](ADDLINK) at a later time. \n\nYou can register lifecycle handlers to respond when the subscription succeeds or fails. The [`onSubscribed` handler](ADDLINK) runs on every successful connection, including automatic re-subscriptions attempted after network interruptions. The [`onSubscriptionError` handler](ADDLINK) runs whenever an error occurs.\n\n### Unsubscribing\n\nYou can unsubscribe in the following ways:\n\n- By `subscriptionId`: Removes a single subscription.\n- By `channel`: Removes all subscriptions to that channel or resource.\n- By both: Removes the specific subscription, verifying it matches the specified channel or resource. If it doesn't, the subscription isn't removed.\n\nWhen the last subscription on a connection is removed, the connection closes automatically.\n\n## Reconnection and message sync\n\nIf the connection drops, the client automatically attempts to reconnect and re-subscribe. When subscribing or re-subscribing, the `isSynced` parameter of the `onSubscribed()` hook indicates whether all missed messages were successfully restored, or whether manual the subscriber needs to take further action. \n\nLearn more about [subscribing](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/subscriber/subscribe) to a channel or resource.\n\n<!-- TODO: Document server-side buffer limits for message replay. -->\n\n## Subscription errors\n\nSubscription errors are caused by the subscription being rejected or by connection failures. Each error includes `errorCode` and `recoverable` properties that indicate the error type and whether the client is automatically retrying.\n\nLearn more about how the [`subscribe()`](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/subscriber/subscribe) method handles subscription errors.\n\n## Before you begin\n\nIt's important to note the following points before starting to code:\n\n- Subscriptions are ephemeral. They don't persist across sessions.\n- Closing a browser tab removes all its subscriptions.\n- Permissions are checked when a subscription is first established. When a subscriber doesn't have `read` permission on the channel, their subscription fails.\n<!-- TODO: Document channel/subscription limits per site/app. -->\n\n## Use cases\n\n- [Send notifications to connected clients](ADDLINK).\n- [Broadcast data updates in real time](ADDLINK).\n- [Push state changes to a live dashboard](ADDLINK).\n\n## Terminology\n\n- **Subscription**: An active connection between a client and a channel or resource, identified by a subscription ID.\n- **Subscription ID**: A unique identifier returned by `subscribe()`. Use it to unsubscribe or track lifecycle events.\n\n@sdk_package_setup\n"
+      }
+    ],
+    "/site": [
+      {
+        "type": "GUIDE",
+        "title": "Introduction",
+        "src": "---\narticleType: intro\n---\n\n# About the Site API\n\nThe Site API lets you control subscriber permissions for the [Realtime APIs](ADDLINK). It determines which [subscribers](ADDLINK) can receive messages on specific [channels and resources](ADDLINK).\n\nTo define permissions, set up the [`realtime_check_permission` hook](ADDLINK) in the **realtime-permissions.js** file in a site's backend. You can include all permissions logic directly in the hook, or use the [Permissions Router](ADDLINK) to organize permissions logic per channel and resource.\n\nWith the Site API, you can:\n\n- Define the `realtime_check_permission` hook to control subscriber access.\n- Use the [Permissions Router](ADDLINK) to organize permission logic per channel or resource.\n\n## Before you begin\n\nIt's important to note the following points before starting to code:\n\n- In Wix Studio, you must create a **realtime-permissions.js** file in a site's backend, even if the `realtime_check_permission` isn't defined. Without the file, subscriptions fail.\n- When the `realtime_check_permission` hook isn't defined, all subscribers receive the default permissions of `{\"read\": true}`.\n- When previewing a site, `read` permissions are always `true`.\n- Learn more about [permissions in the realtime SDK](ADDLINK).\n\n## Use cases\n\n- [Restrict channels to logged-in members](ADDLINK).\n\n@sdk_package_setup"
+      }
+    ],
     "/site/publish": [
       {
         "type": "EXAMPLE",
@@ -3713,7 +3782,7 @@
       {
         "type": "GUIDE",
         "title": "Introduction",
-        "src": "# Introduction\n\nUse the permissions router to define the permissions you want to grant to subscribers\non channels or channel resources. You can set permissions on the channel and channel\nresource level. If you do not define permissions for a particular channel resource,\nthat resource inherits the permissions of its parent channel.\n\nTypically you use the permissions router in the **realtime-permissions.js** file in\nyour 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 [`realtime_check_permission()`](https://dev.wix.com/docs/sdk/backend-modules/realtime/site/realtime-check-permission) function."
+        "src": "---\narticleType: intro\n---\n\n# About the Permissions Router API\n\nThe Permissions Router API is a utility for organizing channel permission logic. The router lets you set up a default permissions handler as well as handlers specific to channels or resources.\n\n> **Note**: Alternatively, you can include permissions logic in the [`realtime_check_permission()`](ADDLINK) hook.\n\nLearn more about the [Site API](ADDLINK) and the [Realtime APIs](ADDLINK).\n\nWith the Permissions Router API, you can:\n\n- [Add a handler](ADDLINK) for a specific channel or resource.\n- [Set a default handler](ADDLINK) for channels that don't have explicit handlers.\n- [Check](ADDLINK) subscriber permissions.\n\n## Setting up permissions\n\nTo set up permissions:\n\n1. Create a **realtime-permissions.js** file in a site's backend.\n2. Export a `realtime_check_permission` hook. This hook runs automatically whenever a subscription is attempted.\n3. In the hook body, call `permissionsRouter.check()` to evaluate the subscriber's permissions based on the handlers you've registered.\n\n```js\nimport { permissionsRouter } from '@wix/realtime';\n\npermissionsRouter.default((channel, subscriber) => {\n  return { read: true };\n});\n\nexport function realtime_check_permission(channel, subscriber) {\n  return permissionsRouter.check(channel, subscriber);\n}\n```\n\n## Permission resolution\n\nPermissions can be set at the channel level or the resource level. They determine whether subscribers can receive messages published to that channel or resource.\n\nPermissions follow a cascading pattern:\n\n- When the specified resource [doesn't have a permissions handler](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/permissions-router/add), the handler for its parent channel runs.\n- When the specified or parent channel doesn't have a permissions handler, the [default permissions handler](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/permissions-router/default) runs.\n- When no default handler is set, all subscribers receive the default permissions of `{ \"read\": true }`.\n\n## Before you begin\n\nIt's important to note the following points before starting to code:\n\n- You must create a **realtime-permissions.js** file in a site's backend. Without it, all subscriptions fail in Wix Studio.\n- When the `realtime_check_permission` hook isn't defined, all subscribers receive the default permissions of `{\"read\": true}`.\n- When previewing a site, `read` permissions are always `true`.\n\n## Use cases\n\n- [Restrict channels to logged-in members](ADDLINK).\n\n@sdk_package_setup"
       }
     ],
     "/site/PermissionsRouter/add": [