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

package/README.md

@@ -20,31 +20,65 @@
 code. Implement rate limiting, bot protection, email verification, and defense
 against common attacks.
 
-This is the [Arcjet][arcjet] TypeScript and JavaScript sensitive information redaction library.
+This is the [Arcjet][arcjet] TypeScript and JavaScript sensitive information
+redaction library.
 
-## Installation
+- [npm package (`@arcjet/redact`)](https://www.npmjs.com/package/@arcjet/redact)
+- [GitHub source code (`redact/` in `arcjet/arcjet-js`)](https://github.com/arcjet/arcjet-js/tree/main/redact)
 
-```shell
-npm install -S @arcjet/redact
+## What is this?
+
+This package provides functionality to redact sensitive info.
+The work is done in WebAssembly but is called here from JavaScript.
+
+The WebAssembly files are in [`@arcjet/redact-wasm`][github-arcjet-redact-wasm].
+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].
+
+## When should I use this?
+
+You can use this package to redact sensitive information locally.
+You can redact email addresses, credit card numbers, and more.
+It is also possible to reverse the process: to un-redact what was found.
+
+## Install
+
+This package is ESM only.
+Install with npm in Node.js:
+
+```sh
+npm install @arcjet/redact
 ```
 
-## Example
+## Reference
 
-```typescript
-const text = "Hi, my name is John and my email adress is john@example.com";
-const [redacted, unredact] = await redact(text, {
-  redact: ["email", "phone-number"],
+The full reference documentation can be found in the [Arcjet docs][redact-ref].
+
+## Use
+
+```ts
+import { redact } from "@arcjet/redact";
+
+const value = "Hi, my name is John and my email adress is john@example.com";
+
+const [redacted, unredact] = await redact(value, {
+  entities: ["email", "phone-number"],
 });
 console.log(redacted);
-// Hi, my name is John and my email address is <Redacted email #0>
+// => "Hi, my name is John and my email adress is <Redacted email #0>"
 
 const unredacted = unredact("Your email address is <Redacted email #0>");
-console.log(unredacted); // Your email address is john@example.com
+console.log(unredacted); // "Your email address is john@example.com"
 ```
 
 ## 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
 [apache-license]: http://www.apache.org/licenses/LICENSE-2.0
+[arcjet]: https://arcjet.com
+[redact-ref]: https://docs.arcjet.com/redact/reference
+[github-arcjet-analyze-wasm-what]: https://github.com/arcjet/arcjet-js/tree/main/analyze-wasm#what-is-this
+[github-arcjet-redact-wasm]: https://github.com/arcjet/arcjet-js/tree/main/redact-wasm

package/index.d.ts

@@ -5,7 +5,7 @@ export type RedactOptions<Detect> = {
     entities?: ValidEntities<Detect>;
     contextWindowSize?: number;
     detect?: Detect;
-    replace?: (entity: ValidEntities<Detect>[number]) => string | undefined;
+    replace?: (entity: ValidEntities<Detect>[number], plaintext: string) => string | undefined;
 };
 type Unredact = (input: string) => string;
 export declare function redact<const Detect extends DetectSensitiveInfoEntities<CustomEntities> | undefined, const CustomEntities extends string>(candidate: string, options?: RedactOptions<Detect>): Promise<[string, Unredact]>;

package/index.js

@@ -45,7 +45,7 @@ function performReplacementInText(text, replacement, start, end) {
 function noOpDetect(_tokens) {
     return [];
 }
-function noOpReplace(_input) {
+function noOpReplace(_input, _plaintext) {
     return undefined;
 }
 function getWasmOptions(options) {
@@ -89,10 +89,10 @@ async function callRedactWasm(candidate, options) {
     let convertedReplace = noOpReplace;
     if (typeof options?.replace === "function") {
         const replace = options.replace;
-        convertedReplace = (identifiedType) => {
+        convertedReplace = (identifiedType, plaintext) => {
             return replace(
             // @ts-ignore because we know this is coming from Wasm
-            wasmEntitiesToString(identifiedType));
+            wasmEntitiesToString(identifiedType), plaintext);
         };
     }
     const wasm = await initializeWasm(convertedDetect, convertedReplace);

package/package.json

@@ -1,7 +1,13 @@
 {
   "name": "@arcjet/redact",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.10",
   "description": "Arcjet sensitive information redaction library",
+  "keywords": [
+    "arcjet",
+    "redact",
+    "utility",
+    "util"
+  ],
   "license": "Apache-2.0",
   "homepage": "https://arcjet.com",
   "repository": {
@@ -25,30 +31,28 @@
   "main": "./index.js",
   "types": "./index.d.ts",
   "files": [
-    "LICENSE",
-    "README.md",
-    "*.js",
-    "*.d.ts",
-    "!*.config.js"
+    "index.d.ts",
+    "index.js"
   ],
   "scripts": {
-    "prepublishOnly": "npm run build",
     "build": "rollup --config rollup.config.js",
     "lint": "eslint .",
-    "pretest": "npm run build",
-    "test": "node --test --experimental-test-coverage"
+    "prepublishOnly": "npm run build",
+    "test-api": "node --test",
+    "test-coverage": "node --experimental-test-coverage --test",
+    "test": "npm run build && npm run lint && npm run test-coverage"
   },
   "dependencies": {
-    "@arcjet/redact-wasm": "1.0.0-beta.1"
+    "@arcjet/redact-wasm": "1.0.0-beta.10"
   },
   "devDependencies": {
-    "@arcjet/eslint-config": "1.0.0-beta.1",
-    "@arcjet/rollup-config": "1.0.0-beta.1",
-    "@arcjet/tsconfig": "1.0.0-beta.1",
-    "@rollup/wasm-node": "4.30.1",
+    "@arcjet/eslint-config": "1.0.0-beta.10",
+    "@arcjet/rollup-config": "1.0.0-beta.10",
+    "@arcjet/tsconfig": "1.0.0-beta.10",
+    "@rollup/wasm-node": "4.46.2",
     "@types/node": "18.18.0",
-    "expect": "29.7.0",
-    "typescript": "5.7.3"
+    "eslint": "9.32.0",
+    "typescript": "5.9.2"
   },
   "publishConfig": {
     "access": "public",