@datafog/node 0.2.0 → 0.3.0

package/index.d.ts

@@ -138,6 +138,10 @@ export interface PrivacyManagerProviders {
 }
 
 export declare class PrivacyManager {
+  transformStructured(data: JsonDocument, findings: StructuredFindingInput[], config: TransformationConfig, context?: PrivacyContext): Promise<StructuredTransformResult>;
+  scanAndTransformStructured(data: JsonDocument, config: StructuredScanAndTransformConfig, context?: PrivacyContext): Promise<StructuredTransformResult>;
+  restoreStructured(data: JsonDocument, context: PrivacyContext): Promise<StructuredRestoreResult>;
+
   constructor(provider: KeyProvider | PrivacyManagerProviders, tokenProvider?: TokenProvider);
   transform(
     text: string,
@@ -152,6 +156,35 @@ export declare class PrivacyManager {
   ): Promise<TransformResult>;
   restore(text: string, context: PrivacyContext): Promise<RestoreResult>;
 }
+
+/** JSON input uses finite numbers; integer values must be JavaScript-safe. */
+export type JsonValue = null | boolean | number | string | JsonValue[] | { [key: string]: JsonValue };
+export type JsonDocument = JsonValue[] | { [key: string]: JsonValue };
+export interface StructuredScanConfig {
+  readonly locale?: string;
+  readonly discover_person?: boolean;
+  readonly mappings?: Readonly<Record<string, "PERSON">>;
+  readonly exclude?: readonly string[];
+}
+
+export interface StructuredScanAndTransformConfig {
+  readonly scan?: StructuredScanConfig;
+  readonly transform: TransformationConfig;
+}
+export declare function transformStructured(data: JsonDocument, findings: StructuredFindingInput[], config: TransformationConfig): StructuredTransformResult;
+export declare function scanAndTransformStructured(data: JsonDocument, config: StructuredScanAndTransformConfig): StructuredTransformResult;
+
+export interface StructuredTransformResult { readonly data: JsonDocument; readonly transformations: StructuredTransformation[]; }
+export interface StructuredRestoreResult { readonly data: JsonDocument; readonly restorations: StructuredRestoration[]; }
+export declare function discoverFields(dataJson: JsonDocument, config?: StructuredScanConfig | undefined): Array<FieldMapping>
+
+export interface FieldMapping {
+  path: string
+  entityType: string
+  source: string
+  rule: string
+}
+
 export interface Finding {
   readonly entityType: EntityType
   readonly matchedText: string
@@ -180,13 +213,30 @@ export interface KeySelector {
   readonly path: string
 }
 
+export interface NativeStructuredRestoreResult {
+  dataJson: string
+  restorations: Array<StructuredRestoration>
+}
+
+export interface NativeStructuredTransformResult {
+  dataJson: string
+  transformations: Array<StructuredTransformation>
+}
+
 export interface PreparedScanAndTransform {
   readonly findings: Array<Finding>
   readonly selectors: Array<KeySelector>
 }
 
+export interface PreparedStructuredScan {
+  findings: Array<StructuredFinding>
+  selectors: Array<KeySelector>
+}
+
 export declare function prepareScanAndTransform(text: string, config: ScanAndTransformConfig): PreparedScanAndTransform
 
+export declare function prepareStructuredScanAndTransform(text: string, config: unknown): PreparedStructuredScan
+
 export declare function requiredKeySelectors(text: string, findings: FindingInput[], config: TransformationConfig): Array<KeySelector>
 
 export declare function requiredRestoreItems(text: string, context: PrivacyContext): Array<RestoreItem>
@@ -235,6 +285,48 @@ export declare function scan(text: string, config?: ScanConfig | undefined): Arr
 /** Scan text and transform the detected findings. */
 export declare function scanAndTransform(text: string, config: ScanAndTransformConfig): TransformResult
 
+export declare function scanStructured(dataJson: JsonDocument, config?: StructuredScanConfig | undefined): StructuredScanResult
+
+export interface StructuredFinding {
+  path: string
+  finding: Finding
+}
+
+export interface StructuredFindingInput {
+  path: string
+  finding: FindingInput
+}
+
+/** Scan text and transform the detected findings. */
+export declare function structuredRequiredKeySelectors(text: JsonDocument, findings: StructuredFindingInput[], config: TransformationConfig): Array<KeySelector>
+
+export declare function structuredRequiredRestoreItems(text: JsonDocument, context: PrivacyContext): Array<RestoreItem>
+
+export declare function structuredRequiredTokenizationItems(text: JsonDocument, findings: StructuredFindingInput[], config: TransformationConfig, context?: PrivacyContext | undefined): Array<TokenizeItem>
+
+export interface StructuredRestoration {
+  path: string
+  restoration: Restoration
+}
+
+export declare function structuredRestoreWithResults(text: JsonDocument, context: PrivacyContext, results: Array<RestoredValueInput>): NativeStructuredRestoreResult
+
+export declare function structuredScanAndTransform(text: JsonDocument, config: StructuredScanAndTransformConfig): NativeStructuredTransformResult
+
+export interface StructuredScanResult {
+  mappings: Array<FieldMapping>
+  findings: Array<StructuredFinding>
+}
+
+export declare function structuredTransform(text: JsonDocument, findings: StructuredFindingInput[], config: TransformationConfig): NativeStructuredTransformResult
+
+export interface StructuredTransformation {
+  path: string
+  transformation: Transformation
+}
+
+export declare function structuredTransformWithProviderResults(text: JsonDocument, findings: StructuredFindingInput[], config: TransformationConfig, context: PrivacyContext | undefined, resolvedKeys: Array<ResolvedKeyInput>, tokenResults: Array<TokenizeResultInput>): NativeStructuredTransformResult
+
 export interface TextRange {
   readonly start: number
   readonly end: number

package/index.js

@@ -1,5 +1,15 @@
 import { Buffer } from "node:buffer";
 import {
+  structuredTransform as nativeStructuredTransform,
+  structuredScanAndTransform as nativeStructuredScanAndTransform,
+  structuredRequiredKeySelectors as nativeStructuredRequiredKeySelectors,
+  structuredRequiredTokenizationItems as nativeStructuredRequiredTokenizationItems,
+  structuredTransformWithProviderResults as nativeStructuredTransformWithProviderResults,
+  structuredRequiredRestoreItems as nativeStructuredRequiredRestoreItems,
+  structuredRestoreWithResults as nativeStructuredRestoreWithResults,
+  prepareStructuredScanAndTransform as nativePrepareStructuredScanAndTransform,
+  discoverFields as nativeDiscoverFields,
+  scanStructured as nativeScanStructured,
   prepareScanAndTransform as nativePrepareScanAndTransform,
   requiredKeySelectors as nativeRequiredKeySelectors,
   requiredRestoreItems as nativeRequiredRestoreItems,
@@ -167,7 +177,14 @@ export class PrivacyManager {
     }));
   }
 
-  async transform(text, findings, config, context) {
+  async transform(text, findings, config, context) { return this.#transform(text, findings, config, context); }
+  async scanAndTransform(text, config, context) { return this.#scanAndTransform(text, config, context); }
+  async restore(text, context) { return this.#restore(text, context); }
+  async transformStructured(data, findings, config, context) { return this.#transform(structuredJson(data), structuredOptions(findings), structuredOptions(config), structuredOptions(context), true); }
+  async scanAndTransformStructured(data, config, context) { return this.#scanAndTransform(structuredJson(data), structuredOptions(config), structuredOptions(context), true); }
+  async restoreStructured(data, context) { return this.#restore(structuredJson(data), structuredOptions(context), true); }
+
+  async #transform(text, findings, config, context, structured = false) {
     if (typeof text !== "string") {
       throw new TypeError("transform text must be a string");
     }
@@ -176,11 +193,15 @@ export class PrivacyManager {
     }
     let resolved = [];
     try {
-      const selectors = nativeRequiredKeySelectors(text, findings, config);
+      const selectors = (structured ? nativeStructuredRequiredKeySelectors : nativeRequiredKeySelectors)(text, findings, config);
+      const preparedItems = structured
+        ? nativeStructuredRequiredTokenizationItems(text, findings, config, context)
+        : undefined;
       resolved = await this.#resolve(selectors);
-      const items = nativeRequiredTokenizationItems(text, findings, config, context);
+      const items = preparedItems ?? nativeRequiredTokenizationItems(text, findings, config, context);
       const tokens = await this.#tokenize(items, context);
-      return nativeTransformWithProviderResults(text, findings, config, context, resolved, tokens);
+      const result = (structured ? nativeStructuredTransformWithProviderResults : nativeTransformWithProviderResults)(text, findings, config, context, resolved, tokens);
+      return structured ? structuredResult(result) : result;
     } catch (error) {
       if (error instanceof DataFogError) throw error;
       throw normalizeError(error, "invalid_configuration");
@@ -189,21 +210,29 @@ export class PrivacyManager {
     }
   }
 
-  async scanAndTransform(text, config, context) {
+  async #scanAndTransform(text, config, context, structured = false) {
     if (typeof text !== "string") {
       throw new TypeError("scanAndTransform text must be a string");
     }
     let prepared;
     try {
-      prepared = nativePrepareScanAndTransform(text, config);
+      prepared = (structured ? nativePrepareStructuredScanAndTransform : nativePrepareScanAndTransform)(text, config);
     } catch (error) {
       throw normalizeError(error, "invalid_configuration");
     }
+    let preparedItems;
+    if (structured) {
+      try {
+        preparedItems = nativeStructuredRequiredTokenizationItems(text, prepared.findings, config.transform, context);
+      } catch (error) {
+        throw withPathPrefix(error, "/transform");
+      }
+    }
     const resolved = await this.#resolve(prepared.selectors, "/transform");
     try {
-      const items = nativeRequiredTokenizationItems(text, prepared.findings, config.transform, context);
+      const items = preparedItems ?? nativeRequiredTokenizationItems(text, prepared.findings, config.transform, context);
       const tokens = await this.#tokenize(items, context);
-      return nativeTransformWithProviderResults(
+      const result = (structured ? nativeStructuredTransformWithProviderResults : nativeTransformWithProviderResults)(
         text,
         prepared.findings,
         config.transform,
@@ -211,6 +240,7 @@ export class PrivacyManager {
         resolved,
         tokens,
       );
+      return structured ? structuredResult(result) : result;
     } catch (error) {
       throw withPathPrefix(error, "/transform");
     } finally {
@@ -219,17 +249,20 @@ export class PrivacyManager {
   }
 
 
-  async restore(text, context) {
+  async #restore(text, context, structured = false) {
     if (typeof text !== "string") {
       throw new TypeError("restore text must be a string");
     }
     let items;
     try {
-      items = nativeRequiredRestoreItems(text, context);
+      items = (structured ? nativeStructuredRequiredRestoreItems : nativeRequiredRestoreItems)(text, context);
     } catch (error) {
       throw normalizeError(error, "invalid_configuration");
     }
-    if (items.length === 0) return nativeRestoreWithResults(text, context, []);
+    if (items.length === 0) {
+      const result = (structured ? nativeStructuredRestoreWithResults : nativeRestoreWithResults)(text, context, []);
+      return structured ? structuredResult(result) : result;
+    }
     if (!this.#tokenProvider) {
       throw new DataFogError({
         code: "token_provider_required",
@@ -242,7 +275,8 @@ export class PrivacyManager {
     } catch (error) {
       throw normalizeProviderError(error, undefined, "token_provider_error");
     }
-    return nativeRestoreWithResults(text, context, Array.isArray(results) ? results : []);
+    const result = (structured ? nativeStructuredRestoreWithResults : nativeRestoreWithResults)(text, context, Array.isArray(results) ? results : []);
+    return structured ? structuredResult(result) : result;
   }
 }
 
@@ -287,3 +321,67 @@ export function scanAndTransform(text, config) {
     throw normalizeError(error, "invalid_configuration");
   }
 }
+
+function structuredJson(data, omitUndefinedOptions = false) {
+  try {
+    if (data === null || typeof data !== "object") throw new TypeError();
+    const pending = [data];
+    const seen = new Set();
+    while (pending.length) {
+      const value = pending.pop();
+      if (value === null || typeof value === "string" || typeof value === "boolean") continue;
+      if (typeof value === "number") {
+        if (!Number.isFinite(value) || (Number.isInteger(value) && !Number.isSafeInteger(value))) throw new TypeError();
+        continue;
+      }
+      if (typeof value !== "object") throw new TypeError();
+      if (seen.has(value)) continue;
+      seen.add(value);
+      const array = Array.isArray(value);
+      if (!array && Object.getPrototypeOf(value) !== Object.prototype && Object.getPrototypeOf(value) !== null) throw new TypeError();
+      if (array && Object.keys(value).length !== value.length) throw new TypeError();
+      for (const key of Reflect.ownKeys(value)) {
+        if (array && key === "length") continue;
+        if (typeof key !== "string") throw new TypeError();
+        const descriptor = Object.getOwnPropertyDescriptor(value, key);
+        if (!descriptor.enumerable || !("value" in descriptor)) throw new TypeError();
+        if (array && (!/^(0|[1-9][0-9]*)$/.test(key) || Number(key) >= value.length)) throw new TypeError();
+        if (omitUndefinedOptions && !array && descriptor.value === undefined) continue;
+        pending.push(descriptor.value);
+      }
+    }
+    return JSON.stringify(data);
+  } catch {
+    throw new DataFogError({code:"invalid_configuration", reason:"invalid_type", path:"/data", message:"data must be a JSON object or array with finite numbers and safe integers"});
+  }
+}
+
+export function discoverFields(data, config) {
+  const json = structuredJson(data);
+  try { return nativeDiscoverFields(json, structuredOptions(config)); } catch (error) { throw normalizeError(error, "invalid_configuration"); }
+}
+
+export function scanStructured(data, config) {
+  const json = structuredJson(data);
+  try { return nativeScanStructured(json, structuredOptions(config)); } catch (error) { throw normalizeError(error, "invalid_configuration"); }
+}
+
+export function transformStructured(data, findings, config) {
+  const json = structuredJson(data);
+  try { return structuredResult(nativeStructuredTransform(json, structuredOptions(findings), structuredOptions(config))); } catch (error) { throw normalizeError(error, "invalid_configuration"); }
+}
+export function scanAndTransformStructured(data, config) {
+  const json = structuredJson(data);
+  try { return structuredResult(nativeStructuredScanAndTransform(json, structuredOptions(config))); } catch (error) { throw normalizeError(error, "invalid_configuration"); }
+}
+
+function structuredResult({dataJson, ...records}) {
+  return {data:JSON.parse(dataJson), ...records};
+}
+
+function structuredOptions(value) {
+  if (value === undefined) return undefined;
+  try { return JSON.parse(structuredJson(value, true)); } catch {
+    throw new DataFogError({code:"invalid_configuration", reason:"invalid_type", path:"", message:"structured request options must be JSON-compatible"});
+  }
+}

package/native.js

@@ -81,8 +81,8 @@ function requireNative() {
       try {
         const binding = require('@datafog/node-android-arm64')
         const bindingPackageVersion = require('@datafog/node-android-arm64/package.json').version
-        if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -97,8 +97,8 @@ function requireNative() {
       try {
         const binding = require('@datafog/node-android-arm-eabi')
         const bindingPackageVersion = require('@datafog/node-android-arm-eabi/package.json').version
-        if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -118,8 +118,8 @@ function requireNative() {
       try {
         const binding = require('@datafog/node-win32-x64-gnu')
         const bindingPackageVersion = require('@datafog/node-win32-x64-gnu/package.json').version
-        if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -134,8 +134,8 @@ function requireNative() {
       try {
         const binding = require('@datafog/node-win32-x64-msvc')
         const bindingPackageVersion = require('@datafog/node-win32-x64-msvc/package.json').version
-        if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -151,8 +151,8 @@ function requireNative() {
       try {
         const binding = require('@datafog/node-win32-ia32-msvc')
         const bindingPackageVersion = require('@datafog/node-win32-ia32-msvc/package.json').version
-        if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -167,8 +167,8 @@ function requireNative() {
       try {
         const binding = require('@datafog/node-win32-arm64-msvc')
         const bindingPackageVersion = require('@datafog/node-win32-arm64-msvc/package.json').version
-        if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -186,8 +186,8 @@ function requireNative() {
     try {
       const binding = require('@datafog/node-darwin-universal')
       const bindingPackageVersion = require('@datafog/node-darwin-universal/package.json').version
-      if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-        throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+      if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+        throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
       }
       return binding
     } catch (e) {
@@ -202,8 +202,8 @@ function requireNative() {
       try {
         const binding = require('@datafog/node-darwin-x64')
         const bindingPackageVersion = require('@datafog/node-darwin-x64/package.json').version
-        if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -218,8 +218,8 @@ function requireNative() {
       try {
         const binding = require('@datafog/node-darwin-arm64')
         const bindingPackageVersion = require('@datafog/node-darwin-arm64/package.json').version
-        if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -238,8 +238,8 @@ function requireNative() {
       try {
         const binding = require('@datafog/node-freebsd-x64')
         const bindingPackageVersion = require('@datafog/node-freebsd-x64/package.json').version
-        if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -254,8 +254,8 @@ function requireNative() {
       try {
         const binding = require('@datafog/node-freebsd-arm64')
         const bindingPackageVersion = require('@datafog/node-freebsd-arm64/package.json').version
-        if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -275,8 +275,8 @@ function requireNative() {
         try {
           const binding = require('@datafog/node-linux-x64-musl')
           const bindingPackageVersion = require('@datafog/node-linux-x64-musl/package.json').version
-          if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -291,8 +291,8 @@ function requireNative() {
         try {
           const binding = require('@datafog/node-linux-x64-gnu')
           const bindingPackageVersion = require('@datafog/node-linux-x64-gnu/package.json').version
-          if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -309,8 +309,8 @@ function requireNative() {
         try {
           const binding = require('@datafog/node-linux-arm64-musl')
           const bindingPackageVersion = require('@datafog/node-linux-arm64-musl/package.json').version
-          if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -325,8 +325,8 @@ function requireNative() {
         try {
           const binding = require('@datafog/node-linux-arm64-gnu')
           const bindingPackageVersion = require('@datafog/node-linux-arm64-gnu/package.json').version
-          if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -343,8 +343,8 @@ function requireNative() {
         try {
           const binding = require('@datafog/node-linux-arm-musleabihf')
           const bindingPackageVersion = require('@datafog/node-linux-arm-musleabihf/package.json').version
-          if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -359,8 +359,8 @@ function requireNative() {
         try {
           const binding = require('@datafog/node-linux-arm-gnueabihf')
           const bindingPackageVersion = require('@datafog/node-linux-arm-gnueabihf/package.json').version
-          if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -377,8 +377,8 @@ function requireNative() {
         try {
           const binding = require('@datafog/node-linux-loong64-musl')
           const bindingPackageVersion = require('@datafog/node-linux-loong64-musl/package.json').version
-          if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -393,8 +393,8 @@ function requireNative() {
         try {
           const binding = require('@datafog/node-linux-loong64-gnu')
           const bindingPackageVersion = require('@datafog/node-linux-loong64-gnu/package.json').version
-          if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -411,8 +411,8 @@ function requireNative() {
         try {
           const binding = require('@datafog/node-linux-riscv64-musl')
           const bindingPackageVersion = require('@datafog/node-linux-riscv64-musl/package.json').version
-          if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -427,8 +427,8 @@ function requireNative() {
         try {
           const binding = require('@datafog/node-linux-riscv64-gnu')
           const bindingPackageVersion = require('@datafog/node-linux-riscv64-gnu/package.json').version
-          if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -444,8 +444,8 @@ function requireNative() {
       try {
         const binding = require('@datafog/node-linux-ppc64-gnu')
         const bindingPackageVersion = require('@datafog/node-linux-ppc64-gnu/package.json').version
-        if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -460,8 +460,8 @@ function requireNative() {
       try {
         const binding = require('@datafog/node-linux-s390x-gnu')
         const bindingPackageVersion = require('@datafog/node-linux-s390x-gnu/package.json').version
-        if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -480,8 +480,8 @@ function requireNative() {
       try {
         const binding = require('@datafog/node-openharmony-arm64')
         const bindingPackageVersion = require('@datafog/node-openharmony-arm64/package.json').version
-        if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -496,8 +496,8 @@ function requireNative() {
       try {
         const binding = require('@datafog/node-openharmony-x64')
         const bindingPackageVersion = require('@datafog/node-openharmony-x64/package.json').version
-        if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -512,8 +512,8 @@ function requireNative() {
       try {
         const binding = require('@datafog/node-openharmony-arm')
         const bindingPackageVersion = require('@datafog/node-openharmony-arm/package.json').version
-        if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -652,8 +652,8 @@ if (!nativeBinding || forceWasi) {
       if (!candidateFailed) {
         if (process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
           const bindingPackageVersion = require('@datafog/node-wasm32-wasi/package.json').version
-          if (bindingPackageVersion !== '0.2.0') {
-            throw new Error(`WASI binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '0.3.0') {
+            throw new Error(`WASI binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
         }
         wasiBinding = require('@datafog/node-wasm32-wasi')
@@ -703,14 +703,24 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding`)
 }
 
-const { prepareScanAndTransform, requiredKeySelectors, requiredRestoreItems, requiredTokenizationItems, restoreWithResults, scan, scanAndTransform, transform, transformWithProviderResults, transformWithResolvedKeys } = nativeBinding
+const { discoverFields, prepareScanAndTransform, prepareStructuredScanAndTransform, requiredKeySelectors, requiredRestoreItems, requiredTokenizationItems, restoreWithResults, scan, scanAndTransform, scanStructured, structuredRequiredKeySelectors, structuredRequiredRestoreItems, structuredRequiredTokenizationItems, structuredRestoreWithResults, structuredScanAndTransform, structuredTransform, structuredTransformWithProviderResults, transform, transformWithProviderResults, transformWithResolvedKeys } = nativeBinding
+export { discoverFields }
 export { prepareScanAndTransform }
+export { prepareStructuredScanAndTransform }
 export { requiredKeySelectors }
 export { requiredRestoreItems }
 export { requiredTokenizationItems }
 export { restoreWithResults }
 export { scan }
 export { scanAndTransform }
+export { scanStructured }
+export { structuredRequiredKeySelectors }
+export { structuredRequiredRestoreItems }
+export { structuredRequiredTokenizationItems }
+export { structuredRestoreWithResults }
+export { structuredScanAndTransform }
+export { structuredTransform }
+export { structuredTransformWithProviderResults }
 export { transform }
 export { transformWithProviderResults }
 export { transformWithResolvedKeys }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datafog/node",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Fast structured PII detection for Node.js, powered by Rust",
   "license": "MIT",
   "repository": {
@@ -48,10 +48,10 @@
     "typescript": "7.0.2"
   },
   "optionalDependencies": {
-    "@datafog/node-darwin-arm64": "0.2.0",
-    "@datafog/node-darwin-x64": "0.2.0",
-    "@datafog/node-linux-x64-gnu": "0.2.0",
-    "@datafog/node-linux-arm64-gnu": "0.2.0",
-    "@datafog/node-win32-x64-msvc": "0.2.0"
+    "@datafog/node-darwin-arm64": "0.3.0",
+    "@datafog/node-darwin-x64": "0.3.0",
+    "@datafog/node-linux-x64-gnu": "0.3.0",
+    "@datafog/node-linux-arm64-gnu": "0.3.0",
+    "@datafog/node-win32-x64-msvc": "0.3.0"
   }
 }