@marinoscar/platform-db 0.0.0-stage → 0.1.0-next.4

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 (244) hide show
  1. package/CHANGELOG.md +74 -0
  2. package/LICENSE +21 -0
  3. package/README.md +525 -2
  4. package/bin/platform.js +28 -0
  5. package/dist/baseline/deps.d.ts +32 -0
  6. package/dist/baseline/deps.d.ts.map +1 -0
  7. package/dist/baseline/deps.js +66 -0
  8. package/dist/baseline/deps.js.map +1 -0
  9. package/dist/baseline/errors.d.ts +36 -0
  10. package/dist/baseline/errors.d.ts.map +1 -0
  11. package/dist/baseline/errors.js +23 -0
  12. package/dist/baseline/errors.js.map +1 -0
  13. package/dist/baseline/fs.d.ts +9 -0
  14. package/dist/baseline/fs.d.ts.map +1 -0
  15. package/dist/baseline/fs.js +39 -0
  16. package/dist/baseline/fs.js.map +1 -0
  17. package/dist/baseline/index.d.ts +8 -0
  18. package/dist/baseline/index.d.ts.map +1 -0
  19. package/dist/baseline/index.js +24 -0
  20. package/dist/baseline/index.js.map +1 -0
  21. package/dist/baseline/mapping.d.ts +43 -0
  22. package/dist/baseline/mapping.d.ts.map +1 -0
  23. package/dist/baseline/mapping.js +80 -0
  24. package/dist/baseline/mapping.js.map +1 -0
  25. package/dist/baseline/normalise.d.ts +42 -0
  26. package/dist/baseline/normalise.d.ts.map +1 -0
  27. package/dist/baseline/normalise.js +133 -0
  28. package/dist/baseline/normalise.js.map +1 -0
  29. package/dist/baseline/plan.d.ts +66 -0
  30. package/dist/baseline/plan.d.ts.map +1 -0
  31. package/dist/baseline/plan.js +105 -0
  32. package/dist/baseline/plan.js.map +1 -0
  33. package/dist/baseline/report.d.ts +127 -0
  34. package/dist/baseline/report.d.ts.map +1 -0
  35. package/dist/baseline/report.js +89 -0
  36. package/dist/baseline/report.js.map +1 -0
  37. package/dist/baseline/run.d.ts +117 -0
  38. package/dist/baseline/run.d.ts.map +1 -0
  39. package/dist/baseline/run.js +358 -0
  40. package/dist/baseline/run.js.map +1 -0
  41. package/dist/bin/db-commands.d.ts +31 -0
  42. package/dist/bin/db-commands.d.ts.map +1 -0
  43. package/dist/bin/db-commands.js +311 -0
  44. package/dist/bin/db-commands.js.map +1 -0
  45. package/dist/bin/fs-io.d.ts +7 -0
  46. package/dist/bin/fs-io.d.ts.map +1 -0
  47. package/dist/bin/fs-io.js +45 -0
  48. package/dist/bin/fs-io.js.map +1 -0
  49. package/dist/bin/platform.d.ts +21 -0
  50. package/dist/bin/platform.d.ts.map +1 -0
  51. package/dist/bin/platform.js +99 -0
  52. package/dist/bin/platform.js.map +1 -0
  53. package/dist/compose/api.d.ts +84 -0
  54. package/dist/compose/api.d.ts.map +1 -0
  55. package/dist/compose/api.js +101 -0
  56. package/dist/compose/api.js.map +1 -0
  57. package/dist/compose/compose.d.ts +51 -0
  58. package/dist/compose/compose.d.ts.map +1 -0
  59. package/dist/compose/compose.js +177 -0
  60. package/dist/compose/compose.js.map +1 -0
  61. package/dist/compose/diff.d.ts +7 -0
  62. package/dist/compose/diff.d.ts.map +1 -0
  63. package/dist/compose/diff.js +68 -0
  64. package/dist/compose/diff.js.map +1 -0
  65. package/dist/compose/errors.d.ts +31 -0
  66. package/dist/compose/errors.d.ts.map +1 -0
  67. package/dist/compose/errors.js +35 -0
  68. package/dist/compose/errors.js.map +1 -0
  69. package/dist/compose/index.d.ts +3 -0
  70. package/dist/compose/index.d.ts.map +1 -0
  71. package/dist/compose/index.js +11 -0
  72. package/dist/compose/index.js.map +1 -0
  73. package/dist/compose/parse.d.ts +65 -0
  74. package/dist/compose/parse.d.ts.map +1 -0
  75. package/dist/compose/parse.js +122 -0
  76. package/dist/compose/parse.js.map +1 -0
  77. package/dist/drift/app-objects.d.ts +107 -0
  78. package/dist/drift/app-objects.d.ts.map +1 -0
  79. package/dist/drift/app-objects.js +193 -0
  80. package/dist/drift/app-objects.js.map +1 -0
  81. package/dist/drift/db-conformance.d.ts +52 -0
  82. package/dist/drift/db-conformance.d.ts.map +1 -0
  83. package/dist/drift/db-conformance.js +89 -0
  84. package/dist/drift/db-conformance.js.map +1 -0
  85. package/dist/drift/index.d.ts +8 -0
  86. package/dist/drift/index.d.ts.map +1 -0
  87. package/dist/drift/index.js +43 -0
  88. package/dist/drift/index.js.map +1 -0
  89. package/dist/drift/raw-sql-indexes.d.ts +106 -0
  90. package/dist/drift/raw-sql-indexes.d.ts.map +1 -0
  91. package/dist/drift/raw-sql-indexes.js +113 -0
  92. package/dist/drift/raw-sql-indexes.js.map +1 -0
  93. package/dist/drift/raw-sql-tripwire.d.ts +191 -0
  94. package/dist/drift/raw-sql-tripwire.d.ts.map +1 -0
  95. package/dist/drift/raw-sql-tripwire.js +422 -0
  96. package/dist/drift/raw-sql-tripwire.js.map +1 -0
  97. package/dist/drift/rls-policies.d.ts +226 -0
  98. package/dist/drift/rls-policies.d.ts.map +1 -0
  99. package/dist/drift/rls-policies.js +317 -0
  100. package/dist/drift/rls-policies.js.map +1 -0
  101. package/dist/drift/run.d.ts +152 -0
  102. package/dist/drift/run.d.ts.map +1 -0
  103. package/dist/drift/run.js +252 -0
  104. package/dist/drift/run.js.map +1 -0
  105. package/dist/drift/sql-expression.d.ts +27 -0
  106. package/dist/drift/sql-expression.d.ts.map +1 -0
  107. package/dist/drift/sql-expression.js +64 -0
  108. package/dist/drift/sql-expression.js.map +1 -0
  109. package/dist/index.d.ts +16 -0
  110. package/dist/index.d.ts.map +1 -0
  111. package/dist/index.js +33 -0
  112. package/dist/index.js.map +1 -0
  113. package/dist/lock/hash.d.ts +13 -0
  114. package/dist/lock/hash.d.ts.map +1 -0
  115. package/dist/lock/hash.js +19 -0
  116. package/dist/lock/hash.js.map +1 -0
  117. package/dist/lock/index.d.ts +5 -0
  118. package/dist/lock/index.d.ts.map +1 -0
  119. package/dist/lock/index.js +20 -0
  120. package/dist/lock/index.js.map +1 -0
  121. package/dist/lock/lock.d.ts +154 -0
  122. package/dist/lock/lock.d.ts.map +1 -0
  123. package/dist/lock/lock.js +151 -0
  124. package/dist/lock/lock.js.map +1 -0
  125. package/dist/lock/manifest.d.ts +68 -0
  126. package/dist/lock/manifest.d.ts.map +1 -0
  127. package/dist/lock/manifest.js +96 -0
  128. package/dist/lock/manifest.js.map +1 -0
  129. package/dist/lock/semver.d.ts +10 -0
  130. package/dist/lock/semver.d.ts.map +1 -0
  131. package/dist/lock/semver.js +13 -0
  132. package/dist/lock/semver.js.map +1 -0
  133. package/dist/seed/index.d.ts +5 -0
  134. package/dist/seed/index.d.ts.map +1 -0
  135. package/dist/seed/index.js +16 -0
  136. package/dist/seed/index.js.map +1 -0
  137. package/dist/seed/input.d.ts +52 -0
  138. package/dist/seed/input.d.ts.map +1 -0
  139. package/dist/seed/input.js +77 -0
  140. package/dist/seed/input.js.map +1 -0
  141. package/dist/seed/seed-platform.d.ts +41 -0
  142. package/dist/seed/seed-platform.d.ts.map +1 -0
  143. package/dist/seed/seed-platform.js +165 -0
  144. package/dist/seed/seed-platform.js.map +1 -0
  145. package/dist/seed/steps.d.ts +172 -0
  146. package/dist/seed/steps.d.ts.map +1 -0
  147. package/dist/seed/steps.js +136 -0
  148. package/dist/seed/steps.js.map +1 -0
  149. package/dist/seed/types.d.ts +287 -0
  150. package/dist/seed/types.d.ts.map +1 -0
  151. package/dist/seed/types.js +5 -0
  152. package/dist/seed/types.js.map +1 -0
  153. package/dist/sync/app-migrations.d.ts +52 -0
  154. package/dist/sync/app-migrations.d.ts.map +1 -0
  155. package/dist/sync/app-migrations.js +62 -0
  156. package/dist/sync/app-migrations.js.map +1 -0
  157. package/dist/sync/apply.d.ts +29 -0
  158. package/dist/sync/apply.d.ts.map +1 -0
  159. package/dist/sync/apply.js +38 -0
  160. package/dist/sync/apply.js.map +1 -0
  161. package/dist/sync/check.d.ts +59 -0
  162. package/dist/sync/check.d.ts.map +1 -0
  163. package/dist/sync/check.js +115 -0
  164. package/dist/sync/check.js.map +1 -0
  165. package/dist/sync/errors.d.ts +32 -0
  166. package/dist/sync/errors.d.ts.map +1 -0
  167. package/dist/sync/errors.js +23 -0
  168. package/dist/sync/errors.js.map +1 -0
  169. package/dist/sync/index.d.ts +10 -0
  170. package/dist/sync/index.d.ts.map +1 -0
  171. package/dist/sync/index.js +27 -0
  172. package/dist/sync/index.js.map +1 -0
  173. package/dist/sync/ledger.d.ts +65 -0
  174. package/dist/sync/ledger.d.ts.map +1 -0
  175. package/dist/sync/ledger.js +49 -0
  176. package/dist/sync/ledger.js.map +1 -0
  177. package/dist/sync/plan.d.ts +63 -0
  178. package/dist/sync/plan.d.ts.map +1 -0
  179. package/dist/sync/plan.js +86 -0
  180. package/dist/sync/plan.js.map +1 -0
  181. package/dist/sync/promote.d.ts +62 -0
  182. package/dist/sync/promote.d.ts.map +1 -0
  183. package/dist/sync/promote.js +95 -0
  184. package/dist/sync/promote.js.map +1 -0
  185. package/dist/sync/timestamps.d.ts +41 -0
  186. package/dist/sync/timestamps.d.ts.map +1 -0
  187. package/dist/sync/timestamps.js +68 -0
  188. package/dist/sync/timestamps.js.map +1 -0
  189. package/dist/sync/version.d.ts +28 -0
  190. package/dist/sync/version.d.ts.map +1 -0
  191. package/dist/sync/version.js +66 -0
  192. package/dist/sync/version.js.map +1 -0
  193. package/migrations/0001_initial/migration.sql +297 -0
  194. package/migrations/0002_add_personal_access_tokens/migration.sql +31 -0
  195. package/migrations/0003_add_credentials/migration.sql +20 -0
  196. package/migrations/0004_add_notification_deliveries/migration.sql +27 -0
  197. package/migrations/0005_drop_stale_uuid_defaults/migration.sql +35 -0
  198. package/migrations/0006_add_notifications/migration.sql +22 -0
  199. package/migrations/0007_add_push_subscriptions/migration.sql +25 -0
  200. package/migrations/0008_add_jobs/migration.sql +110 -0
  201. package/migrations/0009_add_worker_nodes/migration.sql +90 -0
  202. package/migrations/0010_add_database_backup_runs/migration.sql +104 -0
  203. package/migrations/0011_add_notification_broadcasts/migration.sql +57 -0
  204. package/migrations/0012_add_backup_run_job_link/migration.sql +87 -0
  205. package/migrations/0013_add_job_node_secrets/migration.sql +61 -0
  206. package/migrations/0014_add_backup_run_pg_dump_version/migration.sql +26 -0
  207. package/migrations/0015_add_job_claim_token/migration.sql +92 -0
  208. package/migrations/0016_add_ai_platform/migration.sql +108 -0
  209. package/migrations/0017_revoke_viewer_ai_use/migration.sql +32 -0
  210. package/migrations/0018_add_user_credentials/migration.sql +29 -0
  211. package/migrations/0019_add_device_session_credential_link/migration.sql +52 -0
  212. package/migrations/0020_add_worker_node_vitals/migration.sql +3 -0
  213. package/migrations/0021_add_job_trace_context/migration.sql +6 -0
  214. package/migrations/0022_add_retention_created_at_indexes/migration.sql +13 -0
  215. package/migrations/0023_add_organizations/migration.sql +142 -0
  216. package/migrations/0024_split_system_org_roles/migration.sql +131 -0
  217. package/migrations/0025_org_scoped_rls/migration.sql +215 -0
  218. package/migrations/0026_add_groups/migration.sql +165 -0
  219. package/migrations/0027_add_grants/migration.sql +117 -0
  220. package/migrations/0028_add_org_settings/migration.sql +49 -0
  221. package/migrations/0029_add_org_credentials/migration.sql +54 -0
  222. package/migrations/0030_add_jobs_org_id/migration.sql +18 -0
  223. package/migrations/0031_add_jobs_org_id_status_index/migration.sql +6 -0
  224. package/migrations/0032_add_broadcast_target_org/migration.sql +21 -0
  225. package/migrations/0033_add_android_app/migration.sql +60 -0
  226. package/migrations/0034_open_job_reason/migration.sql +16 -0
  227. package/migrations/0035_ai_usage_feature/migration.sql +37 -0
  228. package/migrations/0036_add_app_metadata/migration.sql +49 -0
  229. package/migrations/0037_open_sharing_vocabularies/migration.sql +97 -0
  230. package/migrations/manifest.json +379 -0
  231. package/package.json +78 -4
  232. package/raw-sql-indexes.json +94 -0
  233. package/rls-policies.json +74 -0
  234. package/schema/ai.prisma +444 -0
  235. package/schema/android-app.prisma +47 -0
  236. package/schema/base.prisma +11 -0
  237. package/schema/credentials.prisma +170 -0
  238. package/schema/db-backup.prisma +376 -0
  239. package/schema/identity.prisma +439 -0
  240. package/schema/jobs.prisma +760 -0
  241. package/schema/notifications.prisma +649 -0
  242. package/schema/settings.prisma +60 -0
  243. package/schema/sharing.prisma +223 -0
  244. package/schema/storage.prisma +84 -0
@@ -0,0 +1,422 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.splitSqlStatements = splitSqlStatements;
4
+ exports.balanced = balanced;
5
+ exports.scanAllIndexes = scanAllIndexes;
6
+ exports.scanRawSqlIndexes = scanRawSqlIndexes;
7
+ exports.scanFragmentIndexes = scanFragmentIndexes;
8
+ exports.checkRawSqlIndexSources = checkRawSqlIndexSources;
9
+ exports.columnsOfDefinition = columnsOfDefinition;
10
+ exports.assertRawSqlIndexes = assertRawSqlIndexes;
11
+ const node_fs_1 = require("node:fs");
12
+ const node_path_1 = require("node:path");
13
+ const raw_sql_indexes_js_1 = require("./raw-sql-indexes.js");
14
+ /**
15
+ * Removes `--` and block comments and splits on top-level semicolons; quotes
16
+ * are respected. Shared with the policy tripwire.
17
+ *
18
+ * @internal
19
+ */
20
+ function splitSqlStatements(sql) {
21
+ const statements = [];
22
+ let current = '';
23
+ let i = 0;
24
+ const n = sql.length;
25
+ while (i < n) {
26
+ const c = sql[i];
27
+ const next = sql[i + 1];
28
+ if (c === '-' && next === '-') {
29
+ while (i < n && sql[i] !== '\n')
30
+ i += 1;
31
+ }
32
+ else if (c === '/' && next === '*') {
33
+ i += 2;
34
+ while (i < n && !(sql[i] === '*' && sql[i + 1] === '/'))
35
+ i += 1;
36
+ i += 2;
37
+ current += ' ';
38
+ }
39
+ else if (c === "'" || c === '"') {
40
+ const quote = c;
41
+ current += c;
42
+ i += 1;
43
+ while (i < n) {
44
+ current += sql[i];
45
+ if (sql[i] === quote) {
46
+ if (sql[i + 1] === quote) {
47
+ current += sql[i + 1];
48
+ i += 2;
49
+ continue;
50
+ }
51
+ i += 1;
52
+ break;
53
+ }
54
+ i += 1;
55
+ }
56
+ }
57
+ else if (c === ';') {
58
+ statements.push(current.trim());
59
+ current = '';
60
+ i += 1;
61
+ }
62
+ else {
63
+ current += c;
64
+ i += 1;
65
+ }
66
+ }
67
+ if (current.trim())
68
+ statements.push(current.trim());
69
+ return statements.filter((s) => s !== '');
70
+ }
71
+ const IDENT = '(?:"[^"]+"|[A-Za-z_][\\w$]*)';
72
+ const CREATE_INDEX = new RegExp(`^CREATE\\s+(UNIQUE\\s+)?INDEX\\s+(?:CONCURRENTLY\\s+)?(?:IF\\s+NOT\\s+EXISTS\\s+)?(${IDENT})\\s+ON\\s+(?:ONLY\\s+)?(${IDENT}(?:\\.${IDENT})?)\\s*(?:USING\\s+\\w+\\s*)?\\(`, 'i');
73
+ const DROP_INDEX = /^DROP\s+INDEX\s+(?:CONCURRENTLY\s+)?(?:IF\s+EXISTS\s+)?(.+)$/is;
74
+ const RENAME_INDEX = new RegExp(`^ALTER\\s+INDEX\\s+(?:IF\\s+EXISTS\\s+)?(${IDENT}(?:\\.${IDENT})?)\\s+RENAME\\s+TO\\s+(${IDENT})$`, 'i');
75
+ const PLAIN_KEY = /^(?:"[^"]+"|[A-Za-z_][\w$]*)(?:\s+(?:ASC|DESC|NULLS\s+(?:FIRST|LAST)|[A-Za-z_]\w*_ops))*$/i;
76
+ const unquote = (ident) => (ident.startsWith('"') ? ident.slice(1, -1) : ident.toLowerCase());
77
+ const unqualify = (qualified) => {
78
+ const parts = qualified.match(new RegExp(IDENT, 'g')) ?? [qualified];
79
+ return unquote(parts[parts.length - 1]);
80
+ };
81
+ /** Splits on commas outside parentheses, brackets and quotes. */
82
+ function splitTopLevel(text) {
83
+ const parts = [];
84
+ let depth = 0;
85
+ let quote = '';
86
+ let current = '';
87
+ for (const c of text) {
88
+ if (quote) {
89
+ current += c;
90
+ if (c === quote)
91
+ quote = '';
92
+ }
93
+ else if (c === "'" || c === '"') {
94
+ quote = c;
95
+ current += c;
96
+ }
97
+ else if (c === '(' || c === '[') {
98
+ depth += 1;
99
+ current += c;
100
+ }
101
+ else if (c === ')' || c === ']') {
102
+ depth -= 1;
103
+ current += c;
104
+ }
105
+ else if (c === ',' && depth === 0) {
106
+ parts.push(current.trim());
107
+ current = '';
108
+ }
109
+ else {
110
+ current += c;
111
+ }
112
+ }
113
+ if (current.trim())
114
+ parts.push(current.trim());
115
+ return parts;
116
+ }
117
+ /**
118
+ * The text inside the parenthesis opened at `open`, and what follows its closing one.
119
+ *
120
+ * @internal
121
+ */
122
+ function balanced(text, open) {
123
+ let depth = 0;
124
+ let quote = '';
125
+ for (let i = open; i < text.length; i += 1) {
126
+ const c = text[i];
127
+ if (quote) {
128
+ if (c === quote)
129
+ quote = '';
130
+ }
131
+ else if (c === "'" || c === '"')
132
+ quote = c;
133
+ else if (c === '(')
134
+ depth += 1;
135
+ else if (c === ')') {
136
+ depth -= 1;
137
+ if (depth === 0)
138
+ return { inner: text.slice(open + 1, i), rest: text.slice(i + 1) };
139
+ }
140
+ }
141
+ return undefined;
142
+ }
143
+ /**
144
+ * Reads every index that migration SQL leaves behind, in statement order: a
145
+ * `CREATE INDEX` or `CREATE UNIQUE INDEX` statement adds one, `DROP INDEX`
146
+ * removes it and `ALTER INDEX` with `RENAME TO` renames it. Comments are
147
+ * ignored. {@link scanRawSqlIndexes} keeps only the raw ones.
148
+ *
149
+ * @param migrations - `[id, sql]` pairs in history order.
150
+ * @returns The indexes that survive the whole history, in creation order.
151
+ * @stability experimental
152
+ */
153
+ function scanAllIndexes(migrations) {
154
+ const live = new Map();
155
+ const firstCreated = new Map();
156
+ for (const [id, sql] of migrations) {
157
+ for (const statement of splitSqlStatements(sql)) {
158
+ const create = CREATE_INDEX.exec(statement);
159
+ if (create) {
160
+ const name = unquote(create[2]);
161
+ const open = create[0].length - 1;
162
+ const group = balanced(statement, open);
163
+ if (!group)
164
+ continue;
165
+ const elements = splitTopLevel(group.inner);
166
+ const plain = elements.every((e) => PLAIN_KEY.test(e));
167
+ const partial = /\bWHERE\b/i.test(group.rest);
168
+ if (!firstCreated.has(name))
169
+ firstCreated.set(name, id);
170
+ live.set(name, {
171
+ name,
172
+ table: unqualify(create[3]),
173
+ unique: Boolean(create[1]),
174
+ columns: plain ? elements.map((e) => unquote(e.split(/\s+/)[0])) : null,
175
+ createdIn: firstCreated.get(name),
176
+ raw: partial || !plain,
177
+ });
178
+ continue;
179
+ }
180
+ const drop = DROP_INDEX.exec(statement);
181
+ if (drop) {
182
+ for (const target of splitTopLevel(drop[1].replace(/\s+(CASCADE|RESTRICT)\s*$/i, '')))
183
+ live.delete(unqualify(target));
184
+ continue;
185
+ }
186
+ const rename = RENAME_INDEX.exec(statement);
187
+ if (rename) {
188
+ const from = unqualify(rename[1]);
189
+ const to = unquote(rename[2]);
190
+ const found = live.get(from);
191
+ if (found) {
192
+ live.delete(from);
193
+ live.set(to, { ...found, name: to });
194
+ }
195
+ }
196
+ }
197
+ }
198
+ return [...live.values()];
199
+ }
200
+ /**
201
+ * Reads the raw-SQL indexes that migration SQL leaves behind (see
202
+ * {@link scanAllIndexes}): an index is raw when it has a `WHERE` clause or any
203
+ * key element that is an expression.
204
+ *
205
+ * @param migrations - `[id, sql]` pairs in history order.
206
+ * @returns The raw-SQL indexes that survive the whole history, in creation order.
207
+ * @stability experimental
208
+ */
209
+ function scanRawSqlIndexes(migrations) {
210
+ return scanAllIndexes(migrations)
211
+ .filter((index) => index.raw)
212
+ .map(({ raw: _raw, ...index }) => index);
213
+ }
214
+ const MODEL_HEADER = /^model\s+([A-Za-z_]\w*)\s*\{\s*$/;
215
+ const MAP_ATTR = /@map\(\s*"([^"]+)"\s*\)/;
216
+ const BLOCK_ATTR = /^@@(unique|index)\s*\((.*)\)\s*(?:\/\/.*)?$/;
217
+ const FIELD_LINE = /^([A-Za-z_]\w*)\s+[A-Za-z_]\w*(?:\([^)]*\))?(?:\[\])?\??(\s.*)?$/;
218
+ /**
219
+ * Reads every model's index declarations out of `prisma format`-shaped schema
220
+ * text: `@@unique`, `@@index` and single-field `@unique`, with Prisma field
221
+ * names translated to database column names through `@map`.
222
+ *
223
+ * @param file - A label for messages.
224
+ * @param text - The fragment's text.
225
+ * @returns One entry per declaration.
226
+ * @stability experimental
227
+ */
228
+ function scanFragmentIndexes(file, text) {
229
+ const found = [];
230
+ const lines = text.replace(/\r\n/g, '\n').split('\n');
231
+ let model;
232
+ const flush = () => {
233
+ if (!model)
234
+ return;
235
+ const columnOf = new Map();
236
+ let table = model.name;
237
+ for (const { text: line } of model.body) {
238
+ const t = line.trim();
239
+ const attr = /^@@map\(\s*"([^"]+)"\s*\)/.exec(t);
240
+ if (attr)
241
+ table = attr[1];
242
+ const field = FIELD_LINE.exec(t);
243
+ if (field && !t.startsWith('@@') && !t.startsWith('//'))
244
+ columnOf.set(field[1], MAP_ATTR.exec(field[2] ?? '')?.[1] ?? field[1]);
245
+ }
246
+ const toColumn = (name) => columnOf.get(name) ?? name;
247
+ for (const { text: line, line: lineNo } of model.body) {
248
+ const t = line.trim();
249
+ const block = BLOCK_ATTR.exec(t);
250
+ if (block) {
251
+ const args = splitTopLevel(block[2]);
252
+ const list = /^\[(.*)\]$/s.exec(args[0] ?? '');
253
+ if (!list)
254
+ continue;
255
+ const columns = splitTopLevel(list[1]).map((e) => toColumn(e.replace(/\(.*$/s, '').trim()));
256
+ const names = args.slice(1).flatMap((a) => {
257
+ const m = /^(?:map|name)\s*:\s*"([^"]+)"$/.exec(a.trim());
258
+ return m ? [m[1]] : [];
259
+ });
260
+ found.push({ file, line: lineNo, model: model.name, table, kind: block[1] === 'unique' ? '@@unique' : '@@index', columns, names });
261
+ continue;
262
+ }
263
+ const field = FIELD_LINE.exec(t);
264
+ if (field && !t.startsWith('//') && /(^|\s)@unique\b/.test(field[2] ?? '')) {
265
+ const given = /@unique\([^)]*map\s*:\s*"([^"]+)"/.exec(field[2] ?? '');
266
+ found.push({ file, line: lineNo, model: model.name, table, kind: '@unique', columns: [toColumn(field[1])], names: given ? [given[1]] : [] });
267
+ }
268
+ }
269
+ model = undefined;
270
+ };
271
+ lines.forEach((text, i) => {
272
+ if (!model) {
273
+ const header = MODEL_HEADER.exec(text);
274
+ if (header)
275
+ model = { name: header[1], start: i + 1, body: [] };
276
+ }
277
+ else if (text === '}') {
278
+ flush();
279
+ }
280
+ else {
281
+ model.body.push({ text, line: i + 1 });
282
+ }
283
+ });
284
+ return found;
285
+ }
286
+ const sameColumns = (a, b) => a.length === b.length && a.every((c, i) => c === b[i]);
287
+ /**
288
+ * The raw-SQL index tripwire, as a pure function. It fails when
289
+ *
290
+ * - a migration creates a partial or expression index that is not listed,
291
+ * - a listed index is not created by the migrations (or no longer partial or expression), or its table, uniqueness or `createdIn` disagree,
292
+ * - a schema fragment declares `@@unique`, `@@index` or `@unique` under a listed index's name, or on the same table and key columns.
293
+ *
294
+ * The last rule is the CLAUDE.md invariant in executable form: the indexes
295
+ * are intentional schema drift, never "fixed" with `@@unique`.
296
+ *
297
+ * @param input - See {@link TripwireInput}.
298
+ * @returns Every problem found, in a stable order; empty when the tripwire holds.
299
+ * @stability experimental
300
+ */
301
+ function checkRawSqlIndexSources(input) {
302
+ const listed = input.listed ?? raw_sql_indexes_js_1.RAW_SQL_INDEXES;
303
+ const problems = [];
304
+ const migrations = [];
305
+ for (const entry of input.manifest) {
306
+ const sql = input.readMigration(entry.dir);
307
+ if (sql === undefined) {
308
+ problems.push({ code: 'LISTED_INDEX_NOT_FOUND', name: entry.id, message: `${entry.id}: migrations/${entry.dir}/migration.sql does not exist, so it cannot be scanned` });
309
+ continue;
310
+ }
311
+ migrations.push([entry.id, sql]);
312
+ }
313
+ const found = scanRawSqlIndexes(migrations);
314
+ const byName = new Map(found.map((index) => [index.name, index]));
315
+ const listedNames = new Set(listed.map((index) => index.name));
316
+ for (const index of found) {
317
+ if (!listedNames.has(index.name)) {
318
+ problems.push({
319
+ code: 'UNLISTED_RAW_INDEX',
320
+ name: index.name,
321
+ message: `${index.name}: ${index.createdIn} creates a partial or expression index on ${index.table} that RAW_SQL_INDEXES does not list; add it to raw-sql-indexes.json with its reason and document it`,
322
+ });
323
+ }
324
+ }
325
+ for (const index of listed) {
326
+ const actual = byName.get(index.name);
327
+ if (!actual) {
328
+ problems.push({
329
+ code: 'LISTED_INDEX_NOT_FOUND',
330
+ name: index.name,
331
+ message: `${index.name}: listed in RAW_SQL_INDEXES but no migration leaves a partial or expression index of that name`,
332
+ });
333
+ continue;
334
+ }
335
+ const differences = [];
336
+ if (actual.table !== index.table)
337
+ differences.push(`table ${actual.table} (listed ${index.table})`);
338
+ if (actual.unique !== index.unique)
339
+ differences.push(`unique=${actual.unique} (listed ${index.unique})`);
340
+ if (actual.createdIn !== index.createdIn)
341
+ differences.push(`created in ${actual.createdIn} (listed ${index.createdIn})`);
342
+ if (differences.length) {
343
+ problems.push({ code: 'LISTED_INDEX_MISMATCH', name: index.name, message: `${index.name}: the migrations say ${differences.join(', ')}` });
344
+ }
345
+ }
346
+ for (const fragment of input.fragments) {
347
+ for (const declared of scanFragmentIndexes(fragment.file, fragment.text)) {
348
+ for (const index of listed) {
349
+ const sameName = declared.names.includes(index.name);
350
+ const keyColumns = sameName ? undefined : columnsOfDefinition(index.definition);
351
+ const sameKey = !sameName && declared.table === index.table && keyColumns !== undefined && sameColumns(declared.columns, keyColumns);
352
+ if (sameName || sameKey) {
353
+ problems.push({
354
+ code: 'FRAGMENT_DECLARES_RAW_INDEX',
355
+ name: index.name,
356
+ message: `${fragment.file}:${declared.line}: ${declared.model} declares ${declared.kind} on (${declared.columns.join(', ')}) which is the raw-SQL index ${index.name}; Prisma builds a full index there, not the partial one. Remove it (intentional drift, see ${index.doc})`,
357
+ });
358
+ }
359
+ }
360
+ }
361
+ }
362
+ return problems;
363
+ }
364
+ /**
365
+ * The key columns of a listed index definition, or `undefined` when a key element is an expression.
366
+ *
367
+ * @internal
368
+ */
369
+ function columnsOfDefinition(definition) {
370
+ const open = definition.search(/\sUSING\s+\w+\s*\(/i);
371
+ if (open < 0)
372
+ return undefined;
373
+ const group = balanced(definition, definition.indexOf('(', open));
374
+ if (!group)
375
+ return undefined;
376
+ const elements = splitTopLevel(group.inner);
377
+ if (!elements.every((e) => PLAIN_KEY.test(e)))
378
+ return undefined;
379
+ return elements.map((e) => unquote(e.split(/\s+/)[0]));
380
+ }
381
+ /** Every `.prisma` file under a directory, sorted, as `{ file, text }`. */
382
+ function readFragments(dir) {
383
+ if (!(0, node_fs_1.existsSync)(dir))
384
+ return [];
385
+ const out = [];
386
+ const walk = (current) => {
387
+ for (const name of (0, node_fs_1.readdirSync)(current).sort()) {
388
+ const path = (0, node_path_1.join)(current, name);
389
+ if ((0, node_fs_1.statSync)(path).isDirectory())
390
+ walk(path);
391
+ else if (name.endsWith('.prisma'))
392
+ out.push({ file: path, text: (0, node_fs_1.readFileSync)(path, 'utf8') });
393
+ }
394
+ };
395
+ walk(dir);
396
+ return out;
397
+ }
398
+ /**
399
+ * Runs the raw-SQL index tripwire against the files on disk: the package's
400
+ * migrations (every manifest entry) and schema fragments. This is the entry
401
+ * the conformance suite and an app's CI call; see {@link checkRawSqlIndexSources}
402
+ * for the rules.
403
+ *
404
+ * @param options - See {@link AssertRawSqlIndexesOptions}.
405
+ * @throws Error listing every problem when the tripwire is tripped.
406
+ * @stability experimental
407
+ */
408
+ function assertRawSqlIndexes(options) {
409
+ const problems = checkRawSqlIndexSources({
410
+ manifest: options.manifest,
411
+ readMigration: (dir) => {
412
+ const file = (0, node_path_1.join)(options.migrationsDir, dir, 'migration.sql');
413
+ return (0, node_fs_1.existsSync)(file) ? (0, node_fs_1.readFileSync)(file, 'utf8') : undefined;
414
+ },
415
+ fragments: readFragments(options.fragmentsDir),
416
+ listed: options.listed,
417
+ });
418
+ if (problems.length > 0) {
419
+ throw new Error(`the raw-SQL index tripwire failed (${problems.length}):\n${problems.map((p) => ` ${p.code} ${p.message}`).join('\n')}`);
420
+ }
421
+ }
422
+ //# sourceMappingURL=raw-sql-tripwire.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"raw-sql-tripwire.js","sourceRoot":"","sources":["../../src/drift/raw-sql-tripwire.ts"],"names":[],"mappings":";;AA4DA,gDA2CC;AAoDD,4BAeC;AAuBD,wCA2CC;AAWD,8CAIC;AAuCD,kDAkDC;AAuCD,0DA6DC;AAOD,kDAQC;AA2CD,kDAaC;AA/fD,qCAA0E;AAC1E,yCAAiC;AAEjC,6DAAgF;AAmDhF;;;;;GAKG;AACH,SAAgB,kBAAkB,CAAC,GAAW;IAC5C,MAAM,UAAU,GAAa,EAAE,CAAC;IAChC,IAAI,OAAO,GAAG,EAAE,CAAC;IACjB,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,MAAM,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC;IACrB,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QACb,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,CAAE,CAAC;QAClB,MAAM,IAAI,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;YAC9B,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,IAAI;gBAAE,CAAC,IAAI,CAAC,CAAC;QAC1C,CAAC;aAAM,IAAI,CAAC,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;YACrC,CAAC,IAAI,CAAC,CAAC;YACP,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC;gBAAE,CAAC,IAAI,CAAC,CAAC;YAChE,CAAC,IAAI,CAAC,CAAC;YACP,OAAO,IAAI,GAAG,CAAC;QACjB,CAAC;aAAM,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;YAClC,MAAM,KAAK,GAAG,CAAC,CAAC;YAChB,OAAO,IAAI,CAAC,CAAC;YACb,CAAC,IAAI,CAAC,CAAC;YACP,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;gBACb,OAAO,IAAI,GAAG,CAAC,CAAC,CAAE,CAAC;gBACnB,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC;oBACrB,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC;wBACzB,OAAO,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,CAAE,CAAC;wBACvB,CAAC,IAAI,CAAC,CAAC;wBACP,SAAS;oBACX,CAAC;oBACD,CAAC,IAAI,CAAC,CAAC;oBACP,MAAM;gBACR,CAAC;gBACD,CAAC,IAAI,CAAC,CAAC;YACT,CAAC;QACH,CAAC;aAAM,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;YACrB,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;YAChC,OAAO,GAAG,EAAE,CAAC;YACb,CAAC,IAAI,CAAC,CAAC;QACT,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,CAAC;YACb,CAAC,IAAI,CAAC,CAAC;QACT,CAAC;IACH,CAAC;IACD,IAAI,OAAO,CAAC,IAAI,EAAE;QAAE,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IACpD,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;AAC5C,CAAC;AAED,MAAM,KAAK,GAAG,8BAA8B,CAAC;AAC7C,MAAM,YAAY,GAAG,IAAI,MAAM,CAC7B,sFAAsF,KAAK,4BAA4B,KAAK,SAAS,KAAK,kCAAkC,EAC5K,GAAG,CACJ,CAAC;AACF,MAAM,UAAU,GAAG,gEAAgE,CAAC;AACpF,MAAM,YAAY,GAAG,IAAI,MAAM,CAAC,4CAA4C,KAAK,SAAS,KAAK,2BAA2B,KAAK,IAAI,EAAE,GAAG,CAAC,CAAC;AAC1I,MAAM,SAAS,GAAG,4FAA4F,CAAC;AAE/G,MAAM,OAAO,GAAG,CAAC,KAAa,EAAU,EAAE,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;AAC9G,MAAM,SAAS,GAAG,CAAC,SAAiB,EAAU,EAAE;IAC9C,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACrE,OAAO,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAE,CAAC,CAAC;AAC3C,CAAC,CAAC;AAEF,iEAAiE;AACjE,SAAS,aAAa,CAAC,IAAY;IACjC,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,IAAI,KAAK,GAAG,EAAE,CAAC;IACf,IAAI,OAAO,GAAG,EAAE,CAAC;IACjB,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;QACrB,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,IAAI,CAAC,CAAC;YACb,IAAI,CAAC,KAAK,KAAK;gBAAE,KAAK,GAAG,EAAE,CAAC;QAC9B,CAAC;aAAM,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;YAClC,KAAK,GAAG,CAAC,CAAC;YACV,OAAO,IAAI,CAAC,CAAC;QACf,CAAC;aAAM,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;YAClC,KAAK,IAAI,CAAC,CAAC;YACX,OAAO,IAAI,CAAC,CAAC;QACf,CAAC;aAAM,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;YAClC,KAAK,IAAI,CAAC,CAAC;YACX,OAAO,IAAI,CAAC,CAAC;QACf,CAAC;aAAM,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;YACpC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;YAC3B,OAAO,GAAG,EAAE,CAAC;QACf,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,CAAC;QACf,CAAC;IACH,CAAC;IACD,IAAI,OAAO,CAAC,IAAI,EAAE;QAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IAC/C,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,SAAgB,QAAQ,CAAC,IAAY,EAAE,IAAY;IACjD,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,IAAI,KAAK,GAAG,EAAE,CAAC;IACf,KAAK,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3C,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAE,CAAC;QACnB,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,CAAC,KAAK,KAAK;gBAAE,KAAK,GAAG,EAAE,CAAC;QAC9B,CAAC;aAAM,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,GAAG;YAAE,KAAK,GAAG,CAAC,CAAC;aACxC,IAAI,CAAC,KAAK,GAAG;YAAE,KAAK,IAAI,CAAC,CAAC;aAC1B,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;YACnB,KAAK,IAAI,CAAC,CAAC;YACX,IAAI,KAAK,KAAK,CAAC;gBAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;QACtF,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAaD;;;;;;;;;GASG;AACH,SAAgB,cAAc,CAAC,UAAoD;IACjF,MAAM,IAAI,GAAG,IAAI,GAAG,EAA2B,CAAC;IAChD,MAAM,YAAY,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC/C,KAAK,MAAM,CAAC,EAAE,EAAE,GAAG,CAAC,IAAI,UAAU,EAAE,CAAC;QACnC,KAAK,MAAM,SAAS,IAAI,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC;YAChD,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC5C,IAAI,MAAM,EAAE,CAAC;gBACX,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAE,CAAC,CAAC;gBACjC,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;gBAClC,MAAM,KAAK,GAAG,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;gBACxC,IAAI,CAAC,KAAK;oBAAE,SAAS;gBACrB,MAAM,QAAQ,GAAG,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBAC5C,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;gBACvD,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAC9C,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC;oBAAE,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;gBACxD,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE;oBACb,IAAI;oBACJ,KAAK,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC,CAAE,CAAC;oBAC5B,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;oBAC1B,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI;oBACxE,SAAS,EAAE,YAAY,CAAC,GAAG,CAAC,IAAI,CAAE;oBAClC,GAAG,EAAE,OAAO,IAAI,CAAC,KAAK;iBACvB,CAAC,CAAC;gBACH,SAAS;YACX,CAAC;YACD,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACxC,IAAI,IAAI,EAAE,CAAC;gBACT,KAAK,MAAM,MAAM,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC,CAAE,CAAC,OAAO,CAAC,4BAA4B,EAAE,EAAE,CAAC,CAAC;oBAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;gBACvH,SAAS;YACX,CAAC;YACD,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC5C,IAAI,MAAM,EAAE,CAAC;gBACX,MAAM,IAAI,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAE,CAAC,CAAC;gBACnC,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAE,CAAC,CAAC;gBAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBAC7B,IAAI,KAAK,EAAE,CAAC;oBACV,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;oBAClB,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,GAAG,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;gBACvC,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;AAC5B,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,iBAAiB,CAAC,UAAoD;IACpF,OAAO,cAAc,CAAC,UAAU,CAAC;SAC9B,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC;SAC5B,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;AAC7C,CAAC;AAwBD,MAAM,YAAY,GAAG,kCAAkC,CAAC;AACxD,MAAM,QAAQ,GAAG,yBAAyB,CAAC;AAC3C,MAAM,UAAU,GAAG,6CAA6C,CAAC;AACjE,MAAM,UAAU,GAAG,kEAAkE,CAAC;AAEtF;;;;;;;;;GASG;AACH,SAAgB,mBAAmB,CAAC,IAAY,EAAE,IAAY;IAC5D,MAAM,KAAK,GAAoB,EAAE,CAAC;IAClC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACtD,IAAI,KAA+F,CAAC;IACpG,MAAM,KAAK,GAAG,GAAS,EAAE;QACvB,IAAI,CAAC,KAAK;YAAE,OAAO;QACnB,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAkB,CAAC;QAC3C,IAAI,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,KAAK,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;YACxC,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YACtB,MAAM,IAAI,GAAG,2BAA2B,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACjD,IAAI,IAAI;gBAAE,KAAK,GAAG,IAAI,CAAC,CAAC,CAAE,CAAC;YAC3B,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACjC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC;gBAAE,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAE,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAE,CAAC,CAAC;QACpI,CAAC;QACD,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC;QACtE,KAAK,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;YACtD,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YACtB,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACjC,IAAI,KAAK,EAAE,CAAC;gBACV,MAAM,IAAI,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,CAAC;gBACtC,MAAM,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;gBAC/C,IAAI,CAAC,IAAI;oBAAE,SAAS;gBACpB,MAAM,OAAO,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC,CAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;gBAC7F,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;oBACxC,MAAM,CAAC,GAAG,gCAAgC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;oBAC1D,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC1B,CAAC,CAAC,CAAC;gBACH,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;gBACnI,SAAS;YACX,CAAC;YACD,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACjC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;gBAC3E,MAAM,KAAK,GAAG,mCAAmC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;gBACvE,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACjJ,CAAC;QACH,CAAC;QACD,KAAK,GAAG,SAAS,CAAC;IACpB,CAAC,CAAC;IACF,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;QACxB,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACvC,IAAI,MAAM;gBAAE,KAAK,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,CAAE,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;QACnE,CAAC;aAAM,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;YACxB,KAAK,EAAE,CAAC;QACV,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACzC,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,KAAK,CAAC;AACf,CAAC;AAuBD,MAAM,WAAW,GAAG,CAAC,CAAoB,EAAE,CAAoB,EAAW,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAEpI;;;;;;;;;;;;;GAaG;AACH,SAAgB,uBAAuB,CAAC,KAAoB;IAC1D,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,oCAAe,CAAC;IAC/C,MAAM,QAAQ,GAAsB,EAAE,CAAC;IACvC,MAAM,UAAU,GAA4B,EAAE,CAAC;IAC/C,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;QACnC,MAAM,GAAG,GAAG,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACtB,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,wBAAwB,EAAE,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC,EAAE,gBAAgB,KAAK,CAAC,GAAG,wDAAwD,EAAE,CAAC,CAAC;YACzK,SAAS;QACX,CAAC;QACD,UAAU,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC;IACnC,CAAC;IACD,MAAM,KAAK,GAAG,iBAAiB,CAAC,UAAU,CAAC,CAAC;IAC5C,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAClE,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IAE/D,KAAK,MAAM,KAAK,IAAI,KAAK,EAAE,CAAC;QAC1B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YACjC,QAAQ,CAAC,IAAI,CAAC;gBACZ,IAAI,EAAE,oBAAoB;gBAC1B,IAAI,EAAE,KAAK,CAAC,IAAI;gBAChB,OAAO,EAAE,GAAG,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,SAAS,6CAA6C,KAAK,CAAC,KAAK,qGAAqG;aACxM,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IACD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACtC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,QAAQ,CAAC,IAAI,CAAC;gBACZ,IAAI,EAAE,wBAAwB;gBAC9B,IAAI,EAAE,KAAK,CAAC,IAAI;gBAChB,OAAO,EAAE,GAAG,KAAK,CAAC,IAAI,gGAAgG;aACvH,CAAC,CAAC;YACH,SAAS;QACX,CAAC;QACD,MAAM,WAAW,GAAa,EAAE,CAAC;QACjC,IAAI,MAAM,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK;YAAE,WAAW,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,KAAK,YAAY,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC;QACpG,IAAI,MAAM,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;YAAE,WAAW,CAAC,IAAI,CAAC,UAAU,MAAM,CAAC,MAAM,YAAY,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;QACzG,IAAI,MAAM,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS;YAAE,WAAW,CAAC,IAAI,CAAC,cAAc,MAAM,CAAC,SAAS,YAAY,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC;QACzH,IAAI,WAAW,CAAC,MAAM,EAAE,CAAC;YACvB,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,uBAAuB,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC,IAAI,wBAAwB,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;QAC7I,CAAC;IACH,CAAC;IAED,KAAK,MAAM,QAAQ,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;QACvC,KAAK,MAAM,QAAQ,IAAI,mBAAmB,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACzE,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;gBAC3B,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBACrD,MAAM,UAAU,GAAG,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,mBAAmB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;gBAChF,MAAM,OAAO,GAAG,CAAC,QAAQ,IAAI,QAAQ,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,IAAI,UAAU,KAAK,SAAS,IAAI,WAAW,CAAC,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;gBACrI,IAAI,QAAQ,IAAI,OAAO,EAAE,CAAC;oBACxB,QAAQ,CAAC,IAAI,CAAC;wBACZ,IAAI,EAAE,6BAA6B;wBACnC,IAAI,EAAE,KAAK,CAAC,IAAI;wBAChB,OAAO,EAAE,GAAG,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC,KAAK,aAAa,QAAQ,CAAC,IAAI,QAAQ,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,gCAAgC,KAAK,CAAC,IAAI,8FAA8F,KAAK,CAAC,GAAG,GAAG;qBAC/Q,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;GAIG;AACH,SAAgB,mBAAmB,CAAC,UAAkB;IACpD,MAAM,IAAI,GAAG,UAAU,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;IACtD,IAAI,IAAI,GAAG,CAAC;QAAE,OAAO,SAAS,CAAC;IAC/B,MAAM,KAAK,GAAG,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;IAClE,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAC;IAC7B,MAAM,QAAQ,GAAG,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC5C,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAAE,OAAO,SAAS,CAAC;IAChE,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC;AAC1D,CAAC;AAED,2EAA2E;AAC3E,SAAS,aAAa,CAAC,GAAW;IAChC,IAAI,CAAC,IAAA,oBAAU,EAAC,GAAG,CAAC;QAAE,OAAO,EAAE,CAAC;IAChC,MAAM,GAAG,GAA0C,EAAE,CAAC;IACtD,MAAM,IAAI,GAAG,CAAC,OAAe,EAAQ,EAAE;QACrC,KAAK,MAAM,IAAI,IAAI,IAAA,qBAAW,EAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;YAC/C,MAAM,IAAI,GAAG,IAAA,gBAAI,EAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YACjC,IAAI,IAAA,kBAAQ,EAAC,IAAI,CAAC,CAAC,WAAW,EAAE;gBAAE,IAAI,CAAC,IAAI,CAAC,CAAC;iBACxC,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;gBAAE,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAA,sBAAY,EAAC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;QAChG,CAAC;IACH,CAAC,CAAC;IACF,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,OAAO,GAAG,CAAC;AACb,CAAC;AAkBD;;;;;;;;;GASG;AACH,SAAgB,mBAAmB,CAAC,OAAmC;IACrE,MAAM,QAAQ,GAAG,uBAAuB,CAAC;QACvC,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,aAAa,EAAE,CAAC,GAAG,EAAE,EAAE;YACrB,MAAM,IAAI,GAAG,IAAA,gBAAI,EAAC,OAAO,CAAC,aAAa,EAAE,GAAG,EAAE,eAAe,CAAC,CAAC;YAC/D,OAAO,IAAA,oBAAU,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAA,sBAAY,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACnE,CAAC;QACD,SAAS,EAAE,aAAa,CAAC,OAAO,CAAC,YAAY,CAAC;QAC9C,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC,CAAC;IACH,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,sCAAsC,QAAQ,CAAC,MAAM,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC7I,CAAC;AACH,CAAC"}
@@ -0,0 +1,226 @@
1
+ import type { ManifestEntry } from '../lock/index.js';
2
+ /**
3
+ * A row-level-security policy the package ships, with why it exists. Prisma's
4
+ * schema language cannot express a policy and `prisma migrate diff` ignores it
5
+ * in both directions, so the list is an intentional-drift allow-list like
6
+ * {@link RAW_SQL_INDEXES}: the drift test asserts each policy exists (and that
7
+ * its table has row-level security enabled and forced) and that no other
8
+ * policy does.
9
+ *
10
+ * @stability experimental
11
+ */
12
+ export interface PackageRlsPolicy {
13
+ /** The policy name (`<table>_org_isolation`). */
14
+ name: string;
15
+ /** The table it protects (the database name, not the Prisma model). */
16
+ table: string;
17
+ /** One line: what the policy enforces. */
18
+ reason: string;
19
+ /** The repository document that explains the invariant, relative to the repository root. */
20
+ doc: string;
21
+ /** The platform migration id (`NNNN_slug`) that first creates it. */
22
+ createdIn: string;
23
+ }
24
+ /**
25
+ * Reads the package's `rls-policies.json`.
26
+ *
27
+ * @param file - Path of the JSON file.
28
+ * @returns The policies, in file order.
29
+ * @throws Error when the file is not valid.
30
+ * @stability experimental
31
+ */
32
+ export declare function readPackageRlsPolicies(file: string): PackageRlsPolicy[];
33
+ /**
34
+ * The package's row-level-security policies: the allow-list of intentional
35
+ * drift that `platform db drift` asserts against `pg_policies` and that
36
+ * {@link assertRlsPolicies} checks against the migrations. Read from the
37
+ * shipped `rls-policies.json`.
38
+ *
39
+ * @stability experimental
40
+ */
41
+ export declare const RLS_POLICIES: ReadonlyArray<PackageRlsPolicy>;
42
+ /**
43
+ * A policy an app lists in its own `platform.lock` (`rlsPolicies`).
44
+ *
45
+ * @stability experimental
46
+ */
47
+ export interface RlsPolicyRef {
48
+ /** The policy name. */
49
+ name: string;
50
+ /** The table it protects. */
51
+ table: string;
52
+ }
53
+ /**
54
+ * A row of `pg_policies`.
55
+ *
56
+ * @stability experimental
57
+ */
58
+ export interface PolicyRow {
59
+ /** `tablename`. */
60
+ table: string;
61
+ /** `policyname`. */
62
+ name: string;
63
+ }
64
+ /**
65
+ * The row-level-security flags of one table (`pg_class.relrowsecurity` and `relforcerowsecurity`).
66
+ *
67
+ * @stability experimental
68
+ */
69
+ export interface TableRlsRow {
70
+ /** The table name. */
71
+ table: string;
72
+ /** `relrowsecurity`. */
73
+ enabled: boolean;
74
+ /** `relforcerowsecurity`. */
75
+ forced: boolean;
76
+ }
77
+ /**
78
+ * The class of a policy failure.
79
+ *
80
+ * - `POLICY_MISSING`: a listed policy is not in `pg_policies`.
81
+ * - `POLICY_UNLISTED`: `pg_policies` holds a policy no list names.
82
+ * - `RLS_NOT_ENABLED`: a listed policy's table does not have row-level security enabled.
83
+ * - `RLS_NOT_FORCED`: a listed policy's table does not FORCE it, so the owner (the application role) bypasses the policy.
84
+ * - `RLS_FORCED_WITHOUT_POLICY`: a table forces row-level security but no listed policy protects it (everything would be denied).
85
+ *
86
+ * @stability experimental
87
+ */
88
+ export type RlsProblemCode = 'POLICY_MISSING' | 'POLICY_UNLISTED' | 'RLS_NOT_ENABLED' | 'RLS_NOT_FORCED' | 'RLS_FORCED_WITHOUT_POLICY';
89
+ /**
90
+ * One row-level-security problem.
91
+ *
92
+ * @stability experimental
93
+ */
94
+ export interface RlsProblem {
95
+ /** The class of failure. */
96
+ code: RlsProblemCode;
97
+ /** The policy name, or the table for a table-level problem. */
98
+ name: string;
99
+ /** A one-line explanation. */
100
+ message: string;
101
+ }
102
+ /**
103
+ * The positive assertion of the drift test for policies: every expected policy
104
+ * exists, its table has row-level security enabled AND forced, and nothing else
105
+ * exists (`migrate diff` ignores policies, so a dropped, weakened-by-hand or
106
+ * extra one is invisible to it).
107
+ *
108
+ * @param expected - The package's list plus the app's (`platform.lock` `rlsPolicies`).
109
+ * @param livePolicies - Rows of `pg_policies` for the `public` schema.
110
+ * @param liveTables - Row-level-security flags of every table in the `public` schema.
111
+ * @returns Every problem found.
112
+ * @stability experimental
113
+ */
114
+ export declare function checkRlsPolicies(expected: ReadonlyArray<RlsPolicyRef>, livePolicies: readonly PolicyRow[], liveTables: readonly TableRlsRow[]): RlsProblem[];
115
+ /**
116
+ * A policy found by reading migration SQL.
117
+ *
118
+ * @stability experimental
119
+ */
120
+ export interface ScannedPolicy {
121
+ /** The policy name. */
122
+ name: string;
123
+ /** The table, unquoted and without a schema. */
124
+ table: string;
125
+ /** The migration id that first creates a policy of this name on the table. */
126
+ createdIn: string;
127
+ /** The `USING` expression the history leaves (after any `ALTER POLICY`), normalised by {@link normaliseSqlExpression}; absent when the policy has none. */
128
+ using?: string;
129
+ /** The `WITH CHECK` expression the history leaves, normalised the same way; absent when the policy has none. */
130
+ check?: string;
131
+ }
132
+ /**
133
+ * What a migration history leaves behind for row-level security.
134
+ *
135
+ * @stability experimental
136
+ */
137
+ export interface ScannedRls {
138
+ /** Policies that survive the whole history, in creation order. */
139
+ policies: ScannedPolicy[];
140
+ /** Tables whose row-level security is enabled at the end of the history. */
141
+ enabled: string[];
142
+ /** Tables whose row-level security is forced at the end of the history. */
143
+ forced: string[];
144
+ }
145
+ /**
146
+ * Reads the row-level security a migration history leaves behind, in
147
+ * statement order: `CREATE POLICY` adds a policy, `DROP POLICY` removes it,
148
+ * `ALTER TABLE ... ENABLE|DISABLE|FORCE|NO FORCE ROW LEVEL SECURITY` sets the
149
+ * flags and `DROP TABLE` forgets everything about the table. Comments are
150
+ * ignored.
151
+ *
152
+ * @param migrations - `[id, sql]` pairs in history order.
153
+ * @returns The policies and the enabled and forced tables at the end.
154
+ * @stability experimental
155
+ */
156
+ export declare function scanRlsPolicies(migrations: ReadonlyArray<readonly [string, string]>): ScannedRls;
157
+ /**
158
+ * The class of a policy tripwire failure.
159
+ *
160
+ * - `UNLISTED_POLICY`: a migration leaves a policy `RLS_POLICIES` does not list.
161
+ * - `LISTED_POLICY_NOT_FOUND`: a listed policy is not left by the migrations.
162
+ * - `LISTED_POLICY_MISMATCH`: the listed `createdIn` disagrees with the migrations.
163
+ * - `POLICY_TABLE_NOT_ENABLED` / `POLICY_TABLE_NOT_FORCED`: a policy's table does not `ENABLE` / `FORCE ROW LEVEL SECURITY` in the migrations.
164
+ *
165
+ * @stability experimental
166
+ */
167
+ export type RlsTripwireCode = 'UNLISTED_POLICY' | 'LISTED_POLICY_NOT_FOUND' | 'LISTED_POLICY_MISMATCH' | 'POLICY_TABLE_NOT_ENABLED' | 'POLICY_TABLE_NOT_FORCED';
168
+ /**
169
+ * One policy tripwire failure.
170
+ *
171
+ * @stability experimental
172
+ */
173
+ export interface RlsTripwireProblem {
174
+ /** The class of failure. */
175
+ code: RlsTripwireCode;
176
+ /** The policy name. */
177
+ name: string;
178
+ /** A one-line explanation naming the migration and the fix. */
179
+ message: string;
180
+ }
181
+ /**
182
+ * What {@link checkRlsPolicySources} reads.
183
+ *
184
+ * @stability experimental
185
+ */
186
+ export interface RlsTripwireInput {
187
+ /** The package history, in order. */
188
+ manifest: readonly Pick<ManifestEntry, 'id' | 'dir'>[];
189
+ /** Reads a package migration's SQL by directory; `undefined` when it does not exist. */
190
+ readMigration: (dir: string) => string | undefined;
191
+ /** The list to hold the migrations to; default {@link RLS_POLICIES}. */
192
+ listed?: ReadonlyArray<PackageRlsPolicy>;
193
+ }
194
+ /**
195
+ * The offline policy tripwire, as a pure function: every policy a migration
196
+ * leaves behind is listed in `RLS_POLICIES`, every listed one is created, and
197
+ * each listed policy's table both enables and forces row-level security.
198
+ *
199
+ * @param input - See {@link RlsTripwireInput}.
200
+ * @returns Every problem found; empty when the tripwire holds.
201
+ * @stability experimental
202
+ */
203
+ export declare function checkRlsPolicySources(input: RlsTripwireInput): RlsTripwireProblem[];
204
+ /**
205
+ * What {@link assertRlsPolicies} reads from disk.
206
+ *
207
+ * @stability experimental
208
+ */
209
+ export interface AssertRlsPoliciesOptions {
210
+ /** The package history (`migrations/manifest.json`, parsed). */
211
+ manifest: readonly Pick<ManifestEntry, 'id' | 'dir'>[];
212
+ /** The package's `migrations/` directory. */
213
+ migrationsDir: string;
214
+ /** The list to hold the migrations to; default {@link RLS_POLICIES}. */
215
+ listed?: ReadonlyArray<PackageRlsPolicy>;
216
+ }
217
+ /**
218
+ * Runs the policy tripwire against the migrations on disk and throws, listing
219
+ * every problem, when it does not hold.
220
+ *
221
+ * @param options - See {@link AssertRlsPoliciesOptions}.
222
+ * @throws Error naming each problem.
223
+ * @stability experimental
224
+ */
225
+ export declare function assertRlsPolicies(options: AssertRlsPoliciesOptions): void;
226
+ //# sourceMappingURL=rls-policies.d.ts.map