@arcjet/redact 1.9.0 → 1.10.0-rc.0

package/dist/index.d.ts

@@ -1,71 +1,70 @@
 import { SensitiveInfoEntity } from "@arcjet/redact-wasm";
-
 //#region src/index.d.ts
 /**
-* Types of standard sensitive information that can be detected.
-*/
+ * Types of standard sensitive information that can be detected.
+ */
 type ArcjetSensitiveInfoType = Exclude<SensitiveInfoEntity["tag"], "custom">;
 /**
-* Options for the `redact` function.
-*
-* @template DetectedEntities
-*   Custom entity names that are returned from `detect` and optionally listed in `entities`.
-* @template ListedEntities
-*   Entity names that can be listed in the `entities` option.
-*/
+ * Options for the `redact` function.
+ *
+ * @template DetectedEntities
+ *   Custom entity names that are returned from `detect` and optionally listed in `entities`.
+ * @template ListedEntities
+ *   Entity names that can be listed in the `entities` option.
+ */
 type RedactOptions<DetectedEntities extends string | undefined = undefined, ListedEntities extends ArcjetSensitiveInfoType | Exclude<DetectedEntities, undefined> = ArcjetSensitiveInfoType | Exclude<DetectedEntities, undefined>> = {
   /**
-  * Entities to redact.
-  */
+   * Entities to redact.
+   */
   entities?: ReadonlyArray<ListedEntities | Exclude<DetectedEntities, undefined>>;
   /**
-  * Size of tokens to consider.
-  */
+   * Size of tokens to consider.
+   */
   contextWindowSize?: number;
   /**
-  * Custom detection function to identify sensitive information.
-  *
-  * @template DetectedEntities
-  *   Custom entity names that are returned from `detect` and optionally listed in `entities`.
-  * @template ListedEntities
-  *   Entity names that can be listed in the `entities` option.
-  * @param tokens
-  *   Tokens.
-  * @returns
-  *   List of entities (or undefined).
-  */
+   * Custom detection function to identify sensitive information.
+   *
+   * @template DetectedEntities
+   *   Custom entity names that are returned from `detect` and optionally listed in `entities`.
+   * @template ListedEntities
+   *   Entity names that can be listed in the `entities` option.
+   * @param tokens
+   *   Tokens.
+   * @returns
+   *   List of entities (or undefined).
+   */
   detect?: (tokens: string[]) => ReadonlyArray<DetectedEntities>;
   /**
-  * Custom replace function to redact sensitive information.
-  *
-  * @template DetectedEntities
-  *   Custom entity names that are returned from `detect` and optionally listed in `entities`.
-  * @template ListedEntities
-  *   Entity names that can be listed in the `entities` option.
-  * @param entity
-  *   Entity to redact.
-  * @param plaintext
-  *   The plaintext string to redact.
-  * @returns
-  *   Redacted string or nothing.
-  */
+   * Custom replace function to redact sensitive information.
+   *
+   * @template DetectedEntities
+   *   Custom entity names that are returned from `detect` and optionally listed in `entities`.
+   * @template ListedEntities
+   *   Entity names that can be listed in the `entities` option.
+   * @param entity
+   *   Entity to redact.
+   * @param plaintext
+   *   The plaintext string to redact.
+   * @returns
+   *   Redacted string or nothing.
+   */
   replace?: (entity: ListedEntities, plaintext: string) => string | undefined;
 };
 type Unredact = (input: string) => string;
 /**
-* Redact sensitive info.
-*
-* @template DetectedEntities
-*   Custom entity names that are returned from `detect` and optionally listed in `entities`.
-* @template ListedEntities
-*   Entity names that can be listed in the `entities` option.
-* @param candidate
-*   Value to redact.
-* @param options
-*   Configuration.
-* @returns
-*   Promise to a tuple with the redacted string and a function to unredact it.
-*/
+ * Redact sensitive info.
+ *
+ * @template DetectedEntities
+ *   Custom entity names that are returned from `detect` and optionally listed in `entities`.
+ * @template ListedEntities
+ *   Entity names that can be listed in the `entities` option.
+ * @param candidate
+ *   Value to redact.
+ * @param options
+ *   Configuration.
+ * @returns
+ *   Promise to a tuple with the redacted string and a function to unredact it.
+ */
 declare function redact<const DetectedEntities extends string | undefined = undefined, const ListedEntities extends ArcjetSensitiveInfoType | Exclude<DetectedEntities, undefined> = ArcjetSensitiveInfoType | Exclude<DetectedEntities, undefined>>(candidate: string, options?: RedactOptions<DetectedEntities, ListedEntities>): Promise<[string, Unredact]>;
 //#endregion
 export { ArcjetSensitiveInfoType, RedactOptions, redact };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcjet/redact",
-  "version": "1.9.0",
+  "version": "1.10.0-rc.0",
   "description": "Arcjet sensitive information redaction library",
   "keywords": [
     "arcjet",
@@ -42,18 +42,18 @@
   },
   "scripts": {
     "build": "tsdown",
-    "typecheck": "tsgo --noEmit",
+    "typecheck": "tsc --noEmit",
     "test-api": "node --test -- test/*.test.ts",
     "test-coverage": "node --experimental-test-coverage --test -- test/*.test.ts",
     "test": "npm run build && npm run test-coverage"
   },
   "dependencies": {
-    "@arcjet/redact-wasm": "1.9.0"
+    "@arcjet/redact-wasm": "1.10.0-rc.0"
   },
   "devDependencies": {
-    "@types/node": "22.19.21",
-    "tsdown": "0.22.3",
-    "typescript": "6.0.3"
+    "@types/node": "22.20.1",
+    "tsdown": "0.22.7",
+    "typescript": "7.0.2"
   },
   "engines": {
     "node": ">=22.21.0 <23 || >=24.5.0"