@perses-dev/plugin-system 0.8.0 → 0.9.0

package/dist/components/PluginRegistry/legacy/PluginRegistry.js

@@ -1 +0,0 @@
-import{jsx as _jsx}from"react/jsx-runtime";import{createContext,useContext,useMemo,useCallback}from"react";import{useQuery}from"react-query";import{useRegistryState}from"./registry-state";export function PluginRegistry(e){const{children:t,getInstalledPlugins:i,importPluginModule:r}=e,o=useQuery("installed-plugins",i),{loadablePlugins:n,plugins:s,register:u}=useRegistryState(o.data),l=useCallback((async(e,t)=>{if(void 0!==s[e][t])return;const i=n[e][t];if(void 0===i)throw new Error(`No ${e} plugin is available for kind ${t}`);const o=await r(i);u(i,o)}),[s,n,r,u]),a=useMemo((()=>({plugins:s,loadPlugin:o.isLoading?void 0:l})),[o.isLoading,s,l]);return _jsx(PluginRegistryContext.Provider,{value:a,children:t})}const PluginRegistryContext=createContext(void 0);export function usePluginRegistry(){const e=useContext(PluginRegistryContext);if(void 0===e)throw new Error("No PluginRegistry context found. Did you forget a Provider?");return e}

package/dist/components/PluginRegistry/legacy/index.d.ts

@@ -1,2 +0,0 @@
-export * from './PluginRegistry';
-//# sourceMappingURL=index.d.ts.map

package/dist/components/PluginRegistry/legacy/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/PluginRegistry/legacy/index.ts"],"names":[],"mappings":"AAaA,cAAc,kBAAkB,CAAC"}

package/dist/components/PluginRegistry/legacy/index.js

@@ -1 +0,0 @@
-export*from"./PluginRegistry";

package/dist/components/PluginRegistry/legacy/registry-state.d.ts

@@ -1,18 +0,0 @@
-import { JsonObject } from '@perses-dev/core';
-import { PluginModuleResource, PluginType, PluginImplementation } from '../../../model';
-export declare type PluginResourcesByTypeAndKind = {
-    [K in PluginType]: Record<string, PluginModuleResource>;
-};
-export declare type LoadedPluginsByTypeAndKind = {
-    [Type in PluginType]: Record<string, PluginImplementation<Type, JsonObject>>;
-};
-/**
- * Hook for setting up plugin registry state. Returns the state, plus a function
- * for registering plugins with that state.
- */
-export declare function useRegistryState(installedPlugins?: PluginModuleResource[]): {
-    loadablePlugins: PluginResourcesByTypeAndKind;
-    plugins: LoadedPluginsByTypeAndKind;
-    register: (resource: PluginModuleResource, pluginModule: unknown) => void;
-};
-//# sourceMappingURL=registry-state.d.ts.map

package/dist/components/PluginRegistry/legacy/registry-state.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"registry-state.d.ts","sourceRoot":"","sources":["../../../../src/components/PluginRegistry/legacy/registry-state.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAEL,oBAAoB,EACpB,UAAU,EAEV,oBAAoB,EAIrB,MAAM,gBAAgB,CAAC;AAGxB,oBAAY,4BAA4B,GAAG;KACxC,CAAC,IAAI,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC;CACxD,CAAC;AAGF,oBAAY,0BAA0B,GAAG;KACtC,IAAI,IAAI,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;CAC7E,CAAC;AAEF;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,gBAAgB,CAAC,EAAE,oBAAoB,EAAE;;;yBAsC3D,oBAAoB,gBAAgB,OAAO,KAAG,IAAI;EAgDhE"}

package/dist/components/PluginRegistry/legacy/registry-state.js

@@ -1 +0,0 @@
-import{useCallback,useMemo,useRef}from"react";import{useImmer}from"use-immer";import{ALL_PLUGIN_TYPES}from"../../../model";export function useRegistryState(e){const n=useMemo((()=>{const n={};for(const e of ALL_PLUGIN_TYPES)n[e]={};if(void 0===e)return n;for(const r of e)for(const e of r.spec.plugins){const{pluginType:o,kind:s}=e,t=n[o];void 0===t[s]?t[s]=r:console.warn(`Got multiple ${o} plugin definitions for kind ${s}`)}return n}),[e]),[r,o]=useImmer((()=>{const e={};for(const n of ALL_PLUGIN_TYPES)e[n]={};return e})),s=useRef(new Set),t=useCallback(((e,n)=>{if(s.current.has(n))return;const r=n;o((n=>{for(const o of e.spec.plugins){const{pluginType:s,kind:t}=o,i=r[t];if(void 0!==i)switch(s){case"Variable":n.Variable[t]=i;break;case"Panel":n.Panel[t]=i;break;case"GraphQuery":n.GraphQuery[t]=i;break;default:throw new Error(`Unhandled plugin config: ${s}`)}else console.warn(`Could not find ${s} plugin for kind '${t}' in ${e.metadata.name}`)}})),s.current.add(n)}),[o]);return{loadablePlugins:n,plugins:r,register:t}}

package/dist/components/PluginRegistry/test-plugins/bert/plugin.json

@@ -1,32 +0,0 @@
-{
-    "kind": "PluginModule",
-    "metadata": { "name": "Bert" },
-    "spec": {
-        "plugins": [
-            {
-                "pluginType": "Panel",
-                "kind": "BertPanel1",
-                "display": {
-                    "name": "Bert Panel 1",
-                    "description": ""
-                }
-            },
-            {
-                "pluginType": "Panel",
-                "kind": "BertPanel2",
-                "display": {
-                    "name": "Bert Panel 2",
-                    "description": ""
-                }
-            },
-            {
-                "pluginType": "Variable",
-                "kind": "BertVariable",
-                "display": {
-                    "name": "Bert Variable",
-                    "description": ""
-                }
-            }
-        ]
-    }
-}

package/dist/components/PluginRegistry/test-plugins/ernie/plugin.json

@@ -1,24 +0,0 @@
-{
-    "kind": "PluginModule",
-    "metadata": { "name": "Ernie" },
-    "spec": {
-        "plugins": [
-            {
-                "pluginType": "Variable",
-                "kind": "ErnieVariable",
-                "display": {
-                    "name": "Ernie Variable",
-                    "description": "A variable plugin that exists in the plugin module"
-                }
-            },
-            {
-                "pluginType": "Variable",
-                "kind": "MissingErnieVariable",
-                "display": {
-                    "name": "Ernie Variable",
-                    "description": "A variable plugin that exists here in the metadata, but is not in the plugin module"
-                }
-            }
-        ]
-    }
-}

package/dist/model/graph-queries.d.ts

@@ -1,36 +0,0 @@
-import { AbsoluteTimeRange, Definition, JsonObject, ResourceSelector, UnixTimeMs } from '@perses-dev/core';
-/**
- * Options that are common to all Graph Queries.
- */
-export interface GraphQueryDefinition<Options extends JsonObject = JsonObject> extends Definition<Options> {
-    datasource?: ResourceSelector;
-}
-/**
- * A plugin for running graph queries.
- */
-export interface GraphQueryPlugin<Options extends JsonObject = JsonObject> {
-    useGraphQuery: UseGraphQueryHook<Options>;
-}
-export declare type UseGraphQueryHook<Options extends JsonObject> = (definition: GraphQueryDefinition<Options>, hookOptions?: UseGraphQueryHookOptions) => {
-    data?: GraphData;
-    loading: boolean;
-    error?: Error;
-};
-export interface UseGraphQueryHookOptions {
-    suggestedStepMs?: number;
-}
-export interface GraphData {
-    timeRange: AbsoluteTimeRange;
-    stepMs: number;
-    series: Iterable<GraphSeries>;
-}
-export interface GraphSeries {
-    name: string;
-    values: Iterable<GraphSeriesValueTuple>;
-}
-export declare type GraphSeriesValueTuple = [timestamp: UnixTimeMs, value: number];
-/**
- * Use a Graph Query's results from a graph query plugin at runtime.
- */
-export declare const useGraphQuery: GraphQueryPlugin['useGraphQuery'];
-//# sourceMappingURL=graph-queries.d.ts.map

package/dist/model/graph-queries.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"graph-queries.d.ts","sourceRoot":"","sources":["../../src/model/graph-queries.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,UAAU,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAG3G;;GAEG;AACH,MAAM,WAAW,oBAAoB,CAAC,OAAO,SAAS,UAAU,GAAG,UAAU,CAAE,SAAQ,UAAU,CAAC,OAAO,CAAC;IACxG,UAAU,CAAC,EAAE,gBAAgB,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB,CAAC,OAAO,SAAS,UAAU,GAAG,UAAU;IACvE,aAAa,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC;CAC3C;AAED,oBAAY,iBAAiB,CAAC,OAAO,SAAS,UAAU,IAAI,CAC1D,UAAU,EAAE,oBAAoB,CAAC,OAAO,CAAC,EACzC,WAAW,CAAC,EAAE,wBAAwB,KACnC;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,CAAC;AAEF,MAAM,WAAW,wBAAwB;IACvC,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,SAAS;IACxB,SAAS,EAAE,iBAAiB,CAAC;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC;CAC/B;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,QAAQ,CAAC,qBAAqB,CAAC,CAAC;CACzC;AAED,oBAAY,qBAAqB,GAAG,CAAC,SAAS,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;AAE3E;;GAEG;AACH,eAAO,MAAM,aAAa,EAAE,gBAAgB,CAAC,eAAe,CAO3D,CAAC"}

package/dist/model/graph-queries.js

@@ -1 +0,0 @@
-import{usePlugin}from"../components/PluginLoadingBoundary";export const useGraphQuery=n=>{const r=usePlugin("GraphQuery",n.kind);return void 0===r?{loading:!0}:r.useGraphQuery(n)};