@moxxy/plugin-provider-admin 0.26.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Moxxy (moxxy.ai)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/factory.d.ts

@@ -0,0 +1,12 @@
+import { type ProviderDef } from '@moxxy/sdk';
+import { validateOpenAICompatKey } from '@moxxy/plugin-provider-openai';
+import type { StoredProvider } from './types.js';
+/**
+ * Re-export the shared OpenAI-compatible key validator so existing
+ * consumers (and `index.ts`) keep a single import surface. The probe
+ * lives in `@moxxy/plugin-provider-openai` — we don't keep a local copy.
+ */
+export { validateOpenAICompatKey };
+/** Build a runtime ProviderDef from a stored entry by dispatching on `kind`. */
+export declare function buildProviderDef(entry: StoredProvider): ProviderDef;
+//# sourceMappingURL=factory.d.ts.map

package/dist/factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../src/factory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,KAAK,WAAW,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,EAA8B,uBAAuB,EAAE,MAAM,+BAA+B,CAAC;AACpG,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjD;;;;GAIG;AACH,OAAO,EAAE,uBAAuB,EAAE,CAAC;AA2BnC,gFAAgF;AAChF,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,cAAc,GAAG,WAAW,CASnE"}

package/dist/factory.js

@@ -0,0 +1,35 @@
+import { MoxxyError } from '@moxxy/sdk';
+import { defineOpenAICompatProvider, validateOpenAICompatKey } from '@moxxy/plugin-provider-openai';
+/**
+ * Re-export the shared OpenAI-compatible key validator so existing
+ * consumers (and `index.ts`) keep a single import surface. The probe
+ * lives in `@moxxy/plugin-provider-openai` — we don't keep a local copy.
+ */
+export { validateOpenAICompatKey };
+const PROVIDER_DEF_BUILDERS = {
+    // For `openai-compat` we delegate to the shared {@link defineOpenAICompatProvider}
+    // factory that the built-in vendor plugins (xai/zai/google/local) also use: it
+    // forces the vendor's slug + baseURL + default model + catalog onto the shared
+    // OpenAI client and wires validateKey against the same baseURL, so the
+    // setup-wizard / `moxxy doctor --check-keys` paths work end-to-end. The runtime
+    // config only carries the resolved API key, so the factory's narrow pick keeps
+    // just that and the vendor's stored baseURL/defaultModel win.
+    'openai-compat': (entry) => defineOpenAICompatProvider({
+        name: entry.name,
+        baseURL: entry.baseURL,
+        defaultModel: entry.defaultModel,
+        models: entry.models,
+    }),
+};
+/** Build a runtime ProviderDef from a stored entry by dispatching on `kind`. */
+export function buildProviderDef(entry) {
+    const build = PROVIDER_DEF_BUILDERS[entry.kind];
+    if (!build) {
+        throw new MoxxyError({
+            code: 'CONFIG_INVALID',
+            message: `provider-admin: unsupported kind ${String(entry.kind)}`,
+        });
+    }
+    return build(entry);
+}
+//# sourceMappingURL=factory.js.map

package/dist/factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"factory.js","sourceRoot":"","sources":["../src/factory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAoB,MAAM,YAAY,CAAC;AAC1D,OAAO,EAAE,0BAA0B,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAC;AAGpG;;;;GAIG;AACH,OAAO,EAAE,uBAAuB,EAAE,CAAC;AAUnC,MAAM,qBAAqB,GAAuD;IAChF,mFAAmF;IACnF,+EAA+E;IAC/E,+EAA+E;IAC/E,uEAAuE;IACvE,gFAAgF;IAChF,+EAA+E;IAC/E,8DAA8D;IAC9D,eAAe,EAAE,CAAC,KAAK,EAAE,EAAE,CACzB,0BAA0B,CAAC;QACzB,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,YAAY,EAAE,KAAK,CAAC,YAAY;QAChC,MAAM,EAAE,KAAK,CAAC,MAAM;KACrB,CAAC;CACL,CAAC;AAEF,gFAAgF;AAChF,MAAM,UAAU,gBAAgB,CAAC,KAAqB;IACpD,MAAM,KAAK,GAAG,qBAAqB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAChD,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,UAAU,CAAC;YACnB,IAAI,EAAE,gBAAgB;YACtB,OAAO,EAAE,oCAAoC,MAAM,CAAE,KAA2B,CAAC,IAAI,CAAC,EAAE;SACzF,CAAC,CAAC;IACL,CAAC;IACD,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC;AACtB,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,92 @@
+import { type Plugin, type ProviderAdminView, type ProviderDef } from '@moxxy/sdk';
+import { providersConfigPath, readProvidersConfig, removeStoredProvider, upsertStoredProvider } from './store.js';
+export { providersConfigPath, readProvidersConfig, upsertStoredProvider, removeStoredProvider };
+export type { StoredProvider, StoredProviderOpenAICompat, StoredProvidersConfig } from './types.js';
+export { buildProviderDef, validateOpenAICompatKey } from './factory.js';
+export { providerApiKeyName, storedProviderApiKeyName } from './key-name.js';
+/**
+ * Minimal subset of the in-process ProviderRegistry the admin plugin
+ * needs. Keeping the surface narrow lets us pass either the live
+ * `session.providers` from the CLI or a fake from tests.
+ */
+export interface ProviderRegistryLike {
+    register(def: ProviderDef): void;
+    replace(def: ProviderDef): void;
+    unregister(name: string): void;
+    list(): ReadonlyArray<ProviderDef>;
+    /**
+     * Name of the currently-active provider, when the registry tracks one. The
+     * live `session.providers` implements this; the narrow fake used in tests may
+     * not — hence optional. Used to detect when a `replace()`/`unregister()`
+     * targets the active provider so we can rebuild (or refuse).
+     */
+    getActiveName?(): string | null;
+    /**
+     * Rebuild + activate a provider's instance. `replace()` drops the cached
+     * instance, so replacing the ACTIVE provider's def MUST be followed by
+     * `setActive(name, config)` or `getActive()` throws on the next turn (the
+     * invariant documented on core's ProviderRegistry).
+     */
+    setActive?(name: string, config?: Record<string, unknown>): unknown;
+}
+export interface BuildProviderAdminPluginOptions {
+    /** Live provider registry — the plugin (un)registers stored defs against it. */
+    readonly providerRegistry: ProviderRegistryLike;
+    /** Override the on-disk path. Tests inject a tmp file here. */
+    readonly configPath?: string;
+    /**
+     * Optional credential resolver. When supplied AND a reconfigure/replace
+     * targets the currently-active provider, the plugin rebuilds the active
+     * instance with this config so `getActive()` keeps working without a manual
+     * re-select. Without it the plugin leaves the active instance alone (the host
+     * — e.g. the runner, which owns the credential resolver — is responsible for
+     * the rebuild). Mirrors the runner's `setActive` config resolution.
+     */
+    readonly resolveActiveConfig?: (name: string) => Promise<Record<string, unknown>> | Record<string, unknown>;
+}
+/**
+ * Shared state + critical-section helpers for one wired plugin instance. Both
+ * {@link buildProviderAdminPlugin} and {@link buildProviderAdminPluginWithApi}
+ * drive the SAME engine so the built-in guard, active-provider rebuild and the
+ * registry-mutation lock are consistent across the tools and the configure API.
+ */
+interface ProviderAdminEngine {
+    readonly providerRegistry: ProviderRegistryLike;
+    readonly configPath?: string;
+    /** Names registered BY THIS PLUGIN (provider_add/configure/onInit). */
+    readonly ownNames: Set<string>;
+    /**
+     * Is `name` a host built-in (code provider) we must never replace? Evaluated
+     * LAZILY against the LIVE registry minus our own names — NOT snapshotted at
+     * build time, because the CLI builds this plugin BEFORE the host registers
+     * its built-in provider defs, so a build-time snapshot is empty and the guard
+     * is dead (a `provider_add({name:'openai'})` would silently hot-swap the real
+     * built-in's def). A name present in the live registry that we did not put
+     * there is, by definition, a built-in.
+     */
+    isBuiltin(name: string): boolean;
+    /** Serialize the capture→registry-mutate→persist→rollback section per name. */
+    withLock<T>(name: string, fn: () => Promise<T>): Promise<T>;
+    /**
+     * After `replace()` on the active provider, the cached instance is dropped
+     * (core ProviderRegistry invariant) so `getActive()` throws until rebuilt.
+     * Rebuild it with resolved config when the host wired a resolver. No-op when
+     * `name` isn't active or the registry doesn't track an active provider.
+     */
+    rebuildActiveIfNeeded(name: string): Promise<void>;
+}
+/**
+ * Like {@link buildProviderAdminPlugin} but also returns a
+ * {@link ProviderAdminView} api the host can stash on the session
+ * (`session.providerAdmin`) so channels — and the runner's
+ * `provider.configure` method — can edit a stored provider without going
+ * through the model. Mirrors `buildMcpAdminPluginWithApi`.
+ */
+export declare function buildProviderAdminPluginWithApi(opts: BuildProviderAdminPluginOptions): {
+    readonly plugin: Plugin;
+    readonly api: ProviderAdminView;
+};
+export declare function buildProviderAdminPlugin(opts: BuildProviderAdminPluginOptions, sharedEngine?: ProviderAdminEngine): Plugin;
+export declare const providerAdminPlugin: Plugin;
+export default providerAdminPlugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,KAAK,MAAM,EACX,KAAK,iBAAiB,EAEtB,KAAK,WAAW,EACjB,MAAM,YAAY,CAAC;AAGpB,OAAO,EACL,mBAAmB,EACnB,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,EACrB,MAAM,YAAY,CAAC;AAsBpB,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,CAAC;AAChG,YAAY,EAAE,cAAc,EAAE,0BAA0B,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACpG,OAAO,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AACzE,OAAO,EAAE,kBAAkB,EAAE,wBAAwB,EAAE,MAAM,eAAe,CAAC;AAE7E;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,GAAG,EAAE,WAAW,GAAG,IAAI,CAAC;IACjC,OAAO,CAAC,GAAG,EAAE,WAAW,GAAG,IAAI,CAAC;IAChC,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,IAAI,IAAI,aAAa,CAAC,WAAW,CAAC,CAAC;IACnC;;;;;OAKG;IACH,aAAa,CAAC,IAAI,MAAM,GAAG,IAAI,CAAC;IAChC;;;;;OAKG;IACH,SAAS,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC;CACrE;AAED,MAAM,WAAW,+BAA+B;IAC9C,gFAAgF;IAChF,QAAQ,CAAC,gBAAgB,EAAE,oBAAoB,CAAC;IAChD,+DAA+D;IAC/D,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B;;;;;;;OAOG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC7G;AAkJD;;;;;GAKG;AACH,UAAU,mBAAmB;IAC3B,QAAQ,CAAC,gBAAgB,EAAE,oBAAoB,CAAC;IAChD,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,uEAAuE;IACvE,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC/B;;;;;;;;OAQG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IACjC,+EAA+E;IAC/E,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAC5D;;;;;OAKG;IACH,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACpD;AAsFD;;;;;;GAMG;AACH,wBAAgB,+BAA+B,CAAC,IAAI,EAAE,+BAA+B,GAAG;IACtF,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,GAAG,EAAE,iBAAiB,CAAC;CACjC,CA8CA;AAED,wBAAgB,wBAAwB,CACtC,IAAI,EAAE,+BAA+B,EACrC,YAAY,CAAC,EAAE,mBAAmB,GACjC,MAAM,CAmMR;AAcD,eAAO,MAAM,mBAAmB,EAAE,MAsC9B,CAAC;AAGL,eAAe,mBAAmB,CAAC"}