@geekmidas/audit 10.0.0-alpha.98 → 10.0.0
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.
- package/CHANGELOG.md +109 -0
- package/README.md +2 -2
- package/TECHNICAL.md +937 -0
- package/dist/{Auditor-BBXXCD0v.d.cts → Auditor-CW2NrfHS.d.mts} +7 -2
- package/dist/Auditor-CW2NrfHS.d.mts.map +1 -0
- package/dist/{Auditor-BBXXCD0v.d.mts → Auditor-DpBHXIJM.d.cts} +7 -2
- package/dist/Auditor-DpBHXIJM.d.cts.map +1 -0
- package/dist/Auditor.d.cts +1 -1
- package/dist/Auditor.d.mts +1 -1
- package/dist/Auditor.mjs +0 -1
- package/dist/DefaultAuditor-BAVnNmRh.mjs +96 -0
- package/dist/DefaultAuditor-BAVnNmRh.mjs.map +1 -0
- package/dist/DefaultAuditor-DlJ1ENfx.d.mts +59 -0
- package/dist/DefaultAuditor-DlJ1ENfx.d.mts.map +1 -0
- package/dist/DefaultAuditor-GRFI86N_.d.cts +59 -0
- package/dist/DefaultAuditor-GRFI86N_.d.cts.map +1 -0
- package/dist/DefaultAuditor-JbZ_BQfh.cjs +102 -0
- package/dist/DefaultAuditor-JbZ_BQfh.cjs.map +1 -0
- package/dist/DefaultAuditor.cjs +2 -95
- package/dist/DefaultAuditor.d.cts +3 -55
- package/dist/DefaultAuditor.d.mts +3 -55
- package/dist/DefaultAuditor.mjs +2 -94
- package/dist/cache-BbIl31RL.mjs +167 -0
- package/dist/cache-BbIl31RL.mjs.map +1 -0
- package/dist/cache-Bih6HxY6.d.cts +96 -0
- package/dist/cache-Bih6HxY6.d.cts.map +1 -0
- package/dist/cache-l7jAptBl.cjs +173 -0
- package/dist/cache-l7jAptBl.cjs.map +1 -0
- package/dist/cache-wET57t6d.d.mts +96 -0
- package/dist/cache-wET57t6d.d.mts.map +1 -0
- package/dist/cache.cjs +2 -166
- package/dist/cache.d.cts +3 -92
- package/dist/cache.d.mts +3 -92
- package/dist/cache.mjs +2 -165
- package/dist/chunk-CUT6urMc.cjs +30 -0
- package/dist/index.cjs +3 -3
- package/dist/index.d.cts +3 -3
- package/dist/index.d.mts +3 -3
- package/dist/index.mjs +3 -2
- package/dist/knex.cjs +9 -9
- package/dist/knex.cjs.map +1 -1
- package/dist/knex.d.cts +11 -9
- package/dist/knex.d.cts.map +1 -1
- package/dist/knex.d.mts +11 -9
- package/dist/knex.d.mts.map +1 -1
- package/dist/knex.mjs +7 -7
- package/dist/knex.mjs.map +1 -1
- package/dist/kysely.cjs +9 -9
- package/dist/kysely.cjs.map +1 -1
- package/dist/kysely.d.cts +11 -9
- package/dist/kysely.d.cts.map +1 -1
- package/dist/kysely.d.mts +11 -9
- package/dist/kysely.d.mts.map +1 -1
- package/dist/kysely.mjs +7 -7
- package/dist/kysely.mjs.map +1 -1
- package/dist/memory.cjs +7 -6
- package/dist/memory.cjs.map +1 -1
- package/dist/memory.d.cts +7 -3
- package/dist/memory.d.cts.map +1 -1
- package/dist/memory.d.mts +7 -3
- package/dist/memory.d.mts.map +1 -1
- package/dist/memory.mjs +4 -3
- package/dist/memory.mjs.map +1 -1
- package/dist/storage.d.cts +1 -1
- package/dist/storage.d.mts +1 -1
- package/dist/storage.mjs +0 -1
- package/dist/types.d.cts +1 -1
- package/dist/types.d.mts +1 -1
- package/dist/types.mjs +0 -1
- package/package.json +13 -19
- package/src/Auditor.ts +157 -0
- package/src/DefaultAuditor.ts +141 -0
- package/src/__tests__/CacheAuditStorage.spec.ts +382 -0
- package/src/__tests__/DefaultAuditor.spec.ts +529 -0
- package/src/__tests__/InMemoryAuditStorage.spec.ts +317 -0
- package/src/__tests__/KnexAuditStorage.integration.spec.ts +739 -0
- package/src/__tests__/KyselyAuditStorage.integration.spec.ts +518 -0
- package/src/__tests__/KyselyAuditStorage.spec.ts +443 -0
- package/src/cache.ts +263 -0
- package/src/index.ts +23 -0
- package/src/knex.ts +430 -0
- package/src/kysely.ts +424 -0
- package/src/memory.ts +50 -0
- package/src/storage.ts +203 -0
- package/src/types.ts +154 -0
- package/tsconfig.json +9 -0
- package/dist/Auditor-BBXXCD0v.d.cts.map +0 -1
- package/dist/Auditor-BBXXCD0v.d.mts.map +0 -1
- package/dist/DefaultAuditor.cjs.map +0 -1
- package/dist/DefaultAuditor.d.cts.map +0 -1
- package/dist/DefaultAuditor.d.mts.map +0 -1
- package/dist/DefaultAuditor.mjs.map +0 -1
- package/dist/cache.cjs.map +0 -1
- package/dist/cache.d.cts.map +0 -1
- package/dist/cache.d.mts.map +0 -1
- package/dist/cache.mjs.map +0 -1
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import { InferStandardSchema } from "@geekmidas/schema";
|
|
2
2
|
import { StandardSchemaV1 } from "@standard-schema/spec";
|
|
3
|
+
|
|
3
4
|
//#region src/storage.d.ts
|
|
5
|
+
|
|
4
6
|
/**
|
|
5
7
|
* Minimal interface for transaction-aware audit flushing.
|
|
6
8
|
* Use this when you need to flush audits within a database transaction.
|
|
@@ -186,6 +188,7 @@ interface AuditStorage<TAuditAction extends AuditableAction<string, unknown> = A
|
|
|
186
188
|
flush(trx?: unknown): Promise<void>;
|
|
187
189
|
}, callback: () => Promise<T>, db?: unknown): Promise<T>;
|
|
188
190
|
}
|
|
191
|
+
//# sourceMappingURL=storage.d.ts.map
|
|
189
192
|
//#endregion
|
|
190
193
|
//#region src/types.d.ts
|
|
191
194
|
/**
|
|
@@ -444,6 +447,8 @@ interface Auditor<TAuditAction extends AuditableAction<string, unknown> = Audita
|
|
|
444
447
|
*/
|
|
445
448
|
getTransaction(): TTransaction | undefined;
|
|
446
449
|
}
|
|
450
|
+
//# sourceMappingURL=Auditor.d.ts.map
|
|
451
|
+
|
|
447
452
|
//#endregion
|
|
448
|
-
export {
|
|
449
|
-
//# sourceMappingURL=Auditor-
|
|
453
|
+
export { AuditActor, AuditMetadata, AuditOperation, AuditOptions, AuditQueryOptions, AuditRecord, AuditStorage, AuditableAction, Auditor, ExtractAuditPayload, ExtractAuditType, ExtractAuditorAction, ExtractStorageAuditAction, MappedAudit, TransactionAwareAuditor };
|
|
454
|
+
//# sourceMappingURL=Auditor-CW2NrfHS.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Auditor-CW2NrfHS.d.mts","names":[],"sources":["../src/storage.ts","../src/types.ts","../src/Auditor.ts"],"sourcesContent":[],"mappings":";;;;;;;;AAuBA;;;;;AAImC;AAMnC;;;;;AAYU;AAwCV;;;;;;AAe+C,UA7E9B,uBA6E8B,CAAA,eAAA,OAAA,CAAA,CAAA;EAAO;EASpB,cAAW,CAAA,GAAA,EApFxB,YAoFwB,CAAA,EAAA,IAAA;EAAW;EAAZ,KAStB,CAAA,GAAA,CAAA,EA3FT,YA2FS,CAAA,EA3FM,OA2FN,CAAA,IAAA,CAAA;;;;;AAiFJ,UAtKD,iBAAA,CAsKC;EAAO;EAEZ,IAAT,CAAA,EAAA,MAAA,GAAA,MAAA,EAAA;EAAO;sBApKU;;;ECnBT;EAAe,OAAA,CAAA,EAAA,MAAA;EAAA;EACf,IACF,CAAA,EDuBF,ICvBE;EAAQ;EAMN,EAAA,CAAA,EDmBN,ICnBM;EAAgB;EAAA,KAAW,CAAA,EAAA,MAAA;EAAe;EACpD,MAAS,CAAA,EAAA,MAAA;EAAe;EAA8B,OAAA,CAAA,EAAA,WAAA,GAAA,MAAA;EAK5C;EAAmB,cAAA,CAAA,EAAA,KAAA,GAAA,MAAA;;;;;;;;AAGgC;AAK/D;AAKA;AAYA;AAkBA;;;;;;;;;;AAsByB;AAMzB;;;;;;AAUmB;AAOnB;AAA4B,UDnCX,YCmCW,CAAA,qBDlCN,eCkCM,CAAA,MAAA,EAAA,OAAA,CAAA,GDlC6B,eCkC7B,CAAA,MAAA,EAAA,OAAA,CAAA,CAAA,CAAA;EAAA;EACS,SACpB,iBAAA,CAAA,ED9Ba,YC8Bb;EAAgB;;;;;;;EAOuB,KAAlD,CAAA,OAAA,ED7BU,WC6BV,EAAA,EAAA,GAAA,CAAA,EAAA,OAAA,CAAA,ED7ByC,OC6BzC,CAAA,IAAA,CAAA;EAAmB;;;;;AAMJ;AAQrB;EAAgC,KAAA,EAAA,OAAA,EDlCf,iBCkCe,CAAA,EDlCK,OCkCL,CDlCa,WCkCb,EAAA,CAAA;EAAA;;;AAAoC;AAKpE;;;EACE,KAAS,EAAA,OAAA,ED/BM,IC+BN,CD/BW,iBC+BX,EAAA,OAAA,GAAA,QAAA,CAAA,CAAA,ED/BoD,OC+BpD,CAAA,MAAA,CAAA;EAAY;;AAA+B;;;;ACrHtD;;;;;;;;;;;;EAwCwB,WAUH,GAAA,EAAA,OAAA;EAAW;;;;;;;AAyED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0BF0CN;qBAEP,QAAQ,mBAEtB,QAAQ;;;;;;;AAlLZ;;;;;AAImC;AAMnC;;;;;AAYU;AAwCV;AAA6B,KCnEjB,eDmEiB,CAAA,cAAA,MAAA,EAAA,WAAA,OAAA,CAAA,GAAA;EAAA,IACP,ECnEf,KDmEe;EAAe,OAAoB,EClE/C,QDkE+C;CAAe;;;;AAuB3B,KCnFjC,gBDmFiC,CAAA,UCnFN,eDmFM,CAAA,MAAA,EAAA,OAAA,CAAA,CAAA,GClF5C,CDkF4C,SClFlC,eDkFkC,CAAA,KAAA,MAAA,EAAA,OAAA,CAAA,GClFM,KDkFN,GAAA,KAAA;;;;AASkB,KCtFnD,mBDsFmD,CAAA,UCrFpD,eDqFoD,CAAA,MAAA,EAAA,OAAA,CAAA,EAAA,cCpFhD,gBDoFgD,CCpF/B,CDoF+B,CAAA,CAAA,GCnF3D,CDmF2D,SCnFjD,eDmFiD,CCnFjC,KDmFiC,EAAA,KAAA,SAAA,CAAA,GCnFR,QDmFQ,GAAA,KAAA;;;;AAmFnD,KCjKA,cAAA,GDiKA,QAAA,GAAA,QAAA,GAAA,QAAA,GAAA,QAAA;;AAAD;;UC5JM,UAAA;;EA3BL,EAAA,CAAA,EAAA,MAAA;EAAe;EAAA,IACpB,CAAA,EAAA,MAAA;EAAK;EACM,CAAA,GAAA,EAAA,MAAA,CAAA,EAAA,OAAA;AAMlB;;;;AACW,UA8BM,aAAA,CA9BN;EAAe;EAA8B,SAAA,CAAA,EAAA,MAAA;EAK5C;EAAmB,QAAA,CAAA,EAAA,MAAA;EAAA;EACL,MACM,CAAA,EAAA,MAAA;EAAC;EAAF,EAAA,CAC3B,EAAA,MAAA;EAAC;EAA8B,SAArB,CAAA,EAAA,MAAA;EAAe;EAAkC,CAAA,GAAA,EAAA,MAAA,CAAA,EAAA,OAAA;AAK/D;AAKA;AAYA;AAkBA;AAA4B,UAAX,WAAW,CAAA,WAAA,OAAA,CAAA,CAAA;EAAA;EAMF,EAAA,EAIL,MAAA;EAAM;EAER,IAEN,EAAA,MAAA;EAAM;EAEA,SAEP,EAZA,cAYA;EAAI;EAEG,KAEP,CAAA,EAAA,MAAA;EAAa;EAMR,QAAA,CAAA,EAAA,MAAY,GAlBR,MAkBQ,CAAA,MAAA,EAAA,OAAA,CAAA;EAAA;EAAA,SAER,CAAA,EAlBR,MAkBQ,CAAA,MAAA,EAAA,OAAA,CAAA;EAAM;EAIA,SAEd,CAAA,EAtBA,MAsBA,CAAA,MAAA,EAAA,OAAA,CAAA;EAAM;EAEA,OAAA,CAAA,EAtBR,QAsBQ;EAOF;EAAW,SAAA,EA3BhB,IA2BgB;EAAA;EACS,KACpB,CAAA,EA3BR,UA2BQ;EAAgB;EAGG,QAA7B,CAAA,EA5BK,aA4BL;;;;;AAIiC,UA1BvB,YAAA,CA0BuB;EAAgB;EAA/B,QAEc,CAAA,EAAA,MAAA,GA1BlB,MA0BkB,CAAA,MAAA,EAAA,OAAA,CAAA;EAAO;EAAR,KAGN,CAAA,EAAA,MAAA;EAAO;EAAR,SAChB,CAAA,EA1BF,cA0BE;EAAM;EAQT,SAAA,CAAA,EAhCC,MAgCD,CAAA,MAAoB,EAAA,OAAA,CAAA;EAAA;EAAA,SAAM,CAAA,EA9BzB,MA8ByB,CAAA,MAAA,EAAA,OAAA,CAAA;;;AAA8B;AAKpE;;AACC,UA7BgB,WA6BhB,CAAA,qBA5BqB,eA4BrB,CAAA,MAAA,EAAA,OAAA,CAAA,EAAA,gBA3BgB,gBA2BhB,GAAA,SAAA,GAAA,SAAA,CAAA,CAAA;EAAC;EAAqB,IAAY,EAxB5B,gBAwB4B,CAxBX,YAwBW,CAAA;EAAC;EAAkB,OAAA,EAAA,CAAA,QAAA,EArB1C,mBAqB0C,CArBtB,OAqBsB,CAAA,EAAA,GApBhD,mBAoBgD,CApB5B,YAoB4B,EApBd,gBAoBc,CApBG,YAoBH,CAAA,CAAA;;oBAlBnC,oBAAoB;;ECnGtB,QAAA,CAAA,EAAO,CAAA,QAAA,EDsGZ,mBCtGY,CDsGQ,OCtGR,CAAA,EAAA,GAAA,MAAA,GDuGT,MCvGS,CAAA,MAAA,EAAA,OAAA,CAAA;EAAA;EAAA,KACF,CAAA,EAAA,MAAA;;;;;AAqCd,KDyEI,oBCzEJ,CAAA,CAAA,CAAA,GDyE8B,CCzE9B,SDyEwC,OCzExC,CAAA,KAAA,EAAA,CAAA,GDyE2D,CCzE3D,GAAA,KAAA;;;;AAEI,KD4EA,yBC5EA,CAAA,CAAA,CAAA,GD6EX,CC7EW,SD6ED,YC7EC,CAAA,KAAA,EAAA,CAAA,GD6EuB,CC7EvB,GD6E2B,eC7E3B,CAAA,MAAA,EAAA,OAAA,CAAA;;;;;;AFjDZ;;;;;AAImC;AAMnC;;;;;AAYU;AAwCV;;;;;;;AAwBiB,UE7EA,OF6EA,CAAA,qBE5EK,eF4EL,CAAA,MAAA,EAAA,OAAA,CAAA,GE5EwC,eF4ExC,CAAA,MAAA,EAAA,OAAA,CAAA,EAAA,eAAA,OAAA,CAAA,CAAA;EAAiB;;;;EASb,SAA0C,KAAA,EE3E9C,UF2E8C;EAAO;;;;;AAmF3D;;;;ACvLX;;;;AAEkB;AAMlB;;;;;;AACwD;AAKxD;;;EAC0B,KACM,CAAA,cCmCX,gBDnCW,CCmCM,YDnCN,CAAA,CAAA,CAAA,IAAA,ECoCxB,KDpCwB,EAAA,OAAA,ECqCrB,mBDrCqB,CCqCD,YDrCC,ECqCa,KDrCb,CAAA,EAAA,OAAA,CAAA,ECsCpB,YDtCoB,CAAA,EAAA,IAAA;EAAC;;;;;AAC8B;AAK/D;EAKiB,MAAA,CAAA,MAAU,ECqCX,IDrCW,CCqCN,WDrCM,EAAA,IAAA,GAAA,WAAA,GAAA,OAAA,CAAA,CAAA,EAAA,IAAA;EAYV;AAkBjB;;;EAM0B,UAIL,EAAA,ECGN,WDHM,EAAA;EAAM;;;;;;EAYF,KAAA,CAAA,GAAA,CAAA,ECDZ,YDCY,CAAA,ECDG,ODCH,CAAA,IAAA,CAAA;EAMR;;;;EAMU,KAEd,EAAA,EAAA,IAAA;EAAM;AAEA;AAOnB;;;;;;;;;;;;;;;;EAc+B,WAChB,CAAA,QAAA,ECbQ,aDaR,CAAA,EAAA,IAAA;EAAM;AAQrB;;;;;AAAoE;AAKpE;;;;;;AACsD;;;;ACrHtD;;;;;;;;EAsCa,cACkB,CAAA,GAAA,EA8EV,YA9EU,CAAA,EAAA,IAAA;EAAY;;;;EAWX,cAAhB,EAAA,EAyEG,YAzEH,GAAA,SAAA"}
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import { InferStandardSchema } from "@geekmidas/schema";
|
|
2
2
|
import { StandardSchemaV1 } from "@standard-schema/spec";
|
|
3
|
+
|
|
3
4
|
//#region src/storage.d.ts
|
|
5
|
+
|
|
4
6
|
/**
|
|
5
7
|
* Minimal interface for transaction-aware audit flushing.
|
|
6
8
|
* Use this when you need to flush audits within a database transaction.
|
|
@@ -186,6 +188,7 @@ interface AuditStorage<TAuditAction extends AuditableAction<string, unknown> = A
|
|
|
186
188
|
flush(trx?: unknown): Promise<void>;
|
|
187
189
|
}, callback: () => Promise<T>, db?: unknown): Promise<T>;
|
|
188
190
|
}
|
|
191
|
+
//# sourceMappingURL=storage.d.ts.map
|
|
189
192
|
//#endregion
|
|
190
193
|
//#region src/types.d.ts
|
|
191
194
|
/**
|
|
@@ -444,6 +447,8 @@ interface Auditor<TAuditAction extends AuditableAction<string, unknown> = Audita
|
|
|
444
447
|
*/
|
|
445
448
|
getTransaction(): TTransaction | undefined;
|
|
446
449
|
}
|
|
450
|
+
//# sourceMappingURL=Auditor.d.ts.map
|
|
451
|
+
|
|
447
452
|
//#endregion
|
|
448
|
-
export {
|
|
449
|
-
//# sourceMappingURL=Auditor-
|
|
453
|
+
export { AuditActor, AuditMetadata, AuditOperation, AuditOptions, AuditQueryOptions, AuditRecord, AuditStorage, AuditableAction, Auditor, ExtractAuditPayload, ExtractAuditType, ExtractAuditorAction, ExtractStorageAuditAction, MappedAudit, TransactionAwareAuditor };
|
|
454
|
+
//# sourceMappingURL=Auditor-DpBHXIJM.d.cts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Auditor-DpBHXIJM.d.cts","names":[],"sources":["../src/storage.ts","../src/types.ts","../src/Auditor.ts"],"sourcesContent":[],"mappings":";;;;;;;;AAuBA;;;;;AAImC;AAMnC;;;;;AAYU;AAwCV;;;;;;AAe+C,UA7E9B,uBA6E8B,CAAA,eAAA,OAAA,CAAA,CAAA;EAAO;EASpB,cAAW,CAAA,GAAA,EApFxB,YAoFwB,CAAA,EAAA,IAAA;EAAW;EAAZ,KAStB,CAAA,GAAA,CAAA,EA3FT,YA2FS,CAAA,EA3FM,OA2FN,CAAA,IAAA,CAAA;;;;;AAiFJ,UAtKD,iBAAA,CAsKC;EAAO;EAEZ,IAAT,CAAA,EAAA,MAAA,GAAA,MAAA,EAAA;EAAO;sBApKU;;;ECnBT;EAAe,OAAA,CAAA,EAAA,MAAA;EAAA;EACf,IACF,CAAA,EDuBF,ICvBE;EAAQ;EAMN,EAAA,CAAA,EDmBN,ICnBM;EAAgB;EAAA,KAAW,CAAA,EAAA,MAAA;EAAe;EACpD,MAAS,CAAA,EAAA,MAAA;EAAe;EAA8B,OAAA,CAAA,EAAA,WAAA,GAAA,MAAA;EAK5C;EAAmB,cAAA,CAAA,EAAA,KAAA,GAAA,MAAA;;;;;;;;AAGgC;AAK/D;AAKA;AAYA;AAkBA;;;;;;;;;;AAsByB;AAMzB;;;;;;AAUmB;AAOnB;AAA4B,UDnCX,YCmCW,CAAA,qBDlCN,eCkCM,CAAA,MAAA,EAAA,OAAA,CAAA,GDlC6B,eCkC7B,CAAA,MAAA,EAAA,OAAA,CAAA,CAAA,CAAA;EAAA;EACS,SACpB,iBAAA,CAAA,ED9Ba,YC8Bb;EAAgB;;;;;;;EAOuB,KAAlD,CAAA,OAAA,ED7BU,WC6BV,EAAA,EAAA,GAAA,CAAA,EAAA,OAAA,CAAA,ED7ByC,OC6BzC,CAAA,IAAA,CAAA;EAAmB;;;;;AAMJ;AAQrB;EAAgC,KAAA,EAAA,OAAA,EDlCf,iBCkCe,CAAA,EDlCK,OCkCL,CDlCa,WCkCb,EAAA,CAAA;EAAA;;;AAAoC;AAKpE;;;EACE,KAAS,EAAA,OAAA,ED/BM,IC+BN,CD/BW,iBC+BX,EAAA,OAAA,GAAA,QAAA,CAAA,CAAA,ED/BoD,OC+BpD,CAAA,MAAA,CAAA;EAAY;;AAA+B;;;;ACrHtD;;;;;;;;;;;;EAwCwB,WAUH,GAAA,EAAA,OAAA;EAAW;;;;;;;AAyED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0BF0CN;qBAEP,QAAQ,mBAEtB,QAAQ;;;;;;;AAlLZ;;;;;AAImC;AAMnC;;;;;AAYU;AAwCV;AAA6B,KCnEjB,eDmEiB,CAAA,cAAA,MAAA,EAAA,WAAA,OAAA,CAAA,GAAA;EAAA,IACP,ECnEf,KDmEe;EAAe,OAAoB,EClE/C,QDkE+C;CAAe;;;;AAuB3B,KCnFjC,gBDmFiC,CAAA,UCnFN,eDmFM,CAAA,MAAA,EAAA,OAAA,CAAA,CAAA,GClF5C,CDkF4C,SClFlC,eDkFkC,CAAA,KAAA,MAAA,EAAA,OAAA,CAAA,GClFM,KDkFN,GAAA,KAAA;;;;AASkB,KCtFnD,mBDsFmD,CAAA,UCrFpD,eDqFoD,CAAA,MAAA,EAAA,OAAA,CAAA,EAAA,cCpFhD,gBDoFgD,CCpF/B,CDoF+B,CAAA,CAAA,GCnF3D,CDmF2D,SCnFjD,eDmFiD,CCnFjC,KDmFiC,EAAA,KAAA,SAAA,CAAA,GCnFR,QDmFQ,GAAA,KAAA;;;;AAmFnD,KCjKA,cAAA,GDiKA,QAAA,GAAA,QAAA,GAAA,QAAA,GAAA,QAAA;;AAAD;;UC5JM,UAAA;;EA3BL,EAAA,CAAA,EAAA,MAAA;EAAe;EAAA,IACpB,CAAA,EAAA,MAAA;EAAK;EACM,CAAA,GAAA,EAAA,MAAA,CAAA,EAAA,OAAA;AAMlB;;;;AACW,UA8BM,aAAA,CA9BN;EAAe;EAA8B,SAAA,CAAA,EAAA,MAAA;EAK5C;EAAmB,QAAA,CAAA,EAAA,MAAA;EAAA;EACL,MACM,CAAA,EAAA,MAAA;EAAC;EAAF,EAAA,CAC3B,EAAA,MAAA;EAAC;EAA8B,SAArB,CAAA,EAAA,MAAA;EAAe;EAAkC,CAAA,GAAA,EAAA,MAAA,CAAA,EAAA,OAAA;AAK/D;AAKA;AAYA;AAkBA;AAA4B,UAAX,WAAW,CAAA,WAAA,OAAA,CAAA,CAAA;EAAA;EAMF,EAAA,EAIL,MAAA;EAAM;EAER,IAEN,EAAA,MAAA;EAAM;EAEA,SAEP,EAZA,cAYA;EAAI;EAEG,KAEP,CAAA,EAAA,MAAA;EAAa;EAMR,QAAA,CAAA,EAAA,MAAY,GAlBR,MAkBQ,CAAA,MAAA,EAAA,OAAA,CAAA;EAAA;EAAA,SAER,CAAA,EAlBR,MAkBQ,CAAA,MAAA,EAAA,OAAA,CAAA;EAAM;EAIA,SAEd,CAAA,EAtBA,MAsBA,CAAA,MAAA,EAAA,OAAA,CAAA;EAAM;EAEA,OAAA,CAAA,EAtBR,QAsBQ;EAOF;EAAW,SAAA,EA3BhB,IA2BgB;EAAA;EACS,KACpB,CAAA,EA3BR,UA2BQ;EAAgB;EAGG,QAA7B,CAAA,EA5BK,aA4BL;;;;;AAIiC,UA1BvB,YAAA,CA0BuB;EAAgB;EAA/B,QAEc,CAAA,EAAA,MAAA,GA1BlB,MA0BkB,CAAA,MAAA,EAAA,OAAA,CAAA;EAAO;EAAR,KAGN,CAAA,EAAA,MAAA;EAAO;EAAR,SAChB,CAAA,EA1BF,cA0BE;EAAM;EAQT,SAAA,CAAA,EAhCC,MAgCD,CAAA,MAAoB,EAAA,OAAA,CAAA;EAAA;EAAA,SAAM,CAAA,EA9BzB,MA8ByB,CAAA,MAAA,EAAA,OAAA,CAAA;;;AAA8B;AAKpE;;AACC,UA7BgB,WA6BhB,CAAA,qBA5BqB,eA4BrB,CAAA,MAAA,EAAA,OAAA,CAAA,EAAA,gBA3BgB,gBA2BhB,GAAA,SAAA,GAAA,SAAA,CAAA,CAAA;EAAC;EAAqB,IAAY,EAxB5B,gBAwB4B,CAxBX,YAwBW,CAAA;EAAC;EAAkB,OAAA,EAAA,CAAA,QAAA,EArB1C,mBAqB0C,CArBtB,OAqBsB,CAAA,EAAA,GApBhD,mBAoBgD,CApB5B,YAoB4B,EApBd,gBAoBc,CApBG,YAoBH,CAAA,CAAA;;oBAlBnC,oBAAoB;;ECnGtB,QAAA,CAAA,EAAO,CAAA,QAAA,EDsGZ,mBCtGY,CDsGQ,OCtGR,CAAA,EAAA,GAAA,MAAA,GDuGT,MCvGS,CAAA,MAAA,EAAA,OAAA,CAAA;EAAA;EAAA,KACF,CAAA,EAAA,MAAA;;;;;AAqCd,KDyEI,oBCzEJ,CAAA,CAAA,CAAA,GDyE8B,CCzE9B,SDyEwC,OCzExC,CAAA,KAAA,EAAA,CAAA,GDyE2D,CCzE3D,GAAA,KAAA;;;;AAEI,KD4EA,yBC5EA,CAAA,CAAA,CAAA,GD6EX,CC7EW,SD6ED,YC7EC,CAAA,KAAA,EAAA,CAAA,GD6EuB,CC7EvB,GD6E2B,eC7E3B,CAAA,MAAA,EAAA,OAAA,CAAA;;;;;;AFjDZ;;;;;AAImC;AAMnC;;;;;AAYU;AAwCV;;;;;;;AAwBiB,UE7EA,OF6EA,CAAA,qBE5EK,eF4EL,CAAA,MAAA,EAAA,OAAA,CAAA,GE5EwC,eF4ExC,CAAA,MAAA,EAAA,OAAA,CAAA,EAAA,eAAA,OAAA,CAAA,CAAA;EAAiB;;;;EASb,SAA0C,KAAA,EE3E9C,UF2E8C;EAAO;;;;;AAmF3D;;;;ACvLX;;;;AAEkB;AAMlB;;;;;;AACwD;AAKxD;;;EAC0B,KACM,CAAA,cCmCX,gBDnCW,CCmCM,YDnCN,CAAA,CAAA,CAAA,IAAA,ECoCxB,KDpCwB,EAAA,OAAA,ECqCrB,mBDrCqB,CCqCD,YDrCC,ECqCa,KDrCb,CAAA,EAAA,OAAA,CAAA,ECsCpB,YDtCoB,CAAA,EAAA,IAAA;EAAC;;;;;AAC8B;AAK/D;EAKiB,MAAA,CAAA,MAAU,ECqCX,IDrCW,CCqCN,WDrCM,EAAA,IAAA,GAAA,WAAA,GAAA,OAAA,CAAA,CAAA,EAAA,IAAA;EAYV;AAkBjB;;;EAM0B,UAIL,EAAA,ECGN,WDHM,EAAA;EAAM;;;;;;EAYF,KAAA,CAAA,GAAA,CAAA,ECDZ,YDCY,CAAA,ECDG,ODCH,CAAA,IAAA,CAAA;EAMR;;;;EAMU,KAEd,EAAA,EAAA,IAAA;EAAM;AAEA;AAOnB;;;;;;;;;;;;;;;;EAc+B,WAChB,CAAA,QAAA,ECbQ,aDaR,CAAA,EAAA,IAAA;EAAM;AAQrB;;;;;AAAoE;AAKpE;;;;;;AACsD;;;;ACrHtD;;;;;;;;EAsCa,cACkB,CAAA,GAAA,EA8EV,YA9EU,CAAA,EAAA,IAAA;EAAY;;;;EAWX,cAAhB,EAAA,EAyEG,YAzEH,GAAA,SAAA"}
|
package/dist/Auditor.d.cts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { Auditor } from "./Auditor-DpBHXIJM.cjs";
|
|
2
2
|
export { Auditor };
|
package/dist/Auditor.d.mts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { Auditor } from "./Auditor-CW2NrfHS.mjs";
|
|
2
2
|
export { Auditor };
|
package/dist/Auditor.mjs
CHANGED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
import { nanoid } from "nanoid";
|
|
2
|
+
|
|
3
|
+
//#region src/DefaultAuditor.ts
|
|
4
|
+
/**
|
|
5
|
+
* Default implementation of the Auditor interface.
|
|
6
|
+
* Collects audit records in memory and flushes to storage.
|
|
7
|
+
*
|
|
8
|
+
* @template TAuditAction - Union of all allowed audit action types
|
|
9
|
+
* @template TTransaction - Transaction type (e.g., Kysely Transaction)
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* ```typescript
|
|
13
|
+
* const auditor = new DefaultAuditor<AppAuditAction>({
|
|
14
|
+
* actor: { id: 'user-123', type: 'user' },
|
|
15
|
+
* storage: auditStorage,
|
|
16
|
+
* metadata: { requestId: 'req-456', endpoint: '/users' },
|
|
17
|
+
* });
|
|
18
|
+
*
|
|
19
|
+
* auditor.audit('user.created', { userId: '789', email: 'test@example.com' });
|
|
20
|
+
*
|
|
21
|
+
* // Flush inside transaction
|
|
22
|
+
* await auditor.flush(trx);
|
|
23
|
+
* ```
|
|
24
|
+
*/
|
|
25
|
+
var DefaultAuditor = class {
|
|
26
|
+
actor;
|
|
27
|
+
storage;
|
|
28
|
+
metadata;
|
|
29
|
+
generateId;
|
|
30
|
+
records = [];
|
|
31
|
+
transaction;
|
|
32
|
+
constructor(config) {
|
|
33
|
+
this.actor = config.actor;
|
|
34
|
+
this.storage = config.storage;
|
|
35
|
+
this.metadata = config.metadata;
|
|
36
|
+
this.generateId = config.generateId ?? (() => nanoid());
|
|
37
|
+
}
|
|
38
|
+
audit(type, payload, options) {
|
|
39
|
+
const record = {
|
|
40
|
+
id: this.generateId(),
|
|
41
|
+
type,
|
|
42
|
+
operation: options?.operation ?? "CUSTOM",
|
|
43
|
+
table: options?.table,
|
|
44
|
+
entityId: options?.entityId,
|
|
45
|
+
oldValues: options?.oldValues,
|
|
46
|
+
newValues: options?.newValues,
|
|
47
|
+
payload,
|
|
48
|
+
timestamp: /* @__PURE__ */ new Date(),
|
|
49
|
+
actor: this.actor,
|
|
50
|
+
metadata: this.metadata
|
|
51
|
+
};
|
|
52
|
+
this.records.push(record);
|
|
53
|
+
}
|
|
54
|
+
record(record) {
|
|
55
|
+
const fullRecord = {
|
|
56
|
+
...record,
|
|
57
|
+
id: this.generateId(),
|
|
58
|
+
timestamp: /* @__PURE__ */ new Date(),
|
|
59
|
+
actor: this.actor,
|
|
60
|
+
metadata: this.metadata ? {
|
|
61
|
+
...this.metadata,
|
|
62
|
+
...record.metadata
|
|
63
|
+
} : record.metadata
|
|
64
|
+
};
|
|
65
|
+
this.records.push(fullRecord);
|
|
66
|
+
}
|
|
67
|
+
getRecords() {
|
|
68
|
+
return [...this.records];
|
|
69
|
+
}
|
|
70
|
+
async flush(trx) {
|
|
71
|
+
if (this.records.length === 0) return;
|
|
72
|
+
const recordsToFlush = [...this.records];
|
|
73
|
+
this.records = [];
|
|
74
|
+
const transactionToUse = trx ?? this.transaction;
|
|
75
|
+
await this.storage.write(recordsToFlush, transactionToUse);
|
|
76
|
+
}
|
|
77
|
+
setTransaction(trx) {
|
|
78
|
+
this.transaction = trx;
|
|
79
|
+
}
|
|
80
|
+
getTransaction() {
|
|
81
|
+
return this.transaction;
|
|
82
|
+
}
|
|
83
|
+
clear() {
|
|
84
|
+
this.records = [];
|
|
85
|
+
}
|
|
86
|
+
addMetadata(metadata) {
|
|
87
|
+
this.metadata = this.metadata ? {
|
|
88
|
+
...this.metadata,
|
|
89
|
+
...metadata
|
|
90
|
+
} : metadata;
|
|
91
|
+
}
|
|
92
|
+
};
|
|
93
|
+
|
|
94
|
+
//#endregion
|
|
95
|
+
export { DefaultAuditor };
|
|
96
|
+
//# sourceMappingURL=DefaultAuditor-BAVnNmRh.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"DefaultAuditor-BAVnNmRh.mjs","names":["config: DefaultAuditorConfig","type: TType","payload: ExtractAuditPayload<TAuditAction, TType>","options?: AuditOptions","record: AuditRecord","record: Omit<AuditRecord, 'id' | 'timestamp' | 'actor'>","fullRecord: AuditRecord","trx?: TTransaction","trx: TTransaction","metadata: AuditMetadata"],"sources":["../src/DefaultAuditor.ts"],"sourcesContent":["import { nanoid } from 'nanoid';\nimport type { Auditor } from './Auditor';\nimport type { AuditStorage } from './storage';\nimport type {\n\tAuditActor,\n\tAuditableAction,\n\tAuditMetadata,\n\tAuditOptions,\n\tAuditRecord,\n\tExtractAuditPayload,\n\tExtractAuditType,\n} from './types';\n\n/**\n * Configuration for DefaultAuditor.\n */\nexport interface DefaultAuditorConfig {\n\t/** The actor performing audits (set at construction, immutable) */\n\tactor: AuditActor;\n\t/** Storage backend for persisting audits */\n\tstorage: AuditStorage;\n\t/** Optional metadata to attach to all audits */\n\tmetadata?: AuditMetadata;\n\t/** Optional custom ID generator (defaults to nanoid) */\n\tgenerateId?: () => string;\n}\n\n/**\n * Default implementation of the Auditor interface.\n * Collects audit records in memory and flushes to storage.\n *\n * @template TAuditAction - Union of all allowed audit action types\n * @template TTransaction - Transaction type (e.g., Kysely Transaction)\n *\n * @example\n * ```typescript\n * const auditor = new DefaultAuditor<AppAuditAction>({\n * actor: { id: 'user-123', type: 'user' },\n * storage: auditStorage,\n * metadata: { requestId: 'req-456', endpoint: '/users' },\n * });\n *\n * auditor.audit('user.created', { userId: '789', email: 'test@example.com' });\n *\n * // Flush inside transaction\n * await auditor.flush(trx);\n * ```\n */\nexport class DefaultAuditor<\n\tTAuditAction extends AuditableAction<string, unknown> = AuditableAction<\n\t\tstring,\n\t\tunknown\n\t>,\n\tTTransaction = unknown,\n> implements Auditor<TAuditAction, TTransaction>\n{\n\treadonly actor: AuditActor;\n\tprivate readonly storage: AuditStorage;\n\tprivate metadata?: AuditMetadata;\n\tprivate readonly generateId: () => string;\n\tprivate records: AuditRecord[] = [];\n\tprivate transaction?: TTransaction;\n\n\tconstructor(config: DefaultAuditorConfig) {\n\t\tthis.actor = config.actor;\n\t\tthis.storage = config.storage;\n\t\tthis.metadata = config.metadata;\n\t\tthis.generateId = config.generateId ?? (() => nanoid());\n\t}\n\n\taudit<TType extends ExtractAuditType<TAuditAction>>(\n\t\ttype: TType,\n\t\tpayload: ExtractAuditPayload<TAuditAction, TType>,\n\t\toptions?: AuditOptions,\n\t): void {\n\t\tconst record: AuditRecord = {\n\t\t\tid: this.generateId(),\n\t\t\ttype,\n\t\t\toperation: options?.operation ?? 'CUSTOM',\n\t\t\ttable: options?.table,\n\t\t\tentityId: options?.entityId,\n\t\t\toldValues: options?.oldValues,\n\t\t\tnewValues: options?.newValues,\n\t\t\tpayload,\n\t\t\ttimestamp: new Date(),\n\t\t\tactor: this.actor,\n\t\t\tmetadata: this.metadata,\n\t\t};\n\n\t\tthis.records.push(record);\n\t}\n\n\trecord(record: Omit<AuditRecord, 'id' | 'timestamp' | 'actor'>): void {\n\t\tconst fullRecord: AuditRecord = {\n\t\t\t...record,\n\t\t\tid: this.generateId(),\n\t\t\ttimestamp: new Date(),\n\t\t\tactor: this.actor,\n\t\t\tmetadata: this.metadata\n\t\t\t\t? { ...this.metadata, ...record.metadata }\n\t\t\t\t: record.metadata,\n\t\t};\n\n\t\tthis.records.push(fullRecord);\n\t}\n\n\tgetRecords(): AuditRecord[] {\n\t\treturn [...this.records];\n\t}\n\n\tasync flush(trx?: TTransaction): Promise<void> {\n\t\tif (this.records.length === 0) {\n\t\t\treturn;\n\t\t}\n\n\t\tconst recordsToFlush = [...this.records];\n\t\tthis.records = [];\n\n\t\t// Use explicitly passed transaction, or fall back to stored transaction\n\t\tconst transactionToUse = trx ?? this.transaction;\n\t\tawait this.storage.write(recordsToFlush, transactionToUse);\n\t}\n\n\tsetTransaction(trx: TTransaction): void {\n\t\tthis.transaction = trx;\n\t}\n\n\tgetTransaction(): TTransaction | undefined {\n\t\treturn this.transaction;\n\t}\n\n\tclear(): void {\n\t\tthis.records = [];\n\t}\n\n\taddMetadata(metadata: AuditMetadata): void {\n\t\tthis.metadata = this.metadata\n\t\t\t? { ...this.metadata, ...metadata }\n\t\t\t: metadata;\n\t}\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAgDA,IAAa,iBAAb,MAOA;CACC,AAAS;CACT,AAAiB;CACjB,AAAQ;CACR,AAAiB;CACjB,AAAQ,UAAyB,CAAE;CACnC,AAAQ;CAER,YAAYA,QAA8B;AACzC,OAAK,QAAQ,OAAO;AACpB,OAAK,UAAU,OAAO;AACtB,OAAK,WAAW,OAAO;AACvB,OAAK,aAAa,OAAO,eAAe,MAAM,QAAQ;CACtD;CAED,MACCC,MACAC,SACAC,SACO;EACP,MAAMC,SAAsB;GAC3B,IAAI,KAAK,YAAY;GACrB;GACA,WAAW,SAAS,aAAa;GACjC,OAAO,SAAS;GAChB,UAAU,SAAS;GACnB,WAAW,SAAS;GACpB,WAAW,SAAS;GACpB;GACA,2BAAW,IAAI;GACf,OAAO,KAAK;GACZ,UAAU,KAAK;EACf;AAED,OAAK,QAAQ,KAAK,OAAO;CACzB;CAED,OAAOC,QAA+D;EACrE,MAAMC,aAA0B;GAC/B,GAAG;GACH,IAAI,KAAK,YAAY;GACrB,2BAAW,IAAI;GACf,OAAO,KAAK;GACZ,UAAU,KAAK,WACZ;IAAE,GAAG,KAAK;IAAU,GAAG,OAAO;GAAU,IACxC,OAAO;EACV;AAED,OAAK,QAAQ,KAAK,WAAW;CAC7B;CAED,aAA4B;AAC3B,SAAO,CAAC,GAAG,KAAK,OAAQ;CACxB;CAED,MAAM,MAAMC,KAAmC;AAC9C,MAAI,KAAK,QAAQ,WAAW,EAC3B;EAGD,MAAM,iBAAiB,CAAC,GAAG,KAAK,OAAQ;AACxC,OAAK,UAAU,CAAE;EAGjB,MAAM,mBAAmB,OAAO,KAAK;AACrC,QAAM,KAAK,QAAQ,MAAM,gBAAgB,iBAAiB;CAC1D;CAED,eAAeC,KAAyB;AACvC,OAAK,cAAc;CACnB;CAED,iBAA2C;AAC1C,SAAO,KAAK;CACZ;CAED,QAAc;AACb,OAAK,UAAU,CAAE;CACjB;CAED,YAAYC,UAA+B;AAC1C,OAAK,WAAW,KAAK,WAClB;GAAE,GAAG,KAAK;GAAU,GAAG;EAAU,IACjC;CACH;AACD"}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
import { AuditActor, AuditMetadata, AuditOptions, AuditRecord, AuditStorage, AuditableAction, Auditor, ExtractAuditPayload, ExtractAuditType } from "./Auditor-CW2NrfHS.mjs";
|
|
2
|
+
|
|
3
|
+
//#region src/DefaultAuditor.d.ts
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Configuration for DefaultAuditor.
|
|
7
|
+
*/
|
|
8
|
+
interface DefaultAuditorConfig {
|
|
9
|
+
/** The actor performing audits (set at construction, immutable) */
|
|
10
|
+
actor: AuditActor;
|
|
11
|
+
/** Storage backend for persisting audits */
|
|
12
|
+
storage: AuditStorage;
|
|
13
|
+
/** Optional metadata to attach to all audits */
|
|
14
|
+
metadata?: AuditMetadata;
|
|
15
|
+
/** Optional custom ID generator (defaults to nanoid) */
|
|
16
|
+
generateId?: () => string;
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* Default implementation of the Auditor interface.
|
|
20
|
+
* Collects audit records in memory and flushes to storage.
|
|
21
|
+
*
|
|
22
|
+
* @template TAuditAction - Union of all allowed audit action types
|
|
23
|
+
* @template TTransaction - Transaction type (e.g., Kysely Transaction)
|
|
24
|
+
*
|
|
25
|
+
* @example
|
|
26
|
+
* ```typescript
|
|
27
|
+
* const auditor = new DefaultAuditor<AppAuditAction>({
|
|
28
|
+
* actor: { id: 'user-123', type: 'user' },
|
|
29
|
+
* storage: auditStorage,
|
|
30
|
+
* metadata: { requestId: 'req-456', endpoint: '/users' },
|
|
31
|
+
* });
|
|
32
|
+
*
|
|
33
|
+
* auditor.audit('user.created', { userId: '789', email: 'test@example.com' });
|
|
34
|
+
*
|
|
35
|
+
* // Flush inside transaction
|
|
36
|
+
* await auditor.flush(trx);
|
|
37
|
+
* ```
|
|
38
|
+
*/
|
|
39
|
+
declare class DefaultAuditor<TAuditAction extends AuditableAction<string, unknown> = AuditableAction<string, unknown>, TTransaction = unknown> implements Auditor<TAuditAction, TTransaction> {
|
|
40
|
+
readonly actor: AuditActor;
|
|
41
|
+
private readonly storage;
|
|
42
|
+
private metadata?;
|
|
43
|
+
private readonly generateId;
|
|
44
|
+
private records;
|
|
45
|
+
private transaction?;
|
|
46
|
+
constructor(config: DefaultAuditorConfig);
|
|
47
|
+
audit<TType extends ExtractAuditType<TAuditAction>>(type: TType, payload: ExtractAuditPayload<TAuditAction, TType>, options?: AuditOptions): void;
|
|
48
|
+
record(record: Omit<AuditRecord, 'id' | 'timestamp' | 'actor'>): void;
|
|
49
|
+
getRecords(): AuditRecord[];
|
|
50
|
+
flush(trx?: TTransaction): Promise<void>;
|
|
51
|
+
setTransaction(trx: TTransaction): void;
|
|
52
|
+
getTransaction(): TTransaction | undefined;
|
|
53
|
+
clear(): void;
|
|
54
|
+
addMetadata(metadata: AuditMetadata): void;
|
|
55
|
+
}
|
|
56
|
+
//# sourceMappingURL=DefaultAuditor.d.ts.map
|
|
57
|
+
//#endregion
|
|
58
|
+
export { DefaultAuditor, DefaultAuditorConfig };
|
|
59
|
+
//# sourceMappingURL=DefaultAuditor-DlJ1ENfx.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"DefaultAuditor-DlJ1ENfx.d.mts","names":[],"sources":["../src/DefaultAuditor.ts"],"sourcesContent":[],"mappings":";;;;AAgBA;;;AAIU,UAJO,oBAAA,CAIP;EAAY;EAEG,KAAA,EAJjB,UAIiB;EA0BZ;EAAc,OAAA,EA5BjB,YA4BiB;EAAA;EACU,QAAoB,CAAA,EA3B7C,aA2B6C;EAAe;EAKvC,UAAE,CAAA,EAAA,GAAA,GAAA,MAAA;;;;;;;;;;;;;;;;;;;AAAf;;;;cANP,oCACS,mCAAmC,qEAK5C,QAAQ,cAAc;kBAElB;;;;;;sBAOI;sBAOA,iBAAiB,qBAC9B,gBACG,oBAAoB,cAAc,kBACjC;iBAmBI,KAAK;gBAcN;cAII,eAAe;sBAab;oBAIF;;wBAQI"}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
import { AuditActor, AuditMetadata, AuditOptions, AuditRecord, AuditStorage, AuditableAction, Auditor, ExtractAuditPayload, ExtractAuditType } from "./Auditor-DpBHXIJM.cjs";
|
|
2
|
+
|
|
3
|
+
//#region src/DefaultAuditor.d.ts
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Configuration for DefaultAuditor.
|
|
7
|
+
*/
|
|
8
|
+
interface DefaultAuditorConfig {
|
|
9
|
+
/** The actor performing audits (set at construction, immutable) */
|
|
10
|
+
actor: AuditActor;
|
|
11
|
+
/** Storage backend for persisting audits */
|
|
12
|
+
storage: AuditStorage;
|
|
13
|
+
/** Optional metadata to attach to all audits */
|
|
14
|
+
metadata?: AuditMetadata;
|
|
15
|
+
/** Optional custom ID generator (defaults to nanoid) */
|
|
16
|
+
generateId?: () => string;
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* Default implementation of the Auditor interface.
|
|
20
|
+
* Collects audit records in memory and flushes to storage.
|
|
21
|
+
*
|
|
22
|
+
* @template TAuditAction - Union of all allowed audit action types
|
|
23
|
+
* @template TTransaction - Transaction type (e.g., Kysely Transaction)
|
|
24
|
+
*
|
|
25
|
+
* @example
|
|
26
|
+
* ```typescript
|
|
27
|
+
* const auditor = new DefaultAuditor<AppAuditAction>({
|
|
28
|
+
* actor: { id: 'user-123', type: 'user' },
|
|
29
|
+
* storage: auditStorage,
|
|
30
|
+
* metadata: { requestId: 'req-456', endpoint: '/users' },
|
|
31
|
+
* });
|
|
32
|
+
*
|
|
33
|
+
* auditor.audit('user.created', { userId: '789', email: 'test@example.com' });
|
|
34
|
+
*
|
|
35
|
+
* // Flush inside transaction
|
|
36
|
+
* await auditor.flush(trx);
|
|
37
|
+
* ```
|
|
38
|
+
*/
|
|
39
|
+
declare class DefaultAuditor<TAuditAction extends AuditableAction<string, unknown> = AuditableAction<string, unknown>, TTransaction = unknown> implements Auditor<TAuditAction, TTransaction> {
|
|
40
|
+
readonly actor: AuditActor;
|
|
41
|
+
private readonly storage;
|
|
42
|
+
private metadata?;
|
|
43
|
+
private readonly generateId;
|
|
44
|
+
private records;
|
|
45
|
+
private transaction?;
|
|
46
|
+
constructor(config: DefaultAuditorConfig);
|
|
47
|
+
audit<TType extends ExtractAuditType<TAuditAction>>(type: TType, payload: ExtractAuditPayload<TAuditAction, TType>, options?: AuditOptions): void;
|
|
48
|
+
record(record: Omit<AuditRecord, 'id' | 'timestamp' | 'actor'>): void;
|
|
49
|
+
getRecords(): AuditRecord[];
|
|
50
|
+
flush(trx?: TTransaction): Promise<void>;
|
|
51
|
+
setTransaction(trx: TTransaction): void;
|
|
52
|
+
getTransaction(): TTransaction | undefined;
|
|
53
|
+
clear(): void;
|
|
54
|
+
addMetadata(metadata: AuditMetadata): void;
|
|
55
|
+
}
|
|
56
|
+
//# sourceMappingURL=DefaultAuditor.d.ts.map
|
|
57
|
+
//#endregion
|
|
58
|
+
export { DefaultAuditor, DefaultAuditorConfig };
|
|
59
|
+
//# sourceMappingURL=DefaultAuditor-GRFI86N_.d.cts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"DefaultAuditor-GRFI86N_.d.cts","names":[],"sources":["../src/DefaultAuditor.ts"],"sourcesContent":[],"mappings":";;;;AAgBA;;;AAIU,UAJO,oBAAA,CAIP;EAAY;EAEG,KAAA,EAJjB,UAIiB;EA0BZ;EAAc,OAAA,EA5BjB,YA4BiB;EAAA;EACU,QAAoB,CAAA,EA3B7C,aA2B6C;EAAe;EAKvC,UAAE,CAAA,EAAA,GAAA,GAAA,MAAA;;;;;;;;;;;;;;;;;;;AAAf;;;;cANP,oCACS,mCAAmC,qEAK5C,QAAQ,cAAc;kBAElB;;;;;;sBAOI;sBAOA,iBAAiB,qBAC9B,gBACG,oBAAoB,cAAc,kBACjC;iBAmBI,KAAK;gBAcN;cAII,eAAe;sBAab;oBAIF;;wBAQI"}
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
const require_chunk = require('./chunk-CUT6urMc.cjs');
|
|
2
|
+
const nanoid = require_chunk.__toESM(require("nanoid"));
|
|
3
|
+
|
|
4
|
+
//#region src/DefaultAuditor.ts
|
|
5
|
+
/**
|
|
6
|
+
* Default implementation of the Auditor interface.
|
|
7
|
+
* Collects audit records in memory and flushes to storage.
|
|
8
|
+
*
|
|
9
|
+
* @template TAuditAction - Union of all allowed audit action types
|
|
10
|
+
* @template TTransaction - Transaction type (e.g., Kysely Transaction)
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```typescript
|
|
14
|
+
* const auditor = new DefaultAuditor<AppAuditAction>({
|
|
15
|
+
* actor: { id: 'user-123', type: 'user' },
|
|
16
|
+
* storage: auditStorage,
|
|
17
|
+
* metadata: { requestId: 'req-456', endpoint: '/users' },
|
|
18
|
+
* });
|
|
19
|
+
*
|
|
20
|
+
* auditor.audit('user.created', { userId: '789', email: 'test@example.com' });
|
|
21
|
+
*
|
|
22
|
+
* // Flush inside transaction
|
|
23
|
+
* await auditor.flush(trx);
|
|
24
|
+
* ```
|
|
25
|
+
*/
|
|
26
|
+
var DefaultAuditor = class {
|
|
27
|
+
actor;
|
|
28
|
+
storage;
|
|
29
|
+
metadata;
|
|
30
|
+
generateId;
|
|
31
|
+
records = [];
|
|
32
|
+
transaction;
|
|
33
|
+
constructor(config) {
|
|
34
|
+
this.actor = config.actor;
|
|
35
|
+
this.storage = config.storage;
|
|
36
|
+
this.metadata = config.metadata;
|
|
37
|
+
this.generateId = config.generateId ?? (() => (0, nanoid.nanoid)());
|
|
38
|
+
}
|
|
39
|
+
audit(type, payload, options) {
|
|
40
|
+
const record = {
|
|
41
|
+
id: this.generateId(),
|
|
42
|
+
type,
|
|
43
|
+
operation: options?.operation ?? "CUSTOM",
|
|
44
|
+
table: options?.table,
|
|
45
|
+
entityId: options?.entityId,
|
|
46
|
+
oldValues: options?.oldValues,
|
|
47
|
+
newValues: options?.newValues,
|
|
48
|
+
payload,
|
|
49
|
+
timestamp: /* @__PURE__ */ new Date(),
|
|
50
|
+
actor: this.actor,
|
|
51
|
+
metadata: this.metadata
|
|
52
|
+
};
|
|
53
|
+
this.records.push(record);
|
|
54
|
+
}
|
|
55
|
+
record(record) {
|
|
56
|
+
const fullRecord = {
|
|
57
|
+
...record,
|
|
58
|
+
id: this.generateId(),
|
|
59
|
+
timestamp: /* @__PURE__ */ new Date(),
|
|
60
|
+
actor: this.actor,
|
|
61
|
+
metadata: this.metadata ? {
|
|
62
|
+
...this.metadata,
|
|
63
|
+
...record.metadata
|
|
64
|
+
} : record.metadata
|
|
65
|
+
};
|
|
66
|
+
this.records.push(fullRecord);
|
|
67
|
+
}
|
|
68
|
+
getRecords() {
|
|
69
|
+
return [...this.records];
|
|
70
|
+
}
|
|
71
|
+
async flush(trx) {
|
|
72
|
+
if (this.records.length === 0) return;
|
|
73
|
+
const recordsToFlush = [...this.records];
|
|
74
|
+
this.records = [];
|
|
75
|
+
const transactionToUse = trx ?? this.transaction;
|
|
76
|
+
await this.storage.write(recordsToFlush, transactionToUse);
|
|
77
|
+
}
|
|
78
|
+
setTransaction(trx) {
|
|
79
|
+
this.transaction = trx;
|
|
80
|
+
}
|
|
81
|
+
getTransaction() {
|
|
82
|
+
return this.transaction;
|
|
83
|
+
}
|
|
84
|
+
clear() {
|
|
85
|
+
this.records = [];
|
|
86
|
+
}
|
|
87
|
+
addMetadata(metadata) {
|
|
88
|
+
this.metadata = this.metadata ? {
|
|
89
|
+
...this.metadata,
|
|
90
|
+
...metadata
|
|
91
|
+
} : metadata;
|
|
92
|
+
}
|
|
93
|
+
};
|
|
94
|
+
|
|
95
|
+
//#endregion
|
|
96
|
+
Object.defineProperty(exports, 'DefaultAuditor', {
|
|
97
|
+
enumerable: true,
|
|
98
|
+
get: function () {
|
|
99
|
+
return DefaultAuditor;
|
|
100
|
+
}
|
|
101
|
+
});
|
|
102
|
+
//# sourceMappingURL=DefaultAuditor-JbZ_BQfh.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"DefaultAuditor-JbZ_BQfh.cjs","names":["config: DefaultAuditorConfig","type: TType","payload: ExtractAuditPayload<TAuditAction, TType>","options?: AuditOptions","record: AuditRecord","record: Omit<AuditRecord, 'id' | 'timestamp' | 'actor'>","fullRecord: AuditRecord","trx?: TTransaction","trx: TTransaction","metadata: AuditMetadata"],"sources":["../src/DefaultAuditor.ts"],"sourcesContent":["import { nanoid } from 'nanoid';\nimport type { Auditor } from './Auditor';\nimport type { AuditStorage } from './storage';\nimport type {\n\tAuditActor,\n\tAuditableAction,\n\tAuditMetadata,\n\tAuditOptions,\n\tAuditRecord,\n\tExtractAuditPayload,\n\tExtractAuditType,\n} from './types';\n\n/**\n * Configuration for DefaultAuditor.\n */\nexport interface DefaultAuditorConfig {\n\t/** The actor performing audits (set at construction, immutable) */\n\tactor: AuditActor;\n\t/** Storage backend for persisting audits */\n\tstorage: AuditStorage;\n\t/** Optional metadata to attach to all audits */\n\tmetadata?: AuditMetadata;\n\t/** Optional custom ID generator (defaults to nanoid) */\n\tgenerateId?: () => string;\n}\n\n/**\n * Default implementation of the Auditor interface.\n * Collects audit records in memory and flushes to storage.\n *\n * @template TAuditAction - Union of all allowed audit action types\n * @template TTransaction - Transaction type (e.g., Kysely Transaction)\n *\n * @example\n * ```typescript\n * const auditor = new DefaultAuditor<AppAuditAction>({\n * actor: { id: 'user-123', type: 'user' },\n * storage: auditStorage,\n * metadata: { requestId: 'req-456', endpoint: '/users' },\n * });\n *\n * auditor.audit('user.created', { userId: '789', email: 'test@example.com' });\n *\n * // Flush inside transaction\n * await auditor.flush(trx);\n * ```\n */\nexport class DefaultAuditor<\n\tTAuditAction extends AuditableAction<string, unknown> = AuditableAction<\n\t\tstring,\n\t\tunknown\n\t>,\n\tTTransaction = unknown,\n> implements Auditor<TAuditAction, TTransaction>\n{\n\treadonly actor: AuditActor;\n\tprivate readonly storage: AuditStorage;\n\tprivate metadata?: AuditMetadata;\n\tprivate readonly generateId: () => string;\n\tprivate records: AuditRecord[] = [];\n\tprivate transaction?: TTransaction;\n\n\tconstructor(config: DefaultAuditorConfig) {\n\t\tthis.actor = config.actor;\n\t\tthis.storage = config.storage;\n\t\tthis.metadata = config.metadata;\n\t\tthis.generateId = config.generateId ?? (() => nanoid());\n\t}\n\n\taudit<TType extends ExtractAuditType<TAuditAction>>(\n\t\ttype: TType,\n\t\tpayload: ExtractAuditPayload<TAuditAction, TType>,\n\t\toptions?: AuditOptions,\n\t): void {\n\t\tconst record: AuditRecord = {\n\t\t\tid: this.generateId(),\n\t\t\ttype,\n\t\t\toperation: options?.operation ?? 'CUSTOM',\n\t\t\ttable: options?.table,\n\t\t\tentityId: options?.entityId,\n\t\t\toldValues: options?.oldValues,\n\t\t\tnewValues: options?.newValues,\n\t\t\tpayload,\n\t\t\ttimestamp: new Date(),\n\t\t\tactor: this.actor,\n\t\t\tmetadata: this.metadata,\n\t\t};\n\n\t\tthis.records.push(record);\n\t}\n\n\trecord(record: Omit<AuditRecord, 'id' | 'timestamp' | 'actor'>): void {\n\t\tconst fullRecord: AuditRecord = {\n\t\t\t...record,\n\t\t\tid: this.generateId(),\n\t\t\ttimestamp: new Date(),\n\t\t\tactor: this.actor,\n\t\t\tmetadata: this.metadata\n\t\t\t\t? { ...this.metadata, ...record.metadata }\n\t\t\t\t: record.metadata,\n\t\t};\n\n\t\tthis.records.push(fullRecord);\n\t}\n\n\tgetRecords(): AuditRecord[] {\n\t\treturn [...this.records];\n\t}\n\n\tasync flush(trx?: TTransaction): Promise<void> {\n\t\tif (this.records.length === 0) {\n\t\t\treturn;\n\t\t}\n\n\t\tconst recordsToFlush = [...this.records];\n\t\tthis.records = [];\n\n\t\t// Use explicitly passed transaction, or fall back to stored transaction\n\t\tconst transactionToUse = trx ?? this.transaction;\n\t\tawait this.storage.write(recordsToFlush, transactionToUse);\n\t}\n\n\tsetTransaction(trx: TTransaction): void {\n\t\tthis.transaction = trx;\n\t}\n\n\tgetTransaction(): TTransaction | undefined {\n\t\treturn this.transaction;\n\t}\n\n\tclear(): void {\n\t\tthis.records = [];\n\t}\n\n\taddMetadata(metadata: AuditMetadata): void {\n\t\tthis.metadata = this.metadata\n\t\t\t? { ...this.metadata, ...metadata }\n\t\t\t: metadata;\n\t}\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAgDA,IAAa,iBAAb,MAOA;CACC,AAAS;CACT,AAAiB;CACjB,AAAQ;CACR,AAAiB;CACjB,AAAQ,UAAyB,CAAE;CACnC,AAAQ;CAER,YAAYA,QAA8B;AACzC,OAAK,QAAQ,OAAO;AACpB,OAAK,UAAU,OAAO;AACtB,OAAK,WAAW,OAAO;AACvB,OAAK,aAAa,OAAO,eAAe,MAAM,oBAAQ;CACtD;CAED,MACCC,MACAC,SACAC,SACO;EACP,MAAMC,SAAsB;GAC3B,IAAI,KAAK,YAAY;GACrB;GACA,WAAW,SAAS,aAAa;GACjC,OAAO,SAAS;GAChB,UAAU,SAAS;GACnB,WAAW,SAAS;GACpB,WAAW,SAAS;GACpB;GACA,2BAAW,IAAI;GACf,OAAO,KAAK;GACZ,UAAU,KAAK;EACf;AAED,OAAK,QAAQ,KAAK,OAAO;CACzB;CAED,OAAOC,QAA+D;EACrE,MAAMC,aAA0B;GAC/B,GAAG;GACH,IAAI,KAAK,YAAY;GACrB,2BAAW,IAAI;GACf,OAAO,KAAK;GACZ,UAAU,KAAK,WACZ;IAAE,GAAG,KAAK;IAAU,GAAG,OAAO;GAAU,IACxC,OAAO;EACV;AAED,OAAK,QAAQ,KAAK,WAAW;CAC7B;CAED,aAA4B;AAC3B,SAAO,CAAC,GAAG,KAAK,OAAQ;CACxB;CAED,MAAM,MAAMC,KAAmC;AAC9C,MAAI,KAAK,QAAQ,WAAW,EAC3B;EAGD,MAAM,iBAAiB,CAAC,GAAG,KAAK,OAAQ;AACxC,OAAK,UAAU,CAAE;EAGjB,MAAM,mBAAmB,OAAO,KAAK;AACrC,QAAM,KAAK,QAAQ,MAAM,gBAAgB,iBAAiB;CAC1D;CAED,eAAeC,KAAyB;AACvC,OAAK,cAAc;CACnB;CAED,iBAA2C;AAC1C,SAAO,KAAK;CACZ;CAED,QAAc;AACb,OAAK,UAAU,CAAE;CACjB;CAED,YAAYC,UAA+B;AAC1C,OAAK,WAAW,KAAK,WAClB;GAAE,GAAG,KAAK;GAAU,GAAG;EAAU,IACjC;CACH;AACD"}
|
package/dist/DefaultAuditor.cjs
CHANGED
|
@@ -1,96 +1,3 @@
|
|
|
1
|
-
|
|
2
|
-
let nanoid = require("nanoid");
|
|
3
|
-
//#region src/DefaultAuditor.ts
|
|
4
|
-
/**
|
|
5
|
-
* Default implementation of the Auditor interface.
|
|
6
|
-
* Collects audit records in memory and flushes to storage.
|
|
7
|
-
*
|
|
8
|
-
* @template TAuditAction - Union of all allowed audit action types
|
|
9
|
-
* @template TTransaction - Transaction type (e.g., Kysely Transaction)
|
|
10
|
-
*
|
|
11
|
-
* @example
|
|
12
|
-
* ```typescript
|
|
13
|
-
* const auditor = new DefaultAuditor<AppAuditAction>({
|
|
14
|
-
* actor: { id: 'user-123', type: 'user' },
|
|
15
|
-
* storage: auditStorage,
|
|
16
|
-
* metadata: { requestId: 'req-456', endpoint: '/users' },
|
|
17
|
-
* });
|
|
18
|
-
*
|
|
19
|
-
* auditor.audit('user.created', { userId: '789', email: 'test@example.com' });
|
|
20
|
-
*
|
|
21
|
-
* // Flush inside transaction
|
|
22
|
-
* await auditor.flush(trx);
|
|
23
|
-
* ```
|
|
24
|
-
*/
|
|
25
|
-
var DefaultAuditor = class {
|
|
26
|
-
actor;
|
|
27
|
-
storage;
|
|
28
|
-
metadata;
|
|
29
|
-
generateId;
|
|
30
|
-
records = [];
|
|
31
|
-
transaction;
|
|
32
|
-
constructor(config) {
|
|
33
|
-
this.actor = config.actor;
|
|
34
|
-
this.storage = config.storage;
|
|
35
|
-
this.metadata = config.metadata;
|
|
36
|
-
this.generateId = config.generateId ?? (() => (0, nanoid.nanoid)());
|
|
37
|
-
}
|
|
38
|
-
audit(type, payload, options) {
|
|
39
|
-
const record = {
|
|
40
|
-
id: this.generateId(),
|
|
41
|
-
type,
|
|
42
|
-
operation: options?.operation ?? "CUSTOM",
|
|
43
|
-
table: options?.table,
|
|
44
|
-
entityId: options?.entityId,
|
|
45
|
-
oldValues: options?.oldValues,
|
|
46
|
-
newValues: options?.newValues,
|
|
47
|
-
payload,
|
|
48
|
-
timestamp: /* @__PURE__ */ new Date(),
|
|
49
|
-
actor: this.actor,
|
|
50
|
-
metadata: this.metadata
|
|
51
|
-
};
|
|
52
|
-
this.records.push(record);
|
|
53
|
-
}
|
|
54
|
-
record(record) {
|
|
55
|
-
const fullRecord = {
|
|
56
|
-
...record,
|
|
57
|
-
id: this.generateId(),
|
|
58
|
-
timestamp: /* @__PURE__ */ new Date(),
|
|
59
|
-
actor: this.actor,
|
|
60
|
-
metadata: this.metadata ? {
|
|
61
|
-
...this.metadata,
|
|
62
|
-
...record.metadata
|
|
63
|
-
} : record.metadata
|
|
64
|
-
};
|
|
65
|
-
this.records.push(fullRecord);
|
|
66
|
-
}
|
|
67
|
-
getRecords() {
|
|
68
|
-
return [...this.records];
|
|
69
|
-
}
|
|
70
|
-
async flush(trx) {
|
|
71
|
-
if (this.records.length === 0) return;
|
|
72
|
-
const recordsToFlush = [...this.records];
|
|
73
|
-
this.records = [];
|
|
74
|
-
const transactionToUse = trx ?? this.transaction;
|
|
75
|
-
await this.storage.write(recordsToFlush, transactionToUse);
|
|
76
|
-
}
|
|
77
|
-
setTransaction(trx) {
|
|
78
|
-
this.transaction = trx;
|
|
79
|
-
}
|
|
80
|
-
getTransaction() {
|
|
81
|
-
return this.transaction;
|
|
82
|
-
}
|
|
83
|
-
clear() {
|
|
84
|
-
this.records = [];
|
|
85
|
-
}
|
|
86
|
-
addMetadata(metadata) {
|
|
87
|
-
this.metadata = this.metadata ? {
|
|
88
|
-
...this.metadata,
|
|
89
|
-
...metadata
|
|
90
|
-
} : metadata;
|
|
91
|
-
}
|
|
92
|
-
};
|
|
93
|
-
//#endregion
|
|
94
|
-
exports.DefaultAuditor = DefaultAuditor;
|
|
1
|
+
const require_DefaultAuditor = require('./DefaultAuditor-JbZ_BQfh.cjs');
|
|
95
2
|
|
|
96
|
-
|
|
3
|
+
exports.DefaultAuditor = require_DefaultAuditor.DefaultAuditor;
|
|
@@ -1,55 +1,3 @@
|
|
|
1
|
-
import
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
* Configuration for DefaultAuditor.
|
|
5
|
-
*/
|
|
6
|
-
export interface DefaultAuditorConfig {
|
|
7
|
-
/** The actor performing audits (set at construction, immutable) */
|
|
8
|
-
actor: AuditActor;
|
|
9
|
-
/** Storage backend for persisting audits */
|
|
10
|
-
storage: AuditStorage;
|
|
11
|
-
/** Optional metadata to attach to all audits */
|
|
12
|
-
metadata?: AuditMetadata;
|
|
13
|
-
/** Optional custom ID generator (defaults to nanoid) */
|
|
14
|
-
generateId?: () => string;
|
|
15
|
-
}
|
|
16
|
-
/**
|
|
17
|
-
* Default implementation of the Auditor interface.
|
|
18
|
-
* Collects audit records in memory and flushes to storage.
|
|
19
|
-
*
|
|
20
|
-
* @template TAuditAction - Union of all allowed audit action types
|
|
21
|
-
* @template TTransaction - Transaction type (e.g., Kysely Transaction)
|
|
22
|
-
*
|
|
23
|
-
* @example
|
|
24
|
-
* ```typescript
|
|
25
|
-
* const auditor = new DefaultAuditor<AppAuditAction>({
|
|
26
|
-
* actor: { id: 'user-123', type: 'user' },
|
|
27
|
-
* storage: auditStorage,
|
|
28
|
-
* metadata: { requestId: 'req-456', endpoint: '/users' },
|
|
29
|
-
* });
|
|
30
|
-
*
|
|
31
|
-
* auditor.audit('user.created', { userId: '789', email: 'test@example.com' });
|
|
32
|
-
*
|
|
33
|
-
* // Flush inside transaction
|
|
34
|
-
* await auditor.flush(trx);
|
|
35
|
-
* ```
|
|
36
|
-
*/
|
|
37
|
-
export declare class DefaultAuditor<TAuditAction extends AuditableAction<string, unknown> = AuditableAction<string, unknown>, TTransaction = unknown> implements Auditor<TAuditAction, TTransaction> {
|
|
38
|
-
readonly actor: AuditActor;
|
|
39
|
-
private readonly storage;
|
|
40
|
-
private metadata?;
|
|
41
|
-
private readonly generateId;
|
|
42
|
-
private records;
|
|
43
|
-
private transaction?;
|
|
44
|
-
constructor(config: DefaultAuditorConfig);
|
|
45
|
-
audit<TType extends ExtractAuditType<TAuditAction>>(type: TType, payload: ExtractAuditPayload<TAuditAction, TType>, options?: AuditOptions): void;
|
|
46
|
-
record(record: Omit<AuditRecord, 'id' | 'timestamp' | 'actor'>): void;
|
|
47
|
-
getRecords(): AuditRecord[];
|
|
48
|
-
flush(trx?: TTransaction): Promise<void>;
|
|
49
|
-
setTransaction(trx: TTransaction): void;
|
|
50
|
-
getTransaction(): TTransaction | undefined;
|
|
51
|
-
clear(): void;
|
|
52
|
-
addMetadata(metadata: AuditMetadata): void;
|
|
53
|
-
}
|
|
54
|
-
//#endregion
|
|
55
|
-
//# sourceMappingURL=DefaultAuditor.d.cts.map
|
|
1
|
+
import "./Auditor-DpBHXIJM.cjs";
|
|
2
|
+
import { DefaultAuditor, DefaultAuditorConfig } from "./DefaultAuditor-GRFI86N_.cjs";
|
|
3
|
+
export { DefaultAuditor, DefaultAuditorConfig };
|
|
@@ -1,55 +1,3 @@
|
|
|
1
|
-
import
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
* Configuration for DefaultAuditor.
|
|
5
|
-
*/
|
|
6
|
-
export interface DefaultAuditorConfig {
|
|
7
|
-
/** The actor performing audits (set at construction, immutable) */
|
|
8
|
-
actor: AuditActor;
|
|
9
|
-
/** Storage backend for persisting audits */
|
|
10
|
-
storage: AuditStorage;
|
|
11
|
-
/** Optional metadata to attach to all audits */
|
|
12
|
-
metadata?: AuditMetadata;
|
|
13
|
-
/** Optional custom ID generator (defaults to nanoid) */
|
|
14
|
-
generateId?: () => string;
|
|
15
|
-
}
|
|
16
|
-
/**
|
|
17
|
-
* Default implementation of the Auditor interface.
|
|
18
|
-
* Collects audit records in memory and flushes to storage.
|
|
19
|
-
*
|
|
20
|
-
* @template TAuditAction - Union of all allowed audit action types
|
|
21
|
-
* @template TTransaction - Transaction type (e.g., Kysely Transaction)
|
|
22
|
-
*
|
|
23
|
-
* @example
|
|
24
|
-
* ```typescript
|
|
25
|
-
* const auditor = new DefaultAuditor<AppAuditAction>({
|
|
26
|
-
* actor: { id: 'user-123', type: 'user' },
|
|
27
|
-
* storage: auditStorage,
|
|
28
|
-
* metadata: { requestId: 'req-456', endpoint: '/users' },
|
|
29
|
-
* });
|
|
30
|
-
*
|
|
31
|
-
* auditor.audit('user.created', { userId: '789', email: 'test@example.com' });
|
|
32
|
-
*
|
|
33
|
-
* // Flush inside transaction
|
|
34
|
-
* await auditor.flush(trx);
|
|
35
|
-
* ```
|
|
36
|
-
*/
|
|
37
|
-
export declare class DefaultAuditor<TAuditAction extends AuditableAction<string, unknown> = AuditableAction<string, unknown>, TTransaction = unknown> implements Auditor<TAuditAction, TTransaction> {
|
|
38
|
-
readonly actor: AuditActor;
|
|
39
|
-
private readonly storage;
|
|
40
|
-
private metadata?;
|
|
41
|
-
private readonly generateId;
|
|
42
|
-
private records;
|
|
43
|
-
private transaction?;
|
|
44
|
-
constructor(config: DefaultAuditorConfig);
|
|
45
|
-
audit<TType extends ExtractAuditType<TAuditAction>>(type: TType, payload: ExtractAuditPayload<TAuditAction, TType>, options?: AuditOptions): void;
|
|
46
|
-
record(record: Omit<AuditRecord, 'id' | 'timestamp' | 'actor'>): void;
|
|
47
|
-
getRecords(): AuditRecord[];
|
|
48
|
-
flush(trx?: TTransaction): Promise<void>;
|
|
49
|
-
setTransaction(trx: TTransaction): void;
|
|
50
|
-
getTransaction(): TTransaction | undefined;
|
|
51
|
-
clear(): void;
|
|
52
|
-
addMetadata(metadata: AuditMetadata): void;
|
|
53
|
-
}
|
|
54
|
-
//#endregion
|
|
55
|
-
//# sourceMappingURL=DefaultAuditor.d.mts.map
|
|
1
|
+
import "./Auditor-CW2NrfHS.mjs";
|
|
2
|
+
import { DefaultAuditor, DefaultAuditorConfig } from "./DefaultAuditor-DlJ1ENfx.mjs";
|
|
3
|
+
export { DefaultAuditor, DefaultAuditorConfig };
|