@flowcore/sdk 1.34.0 → 1.35.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [1.35.0](https://github.com/flowcore-io/flowcore-sdk/compare/v1.34.0...v1.35.0) (2025-04-24)
+
+
+### Features
+
+* **event-type:** :sparkles: enhance PII masking schema with detailed field definitions ([955ec28](https://github.com/flowcore-io/flowcore-sdk/commit/955ec281f5d026cb4cf564a25d0cc0d977df70b6))
+
+
+### Bug Fixes
+
+* **event-type:** :art: simplify import statements and improve PII definition formatting ([8f8af77](https://github.com/flowcore-io/flowcore-sdk/commit/8f8af77d114e912b4b76e7f92559b50a6e56b0af))
+* **event-type:** :art: update PII types for improved clarity and consistency ([b8f632a](https://github.com/flowcore-io/flowcore-sdk/commit/b8f632aeff64b5b438f45cc171eb56d2bb09745b))
+
 ## [1.34.0](https://github.com/flowcore-io/flowcore-sdk/compare/v1.33.2...v1.34.0) (2025-04-23)
 
 

package/README.md

@@ -512,9 +512,42 @@ const command = new EventTypeCreateCommand({
   description: "My awesome event type",
   piiMask: {
     key: "entityId",
-    paths: [
-      { path: "$.entityId", type: "string" }
-    ]
+    schema: {
+      // Simple fields
+      name: true,               // Will be masked completely
+      email: "string",          // Will be masked as a string
+      age: "number",            // Will be masked as a number
+      isActive: "boolean",      // Will be masked as a boolean
+      
+      // Complex nested objects
+      address: {
+        street: {
+          type: "string",
+          faker: "address.streetAddress" // Uses faker.js for realistic values
+        },
+        city: "string",
+        zipCode: {
+          type: "string",
+          pattern: "\\d{5}"    // Will generate a 5-digit zip code
+        }
+      },
+      
+      // Arrays
+      phoneNumbers: {
+        type: "array",
+        count: 2,              // Will generate 2 items
+        items: "string"        // Each item will be a masked string
+      },
+      
+      // Objects with properties
+      preferences: {
+        type: "object",
+        properties: {
+          theme: "string",
+          notifications: "boolean"
+        }
+      }
+    }
   },
   piiEnabled: true
 })

package/esm/commands/event-type/event-type.create.d.ts

@@ -1,5 +1,5 @@
 import { Command } from "../../common/command.js";
-import { type EventType } from "../../contracts/event-type.js";
+import { type EventType, type PiiDefinition } from "../../contracts/event-type.js";
 /**
  * The input for the event type create command
  */
@@ -12,17 +12,12 @@ export interface EventTypeCreateInput {
     description: string;
     /** The pii mask of the event type */
     piiMask?: {
-        /** The json path to the key where the entitiy id for the PII mask is located */
+        /** The json path to the key where the entity id for the PII mask is located */
         key: string;
-        /** The paths to the fields that should be masked */
-        paths: {
-            /** The json path to the field that should be masked */
-            path: string;
-            /** The type of the field that should be masked */
-            type: "string" | "number" | "boolean";
-        }[];
+        /** Schema defining the fields that should be masked and how they should be masked */
+        schema: Record<string, PiiDefinition>;
     };
-    /** Whether the event type is active */
+    /** Whether PII masking is enabled for this event type */
     piiEnabled?: boolean;
 }
 /**

package/esm/commands/event-type/event-type.create.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"event-type.create.d.ts","sourceRoot":"","sources":["../../../src/commands/event-type/event-type.create.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAA;AACjD,OAAO,EAAE,KAAK,SAAS,EAAmB,MAAM,+BAA+B,CAAA;AAG/E;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,8BAA8B;IAC9B,UAAU,EAAE,MAAM,CAAA;IAClB,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,wCAAwC;IACxC,WAAW,EAAE,MAAM,CAAA;IACnB,qCAAqC;IACrC,OAAO,CAAC,EAAE;QACR,gFAAgF;QAChF,GAAG,EAAE,MAAM,CAAA;QACX,oDAAoD;QACpD,KAAK,EAAE;YACL,uDAAuD;YACvD,IAAI,EAAE,MAAM,CAAA;YACZ,kDAAkD;YAClD,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAA;SACtC,EAAE,CAAA;KACJ,CAAA;IACD,uCAAuC;IACvC,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,OAAO,CAAC,oBAAoB,EAAE,SAAS,CAAC;IAClF;;OAEG;IACH,UAAmB,cAAc,EAAE,OAAO,CAAQ;IAElD;;OAEG;cACgB,SAAS,IAAI,MAAM;IAGtC;;OAEG;cACgB,UAAU,IAAI,MAAM;IAIvC;;OAEG;cACgB,OAAO,IAAI,MAAM;IAIpC;;OAEG;cACgB,aAAa,CAAC,WAAW,EAAE,OAAO,GAAG,SAAS;CAGlE"}
+{"version":3,"file":"event-type.create.d.ts","sourceRoot":"","sources":["../../../src/commands/event-type/event-type.create.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAA;AACjD,OAAO,EAAE,KAAK,SAAS,EAAmB,KAAK,aAAa,EAAE,MAAM,+BAA+B,CAAA;AAGnG;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,8BAA8B;IAC9B,UAAU,EAAE,MAAM,CAAA;IAClB,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,wCAAwC;IACxC,WAAW,EAAE,MAAM,CAAA;IACnB,qCAAqC;IACrC,OAAO,CAAC,EAAE;QACR,+EAA+E;QAC/E,GAAG,EAAE,MAAM,CAAA;QACX,qFAAqF;QACrF,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;KACtC,CAAA;IACD,yDAAyD;IACzD,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,OAAO,CAAC,oBAAoB,EAAE,SAAS,CAAC;IAClF;;OAEG;IACH,UAAmB,cAAc,EAAE,OAAO,CAAQ;IAElD;;OAEG;cACgB,SAAS,IAAI,MAAM;IAGtC;;OAEG;cACgB,UAAU,IAAI,MAAM;IAIvC;;OAEG;cACgB,OAAO,IAAI,MAAM;IAIpC;;OAEG;cACgB,aAAa,CAAC,WAAW,EAAE,OAAO,GAAG,SAAS;CAGlE"}

package/esm/commands/event-type/event-type.update.d.ts

@@ -1,5 +1,5 @@
 import { Command } from "../../common/command.js";
-import { type EventType } from "../../contracts/event-type.js";
+import { type EventType, type PiiDefinition } from "../../contracts/event-type.js";
 /**
  * The input for the event type update command
  */
@@ -10,17 +10,12 @@ export type EventTypeUpdateInput = {
     description?: string;
     /** The pii mask of the event type */
     piiMask?: {
-        /** The json path to the key where the entitiy id for the PII mask is located */
+        /** The json path to the key where the entity id for the PII mask is located */
         key: string;
-        /** The paths to the fields that should be masked */
-        paths: {
-            /** The json path to the field that should be masked */
-            path: string;
-            /** The type of the field that should be masked */
-            type: "string" | "number" | "boolean";
-        }[];
+        /** Schema defining the fields that should be masked and how they should be masked */
+        schema: Record<string, PiiDefinition>;
     };
-    /** Whether the event type is active */
+    /** Whether PII masking is enabled for this event type */
     piiEnabled?: boolean;
 };
 /**

package/esm/commands/event-type/event-type.update.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"event-type.update.d.ts","sourceRoot":"","sources":["../../../src/commands/event-type/event-type.update.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAA;AACjD,OAAO,EAAE,KAAK,SAAS,EAAmB,MAAM,+BAA+B,CAAA;AAG/E;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,+BAA+B;IAC/B,WAAW,EAAE,MAAM,CAAA;IACnB,wCAAwC;IACxC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,qCAAqC;IACrC,OAAO,CAAC,EAAE;QACR,gFAAgF;QAChF,GAAG,EAAE,MAAM,CAAA;QACX,oDAAoD;QACpD,KAAK,EAAE;YACL,uDAAuD;YACvD,IAAI,EAAE,MAAM,CAAA;YACZ,kDAAkD;YAClD,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAA;SACtC,EAAE,CAAA;KACJ,CAAA;IACD,uCAAuC;IACvC,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,OAAO,CAAC,oBAAoB,EAAE,SAAS,CAAC;IAClF;;OAEG;cACgB,SAAS,IAAI,MAAM;IAGtC;;OAEG;cACgB,UAAU,IAAI,MAAM;IAIvC;;OAEG;cACgB,OAAO,IAAI,MAAM;IAIpC;;OAEG;cACgB,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAKrD;;OAEG;cACgB,aAAa,CAAC,WAAW,EAAE,OAAO,GAAG,SAAS;CAGlE"}
+{"version":3,"file":"event-type.update.d.ts","sourceRoot":"","sources":["../../../src/commands/event-type/event-type.update.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAA;AACjD,OAAO,EAAE,KAAK,SAAS,EAAmB,KAAK,aAAa,EAAE,MAAM,+BAA+B,CAAA;AAGnG;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,+BAA+B;IAC/B,WAAW,EAAE,MAAM,CAAA;IACnB,wCAAwC;IACxC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,qCAAqC;IACrC,OAAO,CAAC,EAAE;QACR,+EAA+E;QAC/E,GAAG,EAAE,MAAM,CAAA;QACX,qFAAqF;QACrF,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;KACtC,CAAA;IACD,yDAAyD;IACzD,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,OAAO,CAAC,oBAAoB,EAAE,SAAS,CAAC;IAClF;;OAEG;cACgB,SAAS,IAAI,MAAM;IAGtC;;OAEG;cACgB,UAAU,IAAI,MAAM;IAIvC;;OAEG;cACgB,OAAO,IAAI,MAAM;IAIpC;;OAEG;cACgB,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAKrD;;OAEG;cACgB,aAAa,CAAC,WAAW,EAAE,OAAO,GAAG,SAAS;CAGlE"}

package/esm/contracts/event-type.d.ts

@@ -1,29 +1,41 @@
-import { type Static, type TArray, type TBoolean, type TLiteral, type TNull, type TObject, type TString, type TUnion } from "@sinclair/typebox";
-export declare const EventTypePiiMaskTypeSchema: TObject<{
-    path: TString;
-    type: TUnion<[TLiteral<"string">, TLiteral<"number">, TLiteral<"boolean">]>;
-}>;
-export declare const EventTypePiiMaskSchema: TObject<{
-    key: TString;
-    paths: TArray<typeof EventTypePiiMaskTypeSchema>;
-}>;
+import { type Static, type TArray, type TObject, type TUnion } from "@sinclair/typebox";
+export type SimplePiiType = boolean | "string" | "number" | "boolean";
+export type DetailedPiiField = {
+    type: "string" | "number" | "boolean" | "object" | "array";
+    faker?: string;
+    args?: unknown[];
+    length?: number;
+    pattern?: string;
+    redact?: {
+        char: string;
+        length: number;
+    };
+    min?: number;
+    max?: number;
+    precision?: number;
+    count?: number;
+    items?: SimplePiiType | DetailedPiiField | Record<string, unknown>;
+    properties?: Record<string, SimplePiiType | DetailedPiiField | Record<string, unknown>>;
+};
+export type PiiDefinition = SimplePiiType | DetailedPiiField | Record<string, SimplePiiType | DetailedPiiField | Record<string, unknown>>;
+export declare const DetailedPiiFieldSchema: TObject;
+export declare const PiiDefinitionSchema: TUnion;
+export declare const EventTypePiiMaskSchema: TObject;
+export declare const EventTypePiiMaskParsedSchema: TArray<TObject>;
 /**
  * The schema for an event type
  */
-export declare const EventTypeSchema: TObject<{
-    id: TString;
-    tenantId: TString;
-    dataCoreId: TString;
-    flowTypeId: TString;
-    name: TString;
-    description: TString;
-    isTruncating: TBoolean;
-    isDeleting: TBoolean;
-    piiMask: TUnion<[typeof EventTypePiiMaskSchema, TNull]>;
-    piiEnabled: TBoolean;
-}>;
+export declare const EventTypeSchema: TObject;
 /**
  * The type for an event type
  */
 export type EventType = Static<typeof EventTypeSchema>;
+/**
+ * Type for PII mask
+ */
+export type EventTypePiiMask = Static<typeof EventTypePiiMaskSchema>;
+/**
+ * Type for parsed PII mask
+ */
+export type EventTypePiiMaskParsed = Static<typeof EventTypePiiMaskParsedSchema>;
 //# sourceMappingURL=event-type.d.ts.map

package/esm/contracts/event-type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"event-type.d.ts","sourceRoot":"","sources":["../../src/contracts/event-type.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,MAAM,EACX,KAAK,MAAM,EACX,KAAK,QAAQ,EACb,KAAK,QAAQ,EACb,KAAK,KAAK,EACV,KAAK,OAAO,EACZ,KAAK,OAAO,EACZ,KAAK,MAAM,EAEZ,MAAM,mBAAmB,CAAA;AAE1B,eAAO,MAAM,0BAA0B,EAAE,OAAO,CAAC;IAC/C,IAAI,EAAE,OAAO,CAAA;IACb,IAAI,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;CAC5E,CAGC,CAAA;AAEF,eAAO,MAAM,sBAAsB,EAAE,OAAO,CAAC;IAC3C,GAAG,EAAE,OAAO,CAAA;IACZ,KAAK,EAAE,MAAM,CAAC,OAAO,0BAA0B,CAAC,CAAA;CACjD,CAGC,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,OAAO,CAAC;IACpC,EAAE,EAAE,OAAO,CAAA;IACX,QAAQ,EAAE,OAAO,CAAA;IACjB,UAAU,EAAE,OAAO,CAAA;IACnB,UAAU,EAAE,OAAO,CAAA;IACnB,IAAI,EAAE,OAAO,CAAA;IACb,WAAW,EAAE,OAAO,CAAA;IACpB,YAAY,EAAE,QAAQ,CAAA;IACtB,UAAU,EAAE,QAAQ,CAAA;IACpB,OAAO,EAAE,MAAM,CAAC,CAAC,OAAO,sBAAsB,EAAE,KAAK,CAAC,CAAC,CAAA;IACvD,UAAU,EAAE,QAAQ,CAAA;CACrB,CAWC,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,eAAe,CAAC,CAAA"}
+{"version":3,"file":"event-type.d.ts","sourceRoot":"","sources":["../../src/contracts/event-type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,MAAM,EAAE,KAAK,OAAO,EAAE,KAAK,MAAM,EAAQ,MAAM,mBAAmB,CAAA;AAG7F,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAA;AAErE,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAO,CAAA;IAC1D,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,OAAO,EAAE,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE;QACP,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,EAAE,MAAM,CAAA;KACf,CAAA;IACD,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,aAAa,GAAG,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAClE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,GAAG,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;CACxF,CAAA;AAGD,MAAM,MAAM,aAAa,GACrB,aAAa,GACb,gBAAgB,GAChB,MAAM,CAAC,MAAM,EAAE,aAAa,GAAG,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;AAE9E,eAAO,MAAM,sBAAsB,EAAE,OA6BnC,CAAA;AAEF,eAAO,MAAM,mBAAmB,EAAE,MAKhC,CAAA;AAEF,eAAO,MAAM,sBAAsB,EAAE,OAGnC,CAAA;AAEF,eAAO,MAAM,4BAA4B,EAAE,MAAM,CAAC,OAAO,CA6BxD,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,OAc5B,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,eAAe,CAAC,CAAA;AAEtD;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAEpE;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC,OAAO,4BAA4B,CAAC,CAAA"}

package/esm/contracts/event-type.js

@@ -1,12 +1,63 @@
-import { Type, } from "@sinclair/typebox";
-export const EventTypePiiMaskTypeSchema = Type.Object({
-    path: Type.String(),
-    type: Type.Union([Type.Literal("string"), Type.Literal("number"), Type.Literal("boolean")]),
+import { Type } from "@sinclair/typebox";
+export const DetailedPiiFieldSchema = Type.Object({
+    type: Type.Union([
+        Type.Literal("string"),
+        Type.Literal("number"),
+        Type.Literal("boolean"),
+        Type.Literal("object"),
+        Type.Literal("array"),
+    ]),
+    faker: Type.Optional(Type.String()),
+    args: Type.Optional(Type.Array(Type.Unknown())),
+    length: Type.Optional(Type.Number()),
+    pattern: Type.Optional(Type.String()),
+    redact: Type.Optional(Type.Object({
+        char: Type.String({ minLength: 1, maxLength: 1 }),
+        length: Type.Number({ minimum: 1 }),
+    })),
+    min: Type.Optional(Type.Number()),
+    max: Type.Optional(Type.Number()),
+    precision: Type.Optional(Type.Number()),
+    count: Type.Optional(Type.Number()),
+    items: Type.Optional(Type.Unknown()),
+    properties: Type.Optional(Type.Record(Type.String(), Type.Unknown())),
 });
+export const PiiDefinitionSchema = Type.Union([
+    Type.Literal(true),
+    Type.Union([Type.Literal("string"), Type.Literal("number"), Type.Literal("boolean")]),
+    DetailedPiiFieldSchema,
+    Type.Record(Type.String(), Type.Unknown()),
+]);
 export const EventTypePiiMaskSchema = Type.Object({
     key: Type.String(),
-    paths: Type.Array(EventTypePiiMaskTypeSchema),
+    schema: Type.Record(Type.String(), PiiDefinitionSchema),
 });
+export const EventTypePiiMaskParsedSchema = Type.Array(Type.Object({
+    path: Type.String(),
+    definition: Type.Object({
+        type: Type.Union([
+            Type.Literal("string"),
+            Type.Literal("number"),
+            Type.Literal("boolean"),
+            Type.Literal("object"),
+            Type.Literal("array"),
+        ]),
+        faker: Type.Optional(Type.String()),
+        args: Type.Array(Type.Unknown()),
+        length: Type.Optional(Type.Number()),
+        pattern: Type.Optional(Type.String()),
+        min: Type.Optional(Type.Number()),
+        max: Type.Optional(Type.Number()),
+        precision: Type.Optional(Type.Number()),
+        count: Type.Optional(Type.Number()),
+        items: Type.Optional(Type.Unknown()),
+        properties: Type.Optional(Type.Record(Type.String(), Type.Unknown())),
+        redact: Type.Optional(Type.Object({
+            char: Type.String(),
+            length: Type.Number(),
+        })),
+    }),
+}));
 /**
  * The schema for an event type
  */
@@ -19,6 +70,9 @@ export const EventTypeSchema = Type.Object({
     description: Type.String(),
     isTruncating: Type.Boolean(),
     isDeleting: Type.Boolean(),
+    createdAt: Type.String(),
+    updatedAt: Type.Union([Type.String(), Type.Null()]),
     piiMask: Type.Union([EventTypePiiMaskSchema, Type.Null()]),
+    piiMaskParsed: Type.Union([EventTypePiiMaskParsedSchema, Type.Null()]),
     piiEnabled: Type.Boolean(),
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowcore/sdk",
-  "version": "1.34.0",
+  "version": "1.35.0",
   "description": "Flowcore SDK",
   "homepage": "https://github.com/flowcore-io/flowcore-sdk#readme",
   "repository": {

package/script/commands/event-type/event-type.create.d.ts

@@ -1,5 +1,5 @@
 import { Command } from "../../common/command.js";
-import { type EventType } from "../../contracts/event-type.js";
+import { type EventType, type PiiDefinition } from "../../contracts/event-type.js";
 /**
  * The input for the event type create command
  */
@@ -12,17 +12,12 @@ export interface EventTypeCreateInput {
     description: string;
     /** The pii mask of the event type */
     piiMask?: {
-        /** The json path to the key where the entitiy id for the PII mask is located */
+        /** The json path to the key where the entity id for the PII mask is located */
         key: string;
-        /** The paths to the fields that should be masked */
-        paths: {
-            /** The json path to the field that should be masked */
-            path: string;
-            /** The type of the field that should be masked */
-            type: "string" | "number" | "boolean";
-        }[];
+        /** Schema defining the fields that should be masked and how they should be masked */
+        schema: Record<string, PiiDefinition>;
     };
-    /** Whether the event type is active */
+    /** Whether PII masking is enabled for this event type */
     piiEnabled?: boolean;
 }
 /**

package/script/commands/event-type/event-type.create.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"event-type.create.d.ts","sourceRoot":"","sources":["../../../src/commands/event-type/event-type.create.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAA;AACjD,OAAO,EAAE,KAAK,SAAS,EAAmB,MAAM,+BAA+B,CAAA;AAG/E;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,8BAA8B;IAC9B,UAAU,EAAE,MAAM,CAAA;IAClB,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,wCAAwC;IACxC,WAAW,EAAE,MAAM,CAAA;IACnB,qCAAqC;IACrC,OAAO,CAAC,EAAE;QACR,gFAAgF;QAChF,GAAG,EAAE,MAAM,CAAA;QACX,oDAAoD;QACpD,KAAK,EAAE;YACL,uDAAuD;YACvD,IAAI,EAAE,MAAM,CAAA;YACZ,kDAAkD;YAClD,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAA;SACtC,EAAE,CAAA;KACJ,CAAA;IACD,uCAAuC;IACvC,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,OAAO,CAAC,oBAAoB,EAAE,SAAS,CAAC;IAClF;;OAEG;IACH,UAAmB,cAAc,EAAE,OAAO,CAAQ;IAElD;;OAEG;cACgB,SAAS,IAAI,MAAM;IAGtC;;OAEG;cACgB,UAAU,IAAI,MAAM;IAIvC;;OAEG;cACgB,OAAO,IAAI,MAAM;IAIpC;;OAEG;cACgB,aAAa,CAAC,WAAW,EAAE,OAAO,GAAG,SAAS;CAGlE"}
+{"version":3,"file":"event-type.create.d.ts","sourceRoot":"","sources":["../../../src/commands/event-type/event-type.create.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAA;AACjD,OAAO,EAAE,KAAK,SAAS,EAAmB,KAAK,aAAa,EAAE,MAAM,+BAA+B,CAAA;AAGnG;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,8BAA8B;IAC9B,UAAU,EAAE,MAAM,CAAA;IAClB,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,wCAAwC;IACxC,WAAW,EAAE,MAAM,CAAA;IACnB,qCAAqC;IACrC,OAAO,CAAC,EAAE;QACR,+EAA+E;QAC/E,GAAG,EAAE,MAAM,CAAA;QACX,qFAAqF;QACrF,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;KACtC,CAAA;IACD,yDAAyD;IACzD,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,OAAO,CAAC,oBAAoB,EAAE,SAAS,CAAC;IAClF;;OAEG;IACH,UAAmB,cAAc,EAAE,OAAO,CAAQ;IAElD;;OAEG;cACgB,SAAS,IAAI,MAAM;IAGtC;;OAEG;cACgB,UAAU,IAAI,MAAM;IAIvC;;OAEG;cACgB,OAAO,IAAI,MAAM;IAIpC;;OAEG;cACgB,aAAa,CAAC,WAAW,EAAE,OAAO,GAAG,SAAS;CAGlE"}

package/script/commands/event-type/event-type.update.d.ts

@@ -1,5 +1,5 @@
 import { Command } from "../../common/command.js";
-import { type EventType } from "../../contracts/event-type.js";
+import { type EventType, type PiiDefinition } from "../../contracts/event-type.js";
 /**
  * The input for the event type update command
  */
@@ -10,17 +10,12 @@ export type EventTypeUpdateInput = {
     description?: string;
     /** The pii mask of the event type */
     piiMask?: {
-        /** The json path to the key where the entitiy id for the PII mask is located */
+        /** The json path to the key where the entity id for the PII mask is located */
         key: string;
-        /** The paths to the fields that should be masked */
-        paths: {
-            /** The json path to the field that should be masked */
-            path: string;
-            /** The type of the field that should be masked */
-            type: "string" | "number" | "boolean";
-        }[];
+        /** Schema defining the fields that should be masked and how they should be masked */
+        schema: Record<string, PiiDefinition>;
     };
-    /** Whether the event type is active */
+    /** Whether PII masking is enabled for this event type */
     piiEnabled?: boolean;
 };
 /**

package/script/commands/event-type/event-type.update.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"event-type.update.d.ts","sourceRoot":"","sources":["../../../src/commands/event-type/event-type.update.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAA;AACjD,OAAO,EAAE,KAAK,SAAS,EAAmB,MAAM,+BAA+B,CAAA;AAG/E;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,+BAA+B;IAC/B,WAAW,EAAE,MAAM,CAAA;IACnB,wCAAwC;IACxC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,qCAAqC;IACrC,OAAO,CAAC,EAAE;QACR,gFAAgF;QAChF,GAAG,EAAE,MAAM,CAAA;QACX,oDAAoD;QACpD,KAAK,EAAE;YACL,uDAAuD;YACvD,IAAI,EAAE,MAAM,CAAA;YACZ,kDAAkD;YAClD,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAA;SACtC,EAAE,CAAA;KACJ,CAAA;IACD,uCAAuC;IACvC,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,OAAO,CAAC,oBAAoB,EAAE,SAAS,CAAC;IAClF;;OAEG;cACgB,SAAS,IAAI,MAAM;IAGtC;;OAEG;cACgB,UAAU,IAAI,MAAM;IAIvC;;OAEG;cACgB,OAAO,IAAI,MAAM;IAIpC;;OAEG;cACgB,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAKrD;;OAEG;cACgB,aAAa,CAAC,WAAW,EAAE,OAAO,GAAG,SAAS;CAGlE"}
+{"version":3,"file":"event-type.update.d.ts","sourceRoot":"","sources":["../../../src/commands/event-type/event-type.update.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAA;AACjD,OAAO,EAAE,KAAK,SAAS,EAAmB,KAAK,aAAa,EAAE,MAAM,+BAA+B,CAAA;AAGnG;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,+BAA+B;IAC/B,WAAW,EAAE,MAAM,CAAA;IACnB,wCAAwC;IACxC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,qCAAqC;IACrC,OAAO,CAAC,EAAE;QACR,+EAA+E;QAC/E,GAAG,EAAE,MAAM,CAAA;QACX,qFAAqF;QACrF,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;KACtC,CAAA;IACD,yDAAyD;IACzD,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,OAAO,CAAC,oBAAoB,EAAE,SAAS,CAAC;IAClF;;OAEG;cACgB,SAAS,IAAI,MAAM;IAGtC;;OAEG;cACgB,UAAU,IAAI,MAAM;IAIvC;;OAEG;cACgB,OAAO,IAAI,MAAM;IAIpC;;OAEG;cACgB,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAKrD;;OAEG;cACgB,aAAa,CAAC,WAAW,EAAE,OAAO,GAAG,SAAS;CAGlE"}

package/script/contracts/event-type.d.ts

@@ -1,29 +1,41 @@
-import { type Static, type TArray, type TBoolean, type TLiteral, type TNull, type TObject, type TString, type TUnion } from "@sinclair/typebox";
-export declare const EventTypePiiMaskTypeSchema: TObject<{
-    path: TString;
-    type: TUnion<[TLiteral<"string">, TLiteral<"number">, TLiteral<"boolean">]>;
-}>;
-export declare const EventTypePiiMaskSchema: TObject<{
-    key: TString;
-    paths: TArray<typeof EventTypePiiMaskTypeSchema>;
-}>;
+import { type Static, type TArray, type TObject, type TUnion } from "@sinclair/typebox";
+export type SimplePiiType = boolean | "string" | "number" | "boolean";
+export type DetailedPiiField = {
+    type: "string" | "number" | "boolean" | "object" | "array";
+    faker?: string;
+    args?: unknown[];
+    length?: number;
+    pattern?: string;
+    redact?: {
+        char: string;
+        length: number;
+    };
+    min?: number;
+    max?: number;
+    precision?: number;
+    count?: number;
+    items?: SimplePiiType | DetailedPiiField | Record<string, unknown>;
+    properties?: Record<string, SimplePiiType | DetailedPiiField | Record<string, unknown>>;
+};
+export type PiiDefinition = SimplePiiType | DetailedPiiField | Record<string, SimplePiiType | DetailedPiiField | Record<string, unknown>>;
+export declare const DetailedPiiFieldSchema: TObject;
+export declare const PiiDefinitionSchema: TUnion;
+export declare const EventTypePiiMaskSchema: TObject;
+export declare const EventTypePiiMaskParsedSchema: TArray<TObject>;
 /**
  * The schema for an event type
  */
-export declare const EventTypeSchema: TObject<{
-    id: TString;
-    tenantId: TString;
-    dataCoreId: TString;
-    flowTypeId: TString;
-    name: TString;
-    description: TString;
-    isTruncating: TBoolean;
-    isDeleting: TBoolean;
-    piiMask: TUnion<[typeof EventTypePiiMaskSchema, TNull]>;
-    piiEnabled: TBoolean;
-}>;
+export declare const EventTypeSchema: TObject;
 /**
  * The type for an event type
  */
 export type EventType = Static<typeof EventTypeSchema>;
+/**
+ * Type for PII mask
+ */
+export type EventTypePiiMask = Static<typeof EventTypePiiMaskSchema>;
+/**
+ * Type for parsed PII mask
+ */
+export type EventTypePiiMaskParsed = Static<typeof EventTypePiiMaskParsedSchema>;
 //# sourceMappingURL=event-type.d.ts.map

package/script/contracts/event-type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"event-type.d.ts","sourceRoot":"","sources":["../../src/contracts/event-type.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,MAAM,EACX,KAAK,MAAM,EACX,KAAK,QAAQ,EACb,KAAK,QAAQ,EACb,KAAK,KAAK,EACV,KAAK,OAAO,EACZ,KAAK,OAAO,EACZ,KAAK,MAAM,EAEZ,MAAM,mBAAmB,CAAA;AAE1B,eAAO,MAAM,0BAA0B,EAAE,OAAO,CAAC;IAC/C,IAAI,EAAE,OAAO,CAAA;IACb,IAAI,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;CAC5E,CAGC,CAAA;AAEF,eAAO,MAAM,sBAAsB,EAAE,OAAO,CAAC;IAC3C,GAAG,EAAE,OAAO,CAAA;IACZ,KAAK,EAAE,MAAM,CAAC,OAAO,0BAA0B,CAAC,CAAA;CACjD,CAGC,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,OAAO,CAAC;IACpC,EAAE,EAAE,OAAO,CAAA;IACX,QAAQ,EAAE,OAAO,CAAA;IACjB,UAAU,EAAE,OAAO,CAAA;IACnB,UAAU,EAAE,OAAO,CAAA;IACnB,IAAI,EAAE,OAAO,CAAA;IACb,WAAW,EAAE,OAAO,CAAA;IACpB,YAAY,EAAE,QAAQ,CAAA;IACtB,UAAU,EAAE,QAAQ,CAAA;IACpB,OAAO,EAAE,MAAM,CAAC,CAAC,OAAO,sBAAsB,EAAE,KAAK,CAAC,CAAC,CAAA;IACvD,UAAU,EAAE,QAAQ,CAAA;CACrB,CAWC,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,eAAe,CAAC,CAAA"}
+{"version":3,"file":"event-type.d.ts","sourceRoot":"","sources":["../../src/contracts/event-type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,MAAM,EAAE,KAAK,OAAO,EAAE,KAAK,MAAM,EAAQ,MAAM,mBAAmB,CAAA;AAG7F,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAA;AAErE,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAO,CAAA;IAC1D,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,OAAO,EAAE,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE;QACP,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,EAAE,MAAM,CAAA;KACf,CAAA;IACD,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,aAAa,GAAG,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAClE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,GAAG,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;CACxF,CAAA;AAGD,MAAM,MAAM,aAAa,GACrB,aAAa,GACb,gBAAgB,GAChB,MAAM,CAAC,MAAM,EAAE,aAAa,GAAG,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;AAE9E,eAAO,MAAM,sBAAsB,EAAE,OA6BnC,CAAA;AAEF,eAAO,MAAM,mBAAmB,EAAE,MAKhC,CAAA;AAEF,eAAO,MAAM,sBAAsB,EAAE,OAGnC,CAAA;AAEF,eAAO,MAAM,4BAA4B,EAAE,MAAM,CAAC,OAAO,CA6BxD,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,OAc5B,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,eAAe,CAAC,CAAA;AAEtD;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAEpE;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC,OAAO,4BAA4B,CAAC,CAAA"}

package/script/contracts/event-type.js

@@ -1,15 +1,66 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EventTypeSchema = exports.EventTypePiiMaskSchema = exports.EventTypePiiMaskTypeSchema = void 0;
+exports.EventTypeSchema = exports.EventTypePiiMaskParsedSchema = exports.EventTypePiiMaskSchema = exports.PiiDefinitionSchema = exports.DetailedPiiFieldSchema = void 0;
 const typebox_1 = require("@sinclair/typebox");
-exports.EventTypePiiMaskTypeSchema = typebox_1.Type.Object({
-    path: typebox_1.Type.String(),
-    type: typebox_1.Type.Union([typebox_1.Type.Literal("string"), typebox_1.Type.Literal("number"), typebox_1.Type.Literal("boolean")]),
+exports.DetailedPiiFieldSchema = typebox_1.Type.Object({
+    type: typebox_1.Type.Union([
+        typebox_1.Type.Literal("string"),
+        typebox_1.Type.Literal("number"),
+        typebox_1.Type.Literal("boolean"),
+        typebox_1.Type.Literal("object"),
+        typebox_1.Type.Literal("array"),
+    ]),
+    faker: typebox_1.Type.Optional(typebox_1.Type.String()),
+    args: typebox_1.Type.Optional(typebox_1.Type.Array(typebox_1.Type.Unknown())),
+    length: typebox_1.Type.Optional(typebox_1.Type.Number()),
+    pattern: typebox_1.Type.Optional(typebox_1.Type.String()),
+    redact: typebox_1.Type.Optional(typebox_1.Type.Object({
+        char: typebox_1.Type.String({ minLength: 1, maxLength: 1 }),
+        length: typebox_1.Type.Number({ minimum: 1 }),
+    })),
+    min: typebox_1.Type.Optional(typebox_1.Type.Number()),
+    max: typebox_1.Type.Optional(typebox_1.Type.Number()),
+    precision: typebox_1.Type.Optional(typebox_1.Type.Number()),
+    count: typebox_1.Type.Optional(typebox_1.Type.Number()),
+    items: typebox_1.Type.Optional(typebox_1.Type.Unknown()),
+    properties: typebox_1.Type.Optional(typebox_1.Type.Record(typebox_1.Type.String(), typebox_1.Type.Unknown())),
 });
+exports.PiiDefinitionSchema = typebox_1.Type.Union([
+    typebox_1.Type.Literal(true),
+    typebox_1.Type.Union([typebox_1.Type.Literal("string"), typebox_1.Type.Literal("number"), typebox_1.Type.Literal("boolean")]),
+    exports.DetailedPiiFieldSchema,
+    typebox_1.Type.Record(typebox_1.Type.String(), typebox_1.Type.Unknown()),
+]);
 exports.EventTypePiiMaskSchema = typebox_1.Type.Object({
     key: typebox_1.Type.String(),
-    paths: typebox_1.Type.Array(exports.EventTypePiiMaskTypeSchema),
+    schema: typebox_1.Type.Record(typebox_1.Type.String(), exports.PiiDefinitionSchema),
 });
+exports.EventTypePiiMaskParsedSchema = typebox_1.Type.Array(typebox_1.Type.Object({
+    path: typebox_1.Type.String(),
+    definition: typebox_1.Type.Object({
+        type: typebox_1.Type.Union([
+            typebox_1.Type.Literal("string"),
+            typebox_1.Type.Literal("number"),
+            typebox_1.Type.Literal("boolean"),
+            typebox_1.Type.Literal("object"),
+            typebox_1.Type.Literal("array"),
+        ]),
+        faker: typebox_1.Type.Optional(typebox_1.Type.String()),
+        args: typebox_1.Type.Array(typebox_1.Type.Unknown()),
+        length: typebox_1.Type.Optional(typebox_1.Type.Number()),
+        pattern: typebox_1.Type.Optional(typebox_1.Type.String()),
+        min: typebox_1.Type.Optional(typebox_1.Type.Number()),
+        max: typebox_1.Type.Optional(typebox_1.Type.Number()),
+        precision: typebox_1.Type.Optional(typebox_1.Type.Number()),
+        count: typebox_1.Type.Optional(typebox_1.Type.Number()),
+        items: typebox_1.Type.Optional(typebox_1.Type.Unknown()),
+        properties: typebox_1.Type.Optional(typebox_1.Type.Record(typebox_1.Type.String(), typebox_1.Type.Unknown())),
+        redact: typebox_1.Type.Optional(typebox_1.Type.Object({
+            char: typebox_1.Type.String(),
+            length: typebox_1.Type.Number(),
+        })),
+    }),
+}));
 /**
  * The schema for an event type
  */
@@ -22,6 +73,9 @@ exports.EventTypeSchema = typebox_1.Type.Object({
     description: typebox_1.Type.String(),
     isTruncating: typebox_1.Type.Boolean(),
     isDeleting: typebox_1.Type.Boolean(),
+    createdAt: typebox_1.Type.String(),
+    updatedAt: typebox_1.Type.Union([typebox_1.Type.String(), typebox_1.Type.Null()]),
     piiMask: typebox_1.Type.Union([exports.EventTypePiiMaskSchema, typebox_1.Type.Null()]),
+    piiMaskParsed: typebox_1.Type.Union([exports.EventTypePiiMaskParsedSchema, typebox_1.Type.Null()]),
     piiEnabled: typebox_1.Type.Boolean(),
 });