@rehearsal-db/core 0.1.0-beta.13 → 0.1.0-beta.15

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 (169) hide show
  1. package/CHANGELOG.md +93 -0
  2. package/README.md +4 -1
  3. package/dist/package.json +100 -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_engine.d.mts +162 -0
  21. package/dist/src/baseline/privacy_engine.mjs +1162 -0
  22. package/dist/src/baseline/privacy_structured_json.d.mts +66 -0
  23. package/dist/src/baseline/privacy_structured_json.mjs +464 -0
  24. package/dist/src/baseline/sanitization_policy.d.mts +69 -0
  25. package/dist/src/baseline/sanitization_policy.mjs +227 -0
  26. package/dist/src/baseline/schema_snapshot.d.mts +19 -0
  27. package/dist/src/baseline/schema_snapshot.mjs +79 -0
  28. package/dist/src/cli/arguments.d.mts +43 -0
  29. package/dist/src/cli/arguments.mjs +135 -0
  30. package/dist/src/cli/guided.d.mts +51 -0
  31. package/dist/src/cli/guided.mjs +713 -0
  32. package/dist/src/cli/init_command.d.mts +21 -0
  33. package/dist/src/cli/init_command.mjs +90 -0
  34. package/dist/src/cli/project_commands.d.mts +157 -0
  35. package/dist/src/cli/project_commands.mjs +183 -0
  36. package/dist/src/cli/rehearsal.d.mts +7 -0
  37. package/dist/src/cli/rehearsal.mjs +706 -0
  38. package/dist/src/cli/renderers.d.mts +299 -0
  39. package/dist/src/cli/renderers.mjs +554 -0
  40. package/dist/src/cli/runtime_commands.d.mts +265 -0
  41. package/dist/src/cli/runtime_commands.mjs +599 -0
  42. package/dist/src/cli/source_commands.d.mts +432 -0
  43. package/dist/src/cli/source_commands.mjs +299 -0
  44. package/dist/src/cli/terminal.d.mts +59 -0
  45. package/dist/src/cli/terminal.mjs +230 -0
  46. package/dist/src/identity/claim.d.mts +144 -0
  47. package/dist/src/identity/claim.mjs +947 -0
  48. package/dist/src/identity/provider_configuration.d.mts +37 -0
  49. package/dist/src/identity/provider_configuration.mjs +132 -0
  50. package/dist/src/identity/storage.d.mts +21 -0
  51. package/dist/src/identity/storage.mjs +122 -0
  52. package/dist/src/index.d.mts +4 -0
  53. package/dist/src/index.mjs +3 -0
  54. package/dist/src/project/configuration.d.mts +181 -0
  55. package/dist/src/project/configuration.mjs +958 -0
  56. package/dist/src/project/install_scaffold.d.mts +42 -0
  57. package/dist/src/project/install_scaffold.mjs +263 -0
  58. package/dist/src/project/setup.d.mts +87 -0
  59. package/dist/src/project/setup.mjs +414 -0
  60. package/dist/src/project/support_report.d.mts +88 -0
  61. package/dist/src/project/support_report.mjs +83 -0
  62. package/dist/src/runtime/cleanup.d.mts +85 -0
  63. package/dist/src/runtime/cleanup.mjs +311 -0
  64. package/dist/src/runtime/migration_history.d.mts +51 -0
  65. package/dist/src/runtime/migration_history.mjs +170 -0
  66. package/dist/src/runtime/plan.d.mts +134 -0
  67. package/dist/src/runtime/plan.mjs +636 -0
  68. package/dist/src/runtime/policy.d.mts +66 -0
  69. package/dist/src/runtime/policy.mjs +369 -0
  70. package/dist/src/runtime/restore.d.mts +22 -0
  71. package/dist/src/runtime/restore.mjs +276 -0
  72. package/dist/src/runtime/service_environment.d.mts +11 -0
  73. package/dist/src/runtime/service_environment.mjs +58 -0
  74. package/dist/src/runtime/topology.d.mts +51 -0
  75. package/dist/src/runtime/topology.mjs +128 -0
  76. package/dist/src/shared/diagnostics.d.mts +97 -0
  77. package/dist/src/shared/diagnostics.mjs +170 -0
  78. package/dist/src/shared/human_output.d.mts +2 -0
  79. package/{src → dist/src}/shared/human_output.mjs +1 -3
  80. package/dist/src/shared/node_runtime.d.mts +14 -0
  81. package/dist/src/shared/node_runtime.mjs +25 -0
  82. package/dist/src/shared/operation_guard.d.mts +22 -0
  83. package/dist/src/shared/operation_guard.mjs +150 -0
  84. package/dist/src/shared/process_environment.d.mts +15 -0
  85. package/dist/src/shared/process_environment.mjs +50 -0
  86. package/dist/src/source/access.d.mts +165 -0
  87. package/dist/src/source/access.mjs +602 -0
  88. package/dist/src/source/asset_transfer.d.mts +27 -0
  89. package/dist/src/source/asset_transfer.mjs +202 -0
  90. package/dist/src/source/baseline.d.mts +66 -0
  91. package/dist/src/source/baseline.mjs +372 -0
  92. package/dist/src/source/external_reader.d.mts +42 -0
  93. package/dist/src/source/external_reader.mjs +278 -0
  94. package/dist/src/source/postgresql_access.d.mts +86 -0
  95. package/dist/src/source/postgresql_access.mjs +454 -0
  96. package/dist/src/source/privacy_paths.d.mts +10 -0
  97. package/dist/src/source/privacy_paths.mjs +27 -0
  98. package/dist/src/targets/driver.d.mts +2 -0
  99. package/dist/src/targets/driver.mjs +13 -0
  100. package/dist/src/targets/postgresql.d.mts +5 -0
  101. package/dist/src/targets/postgresql.mjs +641 -0
  102. package/dist/src/targets/supabase.d.mts +8 -0
  103. package/dist/src/targets/supabase.mjs +659 -0
  104. package/dist/src/targets/supabase_environment.d.mts +49 -0
  105. package/dist/src/targets/supabase_environment.mjs +162 -0
  106. package/dist/src/targets/target.d.mts +33 -0
  107. package/dist/src/targets/target.mjs +39 -0
  108. package/docs/README.md +1 -0
  109. package/docs/architecture.md +17 -9
  110. package/docs/configuration.md +49 -8
  111. package/docs/getting-started.md +28 -0
  112. package/docs/index.md +1 -0
  113. package/docs/production-source.md +43 -7
  114. package/docs/releasing.md +5 -3
  115. package/docs/roadmap.md +3 -2
  116. package/docs/sanitization.md +415 -14
  117. package/docs/standalone-workflow.md +12 -6
  118. package/docs/troubleshooting.md +5 -1
  119. package/docs/tutorial.md +5 -0
  120. package/docs/typescript.md +87 -0
  121. package/package.json +35 -29
  122. package/scripts/install/create_root_config.mjs +0 -36
  123. package/src/README.md +0 -17
  124. package/src/application/session.mjs +0 -435
  125. package/src/baseline/artifact.mjs +0 -684
  126. package/src/baseline/builder.mjs +0 -164
  127. package/src/baseline/input_discovery.mjs +0 -155
  128. package/src/baseline/policy_review.mjs +0 -92
  129. package/src/baseline/preparation.mjs +0 -323
  130. package/src/baseline/privacy_engine.mjs +0 -952
  131. package/src/baseline/sanitization_policy.mjs +0 -299
  132. package/src/baseline/schema_snapshot.mjs +0 -113
  133. package/src/cli/arguments.mjs +0 -126
  134. package/src/cli/guided.mjs +0 -814
  135. package/src/cli/init_command.mjs +0 -94
  136. package/src/cli/rehearsal.mjs +0 -970
  137. package/src/cli/renderers.mjs +0 -626
  138. package/src/cli/runtime_commands.mjs +0 -707
  139. package/src/cli/source_commands.mjs +0 -347
  140. package/src/cli/terminal.mjs +0 -275
  141. package/src/identity/claim.mjs +0 -1163
  142. package/src/identity/provider_configuration.mjs +0 -177
  143. package/src/identity/storage.mjs +0 -165
  144. package/src/project/configuration.mjs +0 -1337
  145. package/src/project/install_scaffold.mjs +0 -291
  146. package/src/project/setup.mjs +0 -466
  147. package/src/project/support_report.mjs +0 -105
  148. package/src/runtime/cleanup.mjs +0 -381
  149. package/src/runtime/migration_history.mjs +0 -220
  150. package/src/runtime/plan.mjs +0 -722
  151. package/src/runtime/policy.mjs +0 -438
  152. package/src/runtime/restore.mjs +0 -337
  153. package/src/runtime/service_environment.mjs +0 -82
  154. package/src/runtime/topology.mjs +0 -177
  155. package/src/shared/diagnostics.mjs +0 -207
  156. package/src/shared/node_runtime.mjs +0 -31
  157. package/src/shared/operation_guard.mjs +0 -162
  158. package/src/shared/process_environment.mjs +0 -68
  159. package/src/source/access.mjs +0 -753
  160. package/src/source/asset_transfer.mjs +0 -207
  161. package/src/source/baseline.mjs +0 -482
  162. package/src/source/external_reader.mjs +0 -255
  163. package/src/source/postgresql_access.mjs +0 -581
  164. package/src/source/privacy_paths.mjs +0 -38
  165. package/src/targets/postgresql.mjs +0 -808
  166. package/src/targets/supabase.mjs +0 -840
  167. package/src/targets/supabase_environment.mjs +0 -229
  168. package/src/targets/target.mjs +0 -66
  169. /package/{src/project → types}/configuration.d.mts +0 -0
@@ -1,229 +0,0 @@
1
- /**
2
- * Purpose: Start and inspect local-only Supabase workdirs without inheriting hosted
3
- * credentials. Do not run directly; this module is reusable script infrastructure.
4
- */
5
-
6
- import { spawnSync } from "node:child_process";
7
- import { createCleanProcessEnvironment } from "../shared/process_environment.mjs";
8
-
9
- export const parseSupabaseStatusEnvironment = (output) => {
10
- const values = {};
11
- for (const line of output.split("\n")) {
12
- const match = line.match(/^([A-Z][A-Z0-9_]*)=(.*)$/);
13
- if (!match) continue;
14
- let value = match[2].trim();
15
- if (value.startsWith('"') && value.endsWith('"')) value = JSON.parse(value);
16
- values[match[1]] = value;
17
- }
18
- return values;
19
- };
20
-
21
- export const parseLocalSupabaseEnvironment = (output) => {
22
- const values = parseSupabaseStatusEnvironment(output);
23
- const localEnvironment = {
24
- apiUrl: values.API_URL,
25
- databaseUrl: values.DB_URL,
26
- publishableKey: values.PUBLISHABLE_KEY ?? values.ANON_KEY,
27
- serviceRoleKey: values.SERVICE_ROLE_KEY ?? values.SECRET_KEY,
28
- studioUrl: values.STUDIO_URL,
29
- };
30
- for (const [label, value] of [
31
- ["API URL", localEnvironment.apiUrl],
32
- ["database URL", localEnvironment.databaseUrl],
33
- ["publishable key", localEnvironment.publishableKey],
34
- ["service-role key", localEnvironment.serviceRoleKey],
35
- ]) {
36
- if (!value) throw new Error(`Local Supabase status omitted its ${label}.`);
37
- }
38
- const api = new URL(localEnvironment.apiUrl);
39
- const database = new URL(localEnvironment.databaseUrl);
40
- const loopbackHosts = ["127.0.0.1", "::1", "localhost"];
41
- if (
42
- !loopbackHosts.includes(api.hostname) ||
43
- !loopbackHosts.includes(database.hostname) ||
44
- !["postgres:", "postgresql:"].includes(database.protocol)
45
- ) {
46
- throw new Error("Refusing to use a non-local Supabase status target.");
47
- }
48
- const databaseName = decodeURIComponent(
49
- database.pathname.replace(/^\//u, ""),
50
- );
51
- if (
52
- !database.port ||
53
- !databaseName ||
54
- !database.username ||
55
- !database.password
56
- ) {
57
- throw new Error(
58
- "Local Supabase status returned an incomplete database URL.",
59
- );
60
- }
61
- return {
62
- ...localEnvironment,
63
- databaseHost: database.hostname,
64
- databasePort: database.port,
65
- databaseName,
66
- databaseUser: decodeURIComponent(database.username),
67
- databasePassword: decodeURIComponent(database.password),
68
- };
69
- };
70
-
71
- export const runLocalCommand = (
72
- command,
73
- args,
74
- {
75
- capture = false,
76
- cwd = process.cwd(),
77
- input,
78
- environment = {},
79
- maxBuffer = 16 * 1024 * 1024,
80
- } = {},
81
- ) => {
82
- const shouldPipe = capture || input !== undefined;
83
- const result = spawnSync(command, args, {
84
- cwd,
85
- encoding: "utf8",
86
- env: createCleanProcessEnvironment({ overrides: environment }),
87
- input,
88
- maxBuffer,
89
- stdio: shouldPipe ? ["pipe", "pipe", "pipe"] : "inherit",
90
- });
91
- if (result.error) throw result.error;
92
- if (result.status !== 0) {
93
- const detail = [result.stdout, result.stderr]
94
- .filter(Boolean)
95
- .join("\n")
96
- .trim();
97
- throw new Error(
98
- `${command} ${args.join(" ")} failed${detail ? `:\n${detail}` : "."}`,
99
- );
100
- }
101
- return result.stdout ?? "";
102
- };
103
-
104
- export const localCommandSucceeds = (
105
- command,
106
- args,
107
- { cwd = process.cwd(), environment = {} } = {},
108
- ) =>
109
- spawnSync(command, args, {
110
- cwd,
111
- env: createCleanProcessEnvironment({ overrides: environment }),
112
- stdio: "ignore",
113
- }).status === 0;
114
-
115
- export const ensureLocalContainerRuntime = ({
116
- cwd = process.cwd(),
117
- autoStartColima = true,
118
- } = {}) => {
119
- if (localCommandSucceeds("docker", ["info"], { cwd })) return;
120
- if (autoStartColima && localCommandSucceeds("colima", ["version"], { cwd })) {
121
- runLocalCommand("colima", ["start"], { cwd });
122
- }
123
- if (!localCommandSucceeds("docker", ["info"], { cwd })) {
124
- throw new Error(
125
- "A local Docker-compatible runtime is required. Install Docker or Colima, then rerun the command.",
126
- );
127
- }
128
- };
129
-
130
- const withWorkdir = (args, workdir) =>
131
- workdir ? [...args, "--workdir", workdir] : args;
132
-
133
- export const readLocalSupabaseEnvironment = ({
134
- cwd,
135
- workdir,
136
- environment = {},
137
- } = {}) => {
138
- const output = runLocalCommand(
139
- "supabase",
140
- withWorkdir(["status", "-o", "env"], workdir),
141
- { capture: true, cwd, environment },
142
- );
143
- return parseLocalSupabaseEnvironment(output);
144
- };
145
-
146
- export const startLocalSupabase = ({
147
- cwd,
148
- workdir,
149
- exclude = [],
150
- environment = {},
151
- applyMigrations = true,
152
- autoStartColima = true,
153
- } = {}) => {
154
- ensureLocalContainerRuntime({ cwd, autoStartColima });
155
- const startArguments = withWorkdir(
156
- ["start", ...(exclude.length ? ["--exclude", exclude.join(",")] : [])],
157
- workdir,
158
- );
159
- runLocalCommand("supabase", startArguments, {
160
- capture: true,
161
- cwd,
162
- environment,
163
- });
164
- if (applyMigrations) {
165
- runLocalCommand(
166
- "supabase",
167
- withWorkdir(["migration", "up", "--local"], workdir),
168
- { capture: true, cwd, environment },
169
- );
170
- }
171
- return readLocalSupabaseEnvironment({ cwd, workdir, environment });
172
- };
173
-
174
- export const stopLocalSupabase = ({ cwd, workdir, environment = {} } = {}) => {
175
- if (!localCommandSucceeds("docker", ["info"], { cwd })) return;
176
- runLocalCommand("supabase", withWorkdir(["stop"], workdir), {
177
- cwd,
178
- environment,
179
- });
180
- };
181
-
182
- export const removeLocalSupabaseProjectResources = ({
183
- cwd = process.cwd(),
184
- projectId,
185
- } = {}) => {
186
- if (!/^[a-z0-9][a-z0-9-]{1,62}$/u.test(projectId ?? "")) {
187
- throw new Error(
188
- "Refusing to remove local Supabase resources without an exact safe project id.",
189
- );
190
- }
191
- const label = `com.supabase.cli.project=${projectId}`;
192
- const list = (resource, format) =>
193
- runLocalCommand(
194
- "docker",
195
- [resource, "ls", "--filter", `label=${label}`, "--format", format],
196
- { capture: true, cwd },
197
- )
198
- .split("\n")
199
- .map((value) => value.trim())
200
- .filter(Boolean);
201
- const containers = runLocalCommand(
202
- "docker",
203
- ["ps", "--all", "--filter", `label=${label}`, "--format", "{{.ID}}"],
204
- { capture: true, cwd },
205
- )
206
- .split("\n")
207
- .map((value) => value.trim())
208
- .filter(Boolean);
209
- if (containers.length) {
210
- runLocalCommand("docker", ["rm", "--force", ...containers], {
211
- capture: true,
212
- cwd,
213
- });
214
- }
215
- const volumes = list("volume", "{{.Name}}");
216
- if (volumes.length) {
217
- runLocalCommand("docker", ["volume", "rm", "--force", ...volumes], {
218
- capture: true,
219
- cwd,
220
- });
221
- }
222
- const networks = list("network", "{{.ID}}");
223
- if (networks.length) {
224
- runLocalCommand("docker", ["network", "rm", ...networks], {
225
- capture: true,
226
- cwd,
227
- });
228
- }
229
- };
@@ -1,66 +0,0 @@
1
- /**
2
- * Purpose: Define the small, closed set of database runtimes Rehearsal can select.
3
- * Runtime implementations stay behind this boundary so the shared CLI does not
4
- * need target-specific branches.
5
- */
6
-
7
- const TARGETS = Object.freeze({
8
- supabase: Object.freeze({
9
- id: "supabase",
10
- label: "Supabase",
11
- }),
12
- postgresql: Object.freeze({
13
- id: "postgresql",
14
- label: "PostgreSQL",
15
- }),
16
- });
17
-
18
- export const REHEARSAL_RUNTIME_TARGETS = Object.freeze(Object.keys(TARGETS));
19
-
20
- export const parseRuntimeInvocation = (arguments_ = process.argv.slice(2)) => {
21
- const action = arguments_.find((argument) => !argument.startsWith("--"));
22
- const valueAfter = (prefix) =>
23
- arguments_
24
- .find((argument) => argument.startsWith(prefix))
25
- ?.slice(prefix.length);
26
- return Object.freeze({
27
- action: action ?? "status",
28
- configPath: valueAfter("--config="),
29
- confirmation: valueAfter("--confirm-candidates="),
30
- });
31
- };
32
-
33
- export const buildRuntimeManagerArguments = ({
34
- managerPath,
35
- action,
36
- configPath,
37
- confirmation,
38
- }) => [
39
- managerPath,
40
- action,
41
- ...(configPath ? [`--config=${configPath}`] : []),
42
- ...(confirmation ? [`--confirm-candidates=${confirmation}`] : []),
43
- ];
44
-
45
- export const resolveRuntimeTarget = (value = "supabase") => {
46
- if (typeof value !== "string" || !Object.hasOwn(TARGETS, value)) {
47
- throw new Error(
48
- `Unsupported Rehearsal runtime target: ${String(value)}. Supported targets: ${REHEARSAL_RUNTIME_TARGETS.join(", ")}.`,
49
- );
50
- }
51
- return TARGETS[value];
52
- };
53
-
54
- export const runRuntimeTarget = async (target) => {
55
- const resolved = resolveRuntimeTarget(target);
56
- switch (resolved.id) {
57
- case "supabase":
58
- await import("./supabase.mjs");
59
- return;
60
- case "postgresql":
61
- await import("./postgresql.mjs");
62
- return;
63
- default:
64
- throw new Error(`No runtime driver is installed for ${resolved.id}.`);
65
- }
66
- };
File without changes