@grafana/assistant 0.1.10 → 0.1.11

package/dist/investigations.d.ts

@@ -0,0 +1,41 @@
+import { BusEventWithPayload } from '@grafana/data';
+/**
+ * Payload for the InvestigationCreatedEvent
+ */
+export interface InvestigationCreatedPayload {
+    /** The ID of the newly created investigation */
+    investigationId: string;
+}
+/**
+ * Event emitted when an investigation is created.
+ * External integrations can subscribe to this event to react to new investigations.
+ */
+export declare class InvestigationCreatedEvent extends BusEventWithPayload<InvestigationCreatedPayload> {
+    static type: string;
+}
+/**
+ * Emit an InvestigationCreatedEvent to notify subscribers that a new investigation was created.
+ *
+ * @param investigationId - The ID of the newly created investigation
+ */
+export declare function emitInvestigationCreated(investigationId: string): void;
+/**
+ * Subscribe to investigation created events.
+ *
+ * @param callback - Function to call when an investigation is created
+ * @returns Unsubscribe function to stop listening for events
+ *
+ * @example
+ * ```typescript
+ * import { onInvestigationCreated } from '@grafana/assistant';
+ *
+ * const unsubscribe = onInvestigationCreated((payload) => {
+ *   console.log('Investigation created:', payload.investigationId);
+ * });
+ *
+ * // Later, when you want to stop listening
+ * unsubscribe();
+ * ```
+ */
+export declare function onInvestigationCreated(callback: (payload: InvestigationCreatedPayload) => void): () => void;
+//# sourceMappingURL=investigations.d.ts.map

package/dist/investigations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"investigations.d.ts","sourceRoot":"","sources":["../src/investigations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAGpD;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,gDAAgD;IAChD,eAAe,EAAE,MAAM,CAAC;CACzB;AAED;;;GAGG;AACH,qBAAa,yBAA0B,SAAQ,mBAAmB,CAAC,2BAA2B,CAAC;IAC7F,MAAM,CAAC,IAAI,SAA6C;CACzD;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,eAAe,EAAE,MAAM,GAAG,IAAI,CAGtE;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,2BAA2B,KAAK,IAAI,GAAG,MAAM,IAAI,CAM3G"}

package/dist/limits/index.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Event name dispatched when limits are updated via SSE.
+ * Other components can listen to this event to get real-time updates.
+ */
+export declare const LIMITS_UPDATED_EVENT = "grafana-assistant-limits-updated";
+/**
+ * Detail payload for the LIMITS_UPDATED_EVENT custom event.
+ */
+export interface LimitsUpdatedEventDetail {
+    count: number;
+    limit: number;
+}
+/**
+ * Result type for limits data.
+ */
+export interface LimitsData {
+    /** Current prompt count for the month */
+    count: number;
+    /** Monthly prompt limit (0 = unlimited) */
+    limit: number;
+    /** Current month in YYYY-MM format */
+    month: string;
+    /** Whether the limit has been reached */
+    isLimitReached: boolean;
+}
+/**
+ * Checks whether the user has reached their monthly prompt limit.
+ *
+ * @returns A promise that resolves to `true` if limits are reached, `false` otherwise
+ * @throws Error if the API call fails
+ *
+ * @example
+ * ```typescript
+ * import { checkLimits } from '@grafana/assistant';
+ *
+ * const data = await checkLimits();
+ * if (data.isLimitReached) {
+ *   console.log('Monthly limit reached');
+ * }
+ * ```
+ */
+export declare function checkLimits(): Promise<LimitsData>;
+/**
+ * React hook to check user prompt limits.
+ * Automatically fetches limits data on mount and listens to real-time updates
+ * via the LIMITS_UPDATED_EVENT custom event.
+ *
+ * @returns An object containing limit data, loading state, error state, and refetch function
+ *
+ * @example
+ * ```typescript
+ * import { useLimits } from '@grafana/assistant';
+ *
+ * function MyComponent() {
+ *   const { count, limit, isLimitReached, loading, error, refetch } = useLimits();
+ *
+ *   if (loading) return <div>Loading...</div>;
+ *   if (error) return <div>Error: {error}</div>;
+ *   if (isLimitReached) return <div>Monthly limit reached ({count}/{limit})</div>;
+ *   return <div>Prompts used: {count}/{limit || 'unlimited'}</div>;
+ * }
+ * ```
+ */
+export declare function useLimits(): {
+    count: number;
+    limit: number;
+    month: string;
+    isLimitReached: boolean;
+    loading: boolean;
+    error: string | null;
+    refetch: () => Promise<void>;
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/limits/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/limits/index.ts"],"names":[],"mappings":"AAKA;;;GAGG;AACH,eAAO,MAAM,oBAAoB,qCAAqC,CAAC;AAEvE;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,yCAAyC;IACzC,KAAK,EAAE,MAAM,CAAC;IACd,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAC;IACd,sCAAsC;IACtC,KAAK,EAAE,MAAM,CAAC;IACd,yCAAyC;IACzC,cAAc,EAAE,OAAO,CAAC;CACzB;AAiCD;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,WAAW,IAAI,OAAO,CAAC,UAAU,CAAC,CAMvD;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,SAAS;;;;;;;;EA8DxB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/assistant",
-  "version": "0.1.10",
+  "version": "0.1.11",
   "description": "Type definitions and helper functions for Grafana Assistant",
   "repository": {
     "type": "git",