rename

crates/tauri/scripts/ipc.js

@@ -92,22 +92,22 @@
     // unlike `JSON.stringify`, we can't extend a type with a method similar to `toJSON`
     // so that `structuredClone` would use, so until https://github.com/whatwg/html/issues/7428
     // we manually call `toIPC`
-    function processToIPCSymbol(data) {
+    function processToIPCKey(data) {
       // if this value changes, make sure to update it in:
       // 1. process-ipc-message-fn.js
       // 2. core.ts
-      const ToIPCSymbol = '__TAURI_TO_IPC__'
+      const ToIPCKey = '__TAURI_TO_IPC_KEY__'
 
       if (
         typeof data === 'object' &&
         'constructor' in data &&
         data.constructor === Array
       ) {
-        return data.map((v) => processToIPCSymbol(v))
+        return data.map((v) => processToIPCKey(v))
       }
 
-      if (typeof data === 'object' && ToIPCSymbol in data) {
-        return data[ToIPCSymbol]()
+      if (typeof data === 'object' && ToIPCKey in data) {
+        return data[ToIPCKey]()
       }
 
       if (
@@ -117,7 +117,7 @@
       ) {
         const acc = {}
         Object.entries(data).forEach(([k, v]) => {
-          acc[k] = processToIPCSymbol(v)
+          acc[k] = processToIPCKey(v)
         })
         return acc
       }
@@ -125,7 +125,7 @@
       return data
     }
 
-    data.payload = processToIPCSymbol(data.payload)
+    data.payload = processToIPCKey(data.payload)
 
     isolation.frame.contentWindow.postMessage(
       data,

crates/tauri/scripts/process-ipc-message-fn.js

@@ -19,7 +19,7 @@
       // if this value changes, make sure to update it in:
       // 1. ipc.js
       // 2. core.ts
-      const ToIPCSymbol = '__TAURI_TO_IPC__'
+      const ToIPCKey = '__TAURI_TO_IPC_KEY__'
 
       if (val instanceof Map) {
         return Object.fromEntries(val.entries())
@@ -33,8 +33,8 @@
         typeof val.id === 'number'
       ) {
         return `__CHANNEL__:${val.id}`
-      } else if (typeof val === "object" && ToIPCSymbol in val) {
-        return val[ToIPCSymbol]()
+      } else if (typeof val === "object" && ToIPCKey in val) {
+        return val[ToIPCKey]()
       } else {
         return val
       }

packages/api/src/core.ts

@@ -259,7 +259,7 @@ export class Resource {
 }
 
 /**
- * Symbol to be used to implement a special function
+ * A key to be used to implement a special function
  * on your types that define how your type should be serialized
  * when passing across the IPC.
  * @example
@@ -274,7 +274,7 @@ export class Resource {
  * `UserId::String("id")` would be serialized into `{ String: "id" }`
  * and so we need to pass the same structure back to Rust
  * ```ts
- * import { ToIPCSymbol } from "@tauri-apps/api/core"
+ * import { ToIPCKey } from "@tauri-apps/api/core"
  *
  * class UserIdString {
  *   id
@@ -282,7 +282,7 @@ export class Resource {
  *     this.id = id
  *   }
  *
- *   [ToIPCSymbol]() {
+ *   [ToIPCKey]() {
  *     return { String: this.id }
  *   }
  * }
@@ -293,7 +293,7 @@ export class Resource {
  *     this.id = id
  *   }
  *
- *   [ToIPCSymbol]() {
+ *   [ToIPCKey]() {
  *     return { Number: this.id }
  *   }
  * }
@@ -306,7 +306,7 @@ export class Resource {
 // if this value changes, make sure to update it in:
 // 1. ipc.js
 // 2. process-ipc-message-fn.js
-export const ToIPCSymbol = '__TAURI_TO_IPC__'
+export const ToIPCKey = '__TAURI_TO_IPC_KEY__'
 
 function isTauri(): boolean {
   return 'isTauri' in window && !!window.isTauri

packages/api/src/dpi.ts

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-License-Identifier: MIT
 
-import { ToIPCSymbol } from './core'
+import { ToIPCKey } from './core'
 
 /**
  * A size represented in logical pixels.
@@ -70,7 +70,7 @@ class LogicalSize {
    *
    * @since 2.0.0
    */
-  [ToIPCSymbol]() {
+  [ToIPCKey]() {
     return {
       Logical: {
         width: this.width,
@@ -94,7 +94,7 @@ class LogicalSize {
    * @since 2.0.0
    */
   toJSON() {
-    return this[ToIPCSymbol]()
+    return this[ToIPCKey]()
   }
 }
 
@@ -160,7 +160,7 @@ class PhysicalSize {
    *
    * @since 2.0.0
    */
-  [ToIPCSymbol]() {
+  [ToIPCKey]() {
     return {
       Physical: {
         width: this.width,
@@ -184,7 +184,7 @@ class PhysicalSize {
    * @since 2.0.0
    */
   toJSON() {
-    return this[ToIPCSymbol]()
+    return this[ToIPCKey]()
   }
 }
 
@@ -254,7 +254,7 @@ class LogicalPosition {
    *
    * @since 2.0.0
    */
-  [ToIPCSymbol]() {
+  [ToIPCKey]() {
     return {
       Logical: {
         x: this.x,
@@ -278,7 +278,7 @@ class LogicalPosition {
    * @since 2.0.0
    */
   toJSON() {
-    return this[ToIPCSymbol]()
+    return this[ToIPCKey]()
   }
 }
 
@@ -329,7 +329,7 @@ class PhysicalPosition {
    *
    * @since 2.0.0
    */
-  [ToIPCSymbol]() {
+  [ToIPCKey]() {
     return {
       Physical: {
         x: this.x,
@@ -353,7 +353,7 @@ class PhysicalPosition {
    * @since 2.0.0
    */
   toJSON() {
-    return this[ToIPCSymbol]()
+    return this[ToIPCKey]()
   }
 }