@metamask/snaps-rpc-methods
Version:
MetaMask Snaps JSON-RPC method implementations
90 lines • 3.62 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.messengerCaveatSpecifications = exports.getMessengerCaveatActions = exports.getMessengerCaveatMapper = exports.messengerEndowmentBuilder = void 0;
const permission_controller_1 = require("@metamask/permission-controller");
const rpc_errors_1 = require("@metamask/rpc-errors");
const snaps_utils_1 = require("@metamask/snaps-utils");
const utils_1 = require("@metamask/utils");
const caveats_1 = require("./caveats/index.cjs");
const enum_1 = require("./enum.cjs");
const permissionName = enum_1.SnapEndowments.Messenger;
/**
* `endowment:messenger` returns nothing; it is intended to be used as a
* flag by the Snaps Platform to detect whether a Snap has the capability to
* use the messenger API.
*
* @param _builderOptions - Optional specification builder options.
* @returns The specification for the messenger endowment.
*/
const specificationBuilder = (_builderOptions) => {
return {
permissionType: permission_controller_1.PermissionType.Endowment,
targetName: permissionName,
allowedCaveats: [snaps_utils_1.SnapCaveatType.MessengerScopes],
endowmentGetter: (_getterOptions) => null,
validator: (0, caveats_1.createGenericPermissionValidator)([
{ type: snaps_utils_1.SnapCaveatType.MessengerScopes },
]),
subjectTypes: [permission_controller_1.SubjectType.Snap],
};
};
exports.messengerEndowmentBuilder = Object.freeze({
targetName: permissionName,
specificationBuilder,
});
/**
* Map a raw value from the `initialPermissions` to a caveat specification.
* Note that this function does not do any validation, that's handled by the
* PermissionsController when the permission is requested.
*
* @param value - The raw value from the `initialPermissions`.
* @returns The caveat specification.
*/
function getMessengerCaveatMapper(value) {
if (!value || !(0, utils_1.isObject)(value) || Object.keys(value).length === 0) {
return { caveats: null };
}
return {
caveats: [
{
type: snaps_utils_1.SnapCaveatType.MessengerScopes,
value,
},
],
};
}
exports.getMessengerCaveatMapper = getMessengerCaveatMapper;
/**
* Getter function to get the {@link MessengerActions} caveat value from a
* permission.
*
* @param permission - The permission to get the caveat value from.
* @returns The caveat value.
*/
function getMessengerCaveatActions(permission) {
const caveat = permission?.caveats?.find((permCaveat) => permCaveat.type === snaps_utils_1.SnapCaveatType.MessengerScopes);
return caveat?.value.actions ? caveat.value.actions : null;
}
exports.getMessengerCaveatActions = getMessengerCaveatActions;
/**
* Validates the type of the caveat value.
*
* @param caveat - The caveat to validate.
* @throws If the caveat value is invalid.
*/
function validateCaveat(caveat) {
if (!(0, utils_1.hasProperty)(caveat, 'value') || !(0, utils_1.isObject)(caveat)) {
throw rpc_errors_1.rpcErrors.invalidParams({
message: 'Expected an object.',
});
}
const { value } = caveat;
(0, utils_1.assertStruct)(value, snaps_utils_1.MessengerScopesStruct, 'Invalid messenger scopes specified', rpc_errors_1.rpcErrors.invalidParams);
}
exports.messengerCaveatSpecifications = {
[snaps_utils_1.SnapCaveatType.MessengerScopes]: Object.freeze({
type: snaps_utils_1.SnapCaveatType.MessengerScopes,
validator: (caveat) => validateCaveat(caveat),
}),
};
//# sourceMappingURL=messenger.cjs.map