@flowcore/sdk 1.35.0 → 1.35.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/esm/commands/event-type/event-type.info.js +1 -1
  3. package/esm/contracts/event-type.d.ts +75 -6
  4. package/esm/contracts/event-type.d.ts.map +1 -1
  5. package/esm/contracts/event-type.js +26 -1
  6. package/package.json +1 -1
  7. package/script/commands/event-type/event-type.info.js +1 -1
  8. package/script/contracts/event-type.d.ts +75 -6
  9. package/script/contracts/event-type.d.ts.map +1 -1
  10. package/script/contracts/event-type.js +25 -0
package/CHANGELOG.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # Changelog
2
2
 
3
+ ## [1.35.2](https://github.com/flowcore-io/flowcore-sdk/compare/v1.35.1...v1.35.2) (2025-04-27)
4
+
5
+
6
+ ### Bug Fixes
7
+
8
+ * **event-type:** :art: enhance type definitions and add detailed schema documentation ([8da86d3](https://github.com/flowcore-io/flowcore-sdk/commit/8da86d3ab98b0de4e76c1f01ef8666cc8485caf5))
9
+
10
+ ## [1.35.1](https://github.com/flowcore-io/flowcore-sdk/compare/v1.35.0...v1.35.1) (2025-04-27)
11
+
12
+
13
+ ### Bug Fixes
14
+
15
+ * **event-type:** :bug: ensure pageSize does not exceed 100 ([90f868a](https://github.com/flowcore-io/flowcore-sdk/commit/90f868a761371bafcad1a6b20c931f1d2f89eb53))
16
+
3
17
  ## [1.35.0](https://github.com/flowcore-io/flowcore-sdk/compare/v1.34.0...v1.35.0) (2025-04-24)
4
18
 
5
19
 
package/esm/commands/event-type/event-type.info.js CHANGED
@@ -22,7 +22,7 @@ export class EventTypeInfoCommand extends CustomCommand {
22
22
  tenant: this.input.tenant,
23
23
  eventTypeId: this.input.eventTypeId,
24
24
  order: "desc",
25
- pageSize: lastEventsLimit,
25
+ pageSize: Math.max(lastEventsLimit, 100),
26
26
  });
27
27
  const [firstTimeBucketResponse, lastTimeBucketResponse] = await Promise.all([
28
28
  client.execute(firstTimeBucketCommand),
package/esm/contracts/event-type.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { type Static, type TArray, type TObject, type TUnion } from "@sinclair/typebox";
1
+ import { type Static, type TArray, type TBoolean, type TLiteral, type TNull, type TNumber, type TObject, type TOptional, type TRecord, type TString, type TUnion, type TUnknown } from "@sinclair/typebox";
2
2
  export type SimplePiiType = boolean | "string" | "number" | "boolean";
3
3
  export type DetailedPiiField = {
4
4
  type: "string" | "number" | "boolean" | "object" | "array";
@@ -18,14 +18,83 @@ export type DetailedPiiField = {
18
18
  properties?: Record<string, SimplePiiType | DetailedPiiField | Record<string, unknown>>;
19
19
  };
20
20
  export type PiiDefinition = SimplePiiType | DetailedPiiField | Record<string, SimplePiiType | DetailedPiiField | Record<string, unknown>>;
21
- export declare const DetailedPiiFieldSchema: TObject;
22
- export declare const PiiDefinitionSchema: TUnion;
23
- export declare const EventTypePiiMaskSchema: TObject;
24
- export declare const EventTypePiiMaskParsedSchema: TArray<TObject>;
21
+ /**
22
+ * The schema for a detailed PII field
23
+ */
24
+ export declare const DetailedPiiFieldSchema: TObject<{
25
+ type: TUnion<[TLiteral<"string">, TLiteral<"number">, TLiteral<"boolean">, TLiteral<"object">, TLiteral<"array">]>;
26
+ faker: TOptional<TString>;
27
+ args: TOptional<TArray<TUnknown>>;
28
+ length: TOptional<TNumber>;
29
+ pattern: TOptional<TString>;
30
+ redact: TOptional<TObject<{
31
+ char: TString;
32
+ length: TNumber;
33
+ }>>;
34
+ min: TOptional<TNumber>;
35
+ max: TOptional<TNumber>;
36
+ precision: TOptional<TNumber>;
37
+ count: TOptional<TNumber>;
38
+ items: TOptional<TUnknown>;
39
+ properties: TOptional<TRecord<TString, TUnknown>>;
40
+ }>;
41
+ /**
42
+ * The schema for a PII definition
43
+ */
44
+ export declare const PiiDefinitionSchema: TUnion<[
45
+ TLiteral<true>,
46
+ TUnion<[TLiteral<"string">, TLiteral<"number">, TLiteral<"boolean">]>,
47
+ typeof DetailedPiiFieldSchema,
48
+ TRecord<TString, TUnknown>
49
+ ]>;
50
+ /**
51
+ * The schema for an event type PII mask
52
+ */
53
+ export declare const EventTypePiiMaskSchema: TObject<{
54
+ key: TString;
55
+ schema: TRecord<TString, typeof PiiDefinitionSchema>;
56
+ }>;
57
+ /**
58
+ * The schema for an event type PII mask parsed
59
+ */
60
+ export declare const EventTypePiiMaskParsedSchema: TArray<TObject<{
61
+ path: TString;
62
+ definition: TObject<{
63
+ type: TUnion<[TLiteral<"string">, TLiteral<"number">, TLiteral<"boolean">, TLiteral<"object">, TLiteral<"array">]>;
64
+ faker: TOptional<TString>;
65
+ args: TArray<TUnknown>;
66
+ length: TOptional<TNumber>;
67
+ pattern: TOptional<TString>;
68
+ min: TOptional<TNumber>;
69
+ max: TOptional<TNumber>;
70
+ precision: TOptional<TNumber>;
71
+ count: TOptional<TNumber>;
72
+ items: TOptional<TUnknown>;
73
+ properties: TOptional<TRecord<TString, TUnknown>>;
74
+ redact: TOptional<TObject<{
75
+ char: TString;
76
+ length: TNumber;
77
+ }>>;
78
+ }>;
79
+ }>>;
25
80
  /**
26
81
  * The schema for an event type
27
82
  */
28
- export declare const EventTypeSchema: TObject;
83
+ export declare const EventTypeSchema: TObject<{
84
+ id: TString;
85
+ tenantId: TString;
86
+ dataCoreId: TString;
87
+ flowTypeId: TString;
88
+ name: TString;
89
+ description: TString;
90
+ isTruncating: TBoolean;
91
+ isDeleting: TBoolean;
92
+ createdAt: TString;
93
+ updatedAt: TUnion<[TString, TNull]>;
94
+ piiMask: TUnion<[typeof EventTypePiiMaskSchema, TNull]>;
95
+ piiMaskParsed: TUnion<[typeof EventTypePiiMaskParsedSchema, TNull]>;
96
+ piiEnabled: TBoolean;
97
+ }>;
29
98
  /**
30
99
  * The type for an event type
31
100
  */
package/esm/contracts/event-type.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"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"}
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,SAAS,EACd,KAAK,OAAO,EACZ,KAAK,OAAO,EACZ,KAAK,MAAM,EACX,KAAK,QAAQ,EAEd,MAAM,mBAAmB,CAAA;AAG1B,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;;GAEG;AACH,eAAO,MAAM,sBAAsB,EAAE,OAAO,CAAC;IAC3C,IAAI,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;IAClH,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;IACzB,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAA;IACjC,MAAM,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;IAC1B,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;IAC3B,MAAM,EAAE,SAAS,CACf,OAAO,CAAC;QACN,IAAI,EAAE,OAAO,CAAA;QACb,MAAM,EAAE,OAAO,CAAA;KAChB,CAAC,CACH,CAAA;IACD,GAAG,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;IACvB,GAAG,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;IACvB,SAAS,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;IAC7B,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;IACzB,KAAK,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAA;IAC1B,UAAU,EAAE,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAA;CAClD,CA6BC,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB,EAAE,MAAM,CACtC;IACE,QAAQ,CAAC,IAAI,CAAC;IACd,MAAM,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;IACrE,OAAO,sBAAsB;IAC7B,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC;CAC3B,CAMD,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,sBAAsB,EAAE,OAAO,CAAC;IAC3C,GAAG,EAAE,OAAO,CAAA;IACZ,MAAM,EAAE,OAAO,CAAC,OAAO,EAAE,OAAO,mBAAmB,CAAC,CAAA;CACrD,CAGC,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,4BAA4B,EAAE,MAAM,CAC/C,OAAO,CAAC;IACN,IAAI,EAAE,OAAO,CAAA;IACb,UAAU,EAAE,OAAO,CAAC;QAClB,IAAI,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;QAClH,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;QACzB,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAA;QACtB,MAAM,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;QAC1B,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;QAC3B,GAAG,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;QACvB,GAAG,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;QACvB,SAAS,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;QAC7B,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;QACzB,KAAK,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAA;QAC1B,UAAU,EAAE,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAA;QACjD,MAAM,EAAE,SAAS,CACf,OAAO,CAAC;YACN,IAAI,EAAE,OAAO,CAAA;YACb,MAAM,EAAE,OAAO,CAAA;SAChB,CAAC,CACH,CAAA;KACF,CAAC,CAAA;CACH,CAAC,CA8BH,CAAA;AAED;;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,SAAS,EAAE,OAAO,CAAA;IAClB,SAAS,EAAE,MAAM,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAA;IACnC,OAAO,EAAE,MAAM,CAAC,CAAC,OAAO,sBAAsB,EAAE,KAAK,CAAC,CAAC,CAAA;IACvD,aAAa,EAAE,MAAM,CAAC,CAAC,OAAO,4BAA4B,EAAE,KAAK,CAAC,CAAC,CAAA;IACnE,UAAU,EAAE,QAAQ,CAAA;CACrB,CA2BC,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 CHANGED
@@ -1,4 +1,7 @@
1
- import { Type } from "@sinclair/typebox";
1
+ import { Type, } from "@sinclair/typebox";
2
+ /**
3
+ * The schema for a detailed PII field
4
+ */
2
5
  export const DetailedPiiFieldSchema = Type.Object({
3
6
  type: Type.Union([
4
7
  Type.Literal("string"),
@@ -22,16 +25,25 @@ export const DetailedPiiFieldSchema = Type.Object({
22
25
  items: Type.Optional(Type.Unknown()),
23
26
  properties: Type.Optional(Type.Record(Type.String(), Type.Unknown())),
24
27
  });
28
+ /**
29
+ * The schema for a PII definition
30
+ */
25
31
  export const PiiDefinitionSchema = Type.Union([
26
32
  Type.Literal(true),
27
33
  Type.Union([Type.Literal("string"), Type.Literal("number"), Type.Literal("boolean")]),
28
34
  DetailedPiiFieldSchema,
29
35
  Type.Record(Type.String(), Type.Unknown()),
30
36
  ]);
37
+ /**
38
+ * The schema for an event type PII mask
39
+ */
31
40
  export const EventTypePiiMaskSchema = Type.Object({
32
41
  key: Type.String(),
33
42
  schema: Type.Record(Type.String(), PiiDefinitionSchema),
34
43
  });
44
+ /**
45
+ * The schema for an event type PII mask parsed
46
+ */
35
47
  export const EventTypePiiMaskParsedSchema = Type.Array(Type.Object({
36
48
  path: Type.String(),
37
49
  definition: Type.Object({
@@ -62,17 +74,30 @@ export const EventTypePiiMaskParsedSchema = Type.Array(Type.Object({
62
74
  * The schema for an event type
63
75
  */
64
76
  export const EventTypeSchema = Type.Object({
77
+ /** Unique identifier for the event type */
65
78
  id: Type.String(),
79
+ /** ID of the tenant that owns this event type */
66
80
  tenantId: Type.String(),
81
+ /** ID of the data core this event type belongs to */
67
82
  dataCoreId: Type.String(),
83
+ /** ID of the flow type this event type belongs to */
68
84
  flowTypeId: Type.String(),
85
+ /** Name of the event type */
69
86
  name: Type.String(),
87
+ /** Description of the event type */
70
88
  description: Type.String(),
89
+ /** Indicates if the event type is currently being truncated */
71
90
  isTruncating: Type.Boolean(),
91
+ /** Indicates if the event type is currently being deleted */
72
92
  isDeleting: Type.Boolean(),
93
+ /** Creation timestamp */
73
94
  createdAt: Type.String(),
95
+ /** Last update timestamp */
74
96
  updatedAt: Type.Union([Type.String(), Type.Null()]),
97
+ /** PII mask configuration */
75
98
  piiMask: Type.Union([EventTypePiiMaskSchema, Type.Null()]),
99
+ /** Parsed PII mask configuration */
76
100
  piiMaskParsed: Type.Union([EventTypePiiMaskParsedSchema, Type.Null()]),
101
+ /** Indicates if PII handling is enabled */
77
102
  piiEnabled: Type.Boolean(),
78
103
  });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@flowcore/sdk",
3
- "version": "1.35.0",
3
+ "version": "1.35.2",
4
4
  "description": "Flowcore SDK",
5
5
  "homepage": "https://github.com/flowcore-io/flowcore-sdk#readme",
6
6
  "repository": {
package/script/commands/event-type/event-type.info.js CHANGED
@@ -25,7 +25,7 @@ class EventTypeInfoCommand extends command_custom_js_1.CustomCommand {
25
25
  tenant: this.input.tenant,
26
26
  eventTypeId: this.input.eventTypeId,
27
27
  order: "desc",
28
- pageSize: lastEventsLimit,
28
+ pageSize: Math.max(lastEventsLimit, 100),
29
29
  });
30
30
  const [firstTimeBucketResponse, lastTimeBucketResponse] = await Promise.all([
31
31
  client.execute(firstTimeBucketCommand),
package/script/contracts/event-type.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { type Static, type TArray, type TObject, type TUnion } from "@sinclair/typebox";
1
+ import { type Static, type TArray, type TBoolean, type TLiteral, type TNull, type TNumber, type TObject, type TOptional, type TRecord, type TString, type TUnion, type TUnknown } from "@sinclair/typebox";
2
2
  export type SimplePiiType = boolean | "string" | "number" | "boolean";
3
3
  export type DetailedPiiField = {
4
4
  type: "string" | "number" | "boolean" | "object" | "array";
@@ -18,14 +18,83 @@ export type DetailedPiiField = {
18
18
  properties?: Record<string, SimplePiiType | DetailedPiiField | Record<string, unknown>>;
19
19
  };
20
20
  export type PiiDefinition = SimplePiiType | DetailedPiiField | Record<string, SimplePiiType | DetailedPiiField | Record<string, unknown>>;
21
- export declare const DetailedPiiFieldSchema: TObject;
22
- export declare const PiiDefinitionSchema: TUnion;
23
- export declare const EventTypePiiMaskSchema: TObject;
24
- export declare const EventTypePiiMaskParsedSchema: TArray<TObject>;
21
+ /**
22
+ * The schema for a detailed PII field
23
+ */
24
+ export declare const DetailedPiiFieldSchema: TObject<{
25
+ type: TUnion<[TLiteral<"string">, TLiteral<"number">, TLiteral<"boolean">, TLiteral<"object">, TLiteral<"array">]>;
26
+ faker: TOptional<TString>;
27
+ args: TOptional<TArray<TUnknown>>;
28
+ length: TOptional<TNumber>;
29
+ pattern: TOptional<TString>;
30
+ redact: TOptional<TObject<{
31
+ char: TString;
32
+ length: TNumber;
33
+ }>>;
34
+ min: TOptional<TNumber>;
35
+ max: TOptional<TNumber>;
36
+ precision: TOptional<TNumber>;
37
+ count: TOptional<TNumber>;
38
+ items: TOptional<TUnknown>;
39
+ properties: TOptional<TRecord<TString, TUnknown>>;
40
+ }>;
41
+ /**
42
+ * The schema for a PII definition
43
+ */
44
+ export declare const PiiDefinitionSchema: TUnion<[
45
+ TLiteral<true>,
46
+ TUnion<[TLiteral<"string">, TLiteral<"number">, TLiteral<"boolean">]>,
47
+ typeof DetailedPiiFieldSchema,
48
+ TRecord<TString, TUnknown>
49
+ ]>;
50
+ /**
51
+ * The schema for an event type PII mask
52
+ */
53
+ export declare const EventTypePiiMaskSchema: TObject<{
54
+ key: TString;
55
+ schema: TRecord<TString, typeof PiiDefinitionSchema>;
56
+ }>;
57
+ /**
58
+ * The schema for an event type PII mask parsed
59
+ */
60
+ export declare const EventTypePiiMaskParsedSchema: TArray<TObject<{
61
+ path: TString;
62
+ definition: TObject<{
63
+ type: TUnion<[TLiteral<"string">, TLiteral<"number">, TLiteral<"boolean">, TLiteral<"object">, TLiteral<"array">]>;
64
+ faker: TOptional<TString>;
65
+ args: TArray<TUnknown>;
66
+ length: TOptional<TNumber>;
67
+ pattern: TOptional<TString>;
68
+ min: TOptional<TNumber>;
69
+ max: TOptional<TNumber>;
70
+ precision: TOptional<TNumber>;
71
+ count: TOptional<TNumber>;
72
+ items: TOptional<TUnknown>;
73
+ properties: TOptional<TRecord<TString, TUnknown>>;
74
+ redact: TOptional<TObject<{
75
+ char: TString;
76
+ length: TNumber;
77
+ }>>;
78
+ }>;
79
+ }>>;
25
80
  /**
26
81
  * The schema for an event type
27
82
  */
28
- export declare const EventTypeSchema: TObject;
83
+ export declare const EventTypeSchema: TObject<{
84
+ id: TString;
85
+ tenantId: TString;
86
+ dataCoreId: TString;
87
+ flowTypeId: TString;
88
+ name: TString;
89
+ description: TString;
90
+ isTruncating: TBoolean;
91
+ isDeleting: TBoolean;
92
+ createdAt: TString;
93
+ updatedAt: TUnion<[TString, TNull]>;
94
+ piiMask: TUnion<[typeof EventTypePiiMaskSchema, TNull]>;
95
+ piiMaskParsed: TUnion<[typeof EventTypePiiMaskParsedSchema, TNull]>;
96
+ piiEnabled: TBoolean;
97
+ }>;
29
98
  /**
30
99
  * The type for an event type
31
100
  */
package/script/contracts/event-type.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"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"}
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,SAAS,EACd,KAAK,OAAO,EACZ,KAAK,OAAO,EACZ,KAAK,MAAM,EACX,KAAK,QAAQ,EAEd,MAAM,mBAAmB,CAAA;AAG1B,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;;GAEG;AACH,eAAO,MAAM,sBAAsB,EAAE,OAAO,CAAC;IAC3C,IAAI,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;IAClH,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;IACzB,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAA;IACjC,MAAM,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;IAC1B,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;IAC3B,MAAM,EAAE,SAAS,CACf,OAAO,CAAC;QACN,IAAI,EAAE,OAAO,CAAA;QACb,MAAM,EAAE,OAAO,CAAA;KAChB,CAAC,CACH,CAAA;IACD,GAAG,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;IACvB,GAAG,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;IACvB,SAAS,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;IAC7B,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;IACzB,KAAK,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAA;IAC1B,UAAU,EAAE,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAA;CAClD,CA6BC,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB,EAAE,MAAM,CACtC;IACE,QAAQ,CAAC,IAAI,CAAC;IACd,MAAM,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;IACrE,OAAO,sBAAsB;IAC7B,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC;CAC3B,CAMD,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,sBAAsB,EAAE,OAAO,CAAC;IAC3C,GAAG,EAAE,OAAO,CAAA;IACZ,MAAM,EAAE,OAAO,CAAC,OAAO,EAAE,OAAO,mBAAmB,CAAC,CAAA;CACrD,CAGC,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,4BAA4B,EAAE,MAAM,CAC/C,OAAO,CAAC;IACN,IAAI,EAAE,OAAO,CAAA;IACb,UAAU,EAAE,OAAO,CAAC;QAClB,IAAI,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;QAClH,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;QACzB,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAA;QACtB,MAAM,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;QAC1B,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;QAC3B,GAAG,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;QACvB,GAAG,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;QACvB,SAAS,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;QAC7B,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;QACzB,KAAK,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAA;QAC1B,UAAU,EAAE,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAA;QACjD,MAAM,EAAE,SAAS,CACf,OAAO,CAAC;YACN,IAAI,EAAE,OAAO,CAAA;YACb,MAAM,EAAE,OAAO,CAAA;SAChB,CAAC,CACH,CAAA;KACF,CAAC,CAAA;CACH,CAAC,CA8BH,CAAA;AAED;;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,SAAS,EAAE,OAAO,CAAA;IAClB,SAAS,EAAE,MAAM,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAA;IACnC,OAAO,EAAE,MAAM,CAAC,CAAC,OAAO,sBAAsB,EAAE,KAAK,CAAC,CAAC,CAAA;IACvD,aAAa,EAAE,MAAM,CAAC,CAAC,OAAO,4BAA4B,EAAE,KAAK,CAAC,CAAC,CAAA;IACnE,UAAU,EAAE,QAAQ,CAAA;CACrB,CA2BC,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 CHANGED
@@ -2,6 +2,9 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.EventTypeSchema = exports.EventTypePiiMaskParsedSchema = exports.EventTypePiiMaskSchema = exports.PiiDefinitionSchema = exports.DetailedPiiFieldSchema = void 0;
4
4
  const typebox_1 = require("@sinclair/typebox");
5
+ /**
6
+ * The schema for a detailed PII field
7
+ */
5
8
  exports.DetailedPiiFieldSchema = typebox_1.Type.Object({
6
9
  type: typebox_1.Type.Union([
7
10
  typebox_1.Type.Literal("string"),
@@ -25,16 +28,25 @@ exports.DetailedPiiFieldSchema = typebox_1.Type.Object({
25
28
  items: typebox_1.Type.Optional(typebox_1.Type.Unknown()),
26
29
  properties: typebox_1.Type.Optional(typebox_1.Type.Record(typebox_1.Type.String(), typebox_1.Type.Unknown())),
27
30
  });
31
+ /**
32
+ * The schema for a PII definition
33
+ */
28
34
  exports.PiiDefinitionSchema = typebox_1.Type.Union([
29
35
  typebox_1.Type.Literal(true),
30
36
  typebox_1.Type.Union([typebox_1.Type.Literal("string"), typebox_1.Type.Literal("number"), typebox_1.Type.Literal("boolean")]),
31
37
  exports.DetailedPiiFieldSchema,
32
38
  typebox_1.Type.Record(typebox_1.Type.String(), typebox_1.Type.Unknown()),
33
39
  ]);
40
+ /**
41
+ * The schema for an event type PII mask
42
+ */
34
43
  exports.EventTypePiiMaskSchema = typebox_1.Type.Object({
35
44
  key: typebox_1.Type.String(),
36
45
  schema: typebox_1.Type.Record(typebox_1.Type.String(), exports.PiiDefinitionSchema),
37
46
  });
47
+ /**
48
+ * The schema for an event type PII mask parsed
49
+ */
38
50
  exports.EventTypePiiMaskParsedSchema = typebox_1.Type.Array(typebox_1.Type.Object({
39
51
  path: typebox_1.Type.String(),
40
52
  definition: typebox_1.Type.Object({
@@ -65,17 +77,30 @@ exports.EventTypePiiMaskParsedSchema = typebox_1.Type.Array(typebox_1.Type.Objec
65
77
  * The schema for an event type
66
78
  */
67
79
  exports.EventTypeSchema = typebox_1.Type.Object({
80
+ /** Unique identifier for the event type */
68
81
  id: typebox_1.Type.String(),
82
+ /** ID of the tenant that owns this event type */
69
83
  tenantId: typebox_1.Type.String(),
84
+ /** ID of the data core this event type belongs to */
70
85
  dataCoreId: typebox_1.Type.String(),
86
+ /** ID of the flow type this event type belongs to */
71
87
  flowTypeId: typebox_1.Type.String(),
88
+ /** Name of the event type */
72
89
  name: typebox_1.Type.String(),
90
+ /** Description of the event type */
73
91
  description: typebox_1.Type.String(),
92
+ /** Indicates if the event type is currently being truncated */
74
93
  isTruncating: typebox_1.Type.Boolean(),
94
+ /** Indicates if the event type is currently being deleted */
75
95
  isDeleting: typebox_1.Type.Boolean(),
96
+ /** Creation timestamp */
76
97
  createdAt: typebox_1.Type.String(),
98
+ /** Last update timestamp */
77
99
  updatedAt: typebox_1.Type.Union([typebox_1.Type.String(), typebox_1.Type.Null()]),
100
+ /** PII mask configuration */
78
101
  piiMask: typebox_1.Type.Union([exports.EventTypePiiMaskSchema, typebox_1.Type.Null()]),
102
+ /** Parsed PII mask configuration */
79
103
  piiMaskParsed: typebox_1.Type.Union([exports.EventTypePiiMaskParsedSchema, typebox_1.Type.Null()]),
104
+ /** Indicates if PII handling is enabled */
80
105
  piiEnabled: typebox_1.Type.Boolean(),
81
106
  });