@arcjet/analyze/dist/index.js

Arcjet local analysis engine

import { initializeWasm } from "@arcjet/analyze-wasm";
//#region src/index.ts
const FREE_EMAIL_PROVIDERS = [
	"gmail.com",
	"yahoo.com",
	"hotmail.com",
	"aol.com",
	"hotmail.co.uk"
];
function noOpSensitiveInfoDetect() {
	return [];
}
function noOpBotsDetect() {
	return [];
}
function createCoreImports(detect) {
	if (typeof detect !== "function") detect = noOpSensitiveInfoDetect;
	return {
		"arcjet:js-req/bot-identifier": { detect: noOpBotsDetect },
		"arcjet:js-req/email-validator-overrides": {
			isFreeEmail(domain) {
				if (FREE_EMAIL_PROVIDERS.includes(domain)) return "yes";
				return "unknown";
			},
			isDisposableEmail() {
				return "unknown";
			},
			hasMxRecords() {
				return "unknown";
			},
			hasGravatar() {
				return "unknown";
			}
		},
		"arcjet:js-req/filter-overrides": { ipLookup() {} },
		"arcjet:js-req/sensitive-information-identifier": { detect },
		"arcjet:js-req/verify-bot": { verify() {
			return "unverifiable";
		} }
	};
}
/**
* Generate a fingerprint.
*
* Fingerprints can be used to identify the client across multiple requests.
*
* This considers different things on the `request` based on the passed
* `context.characteristics`.
*
* See [*Fingerprints* on
* `docs.arcjet.com`](https://docs.arcjet.com/fingerprints/) for more info.
*
* @param context
*   Context.
* @param request
*   Request.
* @returns
*   Promise for a SHA-256 fingerprint.
*/
async function generateFingerprint(context, request) {
	const { log } = context;
	const analyze = await initializeWasm(createCoreImports());
	if (typeof analyze !== "undefined") return analyze.generateFingerprint(JSON.stringify(request), context.characteristics);
	log.debug("WebAssembly is not supported in this runtime");
	return "";
}
/**
* Check whether an email is valid.
*
* @param context
*   Context.
* @param value
*   Value.
* @param options
*   Configuration.
* @returns
*   Promise for a result.
*/
async function isValidEmail(context, value, options) {
	const { log } = context;
	const analyze = await initializeWasm(createCoreImports());
	if (typeof analyze !== "undefined") return analyze.isValidEmail(value, options);
	log.debug("WebAssembly is not supported in this runtime");
	return {
		blocked: [],
		validity: "valid"
	};
}
/**
* Detect whether a request is by a bot.
*
* @param context
*   Context.
* @param request
*   Request.
* @param options
*   Configuration.
* @returns
*   Promise for a result.
*/
async function detectBot(context, request, options) {
	const { log } = context;
	const analyze = await initializeWasm(createCoreImports());
	if (typeof analyze !== "undefined") return analyze.detectBot(JSON.stringify(request), options);
	log.debug("WebAssembly is not supported in this runtime");
	return {
		allowed: [],
		denied: [],
		spoofed: false,
		verified: false
	};
}
/**
* Detect sensitive info in a value.
*
* @param context
*   Context.
* @param value
*   Value.
* @param entities
*   Strategy to use for detecting sensitive info;
*   either by denying everything and allowing certain tags or by allowing
*   everything and denying certain tags.
* @param contextWindowSize
*   Number of tokens to pass to `detect`.
* @param detect
*   Function to detect sensitive info (optional).
* @returns
*   Promise for a result.
*/
async function detectSensitiveInfo(context, value, entities, contextWindowSize, detect) {
	const { log } = context;
	const analyze = await initializeWasm(createCoreImports(detect));
	if (typeof analyze !== "undefined") {
		const skipCustomDetect = typeof detect !== "function";
		return analyze.detectSensitiveInfo(value, {
			entities,
			contextWindowSize,
			skipCustomDetect
		});
	}
	log.debug("WebAssembly is not supported in this runtime");
	throw new Error("SENSITIVE_INFO rule failed to run because Wasm is not supported in this environment.");
}
/**
* Check if a filter matches a request.
*
* @param context
*   Arcjet context.
* @param request
*   Request.
* @param localFields
*   Fields to use as `local` in the expressions, as serialized JSON.
* @param expressions
*   Filter expressions.
* @returns
*   Promise to whether the filter matches the request.
*/
async function matchFilters(context, request, localFields, expressions, allowIfMatch) {
	const analyze = await initializeWasm(createCoreImports());
	if (typeof analyze !== "undefined") return analyze.matchFilters(JSON.stringify(request), localFields, expressions, allowIfMatch);
	context.log.debug("WebAssembly is not supported in this runtime");
	throw new Error("FILTER rule failed to run because Wasm is not supported in this environment.");
}
//#endregion
export { detectBot, detectSensitiveInfo, generateFingerprint, isValidEmail, matchFilters };