adnbn 0.8.0 → 0.9.0

package/dist/types/relay.d.ts

@@ -1,20 +1,147 @@
 import { EntrypointOptions } from "./entrypoint.js";
 import { ContentScriptConfig, ContentScriptContext, ContentScriptDefinition } from "./content.js";
-import { TransportConfig, TransportDefinition, TransportType } from "./transport.js";
+import { TransportConfig, TransportDefinition, TransportType, type TransportProxyTarget } from "./transport.js";
 import { Awaiter } from "./helpers.js";
+import type { MessageError } from "./message.js";
+import type { RelayRegistry } from "../relay/index.js";
 export declare const RelayGlobalKey = "adnbnRelay";
 export declare enum RelayMethod {
     Scripting = "scripting",
     Messaging = "messaging"
 }
-export interface RelayConfig extends TransportConfig, ContentScriptConfig {
+export declare enum RelayAllFrames {
+    /**
+     * Executes the method in every frame reached by the selected transport and returns one outcome:
+     * Scripting prefers a fulfilled result, while Messaging returns the first response.
+     *
+     * Warning: mutating methods can execute in multiple frames even though only one outcome is returned.
+     */
+    Any = "any",
+    /** Executes the method in every discovered frame and returns an outcome for each frame. */
+    All = "all"
+}
+export declare enum RelayFrameErrorKind {
+    Remote = "remote",
+    Execution = "execution",
+    Delivery = "delivery",
+    Timeout = "timeout",
+    TargetGone = "target-gone",
+    Unobservable = "unobservable"
+}
+export type RelayNonEmptyReadonlyArray<T> = readonly [T, ...T[]];
+export interface RelayExecutionOptions {
+    /** Maximum execution time per addressed Messaging frame or for the Inject Script operation. */
+    timeoutMs?: number;
+}
+interface RelayTargetBase extends RelayExecutionOptions {
+    tabId: number;
+}
+export interface RelayTopFrameOptions extends RelayTargetBase {
+    allFrames?: false;
+    frameId?: never;
+    frameIds?: never;
+    documentId?: never;
+    documentIds?: never;
+}
+export interface RelayFrameOptions extends RelayTargetBase {
+    frameId: number;
+    allFrames?: never;
+    frameIds?: never;
+    documentId?: never;
+    documentIds?: never;
+}
+export interface RelayFramesOptions extends RelayTargetBase {
+    frameIds: RelayNonEmptyReadonlyArray<number>;
+    allFrames?: never;
+    frameId?: never;
+    documentId?: never;
+    documentIds?: never;
+}
+export interface RelayDocumentOptions extends RelayTargetBase {
+    documentId: string;
+    allFrames?: never;
+    frameId?: never;
+    frameIds?: never;
+    documentIds?: never;
+}
+export interface RelayDocumentsOptions extends RelayTargetBase {
+    documentIds: RelayNonEmptyReadonlyArray<string>;
+    allFrames?: never;
+    frameId?: never;
+    frameIds?: never;
+    documentId?: never;
+}
+/**
+ * Broadcasts the call to all frames without requiring an exhaustive frame list and returns one outcome.
+ * `true` is an alias for `RelayAllFrames.Any`.
+ *
+ * Warning: mutating methods can execute in multiple frames even though only one outcome is returned.
+ */
+export interface RelayAnyFramesOptions extends RelayTargetBase {
+    allFrames: true | RelayAllFrames.Any;
+    frameId?: never;
+    frameIds?: never;
+    documentId?: never;
+    documentIds?: never;
+}
+export interface RelayEveryFrameOptions extends RelayTargetBase {
+    allFrames: RelayAllFrames.All;
+    frameId?: never;
+    frameIds?: never;
+    documentId?: never;
+    documentIds?: never;
+}
+export type RelayAllFramesOptions = RelayAnyFramesOptions | RelayEveryFrameOptions;
+export type RelayScalarOptions = RelayTopFrameOptions | RelayFrameOptions | RelayDocumentOptions;
+export type RelayBatchOptions = RelayFramesOptions | RelayDocumentsOptions | RelayAllFramesOptions;
+export type RelayCallOptions = RelayScalarOptions | RelayBatchOptions;
+export type RelayAddressTarget = {
+    tabId: number;
+    frameId: number;
+    documentId?: string;
+    allFrames?: never;
+} | {
+    tabId: number;
+    frameId?: never;
+    documentId: string;
+    allFrames?: never;
+};
+export type RelayOperationTarget = {
+    tabId: number;
+    allFrames: RelayAllFrames;
+    frameId?: never;
+    documentId?: never;
+};
+export type RelayResultTarget = RelayAddressTarget | RelayOperationTarget;
+export interface RelayFrameError extends MessageError {
+    kind: RelayFrameErrorKind;
+}
+export type RelayFrameResult<T> = {
+    target: RelayResultTarget;
+    status: "fulfilled";
+    result: T;
+} | {
+    target: RelayResultTarget;
+    status: "rejected";
+    error: RelayFrameError;
+};
+export type RelayFramesResult<T> = readonly RelayFrameResult<T>[];
+export type RelayBatchRpcProxy<T> = {
+    [K in keyof T]: T[K] extends (...args: any[]) => any ? (...args: Parameters<T[K]>) => Promise<RelayFramesResult<Awaited<ReturnType<T[K]>>>> : T[K] extends object ? RelayBatchRpcProxyObject<T[K]> : () => Promise<RelayFramesResult<Awaited<T[K]>>>;
+};
+export type RelayBatchRpcProxyObject<T> = (() => Promise<RelayFramesResult<Awaited<T>>>) & RelayBatchRpcProxy<T>;
+export type RelayProxyTarget<N extends keyof RelayRegistry> = TransportProxyTarget<RelayRegistry, N>;
+export type RelayBatchProxyTarget<N extends keyof RelayRegistry> = RelayBatchRpcProxy<RelayRegistry[N]>;
+export interface RelayConfig extends TransportConfig, Omit<ContentScriptConfig, "allFrames"> {
+    allFrames?: boolean | RelayAllFrames;
     method?: RelayMethod;
 }
 export type RelayOptions = RelayConfig & EntrypointOptions;
 export type RelayOptionsMap = Map<string, RelayOptions>;
 export type RelayEntrypointOptions = Partial<RelayOptions>;
 export type RelayMainHandler<T extends TransportType> = (relay: T, context: ContentScriptContext, options: RelayEntrypointOptions) => Awaiter<void>;
-export interface RelayDefinition<T extends TransportType> extends Omit<TransportDefinition<RelayOptions, T>, "main">, Omit<ContentScriptDefinition, "main">, RelayEntrypointOptions {
+export interface RelayDefinition<T extends TransportType> extends Omit<TransportDefinition<RelayOptions, T>, "main">, Omit<ContentScriptDefinition, "main" | "allFrames">, RelayEntrypointOptions {
     main?: RelayMainHandler<T>;
 }
 export type RelayUnresolvedDefinition<T extends TransportType> = Partial<RelayDefinition<T>>;
+export {};

package/dist/types/relay.js

@@ -4,7 +4,23 @@ var RelayMethod = /* @__PURE__ */ ((RelayMethod2) => {
   RelayMethod2["Messaging"] = "messaging";
   return RelayMethod2;
 })(RelayMethod || {});
+var RelayAllFrames = /* @__PURE__ */ ((RelayAllFrames2) => {
+  RelayAllFrames2["Any"] = "any";
+  RelayAllFrames2["All"] = "all";
+  return RelayAllFrames2;
+})(RelayAllFrames || {});
+var RelayFrameErrorKind = /* @__PURE__ */ ((RelayFrameErrorKind2) => {
+  RelayFrameErrorKind2["Remote"] = "remote";
+  RelayFrameErrorKind2["Execution"] = "execution";
+  RelayFrameErrorKind2["Delivery"] = "delivery";
+  RelayFrameErrorKind2["Timeout"] = "timeout";
+  RelayFrameErrorKind2["TargetGone"] = "target-gone";
+  RelayFrameErrorKind2["Unobservable"] = "unobservable";
+  return RelayFrameErrorKind2;
+})(RelayFrameErrorKind || {});
 export {
+  RelayAllFrames,
+  RelayFrameErrorKind,
   RelayGlobalKey,
   RelayMethod
 };

package/dist/types/relay.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/types/relay.ts"],"sourcesContent":["import {EntrypointOptions} from \"@typing/entrypoint\";\nimport {ContentScriptConfig, ContentScriptContext, ContentScriptDefinition} from \"@typing/content\";\nimport {TransportConfig, TransportDefinition, TransportType} from \"@typing/transport\";\nimport {Awaiter} from \"@typing/helpers\";\n\nexport const RelayGlobalKey = \"adnbnRelay\";\n\nexport enum RelayMethod {\n    Scripting = \"scripting\",\n    Messaging = \"messaging\",\n}\n\nexport interface RelayConfig extends TransportConfig, ContentScriptConfig {\n    method?: RelayMethod;\n}\n\nexport type RelayOptions = RelayConfig & EntrypointOptions;\n\nexport type RelayOptionsMap = Map<string, RelayOptions>;\n\nexport type RelayEntrypointOptions = Partial<RelayOptions>;\n\nexport type RelayMainHandler<T extends TransportType> = (\n    relay: T,\n    context: ContentScriptContext,\n    options: RelayEntrypointOptions\n) => Awaiter<void>;\n\nexport interface RelayDefinition<T extends TransportType>\n    extends\n        Omit<TransportDefinition<RelayOptions, T>, \"main\">,\n        Omit<ContentScriptDefinition, \"main\">,\n        RelayEntrypointOptions {\n    main?: RelayMainHandler<T>;\n}\n\nexport type RelayUnresolvedDefinition<T extends TransportType> = Partial<RelayDefinition<T>>;\n"],"mappings":"AAKO,MAAM,iBAAiB;AAEvB,IAAK,cAAL,kBAAKA,iBAAL;AACH,EAAAA,aAAA,eAAY;AACZ,EAAAA,aAAA,eAAY;AAFJ,SAAAA;AAAA,GAAA;","names":["RelayMethod"]}
+{"version":3,"sources":["../../src/types/relay.ts"],"sourcesContent":["import {EntrypointOptions} from \"@typing/entrypoint\";\nimport {ContentScriptConfig, ContentScriptContext, ContentScriptDefinition} from \"@typing/content\";\nimport {TransportConfig, TransportDefinition, TransportType, type TransportProxyTarget} from \"@typing/transport\";\nimport {Awaiter} from \"@typing/helpers\";\nimport type {MessageError} from \"@typing/message\";\nimport type {RelayRegistry} from \"@relay/index\";\n\nexport const RelayGlobalKey = \"adnbnRelay\";\n\nexport enum RelayMethod {\n    Scripting = \"scripting\",\n    Messaging = \"messaging\",\n}\n\nexport enum RelayAllFrames {\n    /**\n     * Executes the method in every frame reached by the selected transport and returns one outcome:\n     * Scripting prefers a fulfilled result, while Messaging returns the first response.\n     *\n     * Warning: mutating methods can execute in multiple frames even though only one outcome is returned.\n     */\n    Any = \"any\",\n\n    /** Executes the method in every discovered frame and returns an outcome for each frame. */\n    All = \"all\",\n}\n\nexport enum RelayFrameErrorKind {\n    Remote = \"remote\",\n    Execution = \"execution\",\n    Delivery = \"delivery\",\n    Timeout = \"timeout\",\n    TargetGone = \"target-gone\",\n    Unobservable = \"unobservable\",\n}\n\nexport type RelayNonEmptyReadonlyArray<T> = readonly [T, ...T[]];\n\nexport interface RelayExecutionOptions {\n    /** Maximum execution time per addressed Messaging frame or for the Inject Script operation. */\n    timeoutMs?: number;\n}\n\ninterface RelayTargetBase extends RelayExecutionOptions {\n    tabId: number;\n}\n\nexport interface RelayTopFrameOptions extends RelayTargetBase {\n    allFrames?: false;\n    frameId?: never;\n    frameIds?: never;\n    documentId?: never;\n    documentIds?: never;\n}\n\nexport interface RelayFrameOptions extends RelayTargetBase {\n    frameId: number;\n    allFrames?: never;\n    frameIds?: never;\n    documentId?: never;\n    documentIds?: never;\n}\n\nexport interface RelayFramesOptions extends RelayTargetBase {\n    frameIds: RelayNonEmptyReadonlyArray<number>;\n    allFrames?: never;\n    frameId?: never;\n    documentId?: never;\n    documentIds?: never;\n}\n\nexport interface RelayDocumentOptions extends RelayTargetBase {\n    documentId: string;\n    allFrames?: never;\n    frameId?: never;\n    frameIds?: never;\n    documentIds?: never;\n}\n\nexport interface RelayDocumentsOptions extends RelayTargetBase {\n    documentIds: RelayNonEmptyReadonlyArray<string>;\n    allFrames?: never;\n    frameId?: never;\n    frameIds?: never;\n    documentId?: never;\n}\n\n/**\n * Broadcasts the call to all frames without requiring an exhaustive frame list and returns one outcome.\n * `true` is an alias for `RelayAllFrames.Any`.\n *\n * Warning: mutating methods can execute in multiple frames even though only one outcome is returned.\n */\nexport interface RelayAnyFramesOptions extends RelayTargetBase {\n    allFrames: true | RelayAllFrames.Any;\n    frameId?: never;\n    frameIds?: never;\n    documentId?: never;\n    documentIds?: never;\n}\n\nexport interface RelayEveryFrameOptions extends RelayTargetBase {\n    allFrames: RelayAllFrames.All;\n    frameId?: never;\n    frameIds?: never;\n    documentId?: never;\n    documentIds?: never;\n}\n\nexport type RelayAllFramesOptions = RelayAnyFramesOptions | RelayEveryFrameOptions;\n\nexport type RelayScalarOptions = RelayTopFrameOptions | RelayFrameOptions | RelayDocumentOptions;\n\nexport type RelayBatchOptions = RelayFramesOptions | RelayDocumentsOptions | RelayAllFramesOptions;\n\nexport type RelayCallOptions = RelayScalarOptions | RelayBatchOptions;\n\nexport type RelayAddressTarget =\n    | {\n          tabId: number;\n          frameId: number;\n          documentId?: string;\n          allFrames?: never;\n      }\n    | {\n          tabId: number;\n          frameId?: never;\n          documentId: string;\n          allFrames?: never;\n      };\n\nexport type RelayOperationTarget = {\n    tabId: number;\n    allFrames: RelayAllFrames;\n    frameId?: never;\n    documentId?: never;\n};\n\nexport type RelayResultTarget = RelayAddressTarget | RelayOperationTarget;\n\nexport interface RelayFrameError extends MessageError {\n    kind: RelayFrameErrorKind;\n}\n\nexport type RelayFrameResult<T> =\n    | {\n          target: RelayResultTarget;\n          status: \"fulfilled\";\n          result: T;\n      }\n    | {\n          target: RelayResultTarget;\n          status: \"rejected\";\n          error: RelayFrameError;\n      };\n\nexport type RelayFramesResult<T> = readonly RelayFrameResult<T>[];\n\nexport type RelayBatchRpcProxy<T> = {\n    [K in keyof T]: T[K] extends (...args: any[]) => any\n        ? (...args: Parameters<T[K]>) => Promise<RelayFramesResult<Awaited<ReturnType<T[K]>>>>\n        : T[K] extends object\n          ? RelayBatchRpcProxyObject<T[K]>\n          : () => Promise<RelayFramesResult<Awaited<T[K]>>>;\n};\n\nexport type RelayBatchRpcProxyObject<T> = (() => Promise<RelayFramesResult<Awaited<T>>>) & RelayBatchRpcProxy<T>;\n\nexport type RelayProxyTarget<N extends keyof RelayRegistry> = TransportProxyTarget<RelayRegistry, N>;\n\nexport type RelayBatchProxyTarget<N extends keyof RelayRegistry> = RelayBatchRpcProxy<RelayRegistry[N]>;\n\nexport interface RelayConfig extends TransportConfig, Omit<ContentScriptConfig, \"allFrames\"> {\n    allFrames?: boolean | RelayAllFrames;\n    method?: RelayMethod;\n}\n\nexport type RelayOptions = RelayConfig & EntrypointOptions;\n\nexport type RelayOptionsMap = Map<string, RelayOptions>;\n\nexport type RelayEntrypointOptions = Partial<RelayOptions>;\n\nexport type RelayMainHandler<T extends TransportType> = (\n    relay: T,\n    context: ContentScriptContext,\n    options: RelayEntrypointOptions\n) => Awaiter<void>;\n\nexport interface RelayDefinition<T extends TransportType>\n    extends\n        Omit<TransportDefinition<RelayOptions, T>, \"main\">,\n        Omit<ContentScriptDefinition, \"main\" | \"allFrames\">,\n        RelayEntrypointOptions {\n    main?: RelayMainHandler<T>;\n}\n\nexport type RelayUnresolvedDefinition<T extends TransportType> = Partial<RelayDefinition<T>>;\n"],"mappings":"AAOO,MAAM,iBAAiB;AAEvB,IAAK,cAAL,kBAAKA,iBAAL;AACH,EAAAA,aAAA,eAAY;AACZ,EAAAA,aAAA,eAAY;AAFJ,SAAAA;AAAA,GAAA;AAKL,IAAK,iBAAL,kBAAKC,oBAAL;AAOH,EAAAA,gBAAA,SAAM;AAGN,EAAAA,gBAAA,SAAM;AAVE,SAAAA;AAAA,GAAA;AAaL,IAAK,sBAAL,kBAAKC,yBAAL;AACH,EAAAA,qBAAA,YAAS;AACT,EAAAA,qBAAA,eAAY;AACZ,EAAAA,qBAAA,cAAW;AACX,EAAAA,qBAAA,aAAU;AACV,EAAAA,qBAAA,gBAAa;AACb,EAAAA,qBAAA,kBAAe;AANP,SAAAA;AAAA,GAAA;","names":["RelayMethod","RelayAllFrames","RelayFrameErrorKind"]}

package/dist/types/rpc.d.ts

@@ -0,0 +1,4 @@
+export type RpcAsyncProxy<T> = {
+    [K in keyof T]: T[K] extends (...args: any[]) => any ? (...args: Parameters<T[K]>) => Promise<Awaited<ReturnType<T[K]>>> : T[K] extends object ? RpcAsyncProxyObject<T[K]> : () => Promise<Awaited<T[K]>>;
+};
+export type RpcAsyncProxyObject<T> = (() => Promise<RpcAsyncProxy<T>>) & RpcAsyncProxy<T>;

package/dist/types/rpc.js

@@ -0,0 +1 @@
+//# sourceMappingURL=rpc.js.map

package/dist/types/rpc.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/types/transport.d.ts

@@ -1,7 +1,8 @@
 import { Required } from "utility-types";
 import { EntrypointOptions } from "./entrypoint.js";
-import { Awaiter, DeepAsyncProxy } from "./helpers.js";
+import { Awaiter } from "./helpers.js";
 import { MessageSender, MessageSendOptions } from "./message.js";
+import { RpcAsyncProxy } from "./rpc.js";
 export type TransportType = ((...args: any[]) => Promise<any>) | {
     [key: string]: any | TransportType;
 };
@@ -10,7 +11,7 @@ export interface TransportDictionary {
 }
 export type TransportName = Extract<keyof TransportDictionary, string>;
 export type TransportTarget<T extends TransportDictionary, K extends keyof T> = T[K];
-export type TransportProxyTarget<T extends TransportDictionary, K extends keyof T> = DeepAsyncProxy<T[K]>;
+export type TransportProxyTarget<T extends TransportDictionary, K extends keyof T> = RpcAsyncProxy<T[K]>;
 export interface TransportManager {
     add<K extends TransportName>(name: K, instance: TransportDictionary[K]): this;
     get<K extends TransportName>(name: K): TransportDictionary[K] | undefined;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "adnbn",
   "type": "module",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "Addon Bone - Cross-browser web extension framework with shared code base",
   "homepage": "https://addonbone.com",
   "author": "Anjey Tsibylskij (https://github.com/atldays)",
@@ -107,7 +107,8 @@
     "prepublishOnly": "npm run build",
     "build": "tsup && tsc -p tsconfig.build.json && node ./scripts/copy-dts.js && tsc-alias -p tsconfig.build.json -f -fe .js",
     "format": "prettier --write .",
-    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "typecheck": "tsc -p tsconfig.json --noEmit && npm run typecheck:tests",
+    "typecheck:tests": "tsc -p tsconfig.tests.json --noEmit",
     "check:node-version": "node ./scripts/check-node-version.js",
     "test": "npm run build && jest",
     "test:ci": "npm run test -- --ci --passWithNoTests --coverage",
@@ -126,8 +127,8 @@
     "release:preview": "release-it --no-github.release --no-npm.publish --no-git.tag --ci"
   },
   "dependencies": {
-    "@addon-core/browser": "^0.7.1",
-    "@addon-core/inject-script": "^0.3.1",
+    "@addon-core/browser": "^0.7.2",
+    "@addon-core/inject-script": "^0.5.0",
     "@addon-core/storage": "^0.7.0",
     "@rsdoctor/rspack-plugin": "^1.5.1",
     "@rspack/cli": "^1.7.5",