@grafana/assistant 0.0.12 → 0.0.13

package/README.md

@@ -86,7 +86,7 @@ openAssistant({
 
 ### Providing Page-Specific Context
 
-You can register context items that are automatically included when the assistant is opened on pages matching specific URL patterns. The `providePageContext` function works like `useState` - it returns a setter function that allows you to update the context dynamically:
+You can register context items that are automatically included when the assistant is opened on pages matching specific URL patterns. The `providePageContext` function returns a setter function that allows you to update the context dynamically:
 
 ```typescript
 import { providePageContext, createContext } from '@grafana/assistant';
@@ -116,16 +116,61 @@ setContext([
   })
 ]);
 
-// The context will automatically be included when openAssistant is called from dashboard pages
-openAssistant({ 
-  prompt: 'Help me analyze this dashboard' 
-  // Current context is automatically included
-});
-
 // Clean up when no longer needed
 setContext.unregister();
 ```
 
+### Using Page Context in React Components
+
+For React components, use the `useProvidePageContext` hook which automatically handles cleanup:
+
+```typescript
+import { useProvidePageContext, createContext } from '@grafana/assistant';
+
+function DashboardComponent() {
+  const dashboardContext = createContext('structured', {
+    data: {
+      name: 'Dashboard Context',
+      pageType: 'dashboard'
+    }
+  });
+
+  // Automatically cleans up on unmount
+  const setContext = useProvidePageContext('/d/*', [dashboardContext]);
+
+  // Update context when needed
+  const handlePanelSelect = (panelId: string) => {
+    setContext([
+      dashboardContext,
+      createContext('structured', {
+        data: {
+          name: 'Panel Context',
+          selectedPanel: panelId
+        }
+      })
+    ]);
+  };
+
+  return <div>Dashboard content</div>;
+}
+```
+
+### Accessing Current Page Context
+
+Use the `usePageContext` hook to access all active context for the current page:
+
+```typescript
+import { usePageContext } from '@grafana/assistant';
+
+function MyComponent() {
+  const pageContext = usePageContext();
+  
+  console.log('Active context items:', pageContext);
+  
+  return <div>Page has {pageContext.length} context items</div>;
+}
+```
+
 ### Creating Context Items
 
 The `createContext` function allows you to create structured context items that provide the assistant with additional information about your Grafana resources.
@@ -182,6 +227,7 @@ const structuredContext = createContext('structured', {
 
 // Create generic context
 const genericContext = createContext('unknown', {
+  id: 'my-context',
   text: 'Some additional context information'
 });
 ```
@@ -221,7 +267,7 @@ export const getExtensionConfigs = () => [
 
 ### React Hooks
 
-#### `useAssistant(): AssistantHook`
+#### `useAssistant(): [boolean, ((props: OpenAssistantProps) => void) | undefined, (() => void) | undefined]`
 
 A React hook that provides assistant availability status and control functions.
 
@@ -230,6 +276,22 @@ A React hook that provides assistant availability status and control functions.
 - `openAssistant?: (props: OpenAssistantProps) => void` - Function to open the assistant (undefined if not available)
 - `closeAssistant?: () => void` - Function to close the assistant (undefined if not available)
 
+#### `usePageContext(): ChatContextItem[]`
+
+A React hook that returns all active context items for the current page based on registered URL patterns.
+
+**Returns:** Array of `ChatContextItem` objects that match the current page URL.
+
+#### `useProvidePageContext(urlPattern: string | RegExp, initialContext?: ChatContextItem[]): (context: ChatContextItem[]) => void`
+
+A React hook for providing page context that automatically cleans up on unmount. This is the recommended way to use page context in React components.
+
+**Parameters:**
+- `urlPattern` - URL pattern (string or RegExp) to match against page URLs
+- `initialContext` - Initial array of ChatContextItem to provide when the pattern matches (defaults to empty array)
+
+**Returns:** A setter function to update the context
+
 ### Availability Functions
 
 #### `isAssistantAvailable(): Observable<boolean>`
@@ -274,7 +336,7 @@ Creates a context item that can be passed to the assistant to provide additional
 
 #### `providePageContext(urlPattern: string | RegExp, initialContext: ChatContextItem[]): ((context: ChatContextItem[]) => void) & { unregister: () => void }`
 
-Registers context items for specific pages based on URL patterns. Returns a setter function to update the context dynamically, similar to `useState`. The context will be automatically included when the assistant is opened on pages matching the pattern.
+Registers context items for specific pages based on URL patterns. Returns a setter function to update the context dynamically. The context will be automatically included when the assistant is opened on pages matching the pattern.
 
 **Parameters:**
 - `urlPattern` - URL pattern (string with wildcards or RegExp) to match against page URLs
@@ -300,7 +362,105 @@ setDashboardContext([...newContext]);
 setDashboardContext.unregister();
 ```
 
+### Questions System
+
+The questions system allows external parties to provide sample prompts with optional context for specific pages. It reuses the existing page context infrastructure but presents a simpler interface focused on questions.
+
+#### `provideQuestions(urlPattern: string | RegExp, initialQuestions: Question[]): ((questions: Question[]) => void) & { unregister: () => void }`
+
+Registers questions for specific pages based on URL patterns. Returns a setter function to update the questions dynamically.
+
+**Parameters:**
+- `urlPattern` - URL pattern (string with wildcards or RegExp) to match against page URLs
+- `initialQuestions` - Initial array of `Question` to provide when the pattern matches
+
+**Returns:** A setter function to update the questions, with an `unregister` method attached for cleanup
+
+**Examples:**
+```typescript
+// Register questions for dashboard pages
+const setQuestions = provideQuestions("/d/*", [
+  {
+    prompt: "What metrics are available in this dashboard?",
+    context: [], // Optional context items created with `createContext`
+  },
+  {
+    prompt: "How can I optimize the queries in this dashboard?",
+    context: [
+      createContext("dashboard", {
+        dashboardUid: 'dashboard-uid',
+        dashboardTitle: 'System Overview',
+        folderUid: 'folder-uid',
+        folderTitle: 'Production'
+      }),
+    ],
+  },
+]);
+
+// Update questions dynamically
+setQuestions([
+  {
+    prompt: "What are the key insights from this dashboard?",
+    context: []
+  }
+]);
+
+// Cleanup when done
+setQuestions.unregister();
+```
+
+#### `useProvideQuestions(urlPattern: string | RegExp, initialQuestions?: Question[]): (questions: Question[]) => void`
+
+React hook for providing questions that automatically cleans up on unmount. This is the recommended way to use questions in React components.
+
+**Parameters:**
+- `urlPattern` - URL pattern (string or RegExp) to match against page URLs
+- `initialQuestions` - Initial array of questions to provide when the pattern matches (defaults to empty array)
+
+**Returns:** A setter function to update the questions
+
+**Example:**
+```typescript
+function DashboardComponent() {
+  const setQuestions = useProvideQuestions('/d/*', [
+    {
+      prompt: "What does this dashboard show?",
+    },
+    {
+      prompt: "How can I improve this dashboard?",
+    }
+  ]);
+
+  return <div>Dashboard</div>;
+}
+```
+
+#### `useQuestions(): Question[]`
 
+React hook to get all questions that match the current URL. This filters the page context to only return question-type items.
+
+**Returns:** Array of questions from all matching registrations
+
+**Example:**
+```typescript
+function AssistantComponent() {
+  const questions = useQuestions();
+  
+  return (
+    <div>
+      <h3>Suggested Questions:</h3>
+      {questions.map((question, index) => (
+        <div key={index}>
+          <p>{question.prompt}</p>
+          {question.context && question.context.length > 0 && (
+            <p>Has additional context</p>
+          )}
+        </div>
+      ))}
+    </div>
+  );
+}
+```
 
 ### Sidebar Types
 
@@ -310,7 +470,6 @@ setDashboardContext.unregister();
 type OpenAssistantProps = {
   prompt?: string;
   context?: ChatContextItem[];
-  includePageContext?: boolean;
 };
 ```
 
@@ -318,7 +477,6 @@ Configuration object for opening the assistant.
 
 - `prompt` - Optional initial prompt to display
 - `context` - Optional context items to provide  
-- `includePageContext` - Whether to automatically include page context for the current URL (defaults to true)
 
 #### `ChatContextItem`
 
@@ -331,7 +489,44 @@ type ChatContextItem = {
 
 A context item that provides structured information to the assistant.
 
+### Page Context Types
+
+#### `PageContextRegistration`
 
+```typescript
+interface PageContextRegistration {
+  id: string;
+  urlPattern: string | RegExp;
+  context: ChatContextItem[];
+}
+```
+
+Represents a registered page context mapping.
+
+### Questions Types
+
+#### `Question`
+
+```typescript
+interface Question {
+  prompt: string;           // The sample prompt/question
+  context?: ChatContextItem[]; // Optional context items
+}
+```
+
+Represents a question with an optional prompt and context.
+
+#### `QuestionRegistration`
+
+```typescript
+interface QuestionRegistration {
+  id: string;
+  urlPattern: string | RegExp;
+  questions: Question[];
+}
+```
+
+Represents a registered questions mapping.
 
 ### Context Types
 
@@ -400,10 +595,7 @@ interface CreateLabelValueContextParams {
 
 ```typescript
 interface StructuredNodeDataParams {
-  data: {
-    name: string;
-    [key: string]: any;
-  };
+  data: Record<string, any>;
   title?: string;
   icon?: IconName;
 }
@@ -413,7 +605,8 @@ interface StructuredNodeDataParams {
 
 ```typescript
 interface NodeDataParams {
-  text: string;
+  id: string;
+  text?: string;
   title?: string;
   icon?: IconName;
 }
@@ -483,6 +676,24 @@ const CALLBACK_EXTENSION_POINT = 'grafana-assistant-app/callback/v0-alpha';
 
 The extension point ID for registering assistant functions.
 
+### Additional Exported Types
+
+The package also exports the following types for advanced use cases:
+
+```typescript
+// Data types for context items
+export type DashboardNodeData;
+export type DatasourceNodeData; 
+export type FolderNodeData;
+export type LabelNameNodeData;
+export type LabelValueNodeData;
+export type StructuredNodeData;
+export type TreeNode;
+
+// Enums
+export enum ItemDataType;
+```
+
 ## License
 
 Apache-2.0

package/dist/context/index.d.ts

@@ -5,4 +5,5 @@ export * from './datasource';
 export * from './factory';
 export * from './label';
 export * from './page';
+export * from './questions';
 export * from './types';

package/dist/context/page.d.ts

@@ -26,4 +26,6 @@ export declare function providePageContext(urlPattern: string | RegExp, initialC
  * @returns A setter function to update the context
  */
 export declare function useProvidePageContext(urlPattern: string | RegExp, initialContext?: ChatContextItem[]): (context: ChatContextItem[]) => void;
-export declare function usePageContext(): ChatContextItem[];
+export declare function usePageContext(options?: {
+    allowQuestions: boolean;
+}): ChatContextItem[];

package/dist/context/questions.d.ts

@@ -0,0 +1,39 @@
+import { ChatContextItem } from './types';
+export interface Question {
+    prompt: string;
+    context?: ChatContextItem[];
+}
+export interface QuestionRegistration {
+    id: string;
+    urlPattern: string | RegExp;
+    questions: Question[];
+}
+/**
+ * Registers questions for specific pages based on URL patterns.
+ * Returns a setter function to update the questions dynamically, similar to useState.
+ *
+ * If a registration with the same URL pattern already exists, it will be replaced.
+ *
+ * @param urlPattern - URL pattern (string or RegExp) to match against page URLs
+ * @param initialQuestions - Initial array of questions to provide when the pattern matches
+ * @returns A setter function to update the questions, with an unregister method attached
+ */
+export declare function provideQuestions(urlPattern: string | RegExp, initialQuestions: Question[]): ((questions: Question[]) => void) & {
+    unregister: () => void;
+};
+/**
+ * React hook for providing questions that automatically cleans up on unmount.
+ * This is the recommended way to use questions in React components.
+ *
+ * @param urlPattern - URL pattern (string or RegExp) to match against page URLs
+ * @param initialQuestions - Initial array of questions to provide when the pattern matches
+ * @returns A setter function to update the questions
+ */
+export declare function useProvideQuestions(urlPattern: string | RegExp, initialQuestions?: Question[]): (questions: Question[]) => void;
+/**
+ * React hook to get all questions that match the current URL.
+ * This filters the page context to only return question-type items.
+ *
+ * @returns Array of questions from all matching registrations
+ */
+export declare function useQuestions(): Question[];

package/dist/context/types.d.ts

@@ -26,6 +26,7 @@ export interface TreeNode {
     title?: string;
     navigable: boolean;
     selectable?: boolean;
+    img?: string;
     icon?: IconName;
     data?: any;
 }

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { createContext, ChatContextItem, DashboardNodeData, DatasourceNodeData, FolderNodeData, ItemDataType, LabelNameNodeData, LabelValueNodeData, StructuredNodeData, TreeNode, providePageContext, PageContextRegistration, usePageContext, } from './context/index';
+export { createContext, ChatContextItem, DashboardNodeData, DatasourceNodeData, FolderNodeData, ItemDataType, LabelNameNodeData, LabelValueNodeData, StructuredNodeData, TreeNode, providePageContext, PageContextRegistration, usePageContext, provideQuestions, useProvideQuestions, useQuestions, Question, QuestionRegistration, } from './context/index';
 export * from './functions';
 export * from './hook';
 export * from './plugin';

package/dist/index.js

@@ -1 +1 @@
-(()=>{"use strict";var e,t={d:(e,a)=>{for(var n in a)t.o(a,n)&&!t.o(e,n)&&Object.defineProperty(e,n,{enumerable:!0,get:a[n]})},o:(e,t)=>Object.prototype.hasOwnProperty.call(e,t),r:e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})}},a={};function n(e){let t=5381;for(let a=0;a<e.length;a++)t=(t<<5)+t+e.charCodeAt(a);return(t>>>0).toString(16)}t.r(a),t.d(a,{CALLBACK_EXTENSION_POINT:()=>N,DashboardNodeData:()=>o,DatasourceNodeData:()=>d,FolderNodeData:()=>i,ItemDataType:()=>e,LabelNameNodeData:()=>l,LabelValueNodeData:()=>c,StructuredNodeData:()=>r,closeAssistant:()=>V,createContext:()=>p,getExposeAssistantFunctionsConfig:()=>D,isAssistantAvailable:()=>I,newFunctionNamespace:()=>U,openAssistant:()=>P,providePageContext:()=>E,useAssistant:()=>O,usePageContext:()=>y}),function(e){e.Unknown="unknown",e.Datasource="datasource",e.LabelName="label_name",e.LabelValue="label_value",e.Dashboard="dashboard",e.DashboardFolder="dashboard_folder",e.Structured="structured"}(e||(e={}));class s{constructor(e){this.params=e,this.text="",this.id=n(e.id)}formatForLLM(t){var a,n;return{type:e.Unknown,codeElementIds:t,data:{name:null!==(a=this.params.text)&&void 0!==a?a:"",text:null!==(n=this.params.text)&&void 0!==n?n:""}}}}class r{constructor(e){this.params=e,this.id=n(JSON.stringify(e.data))}formatForLLM(t){return{type:e.Structured,codeElementIds:t,data:this.params.data}}}class o extends s{constructor(e){super({...e,id:e.dashboardUid}),this.text="",this.dashboardUid=e.dashboardUid,this.dashboardTitle=e.dashboardTitle,this.folderUid=e.folderUid,this.folderTitle=e.folderTitle,this.text=e.dashboardTitle}formatForLLM(t){return{type:e.Dashboard,codeElementIds:t,data:{name:this.dashboardTitle,dashboardUid:this.dashboardUid,dashboardTitle:this.dashboardTitle,folderUid:this.folderUid,folderTitle:this.folderTitle,text:this.text}}}}class i extends s{constructor(e){super({...e,id:e.folderUid}),this.text="",this.folderUid=e.folderUid,this.folderTitle=e.folderTitle,this.text=e.folderTitle}formatForLLM(t){return{type:e.DashboardFolder,codeElementIds:t,data:{name:this.folderTitle,folderUid:this.folderUid,folderTitle:this.folderTitle,text:this.text}}}}class d extends s{constructor(e){super({...e,id:e.datasourceUid}),this.text="",this.datasourceUid=e.datasourceUid,this.datasourceType=e.datasourceType,this.datasourceName=e.datasourceName,this.text=e.datasourceName}formatForLLM(t){return{type:e.Datasource,codeElementIds:t,data:{name:this.datasourceName,uid:this.datasourceUid,type:this.datasourceType,text:this.text}}}}class l extends s{constructor(e){super({...e,id:`${e.datasourceUid}-${e.labelName}`}),this.text="",this.datasourceUid=e.datasourceUid,this.datasourceType=e.datasourceType,this.labelName=e.labelName,this.text=e.labelName}formatForLLM(t){return{type:e.LabelName,codeElementIds:t,data:{name:this.labelName,datasourceUid:this.datasourceUid,datasourceType:this.datasourceType,labelName:this.labelName,text:this.text}}}}class c extends s{constructor(e){super({...e,id:`${e.datasourceUid}-${e.labelName}-${e.labelValue}`}),this.text="",this.datasourceUid=e.datasourceUid,this.datasourceType=e.datasourceType,this.labelName=e.labelName,this.labelValue=e.labelValue,this.text=e.labelValue}formatForLLM(t){return{type:e.LabelValue,codeElementIds:t,data:{name:this.labelValue,datasourceUid:this.datasourceUid,datasourceType:this.datasourceType,labelName:this.labelName,labelValue:this.labelValue,text:this.text}}}}const u={[e.Datasource]:"database",[e.LabelName]:"database",[e.LabelValue]:"database",[e.Dashboard]:"dashboard",[e.DashboardFolder]:"folder",[e.Unknown]:"circle-mono",[e.Structured]:"gf-grid"};function h(t,a){return t===e.Datasource?a.datasourceName:t===e.LabelName?a.labelName:t===e.LabelValue?a.labelValue:t===e.Dashboard?a.dashboardTitle:t===e.DashboardFolder?a.folderTitle:t===e.Structured?a.data.name:"Given Context"}function p(e,t){var a,n;const p=function(e,t){switch(e){case"datasource":return new d(t);case"label_name":return new l(t);case"label_value":return new c(t);case"dashboard":return new o(t);case"dashboard_folder":return new i(t);case"structured":return new r(t);case"unknown":return new s(t);default:return console.error(`Unknown context type: ${e}`),new s(t)}}(e,t);return{node:{id:p.id,name:null!==(a=t.title)&&void 0!==a?a:h(e,t),icon:null!==(n=t.icon)&&void 0!==n?n:u[e],navigable:!1,selectable:!0,data:p},occurrences:[]}}const f=require("@grafana/runtime"),b=require("react"),m=[],v="grafana-assistant:page-context-sync",x="grafana-assistant:page-context-update",w="grafana-assistant:page-context-remove",g="grafana-assistant:location-changed";let L=!1;function E(e,t){const a=m.findIndex((t=>{return a=t.urlPattern,n=e,"string"==typeof a&&"string"==typeof n?a===n:a instanceof RegExp&&n instanceof RegExp&&a.source===n.source&&a.flags===n.flags;var a,n}));let n;-1!==a?(n=m[a],n.context=[...t]):(n={id:`page-context-${Date.now()}-${Math.random().toString(36).slice(2,11)}`,urlPattern:e,context:[...t]},m.push(n)),window.dispatchEvent(new CustomEvent(x,{detail:n})),window.dispatchEvent(new CustomEvent(v,{detail:{registry:m}}));const s=e=>{const t=m.findIndex((e=>e.id===n.id));-1!==t&&(m[t].context=[...e],window.dispatchEvent(new CustomEvent(x,{detail:m[t]})))};return s.unregister=()=>{const e=m.findIndex((e=>e.id===n.id));-1!==e&&(m.splice(e,1),window.dispatchEvent(new CustomEvent(w,{detail:{id:n.id}})))},s}function y(){const[e,t]=(0,b.useState)([]),a=(0,f.useLocationService)(),n=(0,b.useRef)("");return(0,b.useEffect)((()=>{const e=()=>{const e=function(e,t){if(!e)return[];const a=[];for(const n of t)T(e,n.urlPattern)&&a.push(...n.context);return a}(a.getLocation().pathname,m);t(e)},s=()=>{e()},r=t=>{var n;const s=null===(n=t.detail)||void 0===n?void 0:n.pathname;s&&s===a.getLocation().pathname&&e()},o=a.getLocationObservable().subscribe((t=>{const a=t.pathname;a!==n.current&&(n.current=a,function(e){window.dispatchEvent(new CustomEvent(g,{detail:{pathname:e}}))}(a),e())}));return e(),window.addEventListener(v,s),window.addEventListener(x,s),window.addEventListener(w,s),window.addEventListener(g,r),()=>{o.unsubscribe(),window.removeEventListener(v,s),window.removeEventListener(x,s),window.removeEventListener(w,s),window.removeEventListener(g,r)}}),[a]),e}function T(e,t){if(t instanceof RegExp)return t.test(e);if("string"==typeof t){const a=t.replace(/\*\*/g,"\0DOUBLE_STAR\0").replace(/\*/g,"[^/]*").replace(/\u0000DOUBLE_STAR\u0000/g,".*").replace(/\?/g,".");return new RegExp(`^${a}$`).test(e)}return!1}L||(window.addEventListener(v,(e=>{var t;const a=null===(t=e.detail)||void 0===t?void 0:t.registry;if(a){const e=new Set(m.map((e=>e.id))),t=a.filter((t=>!e.has(t.id)));m.push(...t)}})),window.addEventListener(x,(e=>{const t=e.detail;if(t){const e=m.findIndex((e=>e.id===t.id));-1!==e?m[e]=t:m.push(t)}})),window.addEventListener(w,(e=>{var t;const a=null===(t=e.detail)||void 0===t?void 0:t.id;if(a){const e=m.findIndex((e=>e.id===a));-1!==e&&m.splice(e,1)}})),L=!0);const N="grafana-assistant-app/callback/v0-alpha";function U(e,t){return{namespace:e,functions:t}}function D(e){return{title:"callback",targets:[N],fn:()=>e.map((e=>({namespace:e.namespace,functions:e.functions})))}}const S=require("rxjs");function I(){return(0,f.getObservablePluginLinks)({extensionPointId:"grafana/extension-sidebar/v0-alpha"}).pipe((0,S.map)((e=>e.some((e=>"grafana-assistant-app"===e.pluginId&&"Grafana Assistant"===e.title)))))}const A=require("@grafana/data");class C extends A.BusEventWithPayload{}C.type="open-extension-sidebar";class F extends A.BusEventBase{}function P(e){!function(e,t,a){const n=new C({pluginId:"grafana-assistant-app",componentTitle:"Grafana Assistant",props:a});(0,f.getAppEvents)().publish(n)}(0,0,{initialPrompt:e.prompt,initialContext:e.context})}function V(){!function(){const e=new F;(0,f.getAppEvents)().publish(e)}()}function O(){const[e,t]=(0,b.useState)(!1);return(0,b.useEffect)((()=>{const e=I().subscribe((e=>t(e)));return()=>{e.unsubscribe()}}),[]),[e,e?P:void 0,e?V:void 0]}F.type="close-extension-sidebar",module.exports=a})();
+(()=>{"use strict";var e,t={d:(e,a)=>{for(var n in a)t.o(a,n)&&!t.o(e,n)&&Object.defineProperty(e,n,{enumerable:!0,get:a[n]})},o:(e,t)=>Object.prototype.hasOwnProperty.call(e,t),r:e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})}},a={};function n(e){let t=5381;for(let a=0;a<e.length;a++)t=(t<<5)+t+e.charCodeAt(a);return(t>>>0).toString(16)}t.r(a),t.d(a,{CALLBACK_EXTENSION_POINT:()=>I,DashboardNodeData:()=>o,DatasourceNodeData:()=>d,FolderNodeData:()=>i,ItemDataType:()=>e,LabelNameNodeData:()=>l,LabelValueNodeData:()=>u,StructuredNodeData:()=>r,closeAssistant:()=>_,createContext:()=>f,getExposeAssistantFunctionsConfig:()=>C,isAssistantAvailable:()=>F,newFunctionNamespace:()=>A,openAssistant:()=>$,providePageContext:()=>y,provideQuestions:()=>N,useAssistant:()=>k,usePageContext:()=>L,useProvideQuestions:()=>U,useQuestions:()=>D}),function(e){e.Unknown="unknown",e.Datasource="datasource",e.LabelName="label_name",e.LabelValue="label_value",e.Dashboard="dashboard",e.DashboardFolder="dashboard_folder",e.Structured="structured"}(e||(e={}));class s{constructor(e){this.params=e,this.text="",this.id=n(e.id)}formatForLLM(t){var a,n;return{type:e.Unknown,codeElementIds:t,data:{name:null!==(a=this.params.text)&&void 0!==a?a:"",text:null!==(n=this.params.text)&&void 0!==n?n:""}}}}class r{constructor(e){this.params=e,this.id=n(JSON.stringify(e.data))}formatForLLM(t){return{type:e.Structured,codeElementIds:t,data:this.params.data}}}class o extends s{constructor(e){super({...e,id:e.dashboardUid}),this.text="",this.dashboardUid=e.dashboardUid,this.dashboardTitle=e.dashboardTitle,this.folderUid=e.folderUid,this.folderTitle=e.folderTitle,this.text=e.dashboardTitle}formatForLLM(t){return{type:e.Dashboard,codeElementIds:t,data:{name:this.dashboardTitle,dashboardUid:this.dashboardUid,dashboardTitle:this.dashboardTitle,folderUid:this.folderUid,folderTitle:this.folderTitle,text:this.text}}}}class i extends s{constructor(e){super({...e,id:e.folderUid}),this.text="",this.folderUid=e.folderUid,this.folderTitle=e.folderTitle,this.text=e.folderTitle}formatForLLM(t){return{type:e.DashboardFolder,codeElementIds:t,data:{name:this.folderTitle,folderUid:this.folderUid,folderTitle:this.folderTitle,text:this.text}}}}class d extends s{constructor(e){super({...e,id:e.datasourceUid}),this.text="",this.datasourceUid=e.datasourceUid,this.datasourceType=e.datasourceType,this.datasourceName=e.datasourceName,this.text=e.datasourceName}formatForLLM(t){return{type:e.Datasource,codeElementIds:t,data:{name:this.datasourceName,uid:this.datasourceUid,type:this.datasourceType,text:this.text}}}}class l extends s{constructor(e){super({...e,id:`${e.datasourceUid}-${e.labelName}`}),this.text="",this.datasourceUid=e.datasourceUid,this.datasourceType=e.datasourceType,this.labelName=e.labelName,this.text=e.labelName}formatForLLM(t){return{type:e.LabelName,codeElementIds:t,data:{name:this.labelName,datasourceUid:this.datasourceUid,datasourceType:this.datasourceType,labelName:this.labelName,text:this.text}}}}class u extends s{constructor(e){super({...e,id:`${e.datasourceUid}-${e.labelName}-${e.labelValue}`}),this.text="",this.datasourceUid=e.datasourceUid,this.datasourceType=e.datasourceType,this.labelName=e.labelName,this.labelValue=e.labelValue,this.text=e.labelValue}formatForLLM(t){return{type:e.LabelValue,codeElementIds:t,data:{name:this.labelValue,datasourceUid:this.datasourceUid,datasourceType:this.datasourceType,labelName:this.labelName,labelValue:this.labelValue,text:this.text}}}}const c={[e.Datasource]:"database",[e.LabelName]:"database",[e.LabelValue]:"database",[e.Dashboard]:"dashboard",[e.DashboardFolder]:"folder",[e.Unknown]:"circle-mono",[e.Structured]:"gf-grid"};function p(t,a){return t===e.Datasource?a.datasourceName:t===e.LabelName?a.labelName:t===e.LabelValue?a.labelValue:t===e.Dashboard?a.dashboardTitle:t===e.DashboardFolder?a.folderTitle:t===e.Structured?a.data.name:"Given Context"}function f(e,t){var a,n;const f=function(e,t){switch(e){case"datasource":return new d(t);case"label_name":return new l(t);case"label_value":return new u(t);case"dashboard":return new o(t);case"dashboard_folder":return new i(t);case"structured":return new r(t);case"unknown":return new s(t);default:return console.error(`Unknown context type: ${e}`),new s(t)}}(e,t);return{node:{id:f.id,name:null!==(a=t.title)&&void 0!==a?a:p(e,t),icon:null!==(n=t.icon)&&void 0!==n?n:c[e],navigable:!1,selectable:!0,data:f},occurrences:[]}}const h=require("@grafana/runtime"),m=require("react"),b=[],v="grafana-assistant:page-context-sync",x="grafana-assistant:page-context-update",g="grafana-assistant:page-context-remove",w="grafana-assistant:location-changed";let E=!1;function y(e,t){const a=b.findIndex((t=>{return a=t.urlPattern,n=e,"string"==typeof a&&"string"==typeof n?a===n:a instanceof RegExp&&n instanceof RegExp&&a.source===n.source&&a.flags===n.flags;var a,n}));let n;-1!==a?(n=b[a],n.context=[...t]):(n={id:`page-context-${Date.now()}-${Math.random().toString(36).slice(2,11)}`,urlPattern:e,context:[...t]},b.push(n)),window.dispatchEvent(new CustomEvent(x,{detail:n})),window.dispatchEvent(new CustomEvent(v,{detail:{registry:b}}));const s=e=>{const t=b.findIndex((e=>e.id===n.id));-1!==t&&(b[t].context=[...e],window.dispatchEvent(new CustomEvent(x,{detail:b[t]})))};return s.unregister=()=>{const e=b.findIndex((e=>e.id===n.id));-1!==e&&(b.splice(e,1),window.dispatchEvent(new CustomEvent(g,{detail:{id:n.id}})))},s}function L(e={allowQuestions:!1}){const[t,a]=(0,m.useState)([]),n=(0,h.useLocationService)(),s=(0,m.useRef)("");return(0,m.useEffect)((()=>{const e=()=>{const e=function(e,t){if(!e)return[];const a=[];for(const n of t)T(e,n.urlPattern)&&a.push(...n.context);return a}(n.getLocation().pathname,b);a(e)},t=()=>{e()},r=t=>{var a;const s=null===(a=t.detail)||void 0===a?void 0:a.pathname;s&&s===n.getLocation().pathname&&e()},o=n.getLocationObservable().subscribe((t=>{const a=t.pathname;a!==s.current&&(s.current=a,function(e){window.dispatchEvent(new CustomEvent(w,{detail:{pathname:e}}))}(a),e())}));return e(),window.addEventListener(v,t),window.addEventListener(x,t),window.addEventListener(g,t),window.addEventListener(w,r),()=>{o.unsubscribe(),window.removeEventListener(v,t),window.removeEventListener(x,t),window.removeEventListener(g,t),window.removeEventListener(w,r)}}),[n]),e.allowQuestions?t:t.filter((e=>{var t;return"question"!==(null===(t=e.node.data)||void 0===t?void 0:t.type)}))}function T(e,t){if(t instanceof RegExp)return t.test(e);if("string"==typeof t){const a=t.replace(/\*\*/g,"\0DOUBLE_STAR\0").replace(/\*/g,"[^/]*").replace(/\u0000DOUBLE_STAR\u0000/g,".*").replace(/\?/g,".");return new RegExp(`^${a}$`).test(e)}return!1}function N(e,t){const a=e=>e.map(((e,t)=>({node:{id:`question-${t}`,name:e.prompt,navigable:!1,selectable:!0,icon:"question-circle",data:{type:"question",prompt:e.prompt,context:e.context||[]}},occurrences:[]}))),n=y(e,a(t)),s=e=>{n(a(e))};return s.unregister=n.unregister,s}function U(e,t=[]){const a=e=>e.map(((e,t)=>({node:{id:`question-${t}`,name:e.prompt,navigable:!1,selectable:!0,icon:"question-circle",data:{type:"question",prompt:e.prompt,context:e.context||[]}},occurrences:[]}))),n=function(e,t=[]){const a=(0,m.useRef)(),n=(0,m.useRef)(t);return n.current=t,(0,m.useEffect)((()=>(a.current=y(e,n.current),()=>{var e;null===(e=a.current)||void 0===e||e.unregister()})),[e]),(0,m.useEffect)((()=>{a.current&&a.current(t)}),[t]),(0,m.useCallback)((e=>{var t;null===(t=a.current)||void 0===t||t.call(a,e)}),[])}(e,a(t));return e=>{n(a(e))}}function D(){const e=L({allowQuestions:!0});return S(e)}E||(window.addEventListener(v,(e=>{var t;const a=null===(t=e.detail)||void 0===t?void 0:t.registry;if(a){const e=new Set(b.map((e=>e.id))),t=a.filter((t=>!e.has(t.id)));b.push(...t)}})),window.addEventListener(x,(e=>{const t=e.detail;if(t){const e=b.findIndex((e=>e.id===t.id));-1!==e?b[e]=t:b.push(t)}})),window.addEventListener(g,(e=>{var t;const a=null===(t=e.detail)||void 0===t?void 0:t.id;if(a){const e=b.findIndex((e=>e.id===a));-1!==e&&b.splice(e,1)}})),E=!0);const S=e=>e.filter((e=>{var t;return"question"===(null===(t=e.node.data)||void 0===t?void 0:t.type)})).map((e=>{var t,a;return{prompt:(null===(t=e.node.data)||void 0===t?void 0:t.prompt)||e.node.name,context:(null===(a=e.node.data)||void 0===a?void 0:a.context)||[]}})),I="grafana-assistant-app/callback/v0-alpha";function A(e,t){return{namespace:e,functions:t}}function C(e){return{title:"callback",targets:[I],fn:()=>e.map((e=>({namespace:e.namespace,functions:e.functions})))}}const P=require("rxjs");function F(){return(0,h.getObservablePluginLinks)({extensionPointId:"grafana/extension-sidebar/v0-alpha"}).pipe((0,P.map)((e=>e.some((e=>"grafana-assistant-app"===e.pluginId&&"Grafana Assistant"===e.title)))))}const V=require("@grafana/data");class q extends V.BusEventWithPayload{}q.type="open-extension-sidebar";class O extends V.BusEventBase{}function $(e){!function(e,t,a){const n=new q({pluginId:"grafana-assistant-app",componentTitle:"Grafana Assistant",props:a});(0,h.getAppEvents)().publish(n)}(0,0,{initialPrompt:e.prompt,initialContext:e.context})}function _(){!function(){const e=new O;(0,h.getAppEvents)().publish(e)}()}function k(){const[e,t]=(0,m.useState)(!1);return(0,m.useEffect)((()=>{const e=F().subscribe((e=>t(e)));return()=>{e.unsubscribe()}}),[]),[e,e?$:void 0,e?_:void 0]}O.type="close-extension-sidebar",module.exports=a})();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/assistant",
-  "version": "0.0.12",
+  "version": "0.0.13",
   "description": "Type definitions and helper functions for Grafana Assistant",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",