@svgrid/enterprise 1.2.0 → 2.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 (159) hide show
  1. package/dist/cdn/svgrid-enterprise.svelte-external.js +26039 -805
  2. package/dist/designer/assets/index-Dp44bTid.js +939 -0
  3. package/dist/designer/assets/index-RJp6x8tw.css +1 -0
  4. package/dist/designer/assets/jszip.min-CjMo-QGg.js +2 -0
  5. package/dist/designer/index.html +13 -0
  6. package/dist/node/studio.js +22554 -0
  7. package/package.json +10 -3
  8. package/src/SvAuthGate.svelte +115 -0
  9. package/src/SvBoard.dom.test.ts +67 -0
  10. package/src/SvBoard.svelte +192 -0
  11. package/src/SvExportMenu.svelte +553 -0
  12. package/src/SvFileInput.svelte +113 -0
  13. package/src/SvGridEditPanel.dom.test.ts +146 -0
  14. package/src/SvGridEditPanel.svelte +793 -0
  15. package/src/SvGridMasterDetail.svelte +95 -0
  16. package/src/SvImportDialog.svelte +1020 -0
  17. package/src/SvLookupInput.svelte +180 -0
  18. package/src/SvRecordDetail.dom.test.ts +137 -0
  19. package/src/SvRecordDetail.svelte +288 -0
  20. package/src/SvSchedule.dom.test.ts +57 -0
  21. package/src/SvSchedule.svelte +156 -0
  22. package/src/SvSchemaChart.svelte +233 -0
  23. package/src/SvSchemaDashboard.svelte +130 -0
  24. package/src/ai-export-pdf.test.ts +74 -0
  25. package/src/ai-export-xlsx.test.ts +87 -0
  26. package/src/ai-export.test.ts +110 -0
  27. package/src/ai.ts +1188 -782
  28. package/src/edit-panel.test.ts +213 -0
  29. package/src/edit-panel.ts +228 -0
  30. package/src/export-conditional.test.ts +60 -0
  31. package/src/export-conditional.ts +94 -0
  32. package/src/export-ooxml.test.ts +152 -0
  33. package/src/export-ooxml.ts +485 -0
  34. package/src/export-pdf.test.ts +138 -0
  35. package/src/export-pdf.ts +245 -0
  36. package/src/export-print.test.ts +66 -0
  37. package/src/export-print.ts +132 -0
  38. package/src/export-serialize.test.ts +56 -0
  39. package/src/export-serialize.ts +24 -0
  40. package/src/export-xls.ts +196 -0
  41. package/src/export-xlsx-roundtrip.test.ts +120 -0
  42. package/src/export-xlsx.test.ts +150 -0
  43. package/src/export.test.ts +349 -0
  44. package/src/export.ts +1452 -549
  45. package/src/import-automap.test.ts +131 -0
  46. package/src/import-hardening.test.ts +158 -0
  47. package/src/import.ts +1042 -648
  48. package/src/index.ts +282 -0
  49. package/src/install.ts +134 -114
  50. package/src/license-core.test.ts +23 -0
  51. package/src/license-core.ts +35 -0
  52. package/src/license.ts +103 -90
  53. package/src/master-detail.test.ts +61 -0
  54. package/src/master-detail.ts +42 -0
  55. package/src/print.ts +107 -127
  56. package/src/schema-designer.test.ts +121 -0
  57. package/src/schema-designer.ts +142 -0
  58. package/src/schema.test.ts +268 -0
  59. package/src/schema.ts +499 -0
  60. package/src/smart-shim.ts +107 -105
  61. package/src/sources/aggregate.test.ts +79 -0
  62. package/src/sources/aggregate.ts +102 -0
  63. package/src/sources/auth-supabase.test.ts +80 -0
  64. package/src/sources/auth-supabase.ts +87 -0
  65. package/src/sources/dashboard.kpi.test.ts +50 -0
  66. package/src/sources/dashboard.test.ts +61 -0
  67. package/src/sources/dashboard.ts +136 -0
  68. package/src/sources/field-inference.test.ts +60 -0
  69. package/src/sources/field-inference.ts +63 -0
  70. package/src/sources/filters.test.ts +58 -0
  71. package/src/sources/filters.ts +64 -0
  72. package/src/sources/index.ts +67 -0
  73. package/src/sources/introspect-supabase.test.ts +100 -0
  74. package/src/sources/introspect-supabase.ts +119 -0
  75. package/src/sources/realtime-supabase.test.ts +93 -0
  76. package/src/sources/realtime-supabase.ts +99 -0
  77. package/src/sources/relation-lookup.test.ts +99 -0
  78. package/src/sources/relation-lookup.ts +128 -0
  79. package/src/sources/rest-adapters.test.ts +95 -0
  80. package/src/sources/rest-adapters.ts +120 -0
  81. package/src/sources/rest.test.ts +104 -0
  82. package/src/sources/rest.ts +129 -0
  83. package/src/sources/schema-from-columns.test.ts +106 -0
  84. package/src/sources/schema-from-columns.ts +88 -0
  85. package/src/sources/supabase.test.ts +110 -0
  86. package/src/sources/supabase.ts +99 -0
  87. package/src/sources/with-entity-rules.test.ts +104 -0
  88. package/src/sources/with-entity-rules.ts +78 -0
  89. package/src/sources/with-relation-labels.test.ts +75 -0
  90. package/src/sources/with-relation-labels.ts +73 -0
  91. package/src/studio/bug-report.test.ts +101 -0
  92. package/src/studio/bug-report.ts +165 -0
  93. package/src/studio/cli.test.ts +187 -0
  94. package/src/studio/cli.ts +112 -0
  95. package/src/studio/csv.test.ts +90 -0
  96. package/src/studio/csv.ts +165 -0
  97. package/src/studio/db-connect-string.test.ts +94 -0
  98. package/src/studio/db-connect-string.ts +128 -0
  99. package/src/studio/emit-project.test.ts +923 -0
  100. package/src/studio/emit-project.ts +1273 -0
  101. package/src/studio/emit-schema.test.ts +94 -0
  102. package/src/studio/emit-schema.ts +920 -0
  103. package/src/studio/index.ts +195 -0
  104. package/src/studio/introspect-db.test.ts +186 -0
  105. package/src/studio/introspect-db.ts +312 -0
  106. package/src/studio/introspect-prisma.test.ts +99 -0
  107. package/src/studio/introspect-prisma.ts +175 -0
  108. package/src/studio/introspect.test.ts +172 -0
  109. package/src/studio/introspect.ts +310 -0
  110. package/src/studio/pipeline.test.ts +42 -0
  111. package/src/studio/project-robust.test.ts +157 -0
  112. package/src/studio/project.test.ts +473 -0
  113. package/src/studio/project.ts +916 -0
  114. package/src/studio/sample-data.test.ts +58 -0
  115. package/src/studio/sample-data.ts +200 -0
  116. package/src/studio/samples/ats.ts +202 -0
  117. package/src/studio/samples/clinic.ts +177 -0
  118. package/src/studio/samples/crm.ts +250 -0
  119. package/src/studio/samples/ecommerce.ts +187 -0
  120. package/src/studio/samples/events.ts +199 -0
  121. package/src/studio/samples/fleet.ts +184 -0
  122. package/src/studio/samples/gym.ts +213 -0
  123. package/src/studio/samples/hr.ts +193 -0
  124. package/src/studio/samples/index.ts +55 -0
  125. package/src/studio/samples/insurance.ts +195 -0
  126. package/src/studio/samples/inventory.ts +182 -0
  127. package/src/studio/samples/invoicing.ts +162 -0
  128. package/src/studio/samples/library.ts +180 -0
  129. package/src/studio/samples/live-data.test.ts +98 -0
  130. package/src/studio/samples/live-data.ts +308 -0
  131. package/src/studio/samples/projects.ts +190 -0
  132. package/src/studio/samples/realestate.ts +196 -0
  133. package/src/studio/samples/restaurant.ts +187 -0
  134. package/src/studio/samples/samples.test.ts +208 -0
  135. package/src/studio/samples/school.ts +197 -0
  136. package/src/studio/samples/seed-floor.test.ts +25 -0
  137. package/src/studio/samples/shared.ts +305 -0
  138. package/src/studio/samples/subscriptions.ts +183 -0
  139. package/src/studio/samples/support.ts +182 -0
  140. package/src/studio/scaffold-app.test.ts +91 -0
  141. package/src/studio/scaffold-app.ts +161 -0
  142. package/src/studio/scaffold.test.ts +178 -0
  143. package/src/studio/scaffold.ts +374 -0
  144. package/src/studio/themes.ts +172 -0
  145. package/src/studio/verify.test.ts +47 -0
  146. package/src/studio/verify.ts +79 -0
  147. package/src/sveltekit/in-memory.test.ts +104 -0
  148. package/src/sveltekit/in-memory.ts +129 -0
  149. package/src/sveltekit/index.ts +23 -0
  150. package/src/sveltekit/query-plan.test.ts +109 -0
  151. package/src/sveltekit/query-plan.ts +125 -0
  152. package/src/sveltekit/sql-source.test.ts +185 -0
  153. package/src/sveltekit/sql-source.ts +166 -0
  154. package/src/sveltekit/sql.test.ts +80 -0
  155. package/src/sveltekit/sql.ts +131 -0
  156. package/src/sveltekit/transport.test.ts +175 -0
  157. package/src/sveltekit/transport.ts +254 -0
  158. package/src/sveltekit/types.ts +11 -0
  159. package/src/upgrade-prompt.ts +149 -148
@@ -0,0 +1,195 @@
1
+ /**
2
+ * `@svgrid/enterprise/studio` - the pure, Svelte-free Studio core. Introspect a
3
+ * data source into an `EntitySchema`, then scaffold runnable SvelteKit code
4
+ * from it. Importable from Node (the MCP generator) as well as bundlers (the
5
+ * visual designer), since nothing here touches Svelte or the DOM.
6
+ */
7
+ export { inferType, introspectJson, introspectDrizzle, introspectDrizzleAll } from './introspect.js'
8
+ export { refineField, refineFields } from '../sources/field-inference.js'
9
+ export { parseCsv, detectDelimiter, csvToEntity, type CsvEntity } from './csv.js'
10
+ export { introspectPrisma, introspectPrismaAll } from './introspect-prisma.js'
11
+ export {
12
+ introspectDatabase,
13
+ listDatabaseTables,
14
+ countTableRows,
15
+ probeConnection,
16
+ mapSqlType,
17
+ type SqlDialectName,
18
+ type DbExecute,
19
+ type IntrospectDbOptions,
20
+ type TableRowCount,
21
+ } from './introspect-db.js'
22
+ export {
23
+ buildConnectionString,
24
+ parseConnectionString,
25
+ redactConnectionString,
26
+ isFileDialect,
27
+ DRIVER_PACKAGE,
28
+ DEFAULT_PORT,
29
+ type SqlConnectionParts,
30
+ } from './db-connect-string.js'
31
+ export {
32
+ scaffold,
33
+ mergeManaged,
34
+ MANAGED_START,
35
+ MANAGED_END,
36
+ type GeneratedFile,
37
+ type ScaffoldOptions,
38
+ } from './scaffold.js'
39
+ export { scaffoldApp, type ScaffoldAppOptions } from './scaffold-app.js'
40
+ export { emitStudioApp, emitEntityModules, entityScreenPage, prepareEntities } from './emit-schema.js'
41
+ export { emitStudioProject, emitStudioAppBundle, studioDeployInfo } from './emit-project.js'
42
+ export { sampleApps, getSampleApp, type SampleApp } from './samples/index.js'
43
+ export { liveDataSamples, getLiveDataSample } from './samples/live-data.js'
44
+ export {
45
+ sanitizeStudioProject,
46
+ buildStudioBugReport,
47
+ type SanitizeResult,
48
+ type BugReport,
49
+ type BugReportInput,
50
+ type StudioEnv,
51
+ } from './bug-report.js'
52
+ export { generateValue, generateRows } from './sample-data.js'
53
+ export { studioThemes, defaultStudioTheme, getStudioTheme, resolveThemeTokens, isDarkTheme, themeStyleString, type StudioTheme } from './themes.js'
54
+ export {
55
+ createProject,
56
+ defaultScreenFor,
57
+ defaultBlockConfig,
58
+ gridColumns,
59
+ entityOf,
60
+ blockPalette,
61
+ addBlock,
62
+ addBlockAt,
63
+ removeBlock,
64
+ duplicateBlock,
65
+ moveBlock,
66
+ reorderBlock,
67
+ updateBlock,
68
+ addEntity,
69
+ removeEntity,
70
+ updateEntity,
71
+ addScreen,
72
+ removeScreen,
73
+ updateScreen,
74
+ duplicateScreen,
75
+ reorderScreen,
76
+ insertBlock,
77
+ setDataSource,
78
+ setDeployTarget,
79
+ defaultEntitySource,
80
+ flattenBlocks,
81
+ TAB_CHILD_KINDS,
82
+ addTab,
83
+ removeTab,
84
+ renameTab,
85
+ addTabBlock,
86
+ removeTabBlock,
87
+ setEntityDataSource,
88
+ entityDataSource,
89
+ setTheme,
90
+ setThemePreset,
91
+ setShell,
92
+ sanitizeProject,
93
+ screenFromTemplate,
94
+ addScreenFromTemplate,
95
+ serializeProject,
96
+ parseProject,
97
+ validateProject,
98
+ isProjectValid,
99
+ blockColumns,
100
+ roleCanScreen,
101
+ roleCanAction,
102
+ CRUD_ACTIONS,
103
+ type CrudAction,
104
+ type RoleAccess,
105
+ type AccessControl,
106
+ type I18nConfig,
107
+ type DeployTarget,
108
+ type StudioProject,
109
+ type Screen,
110
+ type ScreenNav,
111
+ type Block,
112
+ type BlockKind,
113
+ type BlockConfig,
114
+ type GridConfig,
115
+ type GridColumnConfig,
116
+ type RowLink,
117
+ type RowAction,
118
+ type RowActionKind,
119
+ type FormatOp,
120
+ type FormatRule,
121
+ type GridEditing,
122
+ type GridDensity,
123
+ type GridAlign,
124
+ type PagerPosition,
125
+ type FormConfig,
126
+ type ChartConfig,
127
+ type KpiConfig,
128
+ type KpiFormat,
129
+ type GaugeConfig,
130
+ type TreeConfig,
131
+ type TabsConfig,
132
+ type StudioTab,
133
+ type DashboardConfig,
134
+ type MasterDetailConfig,
135
+ type LookupConfig,
136
+ type PivotConfig,
137
+ type FilterPanelConfig,
138
+ type RecordConfig,
139
+ type BoardConfig,
140
+ type CalendarConfig,
141
+ type DetailConfig,
142
+ type DetailRelated,
143
+ type Reduce,
144
+ type DataSourceKind,
145
+ type EntityDataSource,
146
+ type MemorySource,
147
+ type RestSource,
148
+ type SqlSource,
149
+ type SupabaseSource,
150
+ type PgliteSource,
151
+ type RestMethod,
152
+ type ParamLocation,
153
+ type ParamType,
154
+ type RequestParam,
155
+ type SqlDialectKind,
156
+ type ProjectTheme,
157
+ type ShellConfig,
158
+ type ShellStyle,
159
+ type ScreenTemplate,
160
+ type PaletteItem,
161
+ type ProjectIssue,
162
+ } from './project.js'
163
+ export {
164
+ verifyScaffold,
165
+ summarizeVerify,
166
+ type VerifyResult,
167
+ type VerifyIssue,
168
+ type VerifySeverity,
169
+ } from './verify.js'
170
+ export {
171
+ runStudioAdd,
172
+ runStudioAddApp,
173
+ resolveSchema,
174
+ resolveSchemas,
175
+ type StudioIO,
176
+ type AddOptions,
177
+ type AddResult,
178
+ type AddAppResult,
179
+ } from './cli.js'
180
+
181
+ // Re-export the schema surface so consumers get everything from one entry.
182
+ export {
183
+ resolveIdField,
184
+ schemaToColumns,
185
+ schemaToFormFields,
186
+ linkRelationLabels,
187
+ pickLabelField,
188
+ type EntitySchema,
189
+ type EntityField,
190
+ type EntityFieldType,
191
+ } from '../schema.js'
192
+
193
+ // Pure license classification, so the Node/MCP generator can soft-gate with the
194
+ // same rules as the browser (see license-core.ts). No DOM, safe in Node.
195
+ export { checkLicenseKey, type LicenseInfo, type LicenseStatus } from '../license-core.js'
@@ -0,0 +1,186 @@
1
+ import { describe, expect, it } from 'vitest'
2
+ import { introspectDatabase, listDatabaseTables, countTableRows, probeConnection, mapSqlType, type DbExecute } from './introspect-db'
3
+
4
+ describe('mapSqlType', () => {
5
+ it('maps common SQL types across dialects', () => {
6
+ expect(mapSqlType('integer')).toBe('number')
7
+ expect(mapSqlType('bigint')).toBe('number') // not confused with bit
8
+ expect(mapSqlType('numeric')).toBe('number')
9
+ expect(mapSqlType('boolean')).toBe('boolean')
10
+ expect(mapSqlType('bit')).toBe('boolean')
11
+ expect(mapSqlType('timestamp with time zone')).toBe('datetime')
12
+ expect(mapSqlType('datetime2')).toBe('datetime')
13
+ expect(mapSqlType('date')).toBe('dateString')
14
+ expect(mapSqlType('jsonb')).toBe('json')
15
+ expect(mapSqlType('varchar')).toBe('text')
16
+ })
17
+ })
18
+
19
+ /** Fake executor: returns canned catalog rows and records the SQL it was asked. */
20
+ function fakeExec(rowsByCall: Array<Array<Record<string, unknown>>>) {
21
+ const calls: Array<{ sql: string; params: unknown[] }> = []
22
+ let i = 0
23
+ const execute: DbExecute = async (sql, params) => {
24
+ calls.push({ sql, params })
25
+ return rowsByCall[i++] ?? []
26
+ }
27
+ return { execute, calls }
28
+ }
29
+
30
+ describe('introspectDatabase (information_schema dialects)', () => {
31
+ const catalog = [
32
+ { name: 'id', type: 'integer', nullable: 0, pk: 1 },
33
+ { name: 'email', type: 'varchar', nullable: 0, pk: 0 },
34
+ { name: 'age', type: 'integer', nullable: 1, pk: 0 },
35
+ { name: 'active', type: 'boolean', nullable: 1, pk: 0 },
36
+ ]
37
+
38
+ it('postgres: maps columns, primary key, and NOT NULL -> required', async () => {
39
+ const { execute, calls } = fakeExec([catalog])
40
+ const schema = await introspectDatabase({ dialect: 'postgres', table: 'users', execute })
41
+ expect(schema.name).toBe('users')
42
+ const byField = Object.fromEntries(schema.fields.map((f) => [f.field, f]))
43
+ expect(byField.id!).toMatchObject({ type: 'number', primaryKey: true, readonly: true })
44
+ expect(byField.email!).toMatchObject({ type: 'text', required: true })
45
+ expect(byField.age!.required).toBeUndefined() // nullable
46
+ expect(byField.active!.type).toBe('boolean')
47
+ expect(calls[0]!.sql).toContain('information_schema.columns')
48
+ expect(calls[0]!.params).toEqual(['users'])
49
+ })
50
+
51
+ it('supabase is treated as postgres', async () => {
52
+ const { execute, calls } = fakeExec([catalog])
53
+ await introspectDatabase({ dialect: 'supabase', table: 'users', execute })
54
+ expect(calls[0]!.sql).toContain('information_schema.columns')
55
+ })
56
+
57
+ it('mssql uses @p1 placeholders', async () => {
58
+ const { execute, calls } = fakeExec([catalog])
59
+ await introspectDatabase({ dialect: 'mssql', table: 'Users', execute })
60
+ expect(calls[0]!.sql).toContain('@p1')
61
+ })
62
+
63
+ it('throws when the table has no columns', async () => {
64
+ const { execute } = fakeExec([[]])
65
+ await expect(introspectDatabase({ dialect: 'postgres', table: 'ghost', execute })).rejects.toThrow(
66
+ /no columns/,
67
+ )
68
+ })
69
+
70
+ it('turns a foreign-key column into a relation field', async () => {
71
+ const cols = [
72
+ { name: 'id', type: 'integer', nullable: 0, pk: 1 },
73
+ { name: 'name', type: 'varchar', nullable: 0, pk: 0 },
74
+ { name: 'company_id', type: 'integer', nullable: 0, pk: 0 },
75
+ ]
76
+ const fks = [{ column: 'company_id', ref_table: 'companies', ref_column: 'id' }]
77
+ const { execute, calls } = fakeExec([cols, fks])
78
+ const schema = await introspectDatabase({ dialect: 'postgres', table: 'contacts', execute })
79
+ const byField = Object.fromEntries(schema.fields.map((f) => [f.field, f]))
80
+ expect(byField.company_id!).toMatchObject({
81
+ type: 'relation',
82
+ required: true,
83
+ relation: { entity: 'companies', foreignKey: 'company_id', labelField: 'name' },
84
+ })
85
+ expect(calls[1]!.sql).toContain('FOREIGN KEY')
86
+ })
87
+
88
+ it('degrades gracefully when the FK query fails', async () => {
89
+ let call = 0
90
+ const execute: DbExecute = async () => {
91
+ call += 1
92
+ if (call === 1) return [{ name: 'id', type: 'integer', nullable: 0, pk: 1 }]
93
+ throw new Error('permission denied')
94
+ }
95
+ const schema = await introspectDatabase({ dialect: 'postgres', table: 't', execute })
96
+ expect(schema.fields[0]!.type).toBe('number') // no throw, no relation
97
+ })
98
+ })
99
+
100
+ describe('introspectDatabase (sqlite PRAGMA)', () => {
101
+ it('reads PRAGMA table_info rows (notnull + pk-as-index)', async () => {
102
+ const pragma = [
103
+ { cid: 0, name: 'id', type: 'INTEGER', notnull: 1, dflt_value: null, pk: 1 },
104
+ { cid: 1, name: 'title', type: 'TEXT', notnull: 1, dflt_value: null, pk: 0 },
105
+ { cid: 2, name: 'done', type: 'INTEGER', notnull: 0, dflt_value: null, pk: 0 },
106
+ ]
107
+ const { execute, calls } = fakeExec([pragma])
108
+ const schema = await introspectDatabase({ dialect: 'sqlite', table: 'todos', execute })
109
+ const byField = Object.fromEntries(schema.fields.map((f) => [f.field, f]))
110
+ expect(calls[0]!.sql).toBe('PRAGMA table_info("todos")')
111
+ expect(byField.id!).toMatchObject({ type: 'number', primaryKey: true })
112
+ expect(byField.title!.required).toBe(true)
113
+ expect(byField.done!.required).toBeUndefined()
114
+ })
115
+
116
+ it('reads PRAGMA foreign_key_list into a relation field', async () => {
117
+ const pragma = [
118
+ { cid: 0, name: 'id', type: 'INTEGER', notnull: 1, pk: 1 },
119
+ { cid: 1, name: 'company_id', type: 'INTEGER', notnull: 1, pk: 0 },
120
+ ]
121
+ const fkList = [{ id: 0, seq: 0, table: 'companies', from: 'company_id', to: 'id' }]
122
+ const { execute, calls } = fakeExec([pragma, fkList])
123
+ const schema = await introspectDatabase({ dialect: 'sqlite', table: 'contacts', execute })
124
+ expect(schema.fields.find((f) => f.field === 'company_id')).toMatchObject({
125
+ type: 'relation',
126
+ relation: { entity: 'companies', foreignKey: 'company_id', labelField: 'name' },
127
+ })
128
+ expect(calls[1]!.sql).toBe('PRAGMA foreign_key_list("contacts")')
129
+ })
130
+ })
131
+
132
+ describe('listDatabaseTables', () => {
133
+ it('returns base table names', async () => {
134
+ const { execute } = fakeExec([[{ name: 'users' }, { name: 'orders' }]])
135
+ expect(await listDatabaseTables('postgres', execute)).toEqual(['users', 'orders'])
136
+ })
137
+ })
138
+
139
+ describe('countTableRows', () => {
140
+ it('counts each table with dialect-correct quoting', async () => {
141
+ const { execute, calls } = fakeExec([[{ n: 42 }], [{ n: 7 }]])
142
+ const counts = await countTableRows('mysql', execute, ['users', 'orders'])
143
+ expect(counts).toEqual([{ name: 'users', rows: 42 }, { name: 'orders', rows: 7 }])
144
+ expect(calls[0]!.sql).toBe('SELECT COUNT(*) AS n FROM `users`')
145
+ })
146
+
147
+ it('quotes identifiers per dialect (mssql brackets, pg double-quotes)', async () => {
148
+ const { execute: e1, calls: c1 } = fakeExec([[{ n: 1 }]])
149
+ await countTableRows('mssql', e1, ['Orders'])
150
+ expect(c1[0]!.sql).toBe('SELECT COUNT(*) AS n FROM [Orders]')
151
+ const { execute: e2, calls: c2 } = fakeExec([[{ n: 1 }]])
152
+ await countTableRows('postgres', e2, ['orders'])
153
+ expect(c2[0]!.sql).toBe('SELECT COUNT(*) AS n FROM "orders"')
154
+ })
155
+
156
+ it('reports null (not a throw) for a table it cannot count', async () => {
157
+ let call = 0
158
+ const execute: DbExecute = async () => {
159
+ call += 1
160
+ if (call === 1) return [{ n: 5 }]
161
+ throw new Error('permission denied')
162
+ }
163
+ expect(await countTableRows('postgres', execute, ['ok', 'denied'])).toEqual([
164
+ { name: 'ok', rows: 5 },
165
+ { name: 'denied', rows: null },
166
+ ])
167
+ })
168
+ })
169
+
170
+ describe('probeConnection', () => {
171
+ it('lists tables and (with counts) reports row totals in one probe', async () => {
172
+ // call 1: table list; calls 2-3: per-table COUNT(*)
173
+ const { execute } = fakeExec([[{ name: 'users' }, { name: 'orders' }], [{ n: 3 }], [{ n: 9 }]])
174
+ expect(await probeConnection('postgres', execute, { counts: true })).toEqual({
175
+ ok: true,
176
+ tables: [{ name: 'users', rows: 3 }, { name: 'orders', rows: 9 }],
177
+ })
178
+ })
179
+
180
+ it('skips counting when counts are off', async () => {
181
+ const { execute, calls } = fakeExec([[{ name: 'users' }]])
182
+ const probe = await probeConnection('postgres', execute)
183
+ expect(probe.tables).toEqual([{ name: 'users', rows: null }])
184
+ expect(calls).toHaveLength(1) // no COUNT(*) queries
185
+ })
186
+ })
@@ -0,0 +1,312 @@
1
+ /**
2
+ * Live-database introspection - "connect to your database and scaffold". Reads
3
+ * a table's columns straight from the database catalog and maps them to an
4
+ * `EntitySchema`. Covers PostgreSQL (and Supabase, which is Postgres), MySQL,
5
+ * SQL Server, and SQLite.
6
+ *
7
+ * Driver-free, like `createSqlDataSource`: you pass an `execute(sql, params)`
8
+ * backed by your own connected client (pg, postgres.js, mysql2, mssql,
9
+ * better-sqlite3, the Supabase client, ...). Nothing here imports a driver, so
10
+ * it's testable and adds no dependencies.
11
+ */
12
+ import type { EntityField, EntityFieldType, EntitySchema } from '../schema.js'
13
+ import { refineField } from '../sources/field-inference.js'
14
+
15
+ export type SqlDialectName = 'postgres' | 'supabase' | 'mysql' | 'mssql' | 'sqlite'
16
+ export type DbExecute = (sql: string, params: unknown[]) => Promise<Array<Record<string, unknown>>>
17
+
18
+ function truthy(v: unknown): boolean {
19
+ return v === 1 || v === '1' || v === true
20
+ }
21
+
22
+ function identQuote(name: string): string {
23
+ return `"${name.replace(/"/g, '""')}"`
24
+ }
25
+
26
+ /** Dialect-correct identifier quoting for ad-hoc queries (COUNT etc). */
27
+ function quoteIdent(dialect: SqlDialectName, name: string): string {
28
+ if (dialect === 'mysql') return `\`${name.replace(/`/g, '``')}\``
29
+ if (dialect === 'mssql') return `[${name.replace(/]/g, ']]')}]`
30
+ return identQuote(name) // postgres, supabase, sqlite
31
+ }
32
+
33
+ /** Best-effort SQL type -> entity field type. The designer can refine edge cases. */
34
+ export function mapSqlType(raw: string): EntityFieldType {
35
+ const t = raw.toLowerCase()
36
+ if (/\b(bool|bit)\b/.test(t) || t === 'boolean') return 'boolean'
37
+ if (/int|serial|numeric|decimal|real|double|float|money|number/.test(t)) return 'number'
38
+ if (/timestamp|datetime/.test(t)) return 'datetime'
39
+ if (/date/.test(t)) return 'dateString'
40
+ if (/json/.test(t)) return 'json'
41
+ return 'text'
42
+ }
43
+
44
+ function fieldFrom(name: string, rawType: string, pk: boolean, notNull: boolean): EntityField {
45
+ const field: EntityField = { field: name, type: mapSqlType(rawType) }
46
+ if (pk) {
47
+ field.primaryKey = true
48
+ field.readonly = true
49
+ } else if (notNull) {
50
+ field.required = true
51
+ }
52
+ return field
53
+ }
54
+
55
+ /** Map catalog rows (aliased name/type/nullable/pk) from information_schema dialects. */
56
+ function infoSchemaFields(rows: Array<Record<string, unknown>>): EntityField[] {
57
+ return rows.map((r) =>
58
+ fieldFrom(String(r.name), String(r.type ?? ''), truthy(r.pk), !truthy(r.nullable)),
59
+ )
60
+ }
61
+
62
+ /** Map SQLite `PRAGMA table_info` rows (name/type/notnull/pk-as-index). */
63
+ function sqliteFields(rows: Array<Record<string, unknown>>): EntityField[] {
64
+ return rows.map((r) =>
65
+ fieldFrom(String(r.name), String(r.type ?? ''), Number(r.pk) > 0, Number(r.notnull) === 1),
66
+ )
67
+ }
68
+
69
+ /** A discovered foreign key: local `column` references `table`.`refColumn`. */
70
+ type FkInfo = { column: string; table: string; refColumn?: string }
71
+
72
+ /** Map information_schema FK rows (aliased column/ref_table/ref_column) - pg / mysql / mssql. */
73
+ function infoSchemaFks(rows: Array<Record<string, unknown>>): FkInfo[] {
74
+ return rows
75
+ .filter((r) => r.ref_table)
76
+ .map((r) => ({ column: String(r.column), table: String(r.ref_table), refColumn: r.ref_column ? String(r.ref_column) : undefined }))
77
+ }
78
+
79
+ /** Map SQLite `PRAGMA foreign_key_list` rows (from/table/to). */
80
+ function sqliteFks(rows: Array<Record<string, unknown>>): FkInfo[] {
81
+ return rows.map((r) => ({ column: String(r.from), table: String(r.table), refColumn: r.to ? String(r.to) : undefined }))
82
+ }
83
+
84
+ type DialectDef = {
85
+ columns: (table: string) => { sql: string; params: unknown[] }
86
+ toFields: (rows: Array<Record<string, unknown>>) => EntityField[]
87
+ tables: { sql: string; params: unknown[] }
88
+ foreignKeys: (table: string) => { sql: string; params: unknown[] }
89
+ toForeignKeys: (rows: Array<Record<string, unknown>>) => FkInfo[]
90
+ }
91
+
92
+ const POSTGRES: DialectDef = {
93
+ columns: (table) => ({
94
+ sql: `SELECT c.column_name AS name, c.data_type AS type,
95
+ CASE WHEN c.is_nullable = 'YES' THEN 1 ELSE 0 END AS nullable,
96
+ CASE WHEN pk.column_name IS NOT NULL THEN 1 ELSE 0 END AS pk
97
+ FROM information_schema.columns c
98
+ LEFT JOIN (
99
+ SELECT kcu.column_name
100
+ FROM information_schema.table_constraints tc
101
+ JOIN information_schema.key_column_usage kcu
102
+ ON kcu.constraint_name = tc.constraint_name AND kcu.table_name = tc.table_name
103
+ WHERE tc.constraint_type = 'PRIMARY KEY' AND tc.table_name = $1
104
+ ) pk ON pk.column_name = c.column_name
105
+ WHERE c.table_name = $1
106
+ ORDER BY c.ordinal_position`,
107
+ params: [table],
108
+ }),
109
+ toFields: infoSchemaFields,
110
+ tables: {
111
+ sql: `SELECT table_name AS name FROM information_schema.tables
112
+ WHERE table_schema = 'public' AND table_type = 'BASE TABLE' ORDER BY table_name`,
113
+ params: [],
114
+ },
115
+ foreignKeys: (table) => ({
116
+ sql: `SELECT kcu.column_name AS "column", ccu.table_name AS ref_table, ccu.column_name AS ref_column
117
+ FROM information_schema.table_constraints tc
118
+ JOIN information_schema.key_column_usage kcu
119
+ ON kcu.constraint_name = tc.constraint_name AND kcu.table_name = tc.table_name
120
+ JOIN information_schema.constraint_column_usage ccu
121
+ ON ccu.constraint_name = tc.constraint_name
122
+ WHERE tc.constraint_type = 'FOREIGN KEY' AND tc.table_name = $1`,
123
+ params: [table],
124
+ }),
125
+ toForeignKeys: infoSchemaFks,
126
+ }
127
+
128
+ const MYSQL: DialectDef = {
129
+ columns: (table) => ({
130
+ sql: `SELECT COLUMN_NAME AS name, DATA_TYPE AS type,
131
+ CASE WHEN IS_NULLABLE = 'YES' THEN 1 ELSE 0 END AS nullable,
132
+ CASE WHEN COLUMN_KEY = 'PRI' THEN 1 ELSE 0 END AS pk
133
+ FROM information_schema.columns
134
+ WHERE TABLE_NAME = ? AND TABLE_SCHEMA = DATABASE()
135
+ ORDER BY ORDINAL_POSITION`,
136
+ params: [table],
137
+ }),
138
+ toFields: infoSchemaFields,
139
+ tables: {
140
+ sql: `SELECT TABLE_NAME AS name FROM information_schema.tables
141
+ WHERE TABLE_SCHEMA = DATABASE() AND TABLE_TYPE = 'BASE TABLE' ORDER BY TABLE_NAME`,
142
+ params: [],
143
+ },
144
+ foreignKeys: (table) => ({
145
+ sql: `SELECT COLUMN_NAME AS \`column\`, REFERENCED_TABLE_NAME AS ref_table, REFERENCED_COLUMN_NAME AS ref_column
146
+ FROM information_schema.KEY_COLUMN_USAGE
147
+ WHERE TABLE_SCHEMA = DATABASE() AND TABLE_NAME = ? AND REFERENCED_TABLE_NAME IS NOT NULL`,
148
+ params: [table],
149
+ }),
150
+ toForeignKeys: infoSchemaFks,
151
+ }
152
+
153
+ const MSSQL: DialectDef = {
154
+ columns: (table) => ({
155
+ sql: `SELECT c.COLUMN_NAME AS name, c.DATA_TYPE AS type,
156
+ CASE WHEN c.IS_NULLABLE = 'YES' THEN 1 ELSE 0 END AS nullable,
157
+ CASE WHEN pk.COLUMN_NAME IS NOT NULL THEN 1 ELSE 0 END AS pk
158
+ FROM INFORMATION_SCHEMA.COLUMNS c
159
+ LEFT JOIN (
160
+ SELECT ku.COLUMN_NAME
161
+ FROM INFORMATION_SCHEMA.TABLE_CONSTRAINTS tc
162
+ JOIN INFORMATION_SCHEMA.KEY_COLUMN_USAGE ku ON tc.CONSTRAINT_NAME = ku.CONSTRAINT_NAME
163
+ WHERE tc.CONSTRAINT_TYPE = 'PRIMARY KEY' AND tc.TABLE_NAME = @p1
164
+ ) pk ON pk.COLUMN_NAME = c.COLUMN_NAME
165
+ WHERE c.TABLE_NAME = @p1
166
+ ORDER BY c.ORDINAL_POSITION`,
167
+ params: [table],
168
+ }),
169
+ toFields: infoSchemaFields,
170
+ tables: {
171
+ sql: `SELECT TABLE_NAME AS name FROM INFORMATION_SCHEMA.TABLES
172
+ WHERE TABLE_TYPE = 'BASE TABLE' ORDER BY TABLE_NAME`,
173
+ params: [],
174
+ },
175
+ foreignKeys: (table) => ({
176
+ sql: `SELECT cu.COLUMN_NAME AS [column], pk.TABLE_NAME AS ref_table, pt.COLUMN_NAME AS ref_column
177
+ FROM INFORMATION_SCHEMA.REFERENTIAL_CONSTRAINTS rc
178
+ JOIN INFORMATION_SCHEMA.KEY_COLUMN_USAGE cu ON cu.CONSTRAINT_NAME = rc.CONSTRAINT_NAME
179
+ JOIN INFORMATION_SCHEMA.TABLE_CONSTRAINTS pk ON pk.CONSTRAINT_NAME = rc.UNIQUE_CONSTRAINT_NAME
180
+ JOIN INFORMATION_SCHEMA.KEY_COLUMN_USAGE pt
181
+ ON pt.CONSTRAINT_NAME = pk.CONSTRAINT_NAME AND pt.ORDINAL_POSITION = cu.ORDINAL_POSITION
182
+ WHERE cu.TABLE_NAME = @p1`,
183
+ params: [table],
184
+ }),
185
+ toForeignKeys: infoSchemaFks,
186
+ }
187
+
188
+ const SQLITE: DialectDef = {
189
+ columns: (table) => ({ sql: `PRAGMA table_info(${identQuote(table)})`, params: [] }),
190
+ toFields: sqliteFields,
191
+ tables: {
192
+ sql: `SELECT name FROM sqlite_master WHERE type = 'table' AND name NOT LIKE 'sqlite_%' ORDER BY name`,
193
+ params: [],
194
+ },
195
+ foreignKeys: (table) => ({ sql: `PRAGMA foreign_key_list(${identQuote(table)})`, params: [] }),
196
+ toForeignKeys: sqliteFks,
197
+ }
198
+
199
+ const DIALECTS: Record<Exclude<SqlDialectName, 'supabase'>, DialectDef> = {
200
+ postgres: POSTGRES,
201
+ mysql: MYSQL,
202
+ mssql: MSSQL,
203
+ sqlite: SQLITE,
204
+ }
205
+
206
+ function defFor(dialect: SqlDialectName): DialectDef {
207
+ const key = dialect === 'supabase' ? 'postgres' : dialect
208
+ const def = DIALECTS[key]
209
+ if (!def) throw new Error(`introspectDatabase: unknown dialect "${dialect}"`)
210
+ return def
211
+ }
212
+
213
+ export type IntrospectDbOptions = {
214
+ dialect: SqlDialectName
215
+ table: string
216
+ execute: DbExecute
217
+ }
218
+
219
+ /** Convert FK columns into `relation` fields so the form gets a lookup + master-detail is inferable. */
220
+ function applyForeignKeys(fields: EntityField[], fks: FkInfo[]): EntityField[] {
221
+ if (fks.length === 0) return fields
222
+ const byColumn = new Map(fks.map((fk) => [fk.column, fk]))
223
+ return fields.map((f) => {
224
+ const fk = byColumn.get(f.field)
225
+ if (!fk || f.primaryKey) return f
226
+ const rel: EntityField = {
227
+ field: f.field,
228
+ type: 'relation',
229
+ relation: { entity: fk.table, foreignKey: f.field, labelField: 'name' },
230
+ }
231
+ if (f.required) rel.required = true
232
+ return rel
233
+ })
234
+ }
235
+
236
+ /** Read one table's columns (and foreign keys) from the live database into an EntitySchema. */
237
+ export async function introspectDatabase(options: IntrospectDbOptions): Promise<EntitySchema> {
238
+ const def = defFor(options.dialect)
239
+ const { sql, params } = def.columns(options.table)
240
+ const rows = await options.execute(sql, params)
241
+ const fields = def.toFields(rows)
242
+ if (fields.length === 0) {
243
+ throw new Error(`introspectDatabase: table "${options.table}" has no columns (does it exist?)`)
244
+ }
245
+
246
+ // Foreign keys are best-effort: if the catalog query fails (permissions,
247
+ // unusual setup), degrade to a schema without relations rather than throw.
248
+ let fks: FkInfo[] = []
249
+ try {
250
+ const fk = def.foreignKeys(options.table)
251
+ fks = def.toForeignKeys(await options.execute(fk.sql, fk.params))
252
+ } catch {
253
+ fks = []
254
+ }
255
+
256
+ // Infer rich editors (phone / email / rating / mask / ...) from column names,
257
+ // after FK columns became relations so those are left untouched.
258
+ return { name: options.table, fields: applyForeignKeys(fields, fks).map(refineField) }
259
+ }
260
+
261
+ /** List the base tables in the connected database. */
262
+ export async function listDatabaseTables(
263
+ dialect: SqlDialectName,
264
+ execute: DbExecute,
265
+ ): Promise<string[]> {
266
+ const def = defFor(dialect)
267
+ const rows = await execute(def.tables.sql, def.tables.params)
268
+ return rows.map((r) => String(r.name)).filter(Boolean)
269
+ }
270
+
271
+ export type TableRowCount = { name: string; rows: number | null }
272
+
273
+ /**
274
+ * Count rows in each table - powers the designer's "Test connection" step, which
275
+ * shows the user their real data volumes before they commit to importing. Fully
276
+ * resilient: a table that can't be counted (permissions, a view) yields
277
+ * `rows: null` instead of failing the whole probe.
278
+ */
279
+ export async function countTableRows(
280
+ dialect: SqlDialectName,
281
+ execute: DbExecute,
282
+ tables: string[],
283
+ ): Promise<TableRowCount[]> {
284
+ const out: TableRowCount[] = []
285
+ for (const table of tables) {
286
+ try {
287
+ const rows = await execute(`SELECT COUNT(*) AS n FROM ${quoteIdent(dialect, table)}`, [])
288
+ const n = rows[0]?.n
289
+ out.push({ name: table, rows: n == null ? null : Number(n) })
290
+ } catch {
291
+ out.push({ name: table, rows: null })
292
+ }
293
+ }
294
+ return out
295
+ }
296
+
297
+ /**
298
+ * One round-trip "test connection": confirm we can talk to the database, list
299
+ * its tables, and (optionally) report each table's row count. Throws only if the
300
+ * connection itself is unusable (the caller maps that to a friendly message).
301
+ */
302
+ export async function probeConnection(
303
+ dialect: SqlDialectName,
304
+ execute: DbExecute,
305
+ opts: { counts?: boolean } = {},
306
+ ): Promise<{ ok: true; tables: TableRowCount[] }> {
307
+ const names = await listDatabaseTables(dialect, execute)
308
+ const tables = opts.counts
309
+ ? await countTableRows(dialect, execute, names)
310
+ : names.map((name) => ({ name, rows: null }))
311
+ return { ok: true, tables }
312
+ }