@foxglove/extension 2.37.0 → 2.38.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@foxglove/extension",
-  "version": "2.37.0",
+  "version": "2.38.0",
   "license": "MIT",
   "author": {
     "name": "Foxglove Technologies",

package/src/experimental.ts

@@ -72,6 +72,14 @@ export namespace Experimental {
     initPanel: (context: PanelExtensionContext) => void | (() => void);
   };
 
+  /**
+   * See: {@link ExtensionContext.registerUserScriptUtility}
+   */
+  export type RegisterUserScriptUtilityArgs = {
+    name: `${string}.ts`;
+    source: string;
+  };
+
   export interface ExtensionContext extends BaseExtensionContext {
     /**
      * Register a data loader to add support for additional file formats.
@@ -99,6 +107,44 @@ export namespace Experimental {
      * optional cleanup function to run when the extension `panelElement` unmounts.
      */
     registerPanel(params: ExtensionPanelRegistration): void;
+
+    /**
+     * Register a new user-script utility.
+     *
+     * This utility is available to all user-scripts and imported by its name.
+     *
+     * Example registration:
+     *
+     * ```
+     * registerUserScriptUtility({
+     *   name: "my_add.ts",
+     *   source: `
+     * export function add(a: number, b: number) {
+     *  return a + b;
+     * }
+     * `);
+     * ```
+     *
+     * You can also keep the source code in a file and import it like this:
+     *
+     * ```
+     * import my_add from "./my_add.ts?raw";
+     *
+     * registerUserScriptUtility({ name: "my_add.ts", source: my_add });
+     * ```
+     *
+     * Example usage in a user-script:
+     *
+     * ```
+     * import { add } from "./my_add.ts";
+     *
+     * // ... call `add` in your script function or wherever needed
+     * ```
+     *
+     * @param name
+     * @param source
+     */
+    registerUserScriptUtility(args: RegisterUserScriptUtilityArgs): void;
   }
 
   export interface ExtensionModule {