@dsh-plugin/dsh-loader 1.0.0 → 1.1.0-dev.32278873528

package/src/adapters/index.js

@@ -1,59 +0,0 @@
-// Adapter registration (design.md §7.4). Imports every host adapter and
-// registers it on the provided AdapterRegistry. Kept as a function so tests
-// can build a fresh registry per case.
-import * as dsh1x from './dsh-1-x.js';
-
-/** All host adapter factories, in registration order. */
-export const hostAdapters = [
-  { supports: dsh1x.supports, name: dsh1x.name, create: dsh1x.create },
-];
-
-/** Register every built-in host adapter onto a registry. */
-export function registerHostAdapters(registry) {
-  for (const factory of hostAdapters) registry.register(factory);
-  return registry;
-}
-
-// Client adapter metadata for dsh 1.x (consumed by src/client.js).
-//
-// packageAliases serves TWO roles:
-//   1. **Stable name → real name** (primary): plugins import from stable
-//      names like '@dshloader/ui-primitives' and the adapter maps them to
-//      the real dsh package name for this version. When dsh renames a
-//      package, only the adapter changes — plugin source and bundle stay
-//      the same.
-//   2. **Old real name → new real name** (fallback): if a plugin bundle
-//      was built before adopting stable names and still has
-//      `require('@deepseek-ai/dsh-client-ui-primitives')` baked in, the
-//      adapter can map the old real name to the new real name as a
-//      transition measure.
-export const clientAdapters = [
-  {
-    supports: dsh1x.supports,
-    name: dsh1x.name,
-    moduleAliases: {
-      // deep source import that breaks when dsh ships no `src/` (fix 1).
-      '@deepseek-ai/dsh-client-runtime/src/client/sessions/context-provenance.ts':
-        '@deepseek-ai/dsh-client-runtime/client',
-      // stable module name (design.md §3.3.3).
-      'dsh/runtime/context-provenance': '@deepseek-ai/dsh-client-runtime/client',
-    },
-    // Stable package names → real dsh package names for dsh 1.x.
-    // Plugins import from @dsh-plugin/dsh-loader/* subpaths (e.g.
-    // '@dsh-plugin/dsh-loader/ui-primitives'); the __ModuleLoader__
-    // wrapper (installed by installClient) maps them to the real dsh
-    // package before hitting the module table. When dsh renames a
-    // package, only this table changes — plugin source and bundle stay
-    // the same.
-    packageAliases: {
-      // Client UI component libraries
-      '@dsh-plugin/dsh-loader/ui-primitives': '@deepseek-ai/dsh-client-ui-primitives',
-      '@dsh-plugin/dsh-loader/ui-slots': '@deepseek-ai/dsh-client-ui-slots',
-      '@dsh-plugin/dsh-loader/web-react': '@deepseek-ai/dsh-client-web-react',
-      '@dsh-plugin/dsh-loader/schema-form': '@deepseek-ai/dsh-client-schema-form',
-      '@dsh-plugin/dsh-loader/ui-settings': '@deepseek-ai/dsh-client-ui-settings/client',
-      // Client runtime
-      '@dsh-plugin/dsh-loader/runtime': '@deepseek-ai/dsh-client-runtime/client',
-    },
-  },
-];

package/src/api.js

@@ -1,56 +0,0 @@
-// DshLoaderHostAPI construction (design.md §4.1 / §4.4).
-//
-// `createHostAPI` builds the `ctx.dshLoader` object exposed to other plugins.
-// Each capability (settings / web / services) is constructed from the active
-// adapter's overrides when present, otherwise from the default stable impl in
-// src/services/*.js. The adapter's `apply()` is invoked separately by the
-// bundle entry (src/index.js) so service aliases / bridge routes register via
-// cordis effects and auto-recycle on fiber unload (design.md §4.4).
-import { LOADER_VERSION } from './version.js';
-import { createSettingsAPI } from './services/settings.js';
-import { createWebAPI } from './services/web.js';
-import { createServicesAPI } from './services/services.js';
-import { installHostPackageAliases } from './adapters/dsh-1-x.js';
-
-/**
- * @param {{
- *   ctx: object,
- *   dshVersion: string,
- *   factory: { supports: string, name: string, create: Function },
- *   adapter?: object,
- *   exposeAllNamespaces?: boolean,
- *   whitelist?: Set<string>,
- *   hostPackageAliases?: Record<string, string>,
- * }} opts
- */
-export function createHostAPI({ ctx, dshVersion, factory, adapter, exposeAllNamespaces = false, whitelist, hostPackageAliases = {} }) {
-  const base = {
-    version: LOADER_VERSION,
-    dshVersion,
-    adapterVersion: factory.supports,
-  };
-
-  // Adapters may override any capability (design.md §4.4 HostAdapter.{settings,
-  // web, services}); otherwise the default stable impl is used.
-  const settings = adapter?.settings ?? createSettingsAPI({ ctx, exposeAllNamespaces, whitelist });
-  const web = adapter?.web ?? createWebAPI({ ctx });
-  const services = adapter?.services ?? createServicesAPI({ ctx });
-
-  // Runtime host package-name alias registration. The adapter's apply()
-  // installs the static set at boot; this method lets plugins add more
-  // aliases at runtime (e.g. for packages the adapter didn't know about).
-  const runtimeHostAliases = new Map(Object.entries(hostPackageAliases));
-  const registerPackageAlias = (oldName, newName) => {
-    runtimeHostAliases.set(oldName, newName);
-    // Re-install the hook with the updated map.
-    installHostPackageAliases(Object.fromEntries(runtimeHostAliases));
-  };
-
-  return {
-    ...base,
-    settings,
-    web,
-    services,
-    registerPackageAlias,
-  };
-}

package/src/client.js

@@ -1,330 +0,0 @@
-// dshloader client bundle entry (design.md §3.5 / §4.3 / §7.3).
-//
-// Loaded in the `immediately` prefetch tier (package.json `dsh.client`).
-// Responsibilities:
-//   1. Mount `window.__dshLoader__` with `require` / `registerModuleAlias` /
-//      `rpc.settings.*`.
-//   2. Register module-alias factories via `window.__ModuleLoader__.load` so
-//      deep source imports (fix 1) and stable module names resolve to the
-//      public runtime client entry.
-//   3. When `exposeAllNamespaces` is on, install a fetch interceptor that
-//      merges non-whitelisted namespaces into `/api/settings.describe` and
-//      routes non-whitelisted writes through the host bridge, echoing the
-//      request `rpcId` in the `{ type: 'server-response', rpcId, result }`
-//      envelope (fix 5, path 2 — mirrors dsh-upstream-fixes/lib/client.js).
-//
-// The module exports an `installClient` function for testability and runs an
-// IIFE at the bottom for the real browser bundle.
-import { LOADER_VERSION, LOG_PREFIX } from './version.js';
-import { clientAdapters } from './adapters/index.js';
-import { BRIDGE_PREFIX } from './adapters/dsh-1-x.js';
-
-export class ModuleNotFoundError extends Error {
-  constructor(specifier) {
-    super(`${LOG_PREFIX} module not found: ${specifier}`);
-    this.name = 'ModuleNotFoundError';
-    this.specifier = specifier;
-  }
-}
-
-/**
- * Pick the client adapter for the given dsh version. v1 ships a single
- * client adapter (dsh 1.x); when more are added, swap this for a semver-based
- * selection mirroring the host AdapterRegistry.
- */
-function pickClientAdapter(dshVersion) {
-  return clientAdapters[0];
-}
-
-/**
- * Build the `window.__dshLoader__` API object.
- * @param {{
- *   dshVersion?: string,
- *   adapterVersion?: string,
- *   moduleAliases?: Record<string,string>,
- *   requireImpl?: (spec: string) => any,
- *   fetchBridge?: { describe: () => Promise<any>, write: (mode:string, payload:object) => Promise<any> },
- *   clientCtx?: object,  // cordis client context (for services.get)
- * }} opts
- */
-export function createClientAPI(opts = {}) {
-  const aliases = new Map(Object.entries(opts.moduleAliases ?? {}));
-  const requireImpl = opts.requireImpl ?? ((spec) => {
-    throw new ModuleNotFoundError(spec);
-  });
-  const clientCtx = opts.clientCtx;
-  // Reuse the Map from installClient when provided so registerPackageAlias
-  // mutations are visible to the __ModuleLoader__ wrapper. Otherwise create
-  // a fresh Map from a plain object.
-  const packageAliases = opts.packageAliases instanceof Map
-    ? opts.packageAliases
-    : new Map(Object.entries(opts.packageAliases ?? {}));
-
-  const api = {
-    version: LOADER_VERSION,
-    dshVersion: opts.dshVersion,
-    adapterVersion: opts.adapterVersion,
-
-    require(specifier) {
-      if (typeof specifier !== 'string') throw new ModuleNotFoundError(String(specifier));
-      const target = aliases.get(specifier);
-      if (target === undefined) {
-        throw new ModuleNotFoundError(specifier);
-      }
-      return requireImpl(target);
-    },
-
-    registerModuleAlias(alias, target) {
-      aliases.set(alias, target);
-    },
-
-    /**
-     * Register a package-name alias for the client module loader's
-     * require(). When a plugin's bundle calls require('@old/pkg-name'),
-     * the loader's wrapped require remaps it to '@new/pkg-name' before
-     * hitting the module table. This lets dsh rename client packages
-     * across versions without forcing plugin bundles to rebuild.
-     */
-    registerPackageAlias(oldName, newName) {
-      packageAliases.set(oldName, newName);
-    },
-
-    /**
-     * Read a client-side cordis service by name.
-     * Proxies to `clientCtx.get(name)` — the same ctx.get plugins use
-     * inside their client `apply(ctx)`, but exposed through the stable
-     * dshloader surface so plugins don't depend on the cordis context
-     * shape directly.
-     *
-     * Only available when dshloader's client apply() received a ctx
-     * (cordis client boot). Returns undefined when ctx is not wired.
-     */
-    services: {
-      get(name) {
-        if (clientCtx === undefined || typeof clientCtx.get !== 'function') return undefined;
-        return clientCtx.get(name);
-      },
-    },
-
-    rpc: opts.fetchBridge
-      ? {
-          settings: {
-            describe: () => opts.fetchBridge.describe(),
-            update: (ns, section) => opts.fetchBridge.write('update', { ns, section }),
-            replace: (ns, section) => opts.fetchBridge.write('replace', { ns, section }),
-            mutate: (ns, ops) => opts.fetchBridge.write('mutate', { ns, ops }),
-          },
-        }
-      : undefined,
-  };
-
-  return api;
-}
-
-/**
- * Install dshloader into a browser-like environment.
- * @param {{
- *   window?: any,
- *   dshVersion?: string,
- *   exposeAllNamespaces?: boolean,
- *   requireImpl?: (spec: string) => any,
- *   hostBridgePrefix?: string,
- *   clientCtx?: object,  // cordis client context (passed from apply(ctx))
- * }} [opts]
- */
-export function installClient(opts = {}) {
-  const win = opts.window ?? (typeof window !== 'undefined' ? window : undefined);
-  if (win === undefined) return undefined;
-
-  const dshVersion = opts.dshVersion ?? win.__DSHLOADER_VERSION__ ?? undefined;
-  const adapter = pickClientAdapter(dshVersion);
-  const moduleAliases = { ...(adapter.moduleAliases ?? {}) };
-  // Merge adapter-declared package aliases with any passed via opts (opts
-  // win on conflict, so tests / runtime can override adapter defaults).
-  const packageAliases = new Map(Object.entries(adapter.packageAliases ?? {}));
-  if (opts.packageAliases) {
-    for (const [k, v] of Object.entries(opts.packageAliases)) packageAliases.set(k, v);
-  }
-
-  // fetch bridge (only meaningful when exposeAllNamespaces is on).
-  const exposeAllNamespaces = Boolean(
-    opts.exposeAllNamespaces ?? win.__DSHLOADER_CONFIG__?.exposeAllNamespaces,
-  );
-  const bridgePrefix = opts.hostBridgePrefix ?? BRIDGE_PREFIX;
-
-  const fetchBridge = exposeAllNamespaces
-    ? {
-        describe: () => win.fetch(`${bridgePrefix}/settings/describe`, { headers: { accept: 'application/json' } }).then((r) => r.json()),
-        write: (mode, payload) =>
-          win.fetch(`${bridgePrefix}/settings/${mode}`, {
-            method: 'POST',
-            headers: { 'content-type': 'application/json' },
-            body: JSON.stringify(payload),
-          }).then((r) => r.json()),
-      }
-    : undefined;
-
-  const api = createClientAPI({
-    dshVersion,
-    adapterVersion: adapter.supports,
-    moduleAliases,
-    packageAliases,
-    requireImpl: opts.requireImpl ?? ((spec) => win.__dshNativeRequire__?.(spec)),
-    fetchBridge,
-    clientCtx: opts.clientCtx,
-  });
-  win.__dshLoader__ = api;
-
-  // Wrap __ModuleLoader__.load so every factory's require() function
-  // applies package-name aliases before hitting the module table. This
-  // must happen BEFORE registering module-alias factories below, because
-  // those factories also receive the wrapped require.
-  const loader = win.__ModuleLoader__;
-  if (loader && typeof loader.load === 'function') {
-    const originalLoad = loader.load.bind(loader);
-    loader.load = function dshloaderLoad(handoff) {
-      const wrappedFactory = (require) => {
-        const aliasedRequire = (spec) => {
-          const mapped = packageAliases.get(spec);
-          return require(mapped ?? spec);
-        };
-        return handoff.factory(aliasedRequire);
-      };
-      return originalLoad({ id: handoff.id, factory: wrappedFactory });
-    };
-  }
-
-  // Register module-alias factories with the client module loader (fix 1).
-  if (loader && typeof loader.load === 'function') {
-    for (const [aliasId, target] of Object.entries(moduleAliases)) {
-      loader.load({
-        id: aliasId,
-        factory: (require) => {
-          const mod = require(target);
-          // Preserve the deep import's expected named export shape.
-          if (aliasId.endsWith('context-provenance.ts') || aliasId.endsWith('context-provenance')) {
-            return { contextProvenance: mod.contextProvenance };
-          }
-          return mod;
-        },
-      });
-    }
-  }
-
-  if (exposeAllNamespaces) {
-    installSettingsFetchInterceptor(win, bridgePrefix);
-    console.warn(`${LOG_PREFIX} exposeAllNamespaces enabled: bypassing official settings whitelist`);
-  }
-
-  return api;
-}
-
-/**
- * Fetch interceptor for settings namespace whitelist bypass (fix 5, path 2).
- * Mirrors dsh-upstream-fixes/lib/client.js (127-223).
- *
- * - /api/settings.describe: merge non-whitelisted namespaces from the host
- *   bridge into the official response (rpcId/official fields preserved).
- * - /api/settings.{update,mutate,replace}: route writes for namespaces the
- *   official proxy does NOT expose through the host bridge, and rebuild the
- *   response envelope as `{ type: 'server-response', rpcId, result }` so the
- *   official client can correlate the response with the request.
- */
-export function installSettingsFetchInterceptor(win, bridgePrefix = BRIDGE_PREFIX) {
-  if (typeof win.fetch !== 'function') return () => {};
-  const originalFetch = win.fetch;
-  /** Namespaces the official proxy itself exposed (learned from describe). */
-  const officialExposed = new Set();
-
-  win.fetch = async function dshloaderFetch(input, init) {
-    let pathname = '';
-    try {
-      pathname = new URL(typeof input === 'string' ? input : input.url, win.location?.origin ?? 'http://localhost').pathname;
-    } catch {
-      pathname = String(input).split('?')[0];
-    }
-    const method = (init?.method ?? 'GET').toUpperCase();
-
-    // describe: merge bridge namespaces into the official response.
-    if (pathname === '/api/settings.describe') {
-      const response = await originalFetch(input, init);
-      try {
-        const body = await response.clone().json();
-        const namespaces = body?.result?.value?.namespaces;
-        if (!Array.isArray(namespaces)) return response;
-        for (const row of namespaces) {
-          if (typeof row?.ns === 'string') officialExposed.add(row.ns);
-        }
-        const extra = await originalFetch(`${bridgePrefix}/settings/describe`, {
-          headers: { accept: 'application/json' },
-        });
-        const extraBody = await extra.json();
-        if (extraBody?.ok !== true || !Array.isArray(extraBody.namespaces)) return response;
-        const seen = new Set(namespaces.map((row) => row.ns));
-        const merged = [...namespaces, ...extraBody.namespaces.filter((row) => !seen.has(row.ns))];
-        return new win.Response(
-          JSON.stringify({ ...body, result: { ...body.result, value: { ...body.result.value, namespaces: merged } } }),
-          { status: 200, headers: { 'content-type': 'application/json' } },
-        );
-      } catch {
-        return response;
-      }
-    }
-
-    // writes: route non-whitelisted namespaces through the bridge, echo rpcId.
-    if (
-      (pathname === '/api/settings.update' || pathname === '/api/settings.mutate' || pathname === '/api/settings.replace') &&
-      method === 'POST'
-    ) {
-      let rpcId = null;
-      let payload = null;
-      try {
-        const parsed = JSON.parse(String(init?.body ?? '{}'));
-        rpcId = parsed.rpcId;
-        payload = parsed.payload;
-      } catch {
-        /* fall through to the original endpoint */
-      }
-      const ns = typeof payload?.ns === 'string' ? payload.ns : '';
-      if (rpcId !== null && ns !== '' && officialExposed.size > 0 && !officialExposed.has(ns)) {
-        try {
-          const mode = pathname.slice('/api/settings.'.length);
-          const res = await originalFetch(`${bridgePrefix}/settings/${mode}`, {
-            method: 'POST',
-            headers: { 'content-type': 'application/json' },
-            body: JSON.stringify(payload),
-          });
-          const body = await res.json();
-          if (body?.result) {
-            return new win.Response(
-              JSON.stringify({ type: 'server-response', rpcId, result: body.result }),
-              { status: 200, headers: { 'content-type': 'application/json' } },
-            );
-          }
-        } catch {
-          /* fall back to the original endpoint */
-        }
-      }
-    }
-
-    return originalFetch(input, init);
-  };
-
-  return () => {
-    win.fetch = originalFetch;
-  };
-}
-
-// ── cordis client-plugin entry ─────────────────────────────────────────
-// dsh's client boot applies every registered bundle as a cordis plugin:
-// the module must expose `apply` (third-party plugins / dsh-client-runtime
-// all do `exports.apply = apply`). Without it the client boot fails with
-// "invalid plugin, expect function or object with an \"apply\" method".
-// `installClient` mounts window.__dshLoader__, registers module aliases,
-// wires the client cordis ctx for `services.get`, and (when opted in)
-// installs the settings fetch interceptor.
-export const name = '@dsh-plugin/dsh-loader'
-export const inject = []
-export function apply(ctx) {
-  if (typeof window !== 'undefined') installClient({ window, clientCtx: ctx });
-}

package/src/index.js

@@ -1,105 +0,0 @@
-// dshloader host bundle entry (design.md §7.3 / §4.4).
-//
-// Exports the cordis function-plugin shape (`name`, `inject`, `apply`) and
-// wires the adapter registry → version detection → stable API onto
-// `ctx.dshLoader`. Service aliases / bridge routes register through
-// ctx.reflect.provide / ctx.effect so cordis auto-recycles them on fiber
-// unload — no manual dispose is required for v1's covered capabilities.
-import { LOADER_VERSION, LOG_PREFIX } from './version.js';
-import { readFileSync } from 'node:fs';
-import { join, resolve } from 'node:path';
-import { AdapterRegistry, detectDshVersion, UnsupportedDshVersionError } from './registry.js';
-import { registerHostAdapters } from './adapters/index.js';
-import { createHostAPI } from './api.js';
-
-export const name = '@dsh-plugin/dsh-loader';
-// dshloader itself depends on `webServer` so its fiber only activates once
-// the real web server is provided — the alias then points `httpServer` at it.
-export const inject = ['webServer'];
-
-/**
- * Read the profile-level dshloader config (exposeAllNamespaces etc.).
- * Sources, in priority order:
- *   1. process.env.DSHLOADER_EXPOSE_ALL_SETTINGS=1
- *   2. profile package.json `dsh.dshloader.exposeAllNamespaces`
- *   3. profile package.json `dshLoader.settings.exposeAllNamespaces`
- */
-export function readLoaderConfig({ profileDir } = {}) {
-  const envOn = process.env.DSHLOADER_EXPOSE_ALL_SETTINGS === '1' || process.env.DSHLOADER_EXPOSE_ALL_SETTINGS === 'true';
-  let pkgOn = false;
-  try {
-    // Best-effort: read the profile manifest if reachable via cwd.
-    const dir = profileDir ?? join(process.env.DSH_HOME ?? '', 'profiles', 'web');
-    const manifest = JSON.parse(readFileSync(join(resolve(dir), 'package.json'), 'utf8'));
-    pkgOn = Boolean(
-      manifest.dsh?.dshloader?.exposeAllNamespaces ??
-        manifest.dshLoader?.settings?.exposeAllNamespaces,
-    );
-  } catch {
-    /* ignore */
-  }
-  return { exposeAllNamespaces: envOn || pkgOn };
-}
-
-/**
- * Build the registry + select an adapter for the current dsh version, without
- * touching the cordis context. Exported for tests and the `info` CLI command.
- */
-export function selectAdapter({ dshVersion, registry } = {}) {
-  const reg = registry ?? registerHostAdapters(new AdapterRegistry());
-  const version = dshVersion ?? detectDshVersion();
-  if (version === undefined) {
-    throw new UnsupportedDshVersionError(
-      `${LOG_PREFIX} could not detect dsh version; set DSHLOADER_DSH_VERSION or install @deepseek-ai/dsh`,
-      { kind: 'too-new' },
-    );
-  }
-  const { factory, mode } = reg.select(version);
-  return { registry: reg, factory, mode, dshVersion: version };
-}
-
-/**
- * Apply the selected adapter onto a cordis context and expose the stable API.
- * @param {object} ctx cordis context
- * @param {{ dshVersion?: string, config?: object, registry?: AdapterRegistry }} [opts]
- * @returns {Promise<{ api: object, factory: object, mode: string, dshVersion: string }>}
- */
-export async function applyAdapter(ctx, opts = {}) {
-  const config = opts.config ?? readLoaderConfig();
-  const selection = selectAdapter({ dshVersion: opts.dshVersion, registry: opts.registry });
-  const { factory, mode, dshVersion } = selection;
-
-  const adapter = factory.create(ctx, config);
-  await adapter.apply?.();
-
-  const api = createHostAPI({
-    ctx,
-    dshVersion,
-    factory,
-    adapter,
-    exposeAllNamespaces: config.exposeAllNamespaces,
-    hostPackageAliases: config.hostPackageAliases,
-  });
-  ctx.reflect.provide('dshLoader', api);
-
-  console.log(`${LOG_PREFIX} loaded adapter ${factory.name} for dsh ${dshVersion} (mode: ${mode})`);
-  console.log(`${LOG_PREFIX} registered stable API: settings, web, services`);
-  if (config.exposeAllNamespaces) {
-    console.warn(
-      `${LOG_PREFIX} exposeAllNamespaces enabled: bypassing official settings whitelist`,
-    );
-  }
-
-  return { api, factory, mode, dshVersion };
-}
-
-/** cordis function-plugin entry point. */
-export async function apply(ctx) {
-  if (process.env.DSHLOADER_DISABLE === '1' || process.env.DSHLOADER_DISABLE === 'true') {
-    console.log(`${LOG_PREFIX} disabled by env, skipping`);
-    return;
-  }
-  await applyAdapter(ctx);
-}
-
-export { LOADER_VERSION };