@arcjet/redact-wasm 1.0.0-beta.1 → 1.0.0-beta.10

package/README.md

@@ -18,74 +18,43 @@
 
 [Arcjet][arcjet] sensitive information redaction detection engine.
 
-## Installation
+- [npm package (`@arcjet/redact-wasm`)](https://www.npmjs.com/package/@arcjet/redact-wasm)
+- [GitHub source code (`redact-wasm/` in `arcjet/arcjet-js`)](https://github.com/arcjet/arcjet-js/tree/main/redact-wasm)
 
-```shell
-npm install -S @arcjet/redact-wasm
-```
+## What is this?
 
-## Example
-
-```ts
-import { initializeWasm } from "@arcjet/redact-wasm";
-import type { SensitiveInfoEntity } from "@arcjet/redact-wasm";
-
-function noOpDetect(_tokens: string[]): Array<SensitiveInfoEntity | undefined> {
-  return [];
-}
-function noOpReplace(_input: SensitiveInfoEntity): string | undefined {
-  return undefined;
-}
-
-const wasm = await initializeWasm(noOpDetect, noOpReplace);
-
-// If WebAssembly isn't available in the environment then it will be undefined.
-if (typeof wasm !== "undefined") {
-  const config = {
-    entities: [],
-    contextWindowSize: 1,
-    skipCustomDetect: true,
-    skipCustomRedact: true,
-  };
-
-  const entities = wasm.redact("I am a string", config);
-  // Do something with entities that should be redacted.
-} else {
-  throw new Error(
-    "redact failed to run because Wasm is not supported in this environment",
-  );
-}
-```
+This package provides logic in WebAssembly to locally redact sensitive info.
+The files here are generated.
+They are wrapped up into [`@arcjet/redact`][github-arcjet-redact] for use in
+JavaScript.
+For more info on why we maintain our WebAssembly and JavaScript projects like
+this,
+see [“What is this?” in the readme of
+`@arcjet/analyze-wasm`][github-arcjet-analyze-wasm-what].
 
-## Implementation
+## When should I use this?
 
-This package provides sensitive information identification and redaction logic implemented as a
-WebAssembly module which will run local analysis on the provided string.
+You should not use this but use [`@arcjet/redact`][github-arcjet-redact] instead.
 
-The generated `_virtual/arcjet_analyze_bindings_redact.component.js` file contains the binary inlined as
-a base64 [Data URL][mdn-data-url] with the `application/wasm` MIME type.
+## Install
 
-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][wasm-base64-blog] for more
-details.
+This package is ESM only.
+Install with npm in Node.js:
 
-It is then decoded into an ArrayBuffer to be used directly via WebAssembly's
-`compile()` function in our entry point file.
+```sh
+npm install @arcjet/redact-wasm
+```
 
-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.
+## Use
 
-In the future, we hope to do away with this workaround when all bundlers
-properly support consistent asset bundling techniques.
+Use [`@arcjet/redact`][file-redact] instead.
 
 ## License
 
-Licensed under the [Apache License, Version 2.0][apache-license].
+[Apache License, Version 2.0][apache-license] © [Arcjet Labs, Inc.][arcjet]
 
-[arcjet]: https://arcjet.com
-[mdn-data-url]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs
-[wasm-base64-blog]: https://blobfolio.com/2019/better-binary-batter-mixing-base64-and-uint8array/
 [apache-license]: http://www.apache.org/licenses/LICENSE-2.0
+[arcjet]: https://arcjet.com
+[file-redact]: ../redact/
+[github-arcjet-analyze-wasm-what]: https://github.com/arcjet/arcjet-js/tree/main/analyze-wasm#what-is-this
+[github-arcjet-redact]: https://github.com/arcjet/arcjet-js/tree/main/redact