@wix/realtime 0.1.3 → 0.1.4

package/README.md

@@ -0,0 +1,2 @@
+⚠️ public package ⚠️
+# @wix/wix-realtime 

package/docs/docs-ts-model.json

@@ -0,0 +1,284 @@
+{
+  "typeDocModel": {
+    "id": 0,
+    "name": "@wix/realtime",
+    "variant": "project",
+    "kind": 1,
+    "flags": {},
+    "children": [
+      {
+        "id": 1,
+        "name": "site",
+        "variant": "declaration",
+        "kind": 4,
+        "flags": {},
+        "children": [
+          {
+            "id": 2,
+            "name": "permissionsRouter",
+            "variant": "declaration",
+            "kind": 32,
+            "flags": {
+              "isConst": true
+            },
+            "sources": [
+              {
+                "fileName": "src/site/index.ts",
+                "line": 6,
+                "character": 6,
+                "url": "https://github.com/wix-private/wix-sdk-realtime/blob/e8e2b31/packages/realtime/src/site/index.ts#L6"
+              }
+            ],
+            "type": {
+              "type": "reference",
+              "target": {
+                "sourceFileName": "src/site/permissions-router.ts",
+                "qualifiedName": "PermissionsRouter"
+              },
+              "name": "PermissionsRouter",
+              "package": "@wix/realtime"
+            },
+            "defaultValue": "..."
+          },
+          {
+            "id": 3,
+            "name": "publish",
+            "variant": "declaration",
+            "kind": 64,
+            "flags": {},
+            "sources": [
+              {
+                "fileName": "src/site/index.ts",
+                "line": 7,
+                "character": 6,
+                "url": "https://github.com/wix-private/wix-sdk-realtime/blob/e8e2b31/packages/realtime/src/site/index.ts#L7"
+              }
+            ],
+            "signatures": [
+              {
+                "id": 4,
+                "name": "publish",
+                "variant": "signature",
+                "kind": 4096,
+                "flags": {},
+                "sources": [
+                  {
+                    "fileName": "src/site/types.ts",
+                    "line": 27,
+                    "character": 24,
+                    "url": "https://github.com/wix-private/wix-sdk-realtime/blob/e8e2b31/packages/realtime/src/site/types.ts#L27"
+                  }
+                ],
+                "parameters": [
+                  {
+                    "id": 5,
+                    "name": "channel",
+                    "variant": "param",
+                    "kind": 32768,
+                    "flags": {},
+                    "type": {
+                      "type": "reference",
+                      "target": {
+                        "sourceFileName": "src/site/types.ts",
+                        "qualifiedName": "Channel"
+                      },
+                      "name": "Channel",
+                      "package": "@wix/realtime"
+                    }
+                  },
+                  {
+                    "id": 6,
+                    "name": "payload",
+                    "variant": "param",
+                    "kind": 32768,
+                    "flags": {},
+                    "type": {
+                      "type": "intrinsic",
+                      "name": "unknown"
+                    }
+                  },
+                  {
+                    "id": 7,
+                    "name": "options",
+                    "variant": "param",
+                    "kind": 32768,
+                    "flags": {
+                      "isOptional": true
+                    },
+                    "type": {
+                      "type": "reference",
+                      "target": {
+                        "sourceFileName": "src/site/types.ts",
+                        "qualifiedName": "PublishOptions"
+                      },
+                      "name": "PublishOptions",
+                      "package": "@wix/realtime"
+                    }
+                  }
+                ],
+                "type": {
+                  "type": "reference",
+                  "target": {
+                    "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
+                    "qualifiedName": "Promise"
+                  },
+                  "typeArguments": [
+                    {
+                      "type": "intrinsic",
+                      "name": "unknown"
+                    }
+                  ],
+                  "name": "Promise",
+                  "package": "typescript"
+                }
+              }
+            ]
+          }
+        ],
+        "groups": [
+          {
+            "title": "Variables",
+            "children": [
+              2
+            ]
+          },
+          {
+            "title": "Functions",
+            "children": [
+              3
+            ]
+          }
+        ],
+        "sources": [
+          {
+            "fileName": "src/site/index.ts",
+            "line": 1,
+            "character": 0,
+            "url": "https://github.com/wix-private/wix-sdk-realtime/blob/e8e2b31/packages/realtime/src/site/index.ts#L1"
+          }
+        ]
+      }
+    ],
+    "groups": [
+      {
+        "title": "Namespaces",
+        "children": [
+          1
+        ]
+      }
+    ],
+    "packageName": "@wix/realtime",
+    "symbolIdMap": {}
+  },
+  "appendices": {
+    "/": [
+      {
+        "type": "GUIDE",
+        "title": "Introduction",
+        "src": "# Introduction\nUsing the Realtime API you can create channels and channel resources where messages\n can be published. Site visitors who subscribe to a channel receive the published\n messages published to that channel. When a message is received you can handle the message any\n way you choose, such as displaying the contents of the message or changing the state\n of page elements depending on the contents of the message. You can also manage the\n permissions of who can read from specific channels.\n\n The `wix-realtime-backend` module is used in conjunction with the \n [`wix-realtime-frontend`](wix-realtime-frontend.html) module.\n\n Get hands-on experience with the Realtime API on our [Hello Realtime](https://www.wix.com/velo/example/hello-realtime) example page. \n\n Typical uses of the Realtime API include implementing a messaging system or\n as an alternative to using a polling mechanism.\n\n The 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 \n For a tutorial on using the Realtime API, see \n [Sending Messages with the Realtime API](https://support.wix.com/en/article/velo-tutorial-sending-messages-with-the-realtime-api).\n\n To use the Realtime API in the backend, import `wixRealtimeBackend` from the `wix-realtime-backend` module:\n\n   ```javascript\n   import wixRealtimeBackend from 'wix-realtime-backend';\n   ```"
+      },
+      {
+        "type": "EXAMPLE",
+        "title": "realtime_check_permission_1.md",
+        "src": "// In realtime-permissions.js\n\nexport function realtime_check_permission(channel, subscriber) {\n  // set default permissions\n  let permissions =  {\"read\": true};\n  \n  if(channel.name === \"MembersOnly\") {\n    if(subscriber.type === \"Member\"){\n      permissions.read = true; \n    }\n    else {\n      permissions.read = false;\n    }\n  }\n  \n  return permissions;\n}"
+      },
+      {
+        "type": "EXAMPLE",
+        "title": "realtime_check_permission_2.md",
+        "src": "// In realtime-permissions.js\n\nimport {permissionsRouter} from 'wix-realtime-backend';\n\npermissionsRouter.default( (channel, subscriber) => {\n  return {\"read\": true};\n} );\n\nconst membersOnlyChannel = {\"name\": \"MembersOnly\"};\n\npermissionsRouter.add(membersOnlyChannel, (channel, subscriber) => {\n  if(subscriber.type === \"Member\") {\n    return {\"read\": true};\n  }\n  else {\n    return {\"read\": false};\n  }\n});\n\nexport function realtime_check_permission(channel, subscriber) {\n  return permissionsRouter.check(channel,subscriber);\n}"
+      },
+      {
+        "type": "EXAMPLE",
+        "title": "realtime_check_permission_3.md",
+        "src": "// In realtime-permissions.js\n\nimport { members } from `wix-members-backend`;\n\nexport async function realtime_check_permission(channel, subscriber) {\n  // set default permissions\n  let permissions =  { \"read\": true };\n\n  if(channel.name === \"BobsOnly\") {\n    let member = await members.getMember(subscriber.id, { fieldsets: ['FULL'] });\n    if(member.contactDetails.firstName === \"Bob\") {\n      permissions.read = true;\n    }\n    else {\n      permissions.read = false;\n    }\n  }\n  \n  return permissions;\n}"
+      },
+      {
+        "type": "EXAMPLE",
+        "title": "realtime_check_permission_4.md",
+        "src": "// In realtime-permissions.js\n\nimport { members } from `wix-members-backend`;\nimport { permissionsRouter } from 'wix-realtime-backend';\n\npermissionsRouter.default((channel, subscriber) => {\n  return {\"read\": true};\n});\n\nconst membersOnlyChannel = {\"name\": \"MembersOnly\"};\n\npermissionsRouter.add( membersOnlyChannel, async (channel, subscriber) => {\n  let member = await members.getMember(subscriber.id, { fieldsets: ['FULL'] });\n  \n  if(channel.resourceId === \"BobsOnly\") {\n    if(member.contactDetails.firstName === \"Bob\") {\n      return { \"read\": true };\n    }\n    else {\n      return { \"read\": false };\n    }\n  }\n  else {\n    return { \"read\": true };\n  }\n} );\n\nexport function realtime_check_permission(channel, subscriber) {\n  return permissionsRouter.check(channel, subscriber);\n}"
+      },
+      {
+        "type": "EXAMPLE",
+        "title": "realtime_check_permission_5.md",
+        "src": "import { subscribe } from 'wix-realtime-frontend';\nimport { publishMessage } from 'backend/realtime';\n\nconst updatesChannel = {name: 'updates'};\nconst updatesMembersChannel = {name: 'updates', resourceId: 'members'};\nconst updatesAdminsChannel = {name: 'updates', resourceId: 'admins'};\nconst updatesGuestsChannel = {name: 'updates', resourceId: 'guests'};\n\n$w.onReady(function () {\n  subscribeToChannels();\n  setupPublishButtons();\n});\n\nfunction subscribeToChannels() {\n  subscribe(updatesChannel, messageHandler)\n    .catch(() => console.log('Not subscribed to updates channel'));\n  subscribe(updatesMembersChannel, messageHandler)\n    .catch(() => console.log('Not subscribed to members channel'));\n  subscribe(updatesAdminsChannel, messageHandler)\n    .catch(() => console.log('Not subscribed to admins channel'));\n  subscribe(updatesGuestsChannel, messageHandler)\n    .catch(() => console.log('Not subscribed to guest channel'));\n}\n\nfunction messageHandler(message, channel) {\n  const channelName = channel.name;\n  const channelResource = channel.resourceId ? `-${channel.resourceId}` : '';\n  let newMessageLine = `${channelName}${channelResource}: ${message.payload}\\n`;\n  $w('#receivedMessages').value += newMessageLine;\n}\n\nfunction setupPublishButtons() {\n  $w('#updateButton').onClick(event => {\n    publish(event.target, updatesChannel);\n  });\n\n  $w('#memberUpdateButton').onClick(event => {\n    publish(event.target, updatesMembersChannel);\n  });\n\n  $w('#adminUpdateButton').onClick(event => {\n    publish(event.target, updatesAdminsChannel);\n  });\n\n  $w('#guestUpdateButton').onClick(event => {\n    publish(event.target, updatesGuestsChannel);\n  });\n}\n\nasync function publish(button, channel) {\n  if ($w('#message').value) {\n    button.disable();\n    $w('#message').disable();\n\n    await publishMessage(channel, $w('#message').value);\n\n    $w('#message').value = undefined;\n    $w('#message').enable();\n    button.enable();\n  }\n}"
+      },
+      {
+        "type": "EXAMPLE",
+        "title": "publish_1.md",
+        "src": "import wixRealtimeBackend from 'wix-realtime-backend';\n\n// ...\n\nconst channel = {\"name\": \"someChannel\"};\n\nwixRealtimeBackend.publish(channel, \"My message\")\n  .then(() => {\n    // published\n  });"
+      },
+      {
+        "type": "EXAMPLE",
+        "title": "publish_2.md",
+        "src": "import wixRealtimeBackend from 'wix-realtime-backend';\n\n// ...\n\nconst channel = {\n  \"name\": \"someChannel\",\n  \"resourceId\": \"someId\"\n};\n\nwixRealtimeBackend.publish(channel, \"My message\")\n  .then(() => {\n    // published\n  });"
+      },
+      {
+        "type": "EXAMPLE",
+        "title": "publish_3.md",
+        "src": "import wixRealtimeBackend from 'wix-realtime-backend';\n\n// ...\n\nconst channel = {\"name\": \"someChannel\"};\n\nconst message = {\n  \"firstKey\": \"firstValue\",\n  \"secondKey\": \"secondValue\"\n};\n\nconst user1 = // get ID of first user to publish to\nconst user2 = // get ID of second user to publish to\n\nconst options = {\n  \"users\" : [user1, user2],\n  \"includePublisher\": true\n};\n\nwixRealtimeBackend.publish(channel, message, options)\n  .then( () => {\n    // published\n  } );"
+      },
+      {
+        "type": "EXAMPLE",
+        "title": "publish_4.md",
+        "src": "import { subscribe } from 'wix-realtime-frontend';\nimport { publishMessage } from 'backend/realtime';\n\nconst channelA = { name: 'a' };\nconst channelB = { name: 'b' };\nconst channelB1 = { name: 'b', resourceId: '1' };\nconst channelB2 = { name: 'b', resourceId: '2' };\n\n$w.onReady(function () {\n  subscribeToChannels();\n  setupPublishButtons();\n});\n\nfunction subscribeToChannels() {\n  subscribe(channelA, messageHandler);\n  subscribe(channelB, messageHandler);\n  subscribe(channelB1, messageHandler);\n  subscribe(channelB2, messageHandler);\n}\n\nfunction setupPublishButtons() {\n  $w('#publishButtonA').onClick(event => {\n    publish(event.target, channelA);\n  });\n\n  $w('#publishButtonB').onClick(event => {\n    publish(event.target, channelB);\n  });\n\n  $w('#publishButtonB1').onClick(event => {\n    publish(event.target, channelB1);\n  });\n\n  $w('#publishButtonB2').onClick(event => {\n    publish(event.target, channelB2);\n  });\n}\n\nasync function publish(button, channel) {\n  if ($w('#message').value) {\n    button.disable();\n    $w('#message').disable();\n\n    await publishMessage(channel, $w('#message').value);\n\n    $w('#message').value = undefined;\n    $w('#message').enable();\n    button.enable();\n  }\n}\n\nfunction messageHandler(message, channel) {\n  let textBoxId;\n\n  if (channel.name === 'a') {\n    textBoxId = '#receivedMessagesA';\n  } else { // Channel B - check resource ID\n    if (channel.resourceId === '1') {\n      textBoxId = '#receivedMessagesB1';\n    } else if (channel.resourceId === '2') {\n      textBoxId = '#receivedMessagesB2';\n    } else {\n      textBoxId = '#receivedMessagesB';\n    }\n  }\n\n  $w(textBoxId).value += (message.payload + '\\n');\n}"
+      },
+      {
+        "type": "EXAMPLE",
+        "title": "permissionsRouter_1.md",
+        "src": "// In realtime-permissions.js\n\nimport {permissionsRouter} from 'wix-realtime-backend';\n\npermissionsRouter.default( (channel, subscriber) => {\n  return {\"read\": true};\n} );\n\nconst membersOnlyChannel = {\"name\": \"MembersOnly\"};\n\npermissionsRouter.add(membersOnlyChannel, (channel, subscriber) => {\n  if(subscriber.type === \"Member\") {\n    return {\"read\": true};\n  }\n  else {\n    return {\"read\": false};\n  }\n});\n\nexport function realtime_check_permission(channel, subscriber) {\n  return permissionsRouter.check(channel,subscriber);\n}"
+      },
+      {
+        "type": "EXAMPLE",
+        "title": "permissionsRouter_2.md",
+        "src": "// In realtime-permissions.js\n\nimport { members } from `wix-members-backend`;\nimport { permissionsRouter } from 'wix-realtime-backend';\n\npermissionsRouter.default((channel, subscriber) => {\n  return {\"read\": true};\n});\n\nconst membersOnlyChannel = {\"name\": \"MembersOnly\"};\n\npermissionsRouter.add( membersOnlyChannel, async (channel, subscriber) => {\n  let member = await members.getMember(subscriber.id, { fieldsets: ['FULL'] });\n  \n  if(channel.resourceId === \"BobsOnly\") {\n    if(member.contactDetails.firstName === \"Bob\") {\n      return { \"read\": true };\n    }\n    else {\n      return { \"read\": false };\n    }\n  }\n  else {\n    return { \"read\": true };\n  }\n} );\n\nexport function realtime_check_permission(channel, subscriber) {\n  return permissionsRouter.check(channel, subscriber);\n}"
+      },
+      {
+        "type": "EXAMPLE",
+        "title": "default_1.md",
+        "src": "// In realtime-permissions.js\n\nimport {permissionsRouter} from 'wix-realtime-backend';\n\n// ...\n\npermissionsRouter.default( (channel, subscriber) => {\n  // return default permissions\n  return {\"read\": true};\n} );"
+      },
+      {
+        "type": "EXAMPLE",
+        "title": "default_2.md",
+        "src": "// In realtime-permissions.js\n\nimport {permissionsRouter} from 'wix-realtime-backend';\n\npermissionsRouter.default( (channel, subscriber) => {\n  return {\"read\": true};\n} );\n\nconst membersOnlyChannel = {\"name\": \"MembersOnly\"};\n\npermissionsRouter.add(membersOnlyChannel, (channel, subscriber) => {\n  if(subscriber.type === \"Member\") {\n    return {\"read\": true};\n  }\n  else {\n    return {\"read\": false};\n  }\n});\n\nexport function realtime_check_permission(channel, subscriber) {\n  return permissionsRouter.check(channel,subscriber);\n}"
+      },
+      {
+        "type": "EXAMPLE",
+        "title": "default_3.md",
+        "src": "// In realtime-permissions.js\n\nimport { members } from `wix-members-backend`;\nimport { permissionsRouter } from 'wix-realtime-backend';\n\npermissionsRouter.default((channel, subscriber) => {\n  return {\"read\": true};\n});\n\nconst membersOnlyChannel = {\"name\": \"MembersOnly\"};\n\npermissionsRouter.add( membersOnlyChannel, async (channel, subscriber) => {\n  let member = await members.getMember(subscriber.id, { fieldsets: ['FULL'] });\n  \n  if(channel.resourceId === \"BobsOnly\") {\n    if(member.contactDetails.firstName === \"Bob\") {\n      return { \"read\": true };\n    }\n    else {\n      return { \"read\": false };\n    }\n  }\n  else {\n    return { \"read\": true };\n  }\n} );\n\nexport function realtime_check_permission(channel, subscriber) {\n  return permissionsRouter.check(channel, subscriber);\n}"
+      },
+      {
+        "type": "EXAMPLE",
+        "title": "check_1.md",
+        "src": "// In realtime-permissions.js\n\nimport {permissionsRouter} from 'wix-realtime-backend';\n\n// ...\n\nexport function realtime_check_permission(channel, subscriber) {\n  return permissionsRouter.check(channel,subscriber);\n}"
+      },
+      {
+        "type": "EXAMPLE",
+        "title": "check_2.md",
+        "src": "// In realtime-permissions.js\n\nimport {permissionsRouter} from 'wix-realtime-backend';\n\npermissionsRouter.default( (channel, subscriber) => {\n  return {\"read\": true};\n} );\n\nconst membersOnlyChannel = {\"name\": \"MembersOnly\"};\n\npermissionsRouter.add(membersOnlyChannel, (channel, subscriber) => {\n  if(subscriber.type === \"Member\") {\n    return {\"read\": true};\n  }\n  else {\n    return {\"read\": false};\n  }\n});\n\nexport function realtime_check_permission(channel, subscriber) {\n  return permissionsRouter.check(channel,subscriber);\n}"
+      },
+      {
+        "type": "EXAMPLE",
+        "title": "check_3.md",
+        "src": "// In realtime-permissions.js\n\nimport { members } from `wix-members-backend`;\nimport { permissionsRouter } from 'wix-realtime-backend';\n\npermissionsRouter.default((channel, subscriber) => {\n  return {\"read\": true};\n});\n\nconst membersOnlyChannel = {\"name\": \"MembersOnly\"};\n\npermissionsRouter.add( membersOnlyChannel, async (channel, subscriber) => {\n  let member = await members.getMember(subscriber.id, { fieldsets: ['FULL'] });\n  \n  if(channel.resourceId === \"BobsOnly\") {\n    if(member.contactDetails.firstName === \"Bob\") {\n      return { \"read\": true };\n    }\n    else {\n      return { \"read\": false };\n    }\n  }\n  else {\n    return { \"read\": true };\n  }\n} );\n\nexport function realtime_check_permission(channel, subscriber) {\n  return permissionsRouter.check(channel, subscriber);\n}"
+      },
+      {
+        "type": "EXAMPLE",
+        "title": "add_1.md",
+        "src": "// In realtime-permissions.js\n\nimport {permissionsRouter} from 'wix-realtime-backend';\n\n// ...\n\nconst adminAnnouncements = {\"name\": \"announcements\"}\n\npermissionsRouter.add( adminAnnouncements, (channel, subscriber) => {\n  // add permissions check logic and return\n  // permissions for announcements channel\n  if(subscriber.type === \"Admin\") {\n    return {\"read\": true};\n  }\n  else {\n    return {\"read\": true};\n  }\n} );"
+      },
+      {
+        "type": "EXAMPLE",
+        "title": "add_2.md",
+        "src": "// In realtime-permissions.js\n\nimport {permissionsRouter} from 'wix-realtime-backend';\n\npermissionsRouter.default( (channel, subscriber) => {\n  return {\"read\": true};\n} );\n\nconst membersOnlyChannel = {\"name\": \"MembersOnly\"};\n\npermissionsRouter.add(membersOnlyChannel, (channel, subscriber) => {\n  if(subscriber.type === \"Member\") {\n    return {\"read\": true};\n  }\n  else {\n    return {\"read\": false};\n  }\n});\n\nexport function realtime_check_permission(channel, subscriber) {\n  return permissionsRouter.check(channel,subscriber);\n}"
+      },
+      {
+        "type": "EXAMPLE",
+        "title": "add_3.md",
+        "src": "// In realtime-permissions.js\n\nimport { members } from `wix-members-backend`;\nimport { permissionsRouter } from 'wix-realtime-backend';\n\npermissionsRouter.default((channel, subscriber) => {\n  return {\"read\": true};\n});\n\nconst membersOnlyChannel = {\"name\": \"MembersOnly\"};\n\npermissionsRouter.add( membersOnlyChannel, async (channel, subscriber) => {\n  let member = await members.getMember(subscriber.id, { fieldsets: ['FULL'] });\n  \n  if(channel.resourceId === \"BobsOnly\") {\n    if(member.contactDetails.firstName === \"Bob\") {\n      return { \"read\": true };\n    }\n    else {\n      return { \"read\": false };\n    }\n  }\n  else {\n    return { \"read\": true };\n  }\n} );\n\nexport function realtime_check_permission(channel, subscriber) {\n  return permissionsRouter.check(channel, subscriber);\n}"
+      }
+    ]
+  },
+  "standaloneTypes": {},
+  "metadata": {}
+}

package/package.json

@@ -1,21 +1,22 @@
 {
   "name": "@wix/realtime",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "license": "MIT",
   "main": "cjs/build/index.js",
   "module": "build/index.mjs",
   "type": "module",
   "files": [
     "build",
-    "cjs"
+    "cjs",
+    "docs/docs-ts-model.json"
   ],
   "scripts": {
     "build": "tsc -b tsconfig.json tsconfig.cjs.json",
+    "docs": "docs-ts-model --config ./docs/cli-config.json",
     "test": "tsx --test test/*.spec.ts",
     "lint": "eslint",
     "lint:fix": "eslint --max-warnings=0 . --fix",
-    "typecheck": "tsc --noEmit",
-    "wix:docs": "npx -y @wix/docs-ts-model --config ./docs/cli-config.json"
+    "typecheck": "tsc --noEmit"
   },
   "dependencies": {
     "@wix/sdk-runtime": "^0.3.35"
@@ -25,6 +26,7 @@
     "@types/chance": "^1",
     "@types/express": "^5.0.0",
     "@types/node": "^20.14.2",
+    "@wix/docs-ts-model": "^1.35.0",
     "@wix/sdk": "^1.10.0",
     "@wix/sdk-types": "^1.8.0",
     "chance": "^1.1.11",
@@ -49,13 +51,12 @@
     },
     "validations": {
       "source": [
-        "lint",
-        "wix:docs"
+        "lint"
       ],
       "postDependenciesBuild": [
         "typecheck"
       ]
     }
   },
-  "falconPackageHash": "ee0a301c5d49dbe2635baf800eda272316abbefb4488720b7e42d039"
+  "falconPackageHash": "892a540be192c3e72dd6b122fb9c746c00e6e0f8f8266bb345b03459"
 }