@sanity/preview-kit-compat - npm Package Compare versions

Comparing version 1.5.22 to 1.5.23

CHANGELOG.md

@@ -39,2 +39,13 @@ <!-- markdownlint-disable --><!-- textlint-disable -->
 
+## [1.5.23](https://github.com/sanity-io/visual-editing/compare/preview-kit-compat-v1.5.22...preview-kit-compat-v1.5.23) (2024-11-28)
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @sanity/comlink bumped to 2.0.0
+  * devDependencies
+    * @repo/visual-editing-helpers bumped to 0.7.5
+
 ## [1.5.22](https://github.com/sanity-io/visual-editing/compare/preview-kit-compat-v1.5.21...preview-kit-compat-v1.5.22) (2024-11-26)
@@ -41,0 +52,0 @@

dist/index.js

@@ -27,4 +27,7 @@ import { createListenLogic, createRequestMachine, DOMAIN, MSG_HANDSHAKE_SYN, MSG_HANDSHAKE_SYN_ACK, MSG_HANDSHAKE_ACK, MSG_RESPONSE, MSG_HEARTBEAT, MSG_DISCONNECT, createNode, createNodeMachine } from "@sanity/comlink";
   const { data } = event;
-  return data && typeof data == "object" && "domain" in data && "type" in data && "from" in data && "to" in data && (data.domain === "sanity/channels" && (data.domain = DOMAIN), data.to === "overlays" && (data.to = "visual-editing"), data.from === "overlays" && (data.from = "visual-editing"), data.type = channelsToComlinkMap[data.type] ?? data.type), event;
-}, convertToChannelsMessage = (message) => (message.domain === DOMAIN && (message.domain = "sanity/channels"), message.to === "visual-editing" && (message.to = "overlays"), message.from === "visual-editing" && (message.from = "overlays"), message.type = comlinkToChannelsMap[message.type] ?? message.type, message.type === "channel/response" && message.responseTo && !message.data && (message.data = { responseTo: message.responseTo }), (message.type === "handshake/syn" || message.type === "handshake/syn-ack" || message.type === "handshake/ack") && (message.data = { id: message.connectionId }), message), sendAsChannelsMessage = ({ context }, params) => {
+  return data && typeof data == "object" && "domain" in data && "type" in data && "from" in data && "to" in data && (data.domain === "sanity/channels" && (data.domain = DOMAIN), data.to === "overlays" && (data.to = "visual-editing"), data.from === "overlays" && (data.from = "visual-editing"), data.channelId = data.connectionId, delete data.connectionId, data.type = channelsToComlinkMap[data.type] ?? data.type), event;
+}, convertToChannelsMessage = (comlinkMessage) => {
+  const { channelId, ...rest } = comlinkMessage, message = { ...rest, connectionId: channelId };
+  return message.domain === DOMAIN && (message.domain = "sanity/channels"), message.to === "visual-editing" && (message.to = "overlays"), message.from === "visual-editing" && (message.from = "overlays"), message.type = comlinkToChannelsMap[message.type] ?? message.type, message.type === "channel/response" && message.responseTo && !message.data && (message.data = { responseTo: message.responseTo }), (message.type === "handshake/syn" || message.type === "handshake/syn-ack" || message.type === "handshake/ack") && (message.data = { id: message.connectionId }), message;
+}, sendAsChannelsMessage = ({ context }, params) => {
   const { sources, targetOrigin } = context, message = convertToChannelsMessage(params.message);
@@ -66,10 +69,7 @@ sources.forEach((source) => {
   useEffect(() => {
-    changedKeys !== "[]" && comlink && connected && comlink.post({
-      type: "preview-kit/documents",
-      data: {
-        projectId,
-        dataset,
-        perspective: "previewDrafts",
-        documents: Array.from(documentsInUse.values())
-      }
+    changedKeys !== "[]" && comlink && connected && comlink.post("preview-kit/documents", {
+      projectId,
+      dataset,
+      perspective: "previewDrafts",
+      documents: Array.from(documentsInUse.values())
     });
@@ -76,0 +76,0 @@ }, [changedKeys, comlink, connected, dataset, documentsInUse, projectId]);

package.json

 {
   "name": "@sanity/preview-kit-compat",
-  "version": "1.5.22",
+  "version": "1.5.23",
   "homepage": "https://github.com/sanity-io/visual-editing/tree/main/packages/preview-kit-compat#readme",
@@ -43,7 +43,7 @@ "bugs": {
   "dependencies": {
-    "@sanity/comlink": "1.1.4"
+    "@sanity/comlink": "2.0.0"
   },
   "devDependencies": {
     "@sanity/client": "^6.22.5",
-    "@sanity/pkg-utils": "6.11.12",
+    "@sanity/pkg-utils": "6.11.13",
     "@types/react": "^18.3.12",
@@ -53,7 +53,7 @@ "eslint": "^8.57.1",
     "typescript": "5.6.3",
-    "vitest": "^2.1.5",
+    "vitest": "^2.1.6",
     "@repo/eslint-config": "0.0.0",
+    "@repo/package.config": "0.0.0",
     "@repo/prettier-config": "0.0.0",
-    "@repo/package.config": "0.0.0",
-    "@repo/visual-editing-helpers": "0.7.4"
+    "@repo/visual-editing-helpers": "0.7.5"
   },
@@ -60,0 +60,0 @@ "peerDependencies": {

src/useDocumentsInUse.ts

@@ -15,3 +15,3 @@ import {createCompatibilityActors, type PreviewKitNodeMsg} from '@repo/visual-editing-helpers'
 ): void {
-  const [comlink, setComlink] = useState<Node<Message, PreviewKitNodeMsg> | null>(null)
+  const [comlink, setComlink] = useState<Node<PreviewKitNodeMsg, Message> | null>(null)
 
@@ -23,3 +23,3 @@ const [connected, setConnected] = useState(false)
     }
-    const comlink = createNode<Message, PreviewKitNodeMsg>(
+    const comlink = createNode<PreviewKitNodeMsg, Message>(
       {
@@ -29,3 +29,3 @@ name: 'preview-kit',
       },
-      createNodeMachine<Message, PreviewKitNodeMsg>().provide({
+      createNodeMachine<PreviewKitNodeMsg, Message>().provide({
         actors: createCompatibilityActors<PreviewKitNodeMsg>(),
@@ -55,10 +55,7 @@ }),
     if (changedKeys !== '[]' && comlink && connected) {
-      comlink.post({
-        type: 'preview-kit/documents',
-        data: {
-          projectId,
-          dataset,
-          perspective: 'previewDrafts',
-          documents: Array.from(documentsInUse.values()),
-        },
+      comlink.post('preview-kit/documents', {
+        projectId,
+        dataset,
+        perspective: 'previewDrafts',
+        documents: Array.from(documentsInUse.values()),
       })
@@ -65,0 +62,0 @@ }

No alert changes

Improved metrics

Total package byte prevSize

74016

increased by1.36%

Worsened metrics

Lines of code

339

decreased by-1.17%

Dependency changes

• + Added@sanity/comlink@2.0.0(transitive)

• - Removed@sanity/comlink@1.1.4(transitive)

• Updated@sanity/comlink@2.0.0