@appkit/dek-plugin 0.37.0 → 0.46.0

package/README.md

@@ -1,3 +1,46 @@
-# Dek Plugin
+# @appkit/dek-plugin
 
-This provides types and hooks for building Dek plugins.
+The plugin SDK for building DEK plugins. Provides type definitions, the `DekApi` implementation, and React hooks for plugin state.
+
+## Installation
+
+```bash
+npm install @appkit/dek-plugin
+```
+
+## Usage
+
+```typescript
+import { DekApi, DekPlugin, DekPluginComponentItem } from '@appkit/dek-plugin';
+
+class Plugin implements DekPlugin {
+  constructor(config: Record<string, string>) {
+    this.config = config;
+  }
+
+  async load(api: DekApi) {
+    api.trace('Plugin loaded');
+  }
+
+  async unload() {}
+
+  get components(): DekPluginComponentItem[] {
+    return [
+      {
+        key: 'my-card',
+        element: (props: any) => <MyCard {...props} />,
+        schema: {
+          title: { type: 'string', title: 'Title', default: 'Hello' }
+        }
+      }
+    ];
+  }
+}
+
+export default Plugin;
+```
+
+## Documentation
+
+- [API Reference](docs/api-reference.md) — Full DekPlugin interface, DekApi methods, DekRegistry, schema types
+- [Plugin Development Guide](../../docs/plugin-development.md) — Step-by-step guide to building plugins

package/dist/lib/plugins.d.ts

@@ -11,7 +11,7 @@ export type DekPluginSchemaItemOption = {
 };
 export type DekPluginSchemaType = 'string' | 'number' | 'boolean' | 'list' | 'color' | 'object' | 'styles';
 export type DekPluginSchemaItem = {
-    type: string;
+    type: DekPluginSchemaType;
     title?: string;
     default?: any;
     options?: DekPluginSchemaItemOption[];
@@ -22,11 +22,13 @@ export type DekPluginSchema = Record<string, DekPluginSchemaItem>;
 export type DekPluginComponentItem = {
     key: string;
     description?: string;
+    isCommand?: boolean;
     element: DekPluginElementFactoryWithProps;
     schema?: DekPluginSchema;
 };
 export type DekPluginScreenItem = {
     path: string;
+    description?: string;
     element: DekPluginElementFactoryWithProps;
 };
 export type DekPluginBoardItem = {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@appkit/dek-plugin",
   "private": false,
-  "version": "0.37.0",
+  "version": "0.46.0",
   "type": "module",
   "scripts": {
     "dev": "vite",