electron-effect-rpc 0.8.0 → 0.10.0

package/dist/preload-bridge.js

@@ -1,35 +1,39 @@
-import { isRecord } from "./protocol.js";
-import { defaultChannelPrefix, } from "./types.js";
+import { isFunctionValue, isRecord } from "./boundary.js";
+import { assertValidChannelPrefix, defaultChannelPrefix, } from "./types.js";
 function isContextBridgeLike(value) {
-    return isRecord(value) && typeof value.exposeInMainWorld === "function";
+    return isRecord(value) && isFunctionValue(value.exposeInMainWorld);
 }
 function isIpcRendererLike(value) {
     return (isRecord(value) &&
-        typeof value.invoke === "function" &&
-        typeof value.on === "function" &&
-        typeof value.removeListener === "function");
+        isFunctionValue(value.invoke) &&
+        isFunctionValue(value.on) &&
+        isFunctionValue(value.removeListener));
+}
+function isElectronRendererBindings(value) {
+    return (isRecord(value) &&
+        isContextBridgeLike(value.contextBridge) &&
+        isIpcRendererLike(value.ipcRenderer));
+}
+function parseElectronRendererBindings(value) {
+    return isElectronRendererBindings(value) ? value : null;
 }
 export function resolveElectronRendererBindings(moduleCandidate) {
-    const moduleDefault = isRecord(moduleCandidate) ? moduleCandidate.default : undefined;
-    const source = isRecord(moduleCandidate)
-        ? moduleCandidate
-        : isRecord(moduleDefault)
-            ? moduleDefault
-            : undefined;
-    if (!source) {
-        throw new Error("electron-effect-rpc/preload requires Electron preload runtime bindings.");
+    const direct = parseElectronRendererBindings(moduleCandidate);
+    if (direct) {
+        return direct;
     }
-    const { contextBridge, ipcRenderer } = source;
-    if (!isContextBridgeLike(contextBridge) || !isIpcRendererLike(ipcRenderer)) {
-        throw new Error("electron-effect-rpc/preload requires Electron preload runtime bindings.");
+    if (isRecord(moduleCandidate)) {
+        const fromDefault = parseElectronRendererBindings(moduleCandidate.default);
+        if (fromDefault) {
+            return fromDefault;
+        }
     }
-    return {
-        contextBridge,
-        ipcRenderer,
-    };
+    throw new Error("electron-effect-rpc/preload requires Electron preload runtime bindings.");
 }
 export function createBridgeAdaptersFromBindings(bindings, options) {
-    const channelPrefix = options?.channelPrefix ?? defaultChannelPrefix;
+    const channelPrefix = options?.channelPrefix
+        ? assertValidChannelPrefix(options.channelPrefix)
+        : defaultChannelPrefix;
     const { ipcRenderer } = bindings;
     const invoke = (method, payload) => ipcRenderer.invoke(`${channelPrefix.rpc}${method}`, payload);
     const subscribe = (event, listener) => {

package/dist/protocol.d.ts

@@ -1,29 +1,29 @@
+import { type IpcEncodedValue } from "./boundary.ts";
 export type RpcSuccessEnvelope = {
     readonly type: "success";
-    readonly data: unknown;
+    readonly data: IpcEncodedValue;
 };
 export type RpcFailureEnvelope = {
     readonly type: "failure";
     readonly error: {
         readonly tag: string;
-        readonly data: unknown;
+        readonly data: IpcEncodedValue;
     };
 };
 export type RpcDefectEnvelope = {
     readonly type: "defect";
     readonly message: string;
-    readonly cause?: unknown;
+    readonly cause?: IpcEncodedValue;
 };
 export type RpcResponseEnvelope = RpcSuccessEnvelope | RpcFailureEnvelope | RpcDefectEnvelope;
-export declare function isRecord(value: unknown): value is Record<string, unknown>;
-export declare function formatUnknown(value: unknown): string;
-export declare function extractErrorTag(error: unknown): string;
-export declare function toDefectEnvelope(cause: unknown, prefix?: string): RpcDefectEnvelope;
+export { formatUnknown, isRecord, isStringValue } from "./boundary.ts";
+export declare function extractErrorTag<T>(error: T): string;
+export declare function toDefectEnvelope<T>(cause: T, prefix?: string): RpcDefectEnvelope;
 export declare function safelyCall<T>(callback: ((context: T) => void) | undefined, context: T): void;
 export type StreamDataFrame = {
     readonly type: "data";
     readonly streamId: string;
-    readonly payload: unknown;
+    readonly payload: IpcEncodedValue;
 };
 export type StreamEndFrame = {
     readonly type: "end";
@@ -34,7 +34,7 @@ export type StreamErrorFrame = {
     readonly streamId: string;
     readonly error: {
         readonly tag: string;
-        readonly data: unknown;
+        readonly data: IpcEncodedValue;
     };
 };
 export type StreamDefectFrame = {
@@ -43,7 +43,7 @@ export type StreamDefectFrame = {
     readonly message: string;
 };
 export type StreamFrame = StreamDataFrame | StreamEndFrame | StreamErrorFrame | StreamDefectFrame;
-export declare function extractStreamIdFromRaw(value: unknown): string | null;
-export declare function parseStreamFrame(value: unknown): StreamFrame | null;
-export declare function parseRpcResponseEnvelope(value: unknown): RpcResponseEnvelope | null;
+export declare function extractStreamIdFromRaw<T>(value: T): string | null;
+export declare function parseStreamFrame<T>(value: T): StreamFrame | null;
+export declare function parseRpcResponseEnvelope<T>(value: T): RpcResponseEnvelope | null;
 //# sourceMappingURL=protocol.d.ts.map

package/dist/protocol.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,kBAAkB,GAAG;IAC/B,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,KAAK,EAAE;QACd,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;QACrB,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;KACxB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,kBAAkB,GAAG,kBAAkB,GAAG,iBAAiB,CAAC;AAM9F,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAEzE;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAEpD;AAED,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAUtD;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAOnF;AAED,wBAAgB,UAAU,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,KAAK,IAAI,CAAC,GAAG,SAAS,EAAE,OAAO,EAAE,CAAC,GAAG,IAAI,CAU5F;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IACrB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE;QACd,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;QACrB,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;KACxB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,eAAe,GAAG,cAAc,GAAG,gBAAgB,GAAG,iBAAiB,CAAC;AAElG,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI,CAKpE;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,WAAW,GAAG,IAAI,CA4CnE;AAED,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,OAAO,GAAG,mBAAmB,GAAG,IAAI,CA+CnF"}
+{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AACA,OAAO,EAKL,KAAK,eAAe,EACrB,MAAM,eAAe,CAAC;AAEvB,MAAM,MAAM,kBAAkB,GAAG;IAC/B,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,KAAK,EAAE;QACd,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;QACrB,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC;KAChC,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,eAAe,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,kBAAkB,GAAG,kBAAkB,GAAG,iBAAiB,CAAC;AAM9F,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAEvE,wBAAgB,eAAe,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAUnD;AAED,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAOhF;AAED,wBAAgB,UAAU,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,KAAK,IAAI,CAAC,GAAG,SAAS,EAAE,OAAO,EAAE,CAAC,GAAG,IAAI,CAU5F;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IACrB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE;QACd,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;QACrB,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC;KAChC,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,eAAe,GAAG,cAAc,GAAG,gBAAgB,GAAG,iBAAiB,CAAC;AAMlG,wBAAgB,sBAAsB,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,GAAG,IAAI,CAMjE;AAED,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,WAAW,GAAG,IAAI,CAiChE;AAED,wBAAgB,wBAAwB,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,mBAAmB,GAAG,IAAI,CAyBhF"}

package/dist/protocol.js

@@ -1,14 +1,11 @@
-function hasOwn(record, key) {
-    return Object.prototype.hasOwnProperty.call(record, key);
-}
-export function isRecord(value) {
-    return typeof value === "object" && value !== null;
-}
-export function formatUnknown(value) {
-    return value instanceof Error ? value.message : String(value);
-}
+import * as S from "effect/Schema";
+import { formatUnknown, isRecord, isStringValue, } from "./boundary.js";
+const TaggedValue = S.Struct({
+    _tag: S.String,
+});
+export { formatUnknown, isRecord, isStringValue } from "./boundary.js";
 export function extractErrorTag(error) {
-    if (isRecord(error) && typeof error._tag === "string") {
+    if (S.is(TaggedValue)(error)) {
         return error._tag;
     }
     if (error instanceof Error && error.name.length > 0) {
@@ -35,84 +32,69 @@ export function safelyCall(callback, context) {
         // Diagnostics hooks must never crash transport internals.
     }
 }
+function hasOwn(record, key) {
+    return Object.prototype.hasOwnProperty.call(record, key);
+}
 export function extractStreamIdFromRaw(value) {
-    if (!isRecord(value) || typeof value.streamId !== "string") {
+    if (!isRecord(value)) {
         return null;
     }
-    return value.streamId;
+    const streamId = value.streamId;
+    return isStringValue(streamId) ? streamId : null;
 }
 export function parseStreamFrame(value) {
-    if (!isRecord(value) || typeof value.type !== "string") {
+    if (!isRecord(value)) {
         return null;
     }
-    if (typeof value.streamId !== "string") {
+    const streamId = extractStreamIdFromRaw(value);
+    if (streamId === null) {
         return null;
     }
-    const streamId = value.streamId;
     switch (value.type) {
         case "data":
-            if (!hasOwn(value, "payload")) {
-                return null;
-            }
-            return { type: "data", streamId, payload: value.payload };
+            return hasOwn(value, "payload") ? { type: "data", streamId, payload: value.payload } : null;
         case "end":
             return { type: "end", streamId };
-        case "error":
-            if (!isRecord(value.error) ||
-                typeof value.error.tag !== "string" ||
-                !hasOwn(value.error, "data")) {
+        case "error": {
+            const error = value.error;
+            if (!isRecord(error) || !isStringValue(error.tag) || !hasOwn(error, "data")) {
                 return null;
             }
             return {
                 type: "error",
                 streamId,
-                error: { tag: value.error.tag, data: value.error.data },
+                error: { tag: error.tag, data: error.data },
             };
+        }
         case "defect":
-            if (typeof value.message !== "string") {
-                return null;
-            }
-            return { type: "defect", streamId, message: value.message };
+            return isStringValue(value.message)
+                ? { type: "defect", streamId, message: value.message }
+                : null;
         default:
             return null;
     }
 }
 export function parseRpcResponseEnvelope(value) {
-    if (!isRecord(value) || typeof value.type !== "string") {
+    if (!isRecord(value)) {
         return null;
     }
     switch (value.type) {
         case "success":
-            if (!hasOwn(value, "data")) {
-                return null;
-            }
-            return {
-                type: "success",
-                data: value.data,
-            };
-        case "failure":
-            if (!isRecord(value.error) || typeof value.error.tag !== "string") {
-                return null;
-            }
-            if (!hasOwn(value.error, "data")) {
+            return hasOwn(value, "data") ? { type: "success", data: value.data } : null;
+        case "failure": {
+            const error = value.error;
+            if (!isRecord(error) || !isStringValue(error.tag) || !hasOwn(error, "data")) {
                 return null;
             }
             return {
                 type: "failure",
-                error: {
-                    tag: value.error.tag,
-                    data: value.error.data,
-                },
+                error: { tag: error.tag, data: error.data },
             };
+        }
         case "defect":
-            if (typeof value.message !== "string") {
-                return null;
-            }
-            return {
-                type: "defect",
-                message: value.message,
-                cause: value.cause,
-            };
+            return isStringValue(value.message)
+                ? { type: "defect", message: value.message, cause: value.cause }
+                : null;
         default:
             return null;
     }

package/dist/renderer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"renderer.d.ts","sourceRoot":"","sources":["../src/renderer.ts"],"names":[],"mappings":"AAEA,OAAO,EAGL,KAAK,eAAe,EACpB,KAAK,WAAW,EAMjB,MAAM,eAAe,CAAC;AAUvB,OAAO,EAEL,KAAK,QAAQ,EACb,KAAK,SAAS,EAGd,KAAK,eAAe,EACpB,KAAK,sBAAsB,EAE3B,KAAK,SAAS,EACd,KAAK,gBAAgB,EAMrB,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAC5B,MAAM,YAAY,CAAC;AAsEpB,wBAAgB,eAAe,CAC7B,KAAK,CAAC,OAAO,SAAS,aAAa,CAAC,SAAS,CAAC,EAC9C,KAAK,CAAC,MAAM,SAAS,aAAa,CAAC,QAAQ,CAAC,EAC5C,KAAK,CAAC,aAAa,SAAS,aAAa,CAAC,eAAe,CAAC,GAAG,SAAS,EAAE,EAExE,QAAQ,EAAE,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,CAAC,EACrD,OAAO,EAAE,gBAAgB,GACxB,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC,CA0JxD;AAqBD,wBAAgB,qBAAqB,CACnC,KAAK,CAAC,OAAO,SAAS,aAAa,CAAC,SAAS,CAAC,EAC9C,KAAK,CAAC,MAAM,SAAS,aAAa,CAAC,QAAQ,CAAC,EAC5C,KAAK,CAAC,aAAa,SAAS,aAAa,CAAC,eAAe,CAAC,GAAG,SAAS,EAAE,EAExE,QAAQ,EAAE,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,CAAC,EACrD,OAAO,EAAE,sBAAsB,GAC9B,eAAe,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC,CAsF9D;AAUD,wBAAgB,qBAAqB,CACnC,KAAK,CAAC,OAAO,SAAS,aAAa,CAAC,SAAS,CAAC,EAC9C,KAAK,CAAC,MAAM,SAAS,aAAa,CAAC,QAAQ,CAAC,EAC5C,KAAK,CAAC,aAAa,SAAS,aAAa,CAAC,eAAe,CAAC,EAE1D,QAAQ,EAAE,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,CAAC,EACrD,OAAO,EAAE,sBAAsB,GAC9B,qBAAqB,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC,CA0OpE;AAED,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"renderer.d.ts","sourceRoot":"","sources":["../src/renderer.ts"],"names":[],"mappings":"AAQA,OAAO,EAGL,KAAK,eAAe,EACpB,KAAK,WAAW,EAMjB,MAAM,eAAe,CAAC;AASvB,OAAO,EAEL,KAAK,QAAQ,EACb,KAAK,SAAS,EAGd,KAAK,eAAe,EACpB,KAAK,sBAAsB,EAE3B,KAAK,SAAS,EACd,KAAK,gBAAgB,EAMrB,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAC5B,MAAM,YAAY,CAAC;AA4EpB,wBAAgB,eAAe,CAC7B,KAAK,CAAC,OAAO,SAAS,aAAa,CAAC,SAAS,CAAC,EAC9C,KAAK,CAAC,MAAM,SAAS,aAAa,CAAC,QAAQ,CAAC,EAC5C,KAAK,CAAC,aAAa,SAAS,aAAa,CAAC,eAAe,CAAC,GAAG,SAAS,EAAE,EAExE,QAAQ,EAAE,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,CAAC,EACrD,OAAO,EAAE,gBAAgB,GACxB,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC,CAyJxD;AAqBD,wBAAgB,qBAAqB,CACnC,KAAK,CAAC,OAAO,SAAS,aAAa,CAAC,SAAS,CAAC,EAC9C,KAAK,CAAC,MAAM,SAAS,aAAa,CAAC,QAAQ,CAAC,EAC5C,KAAK,CAAC,aAAa,SAAS,aAAa,CAAC,eAAe,CAAC,GAAG,SAAS,EAAE,EAExE,QAAQ,EAAE,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,CAAC,EACrD,OAAO,EAAE,sBAAsB,GAC9B,eAAe,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC,CAmG9D;AAUD,wBAAgB,qBAAqB,CACnC,KAAK,CAAC,OAAO,SAAS,aAAa,CAAC,SAAS,CAAC,EAC9C,KAAK,CAAC,MAAM,SAAS,aAAa,CAAC,QAAQ,CAAC,EAC5C,KAAK,CAAC,aAAa,SAAS,aAAa,CAAC,eAAe,CAAC,EAE1D,QAAQ,EAAE,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,CAAC,EACrD,OAAO,EAAE,sBAAsB,GAC9B,qBAAqB,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC,CAsTpE;AAED,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC"}