@arcjet/analyze

@arcjet/analyze

Arcjet helps developers protect their apps. Installed as an SDK, it provides a set of core primitives such as rate limiting and bot protection. These can be used independently or combined to create a set of layered defenses, such as signup form protection.

This is the Arcjet local analysis engine.

Installation

npm install -S @arcjet/analyze

Example

import { generateFingerprint, isValidEmail } from "@arcjet/analyze";

const fingerprint = generateFingerprint("127.0.0.1");
console.log("fingerprint: ", fingerprint);

const valid = isValidEmail("[e-mail]");
console.log("is email valid?", valid);

Implementation

This package provides analyze logic implemented as a WebAssembly module which will run local analysis on request details before calling the Arcjet API.

The arcjet.wasm.js file contains the binary inlined as a base64 Data URL with the application/wasm MIME type.

This was chosen to save on storage space over inlining the file directly as a Uint8Array, which would take up ~3x the space of the Wasm file. See Better Binary Batter: Mixing Base64 and Uint8Array for more details.

It is then decoded into an ArrayBuffer to be used directly via WebAssembly's compile() function in our entry point file.

This is all done to avoid trying to read or bundle the Wasm asset in various ways based on the platform or bundler a user is targeting. One example being that Next.js requires special asyncWebAssembly webpack config to load our Wasm file if we don't do this.

In the future, we hope to do away with this workaround when all bundlers properly support consistent asset bundling techniques.

API

In progress.

License

Licensed under the Apache License, Version 2.0.

Changelog

1.0.0-alpha.7 (2023-12-21)

⚠ BREAKING CHANGES

• Reorganize SDK types to tighten helpers around custom props (#18)

🪲 Bug Fixes

• Reorganize SDK types to tighten helpers around custom props (#18) (3b0c1fb)

📦 Dependencies

• dev: Bump the dev-dependencies group with 5 updates (#82) (a67be47)

✅ Continuous Integration

• Switch to github token (#81) (cfc382a)