@cccsaurora/clue-ui 1.3.0-dev.403 → 1.3.0

package/plugins/image/index.d.ts

@@ -8,5 +8,8 @@ declare class ImagePlugin extends ClueUIPlugin {
     description: string;
     actionResult(props: RenderActionResultProps): import("react/jsx-runtime").JSX.Element;
     fetcherResult(props: RenderFetcherResultProps): import("react/jsx-runtime").JSX.Element;
+    editorLanguage(): string;
+    exampleInput(): string;
+    documentation(): string;
 }
 export default ImagePlugin;

package/plugins/image/index.js

@@ -1,26 +1,42 @@
-var __defProp = Object.defineProperty;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-import { jsx } from "react/jsx-runtime";
-import ClueUIPlugin from "../ClueUIPlugin.js";
-class ImagePlugin extends ClueUIPlugin {
+var p = Object.defineProperty;
+var c = (n, e, t) => e in n ? p(n, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : n[e] = t;
+var i = (n, e, t) => c(n, typeof e != "symbol" ? e + "" : e, t);
+import { jsx as m } from "react/jsx-runtime";
+import h from "../ClueUIPlugin.js";
+import { validateJsonData as l } from "../utils.js";
+class b extends h {
   constructor() {
     super(...arguments);
-    __publicField(this, "name", "ImagePlugin");
-    __publicField(this, "format", "image");
-    __publicField(this, "version", "1.0.0");
-    __publicField(this, "author", "Canadian Centre for Cyber Security Matthew.Rafuse@cyber.gc.ca");
-    __publicField(this, "description", "Renders images.");
+    i(this, "name", "ImagePlugin");
+    i(this, "format", "image");
+    i(this, "version", "1.0.0");
+    i(this, "author", "Canadian Centre for Cyber Security Matthew.Rafuse@cyber.gc.ca");
+    i(this, "description", "Renders images.");
   }
-  actionResult(props) {
-    const { result, fetcherId: _fetcherId, ...additionalProps } = props;
-    return /* @__PURE__ */ jsx("img", { src: result.output.image, alt: result.output.alt, ...additionalProps });
+  actionResult(t) {
+    const { result: r, pluginId: u, ...o } = t, a = l(r.output);
+    if (typeof a.image != "string" || a.image.length === 0)
+      throw new Error('ImagePlugin expects a JSON object with a non-empty "image" string property.');
+    const { image: s, alt: g } = a;
+    return /* @__PURE__ */ m("img", { src: s, alt: g ?? "", ...o });
   }
-  fetcherResult(props) {
-    const { result, fetcherId: _fetcherId, ...additionalProps } = props;
-    return /* @__PURE__ */ jsx("img", { src: result.data.image, alt: result.data.alt, ...additionalProps });
+  fetcherResult(t) {
+    const { result: r, fetcherId: u, ...o } = t, a = l(r.data);
+    if (typeof a.image != "string" || a.image.length === 0)
+      throw new Error('ImagePlugin expects a JSON object with a non-empty "image" string property.');
+    const { image: s, alt: g } = a;
+    return /* @__PURE__ */ m("img", { src: s, alt: g ?? "", ...o });
+  }
+  editorLanguage() {
+    return "json";
+  }
+  exampleInput() {
+    return JSON.stringify({ image: "/svg/dark/clue-icon2.svg", alt: "Clue Logo" }, null, 2);
+  }
+  documentation() {
+    return 'This plugin renders images. It can be used by specifying "image" as the format in the plugin configuration. The input should be a json object with an "image" property that is the URL of the image, and an optional "alt" property for the alt text of the image.';
   }
 }
 export {
-  ImagePlugin as default
+  b as default
 };

package/plugins/json/index.d.ts

@@ -13,5 +13,8 @@ declare class JsonPlugin extends ClueUIPlugin {
     fetcherResult({ result }: {
         result: FetcherResult;
     }): import("react/jsx-runtime").JSX.Element;
+    editorLanguage(): string;
+    exampleInput(): string;
+    documentation(): string;
 }
 export default JsonPlugin;

package/plugins/json/index.js

@@ -1,25 +1,37 @@
-var __defProp = Object.defineProperty;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-import { jsx } from "react/jsx-runtime";
-import { J as JSONViewer } from "../../index-DUEubgWN.js";
-import ClueUIPlugin from "../ClueUIPlugin.js";
-class JsonPlugin extends ClueUIPlugin {
+var s = Object.defineProperty;
+var c = (r, e, t) => e in r ? s(r, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : r[e] = t;
+var n = (r, e, t) => c(r, typeof e != "symbol" ? e + "" : e, t);
+import { jsx as a } from "react/jsx-runtime";
+import { J as i } from "../../index-Cj4d5cGz.js";
+import d from "../ClueUIPlugin.js";
+import { validateJsonData as u } from "../utils.js";
+class g extends d {
   constructor() {
     super(...arguments);
-    __publicField(this, "name", "JsonPlugin");
-    __publicField(this, "format", "json");
-    __publicField(this, "version", "1.0.0");
-    __publicField(this, "author", "Canadian Centre for Cyber Security Matthew.Rafuse@cyber.gc.ca");
-    __publicField(this, "description", "Renders JSON with the default renderer or the overridden json component defined in the clue component provider.");
+    n(this, "name", "JsonPlugin");
+    n(this, "format", "json");
+    n(this, "version", "1.0.0");
+    n(this, "author", "Canadian Centre for Cyber Security Matthew.Rafuse@cyber.gc.ca");
+    n(this, "description", "Renders JSON with the default renderer or the overridden json component defined in the clue component provider.");
   }
-  actionResult({ result }) {
-    return /* @__PURE__ */ jsx(JSONViewer, { data: result.output, collapse: true, forceCompact: true });
+  actionResult({ result: t }) {
+    const o = u(t.output);
+    return /* @__PURE__ */ a(i, { data: o, collapse: !0, forceCompact: !0 });
   }
-  fetcherResult({ result }) {
-    return /* @__PURE__ */ jsx(JSONViewer, { data: result.data });
+  fetcherResult({ result: t }) {
+    const o = u(t.data);
+    return /* @__PURE__ */ a(i, { data: o, collapse: !0, forceCompact: !0 });
+  }
+  editorLanguage() {
+    return "json";
+  }
+  exampleInput() {
+    return '{ "key": "value" }';
+  }
+  documentation() {
+    return 'This plugin renders JSON. It can be used by specifying "json" as the format in the plugin configuration. The input should be a JSON object or a stringified JSON.';
   }
 }
 export {
-  JsonPlugin as default
+  g as default
 };

package/plugins/markdown/index.d.ts

@@ -13,5 +13,8 @@ declare class MarkdownPlugin extends ClueUIPlugin {
     fetcherResult({ result }: {
         result: FetcherResult;
     }): import("react/jsx-runtime").JSX.Element;
+    editorLanguage(): string;
+    exampleInput(): string;
+    documentation(): string;
 }
 export default MarkdownPlugin;

package/plugins/markdown/index.js

@@ -1,25 +1,36 @@
-var __defProp = Object.defineProperty;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-import { jsx } from "react/jsx-runtime";
-import Markdown from "../../components/display/markdown/index.js";
-import ClueUIPlugin from "../ClueUIPlugin.js";
-class MarkdownPlugin extends ClueUIPlugin {
+var u = Object.defineProperty;
+var i = (e, n, r) => n in e ? u(e, n, { enumerable: !0, configurable: !0, writable: !0, value: r }) : e[n] = r;
+var t = (e, n, r) => i(e, typeof n != "symbol" ? n + "" : n, r);
+import { jsx as a } from "react/jsx-runtime";
+import o from "../../components/display/markdown/index.js";
+import d from "../ClueUIPlugin.js";
+class p extends d {
   constructor() {
     super(...arguments);
-    __publicField(this, "name", "MarkdownPlugin");
-    __publicField(this, "format", "markdown");
-    __publicField(this, "version", "1.0.0");
-    __publicField(this, "author", "Canadian Centre for Cyber Security Matthew.Rafuse@cyber.gc.ca");
-    __publicField(this, "description", "Renders Markdown.");
+    t(this, "name", "MarkdownPlugin");
+    t(this, "format", "markdown");
+    t(this, "version", "1.0.0");
+    t(this, "author", "Canadian Centre for Cyber Security Matthew.Rafuse@cyber.gc.ca");
+    t(this, "description", "Renders Markdown.");
   }
-  actionResult({ result }) {
-    return /* @__PURE__ */ jsx(Markdown, { md: result.output });
+  actionResult({ result: r }) {
+    return /* @__PURE__ */ a(o, { md: r.output });
   }
-  fetcherResult({ result }) {
-    return /* @__PURE__ */ jsx(Markdown, { md: result.data });
+  fetcherResult({ result: r }) {
+    return /* @__PURE__ */ a(o, { md: r.data });
+  }
+  editorLanguage() {
+    return "markdown";
+  }
+  exampleInput() {
+    return `# Markdown Plugin
+This is an example of the Markdown plugin.
+You can use **Markdown** syntax to format your text.`;
+  }
+  documentation() {
+    return 'This plugin renders Markdown. It can be used by specifying "markdown" as the format in the plugin configuration. The input should be a string in Markdown format.';
   }
 }
 export {
-  MarkdownPlugin as default
+  p as default
 };

package/plugins/registry.js

@@ -1,9 +1,9 @@
-var __defProp = Object.defineProperty;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-class ClueUIPluginsRegistry {
+var g = Object.defineProperty;
+var u = (l, i, n) => i in l ? g(l, i, { enumerable: !0, configurable: !0, writable: !0, value: n }) : l[i] = n;
+var a = (l, i, n) => u(l, typeof i != "symbol" ? i + "" : i, n);
+class o {
   constructor() {
-    __publicField(this, "_plugins", [
+    a(this, "_plugins", [
       // { name: 'TestPlugin', id: 'none', loadPlugin: () => import('./test') },
       { name: "MarkdownPlugin", id: "markdown", loadPlugin: () => import("./markdown/index.js") },
       { name: "ImagePlugin", id: "image", loadPlugin: () => import("./image/index.js") },
@@ -17,5 +17,5 @@ class ClueUIPluginsRegistry {
   }
 }
 export {
-  ClueUIPluginsRegistry as default
+  o as default
 };

package/plugins/store.d.ts

@@ -34,6 +34,7 @@ export declare class ClueUIPluginStore {
      */
     getPlugins(format?: string, resultType?: 'action' | 'fetcher', actionId?: string, fetcherId?: string): string[];
     getPlugin(format: string, resultType: 'action' | 'fetcher', actionId?: string, fetcherId?: string): string | undefined;
+    getAvailableFormats(pluginName?: string): string[];
     get pluginStore(): import('react-pluggable').PluginStore;
 }
 declare const clueUIPluginStore: ClueUIPluginStore;

package/plugins/store.js

@@ -1,6 +1,6 @@
-import { C, c } from "../store-DMdRx9g0.js";
-import "../uniq-CahZPAwp.js";
+import { C as t, c as a } from "../store-DClHBq7r.js";
+import "../uniq-B4UZ671_.js";
 export {
-  C as ClueUIPluginStore,
-  c as default
+  t as ClueUIPluginStore,
+  a as default
 };

package/plugins/test/index.js

@@ -1,25 +1,25 @@
-var __defProp = Object.defineProperty;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-import { jsx } from "react/jsx-runtime";
-import { Typography } from "@mui/material";
-import ClueUIPlugin from "../ClueUIPlugin.js";
-class TestPlugin extends ClueUIPlugin {
+var a = Object.defineProperty;
+var o = (t, e, r) => e in t ? a(t, e, { enumerable: !0, configurable: !0, writable: !0, value: r }) : t[e] = r;
+var i = (t, e, r) => o(t, typeof e != "symbol" ? e + "" : e, r);
+import { jsx as n } from "react/jsx-runtime";
+import { Typography as s } from "@mui/material";
+import u from "../ClueUIPlugin.js";
+class f extends u {
   constructor() {
     super(...arguments);
-    __publicField(this, "name", "TestPlugin");
-    __publicField(this, "format", "test");
-    __publicField(this, "version", "0.0.1");
-    __publicField(this, "author", "Canadian Centre for Cyber Security Matthew.Rafuse@cyber.gc.ca");
-    __publicField(this, "description", "This plugin is a test.");
+    i(this, "name", "TestPlugin");
+    i(this, "format", "test");
+    i(this, "version", "0.0.1");
+    i(this, "author", "Canadian Centre for Cyber Security Matthew.Rafuse@cyber.gc.ca");
+    i(this, "description", "This plugin is a test.");
   }
-  actionResult(_props) {
-    return /* @__PURE__ */ jsx(Typography, { variant: "h1", children: "Test Plugin!" });
+  actionResult(r) {
+    return /* @__PURE__ */ n(s, { variant: "h1", children: "Test Plugin!" });
   }
-  fetcherResult(_props) {
-    return /* @__PURE__ */ jsx(Typography, { variant: "h1", children: "Test Plugin!" });
+  fetcherResult(r) {
+    return /* @__PURE__ */ n(s, { variant: "h1", children: "Test Plugin!" });
   }
 }
 export {
-  TestPlugin as default
+  f as default
 };

package/plugins/utils.d.ts

@@ -0,0 +1 @@
+export declare const validateJsonData: (data: unknown) => object;

package/plugins/utils.js

@@ -0,0 +1,19 @@
+const o = (r) => {
+  let t = r;
+  if (typeof t == "string")
+    try {
+      t = JSON.parse(t);
+    } catch (e) {
+      throw new Error(`Failed to parse JSON string: ${String(e)}`, {
+        cause: e instanceof Error ? e : void 0
+      });
+    }
+  if (t === null || typeof t != "object") {
+    const e = t === null ? "null" : typeof t;
+    throw new Error(`Input must be a JSON object or a JSON object encoded as a string. Got: ${e}`);
+  }
+  return t;
+};
+export {
+  o as validateJsonData
+};