@dxos/app-framework 0.8.4-main.8360d9e660 → 0.8.4-main.8baae0fced

package/src/core/edge-registry-plugin-provider.ts

@@ -0,0 +1,92 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Context } from '@dxos/context';
+import { type EdgeHttpClient } from '@dxos/edge-client';
+import { type PluginEntry } from '@dxos/protocols';
+
+import * as Registry from './registry';
+
+/**
+ * Maps a wire-format `PluginEntry` (from `@dxos/protocols`) to a
+ * `Registry.Plugin` (the app-framework domain type).
+ *
+ * This is the only translation seam between the two independently-defined type
+ * hierarchies — fields are mapped explicitly, with no shared type between them.
+ */
+const toRegistryPlugin = (entry: PluginEntry): Registry.Plugin => ({
+  id: entry.meta.id,
+  name: entry.meta.name,
+  description: entry.meta.description,
+  homePage: entry.meta.homePage,
+  source: entry.meta.source,
+  screenshots: entry.meta.screenshots ? [...entry.meta.screenshots] : undefined,
+  tags: entry.meta.tags ? [...entry.meta.tags] : undefined,
+  icon: entry.meta.icon,
+  iconHue: entry.meta.iconHue,
+  moduleUrl: entry.moduleUrl,
+  repo: entry.repo,
+  version: entry.releaseTag,
+});
+
+/**
+ * Implements `Registry.PluginProvider` against the Edge `/registry` HTTP endpoints.
+ *
+ * Lives in app-framework (rather than the more obvious home of `@dxos/edge-client`)
+ * because edge-client doesn't depend on app-framework; siting the implementation
+ * here keeps the dependency arrow `app-framework → edge-client` and avoids a
+ * cycle. The class needs only the public `EdgeHttpClient` type, so a one-way
+ * type-import is enough.
+ *
+ * `listVersions` is currently a stub: it returns the single latest version derived
+ * from the cached plugin list, so the host's version picker has something to render.
+ * The wire contract for the real endpoint already exists — see
+ * `GetPluginVersionsResponseBodySchema` in `@dxos/protocols/edge/registry` and
+ * {@link EdgeHttpClient.getRegistryPluginVersions} — so once Edge ships
+ * `GET /registry/plugins/:repo/versions`, swap this stub for a call to
+ * `this._client.getRegistryPluginVersions(...)` and map each entry through a
+ * `toRegistryPluginVersion` helper (mirror of {@link toRegistryPlugin}).
+ */
+export class EdgeRegistryPluginProvider implements Registry.PluginProvider {
+  // Cached on first load so getPlugin/listVersions can resolve without re-fetching.
+  #cachedPlugins: readonly Registry.Plugin[] = [];
+
+  constructor(private readonly _client: EdgeHttpClient) {}
+
+  listPlugins(): Effect.Effect<readonly Registry.Plugin[], Error> {
+    return Effect.tryPromise({
+      try: () => this._client.getRegistryPlugins(Context.default()),
+      catch: (error) => (error instanceof Error ? error : new Error(String(error))),
+    }).pipe(
+      Effect.map((body) => {
+        const plugins = body.plugins.filter((entry) => entry.health === 'ok').map(toRegistryPlugin);
+        this.#cachedPlugins = plugins;
+        return plugins;
+      }),
+    );
+  }
+
+  listVersions(repo: string): Effect.Effect<readonly Registry.PluginVersion[], Error> {
+    // Stub: return only the currently-known version until Edge implements the versions endpoint.
+    const plugin = this.#cachedPlugins.find((candidate) => candidate.repo === repo);
+    if (!plugin) {
+      return Effect.fail(new Error(`Plugin not found in catalog: ${repo}`));
+    }
+    const version: Registry.PluginVersion = { tag: plugin.version, moduleUrl: plugin.moduleUrl };
+    return Effect.succeed([version]);
+  }
+
+  getPlugin(repo: string, version?: string): Effect.Effect<Registry.Plugin, Error> {
+    const plugin = this.#cachedPlugins.find((p) => p.repo === repo);
+    if (!plugin) {
+      return Effect.fail(new Error(`Plugin not found in catalog: ${repo}`));
+    }
+    if (version && version !== plugin.version) {
+      return Effect.fail(new Error(`Version ${version} not available for ${repo}; only ${plugin.version} is cached`));
+    }
+    return Effect.succeed(plugin);
+  }
+}

package/src/core/index.ts

@@ -6,4 +6,10 @@ export * as ActivationEvent from './activation-event';
 export * as Capability from './capability';
 export * as CapabilityManager from './capability-manager';
 export * as Plugin from './plugin';
+export * as PluginAssetCache from './plugin-asset-cache';
 export * as PluginManager from './plugin-manager';
+export * as PluginManifest from './plugin-manifest';
+export { PLUGIN_DEV_SERVER_PORT } from './plugin-manifest';
+export * as Registry from './registry';
+export { EdgeRegistryPluginProvider } from './edge-registry-plugin-provider';
+export * as UrlLoader from './url-loader';

package/src/core/plugin-asset-cache.ts

@@ -0,0 +1,60 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { BaseError } from '@dxos/errors';
+
+/**
+ * Tagged error for cache operations. Construction sites supply `context.operation`
+ * (one of `'cache' | 'evict' | 'resolve' | 'list'`) and `context.pluginId` so
+ * downstream handlers can route on the failed call without scanning the message.
+ */
+export class PluginAssetCacheError extends BaseError.extend(
+  'PluginAssetCacheError',
+  'Plugin asset cache operation failed',
+) {}
+
+/**
+ * Per-platform offline cache for third-party plugin assets.
+ *
+ * Implementations live alongside their platform glue (composer-app's
+ * `asset-cache/{tauri,service-worker}.ts`); the no-op default is for tests
+ * and unsupported environments.
+ */
+export interface Cache {
+  /**
+   * Persist all listed URLs under the namespace of `pluginId`. Idempotent.
+   * The order of `urls` is significant — the first entry is treated as the entry module.
+   */
+  cache(pluginId: string, urls: readonly string[]): Effect.Effect<void, PluginAssetCacheError>;
+
+  /**
+   * Drop all assets for a plugin (uninstall).
+   */
+  evict(pluginId: string): Effect.Effect<void, PluginAssetCacheError>;
+
+  /**
+   * Resolves a plugin asset URL to a platform-specific cached URL when one is available.
+   * Returns the original URL when no cached copy exists or the platform serves cached
+   * responses transparently (e.g. service worker fetch interception on web).
+   */
+  resolve(pluginId: string, url: string): Effect.Effect<string, PluginAssetCacheError>;
+
+  /**
+   * List currently cached plugin ids (diagnostic).
+   */
+  list(): Effect.Effect<readonly string[], PluginAssetCacheError>;
+}
+
+/**
+ * No-op implementation. Used when no platform cache is registered (tests, unsupported environments).
+ * Plugins still load — they just have no offline guarantee.
+ */
+export const noop = (): Cache => ({
+  cache: () => Effect.void,
+  evict: () => Effect.void,
+  resolve: (_pluginId, url) => Effect.succeed(url),
+  list: () => Effect.succeed([] as readonly string[]),
+});