osra 0.6.2 → 0.6.4

package/build/revivables/fallbacks.d.ts

@@ -128,12 +128,14 @@ export declare const transferable: {
     readonly box: (value: Transferable, _context: RevivableContext<any>) => Transferable;
     readonly revive: (value: BoxedTransferable, _context: RevivableContext<any>) => Transferable;
 };
-export type BoxedBlobGuard = BoxBaseType<'blobGuard'>;
-export declare const blobGuard: {
-    readonly type: 'blobGuard';
-    readonly isType: (value: unknown) => value is never;
-    readonly box: (value: never, context: RevivableContext<any>) => Blob;
-    readonly revive: (value: BoxedBlobGuard, _context: RevivableContext<any>) => Blob;
+export type BoxedBlob = BoxBaseType<'blob'>;
+declare const isBlob: (value: unknown) => value is Blob;
+export declare const blob: {
+    readonly type: 'blob';
+    readonly capableOnly: true;
+    readonly isType: typeof isBlob;
+    readonly box: (value: Blob, context: RevivableContext<any>) => Blob;
+    readonly revive: (value: BoxedBlob, _context: RevivableContext<any>) => Blob;
 };
 export type BoxedUnclonable = BoxBaseType<'unclonable'>;
 export declare const unclonable: {

package/build/revivables/index.d.ts

@@ -57,10 +57,11 @@ export declare const defaultRevivableModules: readonly [typeof transfer, typeof
     readonly box: (value: import("./fallbacks.js").Transferable, _context: RevivableContext<any>) => import("./fallbacks.js").Transferable;
     readonly revive: (value: import("./fallbacks.js").BoxedTransferable, _context: RevivableContext<any>) => import("./fallbacks.js").Transferable;
 }, {
-    readonly type: 'blobGuard';
-    readonly isType: (value: unknown) => value is never;
-    readonly box: (value: never, context: RevivableContext<any>) => Blob;
-    readonly revive: (value: import("./fallbacks.js").BoxedBlobGuard, _context: RevivableContext<any>) => Blob;
+    readonly type: 'blob';
+    readonly capableOnly: true;
+    readonly isType: (value: unknown) => value is Blob;
+    readonly box: (value: Blob, context: RevivableContext<any>) => Blob;
+    readonly revive: (value: import("./fallbacks.js").BoxedBlob, _context: RevivableContext<any>) => Blob;
 }, typeof eventTarget, {
     readonly type: 'unclonable';
     readonly isType: (value: unknown) => value is never;

package/build/types.d.ts

@@ -8,15 +8,21 @@ export declare const OSRA_BOX: '__OSRA_BOX__';
 export type Uuid = `${string}-${string}-${string}-${string}-${string}`;
 export type Jsonable = boolean | null | number | string | {
     [key: string]: Jsonable;
-} | Array<Jsonable>;
+} | ReadonlyArray<Jsonable>;
 export type Structurable = Jsonable
 /** not really structureable but here for convenience */
- | void | undefined | bigint | Date | RegExp | File | FileList | ArrayBuffer | ArrayBufferView | ImageBitmap | ImageData | {
+ | void | undefined | bigint | Date | RegExp | Blob | File | FileList | ArrayBuffer | ArrayBufferView | ImageBitmap | ImageData | {
     [key: string]: Structurable;
-} | Array<Structurable> | Map<Structurable, Structurable> | Set<Structurable>;
-export type StructurableTransferable = Structurable | Transferable | {
+} | ReadonlyArray<Structurable> | Map<Structurable, Structurable> | Set<Structurable>;
+/** lib.dom declares some `Transferable` members as EMPTY interfaces
+ *  (`MediaSourceHandle` as of TS 5.x/7.x). With no members they structurally
+ *  absorb every object type, which would let `WeakMap` & co. slip past the
+ *  `Capable` check unnoticed. Drop member-less types from the compile-time
+ *  union; runtime transfer of those exotic types is unaffected. */
+type NonAbsorbing<T> = T extends unknown ? keyof T extends never ? never : T : never;
+export type StructurableTransferable = Structurable | NonAbsorbing<Transferable> | {
     [key: string]: StructurableTransferable;
-} | Array<StructurableTransferable> | Map<StructurableTransferable, StructurableTransferable> | Set<StructurableTransferable>;
+} | ReadonlyArray<StructurableTransferable> | Map<StructurableTransferable, StructurableTransferable> | Set<StructurableTransferable>;
 /** "Free" types in `Capable` - narrows to `Jsonable` on JSON transports so
  *  user code can't type a `Date`/`File`/etc. that JSON would silently coerce.
  *  Modules that DO support JSON (date, map, set, bigint, …) put their type
@@ -24,11 +30,11 @@ export type StructurableTransferable = Structurable | Transferable | {
 type CapableBase<Ctx extends RevivableContext> = IsJsonOnlyTransport<Ctx['transport']> extends true ? Jsonable | undefined | void : StructurableTransferable;
 export type Capable<TModules extends readonly RevivableModule[] = DefaultRevivableModules, Ctx extends RevivableContext = RevivableContext> = CapableBase<Ctx> | InferRevivables<TModules, Ctx> | {
     [key: string]: Capable<TModules, Ctx>;
-} | Array<Capable<TModules, Ctx>> | Map<Capable<TModules, Ctx>, Capable<TModules, Ctx>> | Set<Capable<TModules, Ctx>>;
+} | ReadonlyArray<Capable<TModules, Ctx>> | Map<Capable<TModules, Ctx>, Capable<TModules, Ctx>> | Set<Capable<TModules, Ctx>>;
 /** What a value looks like from the far side of the connection: functions
  *  become async (calls cross the wire), containers map recursively,
  *  everything else revives as itself. */
-export type Remote<T> = T extends (...args: infer P) => infer R ? (...args: P) => Promise<Remote<Awaited<R>>> : T extends Promise<infer U> ? Promise<Remote<U>> : T extends Map<any, any> | Set<any> | Date | Error | RegExp | ArrayBuffer | ArrayBufferView | File | FileList | ReadableStream | WritableStream | MessagePort | EventTarget | Request | Response | Headers ? T : T extends AsyncIterable<infer U> ? AsyncIterableIterator<Remote<U>> : T extends ReadonlyArray<unknown> ? {
+export type Remote<T> = T extends (...args: infer P) => infer R ? (...args: P) => Promise<Remote<Awaited<R>>> : T extends Promise<infer U> ? Promise<Remote<U>> : T extends Map<any, any> | Set<any> | Date | Error | RegExp | ArrayBuffer | ArrayBufferView | Blob | File | FileList | ReadableStream | WritableStream | MessagePort | EventTarget | Request | Response | Headers ? T : T extends AsyncIterable<infer U> ? AsyncIterableIterator<Remote<U>> : T extends ReadonlyArray<unknown> ? {
     [K in keyof T]: Remote<T[K]>;
 } : T extends object ? {
     [K in keyof T]: Remote<T[K]>;

package/build/utils/transport.d.ts

@@ -1,6 +1,23 @@
 import type { Browser } from 'webextension-polyfill';
 import type { Message } from '../types.js';
 import type { WebExtOnConnect, WebExtOnMessage, WebExtPort, WebExtRuntime, WebExtSender } from './type-guards.js';
+/** What the local side knows about the realm on the other end of a connection.
+ *
+ *  `origin` and `source` are only OBSERVABLE on window transports. A MessagePort message carries
+ *  origin "" and source null, so for a port the identity has to be declared by whoever created the
+ *  transport, which is the side that received the port over a trustworthy window message. That is why
+ *  `expose` takes a `context` option rather than only reporting what it can see: without it, every
+ *  port-based consumer would rebuild the same out-of-band handshake to learn who it is talking to. */
+export type Context = {
+    /** Tears down THIS connection and nothing else: the peer is sent a close, its revivables are torn
+     *  down, and it stops being tracked. `unregisterSignal` is the whole-expose equivalent; this is the
+     *  one a server reaches for when a single realm misbehaves or is finished with. */
+    abort?: () => void;
+    origin?: string;
+    source?: MessageEventSource | null;
+    port?: MessagePort | WebExtPort;
+    sender?: WebExtSender;
+};
 export type MessageContext = {
     port?: MessagePort | WebExtPort;
     sender?: WebExtSender;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "osra",
-  "version": "0.6.2",
+  "version": "0.6.4",
   "description": "Easy communication between workers",
   "homepage": "https://github.com/Banou26/osra#readme",
   "bugs": {
@@ -17,6 +17,9 @@
   ],
   "type": "module",
   "sideEffects": false,
+  "workspaces": [
+    "docs"
+  ],
   "main": "build/index.js",
   "types": "./build/index.d.ts",
   "exports": {
@@ -31,7 +34,7 @@
     "./package.json": "./package.json"
   },
   "scripts": {
-    "build": "vp build && tsc --declaration --emitDeclarationOnly",
+    "build": "vp build && node ./node_modules/typescript7/bin/tsc --declaration --emitDeclarationOnly",
     "build-watch": "vp build --watch",
     "clean": "rimraf build",
     "prepublishOnly": "npm run clean && npm run build",
@@ -46,18 +49,22 @@
     "test-with-coverage": "npm run build-test && npx playwright test && npm run print-coverage && npm run clean-coverage",
     "print-coverage": "npx nyc report",
     "clean-coverage": "rimraf .nyc_output coverage",
-    "type-check": "tsc --noEmit && tsc --noEmit -p tsconfig.tests.json",
+    "type-check": "node ./node_modules/typescript7/bin/tsc --noEmit && node ./node_modules/typescript7/bin/tsc --noEmit -p tsconfig.tests.json",
     "start-server": "http-server -p 3000",
     "build-extension-test": "node build-extension-test.mjs",
     "test-extension": "npm run build-extension-test && npx playwright test -c playwright.extension.config.ts",
-    "check-consumer-types": "npm run build && tsc --noEmit -p tsconfig.consumer.json"
+    "check-consumer-types": "npm run build && node ./node_modules/typescript7/bin/tsc --noEmit -p tsconfig.consumer.json",
+    "docs-dev": "npm run dev -w docs",
+    "docs-build": "npm run build -w docs",
+    "docs-preview": "npm run preview -w docs",
+    "docs-check-twoslash": "npm run check-twoslash -w docs"
   },
   "dependencies": {
     "@types/webextension-polyfill": "^0.12.4"
   },
   "devDependencies": {
     "@istanbuljs/nyc-config-typescript": "^1.0.2",
-    "@playwright/test": "^1.58.2",
+    "@playwright/test": "1.58.2",
     "@types/chai": "^5.2.3",
     "@types/chai-as-promised": "^8.0.2",
     "@types/chrome": "^0.1.27",
@@ -69,8 +76,8 @@
     "http-server": "^14.1.1",
     "nodemon": "^3.1.10",
     "nyc": "^17.1.0",
-    "playwright": "^1.58.2",
-    "typescript": "^7.0.2",
+    "playwright": "1.58.2",
+    "typescript7": "npm:typescript@^7.0.2",
     "vite": "npm:@voidzero-dev/vite-plus-core@0.2.4",
     "vite-plugin-istanbul": "^8.0.0",
     "vite-plus": "0.2.4",