chore: plugin manifest definition by MarioCadenas · Pull Request #82 · databricks/appkit

MarioCadenas · 2026-02-03T17:50:02Z

This PR introduces the definition for manifests, resources and so on for plugins plus the manifests for both analytics and server plugin

chore: make plugin manifest required All plugins must now declare a static manifest property with their metadata and resource requirements. This simplifies the manifest loader and provides better error messages.

Implement manifest loader with validation and error handling. All plugins must have a static manifest property. Features: - getPluginManifest() - loads and validates plugin manifests - getResourceRequirements() - extracts resource requirements - Comprehensive validation with clear error messages - Unit tests and integration tests with core plugins

pkosiec

Overall LGTM, just small comments

pkosiec · 2026-02-04T13:46:06Z

docs/docs/api/appkit/Enumeration.ResourceType.md

Something went wrong with displaying an icon near to the enum in the docs - it falls-back to the "other" category, but it should use enum:

appkit/docs/src/css/custom.css

Lines 112 to 116 in 8dceeb4

.api-kind-enum .menu__link::before {

border-color: var(--api-kind-enum-color);

color: var(--api-kind-enum-color);

content: "E";

}

appkit/docs/sidebars.ts

Lines 35 to 46 in b70ea1c

for (const subItem of item.items) {

// Extract kind from the id (e.g., "Function." from "api/appkit/Function.name")

// To get "function", "class", "interface", etc.

const idParts = subItem.id.split("/").pop() || "";

const rawKind = idParts.split(".")[0].toLowerCase();

const kind = SUPPORTED_KINDS.has(rawKind) ? rawKind : "other";

flatItems.push({

...subItem,

className: `api-kind-${kind}`,

});

}

Could you please check? maybe it's just named "enumeration" or sth, and the fix will be easy. Thanks!

pkosiec · 2026-02-04T13:47:12Z

packages/appkit/src/plugin/plugin.ts

 ]);

-/** Base abstract class for creating AppKit plugins */
+/**


Awesome you documented this 👌

pkosiec · 2026-02-04T13:48:41Z

packages/appkit/src/plugins/analytics/manifest.ts

+        timeout: {
+          type: "number",
+          default: 30000,
+          description: "Query execution timeout in milliseconds",
+        },
+        queriesDir: {
+          type: "string",
+          description: "Directory containing SQL query files",
+        },
+        cacheEnabled: {
+          type: "boolean",
+          default: true,
+          description: "Enable query result caching",
+        },


Timeout is defined on the constructor level, but what about the other properties? 🤔

appkit/packages/appkit/src/plugins/analytics/types.ts

Lines 3 to 5 in 2e1be40

export interface IAnalyticsConfig extends BasePluginConfig {

timeout?: number;

}

pkosiec · 2026-02-04T13:51:18Z

packages/appkit/src/registry/types.ts

+ * Configuration schema definition for plugin config.
+ * Uses JSON Schema format for validation and documentation.
+ */
+export interface ConfigSchema {


Maybe we should already use existing JSON schema types from some library? I believe at some point we'll use some lib to validate the configuration, right?

(totally fine to skip this comment)

packages/appkit/src/registry/manifest-loader.ts

Base automatically changed from refactor-move-core-plugins to main February 4, 2026 10:33

MarioCadenas force-pushed the plugin-manifest-definition branch 2 times, most recently from d218b64 to 0c73331 Compare February 4, 2026 11:00

chore: plugin manifest definition

eb19da1

chore: make plugin manifest required All plugins must now declare a static manifest property with their metadata and resource requirements. This simplifies the manifest loader and provides better error messages.

MarioCadenas force-pushed the plugin-manifest-definition branch from 0c73331 to eb19da1 Compare February 4, 2026 13:18

MarioCadenas force-pushed the plugin-manifest-definition branch from 780c458 to 14b339e Compare February 4, 2026 13:28

MarioCadenas marked this pull request as ready for review February 4, 2026 13:32

MarioCadenas requested a review from pkosiec February 4, 2026 13:32

chore: fixup

3e2badc

pkosiec reviewed Feb 4, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: plugin manifest definition#82

chore: plugin manifest definition#82
MarioCadenas wants to merge 3 commits intomainfrom
plugin-manifest-definition

MarioCadenas commented Feb 3, 2026 •

edited

Loading

Uh oh!

pkosiec left a comment

Uh oh!

pkosiec Feb 4, 2026

Uh oh!

pkosiec Feb 4, 2026

Uh oh!

pkosiec Feb 4, 2026

Uh oh!

pkosiec Feb 4, 2026 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	.api-kind-enum .menu__link::before {
	border-color: var(--api-kind-enum-color);
	color: var(--api-kind-enum-color);
	content: "E";
	}

	for (const subItem of item.items) {
	// Extract kind from the id (e.g., "Function." from "api/appkit/Function.name")
	// To get "function", "class", "interface", etc.
	const idParts = subItem.id.split("/").pop() \|\| "";
	const rawKind = idParts.split(".")[0].toLowerCase();
	const kind = SUPPORTED_KINDS.has(rawKind) ? rawKind : "other";

	flatItems.push({
	...subItem,
	className: `api-kind-${kind}`,
	});
	}

	export interface IAnalyticsConfig extends BasePluginConfig {
	timeout?: number;
	}

Conversation

MarioCadenas commented Feb 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pkosiec left a comment

Choose a reason for hiding this comment

Uh oh!

pkosiec Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

pkosiec Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

pkosiec Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

pkosiec Feb 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

MarioCadenas commented Feb 3, 2026 •

edited

Loading

pkosiec Feb 4, 2026 •

edited

Loading