@anweat/dsh-browser 0.2.0-rc.1 → 0.2.0

package/lib/settings-scope.d.ts

@@ -1,56 +0,0 @@
-/**
- * Host-version-adaptive settings scope resolution.
- *
- * DSH changed how a plugin declares its editable configuration section:
- *
- * - Older hosts (dsh-v0.1.1-rc.2 … v0.1.5-alpha.1) exposed a standalone
- *   `settingsNamespace()` helper plus a `settings.register(ns, schema, opts)`
- *   provider method. The plugin owned a mutable source ref and read the
- *   registered scope on every operation.
- * - Newer hosts (dsh-v0.1.7-rc.2+) removed both. Settings pages are derived
- *   from the Loader entry's own `Config` schema, and `SettingsForms` exposes
- *   only `configure/describe/update/replace/mutate` — there is no `register`.
- *   The host re-validates the entry config and restarts the plugin fiber, so
- *   the value handed to `apply(ctx, config)` is already the live resolved one.
- *
- * Calling `settings.register` unconditionally therefore throws
- * `TypeError: settings.register is not a function` on a newer host and aborts
- * the whole plugin fiber, so this module probes for the method and degrades to
- * the entry-config path instead.
- * @module dsh-browser/settings-scope
- */
-/** The subset of the older host's `settings.register` contract we depend on. */
-export interface LegacySettingsRegister {
-    register: (ns: string, schema: unknown, options?: {
-        base?: unknown;
-        applies?: string;
-    }) => {
-        get: () => unknown;
-    };
-}
-/** Resolved settings access: either the legacy live scope or the entry config. */
-export interface SettingsResolution<TConfig> {
-    /**
-     * Read the current configuration. On a legacy host this re-reads the
-     * registered scope (so edits are observed live); on a newer host it returns
-     * the entry config that the host keeps current by restarting the fiber.
-     */
-    get: () => TConfig;
-    /**
-     * How the value is kept up to date: `'scope'` when the legacy provider owns
-     * it, `'entry'` when the Loader re-applies the plugin config itself.
-     */
-    mode: 'scope' | 'entry';
-}
-/**
- * Register the plugin's settings section when the host supports it, and
- * otherwise fall back to the Loader-managed entry config.
- *
- * @param settings - the injected `ctx.settings` service, or undefined when the
- *   host composes none.
- * @param namespace - the settings namespace / loader entry id (e.g. `browser`).
- * @param schema - the plugin's schemastery `Config` schema.
- * @param entryConfig - the config the host passed into `apply`.
- * @returns a version-independent reader for the current configuration.
- */
-export declare function resolveSettingsScope<TConfig>(settings: unknown, namespace: string, schema: unknown, entryConfig: TConfig): SettingsResolution<TConfig>;

package/lib/settings-scope.js

@@ -1,51 +0,0 @@
-/**
- * Host-version-adaptive settings scope resolution.
- *
- * DSH changed how a plugin declares its editable configuration section:
- *
- * - Older hosts (dsh-v0.1.1-rc.2 … v0.1.5-alpha.1) exposed a standalone
- *   `settingsNamespace()` helper plus a `settings.register(ns, schema, opts)`
- *   provider method. The plugin owned a mutable source ref and read the
- *   registered scope on every operation.
- * - Newer hosts (dsh-v0.1.7-rc.2+) removed both. Settings pages are derived
- *   from the Loader entry's own `Config` schema, and `SettingsForms` exposes
- *   only `configure/describe/update/replace/mutate` — there is no `register`.
- *   The host re-validates the entry config and restarts the plugin fiber, so
- *   the value handed to `apply(ctx, config)` is already the live resolved one.
- *
- * Calling `settings.register` unconditionally therefore throws
- * `TypeError: settings.register is not a function` on a newer host and aborts
- * the whole plugin fiber, so this module probes for the method and degrades to
- * the entry-config path instead.
- * @module dsh-browser/settings-scope
- */
-/** Narrow an unknown service to the legacy registering shape. */
-function legacyRegister(settings) {
-    if (settings === null || typeof settings !== 'object')
-        return undefined;
-    const candidate = settings.register;
-    return typeof candidate === 'function'
-        ? candidate.bind(settings)
-        : undefined;
-}
-/**
- * Register the plugin's settings section when the host supports it, and
- * otherwise fall back to the Loader-managed entry config.
- *
- * @param settings - the injected `ctx.settings` service, or undefined when the
- *   host composes none.
- * @param namespace - the settings namespace / loader entry id (e.g. `browser`).
- * @param schema - the plugin's schemastery `Config` schema.
- * @param entryConfig - the config the host passed into `apply`.
- * @returns a version-independent reader for the current configuration.
- */
-export function resolveSettingsScope(settings, namespace, schema, entryConfig) {
-    const register = legacyRegister(settings);
-    if (register === undefined)
-        return { get: () => entryConfig, mode: 'entry' };
-    // The legacy provider is present: keep reading through it so live edits are
-    // visible without a fiber restart (the historical behaviour on those hosts).
-    const scope = register(namespace, schema, { base: entryConfig, applies: 'restart' });
-    return { get: () => scope.get(), mode: 'scope' };
-}
-//# sourceMappingURL=settings-scope.js.map

package/lib/settings-scope.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"settings-scope.js","sourceRoot":"","sources":["../src/settings-scope.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AA0BH,iEAAiE;AACjE,SAAS,cAAc,CAAC,QAAiB;IACvC,IAAI,QAAQ,KAAK,IAAI,IAAI,OAAO,QAAQ,KAAK,QAAQ;QAAE,OAAO,SAAS,CAAA;IACvE,MAAM,SAAS,GAAI,QAAmC,CAAC,QAAQ,CAAA;IAC/D,OAAO,OAAO,SAAS,KAAK,UAAU;QACpC,CAAC,CAAE,SAAgD,CAAC,IAAI,CAAC,QAAQ,CAAC;QAClE,CAAC,CAAC,SAAS,CAAA;AACf,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,oBAAoB,CAClC,QAAiB,EACjB,SAAiB,EACjB,MAAe,EACf,WAAoB;IAEpB,MAAM,QAAQ,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAA;IACzC,IAAI,QAAQ,KAAK,SAAS;QAAE,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,WAAW,EAAE,IAAI,EAAE,OAAO,EAAE,CAAA;IAC5E,4EAA4E;IAC5E,6EAA6E;IAC7E,MAAM,KAAK,GAAG,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAA;IACpF,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,EAAa,EAAE,IAAI,EAAE,OAAO,EAAE,CAAA;AAC7D,CAAC"}