@ecopages/core 0.2.0-alpha.7 → 0.2.0-alpha.9

package/src/services/invalidation/development-invalidation.service.js

@@ -0,0 +1,189 @@
+import path from "node:path";
+import { getAppServerInvalidationState } from "../runtime-state/server-invalidation-state.service.js";
+class DevelopmentInvalidationService {
+  appConfig;
+  constructor(appConfig) {
+    this.appConfig = appConfig;
+  }
+  /**
+   * Returns the current app-owned server-module invalidation version.
+   */
+  getServerModuleInvalidationVersion() {
+    return getAppServerInvalidationState(this.appConfig).getServerInvalidationVersion();
+  }
+  /**
+   * Invalidates the app-owned server-module graph.
+   */
+  invalidateServerModules(changedFiles) {
+    getAppServerInvalidationState(this.appConfig).invalidateServerModules(changedFiles);
+  }
+  /**
+   * Resets runtime-owned graph state and invalidates server modules.
+   */
+  resetRuntimeState(changedFiles) {
+    const serverInvalidationState = getAppServerInvalidationState(this.appConfig);
+    serverInvalidationState.invalidateServerModules(changedFiles);
+    serverInvalidationState.reset();
+  }
+  /**
+   * Classifies one changed file into an explicit framework invalidation plan.
+   */
+  planFileChange(filePath) {
+    if (this.isPublicDirFile(filePath)) {
+      return {
+        category: "public-asset",
+        invalidateServerModules: false,
+        refreshRoutes: false,
+        reloadBrowser: true,
+        delegateToHmr: false,
+        processorHandledAsset: false
+      };
+    }
+    if (this.matchesAdditionalWatchPaths(filePath)) {
+      return {
+        category: "additional-watch",
+        invalidateServerModules: false,
+        refreshRoutes: false,
+        reloadBrowser: true,
+        delegateToHmr: false,
+        processorHandledAsset: false
+      };
+    }
+    if (this.isIncludeSourceFile(filePath)) {
+      return {
+        category: "include-source",
+        invalidateServerModules: true,
+        refreshRoutes: false,
+        reloadBrowser: true,
+        delegateToHmr: false,
+        processorHandledAsset: false
+      };
+    }
+    if (this.isRouteSourceFile(filePath)) {
+      return {
+        category: "route-source",
+        invalidateServerModules: true,
+        refreshRoutes: true,
+        reloadBrowser: false,
+        delegateToHmr: true,
+        processorHandledAsset: false
+      };
+    }
+    if (this.isProcessorOwnedAsset(filePath)) {
+      return {
+        category: "processor-owned-asset",
+        invalidateServerModules: false,
+        refreshRoutes: false,
+        reloadBrowser: false,
+        delegateToHmr: false,
+        processorHandledAsset: true
+      };
+    }
+    if (this.isServerModuleSourceFile(filePath)) {
+      return {
+        category: "server-source",
+        invalidateServerModules: true,
+        refreshRoutes: false,
+        reloadBrowser: false,
+        delegateToHmr: true,
+        processorHandledAsset: false
+      };
+    }
+    return {
+      category: "other",
+      invalidateServerModules: false,
+      refreshRoutes: false,
+      reloadBrowser: false,
+      delegateToHmr: true,
+      processorHandledAsset: false
+    };
+  }
+  /**
+   * Returns whether the file lives under the public directory.
+   */
+  isPublicDirFile(filePath) {
+    return path.resolve(filePath).startsWith(this.appConfig.absolutePaths.publicDir);
+  }
+  /**
+   * Returns whether the file matches `additionalWatchPaths`.
+   */
+  matchesAdditionalWatchPaths(filePath) {
+    const normalizedPath = path.resolve(filePath);
+    const patterns = this.appConfig.additionalWatchPaths;
+    if (!patterns.length) return false;
+    for (const pattern of patterns) {
+      if (pattern.includes("*")) {
+        const ext = pattern.replace(/\*\*?\/\*/, "");
+        if (normalizedPath.endsWith(ext)) return true;
+      } else if (normalizedPath.endsWith(pattern) || normalizedPath === path.resolve(pattern)) {
+        return true;
+      }
+    }
+    return false;
+  }
+  /**
+   * Returns whether the file is a route source file.
+   */
+  isRouteSourceFile(filePath) {
+    const resolvedPath = path.resolve(filePath);
+    if (!resolvedPath.startsWith(this.appConfig.absolutePaths.pagesDir)) {
+      return false;
+    }
+    if (this.appConfig.templatesExt.some((extension) => resolvedPath.endsWith(extension))) {
+      return true;
+    }
+    return /\.(?:[cm]?ts|[jt]sx?|mdx)$/u.test(resolvedPath);
+  }
+  /**
+   * Returns whether the file is an include/template source file.
+   */
+  isIncludeSourceFile(filePath) {
+    const resolvedPath = path.resolve(filePath);
+    if (!resolvedPath.startsWith(this.appConfig.absolutePaths.includesDir)) {
+      return false;
+    }
+    if (this.appConfig.templatesExt.some((extension) => resolvedPath.endsWith(extension))) {
+      return true;
+    }
+    return /\.(?:[cm]?ts|[jt]sx?|mdx)$/u.test(resolvedPath);
+  }
+  /**
+   * Returns whether the file is a server-executed source module outside the
+   * special route/include buckets.
+   */
+  isServerModuleSourceFile(filePath) {
+    const resolvedPath = path.resolve(filePath);
+    if (!resolvedPath.startsWith(this.appConfig.absolutePaths.srcDir)) {
+      return false;
+    }
+    if (this.appConfig.templatesExt.some((extension) => resolvedPath.endsWith(extension))) {
+      return true;
+    }
+    return /\.(?:[cm]?ts|[jt]sx?|mdx)$/u.test(resolvedPath);
+  }
+  /**
+   * Returns whether a processor owns the changed file as an asset input.
+   */
+  isProcessorOwnedAsset(filePath) {
+    for (const processor of this.appConfig.processors.values()) {
+      const capabilities = processor.getAssetCapabilities?.() ?? [];
+      if (capabilities.length > 0) {
+        const matchesConfiguredAsset = typeof processor.matchesFileFilter !== "function" || processor.matchesFileFilter(filePath);
+        if (matchesConfiguredAsset && capabilities.some((capability) => processor.canProcessAsset?.(capability.kind, filePath))) {
+          return true;
+        }
+        continue;
+      }
+      const watchConfig = processor.getWatchConfig();
+      if (!watchConfig) continue;
+      const { extensions = [] } = watchConfig;
+      if (extensions.length && extensions.some((ext) => filePath.endsWith(ext))) {
+        return true;
+      }
+    }
+    return false;
+  }
+}
+export {
+  DevelopmentInvalidationService
+};

package/src/services/module-loading/app-server-module-transpiler.service.d.ts

@@ -0,0 +1,16 @@
+import type { EcoPagesAppConfig } from '../../internal-types.js';
+import { ServerModuleTranspiler } from './server-module-transpiler.service.js';
+/**
+ * Creates the shared app-scoped server-module transpiler for one runtime
+ * instance.
+ */
+export declare function createAppServerModuleTranspiler(appConfig: EcoPagesAppConfig): ServerModuleTranspiler;
+/**
+ * Returns the app-owned server-module transpiler, creating it lazily when the
+ * runtime first needs one.
+ */
+export declare function getAppServerModuleTranspiler(appConfig: EcoPagesAppConfig): ServerModuleTranspiler;
+/**
+ * Installs the server-module transpiler that should serve one app instance.
+ */
+export declare function setAppServerModuleTranspiler(appConfig: EcoPagesAppConfig, serverModuleTranspiler: ServerModuleTranspiler): void;

package/src/services/module-loading/app-server-module-transpiler.service.js

@@ -0,0 +1,34 @@
+import { getAppBuildExecutor } from "../../build/build-adapter.js";
+import { createAppNodeBootstrapPlugin } from "../../adapters/node/bootstrap-dependency-resolver.js";
+import { DevelopmentInvalidationService } from "../invalidation/development-invalidation.service.js";
+import { ServerModuleTranspiler } from "./server-module-transpiler.service.js";
+function createAppServerModuleTranspiler(appConfig) {
+  const invalidationService = new DevelopmentInvalidationService(appConfig);
+  return new ServerModuleTranspiler({
+    rootDir: appConfig.rootDir,
+    getBuildExecutor: () => getAppBuildExecutor(appConfig),
+    getInvalidationVersion: () => invalidationService.getServerModuleInvalidationVersion(),
+    invalidateModules: (changedFiles) => invalidationService.invalidateServerModules(changedFiles),
+    getDefaultPlugins: typeof Bun === "undefined" && appConfig.rootDir ? () => [createAppNodeBootstrapPlugin(appConfig)] : void 0
+  });
+}
+function getAppServerModuleTranspiler(appConfig) {
+  const existingTranspiler = appConfig.runtime?.serverModuleTranspiler;
+  if (existingTranspiler) {
+    return existingTranspiler;
+  }
+  const serverModuleTranspiler = createAppServerModuleTranspiler(appConfig);
+  setAppServerModuleTranspiler(appConfig, serverModuleTranspiler);
+  return serverModuleTranspiler;
+}
+function setAppServerModuleTranspiler(appConfig, serverModuleTranspiler) {
+  appConfig.runtime = {
+    ...appConfig.runtime ?? {},
+    serverModuleTranspiler
+  };
+}
+export {
+  createAppServerModuleTranspiler,
+  getAppServerModuleTranspiler,
+  setAppServerModuleTranspiler
+};

package/src/services/module-loading/page-module-import.service.d.ts

@@ -0,0 +1,71 @@
+import { build, type BuildExecutor, type BuildResult } from '../../build/build-adapter.js';
+import type { EcoBuildPlugin } from '../../build/build-types.js';
+export interface PageModuleImportOptions {
+    filePath: string;
+    rootDir: string;
+    outdir: string;
+    buildExecutor?: BuildExecutor;
+    invalidationVersion?: number;
+    splitting?: boolean;
+    externalPackages?: boolean;
+    plugins?: EcoBuildPlugin[];
+    transpileErrorMessage?: (details: string) => string;
+    noOutputMessage?: (filePath: string) => string;
+}
+/**
+ * Minimal runtime dependencies required to load page modules.
+ *
+ * @remarks
+ * This service owns cache and runtime import policy. Hashing and build
+ * execution are injected so tests can provide explicit fakes without module
+ * interception.
+ */
+export interface PageModuleImportDependencies {
+    hashFile(filePath: string): string;
+    buildModule(options: Parameters<typeof build>[0], buildExecutor?: BuildExecutor): Promise<BuildResult>;
+}
+/**
+ * Loads source page modules in a runtime-agnostic way.
+ *
+ * This service centralizes the Bun-vs-Node import strategy used by route
+ * scanning, page data loading, and request-time page inspection. In Bun it can
+ * import source files directly; in Node it transpiles the file into a dedicated
+ * output directory first and then imports the generated module.
+ *
+ * Keeping this logic in one place prevents subtle drift in cache-busting,
+ * transpilation settings, and error semantics across the different callers.
+ */
+export declare class PageModuleImportService {
+    private readonly dependencies;
+    private readonly importCache;
+    private developmentInvalidationVersion;
+    constructor(dependencies?: Partial<PageModuleImportDependencies>);
+    /**
+     * Clears the shared import cache used by framework-owned page-module loads.
+     */
+    clearImportCache(): void;
+    /**
+     * Invalidates all previously imported modules in development by clearing the
+     * import cache and incrementing the invalidation version included in cache keys.
+     *
+     * This forces all modules to be reloaded on the next import, even if their
+     * source content hasn't changed. This is necessary to ensure that changes to
+     * non-content aspects of modules (e.g. dependencies, transpilation output)
+     * are picked up during development.
+     */
+    invalidateDevelopmentGraph(): void;
+    /**
+     * Imports a page-like module from source.
+     *
+     * The caller controls the output directory and error wording so different
+     * subsystems can reuse the same loading mechanism while preserving their
+     * current diagnostics. Module identities stay stable for unchanged files and
+     * roll forward automatically when the source hash changes during watch mode.
+     *
+     * @typeParam T Expected module shape.
+     * @param options Runtime-specific import settings.
+     * @returns The loaded module.
+     */
+    importModule<T = unknown>(options: PageModuleImportOptions): Promise<T>;
+    private loadModule;
+}

package/src/services/module-loading/page-module-import.service.js

@@ -0,0 +1,132 @@
+import path from "node:path";
+import { pathToFileURL } from "node:url";
+import { fileSystem } from "@ecopages/file-system";
+import { build } from "../../build/build-adapter.js";
+class PageModuleImportService {
+  dependencies;
+  importCache = /* @__PURE__ */ new Map();
+  developmentInvalidationVersion = 0;
+  constructor(dependencies) {
+    this.dependencies = {
+      hashFile: dependencies?.hashFile ?? ((filePath) => fileSystem.hash(filePath)),
+      buildModule: dependencies?.buildModule ?? ((options, buildExecutor) => build(options, buildExecutor))
+    };
+  }
+  /**
+   * Clears the shared import cache used by framework-owned page-module loads.
+   */
+  clearImportCache() {
+    this.importCache.clear();
+  }
+  /**
+   * Invalidates all previously imported modules in development by clearing the
+   * import cache and incrementing the invalidation version included in cache keys.
+   *
+   * This forces all modules to be reloaded on the next import, even if their
+   * source content hasn't changed. This is necessary to ensure that changes to
+   * non-content aspects of modules (e.g. dependencies, transpilation output)
+   * are picked up during development.
+   */
+  invalidateDevelopmentGraph() {
+    this.clearImportCache();
+    this.developmentInvalidationVersion += 1;
+  }
+  /**
+   * Imports a page-like module from source.
+   *
+   * The caller controls the output directory and error wording so different
+   * subsystems can reuse the same loading mechanism while preserving their
+   * current diagnostics. Module identities stay stable for unchanged files and
+   * roll forward automatically when the source hash changes during watch mode.
+   *
+   * @typeParam T Expected module shape.
+   * @param options Runtime-specific import settings.
+   * @returns The loaded module.
+   */
+  async importModule(options) {
+    const { filePath, rootDir, externalPackages, splitting } = options;
+    const invalidationVersion = options.invalidationVersion ?? this.developmentInvalidationVersion;
+    const fileHash = this.dependencies.hashFile(filePath);
+    const runtime = typeof Bun !== "undefined" ? "bun" : "node";
+    const cacheKey = [
+      runtime,
+      filePath,
+      rootDir,
+      splitting ?? "default",
+      externalPackages ?? "default",
+      fileHash,
+      invalidationVersion
+    ].join("::");
+    const cachedModule = this.importCache.get(cacheKey);
+    if (cachedModule) {
+      return await cachedModule;
+    }
+    const importPromise = this.loadModule({
+      ...options,
+      fileHash
+    });
+    this.importCache.set(cacheKey, importPromise);
+    try {
+      return await importPromise;
+    } catch (error) {
+      this.importCache.delete(cacheKey);
+      throw error;
+    }
+  }
+  async loadModule(options) {
+    const {
+      filePath,
+      rootDir,
+      outdir,
+      invalidationVersion = this.developmentInvalidationVersion,
+      splitting,
+      externalPackages,
+      transpileErrorMessage = (details) => `Error transpiling page module: ${details}`,
+      noOutputMessage = (targetFilePath) => `No transpiled output generated for page module: ${targetFilePath}`,
+      fileHash
+    } = options;
+    if (typeof Bun !== "undefined") {
+      const moduleUrl = pathToFileURL(filePath);
+      if (process.env.NODE_ENV === "development") {
+        moduleUrl.searchParams.set("update", `${fileHash}-${invalidationVersion}`);
+      }
+      return await import(moduleUrl.href);
+    }
+    const fileBaseName = path.basename(filePath, path.extname(filePath));
+    const outputFileName = `${fileBaseName}-${fileHash}.js`;
+    const buildResult = await this.dependencies.buildModule(
+      {
+        entrypoints: [filePath],
+        root: rootDir,
+        outdir,
+        target: "node",
+        format: "esm",
+        sourcemap: "none",
+        splitting: splitting ?? true,
+        minify: false,
+        naming: outputFileName,
+        externalPackages: true,
+        plugins: options.plugins,
+        ...externalPackages !== void 0 ? { externalPackages } : {}
+      },
+      options.buildExecutor
+    );
+    if (!buildResult.success) {
+      const details = buildResult.logs.map((log) => log.message).join(" | ");
+      throw new Error(transpileErrorMessage(details));
+    }
+    const preferredOutputPath = path.join(outdir, outputFileName);
+    const compiledOutput = buildResult.outputs.find((output) => output.path === preferredOutputPath)?.path ?? buildResult.outputs.find((output) => output.path.endsWith(".js"))?.path;
+    if (!compiledOutput) {
+      throw new Error(noOutputMessage(filePath));
+    }
+    const compiledOutputUrl = pathToFileURL(compiledOutput);
+    if (process.env.NODE_ENV === "development") {
+      compiledOutputUrl.searchParams.set("update", `${fileHash}-${invalidationVersion}`);
+    }
+    return await import(compiledOutputUrl.href);
+  }
+}
+export {
+  PageModuleImportService
+};

package/src/services/module-loading/server-loader.service.d.ts

@@ -0,0 +1,96 @@
+import type { EcoBuildPlugin } from '../../build/build-types.js';
+import { type ServerModuleTranspilerBootstrapArgs, type ServerModuleTranspilerOptions } from './server-module-transpiler.service.js';
+/**
+ * High-level module-loading options owned by the framework loader boundary.
+ *
+ * @remarks
+ * These are the same shape the lower-level transpiler needs, minus the
+ * root/build-executor ownership that the loader keeps internally.
+ */
+export interface ServerLoaderModuleOptions extends ServerModuleTranspilerOptions {
+    plugins?: EcoBuildPlugin[];
+}
+/**
+ * Mutable app-phase server-loading context.
+ *
+ * @remarks
+ * The loader starts with bootstrap config-loading context. Once a real built
+ * app config is available, the runtime adapter rebinds the loader so app-entry
+ * and downstream server modules load through the app-owned executor.
+ */
+export interface ServerLoaderAppContext extends ServerModuleTranspilerBootstrapArgs {
+}
+/**
+ * Minimal transpiler dependency required by the server loader.
+ *
+ * @remarks
+ * The loader owns orchestration between bootstrap and app phases, so tests only
+ * need this narrow import/invalidate/dispose surface rather than the concrete
+ * transpiler class.
+ */
+export interface ServerLoaderTranspilerDependency {
+    importModule<T = unknown>(options: ServerLoaderModuleOptions): Promise<T>;
+    invalidate(changedFiles?: string[]): void;
+    dispose(): Promise<void>;
+}
+/**
+ * Factory dependency used by the loader to create phase-specific transpilers.
+ */
+export interface ServerLoaderDependencyFactory {
+    createTranspiler(context: ServerModuleTranspilerBootstrapArgs): ServerLoaderTranspilerDependency;
+}
+/**
+ * Framework-owned server loading boundary.
+ *
+ * @remarks
+ * This abstraction owns config loading, app-entry loading, and cache lifecycle
+ * for the Node thin-host runtime path. Hosts and runtime adapters should depend
+ * on this boundary rather than coordinating raw transpiler instances directly.
+ */
+export interface ServerLoader {
+    /**
+     * Loads the bootstrap config module through the bootstrap server-loading
+     * context.
+     */
+    loadConfig<T = unknown>(options: ServerLoaderModuleOptions): Promise<T>;
+    /**
+     * Loads the app entry module through the currently active app context.
+     *
+     * @remarks
+     * Until app context is rebound, this falls back to the bootstrap context so a
+     * caller can still load through one boundary during early bootstrap.
+     */
+    loadApp<T = unknown>(options: ServerLoaderModuleOptions): Promise<T>;
+    /**
+     * Rebinds the app-phase loading context after a real app config has been
+     * loaded and app-owned build services are available.
+     */
+    rebindAppContext(context: ServerLoaderAppContext): void;
+    /**
+     * Invalidates cached server module state for development reloads.
+     */
+    invalidate(changedFiles?: string[]): void;
+    /**
+     * Releases loader-owned resources.
+     */
+    dispose(): Promise<void>;
+}
+/**
+ * `ServerLoader` implementation backed by `ServerModuleTranspiler` instances.
+ *
+ * @remarks
+ * This is the first named loader abstraction for Workstream 3. It keeps the
+ * lower-level transpiler as the implementation detail while moving ownership of
+ * config/app entry orchestration into one service boundary.
+ */
+export declare class TranspilerServerLoader implements ServerLoader {
+    private readonly createTranspiler;
+    private readonly configTranspiler;
+    private appTranspiler;
+    constructor(configContext: ServerModuleTranspilerBootstrapArgs, dependencies?: ServerLoaderDependencyFactory);
+    loadConfig<T = unknown>(options: ServerLoaderModuleOptions): Promise<T>;
+    loadApp<T = unknown>(options: ServerLoaderModuleOptions): Promise<T>;
+    rebindAppContext(context: ServerLoaderAppContext): void;
+    invalidate(changedFiles?: string[]): void;
+    dispose(): Promise<void>;
+}

package/src/services/module-loading/server-loader.service.js

@@ -0,0 +1,32 @@
+import {
+  ServerModuleTranspiler
+} from "./server-module-transpiler.service.js";
+class TranspilerServerLoader {
+  createTranspiler;
+  configTranspiler;
+  appTranspiler = null;
+  constructor(configContext, dependencies) {
+    this.createTranspiler = dependencies?.createTranspiler ?? ((context) => new ServerModuleTranspiler(context));
+    this.configTranspiler = this.createTranspiler(configContext);
+  }
+  async loadConfig(options) {
+    return await this.configTranspiler.importModule(options);
+  }
+  async loadApp(options) {
+    return await (this.appTranspiler ?? this.configTranspiler).importModule(options);
+  }
+  rebindAppContext(context) {
+    this.appTranspiler = this.createTranspiler(context);
+  }
+  invalidate(changedFiles) {
+    this.configTranspiler.invalidate(changedFiles);
+    this.appTranspiler?.invalidate(changedFiles);
+  }
+  async dispose() {
+    await this.appTranspiler?.dispose();
+    await this.configTranspiler.dispose();
+  }
+}
+export {
+  TranspilerServerLoader
+};

package/src/services/module-loading/server-module-transpiler.service.d.ts

@@ -0,0 +1,69 @@
+import type { BuildExecutor } from '../../build/build-adapter.js';
+import type { EcoBuildPlugin } from '../../build/build-types.js';
+import { type PageModuleImportOptions } from './page-module-import.service.js';
+export type ServerModuleTranspilerOptions = Omit<PageModuleImportOptions, 'rootDir' | 'buildExecutor'>;
+/**
+ * Minimal import-service dependency required by the server module transpiler.
+ *
+ * @remarks
+ * This keeps the transpiler boundary testable without module-level mocking and
+ * lets callers provide an app-owned import implementation when needed.
+ */
+export interface ServerModuleImportDependency {
+    importModule<T = unknown>(options: PageModuleImportOptions): Promise<T>;
+    invalidateDevelopmentGraph(): void;
+}
+/**
+ * Immutable execution context for one server-transpiler instance.
+ *
+ * @remarks
+ * Callers own when and why a new transpiler is created. This service only owns
+ * applying the supplied root/build-executor pair consistently to every module
+ * load that passes through it.
+ */
+export type ServerModuleTranspilerBootstrapArgs = {
+    rootDir: string;
+    getBuildExecutor: () => BuildExecutor | undefined;
+    getInvalidationVersion?: () => number;
+    invalidateModules?: (changedFiles?: string[]) => void;
+    pageModuleImportService?: ServerModuleImportDependency;
+    /** Factory evaluated on each importModule call to produce plugins applied to every load. */
+    getDefaultPlugins?: () => EcoBuildPlugin[];
+};
+/**
+ * App-owned boundary for server-side source module loading.
+ *
+ * @remarks
+ * This service centralizes server-side module transpilation and import behind
+ * an explicit caller-owned root and build executor.
+ */
+export declare class ServerModuleTranspiler {
+    private readonly pageModuleImportService;
+    private readonly getRootDir;
+    private readonly getBuildExecutor;
+    private readonly getInvalidationVersion;
+    private readonly invalidateModules;
+    private readonly getDefaultPlugins;
+    /**
+     * Creates one explicit server-transpiler boundary for a given execution
+     * context.
+     */
+    constructor(args: ServerModuleTranspilerBootstrapArgs);
+    /**
+     * Loads a server-side source module through the caller-owned transpile
+     * context.
+     */
+    importModule<T = unknown>(options: ServerModuleTranspilerOptions): Promise<T>;
+    /**
+     * Invalidates cached module state for development reloads.
+     */
+    invalidate(changedFiles?: string[]): void;
+    /**
+     * Releases transpiler-owned resources.
+     *
+     * @remarks
+     * The current implementation delegates cache ownership to lower-level module
+     * loading services, so disposal is intentionally a no-op for now.
+     */
+    dispose(): Promise<void>;
+}