@foxglove/extension 2.28.0 → 2.29.0

package/package.json

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

package/src/experimental.ts

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-namespace */
 
-import { ExtensionContext as BaseExtensionContext } from "./stable";
+import type { ExtensionContext as BaseExtensionContext } from "./stable";
 
 /**
  * The experimental namespace contains experimental APIs that are not yet stable and WILL change or
@@ -13,9 +13,41 @@ import { ExtensionContext as BaseExtensionContext } from "./stable";
  * @hidden
  */
 export namespace Experimental {
-  // eslint-disable-next-line @typescript-eslint/no-empty-object-type
+  /**
+   * This type represents the arguments you pass to {@link ExtensionContext.registerDataLoader}
+   * when you want to register a data loader.
+   *
+   * @category Data loaders
+   */
+  export type RegisterLocalFileDataLoaderArgs = {
+    /** The type of data loader. Must be "file" for local file data loaders. */
+    type: "file";
+    /** The URL to the WebAssembly module for this data loader. */
+    wasmUrl: string;
+    /** The file extension that this data loader should be associated with. */
+    supportedFileType: FileExtension;
+  };
+
+  /**
+   * Arguments for registering a custom data loader. Currently, only local file data loaders are
+   * supported.
+   *
+   * See: {@link RegisterLocalFileDataLoaderArgs}
+   *
+   * @category Data loaders
+   */
+  export type RegisterDataLoaderArgs = RegisterLocalFileDataLoaderArgs;
+
   export interface ExtensionContext extends BaseExtensionContext {
-    // no-op until we have experimental APIs
+    /**
+     * Register a data loader to add support for additional file formats.
+     *
+     * A data loader teaches Foxglove how to read new file formats. The data loader is a WASM layer
+     * that bridges the semantics of the custom file format to Foxglove.
+     *
+     * See: {@link RegisterDataLoaderArgs}
+     */
+    registerDataLoader(args: RegisterDataLoaderArgs): void;
   }
 
   export interface ExtensionModule {