@grafana/assistant 0.0.1-alpha.2

package/README.md

@@ -0,0 +1,119 @@
+# @grafana/assistant
+
+Type definitions for Grafana Assistant functions and dashboard operations.
+
+## Installation
+
+```bash
+npm install @grafana/assistant
+```
+
+## Usage
+
+```typescript
+import type { AddCallbackFunction, FunctionImplementation, DashboardOperations } from '@grafana/assistant';
+
+// Use the type to define your assistant function handler
+const registerFunction: AddCallbackFunction = (pluginId, namespace, functionName, functionImpl) => {
+  // Your implementation here
+};
+
+// Example function implementation
+const myFunction: FunctionImplementation = (param1, param2) => {
+  return `Result: ${param1} + ${param2}`;
+};
+```
+
+## Types
+
+### AddCallbackFunction
+
+A function signature for registering assistant functions.
+
+```typescript
+type AddCallbackFunction = (pluginId: string, namespace: string, functionName: string, functionImpl: FunctionImplementation) => void;
+```
+
+**Parameters:**
+- `pluginId: string` - The plugin ID of the function
+- `namespace: string` - The namespace for the function
+- `functionName: string` - The name of the function  
+- `functionImpl: FunctionImplementation` - The implementation of the function
+
+### FunctionImplementation
+
+A type for function implementations that can be registered with the assistant.
+
+```typescript
+type FunctionImplementation = (...args: any[]) => any;
+```
+
+### DashboardOperations
+
+Operations available for dashboard manipulation.
+
+```typescript
+type DashboardOperations = {
+  addPanel: (vizPanel: VizPanel) => void;
+  duplicatePanel: (vizPanel: VizPanel) => void;
+  copyPanel: (vizPanel: VizPanel) => void;
+  pastePanel: () => void;
+  removePanel: (panel: VizPanel) => void;
+  createNewPanel: () => void;
+  createNewRow: () => void;
+  onEnterEditMode: () => void;
+  openSaveDrawer: (options?: SaveDrawerOptions) => void;
+  onStarDashboard: () => void;
+  canEditDashboard: () => boolean;
+  exitEditMode: (options: ExitEditModeOptions) => void;
+};
+```
+
+## Example: Registering Dashboard Operations
+
+Here's how Grafana core would register all dashboard operations:
+
+```typescript
+Object.keys(DashboardOperations).forEach((actionName) => {
+  const action = DashboardOperations[actionName as keyof typeof DashboardOperations];
+  addCallbackFunction.fn('grafana', 'dashboarding', actionName, action);
+});
+```
+
+This example shows how to:
+1. Iterate through all available dashboard operations
+2. Extract each operation function
+3. Register it with the assistant using the 'dashboarding' namespace
+
+## Example: Using Registered Functions
+
+Once functions are registered, they can be retrieved and used from the function registry:
+
+```typescript
+import { functionRegistry } from './functions/registry';
+import type { DashboardOperations } from '@grafana/assistant';
+
+// Retrieve a specific function from the registry
+const onEnterEditMode = functionRegistry.getFunction<DashboardOperations['onEnterEditMode']>(
+  'grafana',
+  'dashboarding',
+  'onEnterEditMode'
+);
+
+if (!onEnterEditMode) {
+  throw new Error('onEnterEditMode function not found');
+}
+
+// Use the retrieved function
+onEnterEditMode();
+```
+
+This example demonstrates:
+1. Using `functionRegistry.getFunction()` to retrieve registered functions by plugin ID, namespace, and function name
+2. Type-safe function retrieval using TypeScript generics
+3. Null checking before using the function
+4. Calling the retrieved function
+
+## License
+
+Apache-2.0

package/dist/dashboarding.d.ts

@@ -0,0 +1,23 @@
+import { VizPanel } from '@grafana/scenes';
+export type SaveDrawerOptions = {
+    saveAsCopy?: boolean;
+    onSaveSuccess?: () => void;
+};
+export type ExitEditModeOptions = {
+    skipConfirm: boolean;
+    restoreInitialState?: boolean;
+};
+export type DashboardOperations = {
+    addPanel: (vizPanel: VizPanel) => void;
+    duplicatePanel: (vizPanel: VizPanel) => void;
+    copyPanel: (vizPanel: VizPanel) => void;
+    pastePanel: () => void;
+    removePanel: (panel: VizPanel) => void;
+    createNewPanel: () => void;
+    createNewRow: () => void;
+    onEnterEditMode: () => void;
+    openSaveDrawer: (options?: SaveDrawerOptions) => void;
+    onStarDashboard: () => void;
+    canEditDashboard: () => boolean;
+    exitEditMode: (options: ExitEditModeOptions) => void;
+};

package/dist/dashboarding.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=dashboarding.js.map

package/dist/dashboarding.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dashboarding.js","sourceRoot":"","sources":["../src/dashboarding.ts"],"names":[],"mappings":""}

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+export type FunctionImplementation = (...args: any[]) => any;
+/**
+ * Function signature for registering Assistant functions. These functions
+ * support the tools offered by the Assistant.
+ *
+ * @param pluginId - The plugin ID of the function
+ * @param namespace - The namespace for the function
+ * @param functionName - The name of the function
+ * @param functionImpl - The implementation of the function
+ */
+export type AddCallbackFunction = (pluginId: string, namespace: string, functionName: string, functionImpl: FunctionImplementation) => void;
+export * from './dashboarding';

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from './dashboarding';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAkBA,cAAc,gBAAgB,CAAC"}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@grafana/assistant",
+  "version": "0.0.1-alpha.2",
+  "description": "Type definitions for Grafana Assistant functions",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "prebuild": "rm -rf dist",
+    "build": "tsc",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "npm run clean && npm run build"
+  },
+  "keywords": [
+    "grafana",
+    "assistant",
+    "types",
+    "typescript"
+  ],
+  "author": "Grafana Labs",
+  "license": "Apache-2.0",
+  "devDependencies": {
+    "typescript": "^5.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "@grafana/scenes": ">=5.41.0"
+  }
+}