fastify-auto-sqlapi 0.5.1 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (212) hide show
  1. package/AGENTS.md +5 -5
  2. package/AGENTS_BACKEND.md +166 -130
  3. package/AGENTS_FRONTEND.md +60 -38
  4. package/BREAKING_CHANGES.md +9 -893
  5. package/CHANGELOG.md +246 -15
  6. package/README.md +71 -45
  7. package/dist/bin/generate-schema.js +12 -12
  8. package/dist/bin/generate-tables.js +1 -2
  9. package/dist/bin/utils.d.ts +2 -6
  10. package/dist/bin/utils.d.ts.map +1 -1
  11. package/dist/bin/utils.js +13 -33
  12. package/dist/index.d.ts +13 -33
  13. package/dist/index.d.ts.map +1 -1
  14. package/dist/index.js +6 -37
  15. package/dist/lib/adapters/mysql-adapter.d.ts +5 -2
  16. package/dist/lib/adapters/mysql-adapter.d.ts.map +1 -1
  17. package/dist/lib/adapters/pg-adapter.d.ts +5 -2
  18. package/dist/lib/adapters/pg-adapter.d.ts.map +1 -1
  19. package/dist/lib/agent/manifest.d.ts +27 -10
  20. package/dist/lib/agent/manifest.d.ts.map +1 -1
  21. package/dist/lib/agent/manifest.js +43 -26
  22. package/dist/lib/agent/tool-schemas.d.ts +5 -4
  23. package/dist/lib/agent/tool-schemas.d.ts.map +1 -1
  24. package/dist/lib/agent/tool-schemas.js +5 -5
  25. package/dist/lib/cli/config.d.ts +37 -2
  26. package/dist/lib/cli/config.d.ts.map +1 -1
  27. package/dist/lib/cli/config.js +106 -16
  28. package/dist/lib/cli/mysql-introspect.d.ts +6 -1
  29. package/dist/lib/cli/mysql-introspect.d.ts.map +1 -1
  30. package/dist/lib/cli/mysql-introspect.js +15 -15
  31. package/dist/lib/cli/pg-introspect.d.ts +0 -1
  32. package/dist/lib/cli/pg-introspect.d.ts.map +1 -1
  33. package/dist/lib/cli/pg-introspect.js +2 -13
  34. package/dist/lib/cli/tables-codegen.d.ts +0 -4
  35. package/dist/lib/cli/tables-codegen.d.ts.map +1 -1
  36. package/dist/lib/cli/tables-codegen.js +24 -87
  37. package/dist/lib/db.d.ts +42 -17
  38. package/dist/lib/db.d.ts.map +1 -1
  39. package/dist/lib/db.js +114 -40
  40. package/dist/lib/dialect.d.ts +5 -0
  41. package/dist/lib/dialect.d.ts.map +1 -1
  42. package/dist/lib/dialect.js +3 -0
  43. package/dist/lib/engine/bulk/bulk-delete.d.ts +5 -0
  44. package/dist/lib/engine/bulk/bulk-delete.d.ts.map +1 -1
  45. package/dist/lib/engine/bulk/bulk-delete.js +66 -30
  46. package/dist/lib/engine/bulk/bulk-upsert.d.ts.map +1 -1
  47. package/dist/lib/engine/bulk/bulk-upsert.js +45 -26
  48. package/dist/lib/engine/read-hooks.d.ts +3 -3
  49. package/dist/lib/engine/read-hooks.d.ts.map +1 -1
  50. package/dist/lib/engine/read-hooks.js +3 -3
  51. package/dist/lib/engine/rest/delete.d.ts.map +1 -1
  52. package/dist/lib/engine/rest/delete.js +12 -18
  53. package/dist/lib/engine/rest/get.js +8 -8
  54. package/dist/lib/engine/rest/insert.d.ts.map +1 -1
  55. package/dist/lib/engine/rest/insert.js +31 -18
  56. package/dist/lib/engine/rest/update.d.ts.map +1 -1
  57. package/dist/lib/engine/rest/update.js +34 -17
  58. package/dist/lib/engine/search/aggregations.d.ts +3 -3
  59. package/dist/lib/engine/search/aggregations.d.ts.map +1 -1
  60. package/dist/lib/engine/search/aggregations.js +20 -16
  61. package/dist/lib/engine/search/conditions.d.ts +9 -5
  62. package/dist/lib/engine/search/conditions.d.ts.map +1 -1
  63. package/dist/lib/engine/search/conditions.js +31 -20
  64. package/dist/lib/engine/search/fields.d.ts +44 -11
  65. package/dist/lib/engine/search/fields.d.ts.map +1 -1
  66. package/dist/lib/engine/search/fields.js +93 -27
  67. package/dist/lib/engine/search/join-families.d.ts +7 -7
  68. package/dist/lib/engine/search/join-families.d.ts.map +1 -1
  69. package/dist/lib/engine/search/join-families.js +84 -75
  70. package/dist/lib/engine/search/joins.d.ts +15 -7
  71. package/dist/lib/engine/search/joins.d.ts.map +1 -1
  72. package/dist/lib/engine/search/joins.js +23 -13
  73. package/dist/lib/engine/search/order-by.d.ts +11 -12
  74. package/dist/lib/engine/search/order-by.d.ts.map +1 -1
  75. package/dist/lib/engine/search/order-by.js +24 -28
  76. package/dist/lib/engine/search/search.d.ts.map +1 -1
  77. package/dist/lib/engine/search/search.js +111 -64
  78. package/dist/lib/engine/validate.d.ts +21 -3
  79. package/dist/lib/engine/validate.d.ts.map +1 -1
  80. package/dist/lib/engine/validate.js +106 -16
  81. package/dist/lib/engine/write-helpers.d.ts +69 -16
  82. package/dist/lib/engine/write-helpers.d.ts.map +1 -1
  83. package/dist/lib/engine/write-helpers.js +257 -105
  84. package/dist/lib/errors.d.ts +42 -10
  85. package/dist/lib/errors.d.ts.map +1 -1
  86. package/dist/lib/errors.js +69 -15
  87. package/dist/lib/nullable.d.ts +3 -2
  88. package/dist/lib/nullable.d.ts.map +1 -1
  89. package/dist/lib/nullable.js +14 -5
  90. package/dist/lib/read-access.d.ts +25 -16
  91. package/dist/lib/read-access.d.ts.map +1 -1
  92. package/dist/lib/read-access.js +33 -17
  93. package/dist/lib/schema/bulk-delete.d.ts +13 -7
  94. package/dist/lib/schema/bulk-delete.d.ts.map +1 -1
  95. package/dist/lib/schema/bulk-delete.js +18 -8
  96. package/dist/lib/schema/bulk-upsert.d.ts +3 -3
  97. package/dist/lib/schema/bulk-upsert.d.ts.map +1 -1
  98. package/dist/lib/schema/bulk-upsert.js +9 -14
  99. package/dist/lib/schema/get.d.ts +1 -1
  100. package/dist/lib/schema/get.d.ts.map +1 -1
  101. package/dist/lib/schema/get.js +2 -2
  102. package/dist/lib/schema/helpers.d.ts +41 -23
  103. package/dist/lib/schema/helpers.d.ts.map +1 -1
  104. package/dist/lib/schema/helpers.js +80 -33
  105. package/dist/lib/schema/insert.d.ts +1 -1
  106. package/dist/lib/schema/insert.d.ts.map +1 -1
  107. package/dist/lib/schema/insert.js +12 -20
  108. package/dist/lib/schema/search.d.ts +2 -13
  109. package/dist/lib/schema/search.d.ts.map +1 -1
  110. package/dist/lib/schema/search.js +64 -61
  111. package/dist/lib/schema/update.d.ts +1 -1
  112. package/dist/lib/schema/update.d.ts.map +1 -1
  113. package/dist/lib/schema/update.js +6 -13
  114. package/dist/lib/sql-api.d.ts +47 -25
  115. package/dist/lib/sql-api.d.ts.map +1 -1
  116. package/dist/lib/sql-api.js +70 -27
  117. package/dist/lib/table-helpers.d.ts +92 -14
  118. package/dist/lib/table-helpers.d.ts.map +1 -1
  119. package/dist/lib/table-helpers.js +367 -128
  120. package/dist/lib/tenant.d.ts +16 -22
  121. package/dist/lib/tenant.d.ts.map +1 -1
  122. package/dist/lib/tenant.js +38 -54
  123. package/dist/lib/write-access.d.ts +15 -9
  124. package/dist/lib/write-access.d.ts.map +1 -1
  125. package/dist/lib/write-access.js +12 -4
  126. package/dist/routes/auto/agent-manifest.routes.d.ts +1 -1
  127. package/dist/routes/auto/agent-manifest.routes.js +2 -2
  128. package/dist/routes/auto/bulk-delete.routes.d.ts +2 -2
  129. package/dist/routes/auto/bulk-delete.routes.d.ts.map +1 -1
  130. package/dist/routes/auto/bulk-delete.routes.js +1 -7
  131. package/dist/routes/auto/bulk-upsert.routes.d.ts +2 -2
  132. package/dist/routes/auto/bulk-upsert.routes.d.ts.map +1 -1
  133. package/dist/routes/auto/bulk-upsert.routes.js +2 -2
  134. package/dist/routes/auto/delete.routes.d.ts +2 -2
  135. package/dist/routes/auto/delete.routes.d.ts.map +1 -1
  136. package/dist/routes/auto/delete.routes.js +8 -10
  137. package/dist/routes/auto/get.routes.d.ts +2 -2
  138. package/dist/routes/auto/get.routes.d.ts.map +1 -1
  139. package/dist/routes/auto/get.routes.js +5 -5
  140. package/dist/routes/auto/insert.routes.d.ts +2 -2
  141. package/dist/routes/auto/insert.routes.d.ts.map +1 -1
  142. package/dist/routes/auto/insert.routes.js +1 -7
  143. package/dist/routes/auto/plugin.d.ts +6 -0
  144. package/dist/routes/auto/plugin.d.ts.map +1 -1
  145. package/dist/routes/auto/plugin.js +60 -36
  146. package/dist/routes/auto/route-helpers.d.ts +26 -12
  147. package/dist/routes/auto/route-helpers.d.ts.map +1 -1
  148. package/dist/routes/auto/route-helpers.js +50 -19
  149. package/dist/routes/auto/search.routes.d.ts +2 -2
  150. package/dist/routes/auto/search.routes.d.ts.map +1 -1
  151. package/dist/routes/auto/search.routes.js +36 -24
  152. package/dist/routes/auto/update.routes.d.ts +2 -2
  153. package/dist/routes/auto/update.routes.d.ts.map +1 -1
  154. package/dist/routes/auto/update.routes.js +1 -8
  155. package/dist/routes/sql-api-decorator.d.ts +30 -12
  156. package/dist/routes/sql-api-decorator.d.ts.map +1 -1
  157. package/dist/routes/sql-api-decorator.js +44 -27
  158. package/dist/types/cli.d.ts +17 -6
  159. package/dist/types/cli.d.ts.map +1 -1
  160. package/dist/types/computed.d.ts +1 -1
  161. package/dist/types/computed.d.ts.map +1 -1
  162. package/dist/types/conditions.d.ts +3 -1
  163. package/dist/types/conditions.d.ts.map +1 -1
  164. package/dist/types/db.d.ts +44 -4
  165. package/dist/types/db.d.ts.map +1 -1
  166. package/dist/types/dml.d.ts +26 -17
  167. package/dist/types/dml.d.ts.map +1 -1
  168. package/dist/types/hooks.d.ts +62 -0
  169. package/dist/types/hooks.d.ts.map +1 -0
  170. package/dist/types/hooks.js +1 -0
  171. package/dist/types/join.d.ts +25 -8
  172. package/dist/types/join.d.ts.map +1 -1
  173. package/dist/types/plugin.d.ts +58 -19
  174. package/dist/types/plugin.d.ts.map +1 -1
  175. package/dist/types/plugin.js +2 -0
  176. package/dist/types/request.d.ts +2 -2
  177. package/dist/types/schema.d.ts +3 -3
  178. package/dist/types/schema.d.ts.map +1 -1
  179. package/dist/types/search.d.ts +28 -13
  180. package/dist/types/search.d.ts.map +1 -1
  181. package/dist/types/search.js +2 -1
  182. package/dist/types/table.d.ts +109 -94
  183. package/dist/types/table.d.ts.map +1 -1
  184. package/dist/types/table.js +7 -2
  185. package/dist/types/tenant.d.ts +28 -2
  186. package/dist/types/tenant.d.ts.map +1 -1
  187. package/dist/types/tenant.js +7 -1
  188. package/dist/types/validation.d.ts +69 -13
  189. package/dist/types/validation.d.ts.map +1 -1
  190. package/dist/types.d.ts +1 -0
  191. package/dist/types.d.ts.map +1 -1
  192. package/dist/types.js +1 -0
  193. package/docs/GLOSSARY.md +11 -5
  194. package/docs/adr/0003-bulk-not-transactional.md +2 -1
  195. package/docs/adr/0006-raw-db-errors.md +2 -1
  196. package/docs/adr/0013-sanitized-db-errors.md +2 -1
  197. package/docs/adr/0014-what-follows-a-write-join.md +1 -1
  198. package/docs/adr/0022-stay-on-0x-while-every-consumer-is-first-party.md +88 -0
  199. package/docs/adr/0023-a-write-runs-in-a-transaction-or-not-at-all.md +60 -0
  200. package/docs/adr/0024-the-consumer-maps-driver-codes-through-dberrors.md +78 -0
  201. package/docs/adr/0025-validatebulk-replaces-validate-in-a-bulk-upsert.md +46 -0
  202. package/docs/adr/0026-update-carries-its-primary-key-in-main.md +43 -0
  203. package/docs/adr/0027-the-1-0-contract.md +74 -0
  204. package/docs/adr/0028-select-star-is-the-default-projection.md +64 -0
  205. package/docs/adr/0029-a-write-names-its-child-rows-by-action.md +96 -0
  206. package/docs/adr/0030-a-child-row-is-validated-by-its-own-table.md +117 -0
  207. package/docs/adr/0031-an-insert-excluded-upsert-key-addresses-an-existing-row.md +58 -0
  208. package/docs/adr/0032-tenant-scope-names-schema-fields.md +56 -0
  209. package/docs/adr/README.md +12 -1
  210. package/docs/upgrading/0.x.md +906 -0
  211. package/docs/upgrading/1.0.md +628 -0
  212. package/package.json +4 -5
@@ -1,7 +1,7 @@
1
1
  import type { ApiRequest } from '../types/request.js';
2
2
  import { QueryClient } from './db.js';
3
- import { type DialectName } from './dialect.js';
4
- import type { DbTables, Queryable, FilterRecord, SearchCondition, Paginator, JoinGroupRequest, JoinRefFilter, JoinFetchRequest, SearchResult, GetResult, InsertResult, UpdateResult, DeleteResult, BulkUpsertItem, BulkUpsertResult, BulkDeleteResult, TenantId } from '../types.js';
3
+ import type { DialectName } from './dialect.js';
4
+ import type { DbTables, Queryable, FilterRecord, SearchCondition, Paginator, ComputeRequest, JoinGroupRequest, JoinRefFilter, JoinFetchRequest, SearchResult, GetResult, InsertResult, UpdateResult, DeleteResult, BulkUpsertItem, BulkUpsertResult, BulkDeleteResult, PrimaryKeyValue, GetTenantId, WriteJoinSections } from '../types.js';
5
5
  export interface SqlApiSearchParams {
6
6
  filters?: FilterRecord;
7
7
  conditions?: SearchCondition[];
@@ -11,41 +11,63 @@ export interface SqlApiSearchParams {
11
11
  joinLeft?: Record<string, JoinFetchRequest>;
12
12
  orderBy?: string;
13
13
  paginator?: Paginator;
14
- computeMin?: string;
15
- computeMax?: string;
16
- computeSum?: string;
17
- computeAvg?: string;
18
- selectComputed?: string[];
14
+ /** Aggregates over all matching rows, by function (see SearchParams.compute). */
15
+ compute?: ComputeRequest;
16
+ /** Main fields to project, schema and computed alike (see SearchParams.select). */
17
+ select?: string[];
19
18
  /** Row cap for the main query when no paginator is provided (see SearchParams.maxRows). */
20
19
  maxRows?: number;
21
20
  }
22
- export interface SqlApiInsertParams {
23
- record: Record<string, unknown>;
24
- secondaries?: Record<string, Record<string, unknown>[]>;
21
+ /** The body of `POST /rest/:table`: the main row and the child rows to `upsert` or `replace`. */
22
+ export interface SqlApiInsertParams extends Omit<WriteJoinSections, 'delete'> {
23
+ main: Record<string, unknown>;
25
24
  }
26
- export interface SqlApiUpdateParams {
27
- record: Record<string, unknown>;
28
- secondaries?: Record<string, Record<string, unknown>[]>;
29
- deletions?: Record<string, Record<string, unknown>[]>;
25
+ /** The body of `PUT /rest/:table`: the main row (with its PK) and the child rows to `upsert`, `delete` or `replace`. */
26
+ export interface SqlApiUpdateParams extends WriteJoinSections {
27
+ main: Record<string, unknown>;
28
+ }
29
+ /**
30
+ * The body of `POST /bulk/:table/delete`: the primary keys to delete — values for a
31
+ * single-column key, objects naming every key field for a composite one.
32
+ */
33
+ export interface SqlApiBulkDeleteParams {
34
+ ids: PrimaryKeyValue[];
30
35
  }
31
36
  export interface SqlApiOptions {
37
+ /**
38
+ * The dialect of a raw pool, `postgres` by default as in the plugin. Refused beside a
39
+ * QueryClient, which carries its own: two sources could disagree.
40
+ */
32
41
  dialect?: DialectName;
33
- getTenantId?: (request: ApiRequest) => TenantId | TenantId[] | null | undefined | Promise<TenantId | TenantId[] | null | undefined>;
42
+ /** As on the plugin: a tenant id or several, `TENANT_ADMIN` for no filter, `null`/`undefined` → 401. */
43
+ getTenantId?: GetTenantId;
34
44
  }
35
- export declare class SqlApi {
45
+ /** A table name of `T`: a literal key when `createSqlApi` was given a typed map, otherwise any string. */
46
+ type TableKey<T extends DbTables> = keyof T & string;
47
+ /**
48
+ * The programmatic API over one `dbTables` map. `T` is that map's type, inferred by
49
+ * `createSqlApi`, so a misspelled table name fails at compile time; `app.sqlApi` is typed
50
+ * over plain `DbTables` and takes any string.
51
+ */
52
+ export declare class SqlApi<T extends DbTables = DbTables> {
36
53
  private dbTables;
37
54
  private options;
38
55
  private db;
39
- constructor(dbOrPool: QueryClient | Queryable, dbTables: DbTables, options?: SqlApiOptions);
56
+ constructor(dbOrPool: QueryClient | Queryable, dbTables: T, options?: SqlApiOptions);
57
+ /**
58
+ * The config of `tableName`. An unknown name is the caller's bug — the routes only ever pass
59
+ * the keys they were built from — so it is a plain Error (500), not a client 400.
60
+ */
40
61
  private getTableConf;
41
62
  private getTenant;
42
- search(tableName: string, params?: SqlApiSearchParams, request?: ApiRequest): Promise<SearchResult>;
43
- get(tableName: string, id: string | number, request?: ApiRequest): Promise<GetResult>;
44
- insert(tableName: string, params: SqlApiInsertParams, request?: ApiRequest): Promise<InsertResult>;
45
- update(tableName: string, params: SqlApiUpdateParams, request?: ApiRequest): Promise<UpdateResult>;
46
- delete(tableName: string, id: string | number, request?: ApiRequest): Promise<DeleteResult>;
47
- bulkUpsert(tableName: string, items: BulkUpsertItem[], request?: ApiRequest): Promise<BulkUpsertResult[]>;
48
- bulkDelete(tableName: string, ids: (string | number)[], request?: ApiRequest): Promise<BulkDeleteResult[]>;
63
+ search(tableName: TableKey<T>, params?: SqlApiSearchParams, request?: ApiRequest): Promise<SearchResult>;
64
+ get(tableName: TableKey<T>, id: string | number, request?: ApiRequest): Promise<GetResult>;
65
+ insert(tableName: TableKey<T>, params: SqlApiInsertParams, request?: ApiRequest): Promise<InsertResult>;
66
+ update(tableName: TableKey<T>, params: SqlApiUpdateParams, request?: ApiRequest): Promise<UpdateResult>;
67
+ delete(tableName: TableKey<T>, id: string | number, request?: ApiRequest): Promise<DeleteResult>;
68
+ bulkUpsert(tableName: TableKey<T>, items: BulkUpsertItem[], request?: ApiRequest): Promise<BulkUpsertResult[]>;
69
+ bulkDelete(tableName: TableKey<T>, params: SqlApiBulkDeleteParams, request?: ApiRequest): Promise<BulkDeleteResult[]>;
49
70
  }
50
- export declare function createSqlApi(dbOrPool: QueryClient | Queryable, dbTables: DbTables, options?: SqlApiOptions): SqlApi;
71
+ export declare function createSqlApi<T extends DbTables>(dbOrPool: QueryClient | Queryable, dbTables: T, options?: SqlApiOptions): SqlApi<T>;
72
+ export {};
51
73
  //# sourceMappingURL=sql-api.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"sql-api.d.ts","sourceRoot":"","sources":["../../src/lib/sql-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEtD,OAAO,EAAqB,WAAW,EAAE,MAAM,SAAS,CAAC;AACzD,OAAO,EAAc,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AAU5D,OAAO,KAAK,EACV,QAAQ,EACR,SAAS,EACT,YAAY,EACZ,eAAe,EACf,SAAS,EACT,gBAAgB,EAChB,aAAa,EACb,gBAAgB,EAChB,YAAY,EACZ,SAAS,EACT,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,QAAQ,EAET,MAAM,aAAa,CAAC;AAIrB,MAAM,WAAW,kBAAkB;IACjC,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,UAAU,CAAC,EAAE,eAAe,EAAE,CAAC;IAC/B,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC9C,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAChD,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAC7C,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,2FAA2F;IAC3F,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC;CACzD;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC;IACxD,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC;CACvD;AAID,MAAM,WAAW,aAAa;IAC5B,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,UAAU,KAAK,QAAQ,GAAG,QAAQ,EAAE,GAAG,IAAI,GAAG,SAAS,GAC3E,OAAO,CAAC,QAAQ,GAAG,QAAQ,EAAE,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC;CACvD;AAED,qBAAa,MAAM;IAKf,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,OAAO;IALjB,OAAO,CAAC,EAAE,CAAc;gBAGtB,QAAQ,EAAE,WAAW,GAAG,SAAS,EACzB,QAAQ,EAAE,QAAQ,EAClB,OAAO,GAAE,aAAkB;IAgBrC,OAAO,CAAC,YAAY;YAMN,SAAS;IAUjB,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,GAAE,kBAAuB,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC;IAyBvG,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC;IAMrF,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC;IAclG,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC;IAelG,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC;IAM3F,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,cAAc,EAAE,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAazG,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;CAKjH;AAED,wBAAgB,YAAY,CAAC,QAAQ,EAAE,WAAW,GAAG,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,MAAM,CAEnH"}
1
+ {"version":3,"file":"sql-api.d.ts","sourceRoot":"","sources":["../../src/lib/sql-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEtD,OAAO,EAAqB,WAAW,EAAE,MAAM,SAAS,CAAC;AACzD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAYhD,OAAO,KAAK,EACV,QAAQ,EAER,SAAS,EACT,YAAY,EACZ,eAAe,EACf,SAAS,EACT,cAAc,EACd,gBAAgB,EAChB,aAAa,EACb,gBAAgB,EAChB,YAAY,EACZ,SAAS,EACT,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,eAAe,EACf,WAAW,EAEX,iBAAiB,EAClB,MAAM,aAAa,CAAC;AAIrB,MAAM,WAAW,kBAAkB;IACjC,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,UAAU,CAAC,EAAE,eAAe,EAAE,CAAC;IAC/B,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC9C,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAChD,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAC7C,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,iFAAiF;IACjF,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,mFAAmF;IACnF,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,2FAA2F;IAC3F,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,iGAAiG;AACjG,MAAM,WAAW,kBAAmB,SAAQ,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAC;IAC3E,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/B;AAED,wHAAwH;AACxH,MAAM,WAAW,kBAAmB,SAAQ,iBAAiB;IAC3D,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,GAAG,EAAE,eAAe,EAAE,CAAC;CACxB;AAoCD,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,wGAAwG;IACxG,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED,0GAA0G;AAC1G,KAAK,QAAQ,CAAC,CAAC,SAAS,QAAQ,IAAI,MAAM,CAAC,GAAG,MAAM,CAAC;AAErD;;;;GAIG;AACH,qBAAa,MAAM,CAAC,CAAC,SAAS,QAAQ,GAAG,QAAQ;IAK7C,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,OAAO;IALjB,OAAO,CAAC,EAAE,CAAc;gBAGtB,QAAQ,EAAE,WAAW,GAAG,SAAS,EACzB,QAAQ,EAAE,CAAC,EACX,OAAO,GAAE,aAAkB;IAwBrC;;;OAGG;IACH,OAAO,CAAC,YAAY;YASN,SAAS;IAUjB,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,MAAM,GAAE,kBAAuB,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC;IAuB5G,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC;IAM1F,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC;IAevG,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC;IAgBvG,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC;IAMhG,UAAU,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,cAAc,EAAE,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAc9G,UAAU,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;CAM5H;AAED,wBAAgB,YAAY,CAAC,CAAC,SAAS,QAAQ,EAC7C,QAAQ,EAAE,WAAW,GAAG,SAAS,EACjC,QAAQ,EAAE,CAAC,EACX,OAAO,CAAC,EAAE,aAAa,GACtB,MAAM,CAAC,CAAC,CAAC,CAEX"}
@@ -1,15 +1,47 @@
1
1
  import { ConditionBuilder } from 'node-condition-builder';
2
2
  import { createQueryClient, QueryClient } from './db.js';
3
- import { getDialect } from './dialect.js';
4
3
  import { resolveTenant } from './tenant.js';
5
- import { httpError } from './errors.js';
4
+ import { validateDbTables } from './table-helpers.js';
6
5
  import { searchEngine } from './engine/search/search.js';
6
+ import { rejectRetiredSearchKeys } from './engine/search/fields.js';
7
+ import { rejectRetiredWriteKeys } from './engine/write-helpers.js';
7
8
  import { getEngine } from './engine/rest/get.js';
8
9
  import { insertEngine } from './engine/rest/insert.js';
9
10
  import { updateEngine } from './engine/rest/update.js';
10
11
  import { deleteEngine } from './engine/rest/delete.js';
11
12
  import { bulkUpsertEngine } from './engine/bulk/bulk-upsert.js';
12
13
  import { bulkDeleteEngine } from './engine/bulk/bulk-delete.js';
14
+ /**
15
+ * The ids of a bulk delete's params. A JavaScript caller can still pass the pre-1.0 bare
16
+ * array: refused, naming the key, before any SQL.
17
+ */
18
+ function idsOf(tableName, params) {
19
+ const ids = Array.isArray(params) ? undefined : params?.ids;
20
+ if (!Array.isArray(ids)) {
21
+ throw new TypeError(`sqlApi.bulkDelete('${tableName}'): the ids go under \`ids\`, as in the HTTP body` +
22
+ (Array.isArray(params) ? ' (a bare array was the pre-1.0 form)' : ''));
23
+ }
24
+ return ids;
25
+ }
26
+ /**
27
+ * The main row of a write's params. A JavaScript caller can still send the pre-1.0 key
28
+ * `record`, which would otherwise write an empty row or miss the one to update: refused,
29
+ * naming the key, before any SQL.
30
+ */
31
+ function mainOf(method, tableName, params) {
32
+ rejectRetiredWriteKeys(params ?? {});
33
+ const main = params?.main;
34
+ if (main === null || typeof main !== 'object' || Array.isArray(main)) {
35
+ throw new TypeError(`sqlApi.${method}('${tableName}'): the main row goes under \`main\`, as in the HTTP body` +
36
+ ('record' in (params ?? {}) ? ' (`record` was renamed `main`)' : ''));
37
+ }
38
+ return main;
39
+ }
40
+ /**
41
+ * The programmatic API over one `dbTables` map. `T` is that map's type, inferred by
42
+ * `createSqlApi`, so a misspelled table name fails at compile time; `app.sqlApi` is typed
43
+ * over plain `DbTables` and takes any string.
44
+ */
13
45
  export class SqlApi {
14
46
  dbTables;
15
47
  options;
@@ -17,32 +49,42 @@ export class SqlApi {
17
49
  constructor(dbOrPool, dbTables, options = {}) {
18
50
  this.dbTables = dbTables;
19
51
  this.options = options;
20
- // Accept either a QueryClient or a raw Queryable pool
52
+ // One source for the dialect: the QueryClient's own, or the option for a raw pool.
21
53
  if (dbOrPool instanceof QueryClient) {
54
+ if (options.dialect !== undefined) {
55
+ throw new TypeError(`createSqlApi: the QueryClient already carries its dialect ('${dbOrPool.dialectName}'), ` +
56
+ `drop the 'dialect' option — it is for a raw pool only`);
57
+ }
22
58
  this.db = dbOrPool;
23
59
  }
24
60
  else {
25
61
  this.db = createQueryClient(dbOrPool, options.dialect);
26
62
  }
27
- // Set ConditionBuilder dialect (used by filters built via exportTableInfo)
28
- if (options.dialect) {
29
- const dialect = getDialect(options.dialect);
30
- ConditionBuilder.DIALECT = dialect.cbDialect;
31
- }
63
+ // A config in the pre-1.0 shape, or a relation whose target cannot be resolved, is a
64
+ // configuration error: fail here, with the table's name, rather than on the first request.
65
+ validateDbTables(dbTables);
66
+ // The global ConditionBuilder dialect, which a builder created without one (in an
67
+ // `extendedCondition`) uses, follows the dialect the queries run on.
68
+ ConditionBuilder.DIALECT = this.db.cbDialect;
32
69
  }
70
+ /**
71
+ * The config of `tableName`. An unknown name is the caller's bug — the routes only ever pass
72
+ * the keys they were built from — so it is a plain Error (500), not a client 400.
73
+ */
33
74
  getTableConf(tableName) {
34
- const conf = this.dbTables[tableName];
35
- if (!conf)
36
- throw httpError(400, `Table "${tableName}" not found in DbTables`);
37
- return conf;
75
+ if (!Object.hasOwn(this.dbTables, tableName)) {
76
+ throw new Error(`sqlApi: table '${tableName}' is not a key of dbTables. Known: ${Object.keys(this.dbTables).join(', ')}`);
77
+ }
78
+ return this.dbTables[tableName];
38
79
  }
39
80
  async getTenant(tableName, request) {
40
81
  if (!request || !this.options.getTenantId)
41
82
  return undefined;
42
83
  const tableConf = this.getTableConf(tableName);
43
- return resolveTenant({ DbTables: this.dbTables, getTenantId: this.options.getTenantId }, tableConf, request);
84
+ return resolveTenant({ dbTables: this.dbTables, getTenantId: this.options.getTenantId }, tableConf, request);
44
85
  }
45
86
  async search(tableName, params = {}, request) {
87
+ rejectRetiredSearchKeys(params);
46
88
  const tableConf = this.getTableConf(tableName);
47
89
  const tenant = await this.getTenant(tableName, request);
48
90
  return searchEngine(this.dbTables, {
@@ -56,11 +98,8 @@ export class SqlApi {
56
98
  joinLeft: params.joinLeft,
57
99
  orderBy: params.orderBy,
58
100
  paginator: params.paginator,
59
- computeMin: params.computeMin,
60
- computeMax: params.computeMax,
61
- computeSum: params.computeSum,
62
- computeAvg: params.computeAvg,
63
- selectComputed: params.selectComputed,
101
+ compute: params.compute,
102
+ select: params.select,
64
103
  maxRows: params.maxRows,
65
104
  tenant,
66
105
  request,
@@ -78,9 +117,10 @@ export class SqlApi {
78
117
  db: this.db,
79
118
  tableConf,
80
119
  dbTables: this.dbTables,
81
- request: request,
82
- record: params.record,
83
- secondaries: params.secondaries,
120
+ request,
121
+ record: mainOf('insert', tableName, params),
122
+ upsert: params.upsert,
123
+ replace: params.replace,
84
124
  tenant,
85
125
  });
86
126
  }
@@ -91,10 +131,11 @@ export class SqlApi {
91
131
  db: this.db,
92
132
  tableConf,
93
133
  dbTables: this.dbTables,
94
- request: request,
95
- record: params.record,
96
- secondaries: params.secondaries,
97
- deletions: params.deletions,
134
+ request,
135
+ record: mainOf('update', tableName, params),
136
+ upsert: params.upsert,
137
+ delete: params.delete,
138
+ replace: params.replace,
98
139
  tenant,
99
140
  });
100
141
  }
@@ -106,16 +147,18 @@ export class SqlApi {
106
147
  async bulkUpsert(tableName, items, request) {
107
148
  const tableConf = this.getTableConf(tableName);
108
149
  const tenant = await this.getTenant(tableName, request);
150
+ items.forEach((item, i) => rejectRetiredWriteKeys(item ?? {}, String(i)));
109
151
  return bulkUpsertEngine({
110
152
  db: this.db,
111
153
  tableConf,
112
154
  dbTables: this.dbTables,
113
- request: request,
155
+ request,
114
156
  items,
115
157
  tenant,
116
158
  });
117
159
  }
118
- async bulkDelete(tableName, ids, request) {
160
+ async bulkDelete(tableName, params, request) {
161
+ const ids = idsOf(tableName, params);
119
162
  const tableConf = this.getTableConf(tableName);
120
163
  const tenant = await this.getTenant(tableName, request);
121
164
  return bulkDeleteEngine({ db: this.db, tableConf, ids, tenant, request });
@@ -1,24 +1,69 @@
1
- import { ConditionBuilder, type ConditionValueOrUndefined } from 'node-condition-builder';
2
- import { type TSchema, type TObject } from '@sinclair/typebox';
3
- import type { SchemaDefinition, JoinDefinition, TableFilterFn, ITable } from '../types.js';
1
+ import { ConditionBuilder, type ConditionValueOrUndefined, type DialectName as CbDialect } from 'node-condition-builder';
2
+ import { type TSchema, type TObject } from 'typebox';
3
+ import type { SchemaDefinition, JoinDefinition, FilterRecord, TableConfig, DbTables, TenantScope, ExtendedConditionContext } from '../types.js';
4
4
  type ExtraProps<EF> = EF extends TObject<infer P> ? P : EF extends Record<string, TSchema> ? EF : Record<string, never>;
5
- export declare function exportTableInfo<F extends Record<string, TSchema>, EF extends TObject | Record<string, TSchema> = Record<never, TSchema>>(Schema: SchemaDefinition<F>, extraFilters?: EF, extendedCondition?: (condition: ConditionBuilder, filters: {
6
- [K in keyof F | keyof ExtraProps<EF>]?: ConditionValueOrUndefined;
7
- }) => void): {
8
- Schema: SchemaDefinition<F>;
9
- filters: TableFilterFn;
10
- extraFilters: Record<string, TSchema>;
5
+ /**
6
+ * What `defineTable` takes: a {@link TableConfig} whose `extendedCondition` sees the filter
7
+ * values typed by the schema fields and the `extraFilters`.
8
+ */
9
+ export type TableDefinition<F extends Record<string, TSchema>, EF extends TObject | Record<string, TSchema> = Record<never, TSchema>> = Omit<TableConfig<F>, 'extraFilters' | 'extendedCondition'> & {
10
+ extraFilters?: EF;
11
+ extendedCondition?: (condition: ConditionBuilder, filters: {
12
+ [K in keyof F | keyof ExtraProps<EF>]?: ConditionValueOrUndefined;
13
+ }, ctx: ExtendedConditionContext<F>) => void;
11
14
  };
12
- export declare function defineTable<F extends Record<string, TSchema>>(config: ITable<F>): ITable<F>;
15
+ /**
16
+ * The WHERE ConditionBuilder for a table's `filters`: equality on every schema field the
17
+ * values carry (an explicit `null` is `IS NULL`), then the table's `extendedCondition`, which
18
+ * alone gives `extraFilters` a meaning.
19
+ *
20
+ * `dialect` selects identifier quoting (the engines pass the one of the QueryClient running
21
+ * the query). `qualifier` is the raw table name or alias the columns are prefixed with; it
22
+ * defaults to the table's own name, and the engines pass an alias when the condition lands
23
+ * inside a correlated subquery whose FROM is aliased — there the bare table name would
24
+ * resolve against the OUTER query.
25
+ */
26
+ export declare function buildTableFilters(tableConf: TableConfig, filterValues: FilterRecord, dialect?: CbDialect, qualifier?: string): ConditionBuilder;
27
+ export declare function defineTable<F extends Record<string, TSchema>, EF extends TObject | Record<string, TSchema> = Record<never, TSchema>>(definition: TableDefinition<F, EF>): TableConfig<F>;
28
+ /** One term of an order string in its 1-part form: `field [ASC|DESC]`. */
29
+ export declare const PLAIN_ORDER_TERM: RegExp;
30
+ /**
31
+ * Why one term of a `defaultOrder` is not valid on `tableConf`, or null when it is a schema
32
+ * field or a computed field with an optional direction — the grammar of a 1-part request
33
+ * `orderBy`. The dotted notations stay request-only: the default applies to requests that carry
34
+ * no join. Nothing else is accepted, since nothing reaches the SQL as written: an expression is
35
+ * declared as a computed field and ordered by its name.
36
+ */
37
+ export declare function defaultOrderTermProblem(term: string, tableConf: TableConfig): string | null;
38
+ /** The error for a `defaultOrder` term `defaultOrderTermProblem` refused; `where` names the caller. */
39
+ export declare function defaultOrderError(where: string, term: string, tableConf: TableConfig, problem: string): Error;
40
+ /**
41
+ * A table's `tenantScope` with every name resolved to its column, the form the SQL needs. Each
42
+ * name goes through the schema of the table it lives on: `column`, `anyOf` and
43
+ * `through.localField` through the table's own; the `column` and `through.foreignField` of an
44
+ * indirect scope through `through.schema`, the parent's.
45
+ */
46
+ export declare function resolvedTenantScope(tableConf: TableConfig | undefined): TenantScope | undefined;
13
47
  export interface BuildRelationOptions {
14
48
  alias?: string;
15
- selection?: string;
49
+ /**
50
+ * Default fields of the joined rows, when the request names none. Absent, every readable
51
+ * field. Each must be a field of the joined schema (of `fields`, when given).
52
+ */
53
+ select?: string[];
16
54
  unique?: boolean;
55
+ /**
56
+ * The `dbTables` key whose config governs the joined table. Needed only when the joined
57
+ * table sits under several keys, each with its own `readExclude`, `tenantScope` or hooks:
58
+ * then the relation must say which one applies, and startup fails until it does. With a
59
+ * single key over the table, that config is used whatever the key is called.
60
+ */
61
+ target?: string;
17
62
  /**
18
63
  * Allowlist of the target table's fields reachable through this relation.
19
64
  *
20
65
  * The relation is declared against a schema narrowed to these fields, so every read
21
- * surface — `selection`, `filters`, `conditions`, `orderBy`, aggregations, and the
66
+ * surface — `select`, `filters`, `conditions`, `orderBy`, aggregations, and the
22
67
  * generated request/response schemas — rejects anything outside the list with
23
68
  * `400 Unknown field`. Use it to expose a table broadly while keeping some of its
24
69
  * columns out of one relation, without hiding them from the table's own routes the way
@@ -29,9 +74,42 @@ export interface BuildRelationOptions {
29
74
  * join.
30
75
  */
31
76
  fields?: string[];
77
+ /**
78
+ * Upsert the secondaries this relation writes on this key of the joined table (fields):
79
+ * `INSERT … ON CONFLICT (<key>) DO UPDATE`. Absent, they are plain INSERTs. Must be the
80
+ * joined schema's primary key or one of its `uniqueKeys` (checked by `defineTable`), and is
81
+ * for a relation in `writeJoins` only.
82
+ */
83
+ upsertKey?: string[];
32
84
  }
33
85
  export declare function buildRelation<M extends Record<string, TSchema>, J extends Record<string, TSchema>>(mainSchema: SchemaDefinition<M>, mainField: string & keyof M | (string & keyof M)[], joinSchema: SchemaDefinition<J>, joinField: string & keyof J, options?: BuildRelationOptions): JoinDefinition;
34
- export declare function buildUpsertRule<F extends Record<string, TSchema>>(schema: SchemaDefinition<F>, columns: (string & keyof F)[]): [SchemaDefinition, string[]];
35
- export declare function buildUpsertRules(...rules: [SchemaDefinition, string[]][]): Map<SchemaDefinition, string[]>;
86
+ /**
87
+ * The `TableConfig` that governs the target of a relation.
88
+ *
89
+ * A relation is declared against a Schema, while `dbTables` is keyed by route name and may
90
+ * expose one physical table under several keys, each with its own `readExclude`, `tenantScope`,
91
+ * `afterRead` and write-side rules (ADR 0010 makes those follow a join). Which key governs a
92
+ * join must therefore be one rule, shared by the generated body schemas and the engines — a
93
+ * body schema built from one config and an engine running another would advertise fields the
94
+ * engine hides, or the reverse.
95
+ *
96
+ * - `target` set: that key, which must exist and must be a config over the joined table.
97
+ * - Otherwise exactly one key over the joined table: that config, whatever the key is called.
98
+ * - Several keys and no `target`: a configuration error. Picking the first would make the
99
+ * outcome depend on object key order, and the keys differ precisely in what they hide.
100
+ * - No key at all: `undefined` — the joined table has no config, and no rule applies to it.
101
+ *
102
+ * Throws on a configuration error; `validateJoinTargets` runs it over every relation at
103
+ * startup so the error names the table and surfaces before the first request.
104
+ */
105
+ export declare function resolveJoinTableConf(dbTables: DbTables, joinDef: JoinDefinition): TableConfig | undefined;
106
+ /**
107
+ * Startup check of a whole `dbTables` map, run by the plugin and by `createSqlApi`: every
108
+ * entry has the 1.0 config shape — an entry written by hand, not through `defineTable`, would
109
+ * otherwise reach the engines in the pre-1.0 shape — and the target of every read and write
110
+ * relation resolves, so a broken one fails with the host table's name rather than on the
111
+ * first request that uses it.
112
+ */
113
+ export declare function validateDbTables(dbTables: DbTables): void;
36
114
  export {};
37
115
  //# sourceMappingURL=table-helpers.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"table-helpers.d.ts","sourceRoot":"","sources":["../../src/lib/table-helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,KAAK,yBAAyB,EAAiC,MAAM,wBAAwB,CAAC;AACzH,OAAO,EAAQ,KAAK,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,KAAK,EACV,gBAAgB,EAChB,cAAc,EACd,aAAa,EACb,MAAM,EAEP,MAAM,aAAa,CAAC;AAcrB,KAAK,UAAU,CAAC,EAAE,IAAI,EAAE,SAAS,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAExH,wBAAgB,eAAe,CAC7B,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACjC,EAAE,SAAS,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,EAErE,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAC3B,YAAY,GAAE,EAAa,EAC3B,iBAAiB,CAAC,EAAE,CAClB,SAAS,EAAE,gBAAgB,EAC3B,OAAO,EAAE;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,yBAAyB;CAAE,KAC3E,IAAI,GACR;IAAE,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC;IAAC,OAAO,EAAE,aAAa,CAAC;IAAC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAAE,CAsChG;AAED,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC3D,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,GAChB,MAAM,CAAC,CAAC,CAAC,CAYX;AAmVD,MAAM,WAAW,oBAAoB;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAgDD,wBAAgB,aAAa,CAC3B,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACjC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAEjC,UAAU,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAC/B,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC,EAAE,EAClD,UAAU,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAC/B,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC,EAC3B,OAAO,CAAC,EAAE,oBAAoB,GAC7B,cAAc,CAWhB;AAED,wBAAgB,eAAe,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/D,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAC3B,OAAO,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC,EAAE,GAC5B,CAAC,gBAAgB,EAAE,MAAM,EAAE,CAAC,CAE9B;AAED,wBAAgB,gBAAgB,CAC9B,GAAG,KAAK,EAAE,CAAC,gBAAgB,EAAE,MAAM,EAAE,CAAC,EAAE,GACvC,GAAG,CAAC,gBAAgB,EAAE,MAAM,EAAE,CAAC,CAEjC"}
1
+ {"version":3,"file":"table-helpers.d.ts","sourceRoot":"","sources":["../../src/lib/table-helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,KAAK,yBAAyB,EAAE,KAAK,WAAW,IAAI,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACzH,OAAO,EAAQ,KAAK,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,SAAS,CAAC;AAC3D,OAAO,KAAK,EACV,gBAAgB,EAChB,cAAc,EACd,YAAY,EACZ,WAAW,EACX,QAAQ,EACR,WAAW,EACX,wBAAwB,EACzB,MAAM,aAAa,CAAC;AAcrB,KAAK,UAAU,CAAC,EAAE,IAAI,EAAE,SAAS,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAExH;;;GAGG;AACH,MAAM,MAAM,eAAe,CACzB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACjC,EAAE,SAAS,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,IACnE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,cAAc,GAAG,mBAAmB,CAAC,GAAG;IAC/D,YAAY,CAAC,EAAE,EAAE,CAAC;IAClB,iBAAiB,CAAC,EAAE,CAClB,SAAS,EAAE,gBAAgB,EAC3B,OAAO,EAAE;SAAG,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,yBAAyB;KAAE,EAC9E,GAAG,EAAE,wBAAwB,CAAC,CAAC,CAAC,KAC7B,IAAI,CAAC;CACX,CAAC;AAEF;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,WAAW,EACtB,YAAY,EAAE,YAAY,EAC1B,OAAO,CAAC,EAAE,SAAS,EACnB,SAAS,CAAC,EAAE,MAAM,GACjB,gBAAgB,CAuClB;AAED,wBAAgB,WAAW,CACzB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACjC,EAAE,SAAS,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,EACrE,UAAU,EAAE,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAgBpD;AAED,0EAA0E;AAC1E,eAAO,MAAM,gBAAgB,QAA+B,CAAC;AAE7D;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,WAAW,GAAG,MAAM,GAAG,IAAI,CAe3F;AAED,uGAAuG;AACvG,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,GAAG,KAAK,CAE7G;AA2DD;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,WAAW,GAAG,SAAS,GAAG,WAAW,GAAG,SAAS,CAe/F;AA4VD,MAAM,WAAW,oBAAoB;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AA2FD,wBAAgB,aAAa,CAC3B,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACjC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAEjC,UAAU,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAC/B,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC,EAAE,EAClD,UAAU,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAC/B,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC,EAC3B,OAAO,CAAC,EAAE,oBAAoB,GAC7B,cAAc,CAgBhB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,cAAc,GAAG,WAAW,GAAG,SAAS,CAyBzG;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAczD"}