@metamask-previews/json-rpc-engine 10.2.4-preview-427372d → 10.2.4-preview-45a82ea8e
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +5 -1
- package/dist/createMethodMiddleware.cjs +56 -0
- package/dist/createMethodMiddleware.cjs.map +1 -0
- package/dist/createMethodMiddleware.d.cts +79 -0
- package/dist/createMethodMiddleware.d.cts.map +1 -0
- package/dist/createMethodMiddleware.d.mts +79 -0
- package/dist/createMethodMiddleware.d.mts.map +1 -0
- package/dist/createMethodMiddleware.mjs +52 -0
- package/dist/createMethodMiddleware.mjs.map +1 -0
- package/dist/index.cjs +3 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +2 -0
- package/dist/index.d.cts.map +1 -1
- package/dist/index.d.mts +2 -0
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs +1 -0
- package/dist/index.mjs.map +1 -1
- package/dist/v2/createMethodMiddleware.cjs +8 -31
- package/dist/v2/createMethodMiddleware.cjs.map +1 -1
- package/dist/v2/createMethodMiddleware.d.cts +12 -15
- package/dist/v2/createMethodMiddleware.d.cts.map +1 -1
- package/dist/v2/createMethodMiddleware.d.mts +12 -15
- package/dist/v2/createMethodMiddleware.d.mts.map +1 -1
- package/dist/v2/createMethodMiddleware.mjs +6 -28
- package/dist/v2/createMethodMiddleware.mjs.map +1 -1
- package/dist/v2/index.cjs +2 -2
- package/dist/v2/index.cjs.map +1 -1
- package/dist/v2/index.d.cts +2 -2
- package/dist/v2/index.d.cts.map +1 -1
- package/dist/v2/index.d.mts +2 -2
- package/dist/v2/index.d.mts.map +1 -1
- package/dist/v2/index.mjs +2 -2
- package/dist/v2/index.mjs.map +1 -1
- package/dist/v2/utils.cjs +76 -1
- package/dist/v2/utils.cjs.map +1 -1
- package/dist/v2/utils.d.cts +40 -0
- package/dist/v2/utils.d.cts.map +1 -1
- package/dist/v2/utils.d.mts +40 -0
- package/dist/v2/utils.d.mts.map +1 -1
- package/dist/v2/utils.mjs +72 -0
- package/dist/v2/utils.mjs.map +1 -1
- package/package.json +1 -1
|
@@ -12,6 +12,9 @@ type HandlerHooks<Handler> = Handler extends {
|
|
|
12
12
|
} ? Options extends {
|
|
13
13
|
hooks: infer Hooks;
|
|
14
14
|
} ? Hooks : never : never;
|
|
15
|
+
/**
|
|
16
|
+
* A `JsonRpcEngineV2` method middleware handler.
|
|
17
|
+
*/
|
|
15
18
|
export type MethodHandler<Hooks extends Record<string, unknown> = never, MessengerActions extends ActionConstraint = never, Parameters extends JsonRpcParams = JsonRpcParams, Result extends Json = Json, Context extends ContextConstraint = ContextConstraint> = {
|
|
16
19
|
implementation: (options: {
|
|
17
20
|
request: Readonly<JsonRpcRequest<Parameters>>;
|
|
@@ -42,11 +45,18 @@ type AnyMethodHandler = {
|
|
|
42
45
|
hookNames?: Record<string, true>;
|
|
43
46
|
actionNames?: readonly string[];
|
|
44
47
|
};
|
|
45
|
-
|
|
48
|
+
type CreateMethodMiddlewareBaseOptions<Handlers extends Record<string, AnyMethodHandler>> = {
|
|
46
49
|
handlers: Handlers;
|
|
47
|
-
messenger: Messenger<string, HandlerActions<Handlers[keyof Handlers]>>;
|
|
48
50
|
hooks: UnionToIntersection<HandlerHooks<Handlers[keyof Handlers]>>;
|
|
49
51
|
};
|
|
52
|
+
/**
|
|
53
|
+
* Options for {@link createMethodMiddleware}.
|
|
54
|
+
*/
|
|
55
|
+
export type CreateMethodMiddlewareOptions<Handlers extends Record<string, AnyMethodHandler>> = CreateMethodMiddlewareBaseOptions<Handlers> & ([HandlerActions<Handlers[keyof Handlers]>] extends [never] ? {
|
|
56
|
+
messenger?: undefined;
|
|
57
|
+
} : {
|
|
58
|
+
messenger: Messenger<string, HandlerActions<Handlers[keyof Handlers]>>;
|
|
59
|
+
});
|
|
50
60
|
/**
|
|
51
61
|
* Create a JSON-RPC middleware that handles the passed JSON-RPC method handlers using the messenger and hooks.
|
|
52
62
|
*
|
|
@@ -57,18 +67,5 @@ export type CreateMethodMiddlewareOptions<Handlers extends Record<string, AnyMet
|
|
|
57
67
|
* @returns A JsonRpcEngineV2 middleware.
|
|
58
68
|
*/
|
|
59
69
|
export declare function createMethodMiddleware<Handlers extends Record<string, AnyMethodHandler>, Context extends ContextConstraint>(options: CreateMethodMiddlewareOptions<Handlers>): JsonRpcMiddleware<JsonRpcRequest, Json, Context>;
|
|
60
|
-
/**
|
|
61
|
-
* Returns the subset of the specified `hooks` that are included in the
|
|
62
|
-
* `hookNames` object. This is a Principle of Least Authority (POLA) measure
|
|
63
|
-
* to ensure that each RPC method implementation only has access to the
|
|
64
|
-
* API "hooks" it needs to do its job.
|
|
65
|
-
*
|
|
66
|
-
* @param hooks - The hooks to select from.
|
|
67
|
-
* @param hookNames - The names of the hooks to select.
|
|
68
|
-
* @returns The selected hooks.
|
|
69
|
-
* @template Hooks - The hooks to select from.
|
|
70
|
-
* @template HookName - The names of the hooks to select.
|
|
71
|
-
*/
|
|
72
|
-
export declare function selectHooks<Hooks extends Record<string, unknown>, HookName extends keyof Hooks>(hooks: Hooks, hookNames?: Record<HookName, true>): Pick<Hooks, HookName> | undefined;
|
|
73
70
|
export {};
|
|
74
71
|
//# sourceMappingURL=createMethodMiddleware.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createMethodMiddleware.d.mts","sourceRoot":"","sources":["../../src/v2/createMethodMiddleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,4BAA4B;AAElE,OAAO,EAAE,iBAAiB,EAAE,IAAI,EAAE,8BAA0B;AAC5D,OAAO,EAAE,iBAAiB,EAAE,gCAA4B;AACxD,OAAO,
|
|
1
|
+
{"version":3,"file":"createMethodMiddleware.d.mts","sourceRoot":"","sources":["../../src/v2/createMethodMiddleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,4BAA4B;AAElE,OAAO,EAAE,iBAAiB,EAAE,IAAI,EAAE,8BAA0B;AAC5D,OAAO,EAAE,iBAAiB,EAAE,gCAA4B;AACxD,OAAO,EAIL,IAAI,EACJ,aAAa,EACb,cAAc,EACd,mBAAmB,EACpB,oBAAgB;AAEjB,KAAK,cAAc,CAAC,OAAO,IAAI,OAAO,SAAS;IAC7C,cAAc,EAAE,CAAC,OAAO,EAAE,MAAM,OAAO,KAAK,OAAO,CAAC;CACrD,GACG,OAAO,SAAS;IAAE,SAAS,EAAE,SAAS,CAAC,MAAM,EAAE,MAAM,OAAO,CAAC,CAAA;CAAE,GAC7D,OAAO,GACP,KAAK,GACP,KAAK,CAAC;AAEV,KAAK,YAAY,CAAC,OAAO,IAAI,OAAO,SAAS;IAC3C,cAAc,EAAE,CAAC,OAAO,EAAE,MAAM,OAAO,KAAK,OAAO,CAAC;CACrD,GACG,OAAO,SAAS;IAAE,KAAK,EAAE,MAAM,KAAK,CAAA;CAAE,GACpC,KAAK,GACL,KAAK,GACP,KAAK,CAAC;AAEV;;GAEG;AACH,MAAM,MAAM,aAAa,CACvB,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,KAAK,EAC7C,gBAAgB,SAAS,gBAAgB,GAAG,KAAK,EACjD,UAAU,SAAS,aAAa,GAAG,aAAa,EAChD,MAAM,SAAS,IAAI,GAAG,IAAI,EAC1B,OAAO,SAAS,iBAAiB,GAAG,iBAAiB,IACnD;IACF,cAAc,EAAE,CAAC,OAAO,EAAE;QACxB,OAAO,EAAE,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC;QAC9C,OAAO,EAAE,OAAO,CAAC;QACjB,IAAI,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAC3B,SAAS,EAAE,SAAS,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;QAC/C,KAAK,EAAE,KAAK,CAAC;KACd,KAAK,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;CAChC,GAAG,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,GACxB;IAAE,SAAS,CAAC,EAAE,SAAS,CAAA;CAAE,GACzB;IAAE,SAAS,EAAE;SAAG,GAAG,IAAI,MAAM,KAAK,GAAG,IAAI;KAAE,CAAA;CAAE,CAAC,GAChD,CAAC,CAAC,gBAAgB,CAAC,SAAS,CAAC,KAAK,CAAC,GAC/B;IAAE,WAAW,CAAC,EAAE,SAAS,CAAA;CAAE,GAC3B;IAAE,WAAW,EAAE,gBAAgB,CAAC,MAAM,CAAC,EAAE,CAAA;CAAE,CAAC,CAAC;AAEnD,KAAK,gBAAgB,GAAG;IACtB,cAAc,CACZ,IAAI,EAAE,IAAI,EACV,OAAO,EAAE;QACP,OAAO,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;QAClC,OAAO,EAAE,iBAAiB,CAAC;QAC3B,IAAI,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAC3B,SAAS,EAAE,OAAO,CAAC;QACnB,KAAK,EAAE,OAAO,CAAC;KAChB,GACA,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACjC,WAAW,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACjC,CAAC;AAEF,KAAK,iCAAiC,CACpC,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,IAC/C;IACF,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,EAAE,mBAAmB,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,QAAQ,CAAC,CAAC,CAAC,CAAC;CACpE,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,CACvC,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,IAC/C,iCAAiC,CAAC,QAAQ,CAAC,GAC7C,CAAC,CAAC,cAAc,CAAC,QAAQ,CAAC,MAAM,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GACvD;IACE,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,GACD;IACE,SAAS,EAAE,SAAS,CAAC,MAAM,EAAE,cAAc,CAAC,QAAQ,CAAC,MAAM,QAAQ,CAAC,CAAC,CAAC,CAAC;CACxE,CAAC,CAAC;AAQT;;;;;;;;GAQG;AACH,wBAAgB,sBAAsB,CACpC,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,EACjD,OAAO,SAAS,iBAAiB,EAEjC,OAAO,EAAE,6BAA6B,CAAC,QAAQ,CAAC,GAC/C,iBAAiB,CAAC,cAAc,EAAE,IAAI,EAAE,OAAO,CAAC,CA2ClD"}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { Messenger } from "@metamask/messenger";
|
|
2
|
+
import { assertExpectedHooks, createHandlerMessenger, selectHooks } from "./utils.mjs";
|
|
2
3
|
/**
|
|
3
4
|
* Create a JSON-RPC middleware that handles the passed JSON-RPC method handlers using the messenger and hooks.
|
|
4
5
|
*
|
|
@@ -11,15 +12,14 @@ import { Messenger } from "@metamask/messenger";
|
|
|
11
12
|
export function createMethodMiddleware(options) {
|
|
12
13
|
const { messenger: rootMessenger } = options;
|
|
13
14
|
const allHooks = options.hooks;
|
|
15
|
+
const expectedHookNames = new Set(Object.values(options.handlers).flatMap((handler) => handler.hookNames ? Object.getOwnPropertyNames(handler.hookNames) : []));
|
|
16
|
+
assertExpectedHooks(allHooks, expectedHookNames);
|
|
14
17
|
const handlers = Object.entries(options.handlers).reduce((accumulator, [handlerName, handler]) => {
|
|
15
18
|
const handlerHooks = selectHooks(allHooks, handler.hookNames) ?? {};
|
|
16
|
-
const handlerMessenger =
|
|
19
|
+
const handlerMessenger = createHandlerMessenger({
|
|
17
20
|
namespace: handlerName,
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
rootMessenger.delegate({
|
|
21
|
-
actions: (handler.actionNames ?? []),
|
|
22
|
-
messenger: handlerMessenger,
|
|
21
|
+
actionNames: handler.actionNames,
|
|
22
|
+
rootMessenger,
|
|
23
23
|
});
|
|
24
24
|
accumulator[handlerName] = {
|
|
25
25
|
implementation: handler.implementation,
|
|
@@ -37,26 +37,4 @@ export function createMethodMiddleware(options) {
|
|
|
37
37
|
return implementation({ request, context, next, hooks, messenger });
|
|
38
38
|
};
|
|
39
39
|
}
|
|
40
|
-
/**
|
|
41
|
-
* Returns the subset of the specified `hooks` that are included in the
|
|
42
|
-
* `hookNames` object. This is a Principle of Least Authority (POLA) measure
|
|
43
|
-
* to ensure that each RPC method implementation only has access to the
|
|
44
|
-
* API "hooks" it needs to do its job.
|
|
45
|
-
*
|
|
46
|
-
* @param hooks - The hooks to select from.
|
|
47
|
-
* @param hookNames - The names of the hooks to select.
|
|
48
|
-
* @returns The selected hooks.
|
|
49
|
-
* @template Hooks - The hooks to select from.
|
|
50
|
-
* @template HookName - The names of the hooks to select.
|
|
51
|
-
*/
|
|
52
|
-
export function selectHooks(hooks, hookNames) {
|
|
53
|
-
if (hookNames) {
|
|
54
|
-
return Object.keys(hookNames).reduce((hookSubset, _hookName) => {
|
|
55
|
-
const hookName = _hookName;
|
|
56
|
-
hookSubset[hookName] = hooks[hookName];
|
|
57
|
-
return hookSubset;
|
|
58
|
-
}, {});
|
|
59
|
-
}
|
|
60
|
-
return undefined;
|
|
61
|
-
}
|
|
62
40
|
//# sourceMappingURL=createMethodMiddleware.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createMethodMiddleware.mjs","sourceRoot":"","sources":["../../src/v2/createMethodMiddleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,SAAS,EAAE,4BAA4B;
|
|
1
|
+
{"version":3,"file":"createMethodMiddleware.mjs","sourceRoot":"","sources":["../../src/v2/createMethodMiddleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,SAAS,EAAE,4BAA4B;AAIlE,OAAO,EACL,mBAAmB,EACnB,sBAAsB,EACtB,WAAW,EAKZ,oBAAgB;AAoFjB;;;;;;;;GAQG;AACH,MAAM,UAAU,sBAAsB,CAIpC,OAAgD;IAEhD,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;IAC7C,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAgC,CAAC;IAE1D,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAC/B,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAClD,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,mBAAmB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CACvE,CACF,CAAC;IACF,mBAAmB,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;IAEjD,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,MAAM,CAEtD,CAAC,WAAW,EAAE,CAAC,WAAW,EAAE,OAAO,CAAC,EAAE,EAAE;QACxC,MAAM,YAAY,GAAG,WAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;QACpE,MAAM,gBAAgB,GAAG,sBAAsB,CAE7C;YACA,SAAS,EAAE,WAAW;YACtB,WAAW,EAAE,OAAO,CAAC,WAER;YACb,aAAa;SACd,CAAC,CAAC;QAEH,WAAW,CAAC,WAAW,CAAC,GAAG;YACzB,cAAc,EAAE,OAAO,CAAC,cAAc;YACtC,KAAK,EAAE,YAAY;YACnB,SAAS,EAAE,gBAAgB;SAC5B,CAAC;QACF,OAAO,WAAW,CAAC;IACrB,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE;QACpC,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACzC,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;QAED,MAAM,EAAE,cAAc,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;QAErD,OAAO,cAAc,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IACtE,CAAC,CAAC;AACJ,CAAC","sourcesContent":["import { ActionConstraint, Messenger } from '@metamask/messenger';\n\nimport { JsonRpcMiddleware, Next } from './JsonRpcEngineV2';\nimport { ContextConstraint } from './MiddlewareContext';\nimport {\n assertExpectedHooks,\n createHandlerMessenger,\n selectHooks,\n Json,\n JsonRpcParams,\n JsonRpcRequest,\n UnionToIntersection,\n} from './utils';\n\ntype HandlerActions<Handler> = Handler extends {\n implementation: (options: infer Options) => unknown;\n}\n ? Options extends { messenger: Messenger<string, infer Actions> }\n ? Actions\n : never\n : never;\n\ntype HandlerHooks<Handler> = Handler extends {\n implementation: (options: infer Options) => unknown;\n}\n ? Options extends { hooks: infer Hooks }\n ? Hooks\n : never\n : never;\n\n/**\n * A `JsonRpcEngineV2` method middleware handler.\n */\nexport type MethodHandler<\n Hooks extends Record<string, unknown> = never,\n MessengerActions extends ActionConstraint = never,\n Parameters extends JsonRpcParams = JsonRpcParams,\n Result extends Json = Json,\n Context extends ContextConstraint = ContextConstraint,\n> = {\n implementation: (options: {\n request: Readonly<JsonRpcRequest<Parameters>>;\n context: Context;\n next: Next<JsonRpcRequest>;\n messenger: Messenger<string, MessengerActions>;\n hooks: Hooks;\n }) => Promise<Result> | Result;\n} & ([Hooks] extends [never]\n ? { hookNames?: undefined }\n : { hookNames: { [Key in keyof Hooks]: true } }) &\n ([MessengerActions] extends [never]\n ? { actionNames?: undefined }\n : { actionNames: MessengerActions['type'][] });\n\ntype AnyMethodHandler = {\n implementation(\n this: void,\n options: {\n request: Readonly<JsonRpcRequest>;\n context: ContextConstraint;\n next: Next<JsonRpcRequest>;\n messenger: unknown;\n hooks: unknown;\n },\n ): Promise<Json> | Json;\n hookNames?: Record<string, true>;\n actionNames?: readonly string[];\n};\n\ntype CreateMethodMiddlewareBaseOptions<\n Handlers extends Record<string, AnyMethodHandler>,\n> = {\n handlers: Handlers;\n hooks: UnionToIntersection<HandlerHooks<Handlers[keyof Handlers]>>;\n};\n\n/**\n * Options for {@link createMethodMiddleware}.\n */\nexport type CreateMethodMiddlewareOptions<\n Handlers extends Record<string, AnyMethodHandler>,\n> = CreateMethodMiddlewareBaseOptions<Handlers> &\n ([HandlerActions<Handlers[keyof Handlers]>] extends [never]\n ? {\n messenger?: undefined;\n }\n : {\n messenger: Messenger<string, HandlerActions<Handlers[keyof Handlers]>>;\n });\n\ntype ResolvedHandler = {\n implementation: AnyMethodHandler['implementation'];\n hooks: Record<string, unknown>;\n messenger?: Messenger<string, ActionConstraint> | undefined;\n};\n\n/**\n * Create a JSON-RPC middleware that handles the passed JSON-RPC method handlers using the messenger and hooks.\n *\n * @param options The options.\n * @param options.handlers - The JSON-RPC method handler implementations.\n * @param options.messenger - The messenger to be used by the handlers.\n * @param options.hooks - The hooks to be used by the handlers.\n * @returns A JsonRpcEngineV2 middleware.\n */\nexport function createMethodMiddleware<\n Handlers extends Record<string, AnyMethodHandler>,\n Context extends ContextConstraint,\n>(\n options: CreateMethodMiddlewareOptions<Handlers>,\n): JsonRpcMiddleware<JsonRpcRequest, Json, Context> {\n const { messenger: rootMessenger } = options;\n const allHooks = options.hooks as Record<string, unknown>;\n\n const expectedHookNames = new Set(\n Object.values(options.handlers).flatMap((handler) =>\n handler.hookNames ? Object.getOwnPropertyNames(handler.hookNames) : [],\n ),\n );\n assertExpectedHooks(allHooks, expectedHookNames);\n\n const handlers = Object.entries(options.handlers).reduce<\n Record<string, ResolvedHandler>\n >((accumulator, [handlerName, handler]) => {\n const handlerHooks = selectHooks(allHooks, handler.hookNames) ?? {};\n const handlerMessenger = createHandlerMessenger<\n HandlerActions<Handlers[keyof Handlers]>\n >({\n namespace: handlerName,\n actionNames: handler.actionNames as\n | readonly HandlerActions<Handlers[keyof Handlers]>['type'][]\n | undefined,\n rootMessenger,\n });\n\n accumulator[handlerName] = {\n implementation: handler.implementation,\n hooks: handlerHooks,\n messenger: handlerMessenger,\n };\n return accumulator;\n }, {});\n\n return ({ request, context, next }) => {\n const handler = handlers[request.method];\n if (handler === undefined) {\n return next();\n }\n\n const { implementation, hooks, messenger } = handler;\n\n return implementation({ request, context, next, hooks, messenger });\n };\n}\n"]}
|
package/dist/v2/index.cjs
CHANGED
|
@@ -1,12 +1,11 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.JsonRpcEngineError = exports.isRequest = exports.isNotification = exports.MiddlewareContext = exports.JsonRpcServer = exports.JsonRpcEngineV2 = exports.createScaffoldMiddleware = exports.createOriginMiddleware = exports.createMethodMiddleware = exports.
|
|
3
|
+
exports.selectHooks = exports.JsonRpcEngineError = exports.isRequest = exports.isNotification = exports.MiddlewareContext = exports.JsonRpcServer = exports.JsonRpcEngineV2 = exports.createScaffoldMiddleware = exports.createOriginMiddleware = exports.createMethodMiddleware = exports.getUniqueId = exports.asLegacyMiddleware = void 0;
|
|
4
4
|
var asLegacyMiddleware_1 = require("./asLegacyMiddleware.cjs");
|
|
5
5
|
Object.defineProperty(exports, "asLegacyMiddleware", { enumerable: true, get: function () { return asLegacyMiddleware_1.asLegacyMiddleware; } });
|
|
6
6
|
var getUniqueId_1 = require("../getUniqueId.cjs");
|
|
7
7
|
Object.defineProperty(exports, "getUniqueId", { enumerable: true, get: function () { return getUniqueId_1.getUniqueId; } });
|
|
8
8
|
var createMethodMiddleware_1 = require("./createMethodMiddleware.cjs");
|
|
9
|
-
Object.defineProperty(exports, "selectHooks", { enumerable: true, get: function () { return createMethodMiddleware_1.selectHooks; } });
|
|
10
9
|
Object.defineProperty(exports, "createMethodMiddleware", { enumerable: true, get: function () { return createMethodMiddleware_1.createMethodMiddleware; } });
|
|
11
10
|
var createOriginMiddleware_1 = require("./createOriginMiddleware.cjs");
|
|
12
11
|
Object.defineProperty(exports, "createOriginMiddleware", { enumerable: true, get: function () { return createOriginMiddleware_1.createOriginMiddleware; } });
|
|
@@ -22,4 +21,5 @@ var utils_1 = require("./utils.cjs");
|
|
|
22
21
|
Object.defineProperty(exports, "isNotification", { enumerable: true, get: function () { return utils_1.isNotification; } });
|
|
23
22
|
Object.defineProperty(exports, "isRequest", { enumerable: true, get: function () { return utils_1.isRequest; } });
|
|
24
23
|
Object.defineProperty(exports, "JsonRpcEngineError", { enumerable: true, get: function () { return utils_1.JsonRpcEngineError; } });
|
|
24
|
+
Object.defineProperty(exports, "selectHooks", { enumerable: true, get: function () { return utils_1.selectHooks; } });
|
|
25
25
|
//# sourceMappingURL=index.cjs.map
|
package/dist/v2/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../src/v2/index.ts"],"names":[],"mappings":";;;AAAA,+DAA0D;AAAjD,wHAAA,kBAAkB,OAAA;AAC3B,kDAA6C;AAApC,0GAAA,WAAW,OAAA;AACpB,
|
|
1
|
+
{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../src/v2/index.ts"],"names":[],"mappings":";;;AAAA,+DAA0D;AAAjD,wHAAA,kBAAkB,OAAA;AAC3B,kDAA6C;AAApC,0GAAA,WAAW,OAAA;AACpB,uEAAkE;AAAzD,gIAAA,sBAAsB,OAAA;AAE/B,uEAAkE;AAAzD,gIAAA,sBAAsB,OAAA;AAC/B,2EAAsE;AAA7D,oIAAA,wBAAwB,OAAA;AACjC,yDAAoD;AAA3C,kHAAA,eAAe,OAAA;AAWxB,qDAAgD;AAAvC,8GAAA,aAAa,OAAA;AACtB,6DAAwD;AAA/C,sHAAA,iBAAiB,OAAA;AAE1B,qCAKiB;AAJf,uGAAA,cAAc,OAAA;AACd,kGAAA,SAAS,OAAA;AACT,2GAAA,kBAAkB,OAAA;AAClB,oGAAA,WAAW,OAAA","sourcesContent":["export { asLegacyMiddleware } from './asLegacyMiddleware';\nexport { getUniqueId } from '../getUniqueId';\nexport { createMethodMiddleware } from './createMethodMiddleware';\nexport type { MethodHandler } from './createMethodMiddleware';\nexport { createOriginMiddleware } from './createOriginMiddleware';\nexport { createScaffoldMiddleware } from './createScaffoldMiddleware';\nexport { JsonRpcEngineV2 } from './JsonRpcEngineV2';\nexport type {\n JsonRpcMiddleware,\n HandleOptions,\n MergedContextOf,\n MiddlewareParams,\n MiddlewareConstraint,\n Next,\n RequestOf,\n ResultConstraint,\n} from './JsonRpcEngineV2';\nexport { JsonRpcServer } from './JsonRpcServer';\nexport { MiddlewareContext } from './MiddlewareContext';\nexport type { EmptyContext, ContextConstraint } from './MiddlewareContext';\nexport {\n isNotification,\n isRequest,\n JsonRpcEngineError,\n selectHooks,\n} from './utils';\nexport type {\n Json,\n JsonRpcCall,\n JsonRpcNotification,\n JsonRpcParams,\n JsonRpcRequest,\n} from './utils';\n"]}
|
package/dist/v2/index.d.cts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export { asLegacyMiddleware } from "./asLegacyMiddleware.cjs";
|
|
2
2
|
export { getUniqueId } from "../getUniqueId.cjs";
|
|
3
|
-
export {
|
|
3
|
+
export { createMethodMiddleware } from "./createMethodMiddleware.cjs";
|
|
4
4
|
export type { MethodHandler } from "./createMethodMiddleware.cjs";
|
|
5
5
|
export { createOriginMiddleware } from "./createOriginMiddleware.cjs";
|
|
6
6
|
export { createScaffoldMiddleware } from "./createScaffoldMiddleware.cjs";
|
|
@@ -9,6 +9,6 @@ export type { JsonRpcMiddleware, HandleOptions, MergedContextOf, MiddlewareParam
|
|
|
9
9
|
export { JsonRpcServer } from "./JsonRpcServer.cjs";
|
|
10
10
|
export { MiddlewareContext } from "./MiddlewareContext.cjs";
|
|
11
11
|
export type { EmptyContext, ContextConstraint } from "./MiddlewareContext.cjs";
|
|
12
|
-
export { isNotification, isRequest, JsonRpcEngineError } from "./utils.cjs";
|
|
12
|
+
export { isNotification, isRequest, JsonRpcEngineError, selectHooks, } from "./utils.cjs";
|
|
13
13
|
export type { Json, JsonRpcCall, JsonRpcNotification, JsonRpcParams, JsonRpcRequest, } from "./utils.cjs";
|
|
14
14
|
//# sourceMappingURL=index.d.cts.map
|
package/dist/v2/index.d.cts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../src/v2/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,iCAA6B;AAC1D,OAAO,EAAE,WAAW,EAAE,2BAAuB;AAC7C,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../src/v2/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,iCAA6B;AAC1D,OAAO,EAAE,WAAW,EAAE,2BAAuB;AAC7C,OAAO,EAAE,sBAAsB,EAAE,qCAAiC;AAClE,YAAY,EAAE,aAAa,EAAE,qCAAiC;AAC9D,OAAO,EAAE,sBAAsB,EAAE,qCAAiC;AAClE,OAAO,EAAE,wBAAwB,EAAE,uCAAmC;AACtE,OAAO,EAAE,eAAe,EAAE,8BAA0B;AACpD,YAAY,EACV,iBAAiB,EACjB,aAAa,EACb,eAAe,EACf,gBAAgB,EAChB,oBAAoB,EACpB,IAAI,EACJ,SAAS,EACT,gBAAgB,GACjB,8BAA0B;AAC3B,OAAO,EAAE,aAAa,EAAE,4BAAwB;AAChD,OAAO,EAAE,iBAAiB,EAAE,gCAA4B;AACxD,YAAY,EAAE,YAAY,EAAE,iBAAiB,EAAE,gCAA4B;AAC3E,OAAO,EACL,cAAc,EACd,SAAS,EACT,kBAAkB,EAClB,WAAW,GACZ,oBAAgB;AACjB,YAAY,EACV,IAAI,EACJ,WAAW,EACX,mBAAmB,EACnB,aAAa,EACb,cAAc,GACf,oBAAgB"}
|
package/dist/v2/index.d.mts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export { asLegacyMiddleware } from "./asLegacyMiddleware.mjs";
|
|
2
2
|
export { getUniqueId } from "../getUniqueId.mjs";
|
|
3
|
-
export {
|
|
3
|
+
export { createMethodMiddleware } from "./createMethodMiddleware.mjs";
|
|
4
4
|
export type { MethodHandler } from "./createMethodMiddleware.mjs";
|
|
5
5
|
export { createOriginMiddleware } from "./createOriginMiddleware.mjs";
|
|
6
6
|
export { createScaffoldMiddleware } from "./createScaffoldMiddleware.mjs";
|
|
@@ -9,6 +9,6 @@ export type { JsonRpcMiddleware, HandleOptions, MergedContextOf, MiddlewareParam
|
|
|
9
9
|
export { JsonRpcServer } from "./JsonRpcServer.mjs";
|
|
10
10
|
export { MiddlewareContext } from "./MiddlewareContext.mjs";
|
|
11
11
|
export type { EmptyContext, ContextConstraint } from "./MiddlewareContext.mjs";
|
|
12
|
-
export { isNotification, isRequest, JsonRpcEngineError } from "./utils.mjs";
|
|
12
|
+
export { isNotification, isRequest, JsonRpcEngineError, selectHooks, } from "./utils.mjs";
|
|
13
13
|
export type { Json, JsonRpcCall, JsonRpcNotification, JsonRpcParams, JsonRpcRequest, } from "./utils.mjs";
|
|
14
14
|
//# sourceMappingURL=index.d.mts.map
|
package/dist/v2/index.d.mts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/v2/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,iCAA6B;AAC1D,OAAO,EAAE,WAAW,EAAE,2BAAuB;AAC7C,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/v2/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,iCAA6B;AAC1D,OAAO,EAAE,WAAW,EAAE,2BAAuB;AAC7C,OAAO,EAAE,sBAAsB,EAAE,qCAAiC;AAClE,YAAY,EAAE,aAAa,EAAE,qCAAiC;AAC9D,OAAO,EAAE,sBAAsB,EAAE,qCAAiC;AAClE,OAAO,EAAE,wBAAwB,EAAE,uCAAmC;AACtE,OAAO,EAAE,eAAe,EAAE,8BAA0B;AACpD,YAAY,EACV,iBAAiB,EACjB,aAAa,EACb,eAAe,EACf,gBAAgB,EAChB,oBAAoB,EACpB,IAAI,EACJ,SAAS,EACT,gBAAgB,GACjB,8BAA0B;AAC3B,OAAO,EAAE,aAAa,EAAE,4BAAwB;AAChD,OAAO,EAAE,iBAAiB,EAAE,gCAA4B;AACxD,YAAY,EAAE,YAAY,EAAE,iBAAiB,EAAE,gCAA4B;AAC3E,OAAO,EACL,cAAc,EACd,SAAS,EACT,kBAAkB,EAClB,WAAW,GACZ,oBAAgB;AACjB,YAAY,EACV,IAAI,EACJ,WAAW,EACX,mBAAmB,EACnB,aAAa,EACb,cAAc,GACf,oBAAgB"}
|
package/dist/v2/index.mjs
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
export { asLegacyMiddleware } from "./asLegacyMiddleware.mjs";
|
|
2
2
|
export { getUniqueId } from "../getUniqueId.mjs";
|
|
3
|
-
export {
|
|
3
|
+
export { createMethodMiddleware } from "./createMethodMiddleware.mjs";
|
|
4
4
|
export { createOriginMiddleware } from "./createOriginMiddleware.mjs";
|
|
5
5
|
export { createScaffoldMiddleware } from "./createScaffoldMiddleware.mjs";
|
|
6
6
|
export { JsonRpcEngineV2 } from "./JsonRpcEngineV2.mjs";
|
|
7
7
|
export { JsonRpcServer } from "./JsonRpcServer.mjs";
|
|
8
8
|
export { MiddlewareContext } from "./MiddlewareContext.mjs";
|
|
9
|
-
export { isNotification, isRequest, JsonRpcEngineError } from "./utils.mjs";
|
|
9
|
+
export { isNotification, isRequest, JsonRpcEngineError, selectHooks } from "./utils.mjs";
|
|
10
10
|
//# sourceMappingURL=index.mjs.map
|
package/dist/v2/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/v2/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,iCAA6B;AAC1D,OAAO,EAAE,WAAW,EAAE,2BAAuB;AAC7C,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/v2/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,iCAA6B;AAC1D,OAAO,EAAE,WAAW,EAAE,2BAAuB;AAC7C,OAAO,EAAE,sBAAsB,EAAE,qCAAiC;AAElE,OAAO,EAAE,sBAAsB,EAAE,qCAAiC;AAClE,OAAO,EAAE,wBAAwB,EAAE,uCAAmC;AACtE,OAAO,EAAE,eAAe,EAAE,8BAA0B;AAWpD,OAAO,EAAE,aAAa,EAAE,4BAAwB;AAChD,OAAO,EAAE,iBAAiB,EAAE,gCAA4B;AAExD,OAAO,EACL,cAAc,EACd,SAAS,EACT,kBAAkB,EAClB,WAAW,EACZ,oBAAgB","sourcesContent":["export { asLegacyMiddleware } from './asLegacyMiddleware';\nexport { getUniqueId } from '../getUniqueId';\nexport { createMethodMiddleware } from './createMethodMiddleware';\nexport type { MethodHandler } from './createMethodMiddleware';\nexport { createOriginMiddleware } from './createOriginMiddleware';\nexport { createScaffoldMiddleware } from './createScaffoldMiddleware';\nexport { JsonRpcEngineV2 } from './JsonRpcEngineV2';\nexport type {\n JsonRpcMiddleware,\n HandleOptions,\n MergedContextOf,\n MiddlewareParams,\n MiddlewareConstraint,\n Next,\n RequestOf,\n ResultConstraint,\n} from './JsonRpcEngineV2';\nexport { JsonRpcServer } from './JsonRpcServer';\nexport { MiddlewareContext } from './MiddlewareContext';\nexport type { EmptyContext, ContextConstraint } from './MiddlewareContext';\nexport {\n isNotification,\n isRequest,\n JsonRpcEngineError,\n selectHooks,\n} from './utils';\nexport type {\n Json,\n JsonRpcCall,\n JsonRpcNotification,\n JsonRpcParams,\n JsonRpcRequest,\n} from './utils';\n"]}
|
package/dist/v2/utils.cjs
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
var _a;
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
-
exports.JsonRpcEngineError = exports.isInstance = exports.stringify = exports.isNotification = exports.isRequest = void 0;
|
|
4
|
+
exports.createHandlerMessenger = exports.assertExpectedHooks = exports.selectHooks = exports.JsonRpcEngineError = exports.isInstance = exports.stringify = exports.isNotification = exports.isRequest = void 0;
|
|
5
|
+
const messenger_1 = require("@metamask/messenger");
|
|
5
6
|
const utils_1 = require("@metamask/utils");
|
|
6
7
|
const isRequest = (message) => (0, utils_1.hasProperty)(message, 'id');
|
|
7
8
|
exports.isRequest = isRequest;
|
|
@@ -49,4 +50,78 @@ class JsonRpcEngineError extends Error {
|
|
|
49
50
|
}
|
|
50
51
|
exports.JsonRpcEngineError = JsonRpcEngineError;
|
|
51
52
|
_a = JsonRpcEngineErrorSymbol;
|
|
53
|
+
// Method middleware utils
|
|
54
|
+
/**
|
|
55
|
+
* Returns the subset of the specified `hooks` that are included in the
|
|
56
|
+
* `hookNames` object. This is a Principle of Least Authority (POLA) measure
|
|
57
|
+
* to ensure that each RPC method implementation only has access to the
|
|
58
|
+
* API "hooks" it needs to do its job.
|
|
59
|
+
*
|
|
60
|
+
* @param hooks - The hooks to select from.
|
|
61
|
+
* @param hookNames - The names of the hooks to select.
|
|
62
|
+
* @returns The selected hooks, or `undefined` if `hookNames` is not provided.
|
|
63
|
+
* @template Hooks - The hooks to select from.
|
|
64
|
+
* @template HookName - The names of the hooks to select.
|
|
65
|
+
*/
|
|
66
|
+
function selectHooks(hooks, hookNames) {
|
|
67
|
+
if (hookNames) {
|
|
68
|
+
return Object.keys(hookNames).reduce((subset, name) => {
|
|
69
|
+
const hookName = name;
|
|
70
|
+
subset[hookName] = hooks[hookName];
|
|
71
|
+
return subset;
|
|
72
|
+
}, {});
|
|
73
|
+
}
|
|
74
|
+
return undefined;
|
|
75
|
+
}
|
|
76
|
+
exports.selectHooks = selectHooks;
|
|
77
|
+
/**
|
|
78
|
+
* Asserts that `hooks` contains exactly the hook names in `expectedHookNames`.
|
|
79
|
+
* Throws on any missing hooks, then on any extraneous hooks.
|
|
80
|
+
*
|
|
81
|
+
* @param hooks - The hooks object to validate.
|
|
82
|
+
* @param expectedHookNames - The expected hook names.
|
|
83
|
+
*/
|
|
84
|
+
function assertExpectedHooks(hooks, expectedHookNames) {
|
|
85
|
+
const missingHookNames = [];
|
|
86
|
+
expectedHookNames.forEach((hookName) => {
|
|
87
|
+
if (!(0, utils_1.hasProperty)(hooks, hookName)) {
|
|
88
|
+
missingHookNames.push(hookName);
|
|
89
|
+
}
|
|
90
|
+
});
|
|
91
|
+
if (missingHookNames.length > 0) {
|
|
92
|
+
throw new Error(`Missing expected hooks:\n\n${missingHookNames.join('\n')}\n`);
|
|
93
|
+
}
|
|
94
|
+
const extraneousHookNames = Object.getOwnPropertyNames(hooks).filter((hookName) => !expectedHookNames.has(hookName));
|
|
95
|
+
if (extraneousHookNames.length > 0) {
|
|
96
|
+
throw new Error(`Received unexpected hooks:\n\n${extraneousHookNames.join('\n')}\n`);
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
exports.assertExpectedHooks = assertExpectedHooks;
|
|
100
|
+
/**
|
|
101
|
+
* Creates a per-handler messenger namespaced to `namespace`, and delegates the
|
|
102
|
+
* specified `actionNames` from `rootMessenger` to it. This lets each handler
|
|
103
|
+
* call only the actions it declared, per POLA.
|
|
104
|
+
*
|
|
105
|
+
* @param options - The options.
|
|
106
|
+
* @param options.namespace - The namespace for the handler messenger.
|
|
107
|
+
* @param options.actionNames - Actions to delegate from the root messenger.
|
|
108
|
+
* @param options.rootMessenger - The root messenger to delegate from. Required
|
|
109
|
+
* when `actionNames` are provided.
|
|
110
|
+
* @returns The per-handler messenger.
|
|
111
|
+
*/
|
|
112
|
+
function createHandlerMessenger({ namespace, actionNames, rootMessenger, }) {
|
|
113
|
+
if (!actionNames) {
|
|
114
|
+
return undefined;
|
|
115
|
+
}
|
|
116
|
+
if (!rootMessenger) {
|
|
117
|
+
throw new Error('A messenger is required when a handler declares actionNames.');
|
|
118
|
+
}
|
|
119
|
+
const handlerMessenger = new messenger_1.Messenger({ namespace, parent: rootMessenger });
|
|
120
|
+
rootMessenger.delegate({
|
|
121
|
+
actions: actionNames,
|
|
122
|
+
messenger: handlerMessenger,
|
|
123
|
+
});
|
|
124
|
+
return handlerMessenger;
|
|
125
|
+
}
|
|
126
|
+
exports.createHandlerMessenger = createHandlerMessenger;
|
|
52
127
|
//# sourceMappingURL=utils.cjs.map
|
package/dist/v2/utils.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"utils.cjs","sourceRoot":"","sources":["../../src/v2/utils.ts"],"names":[],"mappings":";;;;
|
|
1
|
+
{"version":3,"file":"utils.cjs","sourceRoot":"","sources":["../../src/v2/utils.ts"],"names":[],"mappings":";;;;AACA,mDAAgD;AAChD,2CAAwD;AAkBjD,MAAM,SAAS,GAAG,CACvB,OAA4D,EACzB,EAAE,CAAC,IAAA,mBAAW,EAAC,OAAO,EAAE,IAAI,CAAC,CAAC;AAFtD,QAAA,SAAS,aAE6C;AAE5D,MAAM,cAAc,GAAG,CAC5B,OAA4B,EACY,EAAE,CAAC,CAAC,IAAA,iBAAS,EAAC,OAAO,CAAC,CAAC;AAFpD,QAAA,cAAc,kBAEsC;AAgBjE;;;;;GAKG;AACH,SAAgB,SAAS,CAAC,KAAc;IACtC,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AACxC,CAAC;AAFD,8BAEC;AAED;;;;;;GAMG;AACI,MAAM,UAAU,GAAG,CACxB,KAAc,EACd,MAAc,EACoB,EAAE,CACpC,IAAA,gBAAQ,EAAC,KAAK,CAAC,IAAI,MAAM,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC;AAJlD,QAAA,UAAU,cAIwC;AAE/D,MAAM,wBAAwB,GAAG,MAAM,CAAC,GAAG,CACzC,oCAAoC,CACrC,CAAC;AAEF,MAAa,kBAAmB,SAAQ,KAAK;IAM3C,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QANjB,4EAA4E;QAC5E,0BAA0B;QAC1B,gDAAgD;QAC/B,QAA0B,GAAG,IAAI,CAAC;QAIjD,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;IACnC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,CAAC,KAAc;QAC9B,OAAO,IAAA,kBAAU,EAAC,KAAK,EAAE,wBAAwB,CAAC,CAAC;IACrD,CAAC;CACF;AArBD,gDAqBC;KAjBmB,wBAAwB;AAmB5C,0BAA0B;AAE1B;;;;;;;;;;;GAWG;AACH,SAAgB,WAAW,CACzB,KAAY,EACZ,SAAkC;IAElC,IAAI,SAAS,EAAE,CAAC;QACd,OAAO,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,CAClC,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE;YACf,MAAM,QAAQ,GAAG,IAAgB,CAAC;YAClC,MAAM,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;YACnC,OAAO,MAAM,CAAC;QAChB,CAAC,EACD,EAAE,CACsB,CAAC;IAC7B,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAfD,kCAeC;AAED;;;;;;GAMG;AACH,SAAgB,mBAAmB,CACjC,KAA8B,EAC9B,iBAA8B;IAE9B,MAAM,gBAAgB,GAAa,EAAE,CAAC;IACtC,iBAAiB,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QACrC,IAAI,CAAC,IAAA,mBAAW,EAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,CAAC;YAClC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAClC,CAAC;IACH,CAAC,CAAC,CAAC;IACH,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CACb,8BAA8B,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAC9D,CAAC;IACJ,CAAC;IAED,MAAM,mBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,MAAM,CAClE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,iBAAiB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAC/C,CAAC;IACF,IAAI,mBAAmB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CACb,iCAAiC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CACpE,CAAC;IACJ,CAAC;AACH,CAAC;AAxBD,kDAwBC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,sBAAsB,CAAmC,EACvE,SAAS,EACT,WAAW,EACX,aAAa,GAKd;IACC,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CACb,8DAA8D,CAC/D,CAAC;IACJ,CAAC;IAED,MAAM,gBAAgB,GAAG,IAAI,qBAAS,CAKpC,EAAE,SAAS,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC;IAExC,aAAa,CAAC,QAAQ,CAAC;QACrB,OAAO,EAAE,WAAgC;QACzC,SAAS,EAAE,gBAAgB;KAC5B,CAAC,CAAC;IAEH,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAhCD,wDAgCC","sourcesContent":["import type { ActionConstraint } from '@metamask/messenger';\nimport { Messenger } from '@metamask/messenger';\nimport { hasProperty, isObject } from '@metamask/utils';\nimport type {\n JsonRpcNotification,\n JsonRpcParams,\n JsonRpcRequest,\n} from '@metamask/utils';\n\nexport type {\n Json,\n JsonRpcParams,\n JsonRpcRequest,\n JsonRpcNotification,\n} from '@metamask/utils';\n\nexport type JsonRpcCall<Params extends JsonRpcParams = JsonRpcParams> =\n | JsonRpcNotification<Params>\n | JsonRpcRequest<Params>;\n\nexport const isRequest = <Params extends JsonRpcParams>(\n message: JsonRpcCall<Params> | Readonly<JsonRpcCall<Params>>,\n): message is JsonRpcRequest<Params> => hasProperty(message, 'id');\n\nexport const isNotification = <Params extends JsonRpcParams>(\n message: JsonRpcCall<Params>,\n): message is JsonRpcNotification<Params> => !isRequest(message);\n\n/**\n * An unholy incantation that converts a union of object types into an\n * intersection of object types.\n *\n * @example\n * type A = { a: string } | { b: number };\n * type B = UnionToIntersection<A>; // { a: string } & { b: number }\n */\nexport type UnionToIntersection<Union> = (\n Union extends never ? never : (k: Union) => void\n) extends (k: infer Args) => void\n ? Args\n : never;\n\n/**\n * JSON-stringifies a value.\n *\n * @param value - The value to stringify.\n * @returns The stringified value.\n */\nexport function stringify(value: unknown): string {\n return JSON.stringify(value, null, 2);\n}\n\n/**\n * The implementation of static `isInstance` methods for classes that have them.\n *\n * @param value - The value to check.\n * @param symbol - The symbol property to check for.\n * @returns Whether the value has `{ [symbol]: true }` in its prototype chain.\n */\nexport const isInstance = (\n value: unknown,\n symbol: symbol,\n): value is { [key: symbol]: true } =>\n isObject(value) && symbol in value && value[symbol] === true;\n\nconst JsonRpcEngineErrorSymbol = Symbol.for(\n 'json-rpc-engine#JsonRpcEngineError',\n);\n\nexport class JsonRpcEngineError extends Error {\n // This is a computed property name, and it doesn't seem possible to make it\n // hash private using `#`.\n // eslint-disable-next-line no-restricted-syntax\n private readonly [JsonRpcEngineErrorSymbol] = true;\n\n constructor(message: string) {\n super(message);\n this.name = 'JsonRpcEngineError';\n }\n\n /**\n * Check if a value is a {@link JsonRpcEngineError} instance.\n * Works across different package versions in the same realm.\n *\n * @param value - The value to check.\n * @returns Whether the value is a {@link JsonRpcEngineError} instance.\n */\n static isInstance(value: unknown): value is JsonRpcEngineError {\n return isInstance(value, JsonRpcEngineErrorSymbol);\n }\n}\n\n// Method middleware utils\n\n/**\n * Returns the subset of the specified `hooks` that are included in the\n * `hookNames` object. This is a Principle of Least Authority (POLA) measure\n * to ensure that each RPC method implementation only has access to the\n * API \"hooks\" it needs to do its job.\n *\n * @param hooks - The hooks to select from.\n * @param hookNames - The names of the hooks to select.\n * @returns The selected hooks, or `undefined` if `hookNames` is not provided.\n * @template Hooks - The hooks to select from.\n * @template HookName - The names of the hooks to select.\n */\nexport function selectHooks<Hooks, HookName extends keyof Hooks>(\n hooks: Hooks,\n hookNames?: Record<HookName, true>,\n): Pick<Hooks, HookName> | undefined {\n if (hookNames) {\n return Object.keys(hookNames).reduce<Partial<Pick<Hooks, HookName>>>(\n (subset, name) => {\n const hookName = name as HookName;\n subset[hookName] = hooks[hookName];\n return subset;\n },\n {},\n ) as Pick<Hooks, HookName>;\n }\n return undefined;\n}\n\n/**\n * Asserts that `hooks` contains exactly the hook names in `expectedHookNames`.\n * Throws on any missing hooks, then on any extraneous hooks.\n *\n * @param hooks - The hooks object to validate.\n * @param expectedHookNames - The expected hook names.\n */\nexport function assertExpectedHooks(\n hooks: Record<string, unknown>,\n expectedHookNames: Set<string>,\n): void {\n const missingHookNames: string[] = [];\n expectedHookNames.forEach((hookName) => {\n if (!hasProperty(hooks, hookName)) {\n missingHookNames.push(hookName);\n }\n });\n if (missingHookNames.length > 0) {\n throw new Error(\n `Missing expected hooks:\\n\\n${missingHookNames.join('\\n')}\\n`,\n );\n }\n\n const extraneousHookNames = Object.getOwnPropertyNames(hooks).filter(\n (hookName) => !expectedHookNames.has(hookName),\n );\n if (extraneousHookNames.length > 0) {\n throw new Error(\n `Received unexpected hooks:\\n\\n${extraneousHookNames.join('\\n')}\\n`,\n );\n }\n}\n\n/**\n * Creates a per-handler messenger namespaced to `namespace`, and delegates the\n * specified `actionNames` from `rootMessenger` to it. This lets each handler\n * call only the actions it declared, per POLA.\n *\n * @param options - The options.\n * @param options.namespace - The namespace for the handler messenger.\n * @param options.actionNames - Actions to delegate from the root messenger.\n * @param options.rootMessenger - The root messenger to delegate from. Required\n * when `actionNames` are provided.\n * @returns The per-handler messenger.\n */\nexport function createHandlerMessenger<Actions extends ActionConstraint>({\n namespace,\n actionNames,\n rootMessenger,\n}: {\n namespace: string;\n actionNames: readonly Actions['type'][] | undefined;\n rootMessenger?: Messenger<string, Actions> | undefined;\n}): Messenger<string, Actions> | undefined {\n if (!actionNames) {\n return undefined;\n }\n\n if (!rootMessenger) {\n throw new Error(\n 'A messenger is required when a handler declares actionNames.',\n );\n }\n\n const handlerMessenger = new Messenger<\n string,\n Actions,\n never,\n typeof rootMessenger\n >({ namespace, parent: rootMessenger });\n\n rootMessenger.delegate({\n actions: actionNames as Actions['type'][],\n messenger: handlerMessenger,\n });\n\n return handlerMessenger;\n}\n"]}
|
package/dist/v2/utils.d.cts
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import type { ActionConstraint } from "@metamask/messenger";
|
|
2
|
+
import { Messenger } from "@metamask/messenger";
|
|
1
3
|
import type { JsonRpcNotification, JsonRpcParams, JsonRpcRequest } from "@metamask/utils";
|
|
2
4
|
export type { Json, JsonRpcParams, JsonRpcRequest, JsonRpcNotification, } from "@metamask/utils";
|
|
3
5
|
export type JsonRpcCall<Params extends JsonRpcParams = JsonRpcParams> = JsonRpcNotification<Params> | JsonRpcRequest<Params>;
|
|
@@ -42,4 +44,42 @@ export declare class JsonRpcEngineError extends Error {
|
|
|
42
44
|
*/
|
|
43
45
|
static isInstance(value: unknown): value is JsonRpcEngineError;
|
|
44
46
|
}
|
|
47
|
+
/**
|
|
48
|
+
* Returns the subset of the specified `hooks` that are included in the
|
|
49
|
+
* `hookNames` object. This is a Principle of Least Authority (POLA) measure
|
|
50
|
+
* to ensure that each RPC method implementation only has access to the
|
|
51
|
+
* API "hooks" it needs to do its job.
|
|
52
|
+
*
|
|
53
|
+
* @param hooks - The hooks to select from.
|
|
54
|
+
* @param hookNames - The names of the hooks to select.
|
|
55
|
+
* @returns The selected hooks, or `undefined` if `hookNames` is not provided.
|
|
56
|
+
* @template Hooks - The hooks to select from.
|
|
57
|
+
* @template HookName - The names of the hooks to select.
|
|
58
|
+
*/
|
|
59
|
+
export declare function selectHooks<Hooks, HookName extends keyof Hooks>(hooks: Hooks, hookNames?: Record<HookName, true>): Pick<Hooks, HookName> | undefined;
|
|
60
|
+
/**
|
|
61
|
+
* Asserts that `hooks` contains exactly the hook names in `expectedHookNames`.
|
|
62
|
+
* Throws on any missing hooks, then on any extraneous hooks.
|
|
63
|
+
*
|
|
64
|
+
* @param hooks - The hooks object to validate.
|
|
65
|
+
* @param expectedHookNames - The expected hook names.
|
|
66
|
+
*/
|
|
67
|
+
export declare function assertExpectedHooks(hooks: Record<string, unknown>, expectedHookNames: Set<string>): void;
|
|
68
|
+
/**
|
|
69
|
+
* Creates a per-handler messenger namespaced to `namespace`, and delegates the
|
|
70
|
+
* specified `actionNames` from `rootMessenger` to it. This lets each handler
|
|
71
|
+
* call only the actions it declared, per POLA.
|
|
72
|
+
*
|
|
73
|
+
* @param options - The options.
|
|
74
|
+
* @param options.namespace - The namespace for the handler messenger.
|
|
75
|
+
* @param options.actionNames - Actions to delegate from the root messenger.
|
|
76
|
+
* @param options.rootMessenger - The root messenger to delegate from. Required
|
|
77
|
+
* when `actionNames` are provided.
|
|
78
|
+
* @returns The per-handler messenger.
|
|
79
|
+
*/
|
|
80
|
+
export declare function createHandlerMessenger<Actions extends ActionConstraint>({ namespace, actionNames, rootMessenger, }: {
|
|
81
|
+
namespace: string;
|
|
82
|
+
actionNames: readonly Actions['type'][] | undefined;
|
|
83
|
+
rootMessenger?: Messenger<string, Actions> | undefined;
|
|
84
|
+
}): Messenger<string, Actions> | undefined;
|
|
45
85
|
//# sourceMappingURL=utils.d.cts.map
|
package/dist/v2/utils.d.cts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"utils.d.cts","sourceRoot":"","sources":["../../src/v2/utils.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"utils.d.cts","sourceRoot":"","sources":["../../src/v2/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,4BAA4B;AAC5D,OAAO,EAAE,SAAS,EAAE,4BAA4B;AAEhD,OAAO,KAAK,EACV,mBAAmB,EACnB,aAAa,EACb,cAAc,EACf,wBAAwB;AAEzB,YAAY,EACV,IAAI,EACJ,aAAa,EACb,cAAc,EACd,mBAAmB,GACpB,wBAAwB;AAEzB,MAAM,MAAM,WAAW,CAAC,MAAM,SAAS,aAAa,GAAG,aAAa,IAChE,mBAAmB,CAAC,MAAM,CAAC,GAC3B,cAAc,CAAC,MAAM,CAAC,CAAC;AAE3B,eAAO,MAAM,SAAS,mIAE4C,CAAC;AAEnE,eAAO,MAAM,cAAc,wGAEqC,CAAC;AAEjE;;;;;;;GAOG;AACH,MAAM,MAAM,mBAAmB,CAAC,KAAK,IAAI,CACvC,KAAK,SAAS,KAAK,GAAG,KAAK,GAAG,CAAC,CAAC,EAAE,KAAK,KAAK,IAAI,CACjD,SAAS,CAAC,CAAC,EAAE,MAAM,IAAI,KAAK,IAAI,GAC7B,IAAI,GACJ,KAAK,CAAC;AAEV;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAEhD;AAED;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,UACd,OAAO,UACN,MAAM;;CAE8C,CAAC;AAE/D,QAAA,MAAM,wBAAwB,eAE7B,CAAC;AAEF,qBAAa,kBAAmB,SAAQ,KAAK;IAI3C,OAAO,CAAC,QAAQ,CAAC,CAAC,wBAAwB,CAAC,CAAQ;gBAEvC,OAAO,EAAE,MAAM;IAK3B;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,kBAAkB;CAG/D;AAID;;;;;;;;;;;GAWG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,QAAQ,SAAS,MAAM,KAAK,EAC7D,KAAK,EAAE,KAAK,EACZ,SAAS,CAAC,EAAE,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,GACjC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,SAAS,CAYnC;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC9B,iBAAiB,EAAE,GAAG,CAAC,MAAM,CAAC,GAC7B,IAAI,CAqBN;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,SAAS,gBAAgB,EAAE,EACvE,SAAS,EACT,WAAW,EACX,aAAa,GACd,EAAE;IACD,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,SAAS,OAAO,CAAC,MAAM,CAAC,EAAE,GAAG,SAAS,CAAC;IACpD,aAAa,CAAC,EAAE,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;CACxD,GAAG,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAwBzC"}
|
package/dist/v2/utils.d.mts
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import type { ActionConstraint } from "@metamask/messenger";
|
|
2
|
+
import { Messenger } from "@metamask/messenger";
|
|
1
3
|
import type { JsonRpcNotification, JsonRpcParams, JsonRpcRequest } from "@metamask/utils";
|
|
2
4
|
export type { Json, JsonRpcParams, JsonRpcRequest, JsonRpcNotification, } from "@metamask/utils";
|
|
3
5
|
export type JsonRpcCall<Params extends JsonRpcParams = JsonRpcParams> = JsonRpcNotification<Params> | JsonRpcRequest<Params>;
|
|
@@ -42,4 +44,42 @@ export declare class JsonRpcEngineError extends Error {
|
|
|
42
44
|
*/
|
|
43
45
|
static isInstance(value: unknown): value is JsonRpcEngineError;
|
|
44
46
|
}
|
|
47
|
+
/**
|
|
48
|
+
* Returns the subset of the specified `hooks` that are included in the
|
|
49
|
+
* `hookNames` object. This is a Principle of Least Authority (POLA) measure
|
|
50
|
+
* to ensure that each RPC method implementation only has access to the
|
|
51
|
+
* API "hooks" it needs to do its job.
|
|
52
|
+
*
|
|
53
|
+
* @param hooks - The hooks to select from.
|
|
54
|
+
* @param hookNames - The names of the hooks to select.
|
|
55
|
+
* @returns The selected hooks, or `undefined` if `hookNames` is not provided.
|
|
56
|
+
* @template Hooks - The hooks to select from.
|
|
57
|
+
* @template HookName - The names of the hooks to select.
|
|
58
|
+
*/
|
|
59
|
+
export declare function selectHooks<Hooks, HookName extends keyof Hooks>(hooks: Hooks, hookNames?: Record<HookName, true>): Pick<Hooks, HookName> | undefined;
|
|
60
|
+
/**
|
|
61
|
+
* Asserts that `hooks` contains exactly the hook names in `expectedHookNames`.
|
|
62
|
+
* Throws on any missing hooks, then on any extraneous hooks.
|
|
63
|
+
*
|
|
64
|
+
* @param hooks - The hooks object to validate.
|
|
65
|
+
* @param expectedHookNames - The expected hook names.
|
|
66
|
+
*/
|
|
67
|
+
export declare function assertExpectedHooks(hooks: Record<string, unknown>, expectedHookNames: Set<string>): void;
|
|
68
|
+
/**
|
|
69
|
+
* Creates a per-handler messenger namespaced to `namespace`, and delegates the
|
|
70
|
+
* specified `actionNames` from `rootMessenger` to it. This lets each handler
|
|
71
|
+
* call only the actions it declared, per POLA.
|
|
72
|
+
*
|
|
73
|
+
* @param options - The options.
|
|
74
|
+
* @param options.namespace - The namespace for the handler messenger.
|
|
75
|
+
* @param options.actionNames - Actions to delegate from the root messenger.
|
|
76
|
+
* @param options.rootMessenger - The root messenger to delegate from. Required
|
|
77
|
+
* when `actionNames` are provided.
|
|
78
|
+
* @returns The per-handler messenger.
|
|
79
|
+
*/
|
|
80
|
+
export declare function createHandlerMessenger<Actions extends ActionConstraint>({ namespace, actionNames, rootMessenger, }: {
|
|
81
|
+
namespace: string;
|
|
82
|
+
actionNames: readonly Actions['type'][] | undefined;
|
|
83
|
+
rootMessenger?: Messenger<string, Actions> | undefined;
|
|
84
|
+
}): Messenger<string, Actions> | undefined;
|
|
45
85
|
//# sourceMappingURL=utils.d.mts.map
|
package/dist/v2/utils.d.mts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"utils.d.mts","sourceRoot":"","sources":["../../src/v2/utils.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"utils.d.mts","sourceRoot":"","sources":["../../src/v2/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,4BAA4B;AAC5D,OAAO,EAAE,SAAS,EAAE,4BAA4B;AAEhD,OAAO,KAAK,EACV,mBAAmB,EACnB,aAAa,EACb,cAAc,EACf,wBAAwB;AAEzB,YAAY,EACV,IAAI,EACJ,aAAa,EACb,cAAc,EACd,mBAAmB,GACpB,wBAAwB;AAEzB,MAAM,MAAM,WAAW,CAAC,MAAM,SAAS,aAAa,GAAG,aAAa,IAChE,mBAAmB,CAAC,MAAM,CAAC,GAC3B,cAAc,CAAC,MAAM,CAAC,CAAC;AAE3B,eAAO,MAAM,SAAS,mIAE4C,CAAC;AAEnE,eAAO,MAAM,cAAc,wGAEqC,CAAC;AAEjE;;;;;;;GAOG;AACH,MAAM,MAAM,mBAAmB,CAAC,KAAK,IAAI,CACvC,KAAK,SAAS,KAAK,GAAG,KAAK,GAAG,CAAC,CAAC,EAAE,KAAK,KAAK,IAAI,CACjD,SAAS,CAAC,CAAC,EAAE,MAAM,IAAI,KAAK,IAAI,GAC7B,IAAI,GACJ,KAAK,CAAC;AAEV;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAEhD;AAED;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,UACd,OAAO,UACN,MAAM;;CAE8C,CAAC;AAE/D,QAAA,MAAM,wBAAwB,eAE7B,CAAC;AAEF,qBAAa,kBAAmB,SAAQ,KAAK;IAI3C,OAAO,CAAC,QAAQ,CAAC,CAAC,wBAAwB,CAAC,CAAQ;gBAEvC,OAAO,EAAE,MAAM;IAK3B;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,kBAAkB;CAG/D;AAID;;;;;;;;;;;GAWG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,QAAQ,SAAS,MAAM,KAAK,EAC7D,KAAK,EAAE,KAAK,EACZ,SAAS,CAAC,EAAE,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,GACjC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,SAAS,CAYnC;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC9B,iBAAiB,EAAE,GAAG,CAAC,MAAM,CAAC,GAC7B,IAAI,CAqBN;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,SAAS,gBAAgB,EAAE,EACvE,SAAS,EACT,WAAW,EACX,aAAa,GACd,EAAE;IACD,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,SAAS,OAAO,CAAC,MAAM,CAAC,EAAE,GAAG,SAAS,CAAC;IACpD,aAAa,CAAC,EAAE,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;CACxD,GAAG,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAwBzC"}
|
package/dist/v2/utils.mjs
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
var _a;
|
|
2
|
+
import { Messenger } from "@metamask/messenger";
|
|
2
3
|
import { hasProperty, isObject } from "@metamask/utils";
|
|
3
4
|
export const isRequest = (message) => hasProperty(message, 'id');
|
|
4
5
|
export const isNotification = (message) => !isRequest(message);
|
|
@@ -41,4 +42,75 @@ export class JsonRpcEngineError extends Error {
|
|
|
41
42
|
}
|
|
42
43
|
}
|
|
43
44
|
_a = JsonRpcEngineErrorSymbol;
|
|
45
|
+
// Method middleware utils
|
|
46
|
+
/**
|
|
47
|
+
* Returns the subset of the specified `hooks` that are included in the
|
|
48
|
+
* `hookNames` object. This is a Principle of Least Authority (POLA) measure
|
|
49
|
+
* to ensure that each RPC method implementation only has access to the
|
|
50
|
+
* API "hooks" it needs to do its job.
|
|
51
|
+
*
|
|
52
|
+
* @param hooks - The hooks to select from.
|
|
53
|
+
* @param hookNames - The names of the hooks to select.
|
|
54
|
+
* @returns The selected hooks, or `undefined` if `hookNames` is not provided.
|
|
55
|
+
* @template Hooks - The hooks to select from.
|
|
56
|
+
* @template HookName - The names of the hooks to select.
|
|
57
|
+
*/
|
|
58
|
+
export function selectHooks(hooks, hookNames) {
|
|
59
|
+
if (hookNames) {
|
|
60
|
+
return Object.keys(hookNames).reduce((subset, name) => {
|
|
61
|
+
const hookName = name;
|
|
62
|
+
subset[hookName] = hooks[hookName];
|
|
63
|
+
return subset;
|
|
64
|
+
}, {});
|
|
65
|
+
}
|
|
66
|
+
return undefined;
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Asserts that `hooks` contains exactly the hook names in `expectedHookNames`.
|
|
70
|
+
* Throws on any missing hooks, then on any extraneous hooks.
|
|
71
|
+
*
|
|
72
|
+
* @param hooks - The hooks object to validate.
|
|
73
|
+
* @param expectedHookNames - The expected hook names.
|
|
74
|
+
*/
|
|
75
|
+
export function assertExpectedHooks(hooks, expectedHookNames) {
|
|
76
|
+
const missingHookNames = [];
|
|
77
|
+
expectedHookNames.forEach((hookName) => {
|
|
78
|
+
if (!hasProperty(hooks, hookName)) {
|
|
79
|
+
missingHookNames.push(hookName);
|
|
80
|
+
}
|
|
81
|
+
});
|
|
82
|
+
if (missingHookNames.length > 0) {
|
|
83
|
+
throw new Error(`Missing expected hooks:\n\n${missingHookNames.join('\n')}\n`);
|
|
84
|
+
}
|
|
85
|
+
const extraneousHookNames = Object.getOwnPropertyNames(hooks).filter((hookName) => !expectedHookNames.has(hookName));
|
|
86
|
+
if (extraneousHookNames.length > 0) {
|
|
87
|
+
throw new Error(`Received unexpected hooks:\n\n${extraneousHookNames.join('\n')}\n`);
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
/**
|
|
91
|
+
* Creates a per-handler messenger namespaced to `namespace`, and delegates the
|
|
92
|
+
* specified `actionNames` from `rootMessenger` to it. This lets each handler
|
|
93
|
+
* call only the actions it declared, per POLA.
|
|
94
|
+
*
|
|
95
|
+
* @param options - The options.
|
|
96
|
+
* @param options.namespace - The namespace for the handler messenger.
|
|
97
|
+
* @param options.actionNames - Actions to delegate from the root messenger.
|
|
98
|
+
* @param options.rootMessenger - The root messenger to delegate from. Required
|
|
99
|
+
* when `actionNames` are provided.
|
|
100
|
+
* @returns The per-handler messenger.
|
|
101
|
+
*/
|
|
102
|
+
export function createHandlerMessenger({ namespace, actionNames, rootMessenger, }) {
|
|
103
|
+
if (!actionNames) {
|
|
104
|
+
return undefined;
|
|
105
|
+
}
|
|
106
|
+
if (!rootMessenger) {
|
|
107
|
+
throw new Error('A messenger is required when a handler declares actionNames.');
|
|
108
|
+
}
|
|
109
|
+
const handlerMessenger = new Messenger({ namespace, parent: rootMessenger });
|
|
110
|
+
rootMessenger.delegate({
|
|
111
|
+
actions: actionNames,
|
|
112
|
+
messenger: handlerMessenger,
|
|
113
|
+
});
|
|
114
|
+
return handlerMessenger;
|
|
115
|
+
}
|
|
44
116
|
//# sourceMappingURL=utils.mjs.map
|
package/dist/v2/utils.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"utils.mjs","sourceRoot":"","sources":["../../src/v2/utils.ts"],"names":[],"mappings":";
|
|
1
|
+
{"version":3,"file":"utils.mjs","sourceRoot":"","sources":["../../src/v2/utils.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,SAAS,EAAE,4BAA4B;AAChD,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,wBAAwB;AAkBxD,MAAM,CAAC,MAAM,SAAS,GAAG,CACvB,OAA4D,EACzB,EAAE,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;AAEnE,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,OAA4B,EACY,EAAE,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;AAgBjE;;;;;GAKG;AACH,MAAM,UAAU,SAAS,CAAC,KAAc;IACtC,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AACxC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,KAAc,EACd,MAAc,EACoB,EAAE,CACpC,QAAQ,CAAC,KAAK,CAAC,IAAI,MAAM,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC;AAE/D,MAAM,wBAAwB,GAAG,MAAM,CAAC,GAAG,CACzC,oCAAoC,CACrC,CAAC;AAEF,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAM3C,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QANjB,4EAA4E;QAC5E,0BAA0B;QAC1B,gDAAgD;QAC/B,QAA0B,GAAG,IAAI,CAAC;QAIjD,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;IACnC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,CAAC,KAAc;QAC9B,OAAO,UAAU,CAAC,KAAK,EAAE,wBAAwB,CAAC,CAAC;IACrD,CAAC;CACF;KAjBmB,wBAAwB;AAmB5C,0BAA0B;AAE1B;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,WAAW,CACzB,KAAY,EACZ,SAAkC;IAElC,IAAI,SAAS,EAAE,CAAC;QACd,OAAO,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,CAClC,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE;YACf,MAAM,QAAQ,GAAG,IAAgB,CAAC;YAClC,MAAM,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;YACnC,OAAO,MAAM,CAAC;QAChB,CAAC,EACD,EAAE,CACsB,CAAC;IAC7B,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CACjC,KAA8B,EAC9B,iBAA8B;IAE9B,MAAM,gBAAgB,GAAa,EAAE,CAAC;IACtC,iBAAiB,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QACrC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,CAAC;YAClC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAClC,CAAC;IACH,CAAC,CAAC,CAAC;IACH,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CACb,8BAA8B,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAC9D,CAAC;IACJ,CAAC;IAED,MAAM,mBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,MAAM,CAClE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,iBAAiB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAC/C,CAAC;IACF,IAAI,mBAAmB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CACb,iCAAiC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CACpE,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,sBAAsB,CAAmC,EACvE,SAAS,EACT,WAAW,EACX,aAAa,GAKd;IACC,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CACb,8DAA8D,CAC/D,CAAC;IACJ,CAAC;IAED,MAAM,gBAAgB,GAAG,IAAI,SAAS,CAKpC,EAAE,SAAS,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC;IAExC,aAAa,CAAC,QAAQ,CAAC;QACrB,OAAO,EAAE,WAAgC;QACzC,SAAS,EAAE,gBAAgB;KAC5B,CAAC,CAAC;IAEH,OAAO,gBAAgB,CAAC;AAC1B,CAAC","sourcesContent":["import type { ActionConstraint } from '@metamask/messenger';\nimport { Messenger } from '@metamask/messenger';\nimport { hasProperty, isObject } from '@metamask/utils';\nimport type {\n JsonRpcNotification,\n JsonRpcParams,\n JsonRpcRequest,\n} from '@metamask/utils';\n\nexport type {\n Json,\n JsonRpcParams,\n JsonRpcRequest,\n JsonRpcNotification,\n} from '@metamask/utils';\n\nexport type JsonRpcCall<Params extends JsonRpcParams = JsonRpcParams> =\n | JsonRpcNotification<Params>\n | JsonRpcRequest<Params>;\n\nexport const isRequest = <Params extends JsonRpcParams>(\n message: JsonRpcCall<Params> | Readonly<JsonRpcCall<Params>>,\n): message is JsonRpcRequest<Params> => hasProperty(message, 'id');\n\nexport const isNotification = <Params extends JsonRpcParams>(\n message: JsonRpcCall<Params>,\n): message is JsonRpcNotification<Params> => !isRequest(message);\n\n/**\n * An unholy incantation that converts a union of object types into an\n * intersection of object types.\n *\n * @example\n * type A = { a: string } | { b: number };\n * type B = UnionToIntersection<A>; // { a: string } & { b: number }\n */\nexport type UnionToIntersection<Union> = (\n Union extends never ? never : (k: Union) => void\n) extends (k: infer Args) => void\n ? Args\n : never;\n\n/**\n * JSON-stringifies a value.\n *\n * @param value - The value to stringify.\n * @returns The stringified value.\n */\nexport function stringify(value: unknown): string {\n return JSON.stringify(value, null, 2);\n}\n\n/**\n * The implementation of static `isInstance` methods for classes that have them.\n *\n * @param value - The value to check.\n * @param symbol - The symbol property to check for.\n * @returns Whether the value has `{ [symbol]: true }` in its prototype chain.\n */\nexport const isInstance = (\n value: unknown,\n symbol: symbol,\n): value is { [key: symbol]: true } =>\n isObject(value) && symbol in value && value[symbol] === true;\n\nconst JsonRpcEngineErrorSymbol = Symbol.for(\n 'json-rpc-engine#JsonRpcEngineError',\n);\n\nexport class JsonRpcEngineError extends Error {\n // This is a computed property name, and it doesn't seem possible to make it\n // hash private using `#`.\n // eslint-disable-next-line no-restricted-syntax\n private readonly [JsonRpcEngineErrorSymbol] = true;\n\n constructor(message: string) {\n super(message);\n this.name = 'JsonRpcEngineError';\n }\n\n /**\n * Check if a value is a {@link JsonRpcEngineError} instance.\n * Works across different package versions in the same realm.\n *\n * @param value - The value to check.\n * @returns Whether the value is a {@link JsonRpcEngineError} instance.\n */\n static isInstance(value: unknown): value is JsonRpcEngineError {\n return isInstance(value, JsonRpcEngineErrorSymbol);\n }\n}\n\n// Method middleware utils\n\n/**\n * Returns the subset of the specified `hooks` that are included in the\n * `hookNames` object. This is a Principle of Least Authority (POLA) measure\n * to ensure that each RPC method implementation only has access to the\n * API \"hooks\" it needs to do its job.\n *\n * @param hooks - The hooks to select from.\n * @param hookNames - The names of the hooks to select.\n * @returns The selected hooks, or `undefined` if `hookNames` is not provided.\n * @template Hooks - The hooks to select from.\n * @template HookName - The names of the hooks to select.\n */\nexport function selectHooks<Hooks, HookName extends keyof Hooks>(\n hooks: Hooks,\n hookNames?: Record<HookName, true>,\n): Pick<Hooks, HookName> | undefined {\n if (hookNames) {\n return Object.keys(hookNames).reduce<Partial<Pick<Hooks, HookName>>>(\n (subset, name) => {\n const hookName = name as HookName;\n subset[hookName] = hooks[hookName];\n return subset;\n },\n {},\n ) as Pick<Hooks, HookName>;\n }\n return undefined;\n}\n\n/**\n * Asserts that `hooks` contains exactly the hook names in `expectedHookNames`.\n * Throws on any missing hooks, then on any extraneous hooks.\n *\n * @param hooks - The hooks object to validate.\n * @param expectedHookNames - The expected hook names.\n */\nexport function assertExpectedHooks(\n hooks: Record<string, unknown>,\n expectedHookNames: Set<string>,\n): void {\n const missingHookNames: string[] = [];\n expectedHookNames.forEach((hookName) => {\n if (!hasProperty(hooks, hookName)) {\n missingHookNames.push(hookName);\n }\n });\n if (missingHookNames.length > 0) {\n throw new Error(\n `Missing expected hooks:\\n\\n${missingHookNames.join('\\n')}\\n`,\n );\n }\n\n const extraneousHookNames = Object.getOwnPropertyNames(hooks).filter(\n (hookName) => !expectedHookNames.has(hookName),\n );\n if (extraneousHookNames.length > 0) {\n throw new Error(\n `Received unexpected hooks:\\n\\n${extraneousHookNames.join('\\n')}\\n`,\n );\n }\n}\n\n/**\n * Creates a per-handler messenger namespaced to `namespace`, and delegates the\n * specified `actionNames` from `rootMessenger` to it. This lets each handler\n * call only the actions it declared, per POLA.\n *\n * @param options - The options.\n * @param options.namespace - The namespace for the handler messenger.\n * @param options.actionNames - Actions to delegate from the root messenger.\n * @param options.rootMessenger - The root messenger to delegate from. Required\n * when `actionNames` are provided.\n * @returns The per-handler messenger.\n */\nexport function createHandlerMessenger<Actions extends ActionConstraint>({\n namespace,\n actionNames,\n rootMessenger,\n}: {\n namespace: string;\n actionNames: readonly Actions['type'][] | undefined;\n rootMessenger?: Messenger<string, Actions> | undefined;\n}): Messenger<string, Actions> | undefined {\n if (!actionNames) {\n return undefined;\n }\n\n if (!rootMessenger) {\n throw new Error(\n 'A messenger is required when a handler declares actionNames.',\n );\n }\n\n const handlerMessenger = new Messenger<\n string,\n Actions,\n never,\n typeof rootMessenger\n >({ namespace, parent: rootMessenger });\n\n rootMessenger.delegate({\n actions: actionNames as Actions['type'][],\n messenger: handlerMessenger,\n });\n\n return handlerMessenger;\n}\n"]}
|