@rehearsal-db/core 0.1.0-beta.14 → 0.1.0-beta.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (236) hide show
  1. package/CHANGELOG.md +51 -1
  2. package/README.md +1 -0
  3. package/dist/package.json +101 -0
  4. package/dist/scripts/install/create_root_config.d.mts +3 -0
  5. package/dist/scripts/install/create_root_config.mjs +13 -0
  6. package/dist/scripts/runtime/manage_database.d.mts +6 -0
  7. package/{scripts → dist/scripts}/runtime/manage_database.mjs +6 -8
  8. package/dist/src/application/session.d.mts +96 -0
  9. package/dist/src/application/session.mjs +380 -0
  10. package/dist/src/baseline/artifact.d.mts +119 -0
  11. package/dist/src/baseline/artifact.mjs +522 -0
  12. package/dist/src/baseline/builder.d.mts +19 -0
  13. package/dist/src/baseline/builder.mjs +142 -0
  14. package/dist/src/baseline/input_discovery.d.mts +13 -0
  15. package/dist/src/baseline/input_discovery.mjs +149 -0
  16. package/dist/src/baseline/policy_review.d.mts +56 -0
  17. package/dist/src/baseline/policy_review.mjs +73 -0
  18. package/dist/src/baseline/preparation.d.mts +63 -0
  19. package/dist/src/baseline/preparation.mjs +295 -0
  20. package/dist/src/baseline/privacy_contract.d.mts +147 -0
  21. package/dist/src/baseline/privacy_contract.mjs +2 -0
  22. package/dist/src/baseline/privacy_dependency_graph.d.mts +7 -0
  23. package/dist/src/baseline/privacy_dependency_graph.mjs +110 -0
  24. package/dist/src/baseline/privacy_engine.d.mts +5 -0
  25. package/dist/src/baseline/privacy_engine.mjs +4 -0
  26. package/dist/src/baseline/privacy_key.d.mts +7 -0
  27. package/dist/src/baseline/privacy_key.mjs +42 -0
  28. package/dist/src/baseline/privacy_pipeline.d.mts +7 -0
  29. package/dist/src/baseline/privacy_pipeline.mjs +127 -0
  30. package/dist/src/baseline/privacy_policy.d.mts +6 -0
  31. package/dist/src/baseline/privacy_policy.mjs +237 -0
  32. package/dist/src/baseline/privacy_recipe_validation.d.mts +5 -0
  33. package/dist/src/baseline/privacy_recipe_validation.mjs +289 -0
  34. package/dist/src/baseline/privacy_rule_registry.d.mts +18 -0
  35. package/dist/src/baseline/privacy_rule_registry.mjs +143 -0
  36. package/dist/src/baseline/privacy_structured_json.d.mts +66 -0
  37. package/dist/src/baseline/privacy_structured_json.mjs +464 -0
  38. package/dist/src/baseline/privacy_transforms.d.mts +18 -0
  39. package/dist/src/baseline/privacy_transforms.mjs +142 -0
  40. package/dist/src/baseline/privacy_validation_shared.d.mts +31 -0
  41. package/dist/src/baseline/privacy_validation_shared.mjs +127 -0
  42. package/dist/src/baseline/sanitization_policy.d.mts +69 -0
  43. package/dist/src/baseline/sanitization_policy.mjs +227 -0
  44. package/dist/src/baseline/schema_snapshot.d.mts +19 -0
  45. package/dist/src/baseline/schema_snapshot.mjs +79 -0
  46. package/dist/src/cli/application_command_handlers.d.mts +8 -0
  47. package/dist/src/cli/application_command_handlers.mjs +52 -0
  48. package/dist/src/cli/arguments.d.mts +38 -0
  49. package/dist/src/cli/arguments.mjs +128 -0
  50. package/dist/src/cli/basic_command_handlers.d.mts +4 -0
  51. package/dist/src/cli/basic_command_handlers.mjs +56 -0
  52. package/dist/src/cli/cli_commands.d.mts +14 -0
  53. package/dist/src/cli/cli_commands.mjs +32 -0
  54. package/dist/src/cli/command_contract.d.mts +57 -0
  55. package/dist/src/cli/command_contract.mjs +39 -0
  56. package/dist/src/cli/command_output.d.mts +12 -0
  57. package/dist/src/cli/command_output.mjs +20 -0
  58. package/dist/src/cli/command_registry.d.mts +7 -0
  59. package/dist/src/cli/command_registry.mjs +14 -0
  60. package/dist/src/cli/guided.d.mts +53 -0
  61. package/dist/src/cli/guided.mjs +719 -0
  62. package/dist/src/cli/identity_command_handlers.d.mts +8 -0
  63. package/dist/src/cli/identity_command_handlers.mjs +43 -0
  64. package/dist/src/cli/init_command.d.mts +21 -0
  65. package/dist/src/cli/init_command.mjs +90 -0
  66. package/dist/src/cli/inspection_command_handlers.d.mts +3 -0
  67. package/dist/src/cli/inspection_command_handlers.mjs +79 -0
  68. package/dist/src/cli/project_command_handlers.d.mts +11 -0
  69. package/dist/src/cli/project_command_handlers.mjs +92 -0
  70. package/dist/src/cli/project_commands.d.mts +159 -0
  71. package/dist/src/cli/project_commands.mjs +183 -0
  72. package/dist/src/cli/rehearsal.d.mts +7 -0
  73. package/dist/src/cli/rehearsal.mjs +190 -0
  74. package/dist/src/cli/renderers.d.mts +299 -0
  75. package/dist/src/cli/renderers.mjs +554 -0
  76. package/dist/src/cli/runtime_action_handlers.d.mts +12 -0
  77. package/dist/src/cli/runtime_action_handlers.mjs +201 -0
  78. package/dist/src/cli/runtime_commands.d.mts +269 -0
  79. package/dist/src/cli/runtime_commands.mjs +601 -0
  80. package/dist/src/cli/source_command_handlers.d.mts +8 -0
  81. package/dist/src/cli/source_command_handlers.mjs +62 -0
  82. package/dist/src/cli/source_commands.d.mts +436 -0
  83. package/dist/src/cli/source_commands.mjs +301 -0
  84. package/dist/src/cli/terminal.d.mts +59 -0
  85. package/dist/src/cli/terminal.mjs +230 -0
  86. package/dist/src/identity/claim.d.mts +5 -0
  87. package/dist/src/identity/claim.mjs +4 -0
  88. package/dist/src/identity/claim_contract.d.mts +135 -0
  89. package/dist/src/identity/claim_contract.mjs +6 -0
  90. package/dist/src/identity/claim_executor.d.mts +10 -0
  91. package/dist/src/identity/claim_executor.mjs +358 -0
  92. package/dist/src/identity/claim_identity_lookup.d.mts +17 -0
  93. package/dist/src/identity/claim_identity_lookup.mjs +125 -0
  94. package/dist/src/identity/claim_plan.d.mts +8 -0
  95. package/dist/src/identity/claim_plan.mjs +61 -0
  96. package/dist/src/identity/claim_policy.d.mts +3 -0
  97. package/dist/src/identity/claim_policy.mjs +377 -0
  98. package/dist/src/identity/claim_sql.d.mts +10 -0
  99. package/dist/src/identity/claim_sql.mjs +46 -0
  100. package/dist/src/identity/claim_verification.d.mts +13 -0
  101. package/dist/src/identity/claim_verification.mjs +35 -0
  102. package/dist/src/identity/provider_configuration.d.mts +37 -0
  103. package/dist/src/identity/provider_configuration.mjs +132 -0
  104. package/dist/src/identity/storage.d.mts +21 -0
  105. package/dist/src/identity/storage.mjs +122 -0
  106. package/dist/src/index.d.mts +4 -0
  107. package/dist/src/index.mjs +3 -0
  108. package/dist/src/project/configuration.d.mts +13 -0
  109. package/dist/src/project/configuration.mjs +9 -0
  110. package/dist/src/project/configuration_contract.d.mts +125 -0
  111. package/dist/src/project/configuration_contract.mjs +27 -0
  112. package/dist/src/project/configuration_discovery.d.mts +7 -0
  113. package/dist/src/project/configuration_discovery.mjs +37 -0
  114. package/dist/src/project/configuration_normalization.d.mts +107 -0
  115. package/dist/src/project/configuration_normalization.mjs +302 -0
  116. package/dist/src/project/configuration_rendering.d.mts +14 -0
  117. package/dist/src/project/configuration_rendering.mjs +224 -0
  118. package/dist/src/project/configuration_resolution.d.mts +125 -0
  119. package/dist/src/project/configuration_resolution.mjs +81 -0
  120. package/dist/src/project/configuration_schema.d.mts +22 -0
  121. package/dist/src/project/configuration_schema.mjs +160 -0
  122. package/dist/src/project/configuration_validation.d.mts +22 -0
  123. package/dist/src/project/configuration_validation.mjs +136 -0
  124. package/dist/src/project/install_scaffold.d.mts +42 -0
  125. package/dist/src/project/install_scaffold.mjs +263 -0
  126. package/dist/src/project/project_detection.d.mts +14 -0
  127. package/dist/src/project/project_detection.mjs +47 -0
  128. package/dist/src/project/setup.d.mts +87 -0
  129. package/dist/src/project/setup.mjs +414 -0
  130. package/dist/src/project/support_report.d.mts +88 -0
  131. package/dist/src/project/support_report.mjs +83 -0
  132. package/dist/src/runtime/cleanup.d.mts +85 -0
  133. package/dist/src/runtime/cleanup.mjs +311 -0
  134. package/dist/src/runtime/lifecycle_engine.d.mts +63 -0
  135. package/dist/src/runtime/lifecycle_engine.mjs +114 -0
  136. package/dist/src/runtime/migration_history.d.mts +51 -0
  137. package/dist/src/runtime/migration_history.mjs +170 -0
  138. package/dist/src/runtime/plan.d.mts +134 -0
  139. package/dist/src/runtime/plan.mjs +637 -0
  140. package/dist/src/runtime/policy.d.mts +66 -0
  141. package/dist/src/runtime/policy.mjs +369 -0
  142. package/dist/src/runtime/restore.d.mts +22 -0
  143. package/dist/src/runtime/restore.mjs +276 -0
  144. package/dist/src/runtime/service_environment.d.mts +11 -0
  145. package/dist/src/runtime/service_environment.mjs +58 -0
  146. package/dist/src/runtime/topology.d.mts +51 -0
  147. package/dist/src/runtime/topology.mjs +128 -0
  148. package/dist/src/shared/diagnostics.d.mts +97 -0
  149. package/dist/src/shared/diagnostics.mjs +170 -0
  150. package/dist/src/shared/human_output.d.mts +2 -0
  151. package/{src → dist/src}/shared/human_output.mjs +1 -3
  152. package/dist/src/shared/node_runtime.d.mts +14 -0
  153. package/dist/src/shared/node_runtime.mjs +25 -0
  154. package/dist/src/shared/operation_guard.d.mts +22 -0
  155. package/dist/src/shared/operation_guard.mjs +150 -0
  156. package/dist/src/shared/process_environment.d.mts +15 -0
  157. package/dist/src/shared/process_environment.mjs +50 -0
  158. package/dist/src/source/access.d.mts +165 -0
  159. package/dist/src/source/access.mjs +602 -0
  160. package/dist/src/source/asset_transfer.d.mts +27 -0
  161. package/dist/src/source/asset_transfer.mjs +202 -0
  162. package/dist/src/source/baseline.d.mts +66 -0
  163. package/dist/src/source/baseline.mjs +372 -0
  164. package/dist/src/source/external_reader.d.mts +42 -0
  165. package/dist/src/source/external_reader.mjs +278 -0
  166. package/dist/src/source/postgresql_access.d.mts +86 -0
  167. package/dist/src/source/postgresql_access.mjs +454 -0
  168. package/dist/src/source/privacy_paths.d.mts +10 -0
  169. package/dist/src/source/privacy_paths.mjs +27 -0
  170. package/dist/src/targets/driver.d.mts +2 -0
  171. package/dist/src/targets/driver.mjs +13 -0
  172. package/dist/src/targets/postgresql.d.mts +5 -0
  173. package/dist/src/targets/postgresql.mjs +620 -0
  174. package/dist/src/targets/supabase.d.mts +8 -0
  175. package/dist/src/targets/supabase.mjs +627 -0
  176. package/dist/src/targets/supabase_environment.d.mts +49 -0
  177. package/dist/src/targets/supabase_environment.mjs +162 -0
  178. package/dist/src/targets/target.d.mts +33 -0
  179. package/dist/src/targets/target.mjs +39 -0
  180. package/docs/README.md +1 -0
  181. package/docs/architecture.md +133 -10
  182. package/docs/configuration.md +9 -3
  183. package/docs/index.md +1 -0
  184. package/docs/releasing.md +8 -3
  185. package/docs/typescript.md +134 -0
  186. package/package.json +36 -29
  187. package/types/configuration.d.mts +5 -0
  188. package/scripts/install/create_root_config.mjs +0 -19
  189. package/src/README.md +0 -17
  190. package/src/application/session.mjs +0 -435
  191. package/src/baseline/artifact.mjs +0 -684
  192. package/src/baseline/builder.mjs +0 -164
  193. package/src/baseline/input_discovery.mjs +0 -155
  194. package/src/baseline/policy_review.mjs +0 -92
  195. package/src/baseline/preparation.mjs +0 -323
  196. package/src/baseline/privacy_engine.mjs +0 -1399
  197. package/src/baseline/privacy_structured_json.mjs +0 -554
  198. package/src/baseline/sanitization_policy.mjs +0 -299
  199. package/src/baseline/schema_snapshot.mjs +0 -113
  200. package/src/cli/arguments.mjs +0 -126
  201. package/src/cli/guided.mjs +0 -814
  202. package/src/cli/init_command.mjs +0 -94
  203. package/src/cli/rehearsal.mjs +0 -972
  204. package/src/cli/renderers.mjs +0 -638
  205. package/src/cli/runtime_commands.mjs +0 -707
  206. package/src/cli/source_commands.mjs +0 -355
  207. package/src/cli/terminal.mjs +0 -275
  208. package/src/identity/claim.mjs +0 -1165
  209. package/src/identity/provider_configuration.mjs +0 -177
  210. package/src/identity/storage.mjs +0 -165
  211. package/src/project/configuration.d.mts +0 -164
  212. package/src/project/configuration.mjs +0 -1337
  213. package/src/project/install_scaffold.mjs +0 -325
  214. package/src/project/setup.mjs +0 -474
  215. package/src/project/support_report.mjs +0 -105
  216. package/src/runtime/cleanup.mjs +0 -381
  217. package/src/runtime/migration_history.mjs +0 -220
  218. package/src/runtime/plan.mjs +0 -722
  219. package/src/runtime/policy.mjs +0 -438
  220. package/src/runtime/restore.mjs +0 -337
  221. package/src/runtime/service_environment.mjs +0 -82
  222. package/src/runtime/topology.mjs +0 -177
  223. package/src/shared/diagnostics.mjs +0 -207
  224. package/src/shared/node_runtime.mjs +0 -31
  225. package/src/shared/operation_guard.mjs +0 -162
  226. package/src/shared/process_environment.mjs +0 -68
  227. package/src/source/access.mjs +0 -798
  228. package/src/source/asset_transfer.mjs +0 -259
  229. package/src/source/baseline.mjs +0 -482
  230. package/src/source/external_reader.mjs +0 -368
  231. package/src/source/postgresql_access.mjs +0 -638
  232. package/src/source/privacy_paths.mjs +0 -38
  233. package/src/targets/postgresql.mjs +0 -808
  234. package/src/targets/supabase.mjs +0 -840
  235. package/src/targets/supabase_environment.mjs +0 -229
  236. package/src/targets/target.mjs +0 -66
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Discover likely project-owned baseline inputs without exposing their values.
3
+ * Discovery is bounded, ignores generated/private directories, and only sniffs
4
+ * small JSON or NDJSON files before returning project-relative paths.
5
+ */
6
+ export interface DiscoveredBaselineInputs {
7
+ records: string[];
8
+ ledgers: string[];
9
+ assetManifests: string[];
10
+ }
11
+ export declare const discoverBaselineInputFiles: ({ projectRoot, }?: {
12
+ projectRoot?: string;
13
+ }) => Promise<DiscoveredBaselineInputs>;
@@ -0,0 +1,149 @@
1
+ /**
2
+ * Discover likely project-owned baseline inputs without exposing their values.
3
+ * Discovery is bounded, ignores generated/private directories, and only sniffs
4
+ * small JSON or NDJSON files before returning project-relative paths.
5
+ */
6
+ import { open, readFile, readdir, stat } from "node:fs/promises";
7
+ import { extname, join, relative, sep } from "node:path";
8
+ const ignoredDirectories = new Set([
9
+ ".git",
10
+ ".next",
11
+ ".rehearsal",
12
+ ".turbo",
13
+ "build",
14
+ "coverage",
15
+ "dist",
16
+ "node_modules",
17
+ ]);
18
+ const maximumDepth = 4;
19
+ const maximumFiles = 2_000;
20
+ const maximumJsonBytes = 2 * 1024 * 1024;
21
+ const maximumNdjsonProbeBytes = 64 * 1024;
22
+ const projectRelativePath = (projectRoot, path) => relative(projectRoot, path).split(sep).join("/");
23
+ const preference = {
24
+ records: [
25
+ "rehearsal/sanitized-data.ndjson",
26
+ "rehearsal/synthetic-data.ndjson",
27
+ ],
28
+ ledgers: ["rehearsal/migration-ledger.json"],
29
+ assetManifests: ["rehearsal/assets.json"],
30
+ };
31
+ const sortCandidates = (kind, candidates) => {
32
+ const preferred = new Map(preference[kind].map((path, index) => [path, index]));
33
+ return candidates.sort((left, right) => {
34
+ const leftRank = preferred.get(left) ?? Number.POSITIVE_INFINITY;
35
+ const rightRank = preferred.get(right) ?? Number.POSITIVE_INFINITY;
36
+ return leftRank - rightRank || left.localeCompare(right);
37
+ });
38
+ };
39
+ const readFirstRecord = async (path) => {
40
+ const handle = await open(path, "r");
41
+ try {
42
+ const buffer = Buffer.alloc(maximumNdjsonProbeBytes);
43
+ const { bytesRead } = await handle.read(buffer, 0, buffer.length, 0);
44
+ const probe = buffer.subarray(0, bytesRead).toString("utf8");
45
+ const lines = probe.split(/\r?\n/u);
46
+ for (const line of lines) {
47
+ if (!line.trim())
48
+ continue;
49
+ return JSON.parse(line);
50
+ }
51
+ }
52
+ finally {
53
+ await handle.close();
54
+ }
55
+ return undefined;
56
+ };
57
+ const isRecord = (value) => Boolean(value &&
58
+ typeof value === "object" &&
59
+ !Array.isArray(value) &&
60
+ "table" in value &&
61
+ typeof value.table === "string" &&
62
+ "row" in value &&
63
+ value.row &&
64
+ typeof value.row === "object" &&
65
+ !Array.isArray(value.row));
66
+ const isMigrationLedger = (value) => Array.isArray(value) &&
67
+ value.length > 0 &&
68
+ value.every((entry) => entry &&
69
+ typeof entry === "object" &&
70
+ "version" in entry &&
71
+ typeof entry.version === "string" &&
72
+ "name" in entry &&
73
+ typeof entry.name === "string" &&
74
+ "statements" in entry &&
75
+ Array.isArray(entry.statements));
76
+ const isAssetManifest = (value) => Array.isArray(value) &&
77
+ value.length > 0 &&
78
+ value.every((entry) => entry &&
79
+ typeof entry === "object" &&
80
+ "bucket" in entry &&
81
+ typeof entry.bucket === "string" &&
82
+ "objectPath" in entry &&
83
+ typeof entry.objectPath === "string" &&
84
+ "file" in entry &&
85
+ typeof entry.file === "string");
86
+ const collectCandidateFiles = async (projectRoot) => {
87
+ const files = [];
88
+ const visit = async (directory, depth) => {
89
+ if (depth > maximumDepth || files.length >= maximumFiles)
90
+ return;
91
+ const entries = await readdir(directory, { withFileTypes: true }).catch(() => []);
92
+ entries.sort((left, right) => left.name.localeCompare(right.name));
93
+ for (const entry of entries) {
94
+ if (files.length >= maximumFiles)
95
+ return;
96
+ if (entry.isSymbolicLink())
97
+ continue;
98
+ const path = join(directory, entry.name);
99
+ if (entry.isDirectory()) {
100
+ if (!ignoredDirectories.has(entry.name))
101
+ await visit(path, depth + 1);
102
+ continue;
103
+ }
104
+ if (!entry.isFile() || ![".json", ".ndjson"].includes(extname(path))) {
105
+ continue;
106
+ }
107
+ files.push(path);
108
+ }
109
+ };
110
+ await visit(projectRoot, 0);
111
+ return files;
112
+ };
113
+ export const discoverBaselineInputFiles = async ({ projectRoot = process.cwd(), } = {}) => {
114
+ const result = {
115
+ records: [],
116
+ ledgers: [],
117
+ assetManifests: [],
118
+ };
119
+ for (const path of await collectCandidateFiles(projectRoot)) {
120
+ const pathStats = await stat(path).catch(() => undefined);
121
+ if (!pathStats?.isFile())
122
+ continue;
123
+ const relativePath = projectRelativePath(projectRoot, path);
124
+ try {
125
+ if (extname(path) === ".ndjson") {
126
+ if (isRecord(await readFirstRecord(path))) {
127
+ result.records.push(relativePath);
128
+ }
129
+ continue;
130
+ }
131
+ if (pathStats.size > maximumJsonBytes)
132
+ continue;
133
+ const value = JSON.parse(await readFile(path, "utf8"));
134
+ if (isMigrationLedger(value))
135
+ result.ledgers.push(relativePath);
136
+ else if (isAssetManifest(value))
137
+ result.assetManifests.push(relativePath);
138
+ }
139
+ catch {
140
+ // Invalid or unreadable files are not candidates; explicit validation will
141
+ // provide actionable errors if the user enters one manually.
142
+ }
143
+ }
144
+ return {
145
+ records: sortCandidates("records", result.records),
146
+ ledgers: sortCandidates("ledgers", result.ledgers),
147
+ assetManifests: sortCandidates("assetManifests", result.assetManifests),
148
+ };
149
+ };
@@ -0,0 +1,56 @@
1
+ /**
2
+ * Purpose: Complete and safely apply a generated REVIEW REQUIRED policy draft.
3
+ * The caller owns the interactive presentation; this module owns validation and
4
+ * concurrent-change refusal.
5
+ */
6
+ export declare const SAFE_COLUMN_PRESET: Readonly<{
7
+ action: "REPLACE WITH SYNTHETIC";
8
+ generated: "NEVER";
9
+ identity: "NO";
10
+ foreignKey: null;
11
+ }>;
12
+ type ColumnReference = string | {
13
+ name: string;
14
+ };
15
+ type ReviewedColumn = Record<string, unknown>;
16
+ interface PolicyColumn extends Record<string, unknown> {
17
+ name: string;
18
+ }
19
+ interface PolicyTable extends Record<string, unknown> {
20
+ name: string;
21
+ columns: PolicyColumn[];
22
+ }
23
+ interface PolicyDraft extends Record<string, unknown> {
24
+ draft: true;
25
+ tables: PolicyTable[];
26
+ }
27
+ export declare const createSafeTablePreset: (columns: readonly ColumnReference[]) => {
28
+ [k: string]: {
29
+ action: "REPLACE WITH SYNTHETIC";
30
+ generated: "NEVER";
31
+ identity: "NO";
32
+ foreignKey: null;
33
+ };
34
+ };
35
+ export declare const suggestPolicyExceptionColumns: (columns: readonly ColumnReference[]) => string[];
36
+ export declare const readReviewablePolicyDraft: (path: string) => Promise<{
37
+ source: string;
38
+ draft: PolicyDraft;
39
+ }>;
40
+ export declare const completePolicyDraft: ({ draft, reviewColumn, reviewTable, }: {
41
+ draft: unknown;
42
+ reviewColumn?: (input: {
43
+ table: string;
44
+ column: string;
45
+ }) => ReviewedColumn | undefined | Promise<ReviewedColumn | undefined>;
46
+ reviewTable?: (input: {
47
+ table: string;
48
+ columns: string[];
49
+ }) => Record<string, ReviewedColumn> | undefined | Promise<Record<string, ReviewedColumn> | undefined>;
50
+ }) => Promise<unknown>;
51
+ export declare const applyReviewedPolicy: ({ path, originalSource, policy, }: {
52
+ path: string;
53
+ originalSource: string;
54
+ policy: unknown;
55
+ }) => Promise<void>;
56
+ export {};
@@ -0,0 +1,73 @@
1
+ /**
2
+ * Purpose: Complete and safely apply a generated REVIEW REQUIRED policy draft.
3
+ * The caller owns the interactive presentation; this module owns validation and
4
+ * concurrent-change refusal.
5
+ */
6
+ import { readFile, writeFile } from "node:fs/promises";
7
+ import { validateRuntimeSanitizationPolicy } from "./sanitization_policy.mjs";
8
+ export const SAFE_COLUMN_PRESET = Object.freeze({
9
+ action: "REPLACE WITH SYNTHETIC",
10
+ generated: "NEVER",
11
+ identity: "NO",
12
+ foreignKey: null,
13
+ });
14
+ const isPolicyDraft = (value) => typeof value === "object" &&
15
+ value !== null &&
16
+ "draft" in value &&
17
+ value.draft === true &&
18
+ "tables" in value &&
19
+ Array.isArray(value.tables);
20
+ export const createSafeTablePreset = (columns) => Object.fromEntries(columns.map((column) => [
21
+ typeof column === "string" ? column : column.name,
22
+ { ...SAFE_COLUMN_PRESET },
23
+ ]));
24
+ export const suggestPolicyExceptionColumns = (columns) => columns
25
+ .map((column) => (typeof column === "string" ? column : column.name))
26
+ .filter((column) => column === "id" ||
27
+ column.endsWith("_id") ||
28
+ ["created_at", "updated_at", "deleted_at"].includes(column));
29
+ export const readReviewablePolicyDraft = async (path) => {
30
+ const source = await readFile(path, "utf8");
31
+ const draft = JSON.parse(source);
32
+ if (!isPolicyDraft(draft)) {
33
+ throw new Error("Interactive review requires a generated sanitization policy with draft: true.");
34
+ }
35
+ return { source, draft };
36
+ };
37
+ export const completePolicyDraft = async ({ draft, reviewColumn, reviewTable, }) => {
38
+ if (!isPolicyDraft(draft)) {
39
+ throw new Error("A generated REVIEW REQUIRED policy draft is required.");
40
+ }
41
+ const tables = [];
42
+ for (const table of draft.tables) {
43
+ const columnNames = (table.columns ?? []).map((column) => column.name);
44
+ const tableDecisions = reviewTable
45
+ ? await reviewTable({ table: table.name, columns: columnNames })
46
+ : {};
47
+ const columns = [];
48
+ for (const column of table.columns ?? []) {
49
+ const reviewed = tableDecisions?.[column.name] ??
50
+ (await reviewColumn?.({
51
+ table: table.name,
52
+ column: column.name,
53
+ }));
54
+ if (!reviewed) {
55
+ throw new Error(`Policy review did not classify ${table.name}.${column.name}.`);
56
+ }
57
+ columns.push({ name: column.name, ...reviewed });
58
+ }
59
+ tables.push({ ...table, columns });
60
+ }
61
+ const reviewed = { ...draft, tables };
62
+ delete reviewed.draft;
63
+ return validateRuntimeSanitizationPolicy(reviewed);
64
+ };
65
+ export const applyReviewedPolicy = async ({ path, originalSource, policy, }) => {
66
+ validateRuntimeSanitizationPolicy(policy);
67
+ if ((await readFile(path, "utf8")) !== originalSource) {
68
+ throw new Error("The sanitization policy changed during review; no reviewed policy was written.");
69
+ }
70
+ await writeFile(path, `${JSON.stringify(policy, null, 2)}\n`, {
71
+ mode: 0o600,
72
+ });
73
+ };
@@ -0,0 +1,63 @@
1
+ /**
2
+ * Purpose: Inspect explicit local synthetic records and migration evidence, then
3
+ * create a fail-closed sanitization-policy draft for human review.
4
+ */
5
+ import { type MigrationLedgerEntry } from "../runtime/migration_history.mjs";
6
+ export interface SyntheticTableInspection {
7
+ readonly schema: string;
8
+ readonly name: string;
9
+ readonly rowCount: number;
10
+ readonly columns: string[];
11
+ }
12
+ interface SyntheticRecordInspection {
13
+ readonly rowCount: number;
14
+ readonly tables: SyntheticTableInspection[];
15
+ }
16
+ export interface BaselineInputInspection extends SyntheticRecordInspection {
17
+ readonly projectRoot: string;
18
+ readonly recordsPath: string;
19
+ readonly ledgerPath: string;
20
+ readonly assetsPath?: string;
21
+ readonly migrationHistory: MigrationLedgerEntry[];
22
+ readonly migrationCutoff: string;
23
+ readonly migrationCount: number;
24
+ readonly assetCount: number;
25
+ }
26
+ export interface BaselinePreparationPlan extends SyntheticRecordInspection {
27
+ readonly projectRoot: string;
28
+ readonly destination: string;
29
+ readonly destinationRelative: string;
30
+ readonly recordsPath: string;
31
+ readonly ledgerPath: string;
32
+ readonly migrationCutoff: string;
33
+ readonly migrationCount: number;
34
+ readonly content: string;
35
+ }
36
+ export declare const inspectBaselineInputFiles: ({ projectRoot, configPath, recordsPath, ledgerPath, assetsPath, }: {
37
+ projectRoot?: string;
38
+ configPath?: string;
39
+ recordsPath: string;
40
+ ledgerPath: string;
41
+ assetsPath?: string;
42
+ }) => Promise<BaselineInputInspection>;
43
+ export declare const planBaselinePreparation: ({ projectRoot, configPath, recordsPath, ledgerPath, }: {
44
+ projectRoot?: string;
45
+ configPath?: string;
46
+ recordsPath: string;
47
+ ledgerPath: string;
48
+ }) => Promise<BaselinePreparationPlan>;
49
+ export declare const applyBaselinePreparation: (plan: BaselinePreparationPlan) => Promise<void>;
50
+ export declare const summarizeBaselinePreparation: (plan: BaselinePreparationPlan, { mode }: {
51
+ mode: "preview" | "written";
52
+ }) => {
53
+ mode: "preview" | "written";
54
+ destination: string;
55
+ recordsPath: string;
56
+ ledgerPath: string;
57
+ migrationCutoff: string;
58
+ migrationCount: number;
59
+ rowCount: number;
60
+ tables: readonly SyntheticTableInspection[];
61
+ nextAction: string;
62
+ };
63
+ export {};
@@ -0,0 +1,295 @@
1
+ /**
2
+ * Purpose: Inspect explicit local synthetic records and migration evidence, then
3
+ * create a fail-closed sanitization-policy draft for human review.
4
+ */
5
+ import { createReadStream } from "node:fs";
6
+ import { access, lstat, mkdir, open, readFile } from "node:fs/promises";
7
+ import { createInterface } from "node:readline";
8
+ import { dirname, isAbsolute, relative, resolve, sep } from "node:path";
9
+ import { loadRehearsalConfig } from "../project/configuration.mjs";
10
+ import { buildMigrationLedgerInventory, } from "../runtime/migration_history.mjs";
11
+ const identifierPattern = /^[a-z][a-z0-9_]{0,62}$/u;
12
+ const storageBucketPattern = /^[a-z0-9][a-z0-9.-]{0,99}$/u;
13
+ const hasErrorCode = (error, code) => typeof error === "object" &&
14
+ error !== null &&
15
+ "code" in error &&
16
+ error.code === code;
17
+ const resolveProjectInput = (projectRoot, value, label) => {
18
+ if (typeof value !== "string" || value.trim() === "") {
19
+ throw new Error(`${label} is required.`);
20
+ }
21
+ const path = resolve(projectRoot, value);
22
+ const owned = relative(projectRoot, path);
23
+ if (owned === "" ||
24
+ owned === ".." ||
25
+ owned.startsWith(`..${sep}`) ||
26
+ isAbsolute(owned)) {
27
+ throw new Error(`${label} must be a file inside the project root.`);
28
+ }
29
+ return path;
30
+ };
31
+ const pathExists = (path) => access(path)
32
+ .then(() => true)
33
+ .catch((error) => {
34
+ if (hasErrorCode(error, "ENOENT"))
35
+ return false;
36
+ throw error;
37
+ });
38
+ const assertRegularInput = async (path, label) => {
39
+ let stats;
40
+ try {
41
+ stats = await lstat(path);
42
+ }
43
+ catch (error) {
44
+ if (hasErrorCode(error, "ENOENT"))
45
+ throw new Error(`${label} does not exist.`);
46
+ throw error;
47
+ }
48
+ if (stats.isSymbolicLink() || !stats.isFile()) {
49
+ throw new Error(`${label} must be a regular project-local file.`);
50
+ }
51
+ };
52
+ const inspectSyntheticRecords = async (path) => {
53
+ const tables = new Map();
54
+ let rowCount = 0;
55
+ const lines = createInterface({
56
+ input: createReadStream(path, { encoding: "utf8" }),
57
+ crlfDelay: Infinity,
58
+ });
59
+ for await (const line of lines) {
60
+ if (!line.trim())
61
+ continue;
62
+ let record;
63
+ try {
64
+ record = JSON.parse(line);
65
+ }
66
+ catch (error) {
67
+ throw new Error("Synthetic baseline input contains invalid NDJSON.", {
68
+ cause: error,
69
+ });
70
+ }
71
+ if (typeof record !== "object" ||
72
+ record === null ||
73
+ Array.isArray(record) ||
74
+ !("table" in record) ||
75
+ typeof record.table !== "string" ||
76
+ !("row" in record) ||
77
+ typeof record.row !== "object" ||
78
+ record.row === null ||
79
+ Array.isArray(record.row) ||
80
+ ("schema" in record &&
81
+ record.schema !== undefined &&
82
+ typeof record.schema !== "string")) {
83
+ throw new Error("A synthetic baseline record has an invalid shape.");
84
+ }
85
+ const schema = "schema" in record && typeof record.schema === "string"
86
+ ? record.schema
87
+ : "public";
88
+ if (!identifierPattern.test(schema) ||
89
+ !identifierPattern.test(record.table)) {
90
+ throw new Error("A synthetic baseline record has an invalid shape.");
91
+ }
92
+ const columns = Object.keys(record.row);
93
+ if (columns.length === 0 ||
94
+ columns.some((column) => !identifierPattern.test(column))) {
95
+ throw new Error(`Synthetic baseline table ${record.table} has invalid or empty columns.`);
96
+ }
97
+ const key = schema === "public" ? record.table : `${schema}.${record.table}`;
98
+ const table = tables.get(key) ?? {
99
+ schema,
100
+ name: record.table,
101
+ rowCount: 0,
102
+ columns: new Set(),
103
+ };
104
+ table.rowCount += 1;
105
+ for (const column of columns)
106
+ table.columns.add(column);
107
+ tables.set(key, table);
108
+ rowCount += 1;
109
+ }
110
+ if (rowCount === 0) {
111
+ throw new Error("Synthetic baseline input contains no records.");
112
+ }
113
+ return {
114
+ rowCount,
115
+ tables: [...tables.values()]
116
+ .sort((left, right) => left.name.localeCompare(right.name))
117
+ .map((table) => ({
118
+ schema: table.schema,
119
+ name: table.name,
120
+ rowCount: table.rowCount,
121
+ columns: [...table.columns].sort(),
122
+ })),
123
+ };
124
+ };
125
+ const inspectAssetManifest = async (path, projectRoot) => {
126
+ let manifest;
127
+ try {
128
+ manifest = JSON.parse(await readFile(path, "utf8"));
129
+ }
130
+ catch (error) {
131
+ throw new Error("Storage asset manifest contains invalid JSON.", {
132
+ cause: error,
133
+ });
134
+ }
135
+ if (!Array.isArray(manifest)) {
136
+ throw new Error("Storage asset manifest must be a JSON array.");
137
+ }
138
+ const destinations = new Set();
139
+ for (const [index, asset] of manifest.entries()) {
140
+ if (typeof asset !== "object" ||
141
+ asset === null ||
142
+ Array.isArray(asset) ||
143
+ !("bucket" in asset) ||
144
+ typeof asset.bucket !== "string" ||
145
+ !storageBucketPattern.test(asset.bucket) ||
146
+ !("objectPath" in asset) ||
147
+ typeof asset.objectPath !== "string" ||
148
+ !asset.objectPath ||
149
+ asset.objectPath
150
+ .split("/")
151
+ .some((segment) => !segment || segment === "." || segment === "..") ||
152
+ !("file" in asset) ||
153
+ typeof asset.file !== "string" ||
154
+ !asset.file.trim() ||
155
+ ("contentType" in asset &&
156
+ asset.contentType !== undefined &&
157
+ typeof asset.contentType !== "string")) {
158
+ throw new Error(`Storage asset manifest entry ${index + 1} has an invalid shape.`);
159
+ }
160
+ const destination = `${asset.bucket}/${asset.objectPath}`;
161
+ if (destinations.has(destination)) {
162
+ throw new Error(`Duplicate Storage asset destination: ${destination}.`);
163
+ }
164
+ destinations.add(destination);
165
+ const assetFile = resolveProjectInput(projectRoot, asset.file, `Storage asset file in entry ${index + 1}`);
166
+ await assertRegularInput(assetFile, `Storage asset file in entry ${index + 1}`);
167
+ }
168
+ return { assetCount: manifest.length };
169
+ };
170
+ export const inspectBaselineInputFiles = async ({ projectRoot = process.cwd(), configPath, recordsPath, ledgerPath, assetsPath, }) => {
171
+ const loaded = await loadRehearsalConfig({
172
+ projectRoot,
173
+ ...(configPath === undefined ? {} : { configPath }),
174
+ });
175
+ const records = resolveProjectInput(loaded.projectRoot, recordsPath, "Synthetic records path");
176
+ const ledger = resolveProjectInput(loaded.projectRoot, ledgerPath, "Migration ledger path");
177
+ const assets = assetsPath
178
+ ? resolveProjectInput(loaded.projectRoot, assetsPath, "Storage asset manifest path")
179
+ : undefined;
180
+ await Promise.all([
181
+ assertRegularInput(records, "Synthetic records path"),
182
+ assertRegularInput(ledger, "Migration ledger path"),
183
+ ...(assets
184
+ ? [assertRegularInput(assets, "Storage asset manifest path")]
185
+ : []),
186
+ ]);
187
+ let ledgerRows;
188
+ try {
189
+ ledgerRows = JSON.parse(await readFile(ledger, "utf8"));
190
+ }
191
+ catch (error) {
192
+ throw new Error("Migration ledger contains invalid JSON.", {
193
+ cause: error,
194
+ });
195
+ }
196
+ const [inspection, assetInspection] = await Promise.all([
197
+ inspectSyntheticRecords(records),
198
+ assets
199
+ ? inspectAssetManifest(assets, loaded.projectRoot)
200
+ : Promise.resolve({ assetCount: 0 }),
201
+ ]);
202
+ const migrationHistory = buildMigrationLedgerInventory(ledgerRows, "Synthetic migration ledger");
203
+ const latestMigration = migrationHistory.at(-1);
204
+ if (!latestMigration) {
205
+ throw new Error("Synthetic migration ledger is empty or unavailable.");
206
+ }
207
+ return {
208
+ projectRoot: loaded.projectRoot,
209
+ recordsPath: relative(loaded.projectRoot, records),
210
+ ledgerPath: relative(loaded.projectRoot, ledger),
211
+ ...(assets ? { assetsPath: relative(loaded.projectRoot, assets) } : {}),
212
+ migrationHistory,
213
+ migrationCutoff: latestMigration.version,
214
+ migrationCount: migrationHistory.length,
215
+ rowCount: inspection.rowCount,
216
+ tables: inspection.tables,
217
+ assetCount: assetInspection.assetCount,
218
+ };
219
+ };
220
+ const renderPolicyDraft = ({ migrationCutoff, tables, }) => `${JSON.stringify({
221
+ policyVersion: 1,
222
+ draft: true,
223
+ migrationCutoff,
224
+ tables: tables.map((table) => ({
225
+ ...(table.schema === "public" ? {} : { schema: table.schema }),
226
+ name: table.name,
227
+ group: "synthetic",
228
+ sourceRows: "STREAM AND SANITIZE",
229
+ columns: table.columns.map((name) => ({
230
+ name,
231
+ action: "REVIEW REQUIRED",
232
+ generated: "REVIEW REQUIRED",
233
+ identity: "REVIEW REQUIRED",
234
+ foreignKey: "REVIEW REQUIRED",
235
+ })),
236
+ })),
237
+ }, null, 2)}\n`;
238
+ export const planBaselinePreparation = async ({ projectRoot = process.cwd(), configPath, recordsPath, ledgerPath, }) => {
239
+ const loaded = await loadRehearsalConfig({
240
+ projectRoot,
241
+ ...(configPath === undefined ? {} : { configPath }),
242
+ });
243
+ const inspection = await inspectBaselineInputFiles({
244
+ projectRoot: loaded.projectRoot,
245
+ ...(configPath === undefined ? {} : { configPath }),
246
+ recordsPath,
247
+ ledgerPath,
248
+ });
249
+ const destination = loaded.paths.sanitizationPolicy;
250
+ if (await pathExists(destination)) {
251
+ throw new Error(`Rehearsal baseline preparation will not overwrite ${relative(loaded.projectRoot, destination)}.`);
252
+ }
253
+ return {
254
+ projectRoot: loaded.projectRoot,
255
+ destination,
256
+ destinationRelative: relative(loaded.projectRoot, destination),
257
+ recordsPath: inspection.recordsPath,
258
+ ledgerPath: inspection.ledgerPath,
259
+ migrationCutoff: inspection.migrationCutoff,
260
+ migrationCount: inspection.migrationCount,
261
+ rowCount: inspection.rowCount,
262
+ tables: inspection.tables,
263
+ content: renderPolicyDraft({
264
+ migrationCutoff: inspection.migrationCutoff,
265
+ tables: inspection.tables,
266
+ }),
267
+ };
268
+ };
269
+ export const applyBaselinePreparation = async (plan) => {
270
+ if (await pathExists(plan.destination)) {
271
+ throw new Error(`Rehearsal baseline preparation will not overwrite ${plan.destinationRelative}.`);
272
+ }
273
+ await mkdir(dirname(plan.destination), { recursive: true, mode: 0o700 });
274
+ const handle = await open(plan.destination, "wx", 0o600);
275
+ try {
276
+ await handle.writeFile(plan.content);
277
+ await handle.sync();
278
+ }
279
+ finally {
280
+ await handle.close();
281
+ }
282
+ };
283
+ export const summarizeBaselinePreparation = (plan, { mode }) => ({
284
+ mode,
285
+ destination: plan.destinationRelative,
286
+ recordsPath: plan.recordsPath,
287
+ ledgerPath: plan.ledgerPath,
288
+ migrationCutoff: plan.migrationCutoff,
289
+ migrationCount: plan.migrationCount,
290
+ rowCount: plan.rowCount,
291
+ tables: plan.tables,
292
+ nextAction: mode === "written"
293
+ ? `Review every REVIEW REQUIRED decision in ${plan.destinationRelative}, remove draft only after review, then create the baseline.`
294
+ : "Review this schema-only summary, then rerun with --write to create the draft.",
295
+ });