@forestadmin/agent 1.95.2 → 1.96.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/dist/agent.d.ts +4 -0
- package/dist/agent.js +56 -5
- package/dist/audit-trail/action-capture.d.ts +17 -0
- package/dist/audit-trail/action-capture.js +97 -0
- package/dist/audit-trail/index.d.ts +8 -0
- package/dist/audit-trail/index.js +44 -0
- package/dist/audit-trail/instrument.d.ts +12 -0
- package/dist/audit-trail/instrument.js +393 -0
- package/dist/audit-trail/migrations.d.ts +34 -0
- package/dist/audit-trail/migrations.js +213 -0
- package/dist/audit-trail/revert.d.ts +8 -0
- package/dist/audit-trail/revert.js +81 -0
- package/dist/audit-trail/scope.d.ts +20 -0
- package/dist/audit-trail/scope.js +33 -0
- package/dist/audit-trail/sql-store.d.ts +30 -0
- package/dist/audit-trail/sql-store.js +316 -0
- package/dist/audit-trail/types.d.ts +129 -0
- package/dist/audit-trail/types.js +3 -0
- package/dist/routes/access/audit-trail-correlation.d.ts +18 -0
- package/dist/routes/access/audit-trail-correlation.js +84 -0
- package/dist/routes/access/audit-trail.d.ts +23 -0
- package/dist/routes/access/audit-trail.js +293 -0
- package/dist/routes/capabilities.js +5 -1
- package/dist/routes/index.js +14 -1
- package/dist/routes/modification/action/action.d.ts +3 -0
- package/dist/routes/modification/action/action.js +106 -2
- package/dist/types.d.ts +39 -1
- package/dist/types.js +1 -1
- package/dist/utils/correlation-id.d.ts +5 -0
- package/dist/utils/correlation-id.js +26 -0
- package/dist/utils/options-validator.js +19 -1
- package/dist/utils/query-string.d.ts +3 -1
- package/dist/utils/query-string.js +5 -5
- package/package.json +4 -3
|
@@ -0,0 +1,213 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.buildUmzug = buildUmzug;
|
|
4
|
+
exports.isSchemaAlreadyExistsError = isSchemaAlreadyExistsError;
|
|
5
|
+
exports.ensureSchema = ensureSchema;
|
|
6
|
+
exports.runAuditMigrations = runAuditMigrations;
|
|
7
|
+
const sequelize_1 = require("sequelize");
|
|
8
|
+
const umzug_1 = require("umzug");
|
|
9
|
+
// Arbitrary but stable pair, only needs to be unique across the advisory locks the application
|
|
10
|
+
// takes — the audit-trail migration is the only critical section we hold this lock for.
|
|
11
|
+
const ADVISORY_LOCK = [0x464f, 0x5254];
|
|
12
|
+
// Scoped by `tableName` (not a single fixed name) so two stores configured with different table
|
|
13
|
+
// names in the same schema don't share migration state — otherwise Umzug would see the second
|
|
14
|
+
// store's migrations as already applied and never create its table.
|
|
15
|
+
function migrationsTableName(tableName) {
|
|
16
|
+
return `${tableName}_migration`;
|
|
17
|
+
}
|
|
18
|
+
// Qualifies the migration name with the schema/table it targets, so a name is self-descriptive
|
|
19
|
+
// when read directly out of the migrations table — e.g. `forest.audit_logs:001-create-audit-logs`.
|
|
20
|
+
function qualifiedMigrationName(schema, tableName) {
|
|
21
|
+
return schema
|
|
22
|
+
? `${schema}.${tableName}:001-create-audit-logs`
|
|
23
|
+
: `${tableName}:001-create-audit-logs`;
|
|
24
|
+
}
|
|
25
|
+
// Every table name claimed by an audit-trail store configured in this process, keyed by
|
|
26
|
+
// `schema\0name` — both its own data table and the migration table Umzug derives from it.
|
|
27
|
+
// A second store's data table can otherwise land on the exact name a first store's migration
|
|
28
|
+
// table derives to (e.g. `tableName: 'audit'` derives `audit_migration`, which collides with a
|
|
29
|
+
// second store's `tableName: 'audit_migration'`), silently adopting that tracking table as its
|
|
30
|
+
// own audit table and aborting startup via assertOwnsTable — confusing, since neither store's
|
|
31
|
+
// configuration is wrong in isolation. Catching it here, at store-creation time, names the actual
|
|
32
|
+
// collision instead of leaving it to that unrelated-looking failure deep inside migration 001.
|
|
33
|
+
const claimedTableNames = new Map();
|
|
34
|
+
function claimTableName(schema, name, claimedBy) {
|
|
35
|
+
const key = `${schema ?? ''}\0${name}`;
|
|
36
|
+
const existingOwner = claimedTableNames.get(key);
|
|
37
|
+
if (existingOwner !== undefined && existingOwner !== claimedBy) {
|
|
38
|
+
const target = schema ? `${schema}.${name}` : name;
|
|
39
|
+
throw new Error(`[ForestAdmin] Audit trail: "${target}" is claimed by both "tableName: ${claimedBy}" and ` +
|
|
40
|
+
`"tableName: ${existingOwner}" (as either store's own table, or the migration-tracking ` +
|
|
41
|
+
'table Umzug derives from it) — use distinct "tableName" values for each store.');
|
|
42
|
+
}
|
|
43
|
+
claimedTableNames.set(key, claimedBy);
|
|
44
|
+
}
|
|
45
|
+
async function indexNames(queryInterface, table, transaction) {
|
|
46
|
+
const indexes = (await queryInterface.showIndex(table, { transaction }));
|
|
47
|
+
return new Set(indexes.map(index => index.name));
|
|
48
|
+
}
|
|
49
|
+
async function columnNames(queryInterface, table) {
|
|
50
|
+
const columns = await queryInterface.describeTable(table);
|
|
51
|
+
return new Set(Object.keys(columns));
|
|
52
|
+
}
|
|
53
|
+
// The migration's own idempotency check (`tableExists`) only asks "is there a table with this
|
|
54
|
+
// name", not "is it ours" — so an unrelated customer table happening to share the name would be
|
|
55
|
+
// silently adopted. Verifying every column this migration creates catches that.
|
|
56
|
+
const AUDIT_LOG_COLUMNS = [
|
|
57
|
+
'id',
|
|
58
|
+
'timestamp',
|
|
59
|
+
'operation',
|
|
60
|
+
'collection',
|
|
61
|
+
'record_id',
|
|
62
|
+
'user_id',
|
|
63
|
+
'user_first_name',
|
|
64
|
+
'user_last_name',
|
|
65
|
+
'user_email',
|
|
66
|
+
'action_name',
|
|
67
|
+
'correlation_key',
|
|
68
|
+
'previous_values',
|
|
69
|
+
'new_values',
|
|
70
|
+
'status',
|
|
71
|
+
];
|
|
72
|
+
async function assertOwnsTable(queryInterface, table) {
|
|
73
|
+
const existing = await columnNames(queryInterface, table);
|
|
74
|
+
const missing = AUDIT_LOG_COLUMNS.filter(column => !existing.has(column));
|
|
75
|
+
if (missing.length > 0) {
|
|
76
|
+
const target = table.schema ? `${table.schema}.${table.tableName}` : table.tableName;
|
|
77
|
+
throw new Error(`[ForestAdmin] Audit trail: "${target}" already exists but is missing column(s) ` +
|
|
78
|
+
`${missing.join(', ')} — it does not look like a Forest audit-trail table. Point ` +
|
|
79
|
+
`auditTrail at a different table via the "tableName" option instead of reusing this one.`);
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
async function ensureIndexes(queryInterface, table, transaction) {
|
|
83
|
+
const existing = await indexNames(queryInterface, table, transaction);
|
|
84
|
+
const ensureIndex = async (fields, name) => {
|
|
85
|
+
if (existing.has(name))
|
|
86
|
+
return;
|
|
87
|
+
await queryInterface.addIndex(table, { fields, name, transaction });
|
|
88
|
+
};
|
|
89
|
+
// Length-prefixed so it stays valid on MySQL/MariaDB, which cannot index an unbounded TEXT
|
|
90
|
+
// column directly — `record_id` is TEXT (not VARCHAR) since a packed composite id can be long.
|
|
91
|
+
await ensureIndex([{ name: 'record_id', length: 191 }], `${table.tableName}_record_id`);
|
|
92
|
+
await ensureIndex(['correlation_key'], `${table.tableName}_correlation_key`);
|
|
93
|
+
await ensureIndex(['user_id'], `${table.tableName}_user_id`);
|
|
94
|
+
}
|
|
95
|
+
function buildMigrations(schema, tableName) {
|
|
96
|
+
return [
|
|
97
|
+
{
|
|
98
|
+
name: qualifiedMigrationName(schema, tableName),
|
|
99
|
+
up: async ({ context }) => {
|
|
100
|
+
const table = { tableName: context.tableName, schema: context.schema };
|
|
101
|
+
// Idempotent: lets a process that loses a concurrent-boot race retry cleanly instead of
|
|
102
|
+
// failing on a "relation already exists" error from the winner's DDL. Guards against
|
|
103
|
+
// reusing an unrelated table sharing the name, too — see assertOwnsTable.
|
|
104
|
+
if (await context.queryInterface.tableExists(table, { transaction: context.transaction })) {
|
|
105
|
+
await assertOwnsTable(context.queryInterface, table);
|
|
106
|
+
return;
|
|
107
|
+
}
|
|
108
|
+
await context.queryInterface.createTable(table, {
|
|
109
|
+
id: { type: sequelize_1.DataTypes.BIGINT, primaryKey: true, autoIncrement: true },
|
|
110
|
+
// Millisecond precision: a bare DATE truncates to whole seconds on MySQL, silently
|
|
111
|
+
// dropping the fractional part the `/state` inclusive boundary and the `id` ordering
|
|
112
|
+
// tiebreaker both rely on.
|
|
113
|
+
timestamp: { type: sequelize_1.DataTypes.DATE(3), allowNull: false },
|
|
114
|
+
operation: { type: sequelize_1.DataTypes.STRING, allowNull: false },
|
|
115
|
+
collection: { type: sequelize_1.DataTypes.STRING, allowNull: false },
|
|
116
|
+
// Nullable: a pending create's row has no id yet, since the record doesn't exist
|
|
117
|
+
// until the write resolves.
|
|
118
|
+
record_id: { type: sequelize_1.DataTypes.TEXT, allowNull: true },
|
|
119
|
+
user_id: { type: sequelize_1.DataTypes.INTEGER, allowNull: true },
|
|
120
|
+
// Denormalised from the caller at write time — who acted then, not who holds that id
|
|
121
|
+
// today.
|
|
122
|
+
user_first_name: { type: sequelize_1.DataTypes.TEXT, allowNull: true },
|
|
123
|
+
user_last_name: { type: sequelize_1.DataTypes.TEXT, allowNull: true },
|
|
124
|
+
user_email: { type: sequelize_1.DataTypes.TEXT, allowNull: true },
|
|
125
|
+
// `action` / `action_failed` rows only.
|
|
126
|
+
action_name: { type: sequelize_1.DataTypes.TEXT, allowNull: true },
|
|
127
|
+
correlation_key: { type: sequelize_1.DataTypes.STRING, allowNull: true },
|
|
128
|
+
previous_values: { type: sequelize_1.DataTypes.JSON, allowNull: false, defaultValue: {} },
|
|
129
|
+
new_values: { type: sequelize_1.DataTypes.JSON, allowNull: false, defaultValue: {} },
|
|
130
|
+
// A row is inserted `pending` before the write runs and confirmed `done` after.
|
|
131
|
+
status: { type: sequelize_1.DataTypes.STRING, allowNull: false, defaultValue: 'done' },
|
|
132
|
+
}, { transaction: context.transaction });
|
|
133
|
+
await ensureIndexes(context.queryInterface, table, context.transaction);
|
|
134
|
+
},
|
|
135
|
+
down: async ({ context }) => {
|
|
136
|
+
await context.queryInterface.dropTable({ tableName: context.tableName, schema: context.schema }, { transaction: context.transaction });
|
|
137
|
+
},
|
|
138
|
+
},
|
|
139
|
+
];
|
|
140
|
+
}
|
|
141
|
+
function buildUmzug(sequelize, options) {
|
|
142
|
+
claimTableName(options.schema, options.tableName, options.tableName);
|
|
143
|
+
claimTableName(options.schema, migrationsTableName(options.tableName), options.tableName);
|
|
144
|
+
return new umzug_1.Umzug({
|
|
145
|
+
migrations: buildMigrations(options.schema, options.tableName),
|
|
146
|
+
context: {
|
|
147
|
+
queryInterface: sequelize.getQueryInterface(),
|
|
148
|
+
schema: options.schema,
|
|
149
|
+
tableName: options.tableName,
|
|
150
|
+
transaction: options.transaction,
|
|
151
|
+
},
|
|
152
|
+
storage: new umzug_1.SequelizeStorage({
|
|
153
|
+
sequelize,
|
|
154
|
+
schema: options.schema,
|
|
155
|
+
tableName: migrationsTableName(options.tableName),
|
|
156
|
+
// Sequelize caches model definitions by name on the `Sequelize` instance: without a distinct
|
|
157
|
+
// name here, a second store sharing that instance (a different `tableName`, same connection)
|
|
158
|
+
// would reuse the first store's model and read/write the wrong migration-state table.
|
|
159
|
+
modelName: migrationsTableName(options.tableName),
|
|
160
|
+
}),
|
|
161
|
+
logger: undefined,
|
|
162
|
+
});
|
|
163
|
+
}
|
|
164
|
+
// 42P06 = duplicate_schema (Postgres ≥ 9.2), 23505 = unique_violation on pg_namespace.
|
|
165
|
+
const SCHEMA_ALREADY_EXISTS_CODES = new Set(['42P06', '23505']);
|
|
166
|
+
function isSchemaAlreadyExistsError(error) {
|
|
167
|
+
const code = error?.original?.code;
|
|
168
|
+
return code !== undefined && SCHEMA_ALREADY_EXISTS_CODES.has(code);
|
|
169
|
+
}
|
|
170
|
+
/**
|
|
171
|
+
* Idempotent CREATE SCHEMA. Must run (and commit) on its own before Umzug, because Umzug's storage
|
|
172
|
+
* opens its own connection to create the meta table and would not see a CREATE SCHEMA still
|
|
173
|
+
* pending in a transaction. Not covered by the advisory lock; the existence check + tolerated
|
|
174
|
+
* "already exists" error makes it safe under concurrent boots instead.
|
|
175
|
+
*/
|
|
176
|
+
async function ensureSchema(sequelize, schema) {
|
|
177
|
+
if (!schema)
|
|
178
|
+
return;
|
|
179
|
+
const queryInterface = sequelize.getQueryInterface();
|
|
180
|
+
const schemas = (await queryInterface.showAllSchemas());
|
|
181
|
+
if (schemas.includes(schema))
|
|
182
|
+
return;
|
|
183
|
+
try {
|
|
184
|
+
await queryInterface.createSchema(schema);
|
|
185
|
+
}
|
|
186
|
+
catch (error) {
|
|
187
|
+
if (!isSchemaAlreadyExistsError(error))
|
|
188
|
+
throw error;
|
|
189
|
+
}
|
|
190
|
+
}
|
|
191
|
+
/**
|
|
192
|
+
* Creates the schema then applies every pending audit-table migration. On Postgres the migrations
|
|
193
|
+
* run inside a transaction-scoped advisory lock, and every DDL statement runs on that same
|
|
194
|
+
* transaction, so concurrent agent boots serialize on the DDL and a failure partway through a
|
|
195
|
+
* migration rolls back cleanly instead of leaving partial DDL behind. Other dialects have no
|
|
196
|
+
* equivalent distributed lock; each migration instead checks what already exists before creating
|
|
197
|
+
* it, which closes most — but not all — of the race window on a truly simultaneous boot.
|
|
198
|
+
*/
|
|
199
|
+
async function runAuditMigrations(sequelize, options) {
|
|
200
|
+
await ensureSchema(sequelize, options.schema);
|
|
201
|
+
if (sequelize.getDialect() !== 'postgres') {
|
|
202
|
+
await buildUmzug(sequelize, options).up();
|
|
203
|
+
return;
|
|
204
|
+
}
|
|
205
|
+
await sequelize.transaction(async (transaction) => {
|
|
206
|
+
await sequelize.query('SELECT pg_advisory_xact_lock(:a, :b)', {
|
|
207
|
+
transaction,
|
|
208
|
+
replacements: { a: ADVISORY_LOCK[0], b: ADVISORY_LOCK[1] },
|
|
209
|
+
});
|
|
210
|
+
await buildUmzug(sequelize, { ...options, transaction }).up();
|
|
211
|
+
});
|
|
212
|
+
}
|
|
213
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"migrations.js","sourceRoot":"","sources":["../../src/audit-trail/migrations.ts"],"names":[],"mappings":";;AAsMA,gCA0BC;AAKD,gEAIC;AAQD,oCAgBC;AAUD,gDAoBC;AA7RD,yCAAsC;AACtC,iCAAgD;AAShD,+FAA+F;AAC/F,wFAAwF;AACxF,MAAM,aAAa,GAA8B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAElE,gGAAgG;AAChG,8FAA8F;AAC9F,oEAAoE;AACpE,SAAS,mBAAmB,CAAC,SAAiB;IAC5C,OAAO,GAAG,SAAS,YAAY,CAAC;AAClC,CAAC;AAED,+FAA+F;AAC/F,mGAAmG;AACnG,SAAS,sBAAsB,CAAC,MAA0B,EAAE,SAAiB;IAC3E,OAAO,MAAM;QACX,CAAC,CAAC,GAAG,MAAM,IAAI,SAAS,wBAAwB;QAChD,CAAC,CAAC,GAAG,SAAS,wBAAwB,CAAC;AAC3C,CAAC;AAED,wFAAwF;AACxF,0FAA0F;AAC1F,6FAA6F;AAC7F,+FAA+F;AAC/F,+FAA+F;AAC/F,8FAA8F;AAC9F,kGAAkG;AAClG,+FAA+F;AAC/F,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAAkB,CAAC;AAEpD,SAAS,cAAc,CAAC,MAA0B,EAAE,IAAY,EAAE,SAAiB;IACjF,MAAM,GAAG,GAAG,GAAG,MAAM,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;IACvC,MAAM,aAAa,GAAG,iBAAiB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAEjD,IAAI,aAAa,KAAK,SAAS,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;QAC/D,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;QAEnD,MAAM,IAAI,KAAK,CACb,+BAA+B,MAAM,oCAAoC,SAAS,QAAQ;YACxF,eAAe,aAAa,4DAA4D;YACxF,gFAAgF,CACnF,CAAC;IACJ,CAAC;IAED,iBAAiB,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;AACxC,CAAC;AAED,KAAK,UAAU,UAAU,CACvB,cAA8B,EAC9B,KAA6C,EAC7C,WAAyB;IAEzB,MAAM,OAAO,GAAG,CAAC,MAAM,cAAc,CAAC,SAAS,CAAC,KAAK,EAAE,EAAE,WAAW,EAAE,CAAC,CAErE,CAAC;IAEH,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;AACnD,CAAC;AAED,KAAK,UAAU,WAAW,CACxB,cAA8B,EAC9B,KAA6C;IAE7C,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IAE1D,OAAO,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;AACvC,CAAC;AAED,8FAA8F;AAC9F,gGAAgG;AAChG,gFAAgF;AAChF,MAAM,iBAAiB,GAAG;IACxB,IAAI;IACJ,WAAW;IACX,WAAW;IACX,YAAY;IACZ,WAAW;IACX,SAAS;IACT,iBAAiB;IACjB,gBAAgB;IAChB,YAAY;IACZ,aAAa;IACb,iBAAiB;IACjB,iBAAiB;IACjB,YAAY;IACZ,QAAQ;CACT,CAAC;AAEF,KAAK,UAAU,eAAe,CAC5B,cAA8B,EAC9B,KAA6C;IAE7C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;IAC1D,MAAM,OAAO,GAAG,iBAAiB,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IAE1E,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC;QAErF,MAAM,IAAI,KAAK,CACb,+BAA+B,MAAM,4CAA4C;YAC/E,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,6DAA6D;YAClF,yFAAyF,CAC5F,CAAC;IACJ,CAAC;AACH,CAAC;AAED,KAAK,UAAU,aAAa,CAC1B,cAA8B,EAC9B,KAA6C,EAC7C,WAAyB;IAEzB,MAAM,QAAQ,GAAG,MAAM,UAAU,CAAC,cAAc,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;IAEtE,MAAM,WAAW,GAAG,KAAK,EACvB,MAAwD,EACxD,IAAY,EACZ,EAAE;QACF,IAAI,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC;YAAE,OAAO;QAE/B,MAAM,cAAc,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;IACtE,CAAC,CAAC;IAEF,2FAA2F;IAC3F,+FAA+F;IAC/F,MAAM,WAAW,CAAC,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,KAAK,CAAC,SAAS,YAAY,CAAC,CAAC;IACxF,MAAM,WAAW,CAAC,CAAC,iBAAiB,CAAC,EAAE,GAAG,KAAK,CAAC,SAAS,kBAAkB,CAAC,CAAC;IAC7E,MAAM,WAAW,CAAC,CAAC,SAAS,CAAC,EAAE,GAAG,KAAK,CAAC,SAAS,UAAU,CAAC,CAAC;AAC/D,CAAC;AAED,SAAS,eAAe,CAAC,MAA0B,EAAE,SAAiB;IACpE,OAAO;QACL;YACE,IAAI,EAAE,sBAAsB,CAAC,MAAM,EAAE,SAAS,CAAC;YAC/C,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAiC,EAAE,EAAE;gBACvD,MAAM,KAAK,GAAG,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC;gBAEvE,wFAAwF;gBACxF,qFAAqF;gBACrF,0EAA0E;gBAC1E,IAAI,MAAM,OAAO,CAAC,cAAc,CAAC,WAAW,CAAC,KAAK,EAAE,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;oBAC1F,MAAM,eAAe,CAAC,OAAO,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;oBAErD,OAAO;gBACT,CAAC;gBAED,MAAM,OAAO,CAAC,cAAc,CAAC,WAAW,CACtC,KAAK,EACL;oBACE,EAAE,EAAE,EAAE,IAAI,EAAE,qBAAS,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE;oBACrE,mFAAmF;oBACnF,qFAAqF;oBACrF,2BAA2B;oBAC3B,SAAS,EAAE,EAAE,IAAI,EAAE,qBAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE;oBACxD,SAAS,EAAE,EAAE,IAAI,EAAE,qBAAS,CAAC,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE;oBACvD,UAAU,EAAE,EAAE,IAAI,EAAE,qBAAS,CAAC,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE;oBACxD,iFAAiF;oBACjF,4BAA4B;oBAC5B,SAAS,EAAE,EAAE,IAAI,EAAE,qBAAS,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;oBACpD,OAAO,EAAE,EAAE,IAAI,EAAE,qBAAS,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE;oBACrD,qFAAqF;oBACrF,SAAS;oBACT,eAAe,EAAE,EAAE,IAAI,EAAE,qBAAS,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;oBAC1D,cAAc,EAAE,EAAE,IAAI,EAAE,qBAAS,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;oBACzD,UAAU,EAAE,EAAE,IAAI,EAAE,qBAAS,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;oBACrD,wCAAwC;oBACxC,WAAW,EAAE,EAAE,IAAI,EAAE,qBAAS,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;oBACtD,eAAe,EAAE,EAAE,IAAI,EAAE,qBAAS,CAAC,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE;oBAC5D,eAAe,EAAE,EAAE,IAAI,EAAE,qBAAS,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,YAAY,EAAE,EAAE,EAAE;oBAC7E,UAAU,EAAE,EAAE,IAAI,EAAE,qBAAS,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,YAAY,EAAE,EAAE,EAAE;oBACxE,gFAAgF;oBAChF,MAAM,EAAE,EAAE,IAAI,EAAE,qBAAS,CAAC,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE;iBAC3E,EACD,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,CACrC,CAAC;gBAEF,MAAM,aAAa,CAAC,OAAO,CAAC,cAAc,EAAE,KAAK,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;YAC1E,CAAC;YACD,IAAI,EAAE,KAAK,EAAE,EAAE,OAAO,EAAiC,EAAE,EAAE;gBACzD,MAAM,OAAO,CAAC,cAAc,CAAC,SAAS,CACpC,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,EACxD,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,CACrC,CAAC;YACJ,CAAC;SACF;KACF,CAAC;AACJ,CAAC;AAED,SAAgB,UAAU,CACxB,SAAoB,EACpB,OAA0E;IAE1E,cAAc,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;IACrE,cAAc,CAAC,OAAO,CAAC,MAAM,EAAE,mBAAmB,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;IAE1F,OAAO,IAAI,aAAK,CAAC;QACf,UAAU,EAAE,eAAe,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,SAAS,CAAC;QAC9D,OAAO,EAAE;YACP,cAAc,EAAE,SAAS,CAAC,iBAAiB,EAAE;YAC7C,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,WAAW,EAAE,OAAO,CAAC,WAAW;SACjC;QACD,OAAO,EAAE,IAAI,wBAAgB,CAAC;YAC5B,SAAS;YACT,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,SAAS,EAAE,mBAAmB,CAAC,OAAO,CAAC,SAAS,CAAC;YACjD,6FAA6F;YAC7F,6FAA6F;YAC7F,sFAAsF;YACtF,SAAS,EAAE,mBAAmB,CAAC,OAAO,CAAC,SAAS,CAAC;SAClD,CAAC;QACF,MAAM,EAAE,SAAS;KAClB,CAAC,CAAC;AACL,CAAC;AAED,uFAAuF;AACvF,MAAM,2BAA2B,GAAG,IAAI,GAAG,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;AAEhE,SAAgB,0BAA0B,CAAC,KAAc;IACvD,MAAM,IAAI,GAAI,KAA0C,EAAE,QAAQ,EAAE,IAAI,CAAC;IAEzE,OAAO,IAAI,KAAK,SAAS,IAAI,2BAA2B,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AACrE,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,YAAY,CAChC,SAAoB,EACpB,MAA0B;IAE1B,IAAI,CAAC,MAAM;QAAE,OAAO;IAEpB,MAAM,cAAc,GAAG,SAAS,CAAC,iBAAiB,EAAE,CAAC;IACrD,MAAM,OAAO,GAAG,CAAC,MAAM,cAAc,CAAC,cAAc,EAAE,CAAwB,CAAC;IAE/E,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;QAAE,OAAO;IAErC,IAAI,CAAC;QACH,MAAM,cAAc,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAC5C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,CAAC,0BAA0B,CAAC,KAAK,CAAC;YAAE,MAAM,KAAK,CAAC;IACtD,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,kBAAkB,CACtC,SAAoB,EACpB,OAA+C;IAE/C,MAAM,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IAE9C,IAAI,SAAS,CAAC,UAAU,EAAE,KAAK,UAAU,EAAE,CAAC;QAC1C,MAAM,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,EAAE,EAAE,CAAC;QAE1C,OAAO;IACT,CAAC;IAED,MAAM,SAAS,CAAC,WAAW,CAAC,KAAK,EAAC,WAAW,EAAC,EAAE;QAC9C,MAAM,SAAS,CAAC,KAAK,CAAC,sCAAsC,EAAE;YAC5D,WAAW;YACX,YAAY,EAAE,EAAE,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,EAAE;SAC3D,CAAC,CAAC;QAEH,MAAM,UAAU,CAAC,SAAS,EAAE,EAAE,GAAG,OAAO,EAAE,WAAW,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC;IAChE,CAAC,CAAC,CAAC;AACL,CAAC"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
type AuditEntry = {
|
|
2
|
+
operation: 'create' | 'update' | 'delete';
|
|
3
|
+
previousValues: Record<string, unknown>;
|
|
4
|
+
newValues: Record<string, unknown>;
|
|
5
|
+
};
|
|
6
|
+
export default function revertRecord(current: Record<string, unknown> | null, entries: AuditEntry[]): Record<string, unknown> | null;
|
|
7
|
+
export {};
|
|
8
|
+
//# sourceMappingURL=revert.d.ts.map
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.default = revertRecord;
|
|
4
|
+
const isPlainObject = (value) => Boolean(value) && typeof value === 'object' && !Array.isArray(value) && !(value instanceof Date);
|
|
5
|
+
// Plain object on both sides ⇒ nested diff, walking the union of both sides' keys so an added key
|
|
6
|
+
// (present only in `next`) is caught too, not just a removed one. Anything else — including a key
|
|
7
|
+
// present in `next` but not `previous` at this exact level — is a leaf: `previous` is the value to
|
|
8
|
+
// write back as-is (this also covers "the whole field was replaced with something else", where
|
|
9
|
+
// `previous`/`next` at this level aren't a matching object pair at all).
|
|
10
|
+
const revertValue = (current, previous, next) => {
|
|
11
|
+
if (!isPlainObject(previous) || !isPlainObject(next))
|
|
12
|
+
return previous;
|
|
13
|
+
const keys = new Set([...Object.keys(previous), ...Object.keys(next)]);
|
|
14
|
+
if (Array.isArray(current)) {
|
|
15
|
+
const result = [...current];
|
|
16
|
+
const removedIndices = [];
|
|
17
|
+
for (const key of keys) {
|
|
18
|
+
if (!(key in previous)) {
|
|
19
|
+
// Present only in `next`: this index was appended by the change, remove it on revert.
|
|
20
|
+
removedIndices.push(Number(key));
|
|
21
|
+
}
|
|
22
|
+
else {
|
|
23
|
+
result[Number(key)] = revertValue(result[Number(key)], previous[key], next[key]);
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
// Highest index first so removing one doesn't shift the position of the next one to remove.
|
|
27
|
+
removedIndices
|
|
28
|
+
.sort((a, b) => b - a)
|
|
29
|
+
.forEach(index => {
|
|
30
|
+
result.splice(index, 1);
|
|
31
|
+
});
|
|
32
|
+
return result;
|
|
33
|
+
}
|
|
34
|
+
const base = isPlainObject(current) ? current : {};
|
|
35
|
+
const result = { ...base };
|
|
36
|
+
for (const key of keys) {
|
|
37
|
+
if (!(key in previous)) {
|
|
38
|
+
// Present only in `next`: this key was added by the change, remove it on revert.
|
|
39
|
+
delete result[key];
|
|
40
|
+
}
|
|
41
|
+
else {
|
|
42
|
+
result[key] = revertValue(result[key], previous[key], next[key]);
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
return result;
|
|
46
|
+
};
|
|
47
|
+
const revertOne = (current, entry) => {
|
|
48
|
+
const result = { ...current };
|
|
49
|
+
const columns = new Set([...Object.keys(entry.previousValues), ...Object.keys(entry.newValues)]);
|
|
50
|
+
for (const column of columns) {
|
|
51
|
+
if (!(column in entry.previousValues)) {
|
|
52
|
+
// The change added this column (e.g. a smart action wrote a new field for the first time);
|
|
53
|
+
// reverting removes it rather than writing back a bogus `null`.
|
|
54
|
+
delete result[column];
|
|
55
|
+
}
|
|
56
|
+
else {
|
|
57
|
+
result[column] = revertValue(result[column], entry.previousValues[column], entry.newValues[column]);
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
return result;
|
|
61
|
+
};
|
|
62
|
+
// `entries` must arrive newest-first. `create`/`delete` restore their terminal snapshot (`null` /
|
|
63
|
+
// `previousValues`) and walking continues into older entries, so a target timestamp that predates
|
|
64
|
+
// a delete-then-recreate (or update-then-delete) cycle still resolves to the earlier incarnation
|
|
65
|
+
// instead of stopping dead on the first terminal event encountered.
|
|
66
|
+
function revertRecord(current, entries) {
|
|
67
|
+
let state = current;
|
|
68
|
+
for (const entry of entries) {
|
|
69
|
+
if (entry.operation === 'create') {
|
|
70
|
+
state = null;
|
|
71
|
+
}
|
|
72
|
+
else if (entry.operation === 'delete') {
|
|
73
|
+
state = { ...entry.previousValues };
|
|
74
|
+
}
|
|
75
|
+
else if (state) {
|
|
76
|
+
state = revertOne(state, entry);
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
return state;
|
|
80
|
+
}
|
|
81
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmV2ZXJ0LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2F1ZGl0LXRyYWlsL3JldmVydC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQXFGQSwrQkFpQkM7QUFoR0QsTUFBTSxhQUFhLEdBQUcsQ0FBQyxLQUFjLEVBQW9DLEVBQUUsQ0FDekUsT0FBTyxDQUFDLEtBQUssQ0FBQyxJQUFJLE9BQU8sS0FBSyxLQUFLLFFBQVEsSUFBSSxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQyxDQUFDLEtBQUssWUFBWSxJQUFJLENBQUMsQ0FBQztBQUVuRyxrR0FBa0c7QUFDbEcsa0dBQWtHO0FBQ2xHLG1HQUFtRztBQUNuRywrRkFBK0Y7QUFDL0YseUVBQXlFO0FBQ3pFLE1BQU0sV0FBVyxHQUFHLENBQUMsT0FBZ0IsRUFBRSxRQUFpQixFQUFFLElBQWEsRUFBVyxFQUFFO0lBQ2xGLElBQUksQ0FBQyxhQUFhLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxhQUFhLENBQUMsSUFBSSxDQUFDO1FBQUUsT0FBTyxRQUFRLENBQUM7SUFFdEUsTUFBTSxJQUFJLEdBQUcsSUFBSSxHQUFHLENBQUMsQ0FBQyxHQUFHLE1BQU0sQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLEVBQUUsR0FBRyxNQUFNLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUV2RSxJQUFJLEtBQUssQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLEVBQUUsQ0FBQztRQUMzQixNQUFNLE1BQU0sR0FBRyxDQUFDLEdBQUcsT0FBTyxDQUFDLENBQUM7UUFDNUIsTUFBTSxjQUFjLEdBQWEsRUFBRSxDQUFDO1FBRXBDLEtBQUssTUFBTSxHQUFHLElBQUksSUFBSSxFQUFFLENBQUM7WUFDdkIsSUFBSSxDQUFDLENBQUMsR0FBRyxJQUFJLFFBQVEsQ0FBQyxFQUFFLENBQUM7Z0JBQ3ZCLHNGQUFzRjtnQkFDdEYsY0FBYyxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQztZQUNuQyxDQUFDO2lCQUFNLENBQUM7Z0JBQ04sTUFBTSxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQUMsQ0FBQyxHQUFHLFdBQVcsQ0FBQyxNQUFNLENBQUMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxDQUFDLEVBQUUsUUFBUSxDQUFDLEdBQUcsQ0FBQyxFQUFFLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDO1lBQ25GLENBQUM7UUFDSCxDQUFDO1FBRUQsNEZBQTRGO1FBQzVGLGNBQWM7YUFDWCxJQUFJLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxFQUFFLEVBQUUsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDO2FBQ3JCLE9BQU8sQ0FBQyxLQUFLLENBQUMsRUFBRTtZQUNmLE1BQU0sQ0FBQyxNQUFNLENBQUMsS0FBSyxFQUFFLENBQUMsQ0FBQyxDQUFDO1FBQzFCLENBQUMsQ0FBQyxDQUFDO1FBRUwsT0FBTyxNQUFNLENBQUM7SUFDaEIsQ0FBQztJQUVELE1BQU0sSUFBSSxHQUFHLGFBQWEsQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFDLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUM7SUFDbkQsTUFBTSxNQUFNLEdBQTRCLEVBQUUsR0FBRyxJQUFJLEVBQUUsQ0FBQztJQUVwRCxLQUFLLE1BQU0sR0FBRyxJQUFJLElBQUksRUFBRSxDQUFDO1FBQ3ZCLElBQUksQ0FBQyxDQUFDLEdBQUcsSUFBSSxRQUFRLENBQUMsRUFBRSxDQUFDO1lBQ3ZCLGlGQUFpRjtZQUNqRixPQUFPLE1BQU0sQ0FBQyxHQUFHLENBQUMsQ0FBQztRQUNyQixDQUFDO2FBQU0sQ0FBQztZQUNOLE1BQU0sQ0FBQyxHQUFHLENBQUMsR0FBRyxXQUFXLENBQUMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxFQUFFLFFBQVEsQ0FBQyxHQUFHLENBQUMsRUFBRSxJQUFJLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQztRQUNuRSxDQUFDO0lBQ0gsQ0FBQztJQUVELE9BQU8sTUFBTSxDQUFDO0FBQ2hCLENBQUMsQ0FBQztBQUVGLE1BQU0sU0FBUyxHQUFHLENBQ2hCLE9BQWdDLEVBQ2hDLEtBQWlCLEVBQ1EsRUFBRTtJQUMzQixNQUFNLE1BQU0sR0FBRyxFQUFFLEdBQUcsT0FBTyxFQUFFLENBQUM7SUFDOUIsTUFBTSxPQUFPLEdBQUcsSUFBSSxHQUFHLENBQUMsQ0FBQyxHQUFHLE1BQU0sQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLGNBQWMsQ0FBQyxFQUFFLEdBQUcsTUFBTSxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsU0FBUyxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBRWpHLEtBQUssTUFBTSxNQUFNLElBQUksT0FBTyxFQUFFLENBQUM7UUFDN0IsSUFBSSxDQUFDLENBQUMsTUFBTSxJQUFJLEtBQUssQ0FBQyxjQUFjLENBQUMsRUFBRSxDQUFDO1lBQ3RDLDJGQUEyRjtZQUMzRixnRUFBZ0U7WUFDaEUsT0FBTyxNQUFNLENBQUMsTUFBTSxDQUFDLENBQUM7UUFDeEIsQ0FBQzthQUFNLENBQUM7WUFDTixNQUFNLENBQUMsTUFBTSxDQUFDLEdBQUcsV0FBVyxDQUMxQixNQUFNLENBQUMsTUFBTSxDQUFDLEVBQ2QsS0FBSyxDQUFDLGNBQWMsQ0FBQyxNQUFNLENBQUMsRUFDNUIsS0FBSyxDQUFDLFNBQVMsQ0FBQyxNQUFNLENBQUMsQ0FDeEIsQ0FBQztRQUNKLENBQUM7SUFDSCxDQUFDO0lBRUQsT0FBTyxNQUFNLENBQUM7QUFDaEIsQ0FBQyxDQUFDO0FBRUYsa0dBQWtHO0FBQ2xHLGtHQUFrRztBQUNsRyxpR0FBaUc7QUFDakcsb0VBQW9FO0FBQ3BFLFNBQXdCLFlBQVksQ0FDbEMsT0FBdUMsRUFDdkMsT0FBcUI7SUFFckIsSUFBSSxLQUFLLEdBQUcsT0FBTyxDQUFDO0lBRXBCLEtBQUssTUFBTSxLQUFLLElBQUksT0FBTyxFQUFFLENBQUM7UUFDNUIsSUFBSSxLQUFLLENBQUMsU0FBUyxLQUFLLFFBQVEsRUFBRSxDQUFDO1lBQ2pDLEtBQUssR0FBRyxJQUFJLENBQUM7UUFDZixDQUFDO2FBQU0sSUFBSSxLQUFLLENBQUMsU0FBUyxLQUFLLFFBQVEsRUFBRSxDQUFDO1lBQ3hDLEtBQUssR0FBRyxFQUFFLEdBQUcsS0FBSyxDQUFDLGNBQWMsRUFBRSxDQUFDO1FBQ3RDLENBQUM7YUFBTSxJQUFJLEtBQUssRUFBRSxDQUFDO1lBQ2pCLEtBQUssR0FBRyxTQUFTLENBQUMsS0FBSyxFQUFFLEtBQUssQ0FBQyxDQUFDO1FBQ2xDLENBQUM7SUFDSCxDQUFDO0lBRUQsT0FBTyxLQUFLLENBQUM7QUFDZixDQUFDIn0=
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import type { ForestAdminHttpDriverServices } from '../services';
|
|
2
|
+
import type { Collection, ConditionTree } from '@forestadmin/datasource-toolkit';
|
|
3
|
+
import type { Context } from 'koa';
|
|
4
|
+
export declare function recordExists(collection: Collection, packedId: string, context: Context, scope: ConditionTree | null): Promise<boolean>;
|
|
5
|
+
export type RecordVisibility = {
|
|
6
|
+
/** False → the id still exists and fails the scope; the caller must be denied entirely (404). */
|
|
7
|
+
visible: boolean;
|
|
8
|
+
/**
|
|
9
|
+
* True once the id no longer exists at all, under any scope. `visible` is then true for a
|
|
10
|
+
* different reason than "the record matches the scope": there is nothing left to check
|
|
11
|
+
* existence against. It doesn't mean every value the audit trail holds for that record is safe
|
|
12
|
+
* to hand back to this caller — a scoped-down field value captured while the record still
|
|
13
|
+
* existed can still fall outside the caller's scope, and callers should check that separately
|
|
14
|
+
* (e.g. by re-evaluating the scope's `ConditionTree` against a delete row's `previousValues`)
|
|
15
|
+
* before deciding how much of the record's captured data to surface.
|
|
16
|
+
*/
|
|
17
|
+
goneEntirely: boolean;
|
|
18
|
+
};
|
|
19
|
+
export default function checkRecordVisibility(services: ForestAdminHttpDriverServices, collection: Collection, packedId: string, context: Context): Promise<RecordVisibility>;
|
|
20
|
+
//# sourceMappingURL=scope.d.ts.map
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.recordExists = recordExists;
|
|
7
|
+
exports.default = checkRecordVisibility;
|
|
8
|
+
const datasource_toolkit_1 = require("@forestadmin/datasource-toolkit");
|
|
9
|
+
const id_1 = __importDefault(require("../utils/id"));
|
|
10
|
+
const query_string_1 = __importDefault(require("../utils/query-string"));
|
|
11
|
+
async function recordExists(collection, packedId, context, scope) {
|
|
12
|
+
const id = id_1.default.unpackId(collection.schema, packedId);
|
|
13
|
+
const filter = new datasource_toolkit_1.PaginatedFilter({
|
|
14
|
+
conditionTree: datasource_toolkit_1.ConditionTreeFactory.intersect(datasource_toolkit_1.ConditionTreeFactory.matchIds(collection.schema, [id]), scope),
|
|
15
|
+
});
|
|
16
|
+
const records = await collection.list(query_string_1.default.parseCaller(context, { defaultTimezone: 'UTC' }), filter, new datasource_toolkit_1.Projection(...datasource_toolkit_1.SchemaUtils.getPrimaryKeys(collection.schema)));
|
|
17
|
+
return records.length > 0;
|
|
18
|
+
}
|
|
19
|
+
// A record-level scope can't be evaluated against a record that no longer exists, so a caller whose
|
|
20
|
+
// access is scoped down is only denied when the id currently exists and fails that scope — once it's
|
|
21
|
+
// genuinely gone there is nothing left to scope against, and showing that it existed (including that
|
|
22
|
+
// it was deleted, by whom and when) is much of the point of an audit trail.
|
|
23
|
+
async function checkRecordVisibility(services, collection, packedId, context) {
|
|
24
|
+
const scope = await services.authorization.getScope(collection, context);
|
|
25
|
+
if (!scope)
|
|
26
|
+
return { visible: true, goneEntirely: false };
|
|
27
|
+
if (await recordExists(collection, packedId, context, scope)) {
|
|
28
|
+
return { visible: true, goneEntirely: false };
|
|
29
|
+
}
|
|
30
|
+
const existsOutsideScope = await recordExists(collection, packedId, context, null);
|
|
31
|
+
return { visible: !existsOutsideScope, goneEntirely: !existsOutsideScope };
|
|
32
|
+
}
|
|
33
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2NvcGUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvYXVkaXQtdHJhaWwvc2NvcGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFjQSxvQ0FxQkM7QUFxQkQsd0NBaUJDO0FBckVELHdFQUt5QztBQUV6QyxxREFBa0M7QUFDbEMseUVBQXNEO0FBRS9DLEtBQUssVUFBVSxZQUFZLENBQ2hDLFVBQXNCLEVBQ3RCLFFBQWdCLEVBQ2hCLE9BQWdCLEVBQ2hCLEtBQTJCO0lBRTNCLE1BQU0sRUFBRSxHQUFHLFlBQU8sQ0FBQyxRQUFRLENBQUMsVUFBVSxDQUFDLE1BQU0sRUFBRSxRQUFRLENBQUMsQ0FBQztJQUN6RCxNQUFNLE1BQU0sR0FBRyxJQUFJLG9DQUFlLENBQUM7UUFDakMsYUFBYSxFQUFFLHlDQUFvQixDQUFDLFNBQVMsQ0FDM0MseUNBQW9CLENBQUMsUUFBUSxDQUFDLFVBQVUsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxFQUFFLENBQUMsQ0FBQyxFQUN0RCxLQUFLLENBQ047S0FDRixDQUFDLENBQUM7SUFFSCxNQUFNLE9BQU8sR0FBRyxNQUFNLFVBQVUsQ0FBQyxJQUFJLENBQ25DLHNCQUFpQixDQUFDLFdBQVcsQ0FBQyxPQUFPLEVBQUUsRUFBRSxlQUFlLEVBQUUsS0FBSyxFQUFFLENBQUMsRUFDbEUsTUFBTSxFQUNOLElBQUksK0JBQVUsQ0FBQyxHQUFHLGdDQUFXLENBQUMsY0FBYyxDQUFDLFVBQVUsQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUNqRSxDQUFDO0lBRUYsT0FBTyxPQUFPLENBQUMsTUFBTSxHQUFHLENBQUMsQ0FBQztBQUM1QixDQUFDO0FBaUJELG9HQUFvRztBQUNwRyxxR0FBcUc7QUFDckcscUdBQXFHO0FBQ3JHLDRFQUE0RTtBQUM3RCxLQUFLLFVBQVUscUJBQXFCLENBQ2pELFFBQXVDLEVBQ3ZDLFVBQXNCLEVBQ3RCLFFBQWdCLEVBQ2hCLE9BQWdCO0lBRWhCLE1BQU0sS0FBSyxHQUFHLE1BQU0sUUFBUSxDQUFDLGFBQWEsQ0FBQyxRQUFRLENBQUMsVUFBVSxFQUFFLE9BQU8sQ0FBQyxDQUFDO0lBRXpFLElBQUksQ0FBQyxLQUFLO1FBQUUsT0FBTyxFQUFFLE9BQU8sRUFBRSxJQUFJLEVBQUUsWUFBWSxFQUFFLEtBQUssRUFBRSxDQUFDO0lBRTFELElBQUksTUFBTSxZQUFZLENBQUMsVUFBVSxFQUFFLFFBQVEsRUFBRSxPQUFPLEVBQUUsS0FBSyxDQUFDLEVBQUUsQ0FBQztRQUM3RCxPQUFPLEVBQUUsT0FBTyxFQUFFLElBQUksRUFBRSxZQUFZLEVBQUUsS0FBSyxFQUFFLENBQUM7SUFDaEQsQ0FBQztJQUVELE1BQU0sa0JBQWtCLEdBQUcsTUFBTSxZQUFZLENBQUMsVUFBVSxFQUFFLFFBQVEsRUFBRSxPQUFPLEVBQUUsSUFBSSxDQUFDLENBQUM7SUFFbkYsT0FBTyxFQUFFLE9BQU8sRUFBRSxDQUFDLGtCQUFrQixFQUFFLFlBQVksRUFBRSxDQUFDLGtCQUFrQixFQUFFLENBQUM7QUFDN0UsQ0FBQyJ9
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import type { AuditRecord, AuditStatus, AuditStorageOptions, AuditStore, PendingAuditRecord } from './types';
|
|
2
|
+
import type { Model, ModelStatic } from 'sequelize';
|
|
3
|
+
import { Sequelize } from 'sequelize';
|
|
4
|
+
export declare const DEFAULT_SCHEMA = "forest";
|
|
5
|
+
export declare const DEFAULT_TABLE = "audit_logs";
|
|
6
|
+
export declare function defineAuditLogModel(sequelize: Sequelize, options: {
|
|
7
|
+
schema?: string;
|
|
8
|
+
tableName: string;
|
|
9
|
+
}): ModelStatic<Model>;
|
|
10
|
+
export declare function ensureAuditStorage(sequelize: Sequelize, options: {
|
|
11
|
+
schema?: string;
|
|
12
|
+
tableName: string;
|
|
13
|
+
}): Promise<ModelStatic<Model>>;
|
|
14
|
+
export declare function toRow(record: PendingAuditRecord & {
|
|
15
|
+
status: AuditStatus;
|
|
16
|
+
}): Record<string, unknown>;
|
|
17
|
+
export declare function fieldsChangedCondition(sequelize: Sequelize, fields: string[]): import("sequelize/types/utils").Literal;
|
|
18
|
+
export declare function searchCondition(sequelize: Sequelize, term: string): import("sequelize/types/utils").Literal;
|
|
19
|
+
export declare function fromRow(row: Model): AuditRecord;
|
|
20
|
+
/**
|
|
21
|
+
* Returns a SQL-backed audit store. Construction is synchronous so the store can be passed to
|
|
22
|
+
* `createAgent` at module top level; the connection (and pending migrations) only run when
|
|
23
|
+
* `store.init()` is awaited during `agent.start()`. The store also self-initializes on the first
|
|
24
|
+
* append or read so tests and manual scripts work without an explicit init.
|
|
25
|
+
*/
|
|
26
|
+
export declare function createSqlAuditStore(options: AuditStorageOptions): {
|
|
27
|
+
store: AuditStore;
|
|
28
|
+
close: () => Promise<void>;
|
|
29
|
+
};
|
|
30
|
+
//# sourceMappingURL=sql-store.d.ts.map
|