@tenorlab/react-dashboard 1.0.3 → 1.0.4

package/dist/components/interfaces/core.base.d.ts

@@ -60,7 +60,7 @@ export type TWidgetFactoryBase<TFrameworkComponent = any> = () => Promise<{
  * TFrameworkElementType: see TWidgetMetaInfoBase
  * TFrameworkComponentType: i.e. React.ComponentType<any> (see TWidgetFactoryBase)
  */
-export interface IDynamicWidgetCatalogEntryBase<TFrameworkElementType, TFrameworkComponentType> {
+export interface IDynamicWidgetCatalogEntryBase<TFrameworkElementType = any, TFrameworkComponentType = any> {
     key: TDashboardWidgetKey;
     title: string;
     isContainer?: boolean;
@@ -74,3 +74,7 @@ export type TGetDefaultWidgetMetaFromKeyOptions = {
     description?: string;
 };
 export type TGetDefaultWidgetMetaFromKey = (widgetKey: TDashboardWidgetKey, options?: TGetDefaultWidgetMetaFromKeyOptions) => TWidgetMetaInfoBase<any>;
+export type TManifestEntry = {
+    url: string;
+    meta: TWidgetMetaInfoBase;
+};

package/dist/components/interfaces/core.utils.d.ts

@@ -1,4 +1,4 @@
-import type { TDashboardWidgetKey, TWidgetMetaInfoBase, TDashboardWidgetCatalogBase, TGetDefaultWidgetMetaFromKey } from './core.base';
+import type { TDashboardWidgetKey, TWidgetMetaInfoBase, TDashboardWidgetCatalogBase, TGetDefaultWidgetMetaFromKey, TWidgetFactoryBase, IDynamicWidgetCatalogEntryBase } from './core.base';
 import type { IDashboardConfig } from './core.interfaces';
 export declare const blankDashboardConfig: IDashboardConfig;
 export declare const DashboardMinZoomScale: 0.7;
@@ -6,6 +6,13 @@ export declare const DashboardMaxZoomScale: 1;
 export declare const DashboardZoomStep: 0.05;
 export declare const ensureZoomScaleIsWithinRange: (value: number) => number;
 export declare const getNewZoomScaleWithinRange: (currentZoomScale: number, direction: -1 | 1) => number;
+export declare const removeEmptyContainers: (dashboardConfig: IDashboardConfig) => IDashboardConfig;
+/**
+ * @name ensureContainersSequence
+ * @description
+ * Ensures that the container widgets are numbered sequentially in the dashboardConfig, but the original order is preserved.
+ */
+export declare const ensureContainersSequence: (dashboardConfig: IDashboardConfig) => IDashboardConfig;
 export declare const getDefaultWidgetMetaFromKey: TGetDefaultWidgetMetaFromKey;
 /**
  * @name getDefaultWidgetMetaFromMap
@@ -20,10 +27,25 @@ export declare const getDefaultWidgetMetaFromMap: <TFrameworkElementType = any>(
  * @description Helper to get widget meta info from the catalog by key.
  */
 export declare const getWidgetMetaFromCatalog: <TFrameworkElementType = any, TFrameworkComponentType = any>(widgetKey: TDashboardWidgetKey, widgetsCatalog: TDashboardWidgetCatalogBase<TFrameworkElementType, TFrameworkComponentType>) => TWidgetMetaInfoBase<TFrameworkElementType>;
-export declare const removeEmptyContainers: (dashboardConfig: IDashboardConfig) => IDashboardConfig;
 /**
- * @name ensureContainersSequence
- * @description
- * Ensures that the container widgets are numbered sequentially in the dashboardConfig, but the original order is preserved.
+ * @name createStaticEntry
+ * Helper function to create static entries
+ * This helps keep the catalog registration clean
  */
-export declare const ensureContainersSequence: (dashboardConfig: IDashboardConfig) => IDashboardConfig;
+export declare const createStaticEntry: <TFrameworkComponentType = any>(key: string, component: TFrameworkComponentType) => [string, IDynamicWidgetCatalogEntryBase];
+/**
+ * @name createDynamicEntry
+ * Helper function to create dynamic entries
+ * This helps keep the catalog registration clean
+ */
+export declare const createDynamicEntry: (key: string, loader: TWidgetFactoryBase, meta: TWidgetMetaInfoBase) => [string, IDynamicWidgetCatalogEntryBase];
+export declare const parseKeyAndTitleFromFilePath: (path: string) => {
+    key: TDashboardWidgetKey;
+    title: string;
+    folder: string;
+} | null;
+export declare const remoteWidgetDiscovery: (manifestUrl: string) => Promise<{
+    entries: [string, IDynamicWidgetCatalogEntryBase][];
+    message: string;
+    details: string;
+}>;