refactor(redact): reuse exposed types (#4856)

Some of the types from `@arcjet/redact-wasm` are not used anywhere. Other ones were redefined in `@arcjet/redact` itself. This commit removes the duplication and removes the (completely internal) unused API surface from `@arcjet/redact-wasm`.

Some of the exposed API surface did not specify return types either. This adds return types so that we can verify that the API matches what we want instead of returning arbitrary objects (with `const`s).

Author: wooorm-arcjet

redact-wasm/index.ts

@@ -1,10 +1,5 @@
 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 { ImportObject } 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";
@@ -66,7 +61,7 @@ export async function initializeWasm(
  * @returns
  *   Array of detected entities.
  */
-export type CustomDetect = typeof ArcjetRedactCustomRedact.detectSensitiveInfo;
+type CustomDetect = typeof ArcjetRedactCustomRedact.detectSensitiveInfo;
 
 /**
  * Redact sensitive info.
@@ -78,10 +73,10 @@ export type CustomDetect = typeof ArcjetRedactCustomRedact.detectSensitiveInfo;
  * @returns
  *   Redacted string.
  */
-export type CustomRedact = typeof ArcjetRedactCustomRedact.redactSensitiveInfo;
+type CustomRedact = typeof ArcjetRedactCustomRedact.redactSensitiveInfo;
 
-export {
-  type RedactedSensitiveInfoEntity,
-  type RedactSensitiveInfoConfig,
-  type SensitiveInfoEntity,
-};
+export type {
+  RedactedSensitiveInfoEntity,
+  RedactSensitiveInfoConfig,
+  SensitiveInfoEntity,
+} from "./wasm/arcjet_analyze_bindings_redact.component.js";

redact/index.ts

@@ -1,14 +1,17 @@
 import { initializeWasm } from "@arcjet/redact-wasm";
-import type { SensitiveInfoEntity } from "@arcjet/redact-wasm";
+import type {
+  RedactedSensitiveInfoEntity as RedactedSensitiveInfoEntityWasm,
+  RedactSensitiveInfoConfig,
+  SensitiveInfoEntity,
+} from "@arcjet/redact-wasm";
 
 /**
- * Types of sensitive information.
+ * Types of standard sensitive information that can be detected.
  */
-export type ArcjetSensitiveInfoType =
-  | "email"
-  | "phone-number"
-  | "ip-address"
-  | "credit-card-number";
+export type ArcjetSensitiveInfoType = Exclude<
+  SensitiveInfoEntity["tag"],
+  "custom"
+>;
 
 type DetectSensitiveInfoEntities<T> = (
   tokens: string[],
@@ -65,34 +68,34 @@ export type RedactOptions<Detect> = {
   replace?: Replace<Detect>;
 };
 
-function userEntitiesToWasm(entity: unknown) {
+function userEntitiesToWasm(entity: unknown): SensitiveInfoEntity {
   if (typeof entity !== "string") {
     throw new Error("redaction entities must be strings");
   }
 
   if (entity === "email") {
-    return { tag: "email" as const };
+    return { tag: "email" };
   }
 
   if (entity === "phone-number") {
-    return { tag: "phone-number" as const };
+    return { tag: "phone-number" };
   }
 
   if (entity === "ip-address") {
-    return { tag: "ip-address" as const };
+    return { tag: "ip-address" };
   }
 
   if (entity === "credit-card-number") {
-    return { tag: "credit-card-number" as const };
+    return { tag: "credit-card-number" };
   }
 
   return {
-    tag: "custom" as const,
+    tag: "custom",
     val: entity,
   };
 }
 
-function wasmEntitiesToString(entity: SensitiveInfoEntity) {
+function wasmEntitiesToString(entity: SensitiveInfoEntity): string {
   if (entity.tag === "email") {
     return "email";
   }
@@ -135,18 +138,15 @@ function noOpReplace(
 }
 /* c8 ignore stop */
 
-interface RedactedSensitiveInfoEntity {
-  original: string;
-  redacted: string;
-  start: number;
-  end: number;
+interface RedactedSensitiveInfoEntity
+  extends Omit<RedactedSensitiveInfoEntityWasm, "identifiedType"> {
   identifiedType: string;
 }
 
 function getWasmOptions<
   const Detect extends DetectSensitiveInfoEntities<CustomEntities> | undefined,
   const CustomEntities extends string,
->(options?: RedactOptions<Detect>) {
+>(options?: RedactOptions<Detect>): RedactSensitiveInfoConfig {
   if (typeof options === "object" && options !== null) {
     if (typeof options.entities !== "undefined") {
       if (Array.isArray(options.entities)) {