@ddd-ts-kit/audit 0.0.0-stage → 0.1.0

package/dist/chain/chain-of-tenant.js

@@ -0,0 +1,10 @@
+export const GLOBAL_CHAIN = 'global';
+/**
+ * One chain per tenant, and one `global` chain for work that names no tenant. A tenant can
+ * then be verified, exported and handed over alone, and two tenants never wait for each other
+ * to append. The price: the order of entries of different tenants is not proven by a chain.
+ */
+export function chainOfTenant(record) {
+    return record.tenantId === undefined ? GLOBAL_CHAIN : `tenant:${record.tenantId}`;
+}
+//# sourceMappingURL=chain-of-tenant.js.map

package/dist/chain/chain-of-tenant.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chain-of-tenant.js","sourceRoot":"","sources":["../../src/chain/chain-of-tenant.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,YAAY,GAAG,QAAQ,CAAC;AAErC;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,MAAmB;IAC/C,OAAO,MAAM,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,UAAU,MAAM,CAAC,QAAQ,EAAE,CAAC;AACpF,CAAC"}

package/dist/chain/empty-chain.d.ts

@@ -0,0 +1,3 @@
+import type { ChainHead } from './chain-head.js';
+export declare function emptyChain(chain: string): ChainHead;
+//# sourceMappingURL=empty-chain.d.ts.map

package/dist/chain/empty-chain.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"empty-chain.d.ts","sourceRoot":"","sources":["../../src/chain/empty-chain.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAGjD,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAEnD"}

package/dist/chain/empty-chain.js

@@ -0,0 +1,5 @@
+import { GENESIS_HASH } from './genesis-hash.js';
+export function emptyChain(chain) {
+    return { chain, sequence: 0, hash: GENESIS_HASH };
+}
+//# sourceMappingURL=empty-chain.js.map

package/dist/chain/empty-chain.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"empty-chain.js","sourceRoot":"","sources":["../../src/chain/empty-chain.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,MAAM,UAAU,UAAU,CAAC,KAAa;IACtC,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;AACpD,CAAC"}

package/dist/chain/genesis-hash.d.ts

@@ -0,0 +1,3 @@
+/** The `previousHash` of the first entry of every chain. */
+export declare const GENESIS_HASH: string;
+//# sourceMappingURL=genesis-hash.d.ts.map

package/dist/chain/genesis-hash.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"genesis-hash.d.ts","sourceRoot":"","sources":["../../src/chain/genesis-hash.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,eAAO,MAAM,YAAY,QAAiB,CAAC"}

package/dist/chain/genesis-hash.js

@@ -0,0 +1,3 @@
+/** The `previousHash` of the first entry of every chain. */
+export const GENESIS_HASH = '0'.repeat(64);
+//# sourceMappingURL=genesis-hash.js.map

package/dist/chain/genesis-hash.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"genesis-hash.js","sourceRoot":"","sources":["../../src/chain/genesis-hash.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,MAAM,CAAC,MAAM,YAAY,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC"}

package/dist/chain/hash-of.d.ts

@@ -0,0 +1,5 @@
+import type { AuditEntry } from '@ddd-ts-kit/kernel';
+export type UnsealedEntry = Omit<AuditEntry, 'hash'>;
+/** SHA-256, in lower-case hexadecimal, of the canonical form of the entry without its `hash`. */
+export declare function hashOf(entry: UnsealedEntry): string;
+//# sourceMappingURL=hash-of.d.ts.map

package/dist/chain/hash-of.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hash-of.d.ts","sourceRoot":"","sources":["../../src/chain/hash-of.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAGrD,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;AAErD,iGAAiG;AACjG,wBAAgB,MAAM,CAAC,KAAK,EAAE,aAAa,GAAG,MAAM,CAInD"}

package/dist/chain/hash-of.js

@@ -0,0 +1,8 @@
+import { createHash } from 'node:crypto';
+import { canonicalize } from './canonicalize.js';
+/** SHA-256, in lower-case hexadecimal, of the canonical form of the entry without its `hash`. */
+export function hashOf(entry) {
+    const { hash: _hash, ...content } = entry;
+    return createHash('sha256').update(canonicalize(content), 'utf8').digest('hex');
+}
+//# sourceMappingURL=hash-of.js.map

package/dist/chain/hash-of.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hash-of.js","sourceRoot":"","sources":["../../src/chain/hash-of.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAIjD,iGAAiG;AACjG,MAAM,UAAU,MAAM,CAAC,KAAoB;IACzC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,GAA+C,KAAK,CAAC;IAEtF,OAAO,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAClF,CAAC"}

package/dist/chain/head-after.d.ts

@@ -0,0 +1,4 @@
+import type { AuditEntry } from '@ddd-ts-kit/kernel';
+import type { ChainHead } from './chain-head.js';
+export declare function headAfter(entry: AuditEntry): ChainHead;
+//# sourceMappingURL=head-after.d.ts.map

package/dist/chain/head-after.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"head-after.d.ts","sourceRoot":"","sources":["../../src/chain/head-after.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAEjD,wBAAgB,SAAS,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CAEtD"}

package/dist/chain/head-after.js

@@ -0,0 +1,4 @@
+export function headAfter(entry) {
+    return { chain: entry.chain, sequence: entry.sequence, hash: entry.hash };
+}
+//# sourceMappingURL=head-after.js.map

package/dist/chain/head-after.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"head-after.js","sourceRoot":"","sources":["../../src/chain/head-after.ts"],"names":[],"mappings":"AAGA,MAAM,UAAU,SAAS,CAAC,KAAiB;IACzC,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;AAC5E,CAAC"}

package/dist/chain/seal-checkpoint.d.ts

@@ -0,0 +1,4 @@
+import type { AuditEntry } from '@ddd-ts-kit/kernel';
+import type { SealingOptions } from './sealing-options.js';
+export declare function sealCheckpoint(entry: AuditEntry, sealing: SealingOptions | undefined): Promise<void>;
+//# sourceMappingURL=seal-checkpoint.d.ts.map

package/dist/chain/seal-checkpoint.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"seal-checkpoint.d.ts","sourceRoot":"","sources":["../../src/chain/seal-checkpoint.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAE3D,wBAAsB,cAAc,CAAC,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,cAAc,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAM1G"}

package/dist/chain/seal-checkpoint.js

@@ -0,0 +1,7 @@
+export async function sealCheckpoint(entry, sealing) {
+    if (sealing === undefined || entry.sequence % sealing.every !== 0) {
+        return;
+    }
+    await sealing.onSeal({ chain: entry.chain, sequence: entry.sequence, hash: entry.hash });
+}
+//# sourceMappingURL=seal-checkpoint.js.map

package/dist/chain/seal-checkpoint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"seal-checkpoint.js","sourceRoot":"","sources":["../../src/chain/seal-checkpoint.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,KAAiB,EAAE,OAAmC;IACzF,IAAI,OAAO,KAAK,SAAS,IAAI,KAAK,CAAC,QAAQ,GAAG,OAAO,CAAC,KAAK,KAAK,CAAC,EAAE,CAAC;QAClE,OAAO;IACT,CAAC;IAED,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;AAC3F,CAAC"}

package/dist/chain/seal.d.ts

@@ -0,0 +1,5 @@
+import type { AuditEntry, AuditRecord } from '@ddd-ts-kit/kernel';
+import type { ChainHead } from './chain-head.js';
+/** The entry that follows `head`: its position, the link to the entry before it and its hash. */
+export declare function seal(record: AuditRecord, head: ChainHead): AuditEntry;
+//# sourceMappingURL=seal.d.ts.map

package/dist/chain/seal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"seal.d.ts","sourceRoot":"","sources":["../../src/chain/seal.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAClE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAGjD,iGAAiG;AACjG,wBAAgB,IAAI,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,GAAG,UAAU,CAUrE"}

package/dist/chain/seal.js

@@ -0,0 +1,13 @@
+import { hashOf } from './hash-of.js';
+/** The entry that follows `head`: its position, the link to the entry before it and its hash. */
+export function seal(record, head) {
+    const unsealed = {
+        ...record,
+        extensions: record.extensions ?? {},
+        chain: head.chain,
+        sequence: head.sequence + 1,
+        previousHash: head.hash,
+    };
+    return Object.freeze({ ...unsealed, hash: hashOf(unsealed) });
+}
+//# sourceMappingURL=seal.js.map

package/dist/chain/seal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"seal.js","sourceRoot":"","sources":["../../src/chain/seal.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAEtC,iGAAiG;AACjG,MAAM,UAAU,IAAI,CAAC,MAAmB,EAAE,IAAe;IACvD,MAAM,QAAQ,GAAG;QACf,GAAG,MAAM;QACT,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,EAAE;QACnC,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,QAAQ,EAAE,IAAI,CAAC,QAAQ,GAAG,CAAC;QAC3B,YAAY,EAAE,IAAI,CAAC,IAAI;KACxB,CAAC;IAEF,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;AAChE,CAAC"}

package/dist/chain/sealing-options.d.ts

@@ -0,0 +1,12 @@
+import type { AuditCheckpoint } from './audit-checkpoint.js';
+export interface SealingOptions {
+    /** A checkpoint is handed over each time the sequence of a chain is a multiple of it. */
+    readonly every: number;
+    /**
+     * Runs when the entry is written, inside the unit of work when there is one: appending the
+     * checkpoint to an outbox there makes it commit with the entry. A hook that calls a remote
+     * service directly may anchor an entry whose transaction rolls back afterwards.
+     */
+    onSeal(checkpoint: AuditCheckpoint): void | Promise<void>;
+}
+//# sourceMappingURL=sealing-options.d.ts.map

package/dist/chain/sealing-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sealing-options.d.ts","sourceRoot":"","sources":["../../src/chain/sealing-options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAE7D,MAAM,WAAW,cAAc;IAC7B,yFAAyF;IACzF,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,MAAM,CAAC,UAAU,EAAE,eAAe,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3D"}

package/dist/chain/sealing-options.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=sealing-options.js.map

package/dist/chain/sealing-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sealing-options.js","sourceRoot":"","sources":["../../src/chain/sealing-options.ts"],"names":[],"mappings":""}

package/dist/drizzle/audit-chains-table.d.ts

@@ -0,0 +1,61 @@
+export type AuditChainsTable = ReturnType<typeof auditChainsTable>;
+/** The head of each chain: the row an append locks. One row per chain, updated in place. */
+export declare function auditChainsTable(schemaName?: string): import("drizzle-orm/pg-core").PgTableWithColumns<{
+    name: "audit_chains";
+    schema: string | undefined;
+    columns: {
+        chain: import("drizzle-orm/pg-core").PgColumn<{
+            name: "chain";
+            tableName: "audit_chains";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: true;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        sequence: import("drizzle-orm/pg-core").PgColumn<{
+            name: "sequence";
+            tableName: "audit_chains";
+            dataType: "number";
+            columnType: "PgBigInt53";
+            data: number;
+            driverParam: string | number;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        hash: import("drizzle-orm/pg-core").PgColumn<{
+            name: "hash";
+            tableName: "audit_chains";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+    };
+    dialect: 'pg';
+}>;
+//# sourceMappingURL=audit-chains-table.d.ts.map

package/dist/drizzle/audit-chains-table.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"audit-chains-table.d.ts","sourceRoot":"","sources":["../../src/drizzle/audit-chains-table.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,gBAAgB,GAAG,UAAU,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAEnE,4FAA4F;AAC5F,wBAAgB,gBAAgB,CAAC,UAAU,CAAC,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAMnD"}

package/dist/drizzle/audit-chains-table.js

@@ -0,0 +1,12 @@
+import { bigint, text } from 'drizzle-orm/pg-core';
+import { AUDIT_CHAINS_TABLE } from '../sql/audit-chains-table-name.js';
+import { tableIn } from './table-in.js';
+/** The head of each chain: the row an append locks. One row per chain, updated in place. */
+export function auditChainsTable(schemaName) {
+    return tableIn(schemaName)(AUDIT_CHAINS_TABLE, {
+        chain: text('chain').primaryKey(),
+        sequence: bigint('sequence', { mode: 'number' }).notNull(),
+        hash: text('hash').notNull(),
+    });
+}
+//# sourceMappingURL=audit-chains-table.js.map

package/dist/drizzle/audit-chains-table.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"audit-chains-table.js","sourceRoot":"","sources":["../../src/drizzle/audit-chains-table.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AACvE,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAIxC,4FAA4F;AAC5F,MAAM,UAAU,gBAAgB,CAAC,UAAmB;IAClD,OAAO,OAAO,CAAC,UAAU,CAAC,CAAC,kBAAkB,EAAE;QAC7C,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE;QACjC,QAAQ,EAAE,MAAM,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;QAC1D,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE;KAC7B,CAAC,CAAC;AACL,CAAC"}