@databricks/appkit 0.67.0 → 0.69.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 (76) hide show
  1. package/CLAUDE.md +2 -2
  2. package/dist/appkit/package.js +1 -1
  3. package/dist/core/agent/skills/types.d.ts +6 -1
  4. package/dist/core/agent/skills/types.d.ts.map +1 -1
  5. package/dist/database/contract/index.js +1 -1
  6. package/dist/database/contract/wire.d.ts.map +1 -1
  7. package/dist/database/contract/wire.js +5 -1
  8. package/dist/database/contract/wire.js.map +1 -1
  9. package/dist/database/errors.js +39 -3
  10. package/dist/database/errors.js.map +1 -1
  11. package/dist/database/runtime/data-path.js.map +1 -1
  12. package/dist/database/runtime/engine/drizzle-data-path.js +1 -1
  13. package/dist/database/runtime/engine/drizzle-data-path.js.map +1 -1
  14. package/dist/database/runtime/engine/translate.js +9 -2
  15. package/dist/database/runtime/engine/translate.js.map +1 -1
  16. package/dist/database/schema-builder/define-schema.d.ts +5 -1
  17. package/dist/database/schema-builder/define-schema.d.ts.map +1 -1
  18. package/dist/database/schema-builder/define-schema.js +4 -0
  19. package/dist/database/schema-builder/define-schema.js.map +1 -1
  20. package/dist/database/schema-builder/types.d.ts +7 -2
  21. package/dist/database/schema-builder/types.d.ts.map +1 -1
  22. package/dist/database/schema-builder/types.js.map +1 -1
  23. package/dist/plugins/agents/active-stream-tracker.js +52 -0
  24. package/dist/plugins/agents/active-stream-tracker.js.map +1 -0
  25. package/dist/plugins/agents/adapter-extensions.js +50 -0
  26. package/dist/plugins/agents/adapter-extensions.js.map +1 -0
  27. package/dist/plugins/agents/agents.d.ts +6 -77
  28. package/dist/plugins/agents/agents.d.ts.map +1 -1
  29. package/dist/plugins/agents/agents.js +57 -431
  30. package/dist/plugins/agents/agents.js.map +1 -1
  31. package/dist/plugins/agents/approval.js +28 -0
  32. package/dist/plugins/agents/approval.js.map +1 -0
  33. package/dist/plugins/agents/builtin-tools.js +39 -0
  34. package/dist/plugins/agents/builtin-tools.js.map +1 -0
  35. package/dist/plugins/agents/prompt.js +27 -0
  36. package/dist/plugins/agents/prompt.js.map +1 -0
  37. package/dist/plugins/agents/registry.js +56 -0
  38. package/dist/plugins/agents/registry.js.map +1 -0
  39. package/dist/plugins/agents/resolve-config.js +40 -0
  40. package/dist/plugins/agents/resolve-config.js.map +1 -0
  41. package/dist/plugins/agents/skill-loader.js +139 -0
  42. package/dist/plugins/agents/skill-loader.js.map +1 -0
  43. package/dist/plugins/agents/tool-dispatch.js +124 -0
  44. package/dist/plugins/agents/tool-dispatch.js.map +1 -0
  45. package/dist/plugins/database/crud/codecs.js +78 -0
  46. package/dist/plugins/database/crud/codecs.js.map +1 -0
  47. package/dist/plugins/database/crud/contract.js +151 -0
  48. package/dist/plugins/database/crud/contract.js.map +1 -0
  49. package/dist/plugins/database/crud/exposure.js +40 -0
  50. package/dist/plugins/database/crud/exposure.js.map +1 -0
  51. package/dist/plugins/database/crud/query.js +244 -0
  52. package/dist/plugins/database/crud/query.js.map +1 -0
  53. package/dist/plugins/database/crud/routes.js +124 -0
  54. package/dist/plugins/database/crud/routes.js.map +1 -0
  55. package/dist/plugins/database/database.d.ts +6 -0
  56. package/dist/plugins/database/database.d.ts.map +1 -1
  57. package/dist/plugins/database/database.js +58 -4
  58. package/dist/plugins/database/database.js.map +1 -1
  59. package/dist/plugins/database/defaults.js +28 -1
  60. package/dist/plugins/database/defaults.js.map +1 -1
  61. package/dist/plugins/database/entity-client.js +1 -1
  62. package/dist/plugins/database/entity-types.d.ts +13 -4
  63. package/dist/plugins/database/entity-types.d.ts.map +1 -1
  64. package/dist/plugins/database/lifecycle.js +2 -1
  65. package/dist/plugins/database/lifecycle.js.map +1 -1
  66. package/dist/plugins/database/types.d.ts +32 -0
  67. package/dist/plugins/database/types.d.ts.map +1 -1
  68. package/dist/shared/src/schemas/manifest.d.ts +54 -54
  69. package/docs/api/appkit/Function.database.md +3 -3
  70. package/docs/api/appkit/Function.defineSchema.md +14 -6
  71. package/docs/api/appkit/Interface.Schema.md +10 -2
  72. package/docs/api/appkit/TypeAlias.IDatabaseConfig.md +20 -0
  73. package/docs/api/appkit.md +2 -2
  74. package/llms.txt +2 -2
  75. package/package.json +1 -1
  76. package/sbom.cdx.json +1 -1
@@ -12,12 +12,12 @@ declare const resourceFieldEntrySchema: z.ZodObject<{
12
12
  discovery: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
13
13
  type: z.ZodLiteral<"kind">;
14
14
  resourceKind: z.ZodEnum<{
15
- warehouse: "warehouse";
15
+ volume: "volume";
16
16
  genie_space: "genie_space";
17
+ warehouse: "warehouse";
17
18
  postgres_project: "postgres_project";
18
19
  postgres_branch: "postgres_branch";
19
20
  postgres_database: "postgres_database";
20
- volume: "volume";
21
21
  }>;
22
22
  select: z.ZodOptional<z.ZodString>;
23
23
  display: z.ZodOptional<z.ZodString>;
@@ -58,12 +58,12 @@ declare const pluginManifestSchema: z.ZodObject<{
58
58
  discovery: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
59
59
  type: z.ZodLiteral<"kind">;
60
60
  resourceKind: z.ZodEnum<{
61
- warehouse: "warehouse";
61
+ volume: "volume";
62
62
  genie_space: "genie_space";
63
+ warehouse: "warehouse";
63
64
  postgres_project: "postgres_project";
64
65
  postgres_branch: "postgres_branch";
65
66
  postgres_database: "postgres_database";
66
- volume: "volume";
67
67
  }>;
68
68
  select: z.ZodOptional<z.ZodString>;
69
69
  display: z.ZodOptional<z.ZodString>;
@@ -99,12 +99,12 @@ declare const pluginManifestSchema: z.ZodObject<{
99
99
  discovery: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
100
100
  type: z.ZodLiteral<"kind">;
101
101
  resourceKind: z.ZodEnum<{
102
- warehouse: "warehouse";
102
+ volume: "volume";
103
103
  genie_space: "genie_space";
104
+ warehouse: "warehouse";
104
105
  postgres_project: "postgres_project";
105
106
  postgres_branch: "postgres_branch";
106
107
  postgres_database: "postgres_database";
107
- volume: "volume";
108
108
  }>;
109
109
  select: z.ZodOptional<z.ZodString>;
110
110
  display: z.ZodOptional<z.ZodString>;
@@ -139,12 +139,12 @@ declare const pluginManifestSchema: z.ZodObject<{
139
139
  discovery: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
140
140
  type: z.ZodLiteral<"kind">;
141
141
  resourceKind: z.ZodEnum<{
142
- warehouse: "warehouse";
142
+ volume: "volume";
143
143
  genie_space: "genie_space";
144
+ warehouse: "warehouse";
144
145
  postgres_project: "postgres_project";
145
146
  postgres_branch: "postgres_branch";
146
147
  postgres_database: "postgres_database";
147
- volume: "volume";
148
148
  }>;
149
149
  select: z.ZodOptional<z.ZodString>;
150
150
  display: z.ZodOptional<z.ZodString>;
@@ -180,12 +180,12 @@ declare const pluginManifestSchema: z.ZodObject<{
180
180
  discovery: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
181
181
  type: z.ZodLiteral<"kind">;
182
182
  resourceKind: z.ZodEnum<{
183
- warehouse: "warehouse";
183
+ volume: "volume";
184
184
  genie_space: "genie_space";
185
+ warehouse: "warehouse";
185
186
  postgres_project: "postgres_project";
186
187
  postgres_branch: "postgres_branch";
187
188
  postgres_database: "postgres_database";
188
- volume: "volume";
189
189
  }>;
190
190
  select: z.ZodOptional<z.ZodString>;
191
191
  display: z.ZodOptional<z.ZodString>;
@@ -220,12 +220,12 @@ declare const pluginManifestSchema: z.ZodObject<{
220
220
  discovery: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
221
221
  type: z.ZodLiteral<"kind">;
222
222
  resourceKind: z.ZodEnum<{
223
- warehouse: "warehouse";
223
+ volume: "volume";
224
224
  genie_space: "genie_space";
225
+ warehouse: "warehouse";
225
226
  postgres_project: "postgres_project";
226
227
  postgres_branch: "postgres_branch";
227
228
  postgres_database: "postgres_database";
228
- volume: "volume";
229
229
  }>;
230
230
  select: z.ZodOptional<z.ZodString>;
231
231
  display: z.ZodOptional<z.ZodString>;
@@ -259,12 +259,12 @@ declare const pluginManifestSchema: z.ZodObject<{
259
259
  discovery: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
260
260
  type: z.ZodLiteral<"kind">;
261
261
  resourceKind: z.ZodEnum<{
262
- warehouse: "warehouse";
262
+ volume: "volume";
263
263
  genie_space: "genie_space";
264
+ warehouse: "warehouse";
264
265
  postgres_project: "postgres_project";
265
266
  postgres_branch: "postgres_branch";
266
267
  postgres_database: "postgres_database";
267
- volume: "volume";
268
268
  }>;
269
269
  select: z.ZodOptional<z.ZodString>;
270
270
  display: z.ZodOptional<z.ZodString>;
@@ -298,12 +298,12 @@ declare const pluginManifestSchema: z.ZodObject<{
298
298
  discovery: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
299
299
  type: z.ZodLiteral<"kind">;
300
300
  resourceKind: z.ZodEnum<{
301
- warehouse: "warehouse";
301
+ volume: "volume";
302
302
  genie_space: "genie_space";
303
+ warehouse: "warehouse";
303
304
  postgres_project: "postgres_project";
304
305
  postgres_branch: "postgres_branch";
305
306
  postgres_database: "postgres_database";
306
- volume: "volume";
307
307
  }>;
308
308
  select: z.ZodOptional<z.ZodString>;
309
309
  display: z.ZodOptional<z.ZodString>;
@@ -337,12 +337,12 @@ declare const pluginManifestSchema: z.ZodObject<{
337
337
  discovery: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
338
338
  type: z.ZodLiteral<"kind">;
339
339
  resourceKind: z.ZodEnum<{
340
- warehouse: "warehouse";
340
+ volume: "volume";
341
341
  genie_space: "genie_space";
342
+ warehouse: "warehouse";
342
343
  postgres_project: "postgres_project";
343
344
  postgres_branch: "postgres_branch";
344
345
  postgres_database: "postgres_database";
345
- volume: "volume";
346
346
  }>;
347
347
  select: z.ZodOptional<z.ZodString>;
348
348
  display: z.ZodOptional<z.ZodString>;
@@ -376,12 +376,12 @@ declare const pluginManifestSchema: z.ZodObject<{
376
376
  discovery: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
377
377
  type: z.ZodLiteral<"kind">;
378
378
  resourceKind: z.ZodEnum<{
379
- warehouse: "warehouse";
379
+ volume: "volume";
380
380
  genie_space: "genie_space";
381
+ warehouse: "warehouse";
381
382
  postgres_project: "postgres_project";
382
383
  postgres_branch: "postgres_branch";
383
384
  postgres_database: "postgres_database";
384
- volume: "volume";
385
385
  }>;
386
386
  select: z.ZodOptional<z.ZodString>;
387
387
  display: z.ZodOptional<z.ZodString>;
@@ -415,12 +415,12 @@ declare const pluginManifestSchema: z.ZodObject<{
415
415
  discovery: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
416
416
  type: z.ZodLiteral<"kind">;
417
417
  resourceKind: z.ZodEnum<{
418
- warehouse: "warehouse";
418
+ volume: "volume";
419
419
  genie_space: "genie_space";
420
+ warehouse: "warehouse";
420
421
  postgres_project: "postgres_project";
421
422
  postgres_branch: "postgres_branch";
422
423
  postgres_database: "postgres_database";
423
- volume: "volume";
424
424
  }>;
425
425
  select: z.ZodOptional<z.ZodString>;
426
426
  display: z.ZodOptional<z.ZodString>;
@@ -457,12 +457,12 @@ declare const pluginManifestSchema: z.ZodObject<{
457
457
  discovery: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
458
458
  type: z.ZodLiteral<"kind">;
459
459
  resourceKind: z.ZodEnum<{
460
- warehouse: "warehouse";
460
+ volume: "volume";
461
461
  genie_space: "genie_space";
462
+ warehouse: "warehouse";
462
463
  postgres_project: "postgres_project";
463
464
  postgres_branch: "postgres_branch";
464
465
  postgres_database: "postgres_database";
465
- volume: "volume";
466
466
  }>;
467
467
  select: z.ZodOptional<z.ZodString>;
468
468
  display: z.ZodOptional<z.ZodString>;
@@ -498,12 +498,12 @@ declare const pluginManifestSchema: z.ZodObject<{
498
498
  discovery: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
499
499
  type: z.ZodLiteral<"kind">;
500
500
  resourceKind: z.ZodEnum<{
501
- warehouse: "warehouse";
501
+ volume: "volume";
502
502
  genie_space: "genie_space";
503
+ warehouse: "warehouse";
503
504
  postgres_project: "postgres_project";
504
505
  postgres_branch: "postgres_branch";
505
506
  postgres_database: "postgres_database";
506
- volume: "volume";
507
507
  }>;
508
508
  select: z.ZodOptional<z.ZodString>;
509
509
  display: z.ZodOptional<z.ZodString>;
@@ -537,12 +537,12 @@ declare const pluginManifestSchema: z.ZodObject<{
537
537
  discovery: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
538
538
  type: z.ZodLiteral<"kind">;
539
539
  resourceKind: z.ZodEnum<{
540
- warehouse: "warehouse";
540
+ volume: "volume";
541
541
  genie_space: "genie_space";
542
+ warehouse: "warehouse";
542
543
  postgres_project: "postgres_project";
543
544
  postgres_branch: "postgres_branch";
544
545
  postgres_database: "postgres_database";
545
- volume: "volume";
546
546
  }>;
547
547
  select: z.ZodOptional<z.ZodString>;
548
548
  display: z.ZodOptional<z.ZodString>;
@@ -579,12 +579,12 @@ declare const pluginManifestSchema: z.ZodObject<{
579
579
  discovery: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
580
580
  type: z.ZodLiteral<"kind">;
581
581
  resourceKind: z.ZodEnum<{
582
- warehouse: "warehouse";
582
+ volume: "volume";
583
583
  genie_space: "genie_space";
584
+ warehouse: "warehouse";
584
585
  postgres_project: "postgres_project";
585
586
  postgres_branch: "postgres_branch";
586
587
  postgres_database: "postgres_database";
587
- volume: "volume";
588
588
  }>;
589
589
  select: z.ZodOptional<z.ZodString>;
590
590
  display: z.ZodOptional<z.ZodString>;
@@ -620,12 +620,12 @@ declare const pluginManifestSchema: z.ZodObject<{
620
620
  discovery: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
621
621
  type: z.ZodLiteral<"kind">;
622
622
  resourceKind: z.ZodEnum<{
623
- warehouse: "warehouse";
623
+ volume: "volume";
624
624
  genie_space: "genie_space";
625
+ warehouse: "warehouse";
625
626
  postgres_project: "postgres_project";
626
627
  postgres_branch: "postgres_branch";
627
628
  postgres_database: "postgres_database";
628
- volume: "volume";
629
629
  }>;
630
630
  select: z.ZodOptional<z.ZodString>;
631
631
  display: z.ZodOptional<z.ZodString>;
@@ -660,12 +660,12 @@ declare const pluginManifestSchema: z.ZodObject<{
660
660
  discovery: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
661
661
  type: z.ZodLiteral<"kind">;
662
662
  resourceKind: z.ZodEnum<{
663
- warehouse: "warehouse";
663
+ volume: "volume";
664
664
  genie_space: "genie_space";
665
+ warehouse: "warehouse";
665
666
  postgres_project: "postgres_project";
666
667
  postgres_branch: "postgres_branch";
667
668
  postgres_database: "postgres_database";
668
- volume: "volume";
669
669
  }>;
670
670
  select: z.ZodOptional<z.ZodString>;
671
671
  display: z.ZodOptional<z.ZodString>;
@@ -701,12 +701,12 @@ declare const pluginManifestSchema: z.ZodObject<{
701
701
  discovery: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
702
702
  type: z.ZodLiteral<"kind">;
703
703
  resourceKind: z.ZodEnum<{
704
- warehouse: "warehouse";
704
+ volume: "volume";
705
705
  genie_space: "genie_space";
706
+ warehouse: "warehouse";
706
707
  postgres_project: "postgres_project";
707
708
  postgres_branch: "postgres_branch";
708
709
  postgres_database: "postgres_database";
709
- volume: "volume";
710
710
  }>;
711
711
  select: z.ZodOptional<z.ZodString>;
712
712
  display: z.ZodOptional<z.ZodString>;
@@ -741,12 +741,12 @@ declare const pluginManifestSchema: z.ZodObject<{
741
741
  discovery: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
742
742
  type: z.ZodLiteral<"kind">;
743
743
  resourceKind: z.ZodEnum<{
744
- warehouse: "warehouse";
744
+ volume: "volume";
745
745
  genie_space: "genie_space";
746
+ warehouse: "warehouse";
746
747
  postgres_project: "postgres_project";
747
748
  postgres_branch: "postgres_branch";
748
749
  postgres_database: "postgres_database";
749
- volume: "volume";
750
750
  }>;
751
751
  select: z.ZodOptional<z.ZodString>;
752
752
  display: z.ZodOptional<z.ZodString>;
@@ -780,12 +780,12 @@ declare const pluginManifestSchema: z.ZodObject<{
780
780
  discovery: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
781
781
  type: z.ZodLiteral<"kind">;
782
782
  resourceKind: z.ZodEnum<{
783
- warehouse: "warehouse";
783
+ volume: "volume";
784
784
  genie_space: "genie_space";
785
+ warehouse: "warehouse";
785
786
  postgres_project: "postgres_project";
786
787
  postgres_branch: "postgres_branch";
787
788
  postgres_database: "postgres_database";
788
- volume: "volume";
789
789
  }>;
790
790
  select: z.ZodOptional<z.ZodString>;
791
791
  display: z.ZodOptional<z.ZodString>;
@@ -819,12 +819,12 @@ declare const pluginManifestSchema: z.ZodObject<{
819
819
  discovery: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
820
820
  type: z.ZodLiteral<"kind">;
821
821
  resourceKind: z.ZodEnum<{
822
- warehouse: "warehouse";
822
+ volume: "volume";
823
823
  genie_space: "genie_space";
824
+ warehouse: "warehouse";
824
825
  postgres_project: "postgres_project";
825
826
  postgres_branch: "postgres_branch";
826
827
  postgres_database: "postgres_database";
827
- volume: "volume";
828
828
  }>;
829
829
  select: z.ZodOptional<z.ZodString>;
830
830
  display: z.ZodOptional<z.ZodString>;
@@ -858,12 +858,12 @@ declare const pluginManifestSchema: z.ZodObject<{
858
858
  discovery: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
859
859
  type: z.ZodLiteral<"kind">;
860
860
  resourceKind: z.ZodEnum<{
861
- warehouse: "warehouse";
861
+ volume: "volume";
862
862
  genie_space: "genie_space";
863
+ warehouse: "warehouse";
863
864
  postgres_project: "postgres_project";
864
865
  postgres_branch: "postgres_branch";
865
866
  postgres_database: "postgres_database";
866
- volume: "volume";
867
867
  }>;
868
868
  select: z.ZodOptional<z.ZodString>;
869
869
  display: z.ZodOptional<z.ZodString>;
@@ -897,12 +897,12 @@ declare const pluginManifestSchema: z.ZodObject<{
897
897
  discovery: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
898
898
  type: z.ZodLiteral<"kind">;
899
899
  resourceKind: z.ZodEnum<{
900
- warehouse: "warehouse";
900
+ volume: "volume";
901
901
  genie_space: "genie_space";
902
+ warehouse: "warehouse";
902
903
  postgres_project: "postgres_project";
903
904
  postgres_branch: "postgres_branch";
904
905
  postgres_database: "postgres_database";
905
- volume: "volume";
906
906
  }>;
907
907
  select: z.ZodOptional<z.ZodString>;
908
908
  display: z.ZodOptional<z.ZodString>;
@@ -936,12 +936,12 @@ declare const pluginManifestSchema: z.ZodObject<{
936
936
  discovery: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
937
937
  type: z.ZodLiteral<"kind">;
938
938
  resourceKind: z.ZodEnum<{
939
- warehouse: "warehouse";
939
+ volume: "volume";
940
940
  genie_space: "genie_space";
941
+ warehouse: "warehouse";
941
942
  postgres_project: "postgres_project";
942
943
  postgres_branch: "postgres_branch";
943
944
  postgres_database: "postgres_database";
944
- volume: "volume";
945
945
  }>;
946
946
  select: z.ZodOptional<z.ZodString>;
947
947
  display: z.ZodOptional<z.ZodString>;
@@ -978,12 +978,12 @@ declare const pluginManifestSchema: z.ZodObject<{
978
978
  discovery: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
979
979
  type: z.ZodLiteral<"kind">;
980
980
  resourceKind: z.ZodEnum<{
981
- warehouse: "warehouse";
981
+ volume: "volume";
982
982
  genie_space: "genie_space";
983
+ warehouse: "warehouse";
983
984
  postgres_project: "postgres_project";
984
985
  postgres_branch: "postgres_branch";
985
986
  postgres_database: "postgres_database";
986
- volume: "volume";
987
987
  }>;
988
988
  select: z.ZodOptional<z.ZodString>;
989
989
  display: z.ZodOptional<z.ZodString>;
@@ -1019,12 +1019,12 @@ declare const pluginManifestSchema: z.ZodObject<{
1019
1019
  discovery: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
1020
1020
  type: z.ZodLiteral<"kind">;
1021
1021
  resourceKind: z.ZodEnum<{
1022
- warehouse: "warehouse";
1022
+ volume: "volume";
1023
1023
  genie_space: "genie_space";
1024
+ warehouse: "warehouse";
1024
1025
  postgres_project: "postgres_project";
1025
1026
  postgres_branch: "postgres_branch";
1026
1027
  postgres_database: "postgres_database";
1027
- volume: "volume";
1028
1028
  }>;
1029
1029
  select: z.ZodOptional<z.ZodString>;
1030
1030
  display: z.ZodOptional<z.ZodString>;
@@ -1058,12 +1058,12 @@ declare const pluginManifestSchema: z.ZodObject<{
1058
1058
  discovery: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
1059
1059
  type: z.ZodLiteral<"kind">;
1060
1060
  resourceKind: z.ZodEnum<{
1061
- warehouse: "warehouse";
1061
+ volume: "volume";
1062
1062
  genie_space: "genie_space";
1063
+ warehouse: "warehouse";
1063
1064
  postgres_project: "postgres_project";
1064
1065
  postgres_branch: "postgres_branch";
1065
1066
  postgres_database: "postgres_database";
1066
- volume: "volume";
1067
1067
  }>;
1068
1068
  select: z.ZodOptional<z.ZodString>;
1069
1069
  display: z.ZodOptional<z.ZodString>;
@@ -13,9 +13,9 @@ Create a typed database plugin registration for a finalized schema.
13
13
 
14
14
  ## Type Parameters[​](#type-parameters "Direct link to Type Parameters")
15
15
 
16
- | Type Parameter |
17
- | --------------------------------------------------------------------------- |
18
- | `TSchema` *extends* [`Schema`](./docs/api/appkit/Interface.Schema.md) |
16
+ | Type Parameter |
17
+ | ------------------------------------------------------------------------------------- |
18
+ | `TSchema` *extends* [`Schema`](./docs/api/appkit/Interface.Schema.md)<`string`> |
19
19
 
20
20
  ## Parameters[​](#parameters "Direct link to Parameters")
21
21
 
@@ -1,17 +1,25 @@
1
1
  # Function: defineSchema()
2
2
 
3
3
  ```ts
4
- function defineSchema(builder: (context: SchemaBuilderContext) => Record<string, AppKitTable>, options?: DefineSchemaOptions): Schema;
4
+ function defineSchema<TTables>(builder: (context: SchemaBuilderContext) => TTables, options?: DefineSchemaOptions): Schema<Extract<keyof TTables, string>>;
5
5
 
6
6
  ```
7
7
 
8
+ Compile one declared schema. The returned type keeps the table names the builder returned, so `crudRoutes` and `hooks` can name only real tables.
9
+
10
+ ## Type Parameters[​](#type-parameters "Direct link to Type Parameters")
11
+
12
+ | Type Parameter |
13
+ | ----------------------------------------------------- |
14
+ | `TTables` *extends* `Record`<`string`, `AppKitTable`> |
15
+
8
16
  ## Parameters[​](#parameters "Direct link to Parameters")
9
17
 
10
- | Parameter | Type |
11
- | ---------- | ------------------------------------------------------------------------ |
12
- | `builder` | (`context`: `SchemaBuilderContext`) => `Record`<`string`, `AppKitTable`> |
13
- | `options?` | `DefineSchemaOptions` |
18
+ | Parameter | Type |
19
+ | ---------- | ------------------------------------------------ |
20
+ | `builder` | (`context`: `SchemaBuilderContext`) => `TTables` |
21
+ | `options?` | `DefineSchemaOptions` |
14
22
 
15
23
  ## Returns[​](#returns "Direct link to Returns")
16
24
 
17
- [`Schema`](./docs/api/appkit/Interface.Schema.md)
25
+ [`Schema`](./docs/api/appkit/Interface.Schema.md)<`Extract`\<keyof `TTables`, `string`>>
@@ -1,4 +1,12 @@
1
- # Interface: Schema
1
+ # Interface: Schema\<TTableName>
2
+
3
+ One finalized schema. `TTableName` keeps the declared names in the type, so configuration that addresses a table by name is checked against the schema it was written for. Code that accepts any schema uses the default.
4
+
5
+ ## Type Parameters[​](#type-parameters "Direct link to Type Parameters")
6
+
7
+ | Type Parameter | Default type |
8
+ | ------------------------------- | ------------ |
9
+ | `TTableName` *extends* `string` | `string` |
2
10
 
3
11
  ## Properties[​](#properties "Direct link to Properties")
4
12
 
@@ -23,6 +31,6 @@ readonly $schemaName: string;
23
31
  ### $tables[​](#tables "Direct link to $tables")
24
32
 
25
33
  ```ts
26
- readonly $tables: Readonly<Record<string, AppKitTable>>;
34
+ readonly $tables: Readonly<Record<TTableName, AppKitTable>>;
27
35
 
28
36
  ```
@@ -2,6 +2,8 @@
2
2
 
3
3
  ```ts
4
4
  type IDatabaseConfig<TSchema> = {
5
+ crudRoutes?: CrudRoutesConfig<TSchema>;
6
+ hooks?: { readonly [TTable in SchemaTableName<TSchema>]?: { serialize?: ReadSerializer } };
5
7
  schema: TSchema;
6
8
  };
7
9
 
@@ -17,6 +19,24 @@ Configuration for one schema-bound DatabasePlugin instance.
17
19
 
18
20
  ## Properties[​](#properties "Direct link to Properties")
19
21
 
22
+ ### crudRoutes?[​](#crudroutes "Direct link to crudRoutes?")
23
+
24
+ ```ts
25
+ readonly optional crudRoutes: CrudRoutesConfig<TSchema>;
26
+
27
+ ```
28
+
29
+ ***
30
+
31
+ ### hooks?[​](#hooks "Direct link to hooks?")
32
+
33
+ ```ts
34
+ readonly optional hooks: { readonly [TTable in SchemaTableName<TSchema>]?: { serialize?: ReadSerializer } };
35
+
36
+ ```
37
+
38
+ ***
39
+
20
40
  ### schema[​](#schema "Direct link to schema")
21
41
 
22
42
  ```ts
@@ -74,7 +74,7 @@ Documentation merge entry for Typedoc — combines the stable `@databricks/appki
74
74
  | [ResourceRequirement](./docs/api/appkit/Interface.ResourceRequirement.md) | Declares a resource requirement for a plugin. Can be defined statically in a manifest or dynamically via getResourceRequirements(). |
75
75
  | [RunAgentInput](./docs/api/appkit/Interface.RunAgentInput.md) | - |
76
76
  | [RunAgentResult](./docs/api/appkit/Interface.RunAgentResult.md) | - |
77
- | [Schema](./docs/api/appkit/Interface.Schema.md) | - |
77
+ | [Schema](./docs/api/appkit/Interface.Schema.md) | One finalized schema. `TTableName` keeps the declared names in the type, so configuration that addresses a table by name is checked against the schema it was written for. Code that accepts any schema uses the default. |
78
78
  | [SearchRequest](./docs/api/appkit/Interface.SearchRequest.md) | - |
79
79
  | [SearchResponse](./docs/api/appkit/Interface.SearchResponse.md) | - |
80
80
  | [SearchResult](./docs/api/appkit/Interface.SearchResult.md) | - |
@@ -155,7 +155,7 @@ Documentation merge entry for Typedoc — combines the stable `@databricks/appki
155
155
  | [createWorkspaceClient](./docs/api/appkit/Function.createWorkspaceClient.md) | Construct an AppKit workspace client. |
156
156
  | [database](./docs/api/appkit/Function.database.md) | Create a typed database plugin registration for a finalized schema. |
157
157
  | [defineManifest](./docs/api/appkit/Function.defineManifest.md) | Validates a raw manifest (typically a `manifest.json` import) against the canonical Zod schema and returns it as a strict [PluginManifest](./docs/api/appkit/Interface.PluginManifest.md). |
158
- | [defineSchema](./docs/api/appkit/Function.defineSchema.md) | - |
158
+ | [defineSchema](./docs/api/appkit/Function.defineSchema.md) | Compile one declared schema. The returned type keeps the table names the builder returned, so `crudRoutes` and `hooks` can name only real tables. |
159
159
  | [defineTool](./docs/api/appkit/Function.defineTool.md) | Defines a single tool entry for a plugin's internal registry. |
160
160
  | [enumColumn](./docs/api/appkit/Function.enumColumn.md) | - |
161
161
  | [executeFromRegistry](./docs/api/appkit/Function.executeFromRegistry.md) | Validates tool-call arguments against the entry's schema and invokes its handler. On validation failure, returns an LLM-friendly error string (matching the behavior of `tool()`) rather than throwing, so the model can self-correct on its next turn. |
package/llms.txt CHANGED
@@ -93,7 +93,7 @@ npx @databricks/appkit docs <query>
93
93
  - [Function: createWorkspaceClient()](./docs/api/appkit/Function.createWorkspaceClient.md): Construct an AppKit workspace client.
94
94
  - [Function: database()](./docs/api/appkit/Function.database.md): Create a typed database plugin registration for a finalized schema.
95
95
  - [Function: defineManifest()](./docs/api/appkit/Function.defineManifest.md): Validates a raw manifest (typically a manifest.json import) against the
96
- - [Function: defineSchema()](./docs/api/appkit/Function.defineSchema.md): Parameters
96
+ - [Function: defineSchema()](./docs/api/appkit/Function.defineSchema.md): Compile one declared schema. The returned type keeps the table names the
97
97
  - [Function: defineTool()](./docs/api/appkit/Function.defineTool.md): Defines a single tool entry for a plugin's internal registry.
98
98
  - [Function: enumColumn()](./docs/api/appkit/Function.enumColumn.md): Parameters
99
99
  - [Function: executeFromRegistry()](./docs/api/appkit/Function.executeFromRegistry.md): Validates tool-call arguments against the entry's schema and invokes its
@@ -171,7 +171,7 @@ npx @databricks/appkit docs <query>
171
171
  - [Interface: ResourceRequirement](./docs/api/appkit/Interface.ResourceRequirement.md): Declares a resource requirement for a plugin.
172
172
  - [Interface: RunAgentInput](./docs/api/appkit/Interface.RunAgentInput.md): Properties
173
173
  - [Interface: RunAgentResult](./docs/api/appkit/Interface.RunAgentResult.md): Properties
174
- - [Interface: Schema](./docs/api/appkit/Interface.Schema.md): Properties
174
+ - [Interface: Schema<TTableName>](./docs/api/appkit/Interface.Schema.md): One finalized schema. TTableName keeps the declared names in the type, so
175
175
  - [Interface: SearchRequest](./docs/api/appkit/Interface.SearchRequest.md): Properties
176
176
  - [Interface: SearchResponse<T>](./docs/api/appkit/Interface.SearchResponse.md): Type Parameters
177
177
  - [Interface: SearchResult<T>](./docs/api/appkit/Interface.SearchResult.md): Type Parameters
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@databricks/appkit",
3
3
  "type": "module",
4
- "version": "0.67.0",
4
+ "version": "0.69.0",
5
5
  "main": "./dist/index.js",
6
6
  "types": "./dist/index.d.ts",
7
7
  "bin": {