@wix/realtime 1.0.34 → 1.0.36

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

@@ -38,15 +38,7 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Publishes a message to a channel or channel resource.\n\nAll subscribers currently listening to the specified channel receive the\nmessage. Subscribers to a channel don't receive messages published to a\nresource on that channel, and vice versa.\n\nThis method is backend-only and requires elevated permissions.\n\n<!-- TODO: Check whether this API is relevant for headless projects. -->\n\n> **Note:** This function requires elevated permissions and runs only on the backend.\n> You can also call this method from the frontend using "
-                    },
-                    {
-                      "kind": "code",
-                      "text": "`elevate()`"
-                    },
-                    {
-                      "kind": "text",
-                      "text": ".\n> Elevated permissions are only available for apps and service accounts."
+                      "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": [
@@ -55,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```"
                         }
                       ]
                     },
@@ -68,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```"
                         }
                       ]
                     }
@@ -89,7 +81,7 @@
                       "summary": [
                         {
                           "kind": "text",
-                          "text": "Channel, and optionally resource, to publish to."
+                          "text": "Channel or resource to publish to."
                         }
                       ]
                     },
@@ -161,15 +153,7 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Publishes a message to a channel or channel resource.\n\nAll subscribers currently listening to the specified channel receive the\nmessage. Subscribers to a channel don't receive messages published to a\nresource on that channel, and vice versa.\n\nThis method is backend-only and requires elevated permissions.\n\n<!-- TODO: Check whether this API is relevant for headless projects. -->\n\n> **Note:** This function requires elevated permissions and runs only on the backend.\n> You can also call this method from the frontend using "
-                    },
-                    {
-                      "kind": "code",
-                      "text": "`elevate()`"
-                    },
-                    {
-                      "kind": "text",
-                      "text": ".\n> Elevated permissions are only available for apps and service accounts."
+                      "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": [
@@ -178,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```"
                         }
                       ]
                     },
@@ -191,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```"
                         }
                       ]
                     }
@@ -265,15 +249,7 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Manages subscriber permissions on channels.\n\nUse the permissions router to define which subscribers can receive messages\non specific channels or channel resources. The router allows you to set permissions at the\nchannel level and the channel resource level. If you don't define\npermissions for a particular resource, it inherits the permissions of its\nparent channel.\n\nTypically, you use the permissions router in the **realtime-permissions.js**\nfile in your site's backend to:\n\n+ Set default permissions for all channels where no explicit permissions\n  are defined.\n+ Add permissions logic for specific channels or channel resources.\n+ Check the permissions for a subscriber on a channel.\n\n> **Note:** You don't have to use the permissions router. You can also\n> define all your permissions logic directly in the\n> "
-                    },
-                    {
-                      "kind": "code",
-                      "text": "`realtime_check_permission()`"
-                    },
-                    {
-                      "kind": "text",
-                      "text": " function."
+                      "text": "Realtime permissions router.\n\nDefines which subscribers can receive messages on specific channels or resources. Learn more about [permission resolution](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/permissions-router/introduction#permission-resolution)."
                     }
                   ]
                 },
@@ -295,23 +271,7 @@
                           "summary": [
                             {
                               "kind": "text",
-                              "text": "Sets a permissions handler for a specific channel or channel 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",
-                              "text": "`add()`"
-                            },
-                            {
-                              "kind": "text",
-                              "text": ")\n+ channel: A, resource: 1, permissions: handler Y (set with "
-                            },
-                            {
-                              "kind": "code",
-                              "text": "`add()`"
-                            },
-                            {
-                              "kind": "text",
-                              "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)"
+                              "text": "Sets a permissions handler for a specific channel or resource.\n\nAdding a handler to a channel without specifying a resource applies the handler to the channel and to any of its resources that don't have their own handler. Learn more about [permission resolution](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/permissions-router/introduction#permission-resolution)."
                             }
                           ],
                           "blockTags": [
@@ -364,7 +324,7 @@
                               "summary": [
                                 {
                                   "kind": "text",
-                                  "text": "Channel or channel resource to set a permissions handler for."
+                                  "text": "Channel or resource to set a permissions handler for."
                                 }
                               ]
                             },
@@ -385,7 +345,7 @@
                               "summary": [
                                 {
                                   "kind": "text",
-                                  "text": "Function to run when checking permissions for the specified channel."
+                                  "text": "Handler to run when checking permissions for the specified channel."
                                 }
                               ]
                             },
@@ -441,27 +401,7 @@
                           "summary": [
                             {
                               "kind": "text",
-                              "text": "Checks the permissions for a subscriber on a channel or channel 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",
-                              "text": "`{\"read\": true}`"
-                            },
-                            {
-                              "kind": "text",
-                              "text": ".\n\nTypically, call this method in the body of the "
-                            },
-                            {
-                              "kind": "code",
-                              "text": "`realtime_check_permission()`"
-                            },
-                            {
-                              "kind": "text",
-                              "text": "\nfunction:\n\n"
-                            },
-                            {
-                              "kind": "code",
-                              "text": "```JavaScript\nexport function realtime_check_permission(channel, subscriber) {\n  return permissionsRouter.check(channel, subscriber);\n}\n```"
+                              "text": "Checks permissions for a subscriber on a channel or resource.\n\nRuns the appropriate permissions handler to check whether the subscriber can receive messages on the specified channel or resource.\n\nLearn more about [permission resolution](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/permissions-router/introduction#permission-resolution)."
                             }
                           ],
                           "blockTags": [
@@ -506,7 +446,7 @@
                               "content": [
                                 {
                                   "kind": "text",
-                                  "text": "The permissions granted to the subscriber."
+                                  "text": "Permissions granted to the subscriber for the specified channel or resource."
                                 }
                               ]
                             },
@@ -541,7 +481,7 @@
                               "summary": [
                                 {
                                   "kind": "text",
-                                  "text": "Channel or channel resource to check permissions for."
+                                  "text": "Channel or resource to check permissions for."
                                 }
                               ]
                             },
@@ -622,39 +562,7 @@
                           "summary": [
                             {
                               "kind": "text",
-                              "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": "`add()`"
-                            },
-                            {
-                              "kind": "text",
-                              "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": "`add()`"
-                            },
-                            {
-                              "kind": "text",
-                              "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": "`add()`"
-                            },
-                            {
-                              "kind": "text",
-                              "text": "\n\nIf no default handler is set, the built-in default permissions are used:\n"
-                            },
-                            {
-                              "kind": "code",
-                              "text": "`{\"read\": true}`"
-                            },
-                            {
-                              "kind": "text",
-                              "text": "."
+                              "text": "Sets the default permissions handler.\n\nThe default handler runs when the specified channel or resource doesn't have an explicit handler. Learn more about [permission resolution](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/permissions-router/introduction#permission-resolution)."
                             }
                           ],
                           "blockTags": [
@@ -689,7 +597,7 @@
                               "summary": [
                                 {
                                   "kind": "text",
-                                  "text": "Function to run when checking default permissions."
+                                  "text": "Handler to run when checking default permissions."
                                 }
                               ]
                             },
@@ -745,7 +653,7 @@
                           "summary": [
                             {
                               "kind": "text",
-                              "text": "A function that determines the permissions for a subscriber on a channel\nor channel resource. Return a "
+                              "text": "Determines the permissions for a subscriber on a channel or resource. Return a "
                             },
                             {
                               "kind": "code",
@@ -753,7 +661,7 @@
                             },
                             {
                               "kind": "text",
-                              "text": " object to grant or deny\naccess."
+                              "text": " object to grant or deny access."
                             }
                           ],
                           "blockTags": [
@@ -824,7 +732,7 @@
                               "summary": [
                                 {
                                   "kind": "text",
-                                  "text": "Channel or channel resource being checked."
+                                  "text": "Channel or resource being checked."
                                 }
                               ]
                             },
@@ -907,23 +815,7 @@
                       "summary": [
                         {
                           "kind": "text",
-                          "text": "Sets a permissions handler for a specific channel or channel 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",
-                          "text": "`add()`"
-                        },
-                        {
-                          "kind": "text",
-                          "text": ")\n+ channel: A, resource: 1, permissions: handler Y (set with "
-                        },
-                        {
-                          "kind": "code",
-                          "text": "`add()`"
-                        },
-                        {
-                          "kind": "text",
-                          "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)"
+                          "text": "Sets a permissions handler for a specific channel or resource.\n\nAdding a handler to a channel without specifying a resource adds the handler to the channel and to all resources that don't have their own handler. Learn more about [permission resolution](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/permissions-router/introduction#permission-resolution)."
                         }
                       ],
                       "blockTags": [
@@ -976,7 +868,7 @@
                           "summary": [
                             {
                               "kind": "text",
-                              "text": "Channel or channel resource to set a permissions handler for."
+                              "text": "Channel or resource to set a permissions handler for."
                             }
                           ]
                         },
@@ -997,7 +889,7 @@
                           "summary": [
                             {
                               "kind": "text",
-                              "text": "Function to run when checking permissions for the specified channel."
+                              "text": "Handler to run when checking permissions for the specified channel."
                             }
                           ]
                         },
@@ -1044,27 +936,7 @@
                       "summary": [
                         {
                           "kind": "text",
-                          "text": "Checks the permissions for a subscriber on a channel or channel 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",
-                          "text": "`{\"read\": true}`"
-                        },
-                        {
-                          "kind": "text",
-                          "text": ".\n\nTypically, call this method in the body of the "
-                        },
-                        {
-                          "kind": "code",
-                          "text": "`realtime_check_permission()`"
-                        },
-                        {
-                          "kind": "text",
-                          "text": "\nfunction:\n\n"
-                        },
-                        {
-                          "kind": "code",
-                          "text": "```JavaScript\nexport function realtime_check_permission(channel, subscriber) {\n  return permissionsRouter.check(channel, subscriber);\n}\n```"
+                          "text": "Checks permissions for a subscriber on a channel or resource.\n\nRuns the permissions handler appropriate for the subscriber on the specified channel or resource.\n\nLearn more about [permission resolution](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/permissions-router/introduction#permission-resolution)."
                         }
                       ],
                       "blockTags": [
@@ -1109,7 +981,7 @@
                           "content": [
                             {
                               "kind": "text",
-                              "text": "The permissions granted to the subscriber."
+                              "text": "Permissions granted to the subscriber for the specified channel or resource."
                             }
                           ]
                         },
@@ -1144,7 +1016,7 @@
                           "summary": [
                             {
                               "kind": "text",
-                              "text": "Channel or channel resource to check permissions for."
+                              "text": "Channel or resource to check permissions for."
                             }
                           ]
                         },
@@ -1214,39 +1086,7 @@
                       "summary": [
                         {
                           "kind": "text",
-                          "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": "`add()`"
-                        },
-                        {
-                          "kind": "text",
-                          "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": "`add()`"
-                        },
-                        {
-                          "kind": "text",
-                          "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": "`add()`"
-                        },
-                        {
-                          "kind": "text",
-                          "text": "\n\nIf no default handler is set, the built-in default permissions are used:\n"
-                        },
-                        {
-                          "kind": "code",
-                          "text": "`{\"read\": true}`"
-                        },
-                        {
-                          "kind": "text",
-                          "text": "."
+                          "text": "Sets the default permissions handler.\n\nThe default handler runs when the specified channel or resource doesn't have an explicit handler.\n\nLearn more about [permission resolution](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/permissions-router/introduction#permission-resolution)."
                         }
                       ],
                       "blockTags": [
@@ -1281,7 +1121,7 @@
                           "summary": [
                             {
                               "kind": "text",
-                              "text": "Function to run when checking default permissions."
+                              "text": "Default handler to run when checking permissions."
                             }
                           ]
                         },
@@ -1334,7 +1174,7 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "A realtime channel that subscribers can listen to and publishers can send messages to.\nA channel can optionally contain resources, which act as isolated sub-channels.\nSubscribing to a channel doesn't include messages published to its resources, and vice versa."
+                  "text": "Realtime broadcast channel. Publishers send messages to channels and subscribers listen to them."
                 }
               ]
             },
@@ -1349,7 +1189,7 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Channel name. Supports alphanumeric characters, hyphens, and underscores.\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",
@@ -1386,15 +1226,7 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Resource ID within the channel. Use resources to isolate messages within a channel.\nFor example, a "
-                    },
-                    {
-                      "kind": "code",
-                      "text": "`chat`"
-                    },
-                    {
-                      "kind": "text",
-                      "text": " channel might use a separate resource for each chat room."
+                      "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."
                     }
                   ]
                 },
@@ -1424,7 +1256,7 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "Permission settings for a subscriber on a channel or channel resource."
+                  "text": "Permissions for a subscriber on a channel or resource."
                 }
               ]
             },
@@ -1446,6 +1278,10 @@
                     {
                       "kind": "code",
                       "text": "`true`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": "."
                     }
                   ]
                 },
@@ -1553,15 +1389,7 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "A channel subscriber whose permissions are being checked.\nPassed to the "
-                },
-                {
-                  "kind": "code",
-                  "text": "`realtime_check_permission()`"
-                },
-                {
-                  "kind": "text",
-                  "text": " hook to identify the 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."
                 }
               ]
             },
@@ -1606,7 +1434,7 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Subscriber type, based on their authentication status."
+                      "text": "Subscriber identity type.\n\nLearn more about [Wix identities](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities)."
                     }
                   ],
                   "blockTags": [
@@ -1654,15 +1482,7 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "The realtime permissions router.\n\nUse the permissions router to define which subscribers can receive messages\non specific channels or channel resources. You can set permissions at the\nchannel level and the channel resource level. If you don't define\npermissions for a particular resource, it inherits the permissions of its\nparent channel.\n\nTypically, you use the permissions router in the **realtime-permissions.js**\nfile in your site's backend to:\n\n+ Set default permissions for all channels where no explicit permissions\n  are defined.\n+ Add permissions logic for specific channels or channel resources.\n+ Check the permissions for a subscriber on a channel.\n\n> **Note:** You don't have to use the permissions router. You can also\n> define all your permissions logic directly in the\n> "
-                },
-                {
-                  "kind": "code",
-                  "text": "`realtime_check_permission()`"
-                },
-                {
-                  "kind": "text",
-                  "text": " function."
+                  "text": "Realtime permissions router.\n\nDefines which subscribers can receive messages on specific channels or resources. Learn more about the [permissions router](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/permissions-router/introduction)."
                 }
               ],
               "blockTags": [
@@ -1701,7 +1521,39 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Publishes a message to a channel or channel resource."
+                      "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",
+                      "text": "`options`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": " parameter. To include the publisher's identity in the message,\nset "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`includePublisher`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": " to "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`true`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": " in the "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`options`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": " parameter."
                     }
                   ],
                   "blockTags": [
@@ -1726,64 +1578,7 @@
                         },
                         {
                           "kind": "text",
-                          "text": " module instead.\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",
-                          "text": "`options`"
-                        },
-                        {
-                          "kind": "text",
-                          "text": " parameter. To include the publisher's identity in the message,\nset "
-                        },
-                        {
-                          "kind": "code",
-                          "text": "`includePublisher`"
-                        },
-                        {
-                          "kind": "text",
-                          "text": " to "
-                        },
-                        {
-                          "kind": "code",
-                          "text": "`true`"
-                        },
-                        {
-                          "kind": "text",
-                          "text": " in the "
-                        },
-                        {
-                          "kind": "code",
-                          "text": "`options`"
-                        },
-                        {
-                          "kind": "text",
-                          "text": " parameter."
-                        }
-                      ]
-                    },
-                    {
-                      "tag": "@deprecated",
-                      "content": [
-                        {
-                          "kind": "text",
-                          "text": "Use "
-                        },
-                        {
-                          "kind": "code",
-                          "text": "`publisher.publish`"
-                        },
-                        {
-                          "kind": "text",
-                          "text": " from "
-                        },
-                        {
-                          "kind": "code",
-                          "text": "`@wix/realtime`"
-                        },
-                        {
-                          "kind": "text",
-                          "text": " instead."
+                          "text": " module instead."
                         }
                       ]
                     },
@@ -1828,7 +1623,7 @@
                       "content": [
                         {
                           "kind": "text",
-                          "text": "Fulfilled when the message is published. Doesn't indicate that the message was received by subscribers."
+                          "text": "Resolves when the message is published. Doesn't indicate that the message was received by subscribers."
                         }
                       ]
                     }
@@ -1934,31 +1729,7 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Checks permissions for a subscriber on a channel or channel resource.\n\nThis is a hook, not a method you call directly. Define this function as a\nnamed export in a file called **realtime-permissions.js** in your site's\nbackend. It runs automatically when a site visitor subscribes to a channel.\n\n> **Important:**\n> - If this function isn't defined, all subscribers receive the default\n>   permissions: "
-                    },
-                    {
-                      "kind": "code",
-                      "text": "`{\"read\": true}`"
-                    },
-                    {
-                      "kind": "text",
-                      "text": ".\n> - In Wix Studio, you don't need to define this function, but you must\n>   create a backend file named **realtime-permissions.js**. Without this\n>   file, subscriptions fail.\n\nImplement permissions logic in one of the following ways:\n\n+ Include all permissions logic directly in the body of this function.\n+ Use the "
-                    },
-                    {
-                      "kind": "code",
-                      "text": "`permissionsRouter`"
-                    },
-                    {
-                      "kind": "text",
-                      "text": " to add permissions logic per channel, then\n  call "
-                    },
-                    {
-                      "kind": "code",
-                      "text": "`permissionsRouter.check()`"
-                    },
-                    {
-                      "kind": "text",
-                      "text": " in the body of this function and return\n  its result.\n\n> **Note:** When previewing your site, read permissions are always granted."
+                      "text": "Checks permissions for a subscriber on a channel or resource.\n\nThis hook runs automatically whenever a new subscription is attempted.\n\nSet up this hook as a named export in the **realtime-permissions.js** file in a site's backend.\n\nLearn more about [setting up permissions](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/permissions-router/introduction#setting-up-permissions)."
                     }
                   ],
                   "blockTags": [
@@ -2003,16 +1774,7 @@
                       "content": [
                         {
                           "kind": "text",
-                          "text": "The permissions granted to the subscriber on the channel or channel resource."
-                        }
-                      ]
-                    },
-                    {
-                      "tag": "@servicePath",
-                      "content": [
-                        {
-                          "kind": "text",
-                          "text": "wix-realtime-backend.ChannelPermissions"
+                          "text": "Permissions granted to the subscriber for the specified channel or resource."
                         }
                       ]
                     },
@@ -2038,7 +1800,7 @@
                       "summary": [
                         {
                           "kind": "text",
-                          "text": "Channel, and optionally resource, to check permissions for."
+                          "text": "Channel and resource to check permissions for."
                         }
                       ]
                     },
@@ -2147,7 +1909,7 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Subscribes to a channel or channel resource.\n\nThe method returns a subscription ID immediately. The connection is\nestablished asynchronously in the background. Use the "
+                      "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",
@@ -2155,15 +1917,15 @@
                     },
                     {
                       "kind": "text",
-                      "text": " parameter\nto register lifecycle handlers that notify you when the subscription\nsucceeds or encounters an error.\n\nIf the connection drops, the client automatically attempts to reconnect\nand re-subscribe. The "
+                      "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`"
+                      "text": "`onSubscribed()`"
                     },
                     {
                       "kind": "text",
-                      "text": " handler fires again on each\nsuccessful re-subscription."
+                      "text": " handler runs on every successful re-subscription."
                     }
                   ],
                   "blockTags": [
@@ -2172,11 +1934,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```"
                         }
                       ]
                     },
@@ -2185,11 +1947,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```"
                         }
                       ]
                     }
@@ -2277,7 +2039,7 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Subscribes to a channel or channel resource.\n\nThe method returns a subscription ID immediately. The connection is\nestablished asynchronously in the background. Use the "
+                      "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",
@@ -2285,15 +2047,15 @@
                     },
                     {
                       "kind": "text",
-                      "text": " parameter\nto register lifecycle handlers that notify you when the subscription\nsucceeds or encounters an error.\n\nIf the connection drops, the client automatically attempts to reconnect\nand re-subscribe. The "
+                      "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`"
+                      "text": "`onSubscribed()`"
                     },
                     {
                       "kind": "text",
-                      "text": " handler fires again on each\nsuccessful re-subscription."
+                      "text": " handler runs on every successful re-subscription."
                     }
                   ],
                   "blockTags": [
@@ -2302,11 +2064,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```"
                         }
                       ]
                     },
@@ -2315,11 +2077,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```"
                         }
                       ]
                     }
@@ -2372,7 +2134,7 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Removes one or more subscriptions.\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",
@@ -2388,7 +2150,7 @@
                     },
                     {
                       "kind": "text",
-                      "text": ": removes all subscriptions to that channel or channel 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."
+                      "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": [
@@ -2397,11 +2159,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```"
                         }
                       ]
                     },
@@ -2410,11 +2172,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```"
                         }
                       ]
                     }
@@ -2431,7 +2193,7 @@
                       "summary": [
                         {
                           "kind": "text",
-                          "text": "Specifies what to unsubscribe from. At least one of "
+                          "text": "Unsubscribe information. You must specify "
                         },
                         {
                           "kind": "code",
@@ -2439,7 +2201,7 @@
                         },
                         {
                           "kind": "text",
-                          "text": " or "
+                          "text": ", "
                         },
                         {
                           "kind": "code",
@@ -2447,7 +2209,7 @@
                         },
                         {
                           "kind": "text",
-                          "text": " is required."
+                          "text": ", or both."
                         }
                       ]
                     },
@@ -2474,7 +2236,7 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Removes one or more subscriptions.\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",
@@ -2490,7 +2252,7 @@
                     },
                     {
                       "kind": "text",
-                      "text": ": removes all subscriptions to that channel or channel 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."
+                      "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": [
@@ -2499,11 +2261,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```"
                         }
                       ]
                     },
@@ -2512,11 +2274,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```"
                         }
                       ]
                     }
@@ -2573,7 +2335,7 @@
           "summary": [
             {
               "kind": "text",
-              "text": "Error codes for realtime errors."
+              "text": "Error codes."
             }
           ]
         },
@@ -2588,7 +2350,7 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "The input is invalid. For example, a channel name with unsupported characters."
+                  "text": "Invalid input such as a channel name with unsupported characters."
                 }
               ]
             },
@@ -2607,7 +2369,7 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "A connection attempt failed. The client keeps retrying automatically with exponential backoff."
+                  "text": "Connection attempt failed. Wix automatically attempts to establish the subscription."
                 }
               ]
             },
@@ -2626,11 +2388,11 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "The connection was closed, either intentionally or due to an error. Check "
+                  "text": "Connection closed intentionally or due to an error. Check "
                 },
                 {
                   "kind": "code",
-                  "text": "`recoverable`"
+                  "text": "`error.recoverable`"
                 },
                 {
                   "kind": "text",
@@ -2653,7 +2415,7 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "The subscription request was rejected by the server. For example, due to an authorization failure. This error is non-recoverable."
+                  "text": "Subscription request rejected, for example, due to an authorization failure. This error is non-recoverable."
                 }
               ]
             },
@@ -2685,7 +2447,7 @@
           "summary": [
             {
               "kind": "text",
-              "text": "An error related to a realtime subscription or connection."
+              "text": "Error thrown by a subscription or connection."
             }
           ]
         },
@@ -2832,7 +2594,7 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "Channel related to the error, if applicable."
+                  "text": "Channel that caused the error."
                 }
               ]
             },
@@ -2853,7 +2615,7 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "Error code indicating the type of error."
+                  "text": "Error code."
                 }
               ]
             },
@@ -2876,7 +2638,7 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "Whether the error is recoverable. When "
+                  "text": "Whether the error is automatically recoverable.\n\nWhen "
                 },
                 {
                   "kind": "code",
@@ -2884,7 +2646,7 @@
                 },
                 {
                   "kind": "text",
-                  "text": ", the client is\nautomatically attempting to reconnect. When "
+                  "text": ", the client automatically attempts to reconnect. When "
                 },
                 {
                   "kind": "code",
@@ -2892,11 +2654,15 @@
                 },
                 {
                   "kind": "text",
-                  "text": ", the subscription\nmust be re-created manually.\n\nDefault: "
+                  "text": ", you must attempt to re-subscribe manually.\n\nDefault: "
                 },
                 {
                   "kind": "code",
                   "text": "`false`"
+                },
+                {
+                  "kind": "text",
+                  "text": "."
                 }
               ]
             },
@@ -2917,31 +2683,7 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "HTTP status code from the server response. For example, "
-                },
-                {
-                  "kind": "code",
-                  "text": "`401`"
-                },
-                {
-                  "kind": "text",
-                  "text": ", "
-                },
-                {
-                  "kind": "code",
-                  "text": "`403`"
-                },
-                {
-                  "kind": "text",
-                  "text": ", or "
-                },
-                {
-                  "kind": "code",
-                  "text": "`500`"
-                },
-                {
-                  "kind": "text",
-                  "text": ".\n\nReturned only when "
+                  "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",
@@ -3006,7 +2748,7 @@
           "summary": [
             {
               "kind": "text",
-              "text": "A message received on a realtime channel."
+              "text": "Message received on a channel."
             }
           ]
         },
@@ -3021,7 +2763,7 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "Message payload containing the published data.\n\nMax: 10 KB."
+                  "text": "Message payload that contains the published data.\n\nMax: 10 KB."
                 }
               ]
             },
@@ -3057,7 +2799,7 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "Information about the user who published the message.\n\nReturned only when the publisher's identity is available."
+                  "text": "Publisher details.\n\nReturned only when the publisher's identity is available."
                 }
               ]
             },
@@ -3089,7 +2831,7 @@
           "summary": [
             {
               "kind": "text",
-              "text": "Information about the user who published a message."
+              "text": "Publisher details."
             }
           ]
         },
@@ -3133,7 +2875,7 @@
           "summary": [
             {
               "kind": "text",
-              "text": "Optional lifecycle handlers for a subscription. Use these to respond to\nsubscription status changes, such as successful connections and errors."
+              "text": "Subscription status handlers that run whenever a subscription is established, re-established, or fails."
             }
           ]
         },
@@ -3150,7 +2892,7 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "Called when the subscription is successfully established.\n\nThis handler fires on the initial subscription and again every time the\nsubscription is automatically restored after a reconnection. 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",
@@ -3158,31 +2900,7 @@
                 },
                 {
                   "kind": "text",
-                  "text": " parameter indicates whether the server restored\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 can't restore anything. Load your\n  initial state independently.\n\n- **Re-subscription after reconnect, "
-                },
-                {
-                  "kind": "code",
-                  "text": "`true`"
-                },
-                {
-                  "kind": "text",
-                  "text": "**: the server\n  found the last received message and replayed everything since.\n  No action needed.\n\n- **Re-subscription after reconnect, "
-                },
-                {
-                  "kind": "code",
-                  "text": "`false`"
-                },
-                {
-                  "kind": "text",
-                  "text": "**: the server\n  couldn't restore missed messages (for example, they expired). Resync your\n  state independently.\n\n<!-- TODO: Document server-side buffer limits for message replay. -->"
+                  "text": " parameter indicates whether missed messages were restored."
                 }
               ],
               "blockTags": [
@@ -3192,7 +2910,7 @@
                   "content": [
                     {
                       "kind": "text",
-                      "text": "ID of the subscription that was established."
+                      "text": "ID of the subscription."
                     }
                   ]
                 },
@@ -3202,7 +2920,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. -->"
                     }
                   ]
                 }
@@ -3227,23 +2993,15 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "Called when a subscription error occurs.\n\nThis handler is triggered in the following scenarios:\n\n- **Subscription failed**: the subscription request was rejected (for example,\n  due to an authorization failure). The error includes the HTTP\n  "
+                  "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": "`status`"
-                },
-                {
-                  "kind": "text",
-                  "text": " code. This is non-recoverable and the subscription\n  doesn't retry automatically.\n\n- **Disconnected**: the connection was closed. Check the "
-                },
-                {
-                  "kind": "code",
-                  "text": "`recoverable`"
+                  "text": "`error.recoverable`"
                 },
                 {
                   "kind": "text",
-                  "text": "\n  flag to determine whether the client is auto-reconnecting ("
+                  "text": ":\n   - When "
                 },
                 {
                   "kind": "code",
@@ -3251,7 +3009,7 @@
                 },
                 {
                   "kind": "text",
-                  "text": ") or\n  whether you need to re-create the subscription ("
+                  "text": ", the error is recoverable. The subscription is automatically re-attempted. No further action necessary.\n   - When "
                 },
                 {
                   "kind": "code",
@@ -3259,11 +3017,11 @@
                 },
                 {
                   "kind": "text",
-                  "text": ").\n\n- **Connection error**: fired on each failed reconnection attempt.\n  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",
@@ -3275,23 +3033,7 @@
                 },
                 {
                   "kind": "text",
-                  "text": " for these errors because the\n  client keeps retrying with exponential backoff.\n\nCheck "
-                },
-                {
-                  "kind": "code",
-                  "text": "`error.recoverable`"
-                },
-                {
-                  "kind": "text",
-                  "text": " to distinguish transient errors from permanent\nfailures. This handler may fire multiple times during a single session.\nA typical recovery flow looks like:\n"
-                },
-                {
-                  "kind": "code",
-                  "text": "`subscribed → error (recoverable) → error (recoverable) → subscribed`"
-                },
-                {
-                  "kind": "text",
-                  "text": "."
+                  "text": ", as the subscription is re-established."
                 }
               ],
               "blockTags": [
@@ -3301,7 +3043,23 @@
                   "content": [
                     {
                       "kind": "text",
-                      "text": "The error that occurred."
+                      "text": "Error that occurred. Check "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`errorCode`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": " and "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`recoverable`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": " to determine the type and whether manual action is required."
                     }
                   ]
                 },
@@ -3311,7 +3069,7 @@
                   "content": [
                     {
                       "kind": "text",
-                      "text": "ID of the affected subscription."
+                      "text": "ID of the subscription that generated the error."
                     }
                   ]
                 }
@@ -3345,7 +3103,7 @@
           "summary": [
             {
               "kind": "text",
-              "text": "Options for specifying what to unsubscribe from.\n\nSpecify "
+              "text": "Unsubscribe options. Specify "
             },
             {
               "kind": "code",
@@ -3353,7 +3111,7 @@
             },
             {
               "kind": "text",
-              "text": " to remove all subscriptions to a channel, "
+              "text": ", "
             },
             {
               "kind": "code",
@@ -3361,15 +3119,15 @@
             },
             {
               "kind": "text",
-              "text": " to remove\na single subscription, or both to remove a specific subscription with channel verification.\nAt least one of "
+              "text": ", or both:\n\n- To remove all subscriptions from a channel, specify the channel in "
             },
             {
               "kind": "code",
-              "text": "`channel`"
+              "text": "`channel.name`"
             },
             {
               "kind": "text",
-              "text": " or "
+              "text": ".\n- To remove a single subscription, specify the "
             },
             {
               "kind": "code",
@@ -3377,7 +3135,7 @@
             },
             {
               "kind": "text",
-              "text": " is required."
+              "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."
             }
           ]
         },
@@ -3394,15 +3152,7 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "Channel to unsubscribe from. When specified without "
-                },
-                {
-                  "kind": "code",
-                  "text": "`subscriptionId`"
-                },
-                {
-                  "kind": "text",
-                  "text": ",\nall subscriptions to this channel are removed."
+                  "text": "Channel or resource to unsubscribe from.\n\nWhen empty, the subscription is removed without verifying that it belongs to the channel."
                 }
               ]
             },
@@ -3425,15 +3175,7 @@
               "summary": [
                 {
                   "kind": "text",
-                  "text": "ID of the subscription to remove. When specified without "
-                },
-                {
-                  "kind": "code",
-                  "text": "`channel`"
-                },
-                {
-                  "kind": "text",
-                  "text": ",\nthe specific subscription is removed regardless of its channel."
+                  "text": "ID of the subscription to remove.\n\nWhen empty, all subscriptions to the specified channel are removed."
                 }
               ]
             },
@@ -3478,7 +3220,7 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Callback that runs when a message is received on a subscribed channel or channel resource."
+                      "text": "Runs when a message is published to a channel or resource the subscriber listens to."
                     }
                   ]
                 },
@@ -3493,7 +3235,7 @@
                       "summary": [
                         {
                           "kind": "text",
-                          "text": "The received message, including the payload and optional publisher information."
+                          "text": "Published message."
                         }
                       ]
                     },
@@ -3514,7 +3256,7 @@
                       "summary": [
                         {
                           "kind": "text",
-                          "text": "The channel the message was received on."
+                          "text": "Channel the message was published to."
                         }
                       ]
                     },
@@ -3560,7 +3302,7 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Callback that runs when a subscription error occurs."
+                      "text": "Runs when a subscription error occurs."
                     }
                   ]
                 },
@@ -3575,7 +3317,7 @@
                       "summary": [
                         {
                           "kind": "text",
-                          "text": "The error that occurred."
+                          "text": "Error that occurred."
                         }
                       ]
                     },
@@ -3596,7 +3338,7 @@
                       "summary": [
                         {
                           "kind": "text",
-                          "text": "ID of the affected subscription."
+                          "text": "ID of the subscription that generated the error."
                         }
                       ]
                     },
@@ -3640,7 +3382,15 @@
                   "summary": [
                     {
                       "kind": "text",
-                      "text": "Callback that runs when a subscription is successfully established or re-established after a reconnection."
+                      "text": "Runs when a subscription is successfully established or re-established.\n\nWhen a subscription fails and is re-established, the subscriber might not receive all messages published during the failure. The "
+                    },
+                    {
+                      "kind": "code",
+                      "text": "`isSynced`"
+                    },
+                    {
+                      "kind": "text",
+                      "text": " flag indicates whether all missed messages were successfully delivered.\n\n<!-- TODO: Document server-side buffer limits for message replay. -->"
                     }
                   ]
                 },
@@ -3655,7 +3405,7 @@
                       "summary": [
                         {
                           "kind": "text",
-                          "text": "ID of the subscription."
+                          "text": "Subscription ID."
                         }
                       ]
                     },
@@ -3674,7 +3424,7 @@
                       "summary": [
                         {
                           "kind": "text",
-                          "text": "Whether the server successfully restored missed messages since the last disconnection. <!-- TODO: Document server-side buffer limits for message replay. -->"
+                          "text": "Whether the message history was fully restored."
                         }
                       ]
                     },
@@ -3743,11 +3493,32 @@
     "symbolIdMap": {}
   },
   "appendices": {
+    "/": [
+      {
+        "type": "GUIDE",
+        "title": "Introduction",
+        "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**](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/publisher/introduction): Backend module that sends messages to channels.\n- [**Site**](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/introduction): Backend module that manages subscriber permissions.\n- [**Subscriber**](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/subscriber/introduction): 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](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/introduction).\n2. A client subscribes to a channel or channel resource using the [Subscriber API](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/subscriber/introduction).\n3. The [`realtime_check_permission`](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/realtime-check-permission) hook checks the subscriber's permissions.\n4. The [Publisher](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/publisher/introduction) 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](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/publisher/introduction) is a backend module that sends messages to subscribers listening to the specified channel or resource.\n\n## Site\n\nThe [Site API](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/introduction) controls subscriber permissions. It determines which subscribers can receive messages on specific channels and resources.\n\nLearn more about [permissions in the Site API](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/permissions-router/introduction).\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](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/permissions-router/introduction) 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](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/subscriber/introduction).\n\n\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"
+      }
+    ],
+    "/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](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/subscriber/introduction) with suitable [permissions](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/permissions-router/introduction) 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](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/publisher/introduction) 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](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/subscriber/unsubscribe) at a later time. \n\nYou can register lifecycle handlers to respond when the subscription succeeds or fails. The [`onSubscribed` handler](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/subscriber/subscribe) runs on every successful connection, including automatic re-subscriptions attempted after network interruptions. The [`onSubscriptionError` handler](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/subscriber/subscribe) 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": "# 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 Site API\n\nThe Site API lets you control subscriber permissions for the [Realtime APIs](ADDLINK). It determines which [subscribers](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/subscriber/introduction) can receive messages on specific [channels and resources](ADDLINK).\n\nTo define permissions, set up the [`realtime_check_permission` hook](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/realtime-check-permission) 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](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/permissions-router/introduction) 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](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/permissions-router/introduction) 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](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/permissions-router/introduction).\n\n<!-- ## Use cases\n\n- [Restrict channels to logged-in members](ADDLINK). -->\n\n@sdk_package_setup"
       },
       {
         "type": "GUIDE",
@@ -3810,7 +3581,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()` hook](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/permissions-router/introduction).\n\nLearn more about the [Site API](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/introduction) and the [Realtime APIs](ADDLINK).\n\nWith the Permissions Router API, you can:\n\n- [Add a handler](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/permissions-router/add) for a specific channel or resource.\n- [Set a default handler](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/permissions-router/default) for channels that don't have explicit handlers.\n- [Check](https://dev.wix.com/docs/sdk/business-solutions/realtime/realtime/site/permissions-router/check) 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": [