@metamask/snaps-rpc-methods 11.7.0 → 11.9.0

package/dist/permitted/handlers.mjs

@@ -1,16 +1,22 @@
+import { cancelBackgroundEventHandler } from "./cancelBackgroundEvent.mjs";
+import { clearStateHandler } from "./clearState.mjs";
 import { createInterfaceHandler } from "./createInterface.mjs";
 import { providerRequestHandler } from "./experimentalProviderRequest.mjs";
 import { getAllSnapsHandler } from "./getAllSnaps.mjs";
+import { getBackgroundEventsHandler } from "./getBackgroundEvents.mjs";
 import { getClientStatusHandler } from "./getClientStatus.mjs";
 import { getCurrencyRateHandler } from "./getCurrencyRate.mjs";
 import { getFileHandler } from "./getFile.mjs";
 import { getInterfaceContextHandler } from "./getInterfaceContext.mjs";
 import { getInterfaceStateHandler } from "./getInterfaceState.mjs";
 import { getSnapsHandler } from "./getSnaps.mjs";
+import { getStateHandler } from "./getState.mjs";
 import { invokeKeyringHandler } from "./invokeKeyring.mjs";
 import { invokeSnapSugarHandler } from "./invokeSnapSugar.mjs";
 import { requestSnapsHandler } from "./requestSnaps.mjs";
 import { resolveInterfaceHandler } from "./resolveInterface.mjs";
+import { scheduleBackgroundEventHandler } from "./scheduleBackgroundEvent.mjs";
+import { setStateHandler } from "./setState.mjs";
 import { updateInterfaceHandler } from "./updateInterface.mjs";
 /* eslint-disable @typescript-eslint/naming-convention */
 export const methodHandlers = {
@@ -19,8 +25,10 @@ export const methodHandlers = {
     wallet_requestSnaps: requestSnapsHandler,
     wallet_invokeSnap: invokeSnapSugarHandler,
     wallet_invokeKeyring: invokeKeyringHandler,
+    snap_clearState: clearStateHandler,
     snap_getClientStatus: getClientStatusHandler,
     snap_getFile: getFileHandler,
+    snap_getState: getStateHandler,
     snap_createInterface: createInterfaceHandler,
     snap_updateInterface: updateInterfaceHandler,
     snap_getInterfaceState: getInterfaceStateHandler,
@@ -28,6 +36,10 @@ export const methodHandlers = {
     snap_resolveInterface: resolveInterfaceHandler,
     snap_getCurrencyRate: getCurrencyRateHandler,
     snap_experimentalProviderRequest: providerRequestHandler,
+    snap_scheduleBackgroundEvent: scheduleBackgroundEventHandler,
+    snap_cancelBackgroundEvent: cancelBackgroundEventHandler,
+    snap_getBackgroundEvents: getBackgroundEventsHandler,
+    snap_setState: setStateHandler,
 };
 /* eslint-enable @typescript-eslint/naming-convention */
 export const handlers = Object.values(methodHandlers);

package/dist/permitted/handlers.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"handlers.mjs","sourceRoot":"","sources":["../../src/permitted/handlers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,8BAA0B;AAC3D,OAAO,EAAE,sBAAsB,EAAE,0CAAsC;AACvE,OAAO,EAAE,kBAAkB,EAAE,0BAAsB;AACnD,OAAO,EAAE,sBAAsB,EAAE,8BAA0B;AAC3D,OAAO,EAAE,sBAAsB,EAAE,8BAA0B;AAC3D,OAAO,EAAE,cAAc,EAAE,sBAAkB;AAC3C,OAAO,EAAE,0BAA0B,EAAE,kCAA8B;AACnE,OAAO,EAAE,wBAAwB,EAAE,gCAA4B;AAC/D,OAAO,EAAE,eAAe,EAAE,uBAAmB;AAC7C,OAAO,EAAE,oBAAoB,EAAE,4BAAwB;AACvD,OAAO,EAAE,sBAAsB,EAAE,8BAA0B;AAC3D,OAAO,EAAE,mBAAmB,EAAE,2BAAuB;AACrD,OAAO,EAAE,uBAAuB,EAAE,+BAA2B;AAC7D,OAAO,EAAE,sBAAsB,EAAE,8BAA0B;AAE3D,yDAAyD;AACzD,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,kBAAkB,EAAE,kBAAkB;IACtC,eAAe,EAAE,eAAe;IAChC,mBAAmB,EAAE,mBAAmB;IACxC,iBAAiB,EAAE,sBAAsB;IACzC,oBAAoB,EAAE,oBAAoB;IAC1C,oBAAoB,EAAE,sBAAsB;IAC5C,YAAY,EAAE,cAAc;IAC5B,oBAAoB,EAAE,sBAAsB;IAC5C,oBAAoB,EAAE,sBAAsB;IAC5C,sBAAsB,EAAE,wBAAwB;IAChD,wBAAwB,EAAE,0BAA0B;IACpD,qBAAqB,EAAE,uBAAuB;IAC9C,oBAAoB,EAAE,sBAAsB;IAC5C,gCAAgC,EAAE,sBAAsB;CACzD,CAAC;AACF,wDAAwD;AAExD,MAAM,CAAC,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC","sourcesContent":["import { createInterfaceHandler } from './createInterface';\nimport { providerRequestHandler } from './experimentalProviderRequest';\nimport { getAllSnapsHandler } from './getAllSnaps';\nimport { getClientStatusHandler } from './getClientStatus';\nimport { getCurrencyRateHandler } from './getCurrencyRate';\nimport { getFileHandler } from './getFile';\nimport { getInterfaceContextHandler } from './getInterfaceContext';\nimport { getInterfaceStateHandler } from './getInterfaceState';\nimport { getSnapsHandler } from './getSnaps';\nimport { invokeKeyringHandler } from './invokeKeyring';\nimport { invokeSnapSugarHandler } from './invokeSnapSugar';\nimport { requestSnapsHandler } from './requestSnaps';\nimport { resolveInterfaceHandler } from './resolveInterface';\nimport { updateInterfaceHandler } from './updateInterface';\n\n/* eslint-disable @typescript-eslint/naming-convention */\nexport const methodHandlers = {\n  wallet_getAllSnaps: getAllSnapsHandler,\n  wallet_getSnaps: getSnapsHandler,\n  wallet_requestSnaps: requestSnapsHandler,\n  wallet_invokeSnap: invokeSnapSugarHandler,\n  wallet_invokeKeyring: invokeKeyringHandler,\n  snap_getClientStatus: getClientStatusHandler,\n  snap_getFile: getFileHandler,\n  snap_createInterface: createInterfaceHandler,\n  snap_updateInterface: updateInterfaceHandler,\n  snap_getInterfaceState: getInterfaceStateHandler,\n  snap_getInterfaceContext: getInterfaceContextHandler,\n  snap_resolveInterface: resolveInterfaceHandler,\n  snap_getCurrencyRate: getCurrencyRateHandler,\n  snap_experimentalProviderRequest: providerRequestHandler,\n};\n/* eslint-enable @typescript-eslint/naming-convention */\n\nexport const handlers = Object.values(methodHandlers);\n"]}
+{"version":3,"file":"handlers.mjs","sourceRoot":"","sources":["../../src/permitted/handlers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,oCAAgC;AACvE,OAAO,EAAE,iBAAiB,EAAE,yBAAqB;AACjD,OAAO,EAAE,sBAAsB,EAAE,8BAA0B;AAC3D,OAAO,EAAE,sBAAsB,EAAE,0CAAsC;AACvE,OAAO,EAAE,kBAAkB,EAAE,0BAAsB;AACnD,OAAO,EAAE,0BAA0B,EAAE,kCAA8B;AACnE,OAAO,EAAE,sBAAsB,EAAE,8BAA0B;AAC3D,OAAO,EAAE,sBAAsB,EAAE,8BAA0B;AAC3D,OAAO,EAAE,cAAc,EAAE,sBAAkB;AAC3C,OAAO,EAAE,0BAA0B,EAAE,kCAA8B;AACnE,OAAO,EAAE,wBAAwB,EAAE,gCAA4B;AAC/D,OAAO,EAAE,eAAe,EAAE,uBAAmB;AAC7C,OAAO,EAAE,eAAe,EAAE,uBAAmB;AAC7C,OAAO,EAAE,oBAAoB,EAAE,4BAAwB;AACvD,OAAO,EAAE,sBAAsB,EAAE,8BAA0B;AAC3D,OAAO,EAAE,mBAAmB,EAAE,2BAAuB;AACrD,OAAO,EAAE,uBAAuB,EAAE,+BAA2B;AAC7D,OAAO,EAAE,8BAA8B,EAAE,sCAAkC;AAC3E,OAAO,EAAE,eAAe,EAAE,uBAAmB;AAC7C,OAAO,EAAE,sBAAsB,EAAE,8BAA0B;AAE3D,yDAAyD;AACzD,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,kBAAkB,EAAE,kBAAkB;IACtC,eAAe,EAAE,eAAe;IAChC,mBAAmB,EAAE,mBAAmB;IACxC,iBAAiB,EAAE,sBAAsB;IACzC,oBAAoB,EAAE,oBAAoB;IAC1C,eAAe,EAAE,iBAAiB;IAClC,oBAAoB,EAAE,sBAAsB;IAC5C,YAAY,EAAE,cAAc;IAC5B,aAAa,EAAE,eAAe;IAC9B,oBAAoB,EAAE,sBAAsB;IAC5C,oBAAoB,EAAE,sBAAsB;IAC5C,sBAAsB,EAAE,wBAAwB;IAChD,wBAAwB,EAAE,0BAA0B;IACpD,qBAAqB,EAAE,uBAAuB;IAC9C,oBAAoB,EAAE,sBAAsB;IAC5C,gCAAgC,EAAE,sBAAsB;IACxD,4BAA4B,EAAE,8BAA8B;IAC5D,0BAA0B,EAAE,4BAA4B;IACxD,wBAAwB,EAAE,0BAA0B;IACpD,aAAa,EAAE,eAAe;CAC/B,CAAC;AACF,wDAAwD;AAExD,MAAM,CAAC,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC","sourcesContent":["import { cancelBackgroundEventHandler } from './cancelBackgroundEvent';\nimport { clearStateHandler } from './clearState';\nimport { createInterfaceHandler } from './createInterface';\nimport { providerRequestHandler } from './experimentalProviderRequest';\nimport { getAllSnapsHandler } from './getAllSnaps';\nimport { getBackgroundEventsHandler } from './getBackgroundEvents';\nimport { getClientStatusHandler } from './getClientStatus';\nimport { getCurrencyRateHandler } from './getCurrencyRate';\nimport { getFileHandler } from './getFile';\nimport { getInterfaceContextHandler } from './getInterfaceContext';\nimport { getInterfaceStateHandler } from './getInterfaceState';\nimport { getSnapsHandler } from './getSnaps';\nimport { getStateHandler } from './getState';\nimport { invokeKeyringHandler } from './invokeKeyring';\nimport { invokeSnapSugarHandler } from './invokeSnapSugar';\nimport { requestSnapsHandler } from './requestSnaps';\nimport { resolveInterfaceHandler } from './resolveInterface';\nimport { scheduleBackgroundEventHandler } from './scheduleBackgroundEvent';\nimport { setStateHandler } from './setState';\nimport { updateInterfaceHandler } from './updateInterface';\n\n/* eslint-disable @typescript-eslint/naming-convention */\nexport const methodHandlers = {\n  wallet_getAllSnaps: getAllSnapsHandler,\n  wallet_getSnaps: getSnapsHandler,\n  wallet_requestSnaps: requestSnapsHandler,\n  wallet_invokeSnap: invokeSnapSugarHandler,\n  wallet_invokeKeyring: invokeKeyringHandler,\n  snap_clearState: clearStateHandler,\n  snap_getClientStatus: getClientStatusHandler,\n  snap_getFile: getFileHandler,\n  snap_getState: getStateHandler,\n  snap_createInterface: createInterfaceHandler,\n  snap_updateInterface: updateInterfaceHandler,\n  snap_getInterfaceState: getInterfaceStateHandler,\n  snap_getInterfaceContext: getInterfaceContextHandler,\n  snap_resolveInterface: resolveInterfaceHandler,\n  snap_getCurrencyRate: getCurrencyRateHandler,\n  snap_experimentalProviderRequest: providerRequestHandler,\n  snap_scheduleBackgroundEvent: scheduleBackgroundEventHandler,\n  snap_cancelBackgroundEvent: cancelBackgroundEventHandler,\n  snap_getBackgroundEvents: getBackgroundEventsHandler,\n  snap_setState: setStateHandler,\n};\n/* eslint-enable @typescript-eslint/naming-convention */\n\nexport const handlers = Object.values(methodHandlers);\n"]}

package/dist/permitted/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../src/permitted/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAsBA,iDAA2B;AAC3B,mDAA6B","sourcesContent":["import type { CreateInterfaceMethodHooks } from './createInterface';\nimport type { ProviderRequestMethodHooks } from './experimentalProviderRequest';\nimport type { GetAllSnapsHooks } from './getAllSnaps';\nimport type { GetClientStatusHooks } from './getClientStatus';\nimport type { GetCurrencyRateMethodHooks } from './getCurrencyRate';\nimport type { GetInterfaceStateMethodHooks } from './getInterfaceState';\nimport type { GetSnapsHooks } from './getSnaps';\nimport type { RequestSnapsHooks } from './requestSnaps';\nimport type { ResolveInterfaceMethodHooks } from './resolveInterface';\nimport type { UpdateInterfaceMethodHooks } from './updateInterface';\n\nexport type PermittedRpcMethodHooks = GetAllSnapsHooks &\n  GetClientStatusHooks &\n  GetSnapsHooks &\n  RequestSnapsHooks &\n  CreateInterfaceMethodHooks &\n  UpdateInterfaceMethodHooks &\n  GetInterfaceStateMethodHooks &\n  ResolveInterfaceMethodHooks &\n  GetCurrencyRateMethodHooks &\n  ProviderRequestMethodHooks;\n\nexport * from './handlers';\nexport * from './middleware';\n"]}
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../src/permitted/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAkCA,iDAA2B;AAC3B,mDAA6B","sourcesContent":["import type { CancelBackgroundEventMethodHooks } from './cancelBackgroundEvent';\nimport type { ClearStateHooks } from './clearState';\nimport type { CreateInterfaceMethodHooks } from './createInterface';\nimport type { ProviderRequestMethodHooks } from './experimentalProviderRequest';\nimport type { GetAllSnapsHooks } from './getAllSnaps';\nimport type { GetBackgroundEventsMethodHooks } from './getBackgroundEvents';\nimport type { GetClientStatusHooks } from './getClientStatus';\nimport type { GetCurrencyRateMethodHooks } from './getCurrencyRate';\nimport type { GetInterfaceStateMethodHooks } from './getInterfaceState';\nimport type { GetSnapsHooks } from './getSnaps';\nimport type { GetStateHooks } from './getState';\nimport type { RequestSnapsHooks } from './requestSnaps';\nimport type { ResolveInterfaceMethodHooks } from './resolveInterface';\nimport type { ScheduleBackgroundEventMethodHooks } from './scheduleBackgroundEvent';\nimport type { SetStateHooks } from './setState';\nimport type { UpdateInterfaceMethodHooks } from './updateInterface';\n\nexport type PermittedRpcMethodHooks = ClearStateHooks &\n  GetAllSnapsHooks &\n  GetClientStatusHooks &\n  GetSnapsHooks &\n  GetStateHooks &\n  RequestSnapsHooks &\n  CreateInterfaceMethodHooks &\n  UpdateInterfaceMethodHooks &\n  GetInterfaceStateMethodHooks &\n  ResolveInterfaceMethodHooks &\n  GetCurrencyRateMethodHooks &\n  ProviderRequestMethodHooks &\n  ScheduleBackgroundEventMethodHooks &\n  CancelBackgroundEventMethodHooks &\n  GetBackgroundEventsMethodHooks &\n  SetStateHooks;\n\nexport * from './handlers';\nexport * from './middleware';\n"]}

package/dist/permitted/index.d.cts

@@ -1,14 +1,20 @@
+import type { CancelBackgroundEventMethodHooks } from "./cancelBackgroundEvent.cjs";
+import type { ClearStateHooks } from "./clearState.cjs";
 import type { CreateInterfaceMethodHooks } from "./createInterface.cjs";
 import type { ProviderRequestMethodHooks } from "./experimentalProviderRequest.cjs";
 import type { GetAllSnapsHooks } from "./getAllSnaps.cjs";
+import type { GetBackgroundEventsMethodHooks } from "./getBackgroundEvents.cjs";
 import type { GetClientStatusHooks } from "./getClientStatus.cjs";
 import type { GetCurrencyRateMethodHooks } from "./getCurrencyRate.cjs";
 import type { GetInterfaceStateMethodHooks } from "./getInterfaceState.cjs";
 import type { GetSnapsHooks } from "./getSnaps.cjs";
+import type { GetStateHooks } from "./getState.cjs";
 import type { RequestSnapsHooks } from "./requestSnaps.cjs";
 import type { ResolveInterfaceMethodHooks } from "./resolveInterface.cjs";
+import type { ScheduleBackgroundEventMethodHooks } from "./scheduleBackgroundEvent.cjs";
+import type { SetStateHooks } from "./setState.cjs";
 import type { UpdateInterfaceMethodHooks } from "./updateInterface.cjs";
-export type PermittedRpcMethodHooks = GetAllSnapsHooks & GetClientStatusHooks & GetSnapsHooks & RequestSnapsHooks & CreateInterfaceMethodHooks & UpdateInterfaceMethodHooks & GetInterfaceStateMethodHooks & ResolveInterfaceMethodHooks & GetCurrencyRateMethodHooks & ProviderRequestMethodHooks;
+export type PermittedRpcMethodHooks = ClearStateHooks & GetAllSnapsHooks & GetClientStatusHooks & GetSnapsHooks & GetStateHooks & RequestSnapsHooks & CreateInterfaceMethodHooks & UpdateInterfaceMethodHooks & GetInterfaceStateMethodHooks & ResolveInterfaceMethodHooks & GetCurrencyRateMethodHooks & ProviderRequestMethodHooks & ScheduleBackgroundEventMethodHooks & CancelBackgroundEventMethodHooks & GetBackgroundEventsMethodHooks & SetStateHooks;
 export * from "./handlers.cjs";
 export * from "./middleware.cjs";
 //# sourceMappingURL=index.d.cts.map

package/dist/permitted/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../src/permitted/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0BAA0B,EAAE,8BAA0B;AACpE,OAAO,KAAK,EAAE,0BAA0B,EAAE,0CAAsC;AAChF,OAAO,KAAK,EAAE,gBAAgB,EAAE,0BAAsB;AACtD,OAAO,KAAK,EAAE,oBAAoB,EAAE,8BAA0B;AAC9D,OAAO,KAAK,EAAE,0BAA0B,EAAE,8BAA0B;AACpE,OAAO,KAAK,EAAE,4BAA4B,EAAE,gCAA4B;AACxE,OAAO,KAAK,EAAE,aAAa,EAAE,uBAAmB;AAChD,OAAO,KAAK,EAAE,iBAAiB,EAAE,2BAAuB;AACxD,OAAO,KAAK,EAAE,2BAA2B,EAAE,+BAA2B;AACtE,OAAO,KAAK,EAAE,0BAA0B,EAAE,8BAA0B;AAEpE,MAAM,MAAM,uBAAuB,GAAG,gBAAgB,GACpD,oBAAoB,GACpB,aAAa,GACb,iBAAiB,GACjB,0BAA0B,GAC1B,0BAA0B,GAC1B,4BAA4B,GAC5B,2BAA2B,GAC3B,0BAA0B,GAC1B,0BAA0B,CAAC;AAE7B,+BAA2B;AAC3B,iCAA6B"}
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../src/permitted/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gCAAgC,EAAE,oCAAgC;AAChF,OAAO,KAAK,EAAE,eAAe,EAAE,yBAAqB;AACpD,OAAO,KAAK,EAAE,0BAA0B,EAAE,8BAA0B;AACpE,OAAO,KAAK,EAAE,0BAA0B,EAAE,0CAAsC;AAChF,OAAO,KAAK,EAAE,gBAAgB,EAAE,0BAAsB;AACtD,OAAO,KAAK,EAAE,8BAA8B,EAAE,kCAA8B;AAC5E,OAAO,KAAK,EAAE,oBAAoB,EAAE,8BAA0B;AAC9D,OAAO,KAAK,EAAE,0BAA0B,EAAE,8BAA0B;AACpE,OAAO,KAAK,EAAE,4BAA4B,EAAE,gCAA4B;AACxE,OAAO,KAAK,EAAE,aAAa,EAAE,uBAAmB;AAChD,OAAO,KAAK,EAAE,aAAa,EAAE,uBAAmB;AAChD,OAAO,KAAK,EAAE,iBAAiB,EAAE,2BAAuB;AACxD,OAAO,KAAK,EAAE,2BAA2B,EAAE,+BAA2B;AACtE,OAAO,KAAK,EAAE,kCAAkC,EAAE,sCAAkC;AACpF,OAAO,KAAK,EAAE,aAAa,EAAE,uBAAmB;AAChD,OAAO,KAAK,EAAE,0BAA0B,EAAE,8BAA0B;AAEpE,MAAM,MAAM,uBAAuB,GAAG,eAAe,GACnD,gBAAgB,GAChB,oBAAoB,GACpB,aAAa,GACb,aAAa,GACb,iBAAiB,GACjB,0BAA0B,GAC1B,0BAA0B,GAC1B,4BAA4B,GAC5B,2BAA2B,GAC3B,0BAA0B,GAC1B,0BAA0B,GAC1B,kCAAkC,GAClC,gCAAgC,GAChC,8BAA8B,GAC9B,aAAa,CAAC;AAEhB,+BAA2B;AAC3B,iCAA6B"}

package/dist/permitted/index.d.mts

@@ -1,14 +1,20 @@
+import type { CancelBackgroundEventMethodHooks } from "./cancelBackgroundEvent.mjs";
+import type { ClearStateHooks } from "./clearState.mjs";
 import type { CreateInterfaceMethodHooks } from "./createInterface.mjs";
 import type { ProviderRequestMethodHooks } from "./experimentalProviderRequest.mjs";
 import type { GetAllSnapsHooks } from "./getAllSnaps.mjs";
+import type { GetBackgroundEventsMethodHooks } from "./getBackgroundEvents.mjs";
 import type { GetClientStatusHooks } from "./getClientStatus.mjs";
 import type { GetCurrencyRateMethodHooks } from "./getCurrencyRate.mjs";
 import type { GetInterfaceStateMethodHooks } from "./getInterfaceState.mjs";
 import type { GetSnapsHooks } from "./getSnaps.mjs";
+import type { GetStateHooks } from "./getState.mjs";
 import type { RequestSnapsHooks } from "./requestSnaps.mjs";
 import type { ResolveInterfaceMethodHooks } from "./resolveInterface.mjs";
+import type { ScheduleBackgroundEventMethodHooks } from "./scheduleBackgroundEvent.mjs";
+import type { SetStateHooks } from "./setState.mjs";
 import type { UpdateInterfaceMethodHooks } from "./updateInterface.mjs";
-export type PermittedRpcMethodHooks = GetAllSnapsHooks & GetClientStatusHooks & GetSnapsHooks & RequestSnapsHooks & CreateInterfaceMethodHooks & UpdateInterfaceMethodHooks & GetInterfaceStateMethodHooks & ResolveInterfaceMethodHooks & GetCurrencyRateMethodHooks & ProviderRequestMethodHooks;
+export type PermittedRpcMethodHooks = ClearStateHooks & GetAllSnapsHooks & GetClientStatusHooks & GetSnapsHooks & GetStateHooks & RequestSnapsHooks & CreateInterfaceMethodHooks & UpdateInterfaceMethodHooks & GetInterfaceStateMethodHooks & ResolveInterfaceMethodHooks & GetCurrencyRateMethodHooks & ProviderRequestMethodHooks & ScheduleBackgroundEventMethodHooks & CancelBackgroundEventMethodHooks & GetBackgroundEventsMethodHooks & SetStateHooks;
 export * from "./handlers.mjs";
 export * from "./middleware.mjs";
 //# sourceMappingURL=index.d.mts.map

package/dist/permitted/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/permitted/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0BAA0B,EAAE,8BAA0B;AACpE,OAAO,KAAK,EAAE,0BAA0B,EAAE,0CAAsC;AAChF,OAAO,KAAK,EAAE,gBAAgB,EAAE,0BAAsB;AACtD,OAAO,KAAK,EAAE,oBAAoB,EAAE,8BAA0B;AAC9D,OAAO,KAAK,EAAE,0BAA0B,EAAE,8BAA0B;AACpE,OAAO,KAAK,EAAE,4BAA4B,EAAE,gCAA4B;AACxE,OAAO,KAAK,EAAE,aAAa,EAAE,uBAAmB;AAChD,OAAO,KAAK,EAAE,iBAAiB,EAAE,2BAAuB;AACxD,OAAO,KAAK,EAAE,2BAA2B,EAAE,+BAA2B;AACtE,OAAO,KAAK,EAAE,0BAA0B,EAAE,8BAA0B;AAEpE,MAAM,MAAM,uBAAuB,GAAG,gBAAgB,GACpD,oBAAoB,GACpB,aAAa,GACb,iBAAiB,GACjB,0BAA0B,GAC1B,0BAA0B,GAC1B,4BAA4B,GAC5B,2BAA2B,GAC3B,0BAA0B,GAC1B,0BAA0B,CAAC;AAE7B,+BAA2B;AAC3B,iCAA6B"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/permitted/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gCAAgC,EAAE,oCAAgC;AAChF,OAAO,KAAK,EAAE,eAAe,EAAE,yBAAqB;AACpD,OAAO,KAAK,EAAE,0BAA0B,EAAE,8BAA0B;AACpE,OAAO,KAAK,EAAE,0BAA0B,EAAE,0CAAsC;AAChF,OAAO,KAAK,EAAE,gBAAgB,EAAE,0BAAsB;AACtD,OAAO,KAAK,EAAE,8BAA8B,EAAE,kCAA8B;AAC5E,OAAO,KAAK,EAAE,oBAAoB,EAAE,8BAA0B;AAC9D,OAAO,KAAK,EAAE,0BAA0B,EAAE,8BAA0B;AACpE,OAAO,KAAK,EAAE,4BAA4B,EAAE,gCAA4B;AACxE,OAAO,KAAK,EAAE,aAAa,EAAE,uBAAmB;AAChD,OAAO,KAAK,EAAE,aAAa,EAAE,uBAAmB;AAChD,OAAO,KAAK,EAAE,iBAAiB,EAAE,2BAAuB;AACxD,OAAO,KAAK,EAAE,2BAA2B,EAAE,+BAA2B;AACtE,OAAO,KAAK,EAAE,kCAAkC,EAAE,sCAAkC;AACpF,OAAO,KAAK,EAAE,aAAa,EAAE,uBAAmB;AAChD,OAAO,KAAK,EAAE,0BAA0B,EAAE,8BAA0B;AAEpE,MAAM,MAAM,uBAAuB,GAAG,eAAe,GACnD,gBAAgB,GAChB,oBAAoB,GACpB,aAAa,GACb,aAAa,GACb,iBAAiB,GACjB,0BAA0B,GAC1B,0BAA0B,GAC1B,4BAA4B,GAC5B,2BAA2B,GAC3B,0BAA0B,GAC1B,0BAA0B,GAC1B,kCAAkC,GAClC,gCAAgC,GAChC,8BAA8B,GAC9B,aAAa,CAAC;AAEhB,+BAA2B;AAC3B,iCAA6B"}

package/dist/permitted/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/permitted/index.ts"],"names":[],"mappings":"AAsBA,+BAA2B;AAC3B,iCAA6B","sourcesContent":["import type { CreateInterfaceMethodHooks } from './createInterface';\nimport type { ProviderRequestMethodHooks } from './experimentalProviderRequest';\nimport type { GetAllSnapsHooks } from './getAllSnaps';\nimport type { GetClientStatusHooks } from './getClientStatus';\nimport type { GetCurrencyRateMethodHooks } from './getCurrencyRate';\nimport type { GetInterfaceStateMethodHooks } from './getInterfaceState';\nimport type { GetSnapsHooks } from './getSnaps';\nimport type { RequestSnapsHooks } from './requestSnaps';\nimport type { ResolveInterfaceMethodHooks } from './resolveInterface';\nimport type { UpdateInterfaceMethodHooks } from './updateInterface';\n\nexport type PermittedRpcMethodHooks = GetAllSnapsHooks &\n  GetClientStatusHooks &\n  GetSnapsHooks &\n  RequestSnapsHooks &\n  CreateInterfaceMethodHooks &\n  UpdateInterfaceMethodHooks &\n  GetInterfaceStateMethodHooks &\n  ResolveInterfaceMethodHooks &\n  GetCurrencyRateMethodHooks &\n  ProviderRequestMethodHooks;\n\nexport * from './handlers';\nexport * from './middleware';\n"]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/permitted/index.ts"],"names":[],"mappings":"AAkCA,+BAA2B;AAC3B,iCAA6B","sourcesContent":["import type { CancelBackgroundEventMethodHooks } from './cancelBackgroundEvent';\nimport type { ClearStateHooks } from './clearState';\nimport type { CreateInterfaceMethodHooks } from './createInterface';\nimport type { ProviderRequestMethodHooks } from './experimentalProviderRequest';\nimport type { GetAllSnapsHooks } from './getAllSnaps';\nimport type { GetBackgroundEventsMethodHooks } from './getBackgroundEvents';\nimport type { GetClientStatusHooks } from './getClientStatus';\nimport type { GetCurrencyRateMethodHooks } from './getCurrencyRate';\nimport type { GetInterfaceStateMethodHooks } from './getInterfaceState';\nimport type { GetSnapsHooks } from './getSnaps';\nimport type { GetStateHooks } from './getState';\nimport type { RequestSnapsHooks } from './requestSnaps';\nimport type { ResolveInterfaceMethodHooks } from './resolveInterface';\nimport type { ScheduleBackgroundEventMethodHooks } from './scheduleBackgroundEvent';\nimport type { SetStateHooks } from './setState';\nimport type { UpdateInterfaceMethodHooks } from './updateInterface';\n\nexport type PermittedRpcMethodHooks = ClearStateHooks &\n  GetAllSnapsHooks &\n  GetClientStatusHooks &\n  GetSnapsHooks &\n  GetStateHooks &\n  RequestSnapsHooks &\n  CreateInterfaceMethodHooks &\n  UpdateInterfaceMethodHooks &\n  GetInterfaceStateMethodHooks &\n  ResolveInterfaceMethodHooks &\n  GetCurrencyRateMethodHooks &\n  ProviderRequestMethodHooks &\n  ScheduleBackgroundEventMethodHooks &\n  CancelBackgroundEventMethodHooks &\n  GetBackgroundEventsMethodHooks &\n  SetStateHooks;\n\nexport * from './handlers';\nexport * from './middleware';\n"]}

package/dist/permitted/scheduleBackgroundEvent.cjs

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.scheduleBackgroundEventHandler = void 0;
+const rpc_errors_1 = require("@metamask/rpc-errors");
+const snaps_sdk_1 = require("@metamask/snaps-sdk");
+const snaps_utils_1 = require("@metamask/snaps-utils");
+const superstruct_1 = require("@metamask/superstruct");
+const utils_1 = require("@metamask/utils");
+const luxon_1 = require("luxon");
+const endowments_1 = require("../endowments/index.cjs");
+const methodName = 'snap_scheduleBackgroundEvent';
+const hookNames = {
+    scheduleBackgroundEvent: true,
+    hasPermission: true,
+};
+exports.scheduleBackgroundEventHandler = {
+    methodNames: [methodName],
+    implementation: getScheduleBackgroundEventImplementation,
+    hookNames,
+};
+const offsetRegex = /Z|([+-]\d{2}:?\d{2})$/u;
+const ScheduleBackgroundEventParametersWithDateStruct = (0, superstruct_1.object)({
+    date: (0, superstruct_1.refine)((0, superstruct_1.string)(), 'date', (val) => {
+        const date = luxon_1.DateTime.fromISO(val);
+        if (date.isValid) {
+            // Luxon doesn't have a reliable way to check if timezone info was not provided
+            if (!offsetRegex.test(val)) {
+                return 'ISO 8601 date must have timezone information';
+            }
+            return true;
+        }
+        return 'Not a valid ISO 8601 date';
+    }),
+    request: snaps_utils_1.CronjobRpcRequestStruct,
+});
+const ScheduleBackgroundEventParametersWithDurationStruct = (0, superstruct_1.object)({
+    duration: (0, superstruct_1.refine)((0, superstruct_1.string)(), 'duration', (val) => {
+        const duration = luxon_1.Duration.fromISO(val);
+        if (!duration.isValid) {
+            return 'Not a valid ISO 8601 duration';
+        }
+        return true;
+    }),
+    request: snaps_utils_1.CronjobRpcRequestStruct,
+});
+const ScheduleBackgroundEventParametersStruct = (0, snaps_sdk_1.selectiveUnion)((val) => {
+    if ((0, utils_1.hasProperty)(val, 'date')) {
+        return ScheduleBackgroundEventParametersWithDateStruct;
+    }
+    return ScheduleBackgroundEventParametersWithDurationStruct;
+});
+/**
+ * Generates a `DateTime` object based on if a duration or date is provided.
+ *
+ * @param params - The validated params from the `snap_scheduleBackgroundEvent` call.
+ * @returns A `DateTime` object.
+ */
+function getStartDate(params) {
+    if ('duration' in params) {
+        return luxon_1.DateTime.fromJSDate(new Date())
+            .toUTC()
+            .plus(luxon_1.Duration.fromISO(params.duration));
+    }
+    return luxon_1.DateTime.fromISO(params.date, { setZone: true });
+}
+/**
+ * The `snap_scheduleBackgroundEvent` method implementation.
+ *
+ * @param req - The JSON-RPC request object.
+ * @param res - The JSON-RPC response object.
+ * @param _next - The `json-rpc-engine` "next" callback. Not used by this
+ * function.
+ * @param end - The `json-rpc-engine` "end" callback.
+ * @param hooks - The RPC method hooks.
+ * @param hooks.scheduleBackgroundEvent - The function to schedule a background event.
+ * @param hooks.hasPermission - The function to check if a snap has the `endowment:cronjob` permission.
+ * @returns An id representing the background event.
+ */
+async function getScheduleBackgroundEventImplementation(req, res, _next, end, { scheduleBackgroundEvent, hasPermission, }) {
+    const { params } = req;
+    if (!hasPermission(endowments_1.SnapEndowments.Cronjob)) {
+        return end(rpc_errors_1.providerErrors.unauthorized());
+    }
+    try {
+        const validatedParams = getValidatedParams(params);
+        const { request } = validatedParams;
+        const date = getStartDate(validatedParams);
+        // Make sure any millisecond precision is removed.
+        const truncatedDate = date.startOf('second').toISO({
+            suppressMilliseconds: true,
+        });
+        (0, utils_1.assert)(truncatedDate);
+        const id = scheduleBackgroundEvent({ date: truncatedDate, request });
+        res.result = id;
+    }
+    catch (error) {
+        return end(error);
+    }
+    return end();
+}
+/**
+ * Validate the scheduleBackgroundEvent method `params` and returns them cast to the correct
+ * type. Throws if validation fails.
+ *
+ * @param params - The unvalidated params object from the method request.
+ * @returns The validated resolveInterface method parameter object.
+ */
+function getValidatedParams(params) {
+    try {
+        return (0, superstruct_1.create)(params, ScheduleBackgroundEventParametersStruct);
+    }
+    catch (error) {
+        if (error instanceof superstruct_1.StructError) {
+            throw rpc_errors_1.rpcErrors.invalidParams({
+                message: `Invalid params: ${error.message}.`,
+            });
+        }
+        /* istanbul ignore next */
+        throw rpc_errors_1.rpcErrors.internal();
+    }
+}
+//# sourceMappingURL=scheduleBackgroundEvent.cjs.map

package/dist/permitted/scheduleBackgroundEvent.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduleBackgroundEvent.cjs","sourceRoot":"","sources":["../../src/permitted/scheduleBackgroundEvent.ts"],"names":[],"mappings":";;;AAEA,qDAAiE;AACjE,mDAK6B;AAE7B,uDAG+B;AAC/B,uDAM+B;AAC/B,2CAIyB;AACzB,iCAA2C;AAE3C,wDAA+C;AAG/C,MAAM,UAAU,GAAG,8BAA8B,CAAC;AAElD,MAAM,SAAS,GAA0D;IACvE,uBAAuB,EAAE,IAAI;IAC7B,aAAa,EAAE,IAAI;CACpB,CAAC;AAeW,QAAA,8BAA8B,GAIvC;IACF,WAAW,EAAE,CAAC,UAAU,CAAC;IACzB,cAAc,EAAE,wCAAwC;IACxD,SAAS;CACV,CAAC;AAEF,MAAM,WAAW,GAAG,wBAAwB,CAAC;AAE7C,MAAM,+CAA+C,GAAG,IAAA,oBAAM,EAAC;IAC7D,IAAI,EAAE,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE;QACrC,MAAM,IAAI,GAAG,gBAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACnC,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,+EAA+E;YAC/E,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC3B,OAAO,8CAA8C,CAAC;YACxD,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,2BAA2B,CAAC;IACrC,CAAC,CAAC;IACF,OAAO,EAAE,qCAAuB;CACjC,CAAC,CAAC;AAEH,MAAM,mDAAmD,GAAG,IAAA,oBAAM,EAAC;IACjE,QAAQ,EAAE,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE;QAC7C,MAAM,QAAQ,GAAG,gBAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACvC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACtB,OAAO,+BAA+B,CAAC;QACzC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IACF,OAAO,EAAE,qCAAuB;CACjC,CAAC,CAAC;AAEH,MAAM,uCAAuC,GAAG,IAAA,0BAAc,EAAC,CAAC,GAAG,EAAE,EAAE;IACrE,IAAI,IAAA,mBAAW,EAAC,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC;QAC7B,OAAO,+CAA+C,CAAC;IACzD,CAAC;IACD,OAAO,mDAAmD,CAAC;AAC7D,CAAC,CAAC,CAAC;AAOH;;;;;GAKG;AACH,SAAS,YAAY,CAAC,MAAqC;IACzD,IAAI,UAAU,IAAI,MAAM,EAAE,CAAC;QACzB,OAAO,gBAAQ,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE,CAAC;aACnC,KAAK,EAAE;aACP,IAAI,CAAC,gBAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED,OAAO,gBAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;AAC1D,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,KAAK,UAAU,wCAAwC,CACrD,GAAsD,EACtD,GAA0D,EAC1D,KAAc,EACd,GAA6B,EAC7B,EACE,uBAAuB,EACvB,aAAa,GACsB;IAErC,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC,aAAa,CAAC,2BAAc,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3C,OAAO,GAAG,CAAC,2BAAc,CAAC,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAEnD,MAAM,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC;QAEpC,MAAM,IAAI,GAAG,YAAY,CAAC,eAAe,CAAC,CAAC;QAE3C,kDAAkD;QAClD,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC;YACjD,oBAAoB,EAAE,IAAI;SAC3B,CAAC,CAAC;QAEH,IAAA,cAAM,EAAC,aAAa,CAAC,CAAC;QAEtB,MAAM,EAAE,GAAG,uBAAuB,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,CAAC,CAAC;QACrE,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC;IAClB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CACzB,MAAe;IAEf,IAAI,CAAC;QACH,OAAO,IAAA,oBAAM,EAAC,MAAM,EAAE,uCAAuC,CAAC,CAAC;IACjE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,yBAAW,EAAE,CAAC;YACjC,MAAM,sBAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QACD,0BAA0B;QAC1B,MAAM,sBAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport { providerErrors, rpcErrors } from '@metamask/rpc-errors';\nimport {\n  selectiveUnion,\n  type JsonRpcRequest,\n  type ScheduleBackgroundEventParams,\n  type ScheduleBackgroundEventResult,\n} from '@metamask/snaps-sdk';\nimport type { CronjobRpcRequest } from '@metamask/snaps-utils';\nimport {\n  CronjobRpcRequestStruct,\n  type InferMatching,\n} from '@metamask/snaps-utils';\nimport {\n  StructError,\n  create,\n  object,\n  refine,\n  string,\n} from '@metamask/superstruct';\nimport {\n  assert,\n  hasProperty,\n  type PendingJsonRpcResponse,\n} from '@metamask/utils';\nimport { DateTime, Duration } from 'luxon';\n\nimport { SnapEndowments } from '../endowments';\nimport type { MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_scheduleBackgroundEvent';\n\nconst hookNames: MethodHooksObject<ScheduleBackgroundEventMethodHooks> = {\n  scheduleBackgroundEvent: true,\n  hasPermission: true,\n};\n\ntype ScheduleBackgroundEventHookParams = {\n  date: string;\n  request: CronjobRpcRequest;\n};\n\nexport type ScheduleBackgroundEventMethodHooks = {\n  scheduleBackgroundEvent: (\n    snapEvent: ScheduleBackgroundEventHookParams,\n  ) => string;\n\n  hasPermission: (permissionName: string) => boolean;\n};\n\nexport const scheduleBackgroundEventHandler: PermittedHandlerExport<\n  ScheduleBackgroundEventMethodHooks,\n  ScheduleBackgroundEventParameters,\n  ScheduleBackgroundEventResult\n> = {\n  methodNames: [methodName],\n  implementation: getScheduleBackgroundEventImplementation,\n  hookNames,\n};\n\nconst offsetRegex = /Z|([+-]\\d{2}:?\\d{2})$/u;\n\nconst ScheduleBackgroundEventParametersWithDateStruct = object({\n  date: refine(string(), 'date', (val) => {\n    const date = DateTime.fromISO(val);\n    if (date.isValid) {\n      // Luxon doesn't have a reliable way to check if timezone info was not provided\n      if (!offsetRegex.test(val)) {\n        return 'ISO 8601 date must have timezone information';\n      }\n      return true;\n    }\n    return 'Not a valid ISO 8601 date';\n  }),\n  request: CronjobRpcRequestStruct,\n});\n\nconst ScheduleBackgroundEventParametersWithDurationStruct = object({\n  duration: refine(string(), 'duration', (val) => {\n    const duration = Duration.fromISO(val);\n    if (!duration.isValid) {\n      return 'Not a valid ISO 8601 duration';\n    }\n    return true;\n  }),\n  request: CronjobRpcRequestStruct,\n});\n\nconst ScheduleBackgroundEventParametersStruct = selectiveUnion((val) => {\n  if (hasProperty(val, 'date')) {\n    return ScheduleBackgroundEventParametersWithDateStruct;\n  }\n  return ScheduleBackgroundEventParametersWithDurationStruct;\n});\n\nexport type ScheduleBackgroundEventParameters = InferMatching<\n  typeof ScheduleBackgroundEventParametersStruct,\n  ScheduleBackgroundEventParams\n>;\n\n/**\n * Generates a `DateTime` object based on if a duration or date is provided.\n *\n * @param params - The validated params from the `snap_scheduleBackgroundEvent` call.\n * @returns A `DateTime` object.\n */\nfunction getStartDate(params: ScheduleBackgroundEventParams) {\n  if ('duration' in params) {\n    return DateTime.fromJSDate(new Date())\n      .toUTC()\n      .plus(Duration.fromISO(params.duration));\n  }\n\n  return DateTime.fromISO(params.date, { setZone: true });\n}\n\n/**\n * The `snap_scheduleBackgroundEvent` method implementation.\n *\n * @param req - The JSON-RPC request object.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.scheduleBackgroundEvent - The function to schedule a background event.\n * @param hooks.hasPermission - The function to check if a snap has the `endowment:cronjob` permission.\n * @returns An id representing the background event.\n */\nasync function getScheduleBackgroundEventImplementation(\n  req: JsonRpcRequest<ScheduleBackgroundEventParameters>,\n  res: PendingJsonRpcResponse<ScheduleBackgroundEventResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  {\n    scheduleBackgroundEvent,\n    hasPermission,\n  }: ScheduleBackgroundEventMethodHooks,\n): Promise<void> {\n  const { params } = req;\n\n  if (!hasPermission(SnapEndowments.Cronjob)) {\n    return end(providerErrors.unauthorized());\n  }\n\n  try {\n    const validatedParams = getValidatedParams(params);\n\n    const { request } = validatedParams;\n\n    const date = getStartDate(validatedParams);\n\n    // Make sure any millisecond precision is removed.\n    const truncatedDate = date.startOf('second').toISO({\n      suppressMilliseconds: true,\n    });\n\n    assert(truncatedDate);\n\n    const id = scheduleBackgroundEvent({ date: truncatedDate, request });\n    res.result = id;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the scheduleBackgroundEvent method `params` and returns them cast to the correct\n * type. Throws if validation fails.\n *\n * @param params - The unvalidated params object from the method request.\n * @returns The validated resolveInterface method parameter object.\n */\nfunction getValidatedParams(\n  params: unknown,\n): ScheduleBackgroundEventParameters {\n  try {\n    return create(params, ScheduleBackgroundEventParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n"]}

package/dist/permitted/scheduleBackgroundEvent.d.cts

@@ -0,0 +1,33 @@
+import type { PermittedHandlerExport } from "@metamask/permission-controller";
+import { type ScheduleBackgroundEventParams, type ScheduleBackgroundEventResult } from "@metamask/snaps-sdk";
+import type { CronjobRpcRequest } from "@metamask/snaps-utils";
+import { type InferMatching } from "@metamask/snaps-utils";
+type ScheduleBackgroundEventHookParams = {
+    date: string;
+    request: CronjobRpcRequest;
+};
+export type ScheduleBackgroundEventMethodHooks = {
+    scheduleBackgroundEvent: (snapEvent: ScheduleBackgroundEventHookParams) => string;
+    hasPermission: (permissionName: string) => boolean;
+};
+export declare const scheduleBackgroundEventHandler: PermittedHandlerExport<ScheduleBackgroundEventMethodHooks, ScheduleBackgroundEventParameters, ScheduleBackgroundEventResult>;
+declare const ScheduleBackgroundEventParametersStruct: import("@metamask/superstruct").Struct<{
+    date: string;
+    request: {
+        method: string;
+        id?: string | number | null | undefined;
+        jsonrpc?: "2.0" | undefined;
+        params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
+    };
+} | {
+    request: {
+        method: string;
+        id?: string | number | null | undefined;
+        jsonrpc?: "2.0" | undefined;
+        params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
+    };
+    duration: string;
+}, null>;
+export type ScheduleBackgroundEventParameters = InferMatching<typeof ScheduleBackgroundEventParametersStruct, ScheduleBackgroundEventParams>;
+export {};
+//# sourceMappingURL=scheduleBackgroundEvent.d.cts.map

package/dist/permitted/scheduleBackgroundEvent.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduleBackgroundEvent.d.cts","sourceRoot":"","sources":["../../src/permitted/scheduleBackgroundEvent.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,EAGL,KAAK,6BAA6B,EAClC,KAAK,6BAA6B,EACnC,4BAA4B;AAC7B,OAAO,KAAK,EAAE,iBAAiB,EAAE,8BAA8B;AAC/D,OAAO,EAEL,KAAK,aAAa,EACnB,8BAA8B;AAyB/B,KAAK,iCAAiC,GAAG;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,iBAAiB,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C,uBAAuB,EAAE,CACvB,SAAS,EAAE,iCAAiC,KACzC,MAAM,CAAC;IAEZ,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;CACpD,CAAC;AAEF,eAAO,MAAM,8BAA8B,EAAE,sBAAsB,CACjE,kCAAkC,EAClC,iCAAiC,EACjC,6BAA6B,CAK9B,CAAC;AA8BF,QAAA,MAAM,uCAAuC;;;;;;;;;;;;;;;;QAK3C,CAAC;AAEH,MAAM,MAAM,iCAAiC,GAAG,aAAa,CAC3D,OAAO,uCAAuC,EAC9C,6BAA6B,CAC9B,CAAC"}

package/dist/permitted/scheduleBackgroundEvent.d.mts

@@ -0,0 +1,33 @@
+import type { PermittedHandlerExport } from "@metamask/permission-controller";
+import { type ScheduleBackgroundEventParams, type ScheduleBackgroundEventResult } from "@metamask/snaps-sdk";
+import type { CronjobRpcRequest } from "@metamask/snaps-utils";
+import { type InferMatching } from "@metamask/snaps-utils";
+type ScheduleBackgroundEventHookParams = {
+    date: string;
+    request: CronjobRpcRequest;
+};
+export type ScheduleBackgroundEventMethodHooks = {
+    scheduleBackgroundEvent: (snapEvent: ScheduleBackgroundEventHookParams) => string;
+    hasPermission: (permissionName: string) => boolean;
+};
+export declare const scheduleBackgroundEventHandler: PermittedHandlerExport<ScheduleBackgroundEventMethodHooks, ScheduleBackgroundEventParameters, ScheduleBackgroundEventResult>;
+declare const ScheduleBackgroundEventParametersStruct: import("@metamask/superstruct").Struct<{
+    date: string;
+    request: {
+        method: string;
+        id?: string | number | null | undefined;
+        jsonrpc?: "2.0" | undefined;
+        params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
+    };
+} | {
+    request: {
+        method: string;
+        id?: string | number | null | undefined;
+        jsonrpc?: "2.0" | undefined;
+        params?: Record<string, import("@metamask/snaps-sdk").Json> | import("@metamask/snaps-sdk").Json[] | undefined;
+    };
+    duration: string;
+}, null>;
+export type ScheduleBackgroundEventParameters = InferMatching<typeof ScheduleBackgroundEventParametersStruct, ScheduleBackgroundEventParams>;
+export {};
+//# sourceMappingURL=scheduleBackgroundEvent.d.mts.map

package/dist/permitted/scheduleBackgroundEvent.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduleBackgroundEvent.d.mts","sourceRoot":"","sources":["../../src/permitted/scheduleBackgroundEvent.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,wCAAwC;AAE9E,OAAO,EAGL,KAAK,6BAA6B,EAClC,KAAK,6BAA6B,EACnC,4BAA4B;AAC7B,OAAO,KAAK,EAAE,iBAAiB,EAAE,8BAA8B;AAC/D,OAAO,EAEL,KAAK,aAAa,EACnB,8BAA8B;AAyB/B,KAAK,iCAAiC,GAAG;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,iBAAiB,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C,uBAAuB,EAAE,CACvB,SAAS,EAAE,iCAAiC,KACzC,MAAM,CAAC;IAEZ,aAAa,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC;CACpD,CAAC;AAEF,eAAO,MAAM,8BAA8B,EAAE,sBAAsB,CACjE,kCAAkC,EAClC,iCAAiC,EACjC,6BAA6B,CAK9B,CAAC;AA8BF,QAAA,MAAM,uCAAuC;;;;;;;;;;;;;;;;QAK3C,CAAC;AAEH,MAAM,MAAM,iCAAiC,GAAG,aAAa,CAC3D,OAAO,uCAAuC,EAC9C,6BAA6B,CAC9B,CAAC"}

package/dist/permitted/scheduleBackgroundEvent.mjs

@@ -0,0 +1,119 @@
+import { providerErrors, rpcErrors } from "@metamask/rpc-errors";
+import { selectiveUnion } from "@metamask/snaps-sdk";
+import { CronjobRpcRequestStruct } from "@metamask/snaps-utils";
+import { StructError, create, object, refine, string } from "@metamask/superstruct";
+import { assert, hasProperty } from "@metamask/utils";
+import { DateTime, Duration } from "luxon";
+import { SnapEndowments } from "../endowments/index.mjs";
+const methodName = 'snap_scheduleBackgroundEvent';
+const hookNames = {
+    scheduleBackgroundEvent: true,
+    hasPermission: true,
+};
+export const scheduleBackgroundEventHandler = {
+    methodNames: [methodName],
+    implementation: getScheduleBackgroundEventImplementation,
+    hookNames,
+};
+const offsetRegex = /Z|([+-]\d{2}:?\d{2})$/u;
+const ScheduleBackgroundEventParametersWithDateStruct = object({
+    date: refine(string(), 'date', (val) => {
+        const date = DateTime.fromISO(val);
+        if (date.isValid) {
+            // Luxon doesn't have a reliable way to check if timezone info was not provided
+            if (!offsetRegex.test(val)) {
+                return 'ISO 8601 date must have timezone information';
+            }
+            return true;
+        }
+        return 'Not a valid ISO 8601 date';
+    }),
+    request: CronjobRpcRequestStruct,
+});
+const ScheduleBackgroundEventParametersWithDurationStruct = object({
+    duration: refine(string(), 'duration', (val) => {
+        const duration = Duration.fromISO(val);
+        if (!duration.isValid) {
+            return 'Not a valid ISO 8601 duration';
+        }
+        return true;
+    }),
+    request: CronjobRpcRequestStruct,
+});
+const ScheduleBackgroundEventParametersStruct = selectiveUnion((val) => {
+    if (hasProperty(val, 'date')) {
+        return ScheduleBackgroundEventParametersWithDateStruct;
+    }
+    return ScheduleBackgroundEventParametersWithDurationStruct;
+});
+/**
+ * Generates a `DateTime` object based on if a duration or date is provided.
+ *
+ * @param params - The validated params from the `snap_scheduleBackgroundEvent` call.
+ * @returns A `DateTime` object.
+ */
+function getStartDate(params) {
+    if ('duration' in params) {
+        return DateTime.fromJSDate(new Date())
+            .toUTC()
+            .plus(Duration.fromISO(params.duration));
+    }
+    return DateTime.fromISO(params.date, { setZone: true });
+}
+/**
+ * The `snap_scheduleBackgroundEvent` method implementation.
+ *
+ * @param req - The JSON-RPC request object.
+ * @param res - The JSON-RPC response object.
+ * @param _next - The `json-rpc-engine` "next" callback. Not used by this
+ * function.
+ * @param end - The `json-rpc-engine` "end" callback.
+ * @param hooks - The RPC method hooks.
+ * @param hooks.scheduleBackgroundEvent - The function to schedule a background event.
+ * @param hooks.hasPermission - The function to check if a snap has the `endowment:cronjob` permission.
+ * @returns An id representing the background event.
+ */
+async function getScheduleBackgroundEventImplementation(req, res, _next, end, { scheduleBackgroundEvent, hasPermission, }) {
+    const { params } = req;
+    if (!hasPermission(SnapEndowments.Cronjob)) {
+        return end(providerErrors.unauthorized());
+    }
+    try {
+        const validatedParams = getValidatedParams(params);
+        const { request } = validatedParams;
+        const date = getStartDate(validatedParams);
+        // Make sure any millisecond precision is removed.
+        const truncatedDate = date.startOf('second').toISO({
+            suppressMilliseconds: true,
+        });
+        assert(truncatedDate);
+        const id = scheduleBackgroundEvent({ date: truncatedDate, request });
+        res.result = id;
+    }
+    catch (error) {
+        return end(error);
+    }
+    return end();
+}
+/**
+ * Validate the scheduleBackgroundEvent method `params` and returns them cast to the correct
+ * type. Throws if validation fails.
+ *
+ * @param params - The unvalidated params object from the method request.
+ * @returns The validated resolveInterface method parameter object.
+ */
+function getValidatedParams(params) {
+    try {
+        return create(params, ScheduleBackgroundEventParametersStruct);
+    }
+    catch (error) {
+        if (error instanceof StructError) {
+            throw rpcErrors.invalidParams({
+                message: `Invalid params: ${error.message}.`,
+            });
+        }
+        /* istanbul ignore next */
+        throw rpcErrors.internal();
+    }
+}
+//# sourceMappingURL=scheduleBackgroundEvent.mjs.map

package/dist/permitted/scheduleBackgroundEvent.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduleBackgroundEvent.mjs","sourceRoot":"","sources":["../../src/permitted/scheduleBackgroundEvent.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,6BAA6B;AACjE,OAAO,EACL,cAAc,EAIf,4BAA4B;AAE7B,OAAO,EACL,uBAAuB,EAExB,8BAA8B;AAC/B,OAAO,EACL,WAAW,EACX,MAAM,EACN,MAAM,EACN,MAAM,EACN,MAAM,EACP,8BAA8B;AAC/B,OAAO,EACL,MAAM,EACN,WAAW,EAEZ,wBAAwB;AACzB,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,cAAc;AAE3C,OAAO,EAAE,cAAc,EAAE,gCAAsB;AAG/C,MAAM,UAAU,GAAG,8BAA8B,CAAC;AAElD,MAAM,SAAS,GAA0D;IACvE,uBAAuB,EAAE,IAAI;IAC7B,aAAa,EAAE,IAAI;CACpB,CAAC;AAeF,MAAM,CAAC,MAAM,8BAA8B,GAIvC;IACF,WAAW,EAAE,CAAC,UAAU,CAAC;IACzB,cAAc,EAAE,wCAAwC;IACxD,SAAS;CACV,CAAC;AAEF,MAAM,WAAW,GAAG,wBAAwB,CAAC;AAE7C,MAAM,+CAA+C,GAAG,MAAM,CAAC;IAC7D,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE;QACrC,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACnC,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,+EAA+E;YAC/E,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC3B,OAAO,8CAA8C,CAAC;YACxD,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,2BAA2B,CAAC;IACrC,CAAC,CAAC;IACF,OAAO,EAAE,uBAAuB;CACjC,CAAC,CAAC;AAEH,MAAM,mDAAmD,GAAG,MAAM,CAAC;IACjE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,EAAE,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE;QAC7C,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACvC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACtB,OAAO,+BAA+B,CAAC;QACzC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IACF,OAAO,EAAE,uBAAuB;CACjC,CAAC,CAAC;AAEH,MAAM,uCAAuC,GAAG,cAAc,CAAC,CAAC,GAAG,EAAE,EAAE;IACrE,IAAI,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC;QAC7B,OAAO,+CAA+C,CAAC;IACzD,CAAC;IACD,OAAO,mDAAmD,CAAC;AAC7D,CAAC,CAAC,CAAC;AAOH;;;;;GAKG;AACH,SAAS,YAAY,CAAC,MAAqC;IACzD,IAAI,UAAU,IAAI,MAAM,EAAE,CAAC;QACzB,OAAO,QAAQ,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE,CAAC;aACnC,KAAK,EAAE;aACP,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED,OAAO,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;AAC1D,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,KAAK,UAAU,wCAAwC,CACrD,GAAsD,EACtD,GAA0D,EAC1D,KAAc,EACd,GAA6B,EAC7B,EACE,uBAAuB,EACvB,aAAa,GACsB;IAErC,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;IAEvB,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3C,OAAO,GAAG,CAAC,cAAc,CAAC,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAEnD,MAAM,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC;QAEpC,MAAM,IAAI,GAAG,YAAY,CAAC,eAAe,CAAC,CAAC;QAE3C,kDAAkD;QAClD,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC;YACjD,oBAAoB,EAAE,IAAI;SAC3B,CAAC,CAAC;QAEH,MAAM,CAAC,aAAa,CAAC,CAAC;QAEtB,MAAM,EAAE,GAAG,uBAAuB,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,CAAC,CAAC;QACrE,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC;IAClB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,GAAG,EAAE,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CACzB,MAAe;IAEf,IAAI,CAAC;QACH,OAAO,MAAM,CAAC,MAAM,EAAE,uCAAuC,CAAC,CAAC;IACjE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;YACjC,MAAM,SAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EAAE,mBAAmB,KAAK,CAAC,OAAO,GAAG;aAC7C,CAAC,CAAC;QACL,CAAC;QACD,0BAA0B;QAC1B,MAAM,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC","sourcesContent":["import type { JsonRpcEngineEndCallback } from '@metamask/json-rpc-engine';\nimport type { PermittedHandlerExport } from '@metamask/permission-controller';\nimport { providerErrors, rpcErrors } from '@metamask/rpc-errors';\nimport {\n  selectiveUnion,\n  type JsonRpcRequest,\n  type ScheduleBackgroundEventParams,\n  type ScheduleBackgroundEventResult,\n} from '@metamask/snaps-sdk';\nimport type { CronjobRpcRequest } from '@metamask/snaps-utils';\nimport {\n  CronjobRpcRequestStruct,\n  type InferMatching,\n} from '@metamask/snaps-utils';\nimport {\n  StructError,\n  create,\n  object,\n  refine,\n  string,\n} from '@metamask/superstruct';\nimport {\n  assert,\n  hasProperty,\n  type PendingJsonRpcResponse,\n} from '@metamask/utils';\nimport { DateTime, Duration } from 'luxon';\n\nimport { SnapEndowments } from '../endowments';\nimport type { MethodHooksObject } from '../utils';\n\nconst methodName = 'snap_scheduleBackgroundEvent';\n\nconst hookNames: MethodHooksObject<ScheduleBackgroundEventMethodHooks> = {\n  scheduleBackgroundEvent: true,\n  hasPermission: true,\n};\n\ntype ScheduleBackgroundEventHookParams = {\n  date: string;\n  request: CronjobRpcRequest;\n};\n\nexport type ScheduleBackgroundEventMethodHooks = {\n  scheduleBackgroundEvent: (\n    snapEvent: ScheduleBackgroundEventHookParams,\n  ) => string;\n\n  hasPermission: (permissionName: string) => boolean;\n};\n\nexport const scheduleBackgroundEventHandler: PermittedHandlerExport<\n  ScheduleBackgroundEventMethodHooks,\n  ScheduleBackgroundEventParameters,\n  ScheduleBackgroundEventResult\n> = {\n  methodNames: [methodName],\n  implementation: getScheduleBackgroundEventImplementation,\n  hookNames,\n};\n\nconst offsetRegex = /Z|([+-]\\d{2}:?\\d{2})$/u;\n\nconst ScheduleBackgroundEventParametersWithDateStruct = object({\n  date: refine(string(), 'date', (val) => {\n    const date = DateTime.fromISO(val);\n    if (date.isValid) {\n      // Luxon doesn't have a reliable way to check if timezone info was not provided\n      if (!offsetRegex.test(val)) {\n        return 'ISO 8601 date must have timezone information';\n      }\n      return true;\n    }\n    return 'Not a valid ISO 8601 date';\n  }),\n  request: CronjobRpcRequestStruct,\n});\n\nconst ScheduleBackgroundEventParametersWithDurationStruct = object({\n  duration: refine(string(), 'duration', (val) => {\n    const duration = Duration.fromISO(val);\n    if (!duration.isValid) {\n      return 'Not a valid ISO 8601 duration';\n    }\n    return true;\n  }),\n  request: CronjobRpcRequestStruct,\n});\n\nconst ScheduleBackgroundEventParametersStruct = selectiveUnion((val) => {\n  if (hasProperty(val, 'date')) {\n    return ScheduleBackgroundEventParametersWithDateStruct;\n  }\n  return ScheduleBackgroundEventParametersWithDurationStruct;\n});\n\nexport type ScheduleBackgroundEventParameters = InferMatching<\n  typeof ScheduleBackgroundEventParametersStruct,\n  ScheduleBackgroundEventParams\n>;\n\n/**\n * Generates a `DateTime` object based on if a duration or date is provided.\n *\n * @param params - The validated params from the `snap_scheduleBackgroundEvent` call.\n * @returns A `DateTime` object.\n */\nfunction getStartDate(params: ScheduleBackgroundEventParams) {\n  if ('duration' in params) {\n    return DateTime.fromJSDate(new Date())\n      .toUTC()\n      .plus(Duration.fromISO(params.duration));\n  }\n\n  return DateTime.fromISO(params.date, { setZone: true });\n}\n\n/**\n * The `snap_scheduleBackgroundEvent` method implementation.\n *\n * @param req - The JSON-RPC request object.\n * @param res - The JSON-RPC response object.\n * @param _next - The `json-rpc-engine` \"next\" callback. Not used by this\n * function.\n * @param end - The `json-rpc-engine` \"end\" callback.\n * @param hooks - The RPC method hooks.\n * @param hooks.scheduleBackgroundEvent - The function to schedule a background event.\n * @param hooks.hasPermission - The function to check if a snap has the `endowment:cronjob` permission.\n * @returns An id representing the background event.\n */\nasync function getScheduleBackgroundEventImplementation(\n  req: JsonRpcRequest<ScheduleBackgroundEventParameters>,\n  res: PendingJsonRpcResponse<ScheduleBackgroundEventResult>,\n  _next: unknown,\n  end: JsonRpcEngineEndCallback,\n  {\n    scheduleBackgroundEvent,\n    hasPermission,\n  }: ScheduleBackgroundEventMethodHooks,\n): Promise<void> {\n  const { params } = req;\n\n  if (!hasPermission(SnapEndowments.Cronjob)) {\n    return end(providerErrors.unauthorized());\n  }\n\n  try {\n    const validatedParams = getValidatedParams(params);\n\n    const { request } = validatedParams;\n\n    const date = getStartDate(validatedParams);\n\n    // Make sure any millisecond precision is removed.\n    const truncatedDate = date.startOf('second').toISO({\n      suppressMilliseconds: true,\n    });\n\n    assert(truncatedDate);\n\n    const id = scheduleBackgroundEvent({ date: truncatedDate, request });\n    res.result = id;\n  } catch (error) {\n    return end(error);\n  }\n\n  return end();\n}\n\n/**\n * Validate the scheduleBackgroundEvent method `params` and returns them cast to the correct\n * type. Throws if validation fails.\n *\n * @param params - The unvalidated params object from the method request.\n * @returns The validated resolveInterface method parameter object.\n */\nfunction getValidatedParams(\n  params: unknown,\n): ScheduleBackgroundEventParameters {\n  try {\n    return create(params, ScheduleBackgroundEventParametersStruct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw rpcErrors.invalidParams({\n        message: `Invalid params: ${error.message}.`,\n      });\n    }\n    /* istanbul ignore next */\n    throw rpcErrors.internal();\n  }\n}\n"]}