@tstdl/base 0.93.37 → 0.93.39

package/audit/audit.model.js

@@ -35,7 +35,7 @@ export class RequestDetails {
     sessionId;
 }
 __decorate([
-    StringProperty(),
+    StringProperty({ nullable: true }),
     __metadata("design:type", Object)
 ], RequestDetails.prototype, "path", void 0);
 __decorate([
@@ -179,7 +179,7 @@ __decorate([
     __metadata("design:type", String)
 ], AuditEvent.prototype, "actorType", void 0);
 __decorate([
-    StringProperty(),
+    StringProperty({ nullable: true }),
     __metadata("design:type", Object)
 ], AuditEvent.prototype, "actor", void 0);
 __decorate([

package/audit/auditor.d.ts

@@ -98,7 +98,7 @@ export declare class Auditor<Events extends AuditEvents = Record<never, never>>
      * @param action The name of the action being logged.
      * @param data The payload containing details about the event.
      */
-    info<const E extends Extract<keyof Events, string>>(action: E, data: AuditPayload<Events[E]>): Promise<void>;
+    info<const E extends Extract<keyof Events, string>>(action: E, data?: AuditPayload<Events[E]>): Promise<void>;
     /**
      * Logs a warning event.
      * Automatically sets severity to `Warn` and defaults outcome to `Failure`.
@@ -106,7 +106,7 @@ export declare class Auditor<Events extends AuditEvents = Record<never, never>>
      * @param action The name of the action being logged.
      * @param data The payload containing details about the event.
      */
-    warn<const E extends Extract<keyof Events, string>>(action: E, data: AuditPayload<Events[E]>): Promise<void>;
+    warn<const E extends Extract<keyof Events, string>>(action: E, data?: AuditPayload<Events[E]>): Promise<void>;
     /**
      * Logs an error event.
      * Automatically sets severity to `Error` and defaults outcome to `Failure`.
@@ -114,7 +114,7 @@ export declare class Auditor<Events extends AuditEvents = Record<never, never>>
      * @param action The name of the action being logged.
      * @param data The payload containing details about the event.
      */
-    error<const E extends Extract<keyof Events, string>>(action: E, data: AuditPayload<Events[E]>): Promise<void>;
+    error<const E extends Extract<keyof Events, string>>(action: E, data?: AuditPayload<Events[E]>): Promise<void>;
     /**
      * Logs a critical event.
      * Automatically sets severity to `Critical` and defaults outcome to `Failure`.
@@ -122,6 +122,6 @@ export declare class Auditor<Events extends AuditEvents = Record<never, never>>
      * @param action The name of the action being logged.
      * @param data The payload containing details about the event.
      */
-    critical<const E extends Extract<keyof Events, string>>(action: E, data: AuditPayload<Events[E]>): Promise<void>;
+    critical<const E extends Extract<keyof Events, string>>(action: E, data?: AuditPayload<Events[E]>): Promise<void>;
 }
 export {};

package/audit/auditor.js

@@ -16,10 +16,10 @@ import { DatabaseConfig, EntityRepositoryConfig, injectRepository, isInTransacti
 import { toArray } from '../utils/array/index.js';
 import { Memoize } from '../utils/function/memoize.js';
 import { filterNullishFromRecord, filterUndefinedFromRecord, objectKeys } from '../utils/object/object.js';
-import { assertDefinedPass, isArray, isNotArray, isObject, isString } from '../utils/type-guards.js';
+import { assertDefinedPass, assertNotNullOrUndefined, isArray, isNotArray, isObject, isString } from '../utils/type-guards.js';
 import { AuditEvent } from './audit.model.js';
 import { AuditModuleConfig } from './module.js';
-import { AuditOutcome, AuditSeverity } from './types.js';
+import { ActorType, AuditOutcome, AuditSeverity } from './types.js';
 const { runInAuditorCreationContext, getCurrentAuditorCreationContext, isInAuditorCreationContext } = createContextProvider('AuditorCreation');
 const severityLogLevelMap = {
     [AuditSeverity.Info]: 'info',
@@ -140,6 +140,9 @@ let Auditor = Auditor_1 = class Auditor {
             details,
         });
         this.#logger[severityLogLevelMap[severity]](logMessage, logContext);
+        if ((mergedData.actorType != ActorType.Anonymous) && (mergedData.actorType != ActorType.System)) {
+            assertNotNullOrUndefined(mergedData.actor, 'Audit actor is required for non-anonymous/system actors.');
+        }
         await this.#repository.insert({
             timestamp: TRANSACTION_TIMESTAMP,
             tenantId: mergedData.tenantId ?? null,
@@ -149,7 +152,7 @@ let Auditor = Auditor_1 = class Auditor {
             outcome,
             severity,
             actorType: assertDefinedPass(mergedData.actorType, 'Audit actorType is required'),
-            actor: assertDefinedPass(mergedData.actor, 'Audit actor is required'),
+            actor: mergedData.actor ?? null,
             impersonatorType: mergedData.impersonatorType ?? null,
             impersonator: mergedData.impersonator ?? null,
             targetType: assertDefinedPass(mergedData.targetType, 'Audit targetType is required'),
@@ -178,7 +181,7 @@ let Auditor = Auditor_1 = class Auditor {
         await this.log(action, {
             ...data,
             severity: AuditSeverity.Info,
-            outcome: data.outcome ?? AuditOutcome.Success,
+            outcome: data?.outcome ?? AuditOutcome.Success,
         });
     }
     /**
@@ -192,7 +195,7 @@ let Auditor = Auditor_1 = class Auditor {
         await this.log(action, {
             ...data,
             severity: AuditSeverity.Warn,
-            outcome: data.outcome ?? AuditOutcome.Failure,
+            outcome: data?.outcome ?? AuditOutcome.Failure,
         });
     }
     /**
@@ -206,7 +209,7 @@ let Auditor = Auditor_1 = class Auditor {
         await this.log(action, {
             ...data,
             severity: AuditSeverity.Error,
-            outcome: data.outcome ?? AuditOutcome.Failure,
+            outcome: data?.outcome ?? AuditOutcome.Failure,
         });
     }
     /**
@@ -220,7 +223,7 @@ let Auditor = Auditor_1 = class Auditor {
         await this.log(action, {
             ...data,
             severity: AuditSeverity.Critical,
-            outcome: data.outcome ?? AuditOutcome.Failure,
+            outcome: data?.outcome ?? AuditOutcome.Failure,
         });
     }
 };

package/audit/drizzle/0001_previous_network.sql

@@ -0,0 +1,2 @@
+ALTER TABLE "audit"."event" ALTER COLUMN "actor" DROP NOT NULL;--> statement-breakpoint
+ALTER TABLE "audit"."event" ALTER COLUMN "network_path" DROP NOT NULL;

package/audit/drizzle/meta/0001_snapshot.json

@@ -0,0 +1,195 @@
+{
+  "id": "12d8d2c6-0f8e-4958-a036-cd42c36f2b1f",
+  "prevId": "8f6c87f8-1692-49bd-9bd4-09dc9d0bdcd4",
+  "version": "7",
+  "dialect": "postgresql",
+  "tables": {
+    "audit.event": {
+      "name": "event",
+      "schema": "audit",
+      "columns": {
+        "id": {
+          "name": "id",
+          "type": "uuid",
+          "primaryKey": true,
+          "notNull": true,
+          "default": "gen_random_uuid()"
+        },
+        "timestamp": {
+          "name": "timestamp",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "tenant_id": {
+          "name": "tenant_id",
+          "type": "uuid",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "correlation_id": {
+          "name": "correlation_id",
+          "type": "uuid",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "module": {
+          "name": "module",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "action": {
+          "name": "action",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "outcome": {
+          "name": "outcome",
+          "type": "audit_outcome",
+          "typeSchema": "audit",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "severity": {
+          "name": "severity",
+          "type": "audit_severity",
+          "typeSchema": "audit",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "actor_type": {
+          "name": "actor_type",
+          "type": "actor_type",
+          "typeSchema": "audit",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "actor": {
+          "name": "actor",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "impersonator_type": {
+          "name": "impersonator_type",
+          "type": "actor_type",
+          "typeSchema": "audit",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "impersonator": {
+          "name": "impersonator",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "target_type": {
+          "name": "target_type",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "target_id": {
+          "name": "target_id",
+          "type": "uuid",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "network_path": {
+          "name": "network_path",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "network_ip_address": {
+          "name": "network_ip_address",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "network_user_agent": {
+          "name": "network_user_agent",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "network_session_id": {
+          "name": "network_session_id",
+          "type": "uuid",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "changes_before": {
+          "name": "changes_before",
+          "type": "jsonb",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "changes_after": {
+          "name": "changes_after",
+          "type": "jsonb",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "details": {
+          "name": "details",
+          "type": "jsonb",
+          "primaryKey": false,
+          "notNull": false
+        }
+      },
+      "indexes": {},
+      "foreignKeys": {},
+      "compositePrimaryKeys": {},
+      "uniqueConstraints": {},
+      "policies": {},
+      "checkConstraints": {},
+      "isRLSEnabled": false
+    }
+  },
+  "enums": {
+    "audit.actor_type": {
+      "name": "actor_type",
+      "schema": "audit",
+      "values": [
+        "anonymous",
+        "system",
+        "api-key",
+        "user"
+      ]
+    },
+    "audit.audit_outcome": {
+      "name": "audit_outcome",
+      "schema": "audit",
+      "values": [
+        "pending",
+        "success",
+        "cancelled",
+        "failure",
+        "denied"
+      ]
+    },
+    "audit.audit_severity": {
+      "name": "audit_severity",
+      "schema": "audit",
+      "values": [
+        "info",
+        "warn",
+        "error",
+        "critical"
+      ]
+    }
+  },
+  "schemas": {},
+  "sequences": {},
+  "roles": {},
+  "policies": {},
+  "views": {},
+  "_meta": {
+    "columns": {},
+    "schemas": {},
+    "tables": {}
+  }
+}

package/audit/drizzle/meta/_journal.json

@@ -8,6 +8,13 @@
       "when": 1758041172363,
       "tag": "0000_bored_stick",
       "breakpoints": true
+    },
+    {
+      "idx": 1,
+      "version": "7",
+      "when": 1762968766536,
+      "tag": "0001_previous_network",
+      "breakpoints": true
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tstdl/base",
-  "version": "0.93.37",
+  "version": "0.93.39",
   "author": "Patrick Hein",
   "publishConfig": {
     "access": "public"

package/test/drizzle/0001_closed_the_captain.sql

@@ -0,0 +1,2 @@
+DROP INDEX "test"."test_parade_idx";--> statement-breakpoint
+CREATE INDEX "test_parade_idx" ON "test"."test" USING bm25 ("id","language","title","content","tags",(("title" || ' ' || "content" || ' ' || "tags")::pdb.simple('alias=search_text')),(('foo')::pdb.simple('alias=foo'))) WITH (key_field='id');

package/test/drizzle/meta/0001_snapshot.json

@@ -0,0 +1,117 @@
+{
+  "id": "68a0bdde-47d3-4390-b409-27a74dd269f3",
+  "prevId": "bbffc0f2-678b-42e9-8121-1731a04b8987",
+  "version": "7",
+  "dialect": "postgresql",
+  "tables": {
+    "test.test": {
+      "name": "test",
+      "schema": "test",
+      "columns": {
+        "id": {
+          "name": "id",
+          "type": "uuid",
+          "primaryKey": true,
+          "notNull": true,
+          "default": "gen_random_uuid()"
+        },
+        "title": {
+          "name": "title",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "content": {
+          "name": "content",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "tags": {
+          "name": "tags",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "language": {
+          "name": "language",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        }
+      },
+      "indexes": {
+        "test_parade_idx": {
+          "name": "test_parade_idx",
+          "columns": [
+            {
+              "expression": "id",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "\"language\"",
+              "asc": true,
+              "isExpression": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "\"title\"",
+              "asc": true,
+              "isExpression": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "\"content\"",
+              "asc": true,
+              "isExpression": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "\"tags\"",
+              "asc": true,
+              "isExpression": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "((\"title\" || ' ' || \"content\" || ' ' || \"tags\")::pdb.simple('alias=search_text'))",
+              "asc": true,
+              "isExpression": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "(('foo')::pdb.simple('alias=foo'))",
+              "asc": true,
+              "isExpression": true,
+              "nulls": "last"
+            }
+          ],
+          "isUnique": false,
+          "concurrently": false,
+          "method": "bm25",
+          "with": {
+            "key_field": "'id'"
+          }
+        }
+      },
+      "foreignKeys": {},
+      "compositePrimaryKeys": {},
+      "uniqueConstraints": {},
+      "policies": {},
+      "checkConstraints": {},
+      "isRLSEnabled": false
+    }
+  },
+  "enums": {},
+  "schemas": {},
+  "sequences": {},
+  "roles": {},
+  "policies": {},
+  "views": {},
+  "_meta": {
+    "columns": {},
+    "schemas": {},
+    "tables": {}
+  }
+}

package/test/drizzle/meta/_journal.json

@@ -8,6 +8,13 @@
       "when": 1762381204799,
       "tag": "0000_natural_cannonball",
       "breakpoints": true
+    },
+    {
+      "idx": 1,
+      "version": "7",
+      "when": 1762968768532,
+      "tag": "0001_closed_the_captain",
+      "breakpoints": true
     }
   ]
 }