@perses-dev/plugin-system 0.2.1 → 0.3.0

package/dist/components/PluginLoadingBoundary/PluginLoader.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PluginLoader.d.ts","sourceRoot":"","sources":["../../../src/components/PluginLoadingBoundary/PluginLoader.tsx"],"names":[],"mappings":"AAcA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAGzC,MAAM,WAAW,iBAAiB;IAChC,UAAU,EAAE,UAAU,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,iBAAiB,QAWpD"}
+{"version":3,"file":"PluginLoader.d.ts","sourceRoot":"","sources":["../../../src/components/PluginLoadingBoundary/PluginLoader.tsx"],"names":[],"mappings":"AAcA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAGzC,MAAM,WAAW,iBAAiB;IAChC,UAAU,EAAE,UAAU,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,iBAAiB,QAsBpD"}

package/dist/components/PluginLoadingBoundary/PluginLoader.js

@@ -1 +1 @@
-import{useQuery}from"react-query";import{usePluginRegistry}from"../PluginRegistry";export function PluginLoader(r){const{pluginType:u,kind:e}=r,{loadPlugin:i}=usePluginRegistry(),{error:n}=useQuery(`PluginLoader:${u}_${e}`,(()=>i(u,e)));if(null!=n)throw n;return null}
+import{useQuery}from"react-query";import{usePluginRegistry}from"../PluginRegistry";export function PluginLoader(r){const{pluginType:e,kind:i}=r,{loadPlugin:u}=usePluginRegistry(),{error:n}=useQuery(`PluginLoader:${e}_${i}`,(()=>{if(void 0===u)throw new Error("PluginRegistry loadPlugin not available");return u(e,i)}),{enabled:void 0!==u});if(null!=n)throw n;return null}

package/dist/components/PluginLoadingBoundary/PluginLoadingBoundary.js

@@ -1 +1 @@
-import{jsx as _jsx,jsxs as _jsxs}from"react/jsx-runtime";import{Fragment,createContext,useContext,useMemo,useCallback,useEffect}from"react";import{useImmer}from"use-immer";import{ALL_PLUGIN_TYPES}from"../../model";import{usePluginRegistry}from"../PluginRegistry";import{PluginLoader}from"./PluginLoader";export function PluginLoadingBoundary(e){const{fallback:n,children:o}=e,{plugins:r}=usePluginRegistry(),[t,u]=useImmer((()=>{const e={};for(const n of ALL_PLUGIN_TYPES)e[n]=new Set;return e})),i=useCallback(((e,n)=>{u((o=>{o[e].add(n)}))}),[u]),s=useMemo((()=>({registerPluginDependency:i})),[i]),{loaders:g,fragmentKey:a}=useMemo((()=>{let e="";const n=[];for(const o of ALL_PLUGIN_TYPES){e+=`_${o}:`;const u=t[o];for(const t of u.values())e+=t,void 0===r[o].get(t)&&n.push(_jsx(PluginLoader,{pluginType:o,kind:t},`${o}:${t}`))}return{loaders:n,fragmentKey:e}}),[r,t]),d=0===g.length;return _jsxs(PluginLoadingBoundaryContext.Provider,{value:s,children:[g,d&&_jsx(Fragment,{children:o},a),!1===d&&n]})}const PluginLoadingBoundaryContext=createContext(void 0);export function usePluginLoadingBoundary(){const e=useContext(PluginLoadingBoundaryContext);if(void 0===e)throw new Error("PluginLoadingBoundary context not found. Did you forget a Provider?");return e}export function usePlugin(e,n){const{registerPluginDependency:o}=usePluginLoadingBoundary();useEffect((()=>{o(e,n.kind)}),[e,n.kind,o]);const{plugins:r}=usePluginRegistry();return r[e].get(n.kind)}
+import{jsx as _jsx,jsxs as _jsxs}from"react/jsx-runtime";import{Fragment,createContext,useContext,useMemo,useCallback,useEffect}from"react";import{useImmer}from"use-immer";import{ALL_PLUGIN_TYPES}from"../../model";import{usePluginRegistry}from"../PluginRegistry";import{PluginLoader}from"./PluginLoader";export function PluginLoadingBoundary(e){const{fallback:n,children:o}=e,{plugins:r}=usePluginRegistry(),[t,i]=useImmer((()=>{const e={};for(const n of ALL_PLUGIN_TYPES)e[n]={};return e})),u=useCallback(((e,n)=>{i((o=>{o[e][n]=!0}))}),[i]),s=useMemo((()=>({registerPluginDependency:u})),[u]),{loaders:g,fragmentKey:a}=useMemo((()=>{let e="";const n=[];for(const o of ALL_PLUGIN_TYPES){e+=`_${o}:`;const i=t[o];for(const t in i)e+=t,void 0===r[o][t]&&n.push(_jsx(PluginLoader,{pluginType:o,kind:t},`${o}:${t}`))}return{loaders:n,fragmentKey:e}}),[r,t]),d=0===g.length;return _jsxs(PluginLoadingBoundaryContext.Provider,{value:s,children:[g,d&&_jsx(Fragment,{children:o},a),!1===d&&n]})}const PluginLoadingBoundaryContext=createContext(void 0);export function usePluginLoadingBoundary(){const e=useContext(PluginLoadingBoundaryContext);if(void 0===e)throw new Error("PluginLoadingBoundary context not found. Did you forget a Provider?");return e}export function usePlugin(e,n){const{registerPluginDependency:o}=usePluginLoadingBoundary();useEffect((()=>{o(e,n.kind)}),[e,n.kind,o]);const{plugins:r}=usePluginRegistry();return r[e][n.kind]}

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

@@ -10,14 +10,20 @@ export interface PluginRegistryProps {
  * PluginRegistryContext provider that keeps track of all available plugins and
  * their implementations once they've been loaded.
  */
-export declare function PluginRegistry(props: PluginRegistryProps): JSX.Element | null;
-interface PluginRegistryContextType {
+export declare function PluginRegistry(props: PluginRegistryProps): JSX.Element;
+export interface PluginRegistryContextType {
+    /**
+     * Plugins that have already been loaded and are available for use.
+     */
     plugins: LoadedPluginsByTypeAndKind;
-    loadPlugin: (pluginType: PluginType, kind: string) => Promise<void>;
+    /**
+     * Asks the plugin registry to load the specified plugin. This will be undefined until the list of available plugins
+     * has finished loading.
+     */
+    loadPlugin?: (pluginType: PluginType, kind: string) => Promise<void>;
 }
 /**
  * Gets the PluginRegistryContext, throwing if the provider is missing.
  */
 export declare function usePluginRegistry(): PluginRegistryContextType;
-export {};
 //# sourceMappingURL=PluginRegistry.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"PluginRegistry.d.ts","sourceRoot":"","sources":["../../../src/components/PluginRegistry/PluginRegistry.tsx"],"names":[],"mappings":";AAeA,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACvE,OAAO,EAAE,0BAA0B,EAAoB,MAAM,kBAAkB,CAAC;AAEhF,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,mBAAmB,EAAE,MAAM,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IACrD,kBAAkB,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;CACzE;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,mBAAmB,sBA+BxD;AAID,UAAU,yBAAyB;IACjC,OAAO,EAAE,0BAA0B,CAAC;IACpC,UAAU,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACrE;AAED;;GAEG;AACH,wBAAgB,iBAAiB,IAAI,yBAAyB,CAM7D"}
+{"version":3,"file":"PluginRegistry.d.ts","sourceRoot":"","sources":["../../../src/components/PluginRegistry/PluginRegistry.tsx"],"names":[],"mappings":";AAeA,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACvE,OAAO,EAAE,0BAA0B,EAAoB,MAAM,kBAAkB,CAAC;AAEhF,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,mBAAmB,EAAE,MAAM,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IACrD,kBAAkB,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;CACzE;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,mBAAmB,eA+BxD;AAID,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,OAAO,EAAE,0BAA0B,CAAC;IAEpC;;;OAGG;IACH,UAAU,CAAC,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACtE;AAED;;GAEG;AACH,wBAAgB,iBAAiB,IAAI,yBAAyB,CAM7D"}

package/dist/components/PluginRegistry/PluginRegistry.js

@@ -1 +1 @@
-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:r,importPluginModule:i}=e,o=useQuery("installed-plugins",r),{loadablePlugins:n,plugins:s,register:u}=useRegistryState(o.data),l=useCallback((async(e,t)=>{if(void 0!==s[e].get(t))return;const r=n[e].get(t);if(void 0===r)throw new Error(`No ${e} plugin is available for kind ${t}`);const o=await i(r);u(o)}),[s,n,i,u]),a=useMemo((()=>({plugins:s,loadPlugin:l})),[s,l]);return o.isLoading?null:_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}
+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(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/registry-state.d.ts

@@ -1,10 +1,10 @@
 import { JsonObject } from '@perses-dev/core';
 import { PluginModule, PluginResource, PluginType, PluginImplementation } from '../../model';
 export declare type PluginResourcesByTypeAndKind = {
-    [K in PluginType]: Map<string, PluginResource>;
+    [K in PluginType]: Record<string, PluginResource>;
 };
 export declare type LoadedPluginsByTypeAndKind = {
-    [Type in PluginType]: Map<string, PluginImplementation<Type, JsonObject>>;
+    [Type in PluginType]: Record<string, PluginImplementation<Type, JsonObject>>;
 };
 /**
  * Hook for setting up plugin registry state. Returns the state, plus a function

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

@@ -1 +1 @@
-{"version":3,"file":"registry-state.d.ts","sourceRoot":"","sources":["../../../src/components/PluginRegistry/registry-state.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAEL,YAAY,EACZ,cAAc,EAEd,UAAU,EAEV,oBAAoB,EACrB,MAAM,aAAa,CAAC;AAIrB,oBAAY,4BAA4B,GAAG;KACxC,CAAC,IAAI,UAAU,GAAG,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC;CAC/C,CAAC;AAGF,oBAAY,0BAA0B,GAAG;KACtC,IAAI,IAAI,UAAU,GAAG,GAAG,CAAC,MAAM,EAAE,oBAAoB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;CAC1E,CAAC;AAEF;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,gBAAgB,CAAC,EAAE,cAAc,EAAE;;;6BAuEjD,YAAY,KAAG,IAAI;EAerC"}
+{"version":3,"file":"registry-state.d.ts","sourceRoot":"","sources":["../../../src/components/PluginRegistry/registry-state.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAEL,YAAY,EACZ,cAAc,EAEd,UAAU,EAEV,oBAAoB,EACrB,MAAM,aAAa,CAAC;AAIrB,oBAAY,4BAA4B,GAAG;KACxC,CAAC,IAAI,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC;CAClD,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,cAAc,EAAE;;;6BAuEjD,YAAY,KAAG,IAAI;EAerC"}

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

@@ -1 +1 @@
-import{useCallback,useMemo,useRef}from"react";import{useImmer}from"use-immer";import{ALL_PLUGIN_TYPES}from"../../model";import{createGraphQueryPlugin,createPanelPlugin,createVariablePlugin}from"./create-plugin";export function useRegistryState(e){const r=useMemo((()=>{const r={};for(const e of ALL_PLUGIN_TYPES)r[e]=new Map;if(void 0===e)return r;const n=e=>{const n=e.spec.supported_kinds;for(const t in n){const o=n[t];if(void 0===o)continue;const a=r[o];a.has(t)?console.warn(`Got multiple ${o} plugin definitions for kind ${t}`):a.set(t,e)}};for(const r of e)n(r);return r}),[e]),[n,t]=useImmer((()=>{const e={};for(const r of ALL_PLUGIN_TYPES)e[r]=new Map;return e})),o=useCallback((e=>{switch(e.pluginType){case"Variable":return void t((r=>{r.Variable.set(e.kind,createVariablePlugin(e))}));case"Panel":return void t((r=>{r.Panel.set(e.kind,createPanelPlugin(e))}));case"GraphQuery":return void t((r=>{r.GraphQuery.set(e.kind,createGraphQueryPlugin(e))}));default:throw new Error(`Unhandled plugin config: ${e}`)}}),[t]),a=useRef(new Set);return{loadablePlugins:r,plugins:n,register:useCallback((e=>{a.current.has(e)||(e.setup(o),a.current.add(e))}),[o])}}
+import{useCallback,useMemo,useRef}from"react";import{useImmer}from"use-immer";import{ALL_PLUGIN_TYPES}from"../../model";import{createGraphQueryPlugin,createPanelPlugin,createVariablePlugin}from"./create-plugin";export function useRegistryState(e){const r=useMemo((()=>{const r={};for(const e of ALL_PLUGIN_TYPES)r[e]={};if(void 0===e)return r;const n=e=>{const n=e.spec.supported_kinds;for(const o in n){const t=n[o];if(void 0===t)continue;const i=r[t];void 0===i[o]?i[o]=e:console.warn(`Got multiple ${t} plugin definitions for kind ${o}`)}};for(const r of e)n(r);return r}),[e]),[n,o]=useImmer((()=>{const e={};for(const r of ALL_PLUGIN_TYPES)e[r]={};return e})),t=useCallback((e=>{switch(e.pluginType){case"Variable":return void o((r=>{r.Variable[e.kind]=createVariablePlugin(e)}));case"Panel":return void o((r=>{r.Panel[e.kind]=createPanelPlugin(e)}));case"GraphQuery":return void o((r=>{r.GraphQuery[e.kind]=createGraphQueryPlugin(e)}));default:throw new Error(`Unhandled plugin config: ${e}`)}}),[o]),i=useRef(new Set);return{loadablePlugins:r,plugins:n,register:useCallback((e=>{i.current.has(e)||(e.setup(t),i.current.add(e))}),[t])}}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@perses-dev/plugin-system",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "The plugin feature in Pereses",
   "license": "Apache-2.0",
   "homepage": "https://github.com/perses/perses/blob/main/README.md",
@@ -21,14 +21,14 @@
     "lint:fix": "eslint --fix src --ext .ts,.tsx"
   },
   "dependencies": {
-    "@perses-dev/components": "^0.2.1",
-    "@perses-dev/core": "^0.2.1",
+    "@perses-dev/components": "^0.3.0",
+    "@perses-dev/core": "^0.3.0",
     "immer": "^9.0.12",
-    "react-query": "^3.34.16",
     "use-immer": "^0.6.0"
   },
   "peerDependencies": {
-    "react": "^17.0.2"
+    "react": "^17.0.2",
+    "react-query": "^3.34.16"
   },
   "files": [
     "dist"