@appkit/dek-plugin 0.3.4 → 0.5.0

package/dist/lib/api.d.ts

@@ -1,39 +1,59 @@
 /// <reference types="react" />
 import { DekPluginSchema } from './plugins';
+import { DekRegistry } from './registry';
+import { DekApiStateType } from './state';
 export type SetLocationFunc = (to: string, options?: {
     replace?: boolean | undefined;
 } | undefined) => void;
-export type ApiState = {
-    get: (key: string, defaultValue?: string | number) => string | number | undefined;
-    set: (key: string, value: string | number) => void;
+export type DekApiState = {
+    get: (key: string, defaultValue?: DekApiStateType) => DekApiStateType | undefined;
+    set: (key: string, value: DekApiStateType) => void;
 };
-type ApiInfo = {
+export type DekApiInfo = {
     components: string[];
     screens: string[];
 };
-type ApiPlugin = {
+export type DekApiPlugin = {
     available: boolean;
     component: (key: string, props?: any) => JSX.Element | undefined;
     componentSchema: (key: string) => DekPluginSchema;
     screen: (path: string) => JSX.Element | undefined;
     board: (key: string) => JSX.Element | undefined;
     api: any;
-    state: ApiState;
-    info: ApiInfo;
+    state: DekApiState;
+    info: DekApiInfo;
 };
-export type BoardApiMessageType = 'trace' | 'error';
-export type BoardApiMessage = {
-    type: BoardApiMessageType;
+export type DekApiMessageType = 'trace' | 'error' | 'warn';
+export type DekApiMessage = {
+    type: DekApiMessageType;
     body: string;
     data?: any[];
     at: number;
 };
-export declare class Api {
-    private messageArray;
+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;
+    registry: DekRegistry;
+    boardKey: string;
+    boards: Record<string, any>;
+    board: any;
+    layout: string;
+    commandGroups: Record<string, any>;
+    navigate: (path: string) => void;
+    navigateBack: () => void;
+    open: (boardKey: string) => void;
+    plugins: Record<string, DekApiPlugin>;
+};
+export declare class Api implements DekApi {
     trace(message: string, ...data: any[]): void;
+    warn(message: string, ...data: any[]): void;
     error(message: string, ...data: any[]): void;
-    messages(): BoardApiMessage[];
-    plugin(name: string): ApiPlugin;
+    messages(): DekApiMessage[];
+    plugin(name: string): DekApiPlugin;
+    get registry(): DekRegistry;
     get boardKey(): string;
     get boards(): Record<string, any>;
     get board(): any;
@@ -44,12 +64,12 @@ export declare class Api {
     open(boardKey: string): void;
     private createPluginWrapper;
     private get globals();
-    get plugins(): Record<string, ApiPlugin>;
+    get plugins(): Record<string, DekApiPlugin>;
     private getPluginInstance;
     private getComponent;
     private getComponentSchema;
     private getScreen;
     private getBoard;
 }
-declare const _default: Api;
-export default _default;
+declare const api: Api;
+export default api;

package/dist/lib/hooks/usePluginApi.d.ts

@@ -1,3 +1,3 @@
-import { Api } from '../api';
-declare function usePluginApi(): Api;
+import { DekApi } from '../api';
+declare function usePluginApi(): DekApi;
 export default usePluginApi;

package/dist/lib/hooks/usePluginState.d.ts

@@ -1,2 +1,9 @@
-declare function usePluginState(plugin: string): Record<string, string | number>;
+import { DekApiStateType } from '../state';
+export type ApiSetStateAction = (value: DekApiStateType) => void;
+declare function usePluginState(plugin: string, key: string): [DekApiStateType | undefined, ApiSetStateAction];
+declare function usePluginState(plugin: string, key: string, defaultValue: string): [string, ApiSetStateAction];
+declare function usePluginState(plugin: string, key: string, defaultValue: number): [number, ApiSetStateAction];
+declare function usePluginState(plugin: string, key: string, defaultValue: boolean): [boolean, ApiSetStateAction];
+declare function usePluginState(plugin: string, key: string, defaultValue: Array<any>): [Array<any>, ApiSetStateAction];
+declare function usePluginState(plugin: string, key: string, defaultValue: Record<string, any>): [Record<string, any>, ApiSetStateAction];
 export default usePluginState;

package/dist/lib/plugins.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="react" />
+import { DekApi } from './api';
 export type PluginElementFactoryWithProps = (props: any) => JSX.Element;
 export type PluginElementFactory = () => JSX.Element;
 export type DekPluginSchemaItem = {
@@ -23,7 +24,7 @@ export type DekPluginBoardItem = {
 };
 export type DekPluginConfig = Record<string, string>;
 export type DekPlugin = {
-    load?: (config: DekPluginConfig) => Promise<void>;
+    load?: (api: DekApi) => Promise<void>;
     unload?: () => Promise<void>;
     components?: DekPluginComponentItem[];
     screens?: DekPluginScreenItem[];

package/dist/lib/registry.d.ts

@@ -0,0 +1,26 @@
+export type DekRegistrySchemaPropsItem = {
+    type: 'string' | 'number' | 'boolean' | 'list' | 'color';
+    title: string;
+    default?: any;
+};
+export type DekRegistrySchemaProps = Record<string, DekRegistrySchemaPropsItem>;
+export type DekRegistrySchemaItem = {
+    type: 'string' | 'number' | 'boolean' | 'component' | 'array' | 'props';
+    title: string;
+    required: boolean;
+};
+export type DekRegistrySchema = Record<string, DekRegistrySchemaItem>;
+export type DekRegistryCollectionItem = Record<string, any>;
+export type DekRegistryCollection = {
+    key: string;
+    name: string;
+    schema: DekRegistrySchema;
+    items: Record<string, DekRegistryCollectionItem>;
+};
+export type DekRegistry = {
+    collections: Record<string, DekRegistryCollection>;
+    collection: (collectionKey: string) => DekRegistryCollection | undefined;
+    collectionItems: (collectionKey: string) => DekRegistryCollectionItem[] | undefined;
+    registerCollection: (collectionKey: string, name: string, schema: Record<string, DekRegistrySchemaItem>) => void;
+    registerCollectionItem: (collectionKey: string, itemKey: string, item: DekRegistryCollectionItem) => void;
+};

package/dist/lib/state.d.ts

@@ -1,5 +1,8 @@
-export type ApiState = Record<string, Record<string, string | number>>;
-declare const state: ApiState;
-export declare function setState(plugin: string, key: string, value: string | number): void;
-export declare function getState(plugin: string, key: string): string | number | undefined;
-export default state;
+export type DekApiStateType = string | number | boolean | Array<any> | Record<string, any>;
+export type DekApiStateItem = Record<string, DekApiStateType>;
+export type DekApiState = Record<string, DekApiStateItem>;
+export declare function setState(plugin: string, key: string, value: DekApiStateType): void;
+export declare function getState(plugin: string, key: string): DekApiStateType | undefined;
+export declare function tryParseJson(jsonString: string, defaultValue?: {}): object;
+export declare function useState(plugin: string): DekApiStateItem;
+export declare function isJsonString(str: any): boolean;

package/dist/lib/utils/extractErrorMessage.d.ts

@@ -0,0 +1 @@
+export default function extractErrorMessage(err: unknown): string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@appkit/dek-plugin",
   "private": false,
-  "version": "0.3.4",
+  "version": "0.5.0",
   "type": "module",
   "scripts": {
     "dev": "vite",
@@ -11,7 +11,8 @@
   },
   "dependencies": {
     "react": "^16.8.0 || 17.x || 18.x",
-    "react-dom": "^16.8.0 || 17.x || 18.x"
+    "react-dom": "^16.8.0 || 17.x || 18.x",
+    "usehooks-ts": "^2.9.1"
   },
   "devDependencies": {
     "@types/react": "^18.2.15",

package/dist/lib/hooks/usePluginStateValue.d.ts

@@ -1,4 +0,0 @@
-declare function usePluginStateValue(plugin: string, key: string): string | number | undefined;
-declare function usePluginStateValue(plugin: string, key: string, defaultValue: string): string;
-declare function usePluginStateValue(plugin: string, key: string, defaultValue: number): number;
-export default usePluginStateValue;