@wix/realtime 1.0.46 → 1.0.47

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

@@ -6,14 +6,6 @@
     "kind": 1,
     "flags": {},
     "children": [
-      {
-        "id": 72,
-        "name": "Channel",
-        "variant": "reference",
-        "kind": 8388608,
-        "flags": {},
-        "target": 31
-      },
       {
         "id": 52,
         "name": "publisher",
@@ -2087,8 +2079,8 @@
                     },
                     "type": {
                       "type": "reference",
-                      "target": 31,
-                      "name": "Channel",
+                      "target": 73,
+                      "name": "SubscribeChannel",
                       "package": "@wix/realtime-common"
                     }
                   },
@@ -2108,7 +2100,7 @@
                     },
                     "type": {
                       "type": "reference",
-                      "target": 76,
+                      "target": 80,
                       "name": "MessageHandler",
                       "package": "@wix/realtime-common"
                     }
@@ -2131,7 +2123,7 @@
                     },
                     "type": {
                       "type": "reference",
-                      "target": 93,
+                      "target": 97,
                       "name": "SubscriptionOptions",
                       "package": "@wix/realtime-common"
                     }
@@ -2355,7 +2347,7 @@
                     },
                     "type": {
                       "type": "reference",
-                      "target": 96,
+                      "target": 100,
                       "name": "UnsubscribeOptions",
                       "package": "@wix/realtime-common"
                     }
@@ -2475,7 +2467,7 @@
         ]
       },
       {
-        "id": 113,
+        "id": 117,
         "name": "RealtimeErrorCode",
         "variant": "declaration",
         "kind": 8,
@@ -2490,7 +2482,7 @@
         },
         "children": [
           {
-            "id": 117,
+            "id": 121,
             "name": "BadInput",
             "variant": "declaration",
             "kind": 16,
@@ -2509,7 +2501,7 @@
             }
           },
           {
-            "id": 115,
+            "id": 119,
             "name": "ConnectionError",
             "variant": "declaration",
             "kind": 16,
@@ -2528,7 +2520,7 @@
             }
           },
           {
-            "id": 114,
+            "id": 118,
             "name": "Disconnected",
             "variant": "declaration",
             "kind": 16,
@@ -2555,7 +2547,7 @@
             }
           },
           {
-            "id": 116,
+            "id": 120,
             "name": "SubscriptionFailed",
             "variant": "declaration",
             "kind": 16,
@@ -2578,16 +2570,16 @@
           {
             "title": "Enumeration Members",
             "children": [
-              117,
-              115,
-              114,
-              116
+              121,
+              119,
+              118,
+              120
             ]
           }
         ]
       },
       {
-        "id": 99,
+        "id": 103,
         "name": "RealtimeError",
         "variant": "declaration",
         "kind": 128,
@@ -2602,34 +2594,34 @@
         },
         "children": [
           {
-            "id": 100,
+            "id": 104,
             "name": "constructor",
             "variant": "declaration",
             "kind": 512,
             "flags": {},
             "signatures": [
               {
-                "id": 101,
+                "id": 105,
                 "name": "new RealtimeError",
                 "variant": "signature",
                 "kind": 16384,
                 "flags": {},
                 "parameters": [
                   {
-                    "id": 102,
+                    "id": 106,
                     "name": "errorCode",
                     "variant": "param",
                     "kind": 32768,
                     "flags": {},
                     "type": {
                       "type": "reference",
-                      "target": 113,
+                      "target": 117,
                       "name": "RealtimeErrorCode",
                       "package": "@wix/realtime-common"
                     }
                   },
                   {
-                    "id": 103,
+                    "id": 107,
                     "name": "message",
                     "variant": "param",
                     "kind": 32768,
@@ -2640,7 +2632,7 @@
                     }
                   },
                   {
-                    "id": 104,
+                    "id": 108,
                     "name": "options",
                     "variant": "param",
                     "kind": 32768,
@@ -2650,14 +2642,14 @@
                     "type": {
                       "type": "reflection",
                       "declaration": {
-                        "id": 105,
+                        "id": 109,
                         "name": "__type",
                         "variant": "declaration",
                         "kind": 65536,
                         "flags": {},
                         "children": [
                           {
-                            "id": 106,
+                            "id": 110,
                             "name": "channel",
                             "variant": "declaration",
                             "kind": 1024,
@@ -2666,13 +2658,13 @@
                             },
                             "type": {
                               "type": "reference",
-                              "target": 31,
-                              "name": "Channel",
+                              "target": 73,
+                              "name": "SubscribeChannel",
                               "package": "@wix/realtime-common"
                             }
                           },
                           {
-                            "id": 107,
+                            "id": 111,
                             "name": "recoverable",
                             "variant": "declaration",
                             "kind": 1024,
@@ -2685,7 +2677,7 @@
                             }
                           },
                           {
-                            "id": 108,
+                            "id": 112,
                             "name": "status",
                             "variant": "declaration",
                             "kind": 1024,
@@ -2702,9 +2694,9 @@
                           {
                             "title": "Properties",
                             "children": [
-                              106,
-                              107,
-                              108
+                              110,
+                              111,
+                              112
                             ]
                           }
                         ]
@@ -2714,7 +2706,7 @@
                 ],
                 "type": {
                   "type": "reference",
-                  "target": 99,
+                  "target": 103,
                   "name": "RealtimeError",
                   "package": "@wix/realtime-common"
                 },
@@ -2732,7 +2724,7 @@
             }
           },
           {
-            "id": 110,
+            "id": 114,
             "name": "channel",
             "variant": "declaration",
             "kind": 1024,
@@ -2749,13 +2741,13 @@
             },
             "type": {
               "type": "reference",
-              "target": 31,
-              "name": "Channel",
+              "target": 73,
+              "name": "SubscribeChannel",
               "package": "@wix/realtime-common"
             }
           },
           {
-            "id": 109,
+            "id": 113,
             "name": "errorCode",
             "variant": "declaration",
             "kind": 1024,
@@ -2770,13 +2762,13 @@
             },
             "type": {
               "type": "reference",
-              "target": 113,
+              "target": 117,
               "name": "RealtimeErrorCode",
               "package": "@wix/realtime-common"
             }
           },
           {
-            "id": 111,
+            "id": 115,
             "name": "recoverable",
             "variant": "declaration",
             "kind": 1024,
@@ -2821,7 +2813,7 @@
             }
           },
           {
-            "id": 112,
+            "id": 116,
             "name": "status",
             "variant": "declaration",
             "kind": 1024,
@@ -2862,16 +2854,16 @@
           {
             "title": "Constructors",
             "children": [
-              100
+              104
             ]
           },
           {
             "title": "Properties",
             "children": [
-              110,
-              109,
-              111,
-              112
+              114,
+              113,
+              115,
+              116
             ]
           }
         ],
@@ -2888,7 +2880,7 @@
         ]
       },
       {
-        "id": 73,
+        "id": 77,
         "name": "Message",
         "variant": "declaration",
         "kind": 256,
@@ -2903,7 +2895,7 @@
         },
         "children": [
           {
-            "id": 74,
+            "id": 78,
             "name": "payload",
             "variant": "declaration",
             "kind": 1024,
@@ -2937,7 +2929,7 @@
             }
           },
           {
-            "id": 75,
+            "id": 79,
             "name": "publisher",
             "variant": "declaration",
             "kind": 1024,
@@ -2954,7 +2946,7 @@
             },
             "type": {
               "type": "reference",
-              "target": 81,
+              "target": 85,
               "name": "Publisher",
               "package": "@wix/realtime-common"
             }
@@ -2964,14 +2956,14 @@
           {
             "title": "Properties",
             "children": [
-              74,
-              75
+              78,
+              79
             ]
           }
         ]
       },
       {
-        "id": 81,
+        "id": 85,
         "name": "Publisher",
         "variant": "declaration",
         "kind": 256,
@@ -2986,7 +2978,7 @@
         },
         "children": [
           {
-            "id": 82,
+            "id": 86,
             "name": "id",
             "variant": "declaration",
             "kind": 1024,
@@ -3009,13 +3001,159 @@
           {
             "title": "Properties",
             "children": [
-              82
+              86
+            ]
+          }
+        ]
+      },
+      {
+        "id": 73,
+        "name": "SubscribeChannel",
+        "variant": "declaration",
+        "kind": 256,
+        "flags": {},
+        "comment": {
+          "summary": [
+            {
+              "kind": "text",
+              "text": "Realtime broadcast subscribed channel. Subscribers listen to messages published to channels."
+            }
+          ]
+        },
+        "children": [
+          {
+            "id": 74,
+            "name": "appId",
+            "variant": "declaration",
+            "kind": 1024,
+            "flags": {
+              "isOptional": true
+            },
+            "comment": {
+              "summary": [
+                {
+                  "kind": "text",
+                  "text": "App ID of the channel owner.\n\nSet this to subscribe to a channel owned by a different app (cross-app subscription). When omitted, the channel is assumed to be owned by the caller's app.\n\nThe channel owner must implement the "
+                },
+                {
+                  "kind": "code",
+                  "text": "`REALTIME_PERMISSIONS_PROVIDER`"
+                },
+                {
+                  "kind": "text",
+                  "text": " SPI to authorize cross-app subscriptions; otherwise the subscription is denied.\n\nUse "
+                },
+                {
+                  "kind": "code",
+                  "text": "`WIX_APPS`"
+                },
+                {
+                  "kind": "text",
+                  "text": " from "
+                },
+                {
+                  "kind": "code",
+                  "text": "`@wix/essentials`"
+                },
+                {
+                  "kind": "text",
+                  "text": " to reference well-known Wix app IDs."
+                }
+              ]
+            },
+            "type": {
+              "type": "intrinsic",
+              "name": "string"
+            }
+          },
+          {
+            "id": 75,
+            "name": "name",
+            "variant": "declaration",
+            "kind": 1024,
+            "flags": {},
+            "comment": {
+              "summary": [
+                {
+                  "kind": "text",
+                  "text": "Channel name.\n\n> **Notes:**\n> - Supports only alphanumeric characters, hyphens, and underscores.\n> - The combined length of "
+                },
+                {
+                  "kind": "code",
+                  "text": "`name`"
+                },
+                {
+                  "kind": "text",
+                  "text": " and "
+                },
+                {
+                  "kind": "code",
+                  "text": "`resourceId`"
+                },
+                {
+                  "kind": "text",
+                  "text": " can't exceed 140 characters."
+                }
+              ]
+            },
+            "type": {
+              "type": "intrinsic",
+              "name": "string"
+            },
+            "inheritedFrom": {
+              "type": "reference",
+              "target": -1,
+              "name": "PublishChannel.name"
+            }
+          },
+          {
+            "id": 76,
+            "name": "resourceId",
+            "variant": "declaration",
+            "kind": 1024,
+            "flags": {
+              "isOptional": true
+            },
+            "comment": {
+              "summary": [
+                {
+                  "kind": "text",
+                  "text": "Resource ID.\n\nResources are independent sub-channels in a channel. A subscriber listening to a resource doesn't receive messages published to the parent channel, and vice versa."
+                }
+              ]
+            },
+            "type": {
+              "type": "intrinsic",
+              "name": "string"
+            },
+            "inheritedFrom": {
+              "type": "reference",
+              "target": -1,
+              "name": "PublishChannel.resourceId"
+            }
+          }
+        ],
+        "groups": [
+          {
+            "title": "Properties",
+            "children": [
+              74,
+              75,
+              76
             ]
           }
+        ],
+        "extendedTypes": [
+          {
+            "type": "reference",
+            "target": 72,
+            "name": "PublishChannel",
+            "package": "@wix/realtime-common"
+          }
         ]
       },
       {
-        "id": 93,
+        "id": 97,
         "name": "SubscriptionOptions",
         "variant": "declaration",
         "kind": 256,
@@ -3030,7 +3168,7 @@
         },
         "children": [
           {
-            "id": 94,
+            "id": 98,
             "name": "onSubscribed",
             "variant": "declaration",
             "kind": 1024,
@@ -3125,13 +3263,13 @@
             },
             "type": {
               "type": "reference",
-              "target": 88,
+              "target": 92,
               "name": "SubscriptionHandler",
               "package": "@wix/realtime-common"
             }
           },
           {
-            "id": 95,
+            "id": 99,
             "name": "onSubscriptionError",
             "variant": "declaration",
             "kind": 1024,
@@ -3226,7 +3364,7 @@
             },
             "type": {
               "type": "reference",
-              "target": 83,
+              "target": 87,
               "name": "SubscriptionErrorHandler",
               "package": "@wix/realtime-common"
             }
@@ -3236,14 +3374,14 @@
           {
             "title": "Properties",
             "children": [
-              94,
-              95
+              98,
+              99
             ]
           }
         ]
       },
       {
-        "id": 96,
+        "id": 100,
         "name": "UnsubscribeOptions",
         "variant": "declaration",
         "kind": 256,
@@ -3290,7 +3428,7 @@
         },
         "children": [
           {
-            "id": 97,
+            "id": 101,
             "name": "channel",
             "variant": "declaration",
             "kind": 1024,
@@ -3307,13 +3445,13 @@
             },
             "type": {
               "type": "reference",
-              "target": 31,
-              "name": "Channel",
+              "target": 73,
+              "name": "SubscribeChannel",
               "package": "@wix/realtime-common"
             }
           },
           {
-            "id": 98,
+            "id": 102,
             "name": "subscriptionId",
             "variant": "declaration",
             "kind": 1024,
@@ -3338,14 +3476,14 @@
           {
             "title": "Properties",
             "children": [
-              97,
-              98
+              101,
+              102
             ]
           }
         ]
       },
       {
-        "id": 76,
+        "id": 80,
         "name": "MessageHandler",
         "variant": "declaration",
         "kind": 4194304,
@@ -3353,14 +3491,14 @@
         "type": {
           "type": "reflection",
           "declaration": {
-            "id": 77,
+            "id": 81,
             "name": "__type",
             "variant": "declaration",
             "kind": 65536,
             "flags": {},
             "signatures": [
               {
-                "id": 78,
+                "id": 82,
                 "name": "__type",
                 "variant": "signature",
                 "kind": 4096,
@@ -3375,7 +3513,7 @@
                 },
                 "parameters": [
                   {
-                    "id": 79,
+                    "id": 83,
                     "name": "message",
                     "variant": "param",
                     "kind": 32768,
@@ -3390,13 +3528,13 @@
                     },
                     "type": {
                       "type": "reference",
-                      "target": 73,
+                      "target": 77,
                       "name": "Message",
                       "package": "@wix/realtime-common"
                     }
                   },
                   {
-                    "id": 80,
+                    "id": 84,
                     "name": "channel",
                     "variant": "param",
                     "kind": 32768,
@@ -3411,8 +3549,8 @@
                     },
                     "type": {
                       "type": "reference",
-                      "target": 31,
-                      "name": "Channel",
+                      "target": 73,
+                      "name": "SubscribeChannel",
                       "package": "@wix/realtime-common"
                     }
                   }
@@ -3427,7 +3565,35 @@
         }
       },
       {
-        "id": 83,
+        "id": 72,
+        "name": "PublishChannel",
+        "variant": "declaration",
+        "kind": 4194304,
+        "flags": {},
+        "comment": {
+          "summary": [
+            {
+              "kind": "text",
+              "text": "Realtime broadcast published channel. Publishers send messages to channels and subscribers listen to them."
+            }
+          ]
+        },
+        "type": {
+          "type": "reference",
+          "target": 31,
+          "name": "Channel",
+          "package": "@wix/realtime-common"
+        },
+        "extendedBy": [
+          {
+            "type": "reference",
+            "target": 73,
+            "name": "SubscribeChannel"
+          }
+        ]
+      },
+      {
+        "id": 87,
         "name": "SubscriptionErrorHandler",
         "variant": "declaration",
         "kind": 4194304,
@@ -3435,14 +3601,14 @@
         "type": {
           "type": "reflection",
           "declaration": {
-            "id": 84,
+            "id": 88,
             "name": "__type",
             "variant": "declaration",
             "kind": 65536,
             "flags": {},
             "signatures": [
               {
-                "id": 85,
+                "id": 89,
                 "name": "__type",
                 "variant": "signature",
                 "kind": 4096,
@@ -3457,7 +3623,7 @@
                 },
                 "parameters": [
                   {
-                    "id": 86,
+                    "id": 90,
                     "name": "error",
                     "variant": "param",
                     "kind": 32768,
@@ -3472,13 +3638,13 @@
                     },
                     "type": {
                       "type": "reference",
-                      "target": 99,
+                      "target": 103,
                       "name": "RealtimeError",
                       "package": "@wix/realtime-common"
                     }
                   },
                   {
-                    "id": 87,
+                    "id": 91,
                     "name": "subscriptionId",
                     "variant": "param",
                     "kind": 32768,
@@ -3507,7 +3673,7 @@
         }
       },
       {
-        "id": 88,
+        "id": 92,
         "name": "SubscriptionHandler",
         "variant": "declaration",
         "kind": 4194304,
@@ -3515,14 +3681,14 @@
         "type": {
           "type": "reflection",
           "declaration": {
-            "id": 89,
+            "id": 93,
             "name": "__type",
             "variant": "declaration",
             "kind": 65536,
             "flags": {},
             "signatures": [
               {
-                "id": 90,
+                "id": 94,
                 "name": "__type",
                 "variant": "signature",
                 "kind": 4096,
@@ -3545,7 +3711,7 @@
                 },
                 "parameters": [
                   {
-                    "id": 91,
+                    "id": 95,
                     "name": "subscriptionId",
                     "variant": "param",
                     "kind": 32768,
@@ -3564,7 +3730,7 @@
                     }
                   },
                   {
-                    "id": 92,
+                    "id": 96,
                     "name": "isSynced",
                     "variant": "param",
                     "kind": 32768,
@@ -3594,12 +3760,6 @@
       }
     ],
     "groups": [
-      {
-        "title": "References",
-        "children": [
-          72
-        ]
-      },
       {
         "title": "Namespaces",
         "children": [
@@ -3611,30 +3771,32 @@
       {
         "title": "Enumerations",
         "children": [
-          113
+          117
         ]
       },
       {
         "title": "Classes",
         "children": [
-          99
+          103
         ]
       },
       {
         "title": "Interfaces",
         "children": [
+          77,
+          85,
           73,
-          81,
-          93,
-          96
+          97,
+          100
         ]
       },
       {
         "title": "Type Aliases",
         "children": [
-          76,
-          83,
-          88
+          80,
+          72,
+          87,
+          92
         ]
       }
     ],