@appkit/dek-plugin 0.25.0 → 0.26.0

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-export type { DekPlugin, DekPluginBoardItem, DekPluginComponentItem, DekPluginConfig, DekPluginElementFactoryWithProps, DekPluginElementProps, DekPluginFactory, DekPluginSchema, DekPluginSchemaItem, DekPluginScreenItem, } from './lib/plugins';
+export type { DekIntegration, DekPlugin, DekPluginBoardItem, DekPluginComponentItem, DekPluginConfig, DekPluginElementFactoryWithProps, DekPluginElementProps, DekPluginFactory, DekPluginSchema, DekPluginSchemaItem, DekPluginSchemaItemOption, DekPluginSchemaType, DekPluginScreenItem, } from './lib/plugins';
 export type { DekRegistry, DekRegistryCollection, DekRegistryCollectionItem, DekRegistrySchema, DekRegistrySchemaItem, DekRegistrySchemaProps, DekRegistrySchemaPropsItem, } from './lib/registry';
-export type { DekApi, DekApiInfo, DekApiMessage, DekApiMessageType, DekApiPlugin, DekApiState, } from './lib/api';
+export type { DekApi, DekApiInfo, DekApiMessage, DekApiMessageType, DekApiIntegration as DekApiPlugin, DekApiState, DekBoard, DekBoardBase, DekBoardProperty, DekCommand, DekCommandGroup, DekComponent, DekZone, } from './lib/api';
 export { default as usePluginState } from './lib/hooks/usePluginState';
 export { default as usePluginStateObject } from './lib/hooks/usePluginStateObject';
 export declare function __debug(): void;

package/dist/index.es.js

@@ -188,8 +188,8 @@ class Api {
   messages() {
     return this.internal.messages();
   }
-  plugin(name) {
-    return this.internal.plugin(name);
+  integration(key) {
+    return this.internal.integration(key);
   }
   get registry() {
     return this.internal.registry;
@@ -221,26 +221,26 @@ class Api {
   open(boardKey) {
     this.internal.open(boardKey);
   }
-  get plugins() {
-    return this.internal.plugins;
+  get integrations() {
+    return this.internal.integrations;
   }
   get api() {
-    return this.plugin(this.integrationKey).api;
+    return this.integration(this.integrationKey).api;
   }
   get state() {
-    return this.plugin(this.integrationKey).state;
+    return this.integration(this.integrationKey).state;
   }
   get info() {
-    return this.plugin(this.integrationKey).info;
+    return this.integration(this.integrationKey).info;
   }
   component(key, props) {
-    return this.plugin(this.integrationKey).component(key, props);
+    return this.integration(this.integrationKey).component(key, props);
   }
   componentSchema(key) {
-    return this.plugin(this.integrationKey).componentSchema(key);
+    return this.integration(this.integrationKey).componentSchema(key);
   }
   screen(path) {
-    return this.plugin(this.integrationKey).screen(path);
+    return this.integration(this.integrationKey).screen(path);
   }
 }
 class ApiInternal {
@@ -274,8 +274,8 @@ class ApiInternal {
   messages() {
     return this.globals.messages;
   }
-  plugin(name) {
-    return this.createPluginWrapper(name);
+  integration(key) {
+    return this.createIntegrationWrapper(key);
   }
   get registry() {
     return this.globals.registry;
@@ -288,6 +288,8 @@ class ApiInternal {
   }
   get board() {
     return this.boards.find((board) => board.key === this.boardKey) || {
+      title: "Missing board",
+      key: "#error",
       zones: []
     };
   }
@@ -309,20 +311,20 @@ class ApiInternal {
   open(boardKey) {
     this.globals.setLocation(`/${boardKey}`);
   }
-  createPluginWrapper(integrationKey) {
-    const plugin = this.getPluginInstance(integrationKey);
-    const available = !!plugin;
+  createIntegrationWrapper(integrationKey) {
+    const integration = this.getIntegrationInstance(integrationKey);
+    const available = !!integration;
     return {
       available,
       info: {
-        components: (plugin == null ? void 0 : plugin.components) ? plugin.components.map((component) => component.key) : [],
-        screens: (plugin == null ? void 0 : plugin.screens) ? plugin.screens.map((screen) => screen.path) : []
+        components: (integration == null ? void 0 : integration.components) ? integration.components.map((component) => component.key) : [],
+        screens: (integration == null ? void 0 : integration.screens) ? integration.screens.map((screen) => screen.path) : []
       },
       component: (key, props) => this.getComponent(integrationKey, key, props),
       componentSchema: (key) => this.getComponentSchema(integrationKey, key),
       screen: (path) => this.getScreen(integrationKey, path),
       board: (key) => this.getBoard(integrationKey, key),
-      api: (plugin == null ? void 0 : plugin.api) || {},
+      api: (integration == null ? void 0 : integration.api) || {},
       state: {
         get: (key, defaultValue) => {
           if (!available) {
@@ -342,20 +344,20 @@ class ApiInternal {
   get globals() {
     return window.__dek_globals;
   }
-  get plugins() {
-    const plugins = {};
-    Object.keys(this.globals.pluginInstances).forEach((key) => {
-      plugins[key] = this.createPluginWrapper(key);
+  get integrations() {
+    const integrations = {};
+    Object.keys(this.globals.integrationInstances).forEach((key) => {
+      integrations[key] = this.createIntegrationWrapper(key);
     });
-    return plugins;
+    return integrations;
   }
-  getPluginInstance(integrationKey) {
-    return this.globals.pluginInstances[integrationKey];
+  getIntegrationInstance(integrationKey) {
+    return this.globals.integrationInstances[integrationKey];
   }
   getComponent(integrationKey, componentKey, props) {
-    const plugin = this.getPluginInstance(integrationKey);
-    if (plugin) {
-      const component = plugin.components && plugin.components.find(
+    const integration = this.getIntegrationInstance(integrationKey);
+    if (integration) {
+      const component = integration.components && integration.components.find(
         (c) => c.key.toLowerCase() === componentKey.toLowerCase()
       );
       if (!component) {
@@ -363,15 +365,15 @@ class ApiInternal {
       }
       return component.element({
         ...props,
-        plugin,
+        plugin: integration,
         api: new Api(integrationKey)
       });
     }
   }
   getComponentSchema(integrationKey, componentKey) {
-    const plugin = this.getPluginInstance(integrationKey);
-    if (plugin) {
-      const component = plugin.components && plugin.components.find(
+    const integration = this.getIntegrationInstance(integrationKey);
+    if (integration) {
+      const component = integration.components && integration.components.find(
         (c) => c.key.toLowerCase() === componentKey.toLowerCase()
       );
       if (component) {
@@ -382,29 +384,35 @@ class ApiInternal {
   }
   getScreen(integrationKey, screenPath) {
     if (integrationKey) {
-      const plugin = this.getPluginInstance(integrationKey);
-      if (plugin) {
-        const component = plugin.screens && plugin.screens.find(
+      const integration = this.getIntegrationInstance(integrationKey);
+      if (integration) {
+        const component = integration.screens && integration.screens.find(
           (s) => s.path.toLowerCase() === screenPath.toLowerCase()
         );
         if (!component) {
           return;
         }
-        return component.element({ plugin, api: new Api(integrationKey) });
+        return component.element({
+          plugin: integration,
+          api: new Api(integrationKey)
+        });
       }
     }
   }
   getBoard(integrationKey, boardKey) {
     if (integrationKey) {
-      const plugin = this.getPluginInstance(integrationKey);
-      if (plugin) {
-        const component = plugin.boards && plugin.boards.find(
+      const integration = this.getIntegrationInstance(integrationKey);
+      if (integration) {
+        const component = integration.boards && integration.boards.find(
           (c) => c.key.toLowerCase() === boardKey.toLowerCase()
         );
         if (!component) {
           return;
         }
-        return component.element({ plugin, api: new Api(integrationKey) });
+        return component.element({
+          plugin: integration,
+          api: new Api(integrationKey)
+        });
       }
     }
   }

package/dist/index.umd.js

@@ -191,8 +191,8 @@ var __publicField = (obj, key, value) => {
     messages() {
       return this.internal.messages();
     }
-    plugin(name) {
-      return this.internal.plugin(name);
+    integration(key) {
+      return this.internal.integration(key);
     }
     get registry() {
       return this.internal.registry;
@@ -224,26 +224,26 @@ var __publicField = (obj, key, value) => {
     open(boardKey) {
       this.internal.open(boardKey);
     }
-    get plugins() {
-      return this.internal.plugins;
+    get integrations() {
+      return this.internal.integrations;
     }
     get api() {
-      return this.plugin(this.integrationKey).api;
+      return this.integration(this.integrationKey).api;
     }
     get state() {
-      return this.plugin(this.integrationKey).state;
+      return this.integration(this.integrationKey).state;
     }
     get info() {
-      return this.plugin(this.integrationKey).info;
+      return this.integration(this.integrationKey).info;
     }
     component(key, props) {
-      return this.plugin(this.integrationKey).component(key, props);
+      return this.integration(this.integrationKey).component(key, props);
     }
     componentSchema(key) {
-      return this.plugin(this.integrationKey).componentSchema(key);
+      return this.integration(this.integrationKey).componentSchema(key);
     }
     screen(path) {
-      return this.plugin(this.integrationKey).screen(path);
+      return this.integration(this.integrationKey).screen(path);
     }
   }
   class ApiInternal {
@@ -277,8 +277,8 @@ var __publicField = (obj, key, value) => {
     messages() {
       return this.globals.messages;
     }
-    plugin(name) {
-      return this.createPluginWrapper(name);
+    integration(key) {
+      return this.createIntegrationWrapper(key);
     }
     get registry() {
       return this.globals.registry;
@@ -291,6 +291,8 @@ var __publicField = (obj, key, value) => {
     }
     get board() {
       return this.boards.find((board) => board.key === this.boardKey) || {
+        title: "Missing board",
+        key: "#error",
         zones: []
       };
     }
@@ -312,20 +314,20 @@ var __publicField = (obj, key, value) => {
     open(boardKey) {
       this.globals.setLocation(`/${boardKey}`);
     }
-    createPluginWrapper(integrationKey) {
-      const plugin = this.getPluginInstance(integrationKey);
-      const available = !!plugin;
+    createIntegrationWrapper(integrationKey) {
+      const integration = this.getIntegrationInstance(integrationKey);
+      const available = !!integration;
       return {
         available,
         info: {
-          components: (plugin == null ? void 0 : plugin.components) ? plugin.components.map((component) => component.key) : [],
-          screens: (plugin == null ? void 0 : plugin.screens) ? plugin.screens.map((screen) => screen.path) : []
+          components: (integration == null ? void 0 : integration.components) ? integration.components.map((component) => component.key) : [],
+          screens: (integration == null ? void 0 : integration.screens) ? integration.screens.map((screen) => screen.path) : []
         },
         component: (key, props) => this.getComponent(integrationKey, key, props),
         componentSchema: (key) => this.getComponentSchema(integrationKey, key),
         screen: (path) => this.getScreen(integrationKey, path),
         board: (key) => this.getBoard(integrationKey, key),
-        api: (plugin == null ? void 0 : plugin.api) || {},
+        api: (integration == null ? void 0 : integration.api) || {},
         state: {
           get: (key, defaultValue) => {
             if (!available) {
@@ -345,20 +347,20 @@ var __publicField = (obj, key, value) => {
     get globals() {
       return window.__dek_globals;
     }
-    get plugins() {
-      const plugins = {};
-      Object.keys(this.globals.pluginInstances).forEach((key) => {
-        plugins[key] = this.createPluginWrapper(key);
+    get integrations() {
+      const integrations = {};
+      Object.keys(this.globals.integrationInstances).forEach((key) => {
+        integrations[key] = this.createIntegrationWrapper(key);
       });
-      return plugins;
+      return integrations;
     }
-    getPluginInstance(integrationKey) {
-      return this.globals.pluginInstances[integrationKey];
+    getIntegrationInstance(integrationKey) {
+      return this.globals.integrationInstances[integrationKey];
     }
     getComponent(integrationKey, componentKey, props) {
-      const plugin = this.getPluginInstance(integrationKey);
-      if (plugin) {
-        const component = plugin.components && plugin.components.find(
+      const integration = this.getIntegrationInstance(integrationKey);
+      if (integration) {
+        const component = integration.components && integration.components.find(
           (c) => c.key.toLowerCase() === componentKey.toLowerCase()
         );
         if (!component) {
@@ -366,15 +368,15 @@ var __publicField = (obj, key, value) => {
         }
         return component.element({
           ...props,
-          plugin,
+          plugin: integration,
           api: new Api(integrationKey)
         });
       }
     }
     getComponentSchema(integrationKey, componentKey) {
-      const plugin = this.getPluginInstance(integrationKey);
-      if (plugin) {
-        const component = plugin.components && plugin.components.find(
+      const integration = this.getIntegrationInstance(integrationKey);
+      if (integration) {
+        const component = integration.components && integration.components.find(
           (c) => c.key.toLowerCase() === componentKey.toLowerCase()
         );
         if (component) {
@@ -385,29 +387,35 @@ var __publicField = (obj, key, value) => {
     }
     getScreen(integrationKey, screenPath) {
       if (integrationKey) {
-        const plugin = this.getPluginInstance(integrationKey);
-        if (plugin) {
-          const component = plugin.screens && plugin.screens.find(
+        const integration = this.getIntegrationInstance(integrationKey);
+        if (integration) {
+          const component = integration.screens && integration.screens.find(
             (s) => s.path.toLowerCase() === screenPath.toLowerCase()
           );
           if (!component) {
             return;
           }
-          return component.element({ plugin, api: new Api(integrationKey) });
+          return component.element({
+            plugin: integration,
+            api: new Api(integrationKey)
+          });
         }
       }
     }
     getBoard(integrationKey, boardKey) {
       if (integrationKey) {
-        const plugin = this.getPluginInstance(integrationKey);
-        if (plugin) {
-          const component = plugin.boards && plugin.boards.find(
+        const integration = this.getIntegrationInstance(integrationKey);
+        if (integration) {
+          const component = integration.boards && integration.boards.find(
             (c) => c.key.toLowerCase() === boardKey.toLowerCase()
           );
           if (!component) {
             return;
           }
-          return component.element({ plugin, api: new Api(integrationKey) });
+          return component.element({
+            plugin: integration,
+            api: new Api(integrationKey)
+          });
         }
       }
     }

package/dist/lib/api.d.ts

@@ -5,6 +5,38 @@ import { DekApiStateType } from './state';
 export type SetLocationFunc = (to: string, options?: {
     replace?: boolean | undefined;
 } | undefined) => void;
+export type DekBoardProperty = {
+    key: string;
+    value: string;
+};
+export type DekComponent = {
+    integration: string;
+    component: string;
+    props: DekBoardProperty[];
+    containerProps: DekBoardProperty[];
+};
+export type DekCommand = DekComponent & {
+    title: string;
+};
+export type DekCommandGroup = {
+    key: string;
+    title: string;
+    commands: DekCommand[];
+};
+export type DekZone = DekComponent & {
+    key: string;
+};
+export type DekBoardBase = {
+    integration: string;
+    key: string;
+};
+export type DekBoard = {
+    title: string;
+    key: string;
+    layout?: string | null;
+    base?: DekBoardBase | null;
+    zones: DekZone[];
+};
 export type DekApiState = {
     get: (key: string, defaultValue?: DekApiStateType) => DekApiStateType | undefined;
     set: (key: string, value: DekApiStateType) => void;
@@ -13,7 +45,7 @@ export type DekApiInfo = {
     components: string[];
     screens: string[];
 };
-export type DekApiPlugin = {
+export type DekApiIntegration = {
     available: boolean;
     component: (key: string, props?: any) => JSX.Element | undefined;
     componentSchema: (key: string) => DekPluginSchema;
@@ -35,36 +67,36 @@ export type DekApiInternal = {
     warn: (integrationKey: string, message: string, ...data: any[]) => void;
     error: (integrationKey: string, message: string, ...data: any[]) => void;
     messages: () => DekApiMessage[];
-    plugin: (name: string) => DekApiPlugin;
+    integration: (key: string) => DekApiIntegration;
     registry: DekRegistry;
     boardKey: string;
-    boards: Record<string, any>;
-    board: any;
+    boards: DekBoard[];
+    board: DekBoard;
     layout: string;
-    commandGroups: Record<string, any>;
+    commandGroups: DekCommandGroup[];
     navigate: (path: string) => void;
     navigateParams: Record<string, string | undefined>;
     navigateBack: () => void;
     open: (boardKey: string) => void;
-    plugins: Record<string, DekApiPlugin>;
+    integrations: Record<string, DekApiIntegration>;
 };
 export type DekApi = {
     trace: (message: string, ...data: any[]) => void;
     warn: (message: string, ...data: any[]) => void;
     error: (message: string, ...data: any[]) => void;
     messages: () => DekApiMessage[];
-    plugin: (name: string) => DekApiPlugin;
+    integration: (key: string) => DekApiIntegration;
     registry: DekRegistry;
     boardKey: string;
-    boards: Record<string, any>;
-    board: any;
+    boards: DekBoard[];
+    board: DekBoard;
     layout: string;
-    commandGroups: Record<string, any>;
+    commandGroups: DekCommandGroup[];
     navigate: (path: string) => void;
     navigateParams: Record<string, string | undefined>;
     navigateBack: () => void;
     open: (boardKey: string) => void;
-    plugins: Record<string, DekApiPlugin>;
+    integrations: Record<string, DekApiIntegration>;
 };
 export declare class Api implements DekApi {
     integrationKey: string;
@@ -74,18 +106,18 @@ export declare class Api implements DekApi {
     warn(message: string, ...data: any[]): void;
     error(message: string, ...data: any[]): void;
     messages(): DekApiMessage[];
-    plugin(name: string): DekApiPlugin;
+    integration(key: string): DekApiIntegration;
     get registry(): DekRegistry;
     get boardKey(): string;
-    get boards(): Record<string, any>;
-    get board(): any;
+    get boards(): DekBoard[];
+    get board(): DekBoard;
     get layout(): string;
-    get commandGroups(): Record<string, any>;
+    get commandGroups(): DekCommandGroup[];
     navigate(path: string): void;
     get navigateParams(): Record<string, string | undefined>;
     navigateBack(): void;
     open(boardKey: string): void;
-    get plugins(): Record<string, DekApiPlugin>;
+    get integrations(): Record<string, DekApiIntegration>;
     get api(): any;
     get state(): DekApiState;
     get info(): DekApiInfo;
@@ -98,21 +130,21 @@ export declare class ApiInternal implements DekApiInternal {
     warn(integrationKey: string, message: string, ...data: any[]): void;
     error(integrationKey: string, message: string, ...data: any[]): void;
     messages(): DekApiMessage[];
-    plugin(name: string): DekApiPlugin;
+    integration(key: string): DekApiIntegration;
     get registry(): DekRegistry;
     get boardKey(): string;
-    get boards(): Record<string, any>;
-    get board(): any;
+    get boards(): DekBoard[];
+    get board(): DekBoard;
     get layout(): string;
-    get commandGroups(): Record<string, any>;
+    get commandGroups(): DekCommandGroup[];
     navigate(path: string): void;
     get navigateParams(): Record<string, string | undefined>;
     navigateBack(): void;
     open(boardKey: string): void;
-    private createPluginWrapper;
+    private createIntegrationWrapper;
     private get globals();
-    get plugins(): Record<string, DekApiPlugin>;
-    private getPluginInstance;
+    get integrations(): Record<string, DekApiIntegration>;
+    private getIntegrationInstance;
     private getComponent;
     private getComponentSchema;
     private getScreen;

package/dist/lib/plugins.d.ts

@@ -44,3 +44,4 @@ export type DekPlugin = {
 };
 export declare class DekPluginFactory implements DekPlugin {
 }
+export type DekIntegration = DekPlugin;

package/package.json

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