@databricks/appkit 0.76.1 → 0.77.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 (41) hide show
  1. package/NOTICE.md +10 -12
  2. package/README.md +40 -20
  3. package/dist/appkit/package.js +1 -1
  4. package/dist/cli/commands/plugin/list/list.js +22 -9
  5. package/dist/cli/commands/plugin/list/list.js.map +1 -1
  6. package/dist/cli/commands/plugin/sync/sync.js +10 -2
  7. package/dist/cli/commands/plugin/sync/sync.js.map +1 -1
  8. package/dist/plugins/server/index.js +2 -2
  9. package/dist/plugins/server/index.js.map +1 -1
  10. package/dist/plugins/server/remote-tunnel/remote-tunnel-manager.js +3 -3
  11. package/dist/plugins/server/remote-tunnel/remote-tunnel-manager.js.map +1 -1
  12. package/dist/plugins/server/static-server.js +3 -3
  13. package/dist/plugins/server/static-server.js.map +1 -1
  14. package/dist/plugins/server/utils.js +3 -3
  15. package/dist/plugins/server/utils.js.map +1 -1
  16. package/dist/plugins/server/vite-dev-server.js +4 -4
  17. package/dist/plugins/server/vite-dev-server.js.map +1 -1
  18. package/dist/plugins/serving/manifest.js +3 -2
  19. package/dist/plugins/serving/serving.d.ts +6 -0
  20. package/dist/plugins/serving/serving.d.ts.map +1 -1
  21. package/dist/plugins/serving/serving.js +7 -0
  22. package/dist/plugins/serving/serving.js.map +1 -1
  23. package/dist/schemas/manifest.d.ts +1 -0
  24. package/dist/schemas/manifest.d.ts.map +1 -1
  25. package/dist/schemas/manifest.js +2 -0
  26. package/dist/schemas/manifest.js.map +1 -1
  27. package/dist/shared/src/plugin.d.ts +3 -1
  28. package/dist/shared/src/plugin.d.ts.map +1 -1
  29. package/dist/shared/src/schemas/manifest.d.ts +1 -0
  30. package/dist/shared/src/schemas/manifest.d.ts.map +1 -1
  31. package/dist/shared/src/schemas/manifest.js +2 -0
  32. package/dist/shared/src/schemas/manifest.js.map +1 -1
  33. package/dist/type-generator/database/generate.js +3 -3
  34. package/dist/type-generator/database/generate.js.map +1 -1
  35. package/dist/type-generator/migration.js +2 -2
  36. package/dist/type-generator/migration.js.map +1 -1
  37. package/dist/type-generator/serving/server-file-extractor.js +3 -3
  38. package/dist/type-generator/serving/server-file-extractor.js.map +1 -1
  39. package/docs/api/appkit/Interface.PluginManifest.md +29 -11
  40. package/package.json +2 -2
  41. package/sbom.cdx.json +1 -1
package/docs/api/appkit/Interface.PluginManifest.md CHANGED
@@ -57,6 +57,24 @@ schema: JSONSchema7;
57
57
 
58
58
  ***
59
59
 
60
+ ### deprecated?[​](#deprecated "Direct link to deprecated?")
61
+
62
+ ```ts
63
+ optional deprecated: boolean;
64
+
65
+ ```
66
+
67
+ When true, the plugin is deprecated. It still ships and functions, but tooling (e.g. `appkit plugin list`) may hide or flag it. The recommended replacement is noted in the plugin description.
68
+
69
+ #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")
70
+
71
+ ```ts
72
+ Omit.deprecated
73
+
74
+ ```
75
+
76
+ ***
77
+
60
78
  ### description[​](#description "Direct link to description")
61
79
 
62
80
  ```ts
@@ -66,7 +84,7 @@ description: string;
66
84
 
67
85
  Brief description of what the plugin does
68
86
 
69
- #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")
87
+ #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")
70
88
 
71
89
  ```ts
72
90
  Omit.description
@@ -84,7 +102,7 @@ optional devOnly: boolean;
84
102
 
85
103
  When true, this plugin is only registered when NODE\_ENV === "development". In any other environment createApp skips it entirely (not constructed, no routes, resources not validated). Use for dev-only tooling that must never run in a deployed app.
86
104
 
87
- #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")
105
+ #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")
88
106
 
89
107
  ```ts
90
108
  Omit.devOnly
@@ -102,7 +120,7 @@ displayName: string;
102
120
 
103
121
  Human-readable display name for UI and CLI
104
122
 
105
- #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")
123
+ #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")
106
124
 
107
125
  ```ts
108
126
  Omit.displayName
@@ -120,7 +138,7 @@ optional hidden: boolean;
120
138
 
121
139
  When true, this plugin is excluded from the template plugins manifest (appkit.plugins.json) during sync.
122
140
 
123
- #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")
141
+ #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")
124
142
 
125
143
  ```ts
126
144
  Omit.hidden
@@ -138,7 +156,7 @@ optional keywords: string[];
138
156
 
139
157
  Keywords for plugin discovery
140
158
 
141
- #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")
159
+ #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")
142
160
 
143
161
  ```ts
144
162
  Omit.keywords
@@ -156,7 +174,7 @@ optional license: string;
156
174
 
157
175
  SPDX license identifier
158
176
 
159
- #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")
177
+ #### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")
160
178
 
161
179
  ```ts
162
180
  Omit.license
@@ -192,7 +210,7 @@ optional onSetupMessage: string;
192
210
 
193
211
  Message displayed to the user after project initialization. Use this to inform about manual setup steps (e.g. environment variables, resource provisioning).
194
212
 
195
- #### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")
213
+ #### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")
196
214
 
197
215
  ```ts
198
216
  Omit.onSetupMessage
@@ -210,7 +228,7 @@ optional repository: string;
210
228
 
211
229
  URL to the plugin's source repository
212
230
 
213
- #### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")
231
+ #### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")
214
232
 
215
233
  ```ts
216
234
  Omit.repository
@@ -296,7 +314,7 @@ optional should: string[];
296
314
 
297
315
  ```
298
316
 
299
- #### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")
317
+ #### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")
300
318
 
301
319
  ```ts
302
320
  Omit.scaffolding
@@ -314,7 +332,7 @@ optional stability: "beta" | "ga";
314
332
 
315
333
  Plugin stability level. Beta plugins may have breaking API changes between minor releases but are on a path to GA. GA (general availability) plugins follow semver strictly.
316
334
 
317
- #### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")
335
+ #### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")
318
336
 
319
337
  ```ts
320
338
  Omit.stability
@@ -332,7 +350,7 @@ optional version: string;
332
350
 
333
351
  Plugin version (semver format)
334
352
 
335
- #### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")
353
+ #### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")
336
354
 
337
355
  ```ts
338
356
  Omit.version
package/package.json CHANGED
@@ -1,13 +1,13 @@
1
1
  {
2
2
  "name": "@databricks/appkit",
3
3
  "type": "module",
4
- "version": "0.76.1",
4
+ "version": "0.77.0",
5
5
  "main": "./dist/index.js",
6
6
  "types": "./dist/index.d.ts",
7
7
  "bin": {
8
8
  "appkit": "./bin/appkit.js"
9
9
  },
10
- "packageManager": "pnpm@10.21.0",
10
+ "packageManager": "pnpm@11.0.8",
11
11
  "license": "Apache-2.0",
12
12
  "repository": {
13
13
  "type": "git",