@perses-dev/plugin-system 0.7.1 → 0.8.1

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

@@ -0,0 +1,24 @@
+{
+    "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/cjs/components/PluginRegistry/test-plugins/index.js

@@ -0,0 +1,63 @@
+"use strict";
+// Copyright 2022 The Perses Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.testRegistryProps = void 0;
+const plugin_json_1 = __importDefault(require("./bert/plugin.json"));
+const plugin_json_2 = __importDefault(require("./ernie/plugin.json"));
+// Put all the test plugins into a Map
+const testPlugins = new Map();
+testPlugins.set(plugin_json_1.default, () => Promise.resolve().then(() => __importStar(require('./bert'))));
+testPlugins.set(plugin_json_2.default, () => Promise.resolve().then(() => __importStar(require('./ernie'))));
+/**
+ * Some props for testing the PluginRegistry that use the test plugins/metadata in this folder.
+ */
+exports.testRegistryProps = {
+    getInstalledPlugins: () => {
+        const resources = Array.from(testPlugins.keys());
+        return Promise.resolve(resources);
+    },
+    importPluginModule: (resource) => {
+        const importFn = testPlugins.get(resource);
+        if (importFn === undefined) {
+            throw new Error('Plugin not found');
+        }
+        return importFn();
+    },
+};

package/dist/cjs/components/index.js

@@ -28,4 +28,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./PluginBoundary"), exports);
 __exportStar(require("./PluginLoadingBoundary"), exports);
-__exportStar(require("./PluginRegistry"), exports);
+__exportStar(require("./PluginRegistry/legacy"), exports);

package/dist/cjs/model/graph-queries.js

@@ -18,7 +18,7 @@ const PluginLoadingBoundary_1 = require("../components/PluginLoadingBoundary");
  * Use a Graph Query's results from a graph query plugin at runtime.
  */
 const useGraphQuery = (definition) => {
-    const plugin = (0, PluginLoadingBoundary_1.usePlugin)('GraphQuery', definition);
+    const plugin = (0, PluginLoadingBoundary_1.usePlugin)('GraphQuery', definition.kind);
     if (plugin === undefined) {
         // Provide default values while the plugin is being loaded
         return { loading: true };

package/dist/cjs/model/index.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2021 The Perses Authors
+// Copyright 2022 The Perses Authors
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
@@ -30,3 +30,4 @@ __exportStar(require("./graph-queries"), exports);
 __exportStar(require("./panels"), exports);
 __exportStar(require("./plugins"), exports);
 __exportStar(require("./variables"), exports);
+__exportStar(require("./visual-editing"), exports);

package/dist/cjs/model/panels.js

@@ -1,17 +1,33 @@
 "use strict";
+// Copyright 2022 The Perses Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PanelComponent = void 0;
-const jsx_runtime_1 = require("react/jsx-runtime");
+exports.usePanelPlugin = void 0;
 const PluginLoadingBoundary_1 = require("../components/PluginLoadingBoundary");
 /**
- * Renders a PanelComponent from a panel plugin at runtime.
+ * Hook for using a panel plugin at runtime.
  */
-const PanelComponent = (props) => {
-    const plugin = (0, PluginLoadingBoundary_1.usePlugin)('Panel', props.definition);
-    if (plugin === undefined) {
-        return null;
+function usePanelPlugin(kind) {
+    const plugin = (0, PluginLoadingBoundary_1.usePlugin)('Panel', kind);
+    if (plugin !== undefined) {
+        return plugin;
     }
-    const { PanelComponent: PluginComponent } = plugin;
-    return (0, jsx_runtime_1.jsx)(PluginComponent, { ...props });
+    // Return a default/placeholder plugin while loading happens
+    return defaultPanelPlugin;
+}
+exports.usePanelPlugin = usePanelPlugin;
+const defaultPanelPlugin = {
+    PanelComponent: () => null,
+    OptionsEditorComponent: () => null,
+    createInitialOptions: () => ({}),
 };
-exports.PanelComponent = PanelComponent;

package/dist/cjs/model/plugins.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2021 The Perses Authors
+// Copyright 2022 The Perses Authors
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at

package/dist/cjs/model/variables.js

@@ -18,7 +18,7 @@ const PluginLoadingBoundary_1 = require("../components/PluginLoadingBoundary");
  * Use the variable options from a variable plugin at runtime.
  */
 const useVariableOptions = (definition) => {
-    const plugin = (0, PluginLoadingBoundary_1.usePlugin)('Variable', definition);
+    const plugin = (0, PluginLoadingBoundary_1.usePlugin)('Variable', definition.kind);
     if (plugin === undefined) {
         // Provide default values while the plugin is being loaded
         return { data: [], loading: true };

package/dist/cjs/model/visual-editing.js

@@ -0,0 +1,14 @@
+"use strict";
+// Copyright 2022 The Perses Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/runtime/index.js

@@ -29,3 +29,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./datasources"), exports);
 __exportStar(require("./template-variables"), exports);
 __exportStar(require("./time-range"), exports);
+__exportStar(require("./query-string"), exports);

package/dist/cjs/runtime/plugins.js

@@ -0,0 +1,38 @@
+"use strict";
+// Copyright 2022 The Perses Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useListPluginMetadata = exports.usePlugin = void 0;
+const react_query_1 = require("react-query");
+const PluginRegistry_1 = require("../components/PluginRegistry");
+const cache_keys_1 = require("../utils/cache-keys");
+/**
+ * Loads a plugin and returns the plugin implementation, along with loading/error state.
+ */
+function usePlugin(pluginType, kind, options) {
+    const { getPlugin } = (0, PluginRegistry_1.usePluginRegistry)();
+    const queryKey = (0, cache_keys_1.getTypeAndKindKey)(pluginType, kind);
+    const { data, isLoading, error } = (0, react_query_1.useQuery)(queryKey, () => getPlugin(pluginType, kind), options);
+    return { plugin: data, isLoading, error };
+}
+exports.usePlugin = usePlugin;
+/**
+ * Gets a list of plugin metadata for the specified plugin type and returns it, along with loading/error state.
+ */
+function useListPluginMetadata(pluginType, options) {
+    const { listPluginMetadata } = (0, PluginRegistry_1.usePluginRegistry)();
+    const queryKey = pluginType;
+    const { data, isLoading, error } = (0, react_query_1.useQuery)(queryKey, () => listPluginMetadata(pluginType), options);
+    return { pluginMetadata: data, isLoading, error };
+}
+exports.useListPluginMetadata = useListPluginMetadata;

package/dist/cjs/runtime/query-string.js

@@ -0,0 +1,28 @@
+"use strict";
+// Copyright 2022 The Perses Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useQueryString = exports.QueryStringContext = void 0;
+const react_1 = require("react");
+exports.QueryStringContext = (0, react_1.createContext)(undefined);
+/**
+ * Gets the current query params at runtime.
+ */
+function useQueryString() {
+    const ctx = (0, react_1.useContext)(exports.QueryStringContext);
+    if (ctx === undefined) {
+        throw new Error('No QueryStringContext found. Did you forget a Provider?');
+    }
+    return ctx;
+}
+exports.useQueryString = useQueryString;

package/dist/cjs/runtime/template-variables.js

@@ -12,17 +12,28 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useTemplateVariables = exports.TemplateVariablesContext = void 0;
+exports.useTemplateVariableValues = exports.TemplateVariableContext = void 0;
 const react_1 = require("react");
-exports.TemplateVariablesContext = (0, react_1.createContext)(undefined);
-/**
- * Gets TemplateVariables at runtime.
- */
-function useTemplateVariables() {
-    const ctx = (0, react_1.useContext)(exports.TemplateVariablesContext);
+exports.TemplateVariableContext = (0, react_1.createContext)(undefined);
+function useTemplateVariableContext() {
+    const ctx = (0, react_1.useContext)(exports.TemplateVariableContext);
     if (ctx === undefined) {
-        throw new Error('No TemplateVariablesContext found. Did you forget a Provider?');
+        throw new Error('No TemplateVariableContext found. Did you forget a Provider?');
     }
     return ctx;
 }
-exports.useTemplateVariables = useTemplateVariables;
+function useTemplateVariableValues(names) {
+    const { state } = useTemplateVariableContext();
+    if (names === undefined) {
+        return state;
+    }
+    const values = {};
+    names.forEach((name) => {
+        const s = state[name];
+        if (s) {
+            values[name] = s;
+        }
+    });
+    return values;
+}
+exports.useTemplateVariableValues = useTemplateVariableValues;

package/dist/cjs/runtime/time-range.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2021 The Perses Authors
+// Copyright 2022 The Perses Authors
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at

package/dist/cjs/test/render.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderWithContext = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+// Copyright 2022 The Perses Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+const react_1 = require("@testing-library/react");
+const react_query_1 = require("react-query");
+// Don't retry in tests
+const queryClient = new react_query_1.QueryClient({ defaultOptions: { queries: { refetchOnWindowFocus: false, retry: false } } });
+/**
+ * Test helper to render a React component with some common app-level providers wrapped around it.
+ */
+function renderWithContext(ui, options) {
+    return (0, react_1.render)((0, jsx_runtime_1.jsx)(react_query_1.QueryClientProvider, { client: queryClient, children: ui }), options);
+}
+exports.renderWithContext = renderWithContext;

package/dist/cjs/test/setup-tests.js

@@ -0,0 +1,24 @@
+"use strict";
+// Copyright 2022 The Perses Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+Object.defineProperty(exports, "__esModule", { value: true });
+const react_query_1 = require("react-query");
+// Add testing library assertions
+require("@testing-library/jest-dom/extend-expect");
+(0, react_query_1.setLogger)({
+    log: console.log,
+    warn: console.warn,
+    error: () => {
+        // Don't log network errors to the console during tests
+    },
+});

package/dist/cjs/utils/cache-keys.js

@@ -0,0 +1,22 @@
+"use strict";
+// Copyright 2022 The Perses Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTypeAndKindKey = void 0;
+/**
+ * Gets a unique key for a plugin type/kind that can be used as a cache key.
+ */
+function getTypeAndKindKey(pluginType, kind) {
+    return `${pluginType}:${kind}`;
+}
+exports.getTypeAndKindKey = getTypeAndKindKey;

package/dist/components/PluginLoadingBoundary/PluginLoader.js

@@ -1 +1 @@
-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}
+import{useQuery}from"react-query";import{usePluginRegistry}from"../PluginRegistry/legacy";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.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="react" />
 import { JsonObject } from '@perses-dev/core';
-import { PluginType, PluginDefinition, PluginImplementation } from '../../model';
+import { PluginType, PluginImplementation } from '../../model';
 export interface PluginLoadingBoundaryProps {
     fallback: React.ReactNode;
     children?: React.ReactNode;
@@ -22,6 +22,6 @@ export declare function usePluginLoadingBoundary(): PluginLoadingBoundaryContext
  * Generic usePlugin that will register the dependency with the nearest LoadingBoundary and get the plugin if it's
  * already loaded
  */
-export declare function usePlugin<Type extends PluginType>(pluginType: Type, definition: PluginDefinition<Type, JsonObject>): PluginImplementation<Type, JsonObject> | undefined;
+export declare function usePlugin<Type extends PluginType>(pluginType: Type, kind: string): PluginImplementation<Type, JsonObject> | undefined;
 export {};
 //# sourceMappingURL=PluginLoadingBoundary.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"PluginLoadingBoundary.d.ts","sourceRoot":"","sources":["../../../src/components/PluginLoadingBoundary/PluginLoadingBoundary.tsx"],"names":[],"mappings":";AAaA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAG9C,OAAO,EAAE,UAAU,EAAoB,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AASnG,MAAM,WAAW,0BAA0B;IACzC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;IAC1B,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;CAC5B;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,0BAA0B,eAgEtE;AAED,UAAU,gCAAgC;IACxC,wBAAwB,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;CAC1E;AAID;;GAEG;AACH,wBAAgB,wBAAwB,qCAMvC;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,IAAI,SAAS,UAAU,EAC/C,UAAU,EAAE,IAAI,EAChB,UAAU,EAAE,gBAAgB,CAAC,IAAI,EAAE,UAAU,CAAC,GAC7C,oBAAoB,CAAC,IAAI,EAAE,UAAU,CAAC,GAAG,SAAS,CAUpD"}
+{"version":3,"file":"PluginLoadingBoundary.d.ts","sourceRoot":"","sources":["../../../src/components/PluginLoadingBoundary/PluginLoadingBoundary.tsx"],"names":[],"mappings":";AAaA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAG9C,OAAO,EAAE,UAAU,EAAoB,oBAAoB,EAAE,MAAM,aAAa,CAAC;AASjF,MAAM,WAAW,0BAA0B;IACzC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;IAC1B,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;CAC5B;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,0BAA0B,eAgEtE;AAED,UAAU,gCAAgC;IACxC,wBAAwB,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;CAC1E;AAID;;GAEG;AACH,wBAAgB,wBAAwB,qCAMvC;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,IAAI,SAAS,UAAU,EAC/C,UAAU,EAAE,IAAI,EAChB,IAAI,EAAE,MAAM,GACX,oBAAoB,CAAC,IAAI,EAAE,UAAU,CAAC,GAAG,SAAS,CAUpD"}

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,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]}
+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/legacy";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]={};return e})),i=useCallback(((e,n)=>{u((o=>{o[e][n]=!0}))}),[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 in u)e+=t,void 0===r[o][t]&&n.push(_jsx(PluginLoader,{pluginType:o,kind:t},`${o}:${t}`))}return{loaders:n,fragmentKey:e}}),[r,t]),l=0===g.length;return _jsxs(PluginLoadingBoundaryContext.Provider,{value:s,children:[g,l&&_jsx(Fragment,{children:o},a),!1===l&&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)}),[e,n,o]);const{plugins:r}=usePluginRegistry();return r[e][n]}

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

@@ -1,29 +1,14 @@
 /// <reference types="react" />
-import { PluginModule, PluginResource, PluginType } from '../../model';
-import { LoadedPluginsByTypeAndKind } from './registry-state';
+import { PluginModuleResource } from '../../model';
+import { GetInstalledPlugins } from './plugin-indexes';
 export interface PluginRegistryProps {
     children?: React.ReactNode;
-    getInstalledPlugins: () => Promise<PluginResource[]>;
-    importPluginModule: (resource: PluginResource) => Promise<PluginModule>;
+    getInstalledPlugins: GetInstalledPlugins;
+    importPluginModule: (resource: PluginModuleResource) => Promise<unknown>;
 }
 /**
- * PluginRegistryContext provider that keeps track of all available plugins and
- * their implementations once they've been loaded.
+ * PluginRegistryContext provider that keeps track of all available plugins and provides an API for getting them or
+ * querying the metadata about them.
  */
 export declare function PluginRegistry(props: PluginRegistryProps): JSX.Element;
-export interface PluginRegistryContextType {
-    /**
-     * Plugins that have already been loaded and are available for use.
-     */
-    plugins: LoadedPluginsByTypeAndKind;
-    /**
-     * 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;
 //# 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,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"}
+{"version":3,"file":"PluginRegistry.d.ts","sourceRoot":"","sources":["../../../src/components/PluginRegistry/PluginRegistry.tsx"],"names":[],"mappings":";AAeA,OAAO,EAAE,oBAAoB,EAA4C,MAAM,aAAa,CAAC;AAE7F,OAAO,EAAE,mBAAmB,EAAoB,MAAM,kBAAkB,CAAC;AAGzE,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,kBAAkB,EAAE,CAAC,QAAQ,EAAE,oBAAoB,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;CAC1E;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,mBAAmB,eA6DxD"}

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: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}
+import{jsx as _jsx}from"react/jsx-runtime";import{useEvent}from"@perses-dev/core";import{useRef,useCallback,useMemo}from"react";import{getTypeAndKindKey}from"../../utils/cache-keys";import{usePluginIndexes}from"./plugin-indexes";import{PluginRegistryContext}from"./plugin-registry-model";export function PluginRegistry(e){const{getInstalledPlugins:t,importPluginModule:n,children:r}=e,i=usePluginIndexes(t),s=useRef(new Map),u=useEvent((e=>{let t=s.current.get(e);return void 0===t&&(t=n(e),s.current.set(e,t),t.catch((()=>s.current.delete(e)))),t})),o=useCallback((async(e,t)=>{const n=await i(),r=getTypeAndKindKey(e,t),s=n.pluginResourcesByTypeAndKind.get(r);if(void 0===s)throw new Error(`A ${e} plugin for kind '${t}' is not installed`);const o=(await u(s))[t];if(void 0===o)throw new Error(`The ${e} plugin for kind '${t}' is missing from the ${s.metadata.name} plugin module`);return o}),[i,u]),l=useCallback((async e=>{var t;return null!==(t=(await i()).pluginMetadataByType.get(e))&&void 0!==t?t:[]}),[i]),a=useMemo((()=>({getPlugin:o,listPluginMetadata:l})),[o,l]);return _jsx(PluginRegistryContext.Provider,{value:a,children:r})}

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=PluginRegistry.test.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PluginRegistry.test.d.ts","sourceRoot":"","sources":["../../../src/components/PluginRegistry/PluginRegistry.test.tsx"],"names":[],"mappings":""}

package/dist/components/PluginRegistry/PluginRegistry.test.js

@@ -0,0 +1 @@
+import{jsx as _jsx,jsxs as _jsxs}from"react/jsx-runtime";import{screen}from"@testing-library/react";import{useListPluginMetadata,usePlugin}from"../../runtime/plugins";import{renderWithContext}from"../../test/render";import{PluginRegistry}from"./PluginRegistry";import{testRegistryProps}from"./test-plugins";describe("PluginRegistry",(()=>{const e=e=>{renderWithContext(_jsx(PluginRegistry,{...testRegistryProps,children:e}))};it("can load a plugin that exists",(async()=>{e(_jsx(PluginConsumer,{pluginType:"Variable",kind:"ErnieVariable"}));const t=await screen.findByText("Has plugin: true",void 0,{timeout:3e3});expect(t).toBeInTheDocument()})),it("errors when plugin is not installed",(async()=>{e(_jsx(PluginConsumer,{pluginType:"GraphQuery",kind:"NotInstalled"}));const t=await screen.findByText(/error:/i);expect(t).toBeInTheDocument(),expect(t).toHaveTextContent(/not installed/i)})),it("errors when plugin is missing from the module",(async()=>{e(_jsx(PluginConsumer,{pluginType:"Variable",kind:"MissingErnieVariable"}));const t=await screen.findByText(/error:/i);expect(t).toBeInTheDocument(),expect(t).toHaveTextContent(/missing/i)})),it("lists metadata for plugin metadata that exists",(async()=>{e(_jsx(MetadataConsumer,{pluginType:"Variable"}));const t=await screen.findByRole("table");expect(t).toBeInTheDocument();const n=screen.getAllByRole("row");expect(n).toHaveLength(3)})),it("lists metadata for plugin types with no plugins available",(async()=>{e(_jsx(MetadataConsumer,{pluginType:"GraphQuery"}));const t=await screen.findByRole("table");expect(t).toBeInTheDocument();const n=screen.queryAllByRole("row");expect(n).toHaveLength(0)}))}));const PluginConsumer=e=>{const{plugin:t,isLoading:n,error:i}=usePlugin(e.pluginType,e.kind);return i?_jsxs("div",{children:["Error: ",i.message]}):n?_jsx("div",{children:"Loading"}):_jsxs("div",{children:["Has plugin: ",(void 0!==t).toString()]})},MetadataConsumer=e=>{const{pluginMetadata:t,isLoading:n,error:i}=useListPluginMetadata(e.pluginType);return i?_jsxs("div",{children:["Error: ",i.message]}):n?_jsx("div",{children:"Loading"}):void 0===t?null:_jsx("table",{children:_jsx("tbody",{children:t.map((e=>_jsxs("tr",{children:[_jsx("td",{children:e.pluginType}),_jsx("td",{children:e.kind}),_jsx("td",{children:e.display.name}),_jsx("td",{children:e.display.description})]},e.kind)))})})};

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

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

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

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

package/dist/components/PluginRegistry/index.js

@@ -1 +1 @@
-export*from"./PluginRegistry";
+export*from"./plugin-registry-model";export*from"./PluginRegistry";

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

@@ -0,0 +1,29 @@
+/// <reference types="react" />
+import { PluginModuleResource, PluginType } from '../../../model';
+import { LoadedPluginsByTypeAndKind } from './registry-state';
+export interface PluginRegistryProps {
+    children?: React.ReactNode;
+    getInstalledPlugins: () => Promise<PluginModuleResource[]>;
+    importPluginModule: (resource: PluginModuleResource) => Promise<unknown>;
+}
+/**
+ * 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;
+export interface PluginRegistryContextType {
+    /**
+     * Plugins that have already been loaded and are available for use.
+     */
+    plugins: LoadedPluginsByTypeAndKind;
+    /**
+     * 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;
+//# sourceMappingURL=PluginRegistry.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PluginRegistry.d.ts","sourceRoot":"","sources":["../../../../src/components/PluginRegistry/legacy/PluginRegistry.tsx"],"names":[],"mappings":";AAeA,OAAO,EAAE,oBAAoB,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAClE,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,oBAAoB,EAAE,CAAC,CAAC;IAC3D,kBAAkB,EAAE,CAAC,QAAQ,EAAE,oBAAoB,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;CAC1E;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/legacy/PluginRegistry.js

@@ -0,0 +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: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

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

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

@@ -0,0 +1 @@
+{"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

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

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

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

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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1 @@
+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/plugin-indexes.d.ts

@@ -0,0 +1,11 @@
+import { PluginMetadata, PluginModuleResource } from '../../model';
+export declare type GetInstalledPlugins = () => Promise<PluginModuleResource[]>;
+export interface PluginIndexes {
+    pluginResourcesByTypeAndKind: Map<string, PluginModuleResource>;
+    pluginMetadataByType: Map<string, PluginMetadata[]>;
+}
+/**
+ * Returns an async callback for getting indexes of the installed plugin data.
+ */
+export declare function usePluginIndexes(getInstalledPlugins: GetInstalledPlugins): () => Promise<PluginIndexes>;
+//# sourceMappingURL=plugin-indexes.d.ts.map