@perses-dev/plugin-system 0.7.1 → 0.8.0

package/dist/cjs/components/PluginRegistry/create-plugin.js

@@ -1,118 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvalidPluginDefinitionError = exports.createGraphQueryPlugin = exports.createPanelPlugin = exports.createVariablePlugin = void 0;
-const jsx_runtime_1 = require("react/jsx-runtime");
-// Copyright 2021 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("react");
-/**
- * Take a Variable plugin and wrap it so it works with AnyVariableDefinition,
- * doing runtime checking of the definition before delegating to the plugin.
- */
-function createVariablePlugin(config) {
-    // Create runtime validation function
-    const useRuntimeValidation = createValidationHook(config);
-    // Wrap hook with validation (TODO: Can this wrapper become generic for all
-    // plugin hooks?)
-    function useVariableOptions(definition) {
-        const { isValid, errorRef } = useRuntimeValidation();
-        if (isValid(definition)) {
-            return config.plugin.useVariableOptions(definition);
-        }
-        throw errorRef.current;
-    }
-    return {
-        useVariableOptions,
-    };
-}
-exports.createVariablePlugin = createVariablePlugin;
-/**
- * Take a Panel plugin and wraps it so it works with AnyPanelDefinition, doing
- * runtime checking of the definition before delegating to the plugin.
- */
-function createPanelPlugin(config) {
-    const useRuntimeValidation = createValidationHook(config);
-    // Wrap PanelComponent from config with validation (TODO: Can this wrapper
-    // become generic for all Plugin components?)
-    function PanelComponent(props) {
-        const { definition, ...others } = props;
-        const { isValid, errorRef } = useRuntimeValidation();
-        if (isValid(definition)) {
-            const { PanelComponent } = config.plugin;
-            return (0, jsx_runtime_1.jsx)(PanelComponent, { definition: definition, ...others });
-        }
-        throw errorRef.current;
-    }
-    return {
-        PanelComponent,
-    };
-}
-exports.createPanelPlugin = createPanelPlugin;
-/**
- * Take a GraphQuery plugin and wrap it so it works with AnyChartQueryDefinition,
- * doing runtime validation of the definition before delegating to the plugin.
- */
-function createGraphQueryPlugin(config) {
-    // Create runtime validation function
-    const useRuntimeValidation = createValidationHook(config);
-    // Wrap hook with validation (TODO: Can this wrapper become generic for all
-    // plugin hooks?)
-    function useGraphQuery(definition) {
-        const { isValid, errorRef } = useRuntimeValidation();
-        if (isValid(definition)) {
-            return config.plugin.useGraphQuery(definition);
-        }
-        throw errorRef.current;
-    }
-    return {
-        useGraphQuery,
-    };
-}
-exports.createGraphQueryPlugin = createGraphQueryPlugin;
-// Create a hook for doing runtime validation of a plugin definition, given the
-// plugin's config
-function createValidationHook(config) {
-    const useRuntimeValidation = () => {
-        // Ref for storing any validation errors as a side-effect of calling isValid
-        const errorRef = (0, react_1.useRef)(undefined);
-        // Type guard that validates the generic runtime plugin definition data
-        // is correct for Kind/Options
-        const isValid = (definition) => {
-            var _a, _b;
-            // If they don't give us a validate function in the plugin config, not
-            // much we can do so just assume we're OK
-            const validateErrors = (_b = (_a = config.validate) === null || _a === void 0 ? void 0 : _a.call(config, definition)) !== null && _b !== void 0 ? _b : [];
-            if (validateErrors.length === 0)
-                return true;
-            errorRef.current = new InvalidPluginDefinitionError(config.pluginType, config.kind, validateErrors);
-            return false;
-        };
-        return {
-            isValid,
-            errorRef,
-        };
-    };
-    return useRuntimeValidation;
-}
-/**
- * Thrown when ConfigData fails the runtime validation check for a plugin.
- */
-class InvalidPluginDefinitionError extends Error {
-    constructor(pluginType, kind, validateErrors) {
-        super(`Invalid ${pluginType} plugin definition for kind ${kind}`);
-        this.pluginType = pluginType;
-        this.kind = kind;
-        this.validateErrors = validateErrors;
-    }
-}
-exports.InvalidPluginDefinitionError = InvalidPluginDefinitionError;

package/dist/components/PluginRegistry/create-plugin.d.ts

@@ -1,27 +0,0 @@
-import { JsonObject } from '@perses-dev/core';
-import { PanelPlugin, PluginConfig, PluginType, VariablePlugin, GraphQueryPlugin } from '../../model';
-/**
- * Take a Variable plugin and wrap it so it works with AnyVariableDefinition,
- * doing runtime checking of the definition before delegating to the plugin.
- */
-export declare function createVariablePlugin<Options extends JsonObject>(config: PluginConfig<'Variable', Options>): VariablePlugin;
-/**
- * Take a Panel plugin and wraps it so it works with AnyPanelDefinition, doing
- * runtime checking of the definition before delegating to the plugin.
- */
-export declare function createPanelPlugin<Options extends JsonObject>(config: PluginConfig<'Panel', Options>): PanelPlugin;
-/**
- * Take a GraphQuery plugin and wrap it so it works with AnyChartQueryDefinition,
- * doing runtime validation of the definition before delegating to the plugin.
- */
-export declare function createGraphQueryPlugin<Options extends JsonObject>(config: PluginConfig<'GraphQuery', Options>): GraphQueryPlugin;
-/**
- * Thrown when ConfigData fails the runtime validation check for a plugin.
- */
-export declare class InvalidPluginDefinitionError extends Error {
-    readonly pluginType: PluginType;
-    readonly kind: string;
-    readonly validateErrors: string[];
-    constructor(pluginType: PluginType, kind: string, validateErrors: string[]);
-}
-//# sourceMappingURL=create-plugin.d.ts.map

package/dist/components/PluginRegistry/create-plugin.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"create-plugin.d.ts","sourceRoot":"","sources":["../../../src/components/PluginRegistry/create-plugin.tsx"],"names":[],"mappings":"AAcA,OAAO,EAAE,UAAU,EAAsB,MAAM,kBAAkB,CAAC;AAClE,OAAO,EAEL,WAAW,EACX,YAAY,EAEZ,UAAU,EACV,cAAc,EACd,gBAAgB,EAEjB,MAAM,aAAa,CAAC;AAErB;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,SAAS,UAAU,EAC7D,MAAM,EAAE,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,GACxC,cAAc,CAiBhB;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,SAAS,UAAU,EAAE,MAAM,EAAE,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,WAAW,CAmBjH;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,SAAS,UAAU,EAC/D,MAAM,EAAE,YAAY,CAAC,YAAY,EAAE,OAAO,CAAC,GAC1C,gBAAgB,CAiBlB;AAsCD;;GAEG;AACH,qBAAa,4BAA6B,SAAQ,KAAK;IACzC,QAAQ,CAAC,UAAU,EAAE,UAAU;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM;IAAE,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE;gBAAhF,UAAU,EAAE,UAAU,EAAW,IAAI,EAAE,MAAM,EAAW,cAAc,EAAE,MAAM,EAAE;CAGtG"}

package/dist/components/PluginRegistry/create-plugin.js

@@ -1 +0,0 @@
-import{jsx as _jsx}from"react/jsx-runtime";import{useRef}from"react";export function createVariablePlugin(r){const n=createValidationHook(r);return{useVariableOptions:function(e){const{isValid:i,errorRef:t}=n();if(i(e))return r.plugin.useVariableOptions(e);throw t.current}}}export function createPanelPlugin(r){const n=createValidationHook(r);return{PanelComponent:function(e){const{definition:i,...t}=e,{isValid:o,errorRef:u}=n();if(o(i)){const{PanelComponent:n}=r.plugin;return _jsx(n,{definition:i,...t})}throw u.current}}}export function createGraphQueryPlugin(r){const n=createValidationHook(r);return{useGraphQuery:function(e){const{isValid:i,errorRef:t}=n();if(i(e))return r.plugin.useGraphQuery(e);throw t.current}}}function createValidationHook(r){return()=>{const n=useRef(void 0);return{isValid:e=>{var i,t;const o=null!==(t=null===(i=r.validate)||void 0===i?void 0:i.call(r,e))&&void 0!==t?t:[];return 0===o.length||(n.current=new InvalidPluginDefinitionError(r.pluginType,r.kind,o),!1)},errorRef:n}}}export class InvalidPluginDefinitionError extends Error{constructor(r,n,e){super(`Invalid ${r} plugin definition for kind ${n}`),this.pluginType=r,this.kind=n,this.validateErrors=e}}

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

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