@grafana/assistant 0.1.4 → 0.1.5

package/dist/tools/types.d.ts

@@ -0,0 +1,174 @@
+/**
+ * JSON object type - simple key-value structure
+ */
+export interface JsonObject {
+    [key: string]: any;
+}
+/**
+ * Represents a datasource configuration
+ */
+export interface ToolDatasourceInfo {
+    uid: string;
+    name: string;
+    type: string;
+}
+/**
+ * Function to determine if a tool should be registered based on available datasources
+ */
+export type ShouldRegisterFunction = (datasources: ToolDatasourceInfo[]) => boolean;
+/**
+ * Minimal options for a single request.
+ * Tools only need these basic options. This is a standalone type to avoid
+ * dependency on ConversationManager types from the main app.
+ */
+export interface SingleRequestOptions {
+    weak?: boolean;
+    signal?: AbortSignal;
+    showThinking?: boolean;
+    reasoningLevel?: string;
+}
+/**
+ * Minimal tool use content structure.
+ * Represents the minimal interface needed by tools without depending on main app types.
+ * Matches the structure from the chat API schema (ToolUseContent).
+ */
+export interface MinimalToolUseContent {
+    toolId: string;
+    toolName: string;
+    toolInput?: Record<string, unknown>;
+    type?: 'tool_use';
+}
+/**
+ * Minimal response from a single request.
+ * Tools primarily need the text and toolUse fields. The output field is available
+ * but typed as unknown to avoid dependency on ChatPromptOutput from the main app.
+ */
+export interface SingleRequestResponse {
+    text: string;
+    toolUse: MinimalToolUseContent[];
+    output?: unknown;
+}
+/**
+ * Interface for a Conversation Manager that can execute tools.
+ * This represents the capability to make single requests to the LLM with tool execution support.
+ */
+export interface ToolExecutingManager {
+    /**
+     * Make a single request to the model with centralized error handling
+     * @param systemPrompt System prompt message
+     * @param userMessage User message
+     * @param options Options for the single request (weak, signal, showThinking)
+     * @returns The model's response text
+     */
+    singleRequest(systemPrompt: string, userMessage: string, options?: SingleRequestOptions): Promise<SingleRequestResponse>;
+}
+/**
+ * Type for tool invocation options.
+ * The manager is typed as `ToolExecutingManager` to avoid dependency on ConversationManager from the main app.
+ * Consumers should cast it to the appropriate type when needed.
+ */
+export type ToolInvokeOptions = {
+    manager: ToolExecutingManager;
+    signal?: AbortSignal;
+    timeout?: number;
+};
+/**
+ * Tool output can be:
+ * - A simple string
+ * - A tuple of [string, artifact] where artifact can be any type (string, boolean, number, object, array, etc.)
+ *   Examples include PanelJSON, but the artifact can be any structured data type
+ */
+export type ToolOutput = string | [string, any | null] | [string, any[]] | [string, Record<string, any>];
+/**
+ * Minimal Tool interface - matches the structure needed without extending external Tool type
+ */
+export interface Tool {
+    name: string;
+    description: string;
+    inputSchema: JSONSchema;
+}
+/**
+ * Basic tool interface for inline tools that don't need to support conditional registration
+ * with the "Assistant" (aka frontend agent or chat).
+ *
+ * These tools are typically used for simple, one-off tasks like generating content or executing commands.
+ */
+export interface InlineToolRunnable extends Tool {
+    invoke: (input: JsonObject, options: ToolInvokeOptions) => Promise<ToolOutput>;
+    metadata?: JsonObject & {
+        explainer?: (input?: JsonObject) => string;
+    };
+    verboseParsingErrors?: boolean;
+    responseFormat?: 'content_and_artifact' | string;
+}
+/**
+ * JSON Schema type definition from @types/json-schema
+ * Using JSONSchema7 (Draft 7) which is compatible with zod's toJSONSchema output
+ * and other JSON Schema converters (yup, joi-to-json, etc.)
+ */
+export type _JSONSchema = boolean | JSONSchema;
+export type JSONSchema = {
+    [k: string]: unknown;
+    $schema?: 'https://json-schema.org/draft/2020-12/schema' | 'http://json-schema.org/draft-07/schema#' | 'http://json-schema.org/draft-04/schema#';
+    $id?: string;
+    $anchor?: string;
+    $ref?: string;
+    $dynamicRef?: string;
+    $dynamicAnchor?: string;
+    $vocabulary?: Record<string, boolean>;
+    $comment?: string;
+    $defs?: Record<string, JSONSchema>;
+    type?: 'object' | 'array' | 'string' | 'number' | 'boolean' | 'null' | 'integer';
+    additionalItems?: _JSONSchema;
+    unevaluatedItems?: _JSONSchema;
+    prefixItems?: _JSONSchema[];
+    items?: _JSONSchema | _JSONSchema[];
+    contains?: _JSONSchema;
+    additionalProperties?: _JSONSchema;
+    unevaluatedProperties?: _JSONSchema;
+    properties?: Record<string, _JSONSchema>;
+    patternProperties?: Record<string, _JSONSchema>;
+    dependentSchemas?: Record<string, _JSONSchema>;
+    propertyNames?: _JSONSchema;
+    if?: _JSONSchema;
+    then?: _JSONSchema;
+    else?: _JSONSchema;
+    allOf?: JSONSchema[];
+    anyOf?: JSONSchema[];
+    oneOf?: JSONSchema[];
+    not?: _JSONSchema;
+    multipleOf?: number;
+    maximum?: number;
+    exclusiveMaximum?: number | boolean;
+    minimum?: number;
+    exclusiveMinimum?: number | boolean;
+    maxLength?: number;
+    minLength?: number;
+    pattern?: string;
+    maxItems?: number;
+    minItems?: number;
+    uniqueItems?: boolean;
+    maxContains?: number;
+    minContains?: number;
+    maxProperties?: number;
+    minProperties?: number;
+    required?: string[];
+    dependentRequired?: Record<string, string[]>;
+    enum?: Array<string | number | boolean | null>;
+    const?: string | number | boolean | null;
+    id?: string;
+    title?: string;
+    description?: string;
+    default?: unknown;
+    deprecated?: boolean;
+    readOnly?: boolean;
+    writeOnly?: boolean;
+    nullable?: boolean;
+    examples?: unknown[];
+    format?: string;
+    contentMediaType?: string;
+    contentEncoding?: string;
+    contentSchema?: JSONSchema;
+    _prefault?: unknown;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/tools/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/tools/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,WAAW,EAAE,kBAAkB,EAAE,KAAK,OAAO,CAAC;AAEpF;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpC,IAAI,CAAC,EAAE,UAAU,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,qBAAqB,EAAE,CAAC;IACjC,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;;OAMG;IACH,aAAa,CACX,YAAY,EAAE,MAAM,EACpB,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,oBAAoB,GAC7B,OAAO,CAAC,qBAAqB,CAAC,CAAC;CACnC;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,oBAAoB,CAAC;IAC9B,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAClB,MAAM,GACN,CAAC,MAAM,EAAE,GAAG,GAAG,IAAI,CAAC,GACpB,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,GACf,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;AAElC;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,UAAU,CAAC;CACzB;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAmB,SAAQ,IAAI;IAC9C,MAAM,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,iBAAiB,KAAK,OAAO,CAAC,UAAU,CAAC,CAAC;IAC/E,QAAQ,CAAC,EAAE,UAAU,GAAG;QACtB,SAAS,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,UAAU,KAAK,MAAM,CAAC;KAC5C,CAAC;IACF,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,cAAc,CAAC,EAAE,sBAAsB,GAAG,MAAM,CAAC;CAClD;AAED;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,UAAU,CAAC;AAC/C,MAAM,MAAM,UAAU,GAAG;IACvB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACrB,OAAO,CAAC,EACJ,8CAA8C,GAC9C,yCAAyC,GACzC,yCAAyC,CAAC;IAC9C,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACtC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACnC,IAAI,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAC;IACjF,eAAe,CAAC,EAAE,WAAW,CAAC;IAC9B,gBAAgB,CAAC,EAAE,WAAW,CAAC;IAC/B,WAAW,CAAC,EAAE,WAAW,EAAE,CAAC;IAC5B,KAAK,CAAC,EAAE,WAAW,GAAG,WAAW,EAAE,CAAC;IACpC,QAAQ,CAAC,EAAE,WAAW,CAAC;IACvB,oBAAoB,CAAC,EAAE,WAAW,CAAC;IACnC,qBAAqB,CAAC,EAAE,WAAW,CAAC;IACpC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACzC,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAChD,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAC/C,aAAa,CAAC,EAAE,WAAW,CAAC;IAC5B,EAAE,CAAC,EAAE,WAAW,CAAC;IACjB,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,KAAK,CAAC,EAAE,UAAU,EAAE,CAAC;IACrB,KAAK,CAAC,EAAE,UAAU,EAAE,CAAC;IACrB,KAAK,CAAC,EAAE,UAAU,EAAE,CAAC;IACrB,GAAG,CAAC,EAAE,WAAW,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACpC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAC7C,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC,CAAC;IAC/C,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;IACzC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,aAAa,CAAC,EAAE,UAAU,CAAC;IAC3B,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/assistant",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "Type definitions and helper functions for Grafana Assistant",
   "repository": {
     "type": "git",
@@ -41,7 +41,7 @@
     "jest-environment-jsdom": "^29.5.0",
     "react": "18.3.1",
     "rxjs": "7.8.2",
-    "ts-loader": "^9.0.0",
+    "ts-loader": "^9.5.2",
     "typescript": "^5.0.0",
     "webpack": "^5.0.0",
     "webpack-cli": "^5.0.0"