@metamask/snaps-rpc-methods/dist/permitted/trackEvent.mjs

MetaMask Snaps JSON-RPC method implementations

import { rpcErrors } from "@metamask/rpc-errors";
import { create, object, optional, record, refine, string, StructError } from "@metamask/superstruct";
import { JsonStruct } from "@metamask/utils";
const PropertiesStruct = optional(record(string(), JsonStruct));
const snakeCaseRegex = /^[a-z][a-z0-9]*(?:_[a-z0-9]+)*$/u;
const SnakeCasePropertiesStruct = refine(PropertiesStruct, 'snake_case_keys', (value) => {
    if (!value) {
        return true;
    }
    return Object.keys(value).every((key) => snakeCaseRegex.test(key));
});
const hookNames = {
    trackEvent: true,
};
const TrackEventParametersStruct = object({
    event: object({
        event: string(),
        properties: SnakeCasePropertiesStruct,
        sensitiveProperties: SnakeCasePropertiesStruct,
    }),
});
/**
 * Handler for the `snap_trackEvent` method.
 *
 * @internal
 */
export const trackEventHandler = {
    implementation: getTrackEventImplementation,
    hookNames,
    actionNames: ['SnapController:getSnap'],
};
/**
 * The `snap_trackEvent` method implementation.
 * This method allows pre-installed Snaps to submit tracking events to the client.
 *
 * @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.trackEvent - The function to track the event.
 * @param messenger - The messenger used to call controller actions.
 * @returns Nothing.
 */
function getTrackEventImplementation(req, res, _next, end, { trackEvent }, messenger) {
    const snap = messenger.call('SnapController:getSnap', req.origin);
    if (!snap?.preinstalled) {
        return end(rpcErrors.methodNotFound());
    }
    const { params } = req;
    try {
        const validatedParams = getValidatedParams(params);
        trackEvent(validatedParams.event);
        res.result = null;
    }
    catch (error) {
        return end(error);
    }
    return end();
}
/**
 * Validates the parameters for the snap_trackEvent method.
 *
 * @param params - Parameters to validate.
 * @returns Validated parameters.
 * @throws Throws RPC error if validation fails.
 */
function getValidatedParams(params) {
    try {
        return create(params, TrackEventParametersStruct);
    }
    catch (error) {
        if (error instanceof StructError) {
            if (error.refinement === 'snake_case_keys') {
                throw rpcErrors.invalidParams({
                    message: `Invalid params: All property keys must be in snake_case format. The following key contains invalid properties: "${error.key}".`,
                });
            }
            throw rpcErrors.invalidParams({
                message: `Invalid params: ${error.message}.`,
            });
        }
        /* istanbul ignore next */
        throw rpcErrors.internal();
    }
}
//# sourceMappingURL=trackEvent.mjs.map