@metamask-previews/approval-controller 8.0.0-preview-25d2d4502 → 9.0.0-preview-152e02d

package/CHANGELOG.md

@@ -7,8 +7,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [9.0.0]
+
+### Added
+
+- New `addRequest()` public method ([#8183](https://github.com/MetaMask/core/pull/8183))
+- Expose missing public `ApprovalController` methods through its messenger ([#8183](https://github.com/MetaMask/core/pull/8183))
+  - The following actions are now available:
+    - `ApprovalController:add`
+    - `ApprovalController:addAndShowApprovalRequest`
+    - `ApprovalController:get`
+    - `ApprovalController:getApprovalCount`
+    - `ApprovalController:getTotalApprovalCount`
+  - Corresponding action types (e.g. `ApprovalControllerAddAction`) are available as well.
+
 ### Changed
 
+- **BREAKING:** Standardize names of `ApprovalController` methods ([#8183](https://github.com/MetaMask/core/pull/8183))
+  - All existing methods for handling requests have been renamed so they include `Request` (e.g. `clear()` -> `clearRequest()`). You will need to update usage appropriately.
+  - The error handling method `error()` has been renamed to include `show` (`error()` -> `showError()`). You will need to update usage appropriately.
+- **BREAKING:** Rename get-state action type: `GetApprovalsState` → `ApprovalControllerGetStateAction` ([#8183](https://github.com/MetaMask/core/pull/8183))
 - Upgrade `@metamask/utils` from `^11.8.1` to `^11.9.0` ([#7511](https://github.com/MetaMask/core/pull/7511))
 
 ## [8.0.0]
@@ -298,7 +316,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
     All changes listed after this point were applied to this package following the monorepo conversion.
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/approval-controller@8.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/approval-controller@9.0.0...HEAD
+[9.0.0]: https://github.com/MetaMask/core/compare/@metamask/approval-controller@8.0.0...@metamask/approval-controller@9.0.0
 [8.0.0]: https://github.com/MetaMask/core/compare/@metamask/approval-controller@7.2.1...@metamask/approval-controller@8.0.0
 [7.2.1]: https://github.com/MetaMask/core/compare/@metamask/approval-controller@7.2.0...@metamask/approval-controller@7.2.1
 [7.2.0]: https://github.com/MetaMask/core/compare/@metamask/approval-controller@7.1.3...@metamask/approval-controller@7.2.0

package/dist/ApprovalController-method-action-types.cjs

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ApprovalController-method-action-types.cjs.map

package/dist/ApprovalController-method-action-types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApprovalController-method-action-types.cjs","sourceRoot":"","sources":["../src/ApprovalController-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { ApprovalController } from './ApprovalController';\n\n/**\n * Adds an approval request per the given arguments, optionally showing\n * the approval request to the user.\n *\n * @param opts - Options bag.\n * @param opts.id - The id of the approval request. A random id will be\n * generated if none is provided.\n * @param opts.origin - The origin of the approval request.\n * @param opts.type - The type associated with the approval request.\n * @param opts.requestData - Additional data associated with the request,\n * if any.\n * @param opts.requestState - Additional state associated with the request,\n * if any.\n * @param shouldShowRequest - Whether to show the approval request to the user.\n * @returns The approval promise.\n */\nexport type ApprovalControllerAddRequestAction = {\n  type: `ApprovalController:addRequest`;\n  handler: ApprovalController['addRequest'];\n};\n\n/**\n * Adds an approval request per the given arguments, calls the show approval\n * request function, and returns the associated approval promise resolving to\n * an AddResult object.\n *\n * There can only be one approval per origin and type. An error is thrown if\n * attempting to add an invalid or duplicate request.\n *\n * @param opts - Options bag.\n * @param opts.id - The id of the approval request. A random id will be\n * generated if none is provided.\n * @param opts.origin - The origin of the approval request.\n * @param opts.type - The type associated with the approval request.\n * @param opts.requestData - Additional data associated with the request,\n * @param opts.requestState - Additional state associated with the request,\n * if any.\n * @returns The approval promise resolving to an AddResult object.\n */\nexport type ApprovalControllerAddAndShowApprovalRequestAction = {\n  type: `ApprovalController:addAndShowApprovalRequest`;\n  handler: ApprovalController['addAndShowApprovalRequest'];\n};\n\n/**\n * Adds an approval request per the given arguments and returns the approval\n * promise resolving to an AddResult object.\n *\n * There can only be one approval per origin and type. An error is thrown if\n * attempting to add an invalid or duplicate request.\n *\n * @param opts - Options bag.\n * @param opts.id - The id of the approval request. A random id will be\n * generated if none is provided.\n * @param opts.origin - The origin of the approval request.\n * @param opts.type - The type associated with the approval request.\n * @param opts.requestData - Additional data associated with the request,\n * if any.\n * @returns The approval promise resolving to an AddResult object.\n */\nexport type ApprovalControllerAddAction = {\n  type: `ApprovalController:add`;\n  handler: ApprovalController['add'];\n};\n\n/**\n * Gets the info for the approval request with the given id.\n *\n * @param id - The id of the approval request.\n * @returns The approval request data associated with the id.\n */\nexport type ApprovalControllerGetAction = {\n  type: `ApprovalController:get`;\n  handler: ApprovalController['get'];\n};\n\n/**\n * Gets the number of pending approvals, by origin and/or type.\n *\n * If only `origin` is specified, all approvals for that origin will be\n * counted, regardless of type.\n * If only `type` is specified, all approvals for that type will be counted,\n * regardless of origin.\n * If both `origin` and `type` are specified, 0 or 1 will be returned.\n *\n * @param opts - The approval count options.\n * @param opts.origin - An approval origin.\n * @param opts.type - The type of the approval request.\n * @returns The current approval request count for the given origin and/or\n * type.\n */\nexport type ApprovalControllerGetApprovalCountAction = {\n  type: `ApprovalController:getApprovalCount`;\n  handler: ApprovalController['getApprovalCount'];\n};\n\n/**\n * Get the total count of all pending approval requests for all origins.\n *\n * @returns The total pending approval request count.\n */\nexport type ApprovalControllerGetTotalApprovalCountAction = {\n  type: `ApprovalController:getTotalApprovalCount`;\n  handler: ApprovalController['getTotalApprovalCount'];\n};\n\n/**\n * Checks if there's a pending approval request per the given parameters.\n * At least one parameter must be specified. An error will be thrown if the\n * parameters are invalid.\n *\n * If `id` is specified, all other parameters will be ignored.\n * If `id` is not specified, the method will check for requests that match\n * all of the specified parameters.\n *\n * @param opts - Options bag.\n * @param opts.id - The ID to check for.\n * @param opts.origin - The origin to check for.\n * @param opts.type - The type to check for.\n * @returns `true` if a matching approval is found, and `false` otherwise.\n */\nexport type ApprovalControllerHasRequestAction = {\n  type: `ApprovalController:hasRequest`;\n  handler: ApprovalController['hasRequest'];\n};\n\n/**\n * Resolves the promise of the approval with the given id, and deletes the\n * approval. Throws an error if no such approval exists.\n *\n * @param id - The id of the approval request.\n * @param value - The value to resolve the approval promise with.\n * @param options - Options bag.\n * @returns A promise that either resolves once a result is provided by\n * the creator of the approval request, or immediately if `options.waitForResult`\n * is `false` or `undefined`.\n */\nexport type ApprovalControllerAcceptRequestAction = {\n  type: `ApprovalController:acceptRequest`;\n  handler: ApprovalController['acceptRequest'];\n};\n\n/**\n * Rejects the promise of the approval with the given id, and deletes the\n * approval. Throws an error if no such approval exists.\n *\n * @param id - The id of the approval request.\n * @param error - The error to reject the approval promise with.\n */\nexport type ApprovalControllerRejectRequestAction = {\n  type: `ApprovalController:rejectRequest`;\n  handler: ApprovalController['rejectRequest'];\n};\n\n/**\n * Rejects and deletes all approval requests.\n *\n * @param rejectionError - The JsonRpcError to reject the approval\n * requests with.\n */\nexport type ApprovalControllerClearRequestsAction = {\n  type: `ApprovalController:clearRequests`;\n  handler: ApprovalController['clearRequests'];\n};\n\n/**\n * Updates the request state of the approval with the given id.\n *\n * @param opts - Options bag.\n * @param opts.id - The id of the approval request.\n * @param opts.requestState - Additional data associated with the request\n */\nexport type ApprovalControllerUpdateRequestStateAction = {\n  type: `ApprovalController:updateRequestState`;\n  handler: ApprovalController['updateRequestState'];\n};\n\n/**\n * Starts a new approval flow.\n *\n * @param opts - Options bag.\n * @param opts.id - The id of the approval flow.\n * @param opts.loadingText - The loading text that will be associated to the approval flow.\n * @param opts.show - A flag to determine whether the approval should show to the user.\n * @returns The object containing the approval flow id.\n */\nexport type ApprovalControllerStartFlowAction = {\n  type: `ApprovalController:startFlow`;\n  handler: ApprovalController['startFlow'];\n};\n\n/**\n * Ends the current approval flow.\n *\n * @param opts - Options bag.\n * @param opts.id - The id of the approval flow that will be finished.\n */\nexport type ApprovalControllerEndFlowAction = {\n  type: `ApprovalController:endFlow`;\n  handler: ApprovalController['endFlow'];\n};\n\n/**\n * Sets the loading text for the approval flow.\n *\n * @param opts - Options bag.\n * @param opts.id - The approval flow loading text that will be displayed.\n * @param opts.loadingText - The loading text that will be associated to the approval flow.\n */\nexport type ApprovalControllerSetFlowLoadingTextAction = {\n  type: `ApprovalController:setFlowLoadingText`;\n  handler: ApprovalController['setFlowLoadingText'];\n};\n\n/**\n * Show a success page.\n *\n * @param opts - Options bag.\n * @param opts.message - The message text or components to display in the page.\n * @param opts.header - The text or components to display in the header of the page.\n * @param opts.flowToEnd - The ID of the approval flow to end once the success page is approved.\n * @param opts.title - The title to display above the message. Shown by default but can be hidden with `null`.\n * @param opts.icon - The icon to display in the page. Shown by default but can be hidden with `null`.\n * @returns Empty object to support future additions.\n */\nexport type ApprovalControllerShowSuccessAction = {\n  type: `ApprovalController:showSuccess`;\n  handler: ApprovalController['showSuccess'];\n};\n\n/**\n * Show an error page.\n *\n * @param opts - Options bag.\n * @param opts.message - The message text or components to display in the page.\n * @param opts.header - The text or components to display in the header of the page.\n * @param opts.flowToEnd - The ID of the approval flow to end once the error page is approved.\n * @param opts.title - The title to display above the message. Shown by default but can be hidden with `null`.\n * @param opts.icon - The icon to display in the page. Shown by default but can be hidden with `null`.\n * @returns Empty object to support future additions.\n */\nexport type ApprovalControllerShowErrorAction = {\n  type: `ApprovalController:showError`;\n  handler: ApprovalController['showError'];\n};\n\n/**\n * Union of all ApprovalController action types.\n */\nexport type ApprovalControllerMethodActions =\n  | ApprovalControllerAddRequestAction\n  | ApprovalControllerAddAndShowApprovalRequestAction\n  | ApprovalControllerAddAction\n  | ApprovalControllerGetAction\n  | ApprovalControllerGetApprovalCountAction\n  | ApprovalControllerGetTotalApprovalCountAction\n  | ApprovalControllerHasRequestAction\n  | ApprovalControllerAcceptRequestAction\n  | ApprovalControllerRejectRequestAction\n  | ApprovalControllerClearRequestsAction\n  | ApprovalControllerUpdateRequestStateAction\n  | ApprovalControllerStartFlowAction\n  | ApprovalControllerEndFlowAction\n  | ApprovalControllerSetFlowLoadingTextAction\n  | ApprovalControllerShowSuccessAction\n  | ApprovalControllerShowErrorAction;\n"]}

package/dist/ApprovalController-method-action-types.d.cts

@@ -0,0 +1,240 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+import type { ApprovalController } from "./ApprovalController.cjs";
+/**
+ * Adds an approval request per the given arguments, optionally showing
+ * the approval request to the user.
+ *
+ * @param opts - Options bag.
+ * @param opts.id - The id of the approval request. A random id will be
+ * generated if none is provided.
+ * @param opts.origin - The origin of the approval request.
+ * @param opts.type - The type associated with the approval request.
+ * @param opts.requestData - Additional data associated with the request,
+ * if any.
+ * @param opts.requestState - Additional state associated with the request,
+ * if any.
+ * @param shouldShowRequest - Whether to show the approval request to the user.
+ * @returns The approval promise.
+ */
+export type ApprovalControllerAddRequestAction = {
+    type: `ApprovalController:addRequest`;
+    handler: ApprovalController['addRequest'];
+};
+/**
+ * Adds an approval request per the given arguments, calls the show approval
+ * request function, and returns the associated approval promise resolving to
+ * an AddResult object.
+ *
+ * There can only be one approval per origin and type. An error is thrown if
+ * attempting to add an invalid or duplicate request.
+ *
+ * @param opts - Options bag.
+ * @param opts.id - The id of the approval request. A random id will be
+ * generated if none is provided.
+ * @param opts.origin - The origin of the approval request.
+ * @param opts.type - The type associated with the approval request.
+ * @param opts.requestData - Additional data associated with the request,
+ * @param opts.requestState - Additional state associated with the request,
+ * if any.
+ * @returns The approval promise resolving to an AddResult object.
+ */
+export type ApprovalControllerAddAndShowApprovalRequestAction = {
+    type: `ApprovalController:addAndShowApprovalRequest`;
+    handler: ApprovalController['addAndShowApprovalRequest'];
+};
+/**
+ * Adds an approval request per the given arguments and returns the approval
+ * promise resolving to an AddResult object.
+ *
+ * There can only be one approval per origin and type. An error is thrown if
+ * attempting to add an invalid or duplicate request.
+ *
+ * @param opts - Options bag.
+ * @param opts.id - The id of the approval request. A random id will be
+ * generated if none is provided.
+ * @param opts.origin - The origin of the approval request.
+ * @param opts.type - The type associated with the approval request.
+ * @param opts.requestData - Additional data associated with the request,
+ * if any.
+ * @returns The approval promise resolving to an AddResult object.
+ */
+export type ApprovalControllerAddAction = {
+    type: `ApprovalController:add`;
+    handler: ApprovalController['add'];
+};
+/**
+ * Gets the info for the approval request with the given id.
+ *
+ * @param id - The id of the approval request.
+ * @returns The approval request data associated with the id.
+ */
+export type ApprovalControllerGetAction = {
+    type: `ApprovalController:get`;
+    handler: ApprovalController['get'];
+};
+/**
+ * Gets the number of pending approvals, by origin and/or type.
+ *
+ * If only `origin` is specified, all approvals for that origin will be
+ * counted, regardless of type.
+ * If only `type` is specified, all approvals for that type will be counted,
+ * regardless of origin.
+ * If both `origin` and `type` are specified, 0 or 1 will be returned.
+ *
+ * @param opts - The approval count options.
+ * @param opts.origin - An approval origin.
+ * @param opts.type - The type of the approval request.
+ * @returns The current approval request count for the given origin and/or
+ * type.
+ */
+export type ApprovalControllerGetApprovalCountAction = {
+    type: `ApprovalController:getApprovalCount`;
+    handler: ApprovalController['getApprovalCount'];
+};
+/**
+ * Get the total count of all pending approval requests for all origins.
+ *
+ * @returns The total pending approval request count.
+ */
+export type ApprovalControllerGetTotalApprovalCountAction = {
+    type: `ApprovalController:getTotalApprovalCount`;
+    handler: ApprovalController['getTotalApprovalCount'];
+};
+/**
+ * Checks if there's a pending approval request per the given parameters.
+ * At least one parameter must be specified. An error will be thrown if the
+ * parameters are invalid.
+ *
+ * If `id` is specified, all other parameters will be ignored.
+ * If `id` is not specified, the method will check for requests that match
+ * all of the specified parameters.
+ *
+ * @param opts - Options bag.
+ * @param opts.id - The ID to check for.
+ * @param opts.origin - The origin to check for.
+ * @param opts.type - The type to check for.
+ * @returns `true` if a matching approval is found, and `false` otherwise.
+ */
+export type ApprovalControllerHasRequestAction = {
+    type: `ApprovalController:hasRequest`;
+    handler: ApprovalController['hasRequest'];
+};
+/**
+ * Resolves the promise of the approval with the given id, and deletes the
+ * approval. Throws an error if no such approval exists.
+ *
+ * @param id - The id of the approval request.
+ * @param value - The value to resolve the approval promise with.
+ * @param options - Options bag.
+ * @returns A promise that either resolves once a result is provided by
+ * the creator of the approval request, or immediately if `options.waitForResult`
+ * is `false` or `undefined`.
+ */
+export type ApprovalControllerAcceptRequestAction = {
+    type: `ApprovalController:acceptRequest`;
+    handler: ApprovalController['acceptRequest'];
+};
+/**
+ * Rejects the promise of the approval with the given id, and deletes the
+ * approval. Throws an error if no such approval exists.
+ *
+ * @param id - The id of the approval request.
+ * @param error - The error to reject the approval promise with.
+ */
+export type ApprovalControllerRejectRequestAction = {
+    type: `ApprovalController:rejectRequest`;
+    handler: ApprovalController['rejectRequest'];
+};
+/**
+ * Rejects and deletes all approval requests.
+ *
+ * @param rejectionError - The JsonRpcError to reject the approval
+ * requests with.
+ */
+export type ApprovalControllerClearRequestsAction = {
+    type: `ApprovalController:clearRequests`;
+    handler: ApprovalController['clearRequests'];
+};
+/**
+ * Updates the request state of the approval with the given id.
+ *
+ * @param opts - Options bag.
+ * @param opts.id - The id of the approval request.
+ * @param opts.requestState - Additional data associated with the request
+ */
+export type ApprovalControllerUpdateRequestStateAction = {
+    type: `ApprovalController:updateRequestState`;
+    handler: ApprovalController['updateRequestState'];
+};
+/**
+ * Starts a new approval flow.
+ *
+ * @param opts - Options bag.
+ * @param opts.id - The id of the approval flow.
+ * @param opts.loadingText - The loading text that will be associated to the approval flow.
+ * @param opts.show - A flag to determine whether the approval should show to the user.
+ * @returns The object containing the approval flow id.
+ */
+export type ApprovalControllerStartFlowAction = {
+    type: `ApprovalController:startFlow`;
+    handler: ApprovalController['startFlow'];
+};
+/**
+ * Ends the current approval flow.
+ *
+ * @param opts - Options bag.
+ * @param opts.id - The id of the approval flow that will be finished.
+ */
+export type ApprovalControllerEndFlowAction = {
+    type: `ApprovalController:endFlow`;
+    handler: ApprovalController['endFlow'];
+};
+/**
+ * Sets the loading text for the approval flow.
+ *
+ * @param opts - Options bag.
+ * @param opts.id - The approval flow loading text that will be displayed.
+ * @param opts.loadingText - The loading text that will be associated to the approval flow.
+ */
+export type ApprovalControllerSetFlowLoadingTextAction = {
+    type: `ApprovalController:setFlowLoadingText`;
+    handler: ApprovalController['setFlowLoadingText'];
+};
+/**
+ * Show a success page.
+ *
+ * @param opts - Options bag.
+ * @param opts.message - The message text or components to display in the page.
+ * @param opts.header - The text or components to display in the header of the page.
+ * @param opts.flowToEnd - The ID of the approval flow to end once the success page is approved.
+ * @param opts.title - The title to display above the message. Shown by default but can be hidden with `null`.
+ * @param opts.icon - The icon to display in the page. Shown by default but can be hidden with `null`.
+ * @returns Empty object to support future additions.
+ */
+export type ApprovalControllerShowSuccessAction = {
+    type: `ApprovalController:showSuccess`;
+    handler: ApprovalController['showSuccess'];
+};
+/**
+ * Show an error page.
+ *
+ * @param opts - Options bag.
+ * @param opts.message - The message text or components to display in the page.
+ * @param opts.header - The text or components to display in the header of the page.
+ * @param opts.flowToEnd - The ID of the approval flow to end once the error page is approved.
+ * @param opts.title - The title to display above the message. Shown by default but can be hidden with `null`.
+ * @param opts.icon - The icon to display in the page. Shown by default but can be hidden with `null`.
+ * @returns Empty object to support future additions.
+ */
+export type ApprovalControllerShowErrorAction = {
+    type: `ApprovalController:showError`;
+    handler: ApprovalController['showError'];
+};
+/**
+ * Union of all ApprovalController action types.
+ */
+export type ApprovalControllerMethodActions = ApprovalControllerAddRequestAction | ApprovalControllerAddAndShowApprovalRequestAction | ApprovalControllerAddAction | ApprovalControllerGetAction | ApprovalControllerGetApprovalCountAction | ApprovalControllerGetTotalApprovalCountAction | ApprovalControllerHasRequestAction | ApprovalControllerAcceptRequestAction | ApprovalControllerRejectRequestAction | ApprovalControllerClearRequestsAction | ApprovalControllerUpdateRequestStateAction | ApprovalControllerStartFlowAction | ApprovalControllerEndFlowAction | ApprovalControllerSetFlowLoadingTextAction | ApprovalControllerShowSuccessAction | ApprovalControllerShowErrorAction;
+//# sourceMappingURL=ApprovalController-method-action-types.d.cts.map

package/dist/ApprovalController-method-action-types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApprovalController-method-action-types.d.cts","sourceRoot":"","sources":["../src/ApprovalController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,kBAAkB,EAAE,iCAA6B;AAE/D;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC/C,IAAI,EAAE,+BAA+B,CAAC;IACtC,OAAO,EAAE,kBAAkB,CAAC,YAAY,CAAC,CAAC;CAC3C,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,iDAAiD,GAAG;IAC9D,IAAI,EAAE,8CAA8C,CAAC;IACrD,OAAO,EAAE,kBAAkB,CAAC,2BAA2B,CAAC,CAAC;CAC1D,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,wBAAwB,CAAC;IAC/B,OAAO,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;CACpC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,wBAAwB,CAAC;IAC/B,OAAO,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;CACpC,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD,IAAI,EAAE,qCAAqC,CAAC;IAC5C,OAAO,EAAE,kBAAkB,CAAC,kBAAkB,CAAC,CAAC;CACjD,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,6CAA6C,GAAG;IAC1D,IAAI,EAAE,0CAA0C,CAAC;IACjD,OAAO,EAAE,kBAAkB,CAAC,uBAAuB,CAAC,CAAC;CACtD,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC/C,IAAI,EAAE,+BAA+B,CAAC;IACtC,OAAO,EAAE,kBAAkB,CAAC,YAAY,CAAC,CAAC;CAC3C,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,EAAE,kCAAkC,CAAC;IACzC,OAAO,EAAE,kBAAkB,CAAC,eAAe,CAAC,CAAC;CAC9C,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,EAAE,kCAAkC,CAAC;IACzC,OAAO,EAAE,kBAAkB,CAAC,eAAe,CAAC,CAAC;CAC9C,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,EAAE,kCAAkC,CAAC;IACzC,OAAO,EAAE,kBAAkB,CAAC,eAAe,CAAC,CAAC;CAC9C,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,0CAA0C,GAAG;IACvD,IAAI,EAAE,uCAAuC,CAAC;IAC9C,OAAO,EAAE,kBAAkB,CAAC,oBAAoB,CAAC,CAAC;CACnD,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,8BAA8B,CAAC;IACrC,OAAO,EAAE,kBAAkB,CAAC,WAAW,CAAC,CAAC;CAC1C,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,kBAAkB,CAAC,SAAS,CAAC,CAAC;CACxC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,0CAA0C,GAAG;IACvD,IAAI,EAAE,uCAAuC,CAAC;IAC9C,OAAO,EAAE,kBAAkB,CAAC,oBAAoB,CAAC,CAAC;CACnD,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,mCAAmC,GAAG;IAChD,IAAI,EAAE,gCAAgC,CAAC;IACvC,OAAO,EAAE,kBAAkB,CAAC,aAAa,CAAC,CAAC;CAC5C,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,8BAA8B,CAAC;IACrC,OAAO,EAAE,kBAAkB,CAAC,WAAW,CAAC,CAAC;CAC1C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACvC,kCAAkC,GAClC,iDAAiD,GACjD,2BAA2B,GAC3B,2BAA2B,GAC3B,wCAAwC,GACxC,6CAA6C,GAC7C,kCAAkC,GAClC,qCAAqC,GACrC,qCAAqC,GACrC,qCAAqC,GACrC,0CAA0C,GAC1C,iCAAiC,GACjC,+BAA+B,GAC/B,0CAA0C,GAC1C,mCAAmC,GACnC,iCAAiC,CAAC"}

package/dist/ApprovalController-method-action-types.d.mts

@@ -0,0 +1,240 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+import type { ApprovalController } from "./ApprovalController.mjs";
+/**
+ * Adds an approval request per the given arguments, optionally showing
+ * the approval request to the user.
+ *
+ * @param opts - Options bag.
+ * @param opts.id - The id of the approval request. A random id will be
+ * generated if none is provided.
+ * @param opts.origin - The origin of the approval request.
+ * @param opts.type - The type associated with the approval request.
+ * @param opts.requestData - Additional data associated with the request,
+ * if any.
+ * @param opts.requestState - Additional state associated with the request,
+ * if any.
+ * @param shouldShowRequest - Whether to show the approval request to the user.
+ * @returns The approval promise.
+ */
+export type ApprovalControllerAddRequestAction = {
+    type: `ApprovalController:addRequest`;
+    handler: ApprovalController['addRequest'];
+};
+/**
+ * Adds an approval request per the given arguments, calls the show approval
+ * request function, and returns the associated approval promise resolving to
+ * an AddResult object.
+ *
+ * There can only be one approval per origin and type. An error is thrown if
+ * attempting to add an invalid or duplicate request.
+ *
+ * @param opts - Options bag.
+ * @param opts.id - The id of the approval request. A random id will be
+ * generated if none is provided.
+ * @param opts.origin - The origin of the approval request.
+ * @param opts.type - The type associated with the approval request.
+ * @param opts.requestData - Additional data associated with the request,
+ * @param opts.requestState - Additional state associated with the request,
+ * if any.
+ * @returns The approval promise resolving to an AddResult object.
+ */
+export type ApprovalControllerAddAndShowApprovalRequestAction = {
+    type: `ApprovalController:addAndShowApprovalRequest`;
+    handler: ApprovalController['addAndShowApprovalRequest'];
+};
+/**
+ * Adds an approval request per the given arguments and returns the approval
+ * promise resolving to an AddResult object.
+ *
+ * There can only be one approval per origin and type. An error is thrown if
+ * attempting to add an invalid or duplicate request.
+ *
+ * @param opts - Options bag.
+ * @param opts.id - The id of the approval request. A random id will be
+ * generated if none is provided.
+ * @param opts.origin - The origin of the approval request.
+ * @param opts.type - The type associated with the approval request.
+ * @param opts.requestData - Additional data associated with the request,
+ * if any.
+ * @returns The approval promise resolving to an AddResult object.
+ */
+export type ApprovalControllerAddAction = {
+    type: `ApprovalController:add`;
+    handler: ApprovalController['add'];
+};
+/**
+ * Gets the info for the approval request with the given id.
+ *
+ * @param id - The id of the approval request.
+ * @returns The approval request data associated with the id.
+ */
+export type ApprovalControllerGetAction = {
+    type: `ApprovalController:get`;
+    handler: ApprovalController['get'];
+};
+/**
+ * Gets the number of pending approvals, by origin and/or type.
+ *
+ * If only `origin` is specified, all approvals for that origin will be
+ * counted, regardless of type.
+ * If only `type` is specified, all approvals for that type will be counted,
+ * regardless of origin.
+ * If both `origin` and `type` are specified, 0 or 1 will be returned.
+ *
+ * @param opts - The approval count options.
+ * @param opts.origin - An approval origin.
+ * @param opts.type - The type of the approval request.
+ * @returns The current approval request count for the given origin and/or
+ * type.
+ */
+export type ApprovalControllerGetApprovalCountAction = {
+    type: `ApprovalController:getApprovalCount`;
+    handler: ApprovalController['getApprovalCount'];
+};
+/**
+ * Get the total count of all pending approval requests for all origins.
+ *
+ * @returns The total pending approval request count.
+ */
+export type ApprovalControllerGetTotalApprovalCountAction = {
+    type: `ApprovalController:getTotalApprovalCount`;
+    handler: ApprovalController['getTotalApprovalCount'];
+};
+/**
+ * Checks if there's a pending approval request per the given parameters.
+ * At least one parameter must be specified. An error will be thrown if the
+ * parameters are invalid.
+ *
+ * If `id` is specified, all other parameters will be ignored.
+ * If `id` is not specified, the method will check for requests that match
+ * all of the specified parameters.
+ *
+ * @param opts - Options bag.
+ * @param opts.id - The ID to check for.
+ * @param opts.origin - The origin to check for.
+ * @param opts.type - The type to check for.
+ * @returns `true` if a matching approval is found, and `false` otherwise.
+ */
+export type ApprovalControllerHasRequestAction = {
+    type: `ApprovalController:hasRequest`;
+    handler: ApprovalController['hasRequest'];
+};
+/**
+ * Resolves the promise of the approval with the given id, and deletes the
+ * approval. Throws an error if no such approval exists.
+ *
+ * @param id - The id of the approval request.
+ * @param value - The value to resolve the approval promise with.
+ * @param options - Options bag.
+ * @returns A promise that either resolves once a result is provided by
+ * the creator of the approval request, or immediately if `options.waitForResult`
+ * is `false` or `undefined`.
+ */
+export type ApprovalControllerAcceptRequestAction = {
+    type: `ApprovalController:acceptRequest`;
+    handler: ApprovalController['acceptRequest'];
+};
+/**
+ * Rejects the promise of the approval with the given id, and deletes the
+ * approval. Throws an error if no such approval exists.
+ *
+ * @param id - The id of the approval request.
+ * @param error - The error to reject the approval promise with.
+ */
+export type ApprovalControllerRejectRequestAction = {
+    type: `ApprovalController:rejectRequest`;
+    handler: ApprovalController['rejectRequest'];
+};
+/**
+ * Rejects and deletes all approval requests.
+ *
+ * @param rejectionError - The JsonRpcError to reject the approval
+ * requests with.
+ */
+export type ApprovalControllerClearRequestsAction = {
+    type: `ApprovalController:clearRequests`;
+    handler: ApprovalController['clearRequests'];
+};
+/**
+ * Updates the request state of the approval with the given id.
+ *
+ * @param opts - Options bag.
+ * @param opts.id - The id of the approval request.
+ * @param opts.requestState - Additional data associated with the request
+ */
+export type ApprovalControllerUpdateRequestStateAction = {
+    type: `ApprovalController:updateRequestState`;
+    handler: ApprovalController['updateRequestState'];
+};
+/**
+ * Starts a new approval flow.
+ *
+ * @param opts - Options bag.
+ * @param opts.id - The id of the approval flow.
+ * @param opts.loadingText - The loading text that will be associated to the approval flow.
+ * @param opts.show - A flag to determine whether the approval should show to the user.
+ * @returns The object containing the approval flow id.
+ */
+export type ApprovalControllerStartFlowAction = {
+    type: `ApprovalController:startFlow`;
+    handler: ApprovalController['startFlow'];
+};
+/**
+ * Ends the current approval flow.
+ *
+ * @param opts - Options bag.
+ * @param opts.id - The id of the approval flow that will be finished.
+ */
+export type ApprovalControllerEndFlowAction = {
+    type: `ApprovalController:endFlow`;
+    handler: ApprovalController['endFlow'];
+};
+/**
+ * Sets the loading text for the approval flow.
+ *
+ * @param opts - Options bag.
+ * @param opts.id - The approval flow loading text that will be displayed.
+ * @param opts.loadingText - The loading text that will be associated to the approval flow.
+ */
+export type ApprovalControllerSetFlowLoadingTextAction = {
+    type: `ApprovalController:setFlowLoadingText`;
+    handler: ApprovalController['setFlowLoadingText'];
+};
+/**
+ * Show a success page.
+ *
+ * @param opts - Options bag.
+ * @param opts.message - The message text or components to display in the page.
+ * @param opts.header - The text or components to display in the header of the page.
+ * @param opts.flowToEnd - The ID of the approval flow to end once the success page is approved.
+ * @param opts.title - The title to display above the message. Shown by default but can be hidden with `null`.
+ * @param opts.icon - The icon to display in the page. Shown by default but can be hidden with `null`.
+ * @returns Empty object to support future additions.
+ */
+export type ApprovalControllerShowSuccessAction = {
+    type: `ApprovalController:showSuccess`;
+    handler: ApprovalController['showSuccess'];
+};
+/**
+ * Show an error page.
+ *
+ * @param opts - Options bag.
+ * @param opts.message - The message text or components to display in the page.
+ * @param opts.header - The text or components to display in the header of the page.
+ * @param opts.flowToEnd - The ID of the approval flow to end once the error page is approved.
+ * @param opts.title - The title to display above the message. Shown by default but can be hidden with `null`.
+ * @param opts.icon - The icon to display in the page. Shown by default but can be hidden with `null`.
+ * @returns Empty object to support future additions.
+ */
+export type ApprovalControllerShowErrorAction = {
+    type: `ApprovalController:showError`;
+    handler: ApprovalController['showError'];
+};
+/**
+ * Union of all ApprovalController action types.
+ */
+export type ApprovalControllerMethodActions = ApprovalControllerAddRequestAction | ApprovalControllerAddAndShowApprovalRequestAction | ApprovalControllerAddAction | ApprovalControllerGetAction | ApprovalControllerGetApprovalCountAction | ApprovalControllerGetTotalApprovalCountAction | ApprovalControllerHasRequestAction | ApprovalControllerAcceptRequestAction | ApprovalControllerRejectRequestAction | ApprovalControllerClearRequestsAction | ApprovalControllerUpdateRequestStateAction | ApprovalControllerStartFlowAction | ApprovalControllerEndFlowAction | ApprovalControllerSetFlowLoadingTextAction | ApprovalControllerShowSuccessAction | ApprovalControllerShowErrorAction;
+//# sourceMappingURL=ApprovalController-method-action-types.d.mts.map

package/dist/ApprovalController-method-action-types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApprovalController-method-action-types.d.mts","sourceRoot":"","sources":["../src/ApprovalController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,kBAAkB,EAAE,iCAA6B;AAE/D;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC/C,IAAI,EAAE,+BAA+B,CAAC;IACtC,OAAO,EAAE,kBAAkB,CAAC,YAAY,CAAC,CAAC;CAC3C,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,iDAAiD,GAAG;IAC9D,IAAI,EAAE,8CAA8C,CAAC;IACrD,OAAO,EAAE,kBAAkB,CAAC,2BAA2B,CAAC,CAAC;CAC1D,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,wBAAwB,CAAC;IAC/B,OAAO,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;CACpC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,wBAAwB,CAAC;IAC/B,OAAO,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;CACpC,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD,IAAI,EAAE,qCAAqC,CAAC;IAC5C,OAAO,EAAE,kBAAkB,CAAC,kBAAkB,CAAC,CAAC;CACjD,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,6CAA6C,GAAG;IAC1D,IAAI,EAAE,0CAA0C,CAAC;IACjD,OAAO,EAAE,kBAAkB,CAAC,uBAAuB,CAAC,CAAC;CACtD,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC/C,IAAI,EAAE,+BAA+B,CAAC;IACtC,OAAO,EAAE,kBAAkB,CAAC,YAAY,CAAC,CAAC;CAC3C,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,EAAE,kCAAkC,CAAC;IACzC,OAAO,EAAE,kBAAkB,CAAC,eAAe,CAAC,CAAC;CAC9C,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,EAAE,kCAAkC,CAAC;IACzC,OAAO,EAAE,kBAAkB,CAAC,eAAe,CAAC,CAAC;CAC9C,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,EAAE,kCAAkC,CAAC;IACzC,OAAO,EAAE,kBAAkB,CAAC,eAAe,CAAC,CAAC;CAC9C,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,0CAA0C,GAAG;IACvD,IAAI,EAAE,uCAAuC,CAAC;IAC9C,OAAO,EAAE,kBAAkB,CAAC,oBAAoB,CAAC,CAAC;CACnD,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,8BAA8B,CAAC;IACrC,OAAO,EAAE,kBAAkB,CAAC,WAAW,CAAC,CAAC;CAC1C,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,kBAAkB,CAAC,SAAS,CAAC,CAAC;CACxC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,0CAA0C,GAAG;IACvD,IAAI,EAAE,uCAAuC,CAAC;IAC9C,OAAO,EAAE,kBAAkB,CAAC,oBAAoB,CAAC,CAAC;CACnD,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,mCAAmC,GAAG;IAChD,IAAI,EAAE,gCAAgC,CAAC;IACvC,OAAO,EAAE,kBAAkB,CAAC,aAAa,CAAC,CAAC;CAC5C,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,8BAA8B,CAAC;IACrC,OAAO,EAAE,kBAAkB,CAAC,WAAW,CAAC,CAAC;CAC1C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACvC,kCAAkC,GAClC,iDAAiD,GACjD,2BAA2B,GAC3B,2BAA2B,GAC3B,wCAAwC,GACxC,6CAA6C,GAC7C,kCAAkC,GAClC,qCAAqC,GACrC,qCAAqC,GACrC,qCAAqC,GACrC,0CAA0C,GAC1C,iCAAiC,GACjC,+BAA+B,GAC/B,0CAA0C,GAC1C,mCAAmC,GACnC,iCAAiC,CAAC"}

package/dist/ApprovalController-method-action-types.mjs

@@ -0,0 +1,6 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+export {};
+//# sourceMappingURL=ApprovalController-method-action-types.mjs.map

package/dist/ApprovalController-method-action-types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApprovalController-method-action-types.mjs","sourceRoot":"","sources":["../src/ApprovalController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { ApprovalController } from './ApprovalController';\n\n/**\n * Adds an approval request per the given arguments, optionally showing\n * the approval request to the user.\n *\n * @param opts - Options bag.\n * @param opts.id - The id of the approval request. A random id will be\n * generated if none is provided.\n * @param opts.origin - The origin of the approval request.\n * @param opts.type - The type associated with the approval request.\n * @param opts.requestData - Additional data associated with the request,\n * if any.\n * @param opts.requestState - Additional state associated with the request,\n * if any.\n * @param shouldShowRequest - Whether to show the approval request to the user.\n * @returns The approval promise.\n */\nexport type ApprovalControllerAddRequestAction = {\n  type: `ApprovalController:addRequest`;\n  handler: ApprovalController['addRequest'];\n};\n\n/**\n * Adds an approval request per the given arguments, calls the show approval\n * request function, and returns the associated approval promise resolving to\n * an AddResult object.\n *\n * There can only be one approval per origin and type. An error is thrown if\n * attempting to add an invalid or duplicate request.\n *\n * @param opts - Options bag.\n * @param opts.id - The id of the approval request. A random id will be\n * generated if none is provided.\n * @param opts.origin - The origin of the approval request.\n * @param opts.type - The type associated with the approval request.\n * @param opts.requestData - Additional data associated with the request,\n * @param opts.requestState - Additional state associated with the request,\n * if any.\n * @returns The approval promise resolving to an AddResult object.\n */\nexport type ApprovalControllerAddAndShowApprovalRequestAction = {\n  type: `ApprovalController:addAndShowApprovalRequest`;\n  handler: ApprovalController['addAndShowApprovalRequest'];\n};\n\n/**\n * Adds an approval request per the given arguments and returns the approval\n * promise resolving to an AddResult object.\n *\n * There can only be one approval per origin and type. An error is thrown if\n * attempting to add an invalid or duplicate request.\n *\n * @param opts - Options bag.\n * @param opts.id - The id of the approval request. A random id will be\n * generated if none is provided.\n * @param opts.origin - The origin of the approval request.\n * @param opts.type - The type associated with the approval request.\n * @param opts.requestData - Additional data associated with the request,\n * if any.\n * @returns The approval promise resolving to an AddResult object.\n */\nexport type ApprovalControllerAddAction = {\n  type: `ApprovalController:add`;\n  handler: ApprovalController['add'];\n};\n\n/**\n * Gets the info for the approval request with the given id.\n *\n * @param id - The id of the approval request.\n * @returns The approval request data associated with the id.\n */\nexport type ApprovalControllerGetAction = {\n  type: `ApprovalController:get`;\n  handler: ApprovalController['get'];\n};\n\n/**\n * Gets the number of pending approvals, by origin and/or type.\n *\n * If only `origin` is specified, all approvals for that origin will be\n * counted, regardless of type.\n * If only `type` is specified, all approvals for that type will be counted,\n * regardless of origin.\n * If both `origin` and `type` are specified, 0 or 1 will be returned.\n *\n * @param opts - The approval count options.\n * @param opts.origin - An approval origin.\n * @param opts.type - The type of the approval request.\n * @returns The current approval request count for the given origin and/or\n * type.\n */\nexport type ApprovalControllerGetApprovalCountAction = {\n  type: `ApprovalController:getApprovalCount`;\n  handler: ApprovalController['getApprovalCount'];\n};\n\n/**\n * Get the total count of all pending approval requests for all origins.\n *\n * @returns The total pending approval request count.\n */\nexport type ApprovalControllerGetTotalApprovalCountAction = {\n  type: `ApprovalController:getTotalApprovalCount`;\n  handler: ApprovalController['getTotalApprovalCount'];\n};\n\n/**\n * Checks if there's a pending approval request per the given parameters.\n * At least one parameter must be specified. An error will be thrown if the\n * parameters are invalid.\n *\n * If `id` is specified, all other parameters will be ignored.\n * If `id` is not specified, the method will check for requests that match\n * all of the specified parameters.\n *\n * @param opts - Options bag.\n * @param opts.id - The ID to check for.\n * @param opts.origin - The origin to check for.\n * @param opts.type - The type to check for.\n * @returns `true` if a matching approval is found, and `false` otherwise.\n */\nexport type ApprovalControllerHasRequestAction = {\n  type: `ApprovalController:hasRequest`;\n  handler: ApprovalController['hasRequest'];\n};\n\n/**\n * Resolves the promise of the approval with the given id, and deletes the\n * approval. Throws an error if no such approval exists.\n *\n * @param id - The id of the approval request.\n * @param value - The value to resolve the approval promise with.\n * @param options - Options bag.\n * @returns A promise that either resolves once a result is provided by\n * the creator of the approval request, or immediately if `options.waitForResult`\n * is `false` or `undefined`.\n */\nexport type ApprovalControllerAcceptRequestAction = {\n  type: `ApprovalController:acceptRequest`;\n  handler: ApprovalController['acceptRequest'];\n};\n\n/**\n * Rejects the promise of the approval with the given id, and deletes the\n * approval. Throws an error if no such approval exists.\n *\n * @param id - The id of the approval request.\n * @param error - The error to reject the approval promise with.\n */\nexport type ApprovalControllerRejectRequestAction = {\n  type: `ApprovalController:rejectRequest`;\n  handler: ApprovalController['rejectRequest'];\n};\n\n/**\n * Rejects and deletes all approval requests.\n *\n * @param rejectionError - The JsonRpcError to reject the approval\n * requests with.\n */\nexport type ApprovalControllerClearRequestsAction = {\n  type: `ApprovalController:clearRequests`;\n  handler: ApprovalController['clearRequests'];\n};\n\n/**\n * Updates the request state of the approval with the given id.\n *\n * @param opts - Options bag.\n * @param opts.id - The id of the approval request.\n * @param opts.requestState - Additional data associated with the request\n */\nexport type ApprovalControllerUpdateRequestStateAction = {\n  type: `ApprovalController:updateRequestState`;\n  handler: ApprovalController['updateRequestState'];\n};\n\n/**\n * Starts a new approval flow.\n *\n * @param opts - Options bag.\n * @param opts.id - The id of the approval flow.\n * @param opts.loadingText - The loading text that will be associated to the approval flow.\n * @param opts.show - A flag to determine whether the approval should show to the user.\n * @returns The object containing the approval flow id.\n */\nexport type ApprovalControllerStartFlowAction = {\n  type: `ApprovalController:startFlow`;\n  handler: ApprovalController['startFlow'];\n};\n\n/**\n * Ends the current approval flow.\n *\n * @param opts - Options bag.\n * @param opts.id - The id of the approval flow that will be finished.\n */\nexport type ApprovalControllerEndFlowAction = {\n  type: `ApprovalController:endFlow`;\n  handler: ApprovalController['endFlow'];\n};\n\n/**\n * Sets the loading text for the approval flow.\n *\n * @param opts - Options bag.\n * @param opts.id - The approval flow loading text that will be displayed.\n * @param opts.loadingText - The loading text that will be associated to the approval flow.\n */\nexport type ApprovalControllerSetFlowLoadingTextAction = {\n  type: `ApprovalController:setFlowLoadingText`;\n  handler: ApprovalController['setFlowLoadingText'];\n};\n\n/**\n * Show a success page.\n *\n * @param opts - Options bag.\n * @param opts.message - The message text or components to display in the page.\n * @param opts.header - The text or components to display in the header of the page.\n * @param opts.flowToEnd - The ID of the approval flow to end once the success page is approved.\n * @param opts.title - The title to display above the message. Shown by default but can be hidden with `null`.\n * @param opts.icon - The icon to display in the page. Shown by default but can be hidden with `null`.\n * @returns Empty object to support future additions.\n */\nexport type ApprovalControllerShowSuccessAction = {\n  type: `ApprovalController:showSuccess`;\n  handler: ApprovalController['showSuccess'];\n};\n\n/**\n * Show an error page.\n *\n * @param opts - Options bag.\n * @param opts.message - The message text or components to display in the page.\n * @param opts.header - The text or components to display in the header of the page.\n * @param opts.flowToEnd - The ID of the approval flow to end once the error page is approved.\n * @param opts.title - The title to display above the message. Shown by default but can be hidden with `null`.\n * @param opts.icon - The icon to display in the page. Shown by default but can be hidden with `null`.\n * @returns Empty object to support future additions.\n */\nexport type ApprovalControllerShowErrorAction = {\n  type: `ApprovalController:showError`;\n  handler: ApprovalController['showError'];\n};\n\n/**\n * Union of all ApprovalController action types.\n */\nexport type ApprovalControllerMethodActions =\n  | ApprovalControllerAddRequestAction\n  | ApprovalControllerAddAndShowApprovalRequestAction\n  | ApprovalControllerAddAction\n  | ApprovalControllerGetAction\n  | ApprovalControllerGetApprovalCountAction\n  | ApprovalControllerGetTotalApprovalCountAction\n  | ApprovalControllerHasRequestAction\n  | ApprovalControllerAcceptRequestAction\n  | ApprovalControllerRejectRequestAction\n  | ApprovalControllerClearRequestsAction\n  | ApprovalControllerUpdateRequestStateAction\n  | ApprovalControllerStartFlowAction\n  | ApprovalControllerEndFlowAction\n  | ApprovalControllerSetFlowLoadingTextAction\n  | ApprovalControllerShowSuccessAction\n  | ApprovalControllerShowErrorAction;\n"]}