feat: add library to perform redaction of sensitive information

[e-moran]

Adds the library to perform redaction on text using the Arcjet sensitive info primitive.

Redaction is performed by the redact() function, which takes a string and any configuration that you want to use. It returns the redacted text and an unredact() function as a [redacted, unredact] tuple. Calling unredact() with a string will replace the fake data with the original data.

[trunk-io]

😎 Merged successfully - details.

[socket-security]

New dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/@arcjet/[email protected]	None	0	0 B

View full report↗︎

[blaine-arcjet]

Copying to the root of the PR so it doesn't get buried in comments:

The sample that I've been playing with is:

const [redacted, unredact] = await redact("abc, 123", {
  // entities: ["credit-card-number", "abc"],
  // detect: (tokens: string[]) => {
  //   return tokens.map((token) => {
  //     if (token == "abc") {
  //       return "abc";
  //     }
  //   });
  // },
  replace: (entity) => {
    // if (entity === "abc") return "123456";
    if (entity === "email") return "foobarbaz";
    // if (entity === "") return "123";
  },
});

Essentially, we should be able to comment/uncomment the various pieces and the type inference should be good. I have inlay hints enabled for all my TS so I can see how it is inferring things.

I'm going to push up my changes, but be aware that they have the same caveat as #1446 (comment) and I'm not good enough at TypeScript to know how to make both ways work.

[blaine-arcjet]

I've also just discovered that the arguments of detect must be typed as string[] otherwise the inference is lost. I need think more about how to solve that.

[blaine-arcjet]

Big question on whether we should be defaulting to "no redactions" in the redact library.

[blaine-arcjet]

I think this is good to go! Great work @e-moran 🎉 I think this API is really great.

@e-moran I pushed up some changes to get to 100% code coverage. Please review before you merge.