@arcjet/analyze-wasm 1.0.0-beta.1

package/_virtual/arcjet_analyze_js_req.component.core2.js

@@ -0,0 +1,42 @@
+// @generated by wasm2module - DO NOT EDIT
+/* eslint-disable */
+// @ts-nocheck
+
+/**
+ * This file contains an Arcjet Wasm binary inlined as a base64
+ * [Data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs)
+ * 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
+ * https://blobfolio.com/2019/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.
+ */
+
+const wasmBase64 = "data:application/wasm;base64,AGFzbQEAAAABFQNgBH9/f38Bf2ACf38Bf2ADf39/AAMHBgABAQEBAgQFAXABBgYHJAcBMAAAATEAAQEyAAIBMwADATQABAE1AAUIJGltcG9ydHMBAApPBg8AIAAgASACIANBABEAAAsLACAAIAFBAREBAAsLACAAIAFBAhEBAAsLACAAIAFBAxEBAAsLACAAIAFBBBEBAAsNACAAIAEgAkEFEQIACwAvCXByb2R1Y2VycwEMcHJvY2Vzc2VkLWJ5AQ13aXQtY29tcG9uZW50BzAuMjE5LjEAjgMEbmFtZQATEndpdC1jb21wb25lbnQ6c2hpbQHxAgYAKGluZGlyZWN0LWFyY2pldDpqcy1yZXEvdmVyaWZ5LWJvdC12ZXJpZnkBPmluZGlyZWN0LWFyY2pldDpqcy1yZXEvZW1haWwtdmFsaWRhdG9yLW92ZXJyaWRlcy1pcy1mcmVlLWVtYWlsAkRpbmRpcmVjdC1hcmNqZXQ6anMtcmVxL2VtYWlsLXZhbGlkYXRvci1vdmVycmlkZXMtaXMtZGlzcG9zYWJsZS1lbWFpbAM/aW5kaXJlY3QtYXJjamV0OmpzLXJlcS9lbWFpbC12YWxpZGF0b3Itb3ZlcnJpZGVzLWhhcy1teC1yZWNvcmRzBD1pbmRpcmVjdC1hcmNqZXQ6anMtcmVxL2VtYWlsLXZhbGlkYXRvci1vdmVycmlkZXMtaGFzLWdyYXZhdGFyBT5pbmRpcmVjdC1hcmNqZXQ6anMtcmVxL3NlbnNpdGl2ZS1pbmZvcm1hdGlvbi1pZGVudGlmaWVyLWRldGVjdA==";
+/**
+ * Returns a WebAssembly.Module for an Arcjet Wasm binary, decoded from a base64
+ * Data URL.
+ */
+// TODO: Switch back to top-level await when our platforms all support it
+async function wasm() {
+  // This uses fetch to decode the wasm data url, but disabling cache so files
+  // larger than 2mb don't fail to parse in the Next.js App Router
+  const wasmDecode = await fetch(wasmBase64, { cache: "no-store" });
+  const buf = await wasmDecode.arrayBuffer();
+  // And then we return it as a WebAssembly.Module
+  return WebAssembly.compile(buf);
+}
+
+export { wasm };

package/_virtual/arcjet_analyze_js_req.component.core3.js

@@ -0,0 +1,42 @@
+// @generated by wasm2module - DO NOT EDIT
+/* eslint-disable */
+// @ts-nocheck
+
+/**
+ * This file contains an Arcjet Wasm binary inlined as a base64
+ * [Data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs)
+ * 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
+ * https://blobfolio.com/2019/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.
+ */
+
+const wasmBase64 = "data:application/wasm;base64,AGFzbQEAAAABFQNgBH9/f38Bf2ACf38Bf2ADf39/AAIuBwABMAAAAAExAAEAATIAAQABMwABAAE0AAEAATUAAgAIJGltcG9ydHMBcAEGBgkMAQBBAAsGAAECAwQFAC8JcHJvZHVjZXJzAQxwcm9jZXNzZWQtYnkBDXdpdC1jb21wb25lbnQHMC4yMTkuMQAcBG5hbWUAFRR3aXQtY29tcG9uZW50OmZpeHVwcw==";
+/**
+ * Returns a WebAssembly.Module for an Arcjet Wasm binary, decoded from a base64
+ * Data URL.
+ */
+// TODO: Switch back to top-level await when our platforms all support it
+async function wasm() {
+  // This uses fetch to decode the wasm data url, but disabling cache so files
+  // larger than 2mb don't fail to parse in the Next.js App Router
+  const wasmDecode = await fetch(wasmBase64, { cache: "no-store" });
+  const buf = await wasmDecode.arrayBuffer();
+  // And then we return it as a WebAssembly.Module
+  return WebAssembly.compile(buf);
+}
+
+export { wasm };

package/edge-light.d.ts

@@ -0,0 +1,5 @@
+import type { ImportObject, DetectedSensitiveInfoEntity, SensitiveInfoEntity, BotConfig, EmailValidationResult, BotResult, SensitiveInfoResult, EmailValidationConfig, SensitiveInfoEntities } from "./wasm/arcjet_analyze_js_req.component.js";
+import type { ArcjetJsReqSensitiveInformationIdentifier } from "./wasm/interfaces/arcjet-js-req-sensitive-information-identifier.js";
+type DetectSensitiveInfoFunction = typeof ArcjetJsReqSensitiveInformationIdentifier.detect;
+export declare function initializeWasm(coreImports: ImportObject): Promise<import("./wasm/arcjet_analyze_js_req.component.js").Root | undefined>;
+export { type BotConfig, type DetectedSensitiveInfoEntity, type SensitiveInfoEntity, type EmailValidationConfig, type EmailValidationResult, type BotResult, type SensitiveInfoResult, type SensitiveInfoEntities, type DetectSensitiveInfoFunction, type ImportObject, };

package/edge-light.js

@@ -0,0 +1,27 @@
+import { instantiate } from './wasm/arcjet_analyze_js_req.component.js';
+import componentCoreWasm from './wasm/arcjet_analyze_js_req.component.core.wasm?module';
+import componentCore2Wasm from './wasm/arcjet_analyze_js_req.component.core2.wasm?module';
+import componentCore3Wasm from './wasm/arcjet_analyze_js_req.component.core3.wasm?module';
+
+async function moduleFromPath(path) {
+    if (path === "arcjet_analyze_js_req.component.core.wasm") {
+        return componentCoreWasm;
+    }
+    if (path === "arcjet_analyze_js_req.component.core2.wasm") {
+        return componentCore2Wasm;
+    }
+    if (path === "arcjet_analyze_js_req.component.core3.wasm") {
+        return componentCore3Wasm;
+    }
+    throw new Error(`Unknown path: ${path}`);
+}
+async function initializeWasm(coreImports) {
+    try {
+        return instantiate(moduleFromPath, coreImports);
+    }
+    catch {
+        return undefined;
+    }
+}
+
+export { initializeWasm };

package/edge-light.ts

@@ -0,0 +1,55 @@
+import { instantiate } from "./wasm/arcjet_analyze_js_req.component.js";
+import type {
+  ImportObject,
+  DetectedSensitiveInfoEntity,
+  SensitiveInfoEntity,
+  BotConfig,
+  EmailValidationResult,
+  BotResult,
+  SensitiveInfoResult,
+  EmailValidationConfig,
+  SensitiveInfoEntities,
+} from "./wasm/arcjet_analyze_js_req.component.js";
+import type { ArcjetJsReqSensitiveInformationIdentifier } from "./wasm/interfaces/arcjet-js-req-sensitive-information-identifier.js";
+
+import componentCoreWasm from "./wasm/arcjet_analyze_js_req.component.core.wasm?module";
+import componentCore2Wasm from "./wasm/arcjet_analyze_js_req.component.core2.wasm?module";
+import componentCore3Wasm from "./wasm/arcjet_analyze_js_req.component.core3.wasm?module";
+
+type DetectSensitiveInfoFunction =
+  typeof ArcjetJsReqSensitiveInformationIdentifier.detect;
+
+async function moduleFromPath(path: string): Promise<WebAssembly.Module> {
+  if (path === "arcjet_analyze_js_req.component.core.wasm") {
+    return componentCoreWasm;
+  }
+  if (path === "arcjet_analyze_js_req.component.core2.wasm") {
+    return componentCore2Wasm;
+  }
+  if (path === "arcjet_analyze_js_req.component.core3.wasm") {
+    return componentCore3Wasm;
+  }
+
+  throw new Error(`Unknown path: ${path}`);
+}
+
+export async function initializeWasm(coreImports: ImportObject) {
+  try {
+    return instantiate(moduleFromPath, coreImports);
+  } catch {
+    return undefined;
+  }
+}
+
+export {
+  type BotConfig,
+  type DetectedSensitiveInfoEntity,
+  type SensitiveInfoEntity,
+  type EmailValidationConfig,
+  type EmailValidationResult,
+  type BotResult,
+  type SensitiveInfoResult,
+  type SensitiveInfoEntities,
+  type DetectSensitiveInfoFunction,
+  type ImportObject,
+};

package/index.d.ts

@@ -0,0 +1,5 @@
+import type { ImportObject, BotConfig, DetectedSensitiveInfoEntity, SensitiveInfoEntity, EmailValidationResult, BotResult, SensitiveInfoResult, EmailValidationConfig, SensitiveInfoEntities } from "./wasm/arcjet_analyze_js_req.component.js";
+import type { ArcjetJsReqSensitiveInformationIdentifier } from "./wasm/interfaces/arcjet-js-req-sensitive-information-identifier.js";
+type DetectSensitiveInfoFunction = typeof ArcjetJsReqSensitiveInformationIdentifier.detect;
+export declare function initializeWasm(coreImports: ImportObject): Promise<import("./wasm/arcjet_analyze_js_req.component.js").Root | undefined>;
+export { type BotConfig, type DetectedSensitiveInfoEntity, type SensitiveInfoEntity, type EmailValidationConfig, type EmailValidationResult, type BotResult, type SensitiveInfoResult, type SensitiveInfoEntities, type DetectSensitiveInfoFunction, type ImportObject, };

package/index.js

@@ -0,0 +1,31 @@
+import { instantiate } from './wasm/arcjet_analyze_js_req.component.js';
+import { wasm } from './_virtual/arcjet_analyze_js_req.component.core.js';
+import { wasm as wasm$1 } from './_virtual/arcjet_analyze_js_req.component.core2.js';
+import { wasm as wasm$2 } from './_virtual/arcjet_analyze_js_req.component.core3.js';
+
+const componentCoreWasmPromise = wasm();
+const componentCore2WasmPromise = wasm$1();
+const componentCore3WasmPromise = wasm$2();
+async function moduleFromPath(path) {
+    if (path === "arcjet_analyze_js_req.component.core.wasm") {
+        return componentCoreWasmPromise;
+    }
+    if (path === "arcjet_analyze_js_req.component.core2.wasm") {
+        return componentCore2WasmPromise;
+    }
+    if (path === "arcjet_analyze_js_req.component.core3.wasm") {
+        return componentCore3WasmPromise;
+    }
+    throw new Error(`Unknown path: ${path}`);
+}
+async function initializeWasm(coreImports) {
+    try {
+        // Await the instantiation to catch the failure
+        return instantiate(moduleFromPath, coreImports);
+    }
+    catch {
+        return undefined;
+    }
+}
+
+export { initializeWasm };

package/index.ts

@@ -0,0 +1,60 @@
+import { instantiate } from "./wasm/arcjet_analyze_js_req.component.js";
+import type {
+  ImportObject,
+  BotConfig,
+  DetectedSensitiveInfoEntity,
+  SensitiveInfoEntity,
+  EmailValidationResult,
+  BotResult,
+  SensitiveInfoResult,
+  EmailValidationConfig,
+  SensitiveInfoEntities,
+} from "./wasm/arcjet_analyze_js_req.component.js";
+import type { ArcjetJsReqSensitiveInformationIdentifier } from "./wasm/interfaces/arcjet-js-req-sensitive-information-identifier.js";
+
+import { wasm as componentCoreWasm } from "./wasm/arcjet_analyze_js_req.component.core.wasm?js";
+import { wasm as componentCore2Wasm } from "./wasm/arcjet_analyze_js_req.component.core2.wasm?js";
+import { wasm as componentCore3Wasm } from "./wasm/arcjet_analyze_js_req.component.core3.wasm?js";
+
+type DetectSensitiveInfoFunction =
+  typeof ArcjetJsReqSensitiveInformationIdentifier.detect;
+
+const componentCoreWasmPromise = componentCoreWasm();
+const componentCore2WasmPromise = componentCore2Wasm();
+const componentCore3WasmPromise = componentCore3Wasm();
+
+async function moduleFromPath(path: string): Promise<WebAssembly.Module> {
+  if (path === "arcjet_analyze_js_req.component.core.wasm") {
+    return componentCoreWasmPromise;
+  }
+  if (path === "arcjet_analyze_js_req.component.core2.wasm") {
+    return componentCore2WasmPromise;
+  }
+  if (path === "arcjet_analyze_js_req.component.core3.wasm") {
+    return componentCore3WasmPromise;
+  }
+
+  throw new Error(`Unknown path: ${path}`);
+}
+
+export async function initializeWasm(coreImports: ImportObject) {
+  try {
+    // Await the instantiation to catch the failure
+    return instantiate(moduleFromPath, coreImports);
+  } catch {
+    return undefined;
+  }
+}
+
+export {
+  type BotConfig,
+  type DetectedSensitiveInfoEntity,
+  type SensitiveInfoEntity,
+  type EmailValidationConfig,
+  type EmailValidationResult,
+  type BotResult,
+  type SensitiveInfoResult,
+  type SensitiveInfoEntities,
+  type DetectSensitiveInfoFunction,
+  type ImportObject,
+};

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@arcjet/analyze-wasm",
+  "version": "1.0.0-beta.1",
+  "description": "WebAssembly bindings to Arcjet's local analysis engine",
+  "license": "Apache-2.0",
+  "homepage": "https://arcjet.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/arcjet/arcjet-js.git",
+    "directory": "analyze-wasm"
+  },
+  "bugs": {
+    "url": "https://github.com/arcjet/arcjet-js/issues",
+    "email": "support@arcjet.com"
+  },
+  "author": {
+    "name": "Arcjet",
+    "email": "support@arcjet.com",
+    "url": "https://arcjet.com"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "type": "module",
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    "edge-light": "./edge-light.js",
+    "workerd": "./workerd.js",
+    "default": "./index.js"
+  },
+  "files": [
+    "LICENSE",
+    "README.md",
+    "_virtual/",
+    "wasm/",
+    "*.js",
+    "*.d.ts",
+    "*.ts",
+    "!*.config.js"
+  ],
+  "scripts": {
+    "prepublishOnly": "npm run build",
+    "jco": "jco transpile wasm/arcjet_analyze_js_req.component.wasm --no-wasi-shim --instantiation async -o wasm",
+    "build": "npm run jco; rollup --config rollup.config.js",
+    "lint": "eslint .",
+    "pretest": "npm run build",
+    "test": "node --test"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "@arcjet/eslint-config": "1.0.0-beta.1",
+    "@arcjet/rollup-config": "1.0.0-beta.1",
+    "@arcjet/tsconfig": "1.0.0-beta.1",
+    "@bytecodealliance/jco": "1.5.0",
+    "@rollup/wasm-node": "4.30.1",
+    "@types/node": "18.18.0",
+    "expect": "29.7.0",
+    "typescript": "5.7.3"
+  },
+  "publishConfig": {
+    "access": "public",
+    "tag": "latest"
+  }
+}

package/wasm/arcjet_analyze_js_req.component.d.ts

@@ -0,0 +1,126 @@
+import type { SensitiveInfoEntity } from './interfaces/arcjet-js-req-sensitive-information-identifier.js';
+export { SensitiveInfoEntity };
+/**
+* # Variants
+* 
+* ## `"valid"`
+* 
+* ## `"invalid"`
+*/
+export type EmailValidity = 'valid' | 'invalid';
+export interface EmailValidationResult {
+  validity: EmailValidity,
+  blocked: Array<string>,
+}
+export interface AllowEmailValidationConfig {
+  requireTopLevelDomain: boolean,
+  allowDomainLiteral: boolean,
+  allow: Array<string>,
+}
+export interface DenyEmailValidationConfig {
+  requireTopLevelDomain: boolean,
+  allowDomainLiteral: boolean,
+  deny: Array<string>,
+}
+export type EmailValidationConfig = EmailValidationConfigAllowEmailValidationConfig | EmailValidationConfigDenyEmailValidationConfig;
+export interface EmailValidationConfigAllowEmailValidationConfig {
+  tag: 'allow-email-validation-config',
+  val: AllowEmailValidationConfig,
+}
+export interface EmailValidationConfigDenyEmailValidationConfig {
+  tag: 'deny-email-validation-config',
+  val: DenyEmailValidationConfig,
+}
+export type SensitiveInfoEntities = SensitiveInfoEntitiesAllow | SensitiveInfoEntitiesDeny;
+export interface SensitiveInfoEntitiesAllow {
+  tag: 'allow',
+  val: Array<SensitiveInfoEntity>,
+}
+export interface SensitiveInfoEntitiesDeny {
+  tag: 'deny',
+  val: Array<SensitiveInfoEntity>,
+}
+export interface SensitiveInfoConfig {
+  entities: SensitiveInfoEntities,
+  contextWindowSize?: number,
+  skipCustomDetect: boolean,
+}
+export interface DetectedSensitiveInfoEntity {
+  start: number,
+  end: number,
+  identifiedType: SensitiveInfoEntity,
+}
+export interface SensitiveInfoResult {
+  allowed: Array<DetectedSensitiveInfoEntity>,
+  denied: Array<DetectedSensitiveInfoEntity>,
+}
+export type BotEntity = string;
+export interface AllowedBotConfig {
+  entities: Array<BotEntity>,
+  skipCustomDetect: boolean,
+}
+export interface DeniedBotConfig {
+  entities: Array<BotEntity>,
+  skipCustomDetect: boolean,
+}
+export type BotConfig = BotConfigAllowedBotConfig | BotConfigDeniedBotConfig;
+export interface BotConfigAllowedBotConfig {
+  tag: 'allowed-bot-config',
+  val: AllowedBotConfig,
+}
+export interface BotConfigDeniedBotConfig {
+  tag: 'denied-bot-config',
+  val: DeniedBotConfig,
+}
+export interface BotResult {
+  allowed: Array<BotEntity>,
+  denied: Array<BotEntity>,
+  verified: boolean,
+  spoofed: boolean,
+}
+import { ArcjetJsReqEmailValidatorOverrides } from './interfaces/arcjet-js-req-email-validator-overrides.js';
+import { ArcjetJsReqSensitiveInformationIdentifier } from './interfaces/arcjet-js-req-sensitive-information-identifier.js';
+import { ArcjetJsReqVerifyBot } from './interfaces/arcjet-js-req-verify-bot.js';
+export interface ImportObject {
+  'arcjet:js-req/email-validator-overrides': typeof ArcjetJsReqEmailValidatorOverrides,
+  'arcjet:js-req/sensitive-information-identifier': typeof ArcjetJsReqSensitiveInformationIdentifier,
+  'arcjet:js-req/verify-bot': typeof ArcjetJsReqVerifyBot,
+}
+export interface Root {
+  detectBot(request: string, options: BotConfig): BotResult,
+  generateFingerprint(request: string, characteristics: Array<string>): string,
+  validateCharacteristics(request: string, characteristics: Array<string>): void,
+  isValidEmail(candidate: string, options: EmailValidationConfig): EmailValidationResult,
+  detectSensitiveInfo(content: string, options: SensitiveInfoConfig): SensitiveInfoResult,
+}
+
+/**
+* Instantiates this component with the provided imports and
+* returns a map of all the exports of the component.
+*
+* This function is intended to be similar to the
+* `WebAssembly.instantiate` function. The second `imports`
+* argument is the "import object" for wasm, except here it
+* uses component-model-layer types instead of core wasm
+* integers/numbers/etc.
+*
+* The first argument to this function, `getCoreModule`, is
+* used to compile core wasm modules within the component.
+* Components are composed of core wasm modules and this callback
+* will be invoked per core wasm module. The caller of this
+* function is responsible for reading the core wasm module
+* identified by `path` and returning its compiled
+* `WebAssembly.Module` object. This would use `compileStreaming`
+* on the web, for example.
+*/
+export function instantiate(
+getCoreModule: (path: string) => WebAssembly.Module,
+imports: ImportObject,
+instantiateCore?: (module: WebAssembly.Module, imports: Record<string, any>) => WebAssembly.Instance
+): Root;
+export function instantiate(
+getCoreModule: (path: string) => WebAssembly.Module | Promise<WebAssembly.Module>,
+imports: ImportObject,
+instantiateCore?: (module: WebAssembly.Module, imports: Record<string, any>) => WebAssembly.Instance | Promise<WebAssembly.Instance>
+): Root | Promise<Root>;
+