osra 0.4.4 → 0.5.0

package/build/utils/transport.d.ts

@@ -1,12 +1,14 @@
-import type { Message } from '../types';
-import type { WebExtOnConnect, WebExtOnMessage, WebExtPort, WebExtRuntime, WebExtSender } from './type-guards';
+import type { Browser } from 'webextension-polyfill';
+import type { Message } from '../types.js';
+import type { WebExtOnConnect, WebExtOnMessage, WebExtPort, WebExtRuntime, WebExtSender } from './type-guards.js';
 export type MessageContext = {
     port?: MessagePort | WebExtPort;
     sender?: WebExtSender;
     receiveTransport?: ReceivePlatformTransport;
     source?: MessageEventSource | null;
+    origin?: string;
 };
-export type ReceiveHandler = (listener: (event: Message, messageContext: MessageContext) => void) => void;
+export type ReceiveHandler = (listener: (event: Message, messageContext: MessageContext) => void) => void | (() => void);
 export type EmitHandler = (message: Message, transferables?: Transferable[]) => void;
 type CustomReceive = ReceivePlatformTransport | ReceiveHandler;
 type CustomEmit = EmitPlatformTransport | EmitHandler;
@@ -31,25 +33,21 @@ export type ReceiveJsonPlatformTransport = WebSocket | WebExtPort | WebExtOnConn
 export type JsonPlatformTransport = {
     isJson: true;
 } | EmitJsonPlatformTransport | ReceiveJsonPlatformTransport;
-type StructuredClonePlatformTransport = Window | ServiceWorker | Worker | SharedWorker | MessagePort;
-export type EmitPlatformTransport = EmitJsonPlatformTransport | StructuredClonePlatformTransport;
-export type ReceivePlatformTransport = ReceiveJsonPlatformTransport | StructuredClonePlatformTransport;
+export type EmitPlatformTransport = EmitJsonPlatformTransport | Window | ServiceWorker | Worker | SharedWorker | MessagePort;
+export type ReceivePlatformTransport = ReceiveJsonPlatformTransport | Window | ServiceWorkerContainer | Worker | SharedWorker | MessagePort;
 export type PlatformTransport = EmitPlatformTransport | ReceivePlatformTransport;
-export type EmitTransport = EmitPlatformTransport & Extract<CustomTransport, {
-    emit: any;
-}>;
-export type ReceiveTransport = ReceivePlatformTransport & Extract<CustomTransport, {
-    receive: any;
-}>;
+export type EmitTransport = EmitPlatformTransport | CustomEmitTransport;
+export type ReceiveTransport = ReceivePlatformTransport | CustomReceiveTransport;
 export type Transport = PlatformTransport | CustomTransport;
-export declare const getWebExtensionGlobal: () => typeof browser;
-export declare const getWebExtensionRuntime: () => typeof browser.runtime;
+export declare const getWebExtensionGlobal: () => Browser | undefined;
+export declare const getWebExtensionRuntime: () => import("webextension-polyfill").Runtime.Static | undefined;
 export declare const checkOsraMessageKey: (message: any, key: string) => message is Message;
-export declare const registerOsraMessageListener: ({ listener, transport, remoteName, key, unregisterSignal }: {
+export declare const registerOsraMessageListener: ({ listener, transport, remoteName, key, origin, unregisterSignal }: {
     listener: (message: Message, messageContext: MessageContext) => void;
     transport: ReceiveTransport;
     remoteName?: string;
     key?: string;
+    origin?: string;
     unregisterSignal?: AbortSignal;
 }) => void;
 export declare const sendOsraMessage: (transport: EmitTransport, message: Message, origin?: string, transferables?: Transferable[]) => void;

package/build/utils/type-guards.d.ts

@@ -1,6 +1,6 @@
 import type { Runtime } from 'webextension-polyfill';
-import type { Message } from '../types';
-import type { CustomEmitTransport, CustomReceiveTransport, CustomTransport, EmitJsonPlatformTransport, EmitTransport, JsonPlatformTransport, ReceiveJsonPlatformTransport, ReceiveTransport, Transport } from './transport';
+import type { Message } from '../types.js';
+import type { CustomEmitTransport, CustomReceiveTransport, CustomTransport, EmitJsonPlatformTransport, EmitTransport, JsonPlatformTransport, ReceiveJsonPlatformTransport, ReceiveTransport, Transport } from './transport.js';
 declare const typedArrayConstructorsByName: {
     readonly Int8Array: Int8ArrayConstructor;
     readonly Uint8Array: Uint8ArrayConstructor;
@@ -23,17 +23,25 @@ export declare const typedArrayTypeToTypedArrayConstructor: (value: TypedArrayTy
 export declare const isTypedArray: (value: unknown) => value is TypedArray;
 export declare const isWebSocket: (value: unknown) => value is WebSocket;
 export declare const isServiceWorkerContainer: (value: unknown) => value is ServiceWorkerContainer;
+export declare const isServiceWorker: (value: unknown) => value is ServiceWorker;
 export declare const isWorker: (value: unknown) => value is Worker;
-export declare const isDedicatedWorker: (value: unknown) => value is DedicatedWorkerGlobalScope;
+export type DedicatedWorkerGlobalScopeLike = typeof globalThis & {
+    postMessage: (message: unknown, transfer?: Transferable[]) => void;
+    name: string;
+};
+export declare const isDedicatedWorker: (value: unknown) => value is DedicatedWorkerGlobalScopeLike;
 export declare const isSharedWorker: (value: unknown) => value is SharedWorker;
 export declare const isOsraMessage: (value: unknown) => value is Message;
 type AnyConstructor = abstract new (...args: any[]) => unknown;
 /** True if `value` is an instance of any of the given constructors.
  *  Tolerates undefined entries (constructors missing on this platform). */
 export declare const instanceOfAny: (value: unknown, ctors: readonly (AnyConstructor | undefined)[]) => boolean;
+export declare const isSharedArrayBuffer: (value: unknown) => boolean;
+/** @deprecated Renamed — this only ever checked SharedArrayBuffer, unlike
+ *  the unrelated clonable fallback module. Use isSharedArrayBuffer. */
 export declare const isClonable: (value: unknown) => boolean;
 export declare const isTransferable: (value: unknown) => value is Transferable;
-export type WebExtRuntime = typeof browser.runtime;
+export type WebExtRuntime = Runtime.Static;
 export declare const isWebExtensionRuntime: (value: unknown) => value is WebExtRuntime;
 export type WebExtPort = ReturnType<WebExtRuntime['connect']> | Runtime.Port;
 export declare const isWebExtensionPort: (value: unknown, connectPort?: boolean) => value is WebExtPort;

package/build/utils/typed-event-target.d.ts

@@ -1,4 +1,4 @@
-import type { UnderlyingType } from './type';
+import type { UnderlyingType } from './type.js';
 export type EventMap = Record<string, Event>;
 export interface TypedEventTarget<T extends EventMap> extends EventTarget {
     [UnderlyingType]?: T;

package/build/utils/typed-message-channel.d.ts

@@ -1,8 +1,9 @@
-import type { UnderlyingType } from './type';
-import type { TypedEventTarget } from './typed-event-target';
+import type { UnderlyingType } from './type.js';
+import type { TypedEventTarget } from './typed-event-target.js';
 export type TypedMessagePortEventMap<T = unknown> = {
     'message': MessageEvent<T>;
     'messageerror': MessageEvent;
+    'close': Event;
 };
 export interface TypedMessagePort<T = unknown> extends Omit<TypedEventTarget<TypedMessagePortEventMap<T>>, typeof UnderlyingType> {
     [UnderlyingType]?: T;

package/package.json

@@ -1,11 +1,19 @@
 {
   "name": "osra",
-  "version": "0.4.4",
+  "version": "0.5.0",
   "description": "Easy communication between workers",
   "files": [
     "build"
   ],
   "main": "build/index.js",
+  "types": "./build/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./build/index.d.ts",
+      "import": "./build/index.js"
+    },
+    "./package.json": "./package.json"
+  },
   "type": "module",
   "scripts": {
     "build": "vite build && tsgo --declaration --emitDeclarationOnly",
@@ -17,16 +25,17 @@
     "dev": "concurrently \"npm run build-test-watch\"",
     "_dev": "concurrently \"npm run build-watch\" \"npm run build-test-watch\" \"npm run test-watch\"",
     "dev2": "concurrently \"npm run build-watch\" \"npm run build-test-watch\" \"npm run test-watch-headful\"",
-    "test": "npm run build-test && npx playwright test",
+    "test": "npm run build && npm run build-test && npx playwright test",
     "test-watch": "set PWTEST_WATCH=1 & npx playwright test",
-    "test-watch-headful": "nodemon --watch build --exec \"npx playwright test --headed\"",
+    "test-watch-headful": "nodemon --watch build-test --exec \"npx playwright test --headed\"",
     "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": "tsgo --noEmit && tsgo --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"
+    "test-extension": "npm run build-extension-test && npx playwright test -c playwright.extension.config.ts",
+    "check-consumer-types": "npm run build && tsgo --noEmit -p tsconfig.consumer.json"
   },
   "repository": {
     "type": "git",
@@ -38,6 +47,9 @@
     "url": "https://github.com/Banou26/osra/issues"
   },
   "homepage": "https://github.com/Banou26/osra#readme",
+  "dependencies": {
+    "@types/webextension-polyfill": "^0.12.4"
+  },
   "devDependencies": {
     "@istanbuljs/nyc-config-typescript": "^1.0.2",
     "@playwright/test": "^1.58.2",
@@ -46,8 +58,7 @@
     "@types/chrome": "^0.1.27",
     "@types/firefox-webext-browser": "^143.0.0",
     "@types/node": "^25.0.2",
-    "@types/webextension-polyfill": "^0.12.4",
-    "@typescript/native-preview": "^7.0.0-dev.20260404.1",
+    "@typescript/native-preview": "7.0.0-dev.20260404.1",
     "chai": "^5.3.3",
     "chai-as-promised": "^8.0.1",
     "concurrently": "^9.1.0",
@@ -56,6 +67,8 @@
     "nyc": "^17.1.0",
     "playwright": "^1.58.2",
     "vite": "^8.0.3",
-    "vite-plugin-istanbul": "^8.0.0"
-  }
+    "vite-plugin-istanbul": "^8.0.0",
+    "ws": "^8.21.0"
+  },
+  "sideEffects": false
 }