@arcjet/redact-wasm 1.0.0-alpha.23

package/_virtual/arcjet_analyze_bindings_redact.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,AGFzbQEAAAABDgJgA39/fwBgBH9/f38AAwMCAAEEBQFwAQICBxQDATAAAAExAAEIJGltcG9ydHMBAAofAg0AIAAgASACQQARAAALDwAgACABIAIgA0EBEQEACwAvCXByb2R1Y2VycwEMcHJvY2Vzc2VkLWJ5AQ13aXQtY29tcG9uZW50BzAuMjEwLjAAlQEEbmFtZQATEndpdC1jb21wb25lbnQ6c2hpbQF5AgA6aW5kaXJlY3QtYXJjamV0OnJlZGFjdC9jdXN0b20tcmVkYWN0LWRldGVjdC1zZW5zaXRpdmUtaW5mbwE6aW5kaXJlY3QtYXJjamV0OnJlZGFjdC9jdXN0b20tcmVkYWN0LXJlZGFjdC1zZW5zaXRpdmUtaW5mbw==";
+/**
+ * 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_bindings_redact.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,AGFzbQEAAAABDgJgA39/fwBgBH9/f38AAhoDAAEwAAAAATEAAQAIJGltcG9ydHMBcAECAgkIAQBBAAsCAAEALwlwcm9kdWNlcnMBDHByb2Nlc3NlZC1ieQENd2l0LWNvbXBvbmVudAcwLjIxMC4wABwEbmFtZQAVFHdpdC1jb21wb25lbnQ6Zml4dXBz";
+/**
+ * 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,6 @@
+import type { RedactedSensitiveInfoEntity, RedactSensitiveInfoConfig, SensitiveInfoEntity } from "./wasm/arcjet_analyze_bindings_redact.component.js";
+import type { ArcjetRedactCustomRedact } from "./wasm/interfaces/arcjet-redact-custom-redact.js";
+export declare function initializeWasm(detect: CustomDetect, replace: CustomRedact): Promise<import("./wasm/arcjet_analyze_bindings_redact.component.js").Root | undefined>;
+type CustomDetect = typeof ArcjetRedactCustomRedact.detectSensitiveInfo;
+type CustomRedact = typeof ArcjetRedactCustomRedact.redactSensitiveInfo;
+export { type CustomDetect, type CustomRedact, type RedactedSensitiveInfoEntity, type RedactSensitiveInfoConfig, type SensitiveInfoEntity, };

package/edge-light.js

@@ -0,0 +1,34 @@
+import { instantiate } from './wasm/arcjet_analyze_bindings_redact.component.js';
+import componentCoreWasm from './wasm/arcjet_analyze_bindings_redact.component.core.wasm?module';
+import componentCore2Wasm from './wasm/arcjet_analyze_bindings_redact.component.core2.wasm?module';
+import componentCore3Wasm from './wasm/arcjet_analyze_bindings_redact.component.core3.wasm?module';
+
+async function moduleFromPath(path) {
+    if (path === "arcjet_analyze_bindings_redact.component.core.wasm") {
+        return componentCoreWasm;
+    }
+    if (path === "arcjet_analyze_bindings_redact.component.core2.wasm") {
+        return componentCore2Wasm;
+    }
+    if (path === "arcjet_analyze_bindings_redact.component.core3.wasm") {
+        return componentCore3Wasm;
+    }
+    throw new Error(`Unknown path: ${path}`);
+}
+async function initializeWasm(detect, replace) {
+    const coreImports = {
+        "arcjet:redact/custom-redact": {
+            detectSensitiveInfo: detect,
+            redactSensitiveInfo: replace,
+        },
+    };
+    try {
+        // Await the instantiation to catch the failure
+        return await instantiate(moduleFromPath, coreImports);
+    }
+    catch {
+        console.debug("WebAssembly is not supported in this runtime");
+    }
+}
+
+export { initializeWasm };

package/edge-light.ts

@@ -0,0 +1,56 @@
+import { instantiate } from "./wasm/arcjet_analyze_bindings_redact.component.js";
+import type {
+  ImportObject,
+  RedactedSensitiveInfoEntity,
+  RedactSensitiveInfoConfig,
+  SensitiveInfoEntity,
+} from "./wasm/arcjet_analyze_bindings_redact.component.js";
+import type { ArcjetRedactCustomRedact } from "./wasm/interfaces/arcjet-redact-custom-redact.js";
+
+import componentCoreWasm from "./wasm/arcjet_analyze_bindings_redact.component.core.wasm?module";
+import componentCore2Wasm from "./wasm/arcjet_analyze_bindings_redact.component.core2.wasm?module";
+import componentCore3Wasm from "./wasm/arcjet_analyze_bindings_redact.component.core3.wasm?module";
+
+async function moduleFromPath(path: string): Promise<WebAssembly.Module> {
+  if (path === "arcjet_analyze_bindings_redact.component.core.wasm") {
+    return componentCoreWasm;
+  }
+  if (path === "arcjet_analyze_bindings_redact.component.core2.wasm") {
+    return componentCore2Wasm;
+  }
+  if (path === "arcjet_analyze_bindings_redact.component.core3.wasm") {
+    return componentCore3Wasm;
+  }
+
+  throw new Error(`Unknown path: ${path}`);
+}
+
+export async function initializeWasm(
+  detect: CustomDetect,
+  replace: CustomRedact,
+) {
+  const coreImports: ImportObject = {
+    "arcjet:redact/custom-redact": {
+      detectSensitiveInfo: detect,
+      redactSensitiveInfo: replace,
+    },
+  };
+
+  try {
+    // Await the instantiation to catch the failure
+    return await instantiate(moduleFromPath, coreImports);
+  } catch {
+    console.debug("WebAssembly is not supported in this runtime");
+  }
+}
+
+type CustomDetect = typeof ArcjetRedactCustomRedact.detectSensitiveInfo;
+type CustomRedact = typeof ArcjetRedactCustomRedact.redactSensitiveInfo;
+
+export {
+  type CustomDetect,
+  type CustomRedact,
+  type RedactedSensitiveInfoEntity,
+  type RedactSensitiveInfoConfig,
+  type SensitiveInfoEntity,
+};

package/index.d.ts

@@ -0,0 +1,6 @@
+import type { RedactedSensitiveInfoEntity, RedactSensitiveInfoConfig, SensitiveInfoEntity } from "./wasm/arcjet_analyze_bindings_redact.component.js";
+import type { ArcjetRedactCustomRedact } from "./wasm/interfaces/arcjet-redact-custom-redact.js";
+export declare function initializeWasm(detect: CustomDetect, replace: CustomRedact): Promise<import("./wasm/arcjet_analyze_bindings_redact.component.js").Root | undefined>;
+type CustomDetect = typeof ArcjetRedactCustomRedact.detectSensitiveInfo;
+type CustomRedact = typeof ArcjetRedactCustomRedact.redactSensitiveInfo;
+export { type CustomDetect, type CustomRedact, type RedactedSensitiveInfoEntity, type RedactSensitiveInfoConfig, type SensitiveInfoEntity, };

package/index.js

@@ -0,0 +1,45 @@
+import { instantiate } from './wasm/arcjet_analyze_bindings_redact.component.js';
+import { wasm } from './_virtual/arcjet_analyze_bindings_redact.component.core.js';
+import { wasm as wasm$1 } from './_virtual/arcjet_analyze_bindings_redact.component.core2.js';
+import { wasm as wasm$2 } from './_virtual/arcjet_analyze_bindings_redact.component.core3.js';
+
+const wasmCache = new Map();
+async function moduleFromPath(path) {
+    const cachedModule = wasmCache.get(path);
+    if (typeof cachedModule !== "undefined") {
+        return cachedModule;
+    }
+    if (path === "arcjet_analyze_bindings_redact.component.core.wasm") {
+        const mod = await wasm();
+        wasmCache.set(path, mod);
+        return mod;
+    }
+    if (path === "arcjet_analyze_bindings_redact.component.core2.wasm") {
+        const mod = await wasm$1();
+        wasmCache.set(path, mod);
+        return mod;
+    }
+    if (path === "arcjet_analyze_bindings_redact.component.core3.wasm") {
+        const mod = await wasm$2();
+        wasmCache.set(path, mod);
+        return mod;
+    }
+    throw new Error(`Unknown path: ${path}`);
+}
+async function initializeWasm(detect, replace) {
+    const coreImports = {
+        "arcjet:redact/custom-redact": {
+            detectSensitiveInfo: detect,
+            redactSensitiveInfo: replace,
+        },
+    };
+    try {
+        // Await the instantiation to catch the failure
+        return await instantiate(moduleFromPath, coreImports);
+    }
+    catch {
+        console.debug("WebAssembly is not supported in this runtime");
+    }
+}
+
+export { initializeWasm };

package/index.ts

@@ -0,0 +1,69 @@
+import { instantiate } from "./wasm/arcjet_analyze_bindings_redact.component.js";
+import type {
+  ImportObject,
+  RedactedSensitiveInfoEntity,
+  RedactSensitiveInfoConfig,
+  SensitiveInfoEntity,
+} from "./wasm/arcjet_analyze_bindings_redact.component.js";
+import type { ArcjetRedactCustomRedact } from "./wasm/interfaces/arcjet-redact-custom-redact.js";
+
+import { wasm as componentCoreWasm } from "./wasm/arcjet_analyze_bindings_redact.component.core.wasm?js";
+import { wasm as componentCore2Wasm } from "./wasm/arcjet_analyze_bindings_redact.component.core2.wasm?js";
+import { wasm as componentCore3Wasm } from "./wasm/arcjet_analyze_bindings_redact.component.core3.wasm?js";
+
+const wasmCache = new Map<string, WebAssembly.Module>();
+
+async function moduleFromPath(path: string): Promise<WebAssembly.Module> {
+  const cachedModule = wasmCache.get(path);
+  if (typeof cachedModule !== "undefined") {
+    return cachedModule;
+  }
+
+  if (path === "arcjet_analyze_bindings_redact.component.core.wasm") {
+    const mod = await componentCoreWasm();
+    wasmCache.set(path, mod);
+    return mod;
+  }
+  if (path === "arcjet_analyze_bindings_redact.component.core2.wasm") {
+    const mod = await componentCore2Wasm();
+    wasmCache.set(path, mod);
+    return mod;
+  }
+  if (path === "arcjet_analyze_bindings_redact.component.core3.wasm") {
+    const mod = await componentCore3Wasm();
+    wasmCache.set(path, mod);
+    return mod;
+  }
+
+  throw new Error(`Unknown path: ${path}`);
+}
+
+export async function initializeWasm(
+  detect: CustomDetect,
+  replace: CustomRedact,
+) {
+  const coreImports: ImportObject = {
+    "arcjet:redact/custom-redact": {
+      detectSensitiveInfo: detect,
+      redactSensitiveInfo: replace,
+    },
+  };
+
+  try {
+    // Await the instantiation to catch the failure
+    return await instantiate(moduleFromPath, coreImports);
+  } catch {
+    console.debug("WebAssembly is not supported in this runtime");
+  }
+}
+
+type CustomDetect = typeof ArcjetRedactCustomRedact.detectSensitiveInfo;
+type CustomRedact = typeof ArcjetRedactCustomRedact.redactSensitiveInfo;
+
+export {
+  type CustomDetect,
+  type CustomRedact,
+  type RedactedSensitiveInfoEntity,
+  type RedactSensitiveInfoConfig,
+  type SensitiveInfoEntity,
+};

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@arcjet/redact-wasm",
+  "version": "1.0.0-alpha.23",
+  "description": "Arcjet sensitive information redaction detection engine",
+  "license": "Apache-2.0",
+  "homepage": "https://arcjet.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/arcjet/arcjet-js.git",
+    "directory": "redact-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_bindings_redact.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_OPTIONS=--experimental-vm-modules jest --passWithNoTests"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "@arcjet/eslint-config": "1.0.0-alpha.23",
+    "@arcjet/rollup-config": "1.0.0-alpha.23",
+    "@arcjet/tsconfig": "1.0.0-alpha.23",
+    "@bytecodealliance/jco": "1.5.0",
+    "@jest/globals": "29.7.0",
+    "@rollup/wasm-node": "4.21.2",
+    "@types/node": "18.18.0",
+    "jest": "29.7.0",
+    "typescript": "5.5.4"
+  },
+  "publishConfig": {
+    "access": "public",
+    "tag": "latest"
+  }
+}

package/wasm/arcjet_analyze_bindings_redact.component.d.ts

@@ -0,0 +1,53 @@
+import type { SensitiveInfoEntity } from './interfaces/arcjet-redact-custom-redact.js';
+export { SensitiveInfoEntity };
+export interface RedactSensitiveInfoConfig {
+  entities?: Array<SensitiveInfoEntity>,
+  contextWindowSize?: number,
+  skipCustomDetect: boolean,
+  skipCustomRedact: boolean,
+}
+export interface RedactedSensitiveInfoEntity {
+  original: string,
+  redacted: string,
+  start: number,
+  end: number,
+  identifiedType: SensitiveInfoEntity,
+}
+import { ArcjetRedactCustomRedact } from './interfaces/arcjet-redact-custom-redact.js';
+export interface ImportObject {
+  'arcjet:redact/custom-redact': typeof ArcjetRedactCustomRedact,
+}
+export interface Root {
+  redact(content: string, options: RedactSensitiveInfoConfig): Array<RedactedSensitiveInfoEntity>,
+}
+
+/**
+* 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>;
+