@skaile/forge-settings 0.0.0-stage → 1.0.1

package/dist/runtime/vue/settings-modal-scope.d.ts

@@ -0,0 +1,62 @@
+/**
+ * The tier a settings modal edits, and the URLs of its routes.
+ *
+ * The URL protocol is the host's: every field names a route the host serves,
+ * and no component builds a URL from an id or a slug. `ForgeProvidersPanel`
+ * takes the `providers*` / `environmentUrl` / `providersLayer` fields of this
+ * record as its props; the rest belong to the host's own modal tabs (harness,
+ * voice, workspace), which stay in the host.
+ */
+/** Which settings tier a modal edits. */
+export type SettingsModalSettingsScope = "instance" | "workspace";
+/**
+ * The tier the modal edits: the instance (app-wide defaults) or one
+ * workspace. The caller owns every route: the modal never builds a URL from an
+ * id or slug.
+ */
+export interface SettingsModalScope {
+    /** Dialog header text, e.g. the workspace name. */
+    label: string;
+    /**
+     * `"instance"`: the Harness tab edits the instance defaults
+     * (`PUT /api/settings?scope=instance`); `"workspace"`: it edits this
+     * workspace's overrides through {@link settingsUrl}.
+     */
+    settingsScope: SettingsModalSettingsScope;
+    /**
+     * `GET`/`PUT` endpoint of this scope's settings: `/api/settings` for the
+     * instance, the workspace's override row (`{ harness, model }`) otherwise.
+     */
+    settingsUrl: string;
+    /** Base URL for the Workspace + Connectors tabs' config API calls. */
+    workspaceApiBaseUrl: string;
+    /** `GET` model catalog of this scope's registry, queried with `?harness=<id>`. */
+    modelsUrl: string;
+    /** Provider registry write base: `PUT|DELETE <url>/:id`, `GET <url>/detected`. */
+    providersWriteUrl: string;
+    /**
+     * `GET` endpoint of this scope's `.env` layer, which the Providers tab reads and
+     * writes. Defaults to the instance layer, `/api/settings/env`.
+     */
+    environmentUrl?: string;
+    /**
+     * `GET` endpoint listing registry entries with their credential status
+     * resolved against this scope's environment. Defaults to `/api/providers`.
+     */
+    providersUrl?: string;
+    /**
+     * The registry document the Providers tab edits, when it differs from
+     * {@link settingsScope}. A single-workspace app keeps instance settings but
+     * writes the workspace registry over a user-level one: `"workspace"` there
+     * makes the lower document's entries inherited and patchable.
+     */
+    providersLayer?: SettingsModalSettingsScope;
+    /** Workspace name for workspace-scope copy (the harness-change confirm); defaults to {@link label}. */
+    workspaceName?: string;
+    /** The caller may read but not write this scope (e.g. a `readonly` user, another owner's workspace). */
+    readOnly?: boolean;
+}
+/** Default `GET` route of the merged provider list. */
+export declare const DEFAULT_PROVIDERS_URL = "/api/providers";
+/** Default `GET`/`PUT` route of the instance `.env` layer. */
+export declare const DEFAULT_ENVIRONMENT_URL = "/api/settings/env";

package/dist/runtime/vue/settings-modal-scope.js

@@ -0,0 +1,2 @@
+export const DEFAULT_PROVIDERS_URL = "/api/providers";
+export const DEFAULT_ENVIRONMENT_URL = "/api/settings/env";

package/dist/runtime/vue/useProvidersPanel.d.ts

@@ -0,0 +1,115 @@
+/**
+ * Shared brain for `components-nuxt-ui/ForgeProvidersPanel.vue` — the settings
+ * modal's Providers tab.
+ *
+ * It drives the registry editor: loading, the add/edit form, the delete confirmation,
+ * the "detected in environment" one-click adds, the per-row credential picker,
+ * the enabled toggle and every request live here.
+ *
+ * The panel writes one registry document — the scope's own `layer` — through
+ * `PUT|DELETE ${providersWriteUrl}/:id`. An entry a lower layer defines can be
+ * patched at workspace scope (`credential` / `enabled` only) and reset by
+ * deleting the patch. A key typed into the panel goes to the scope's `.env`
+ * route only; the provider route receives an `env:NAME` reference, never a
+ * value.
+ */
+import { type ComputedRef, type Ref, type WritableComputedRef } from "vue";
+import { type EnvSettingsDocument } from "../shared/env-vars.js";
+import { type AIProviderSurface } from "../shared/provider-registry.js";
+import { type ProvidersPanelEntry, type ProvidersPanelEmit, type ProvidersPanelForm, type ProvidersPanelPreset, type ProvidersPanelProps, type ProvidersPanelRow } from "./providers-panel-model.js";
+export { CREDENTIAL_ENTER_KEY, CREDENTIAL_OTHER_REF, CUSTOM_PRESET } from "./providers-panel-model.js";
+export type { ProvidersPanelCredentialOption, ProvidersPanelEmit, ProvidersPanelEntry, ProvidersPanelForm, ProvidersPanelLayer, ProvidersPanelPreset, ProvidersPanelProps, ProvidersPanelRow, ProvidersPanelRowState, } from "./providers-panel-model.js";
+/** What both `ForgeProvidersPanel` variants bind to. */
+export interface ProvidersPanelState {
+    /** The scope's entries, disabled ones included, in registry order. */
+    rows: ComputedRef<ProvidersPanelRow[]>;
+    loading: Ref<boolean>;
+    loadError: Ref<string | null>;
+    /** Re-read the entries, the detected presets and the environment document. */
+    refresh: () => Promise<void>;
+    dialogVisible: Ref<boolean>;
+    dialogTitle: ComputedRef<string>;
+    /** The row being edited; `null` while adding. */
+    editing: Ref<ProvidersPanelEntry | null>;
+    form: ProvidersPanelForm;
+    /** A refusal from the form check or either request, shown in the dialog. */
+    dialogError: Ref<string | null>;
+    saving: Ref<boolean>;
+    /** Catalog presets plus "Custom" ({@link CUSTOM_PRESET}). */
+    presetOptions: ComputedRef<Array<{
+        label: string;
+        value: string;
+    }>>;
+    surfaceOptions: Array<{
+        label: string;
+        value: AIProviderSurface;
+    }>;
+    isCustom: ComputedRef<boolean>;
+    /** The surface select is shown: a custom `llm`/`embed` entry. */
+    showSurface: ComputedRef<boolean>;
+    baseUrlPlaceholder: ComputedRef<string>;
+    /** "Set value now" is offered: the scope has an `.env` route. */
+    canSetValue: ComputedRef<boolean>;
+    /** The dialog shows the env name and secret fields: adding, not editing. */
+    showCredentialFields: ComputedRef<boolean>;
+    idError: ComputedRef<string | null>;
+    openAdd: (presetId?: string) => void;
+    openEdit: (row: ProvidersPanelEntry) => void;
+    selectPreset: (value: string) => void;
+    saveProvider: () => Promise<void>;
+    deleteTarget: Ref<ProvidersPanelEntry | null>;
+    /** The confirmation dialog's `v-model`; closing it cancels. */
+    deleteOpen: WritableComputedRef<boolean>;
+    deleteError: Ref<string | null>;
+    deleting: Ref<boolean>;
+    requestDelete: (row: ProvidersPanelEntry) => void;
+    confirmDelete: () => Promise<void>;
+    /** Presets whose key is set in the scope's env and that no entry names. */
+    detected: Ref<ProvidersPanelPreset[]>;
+    /** Preset id whose one-click add is in flight. */
+    detectedBusy: Ref<string | null>;
+    detectedError: Ref<string | null>;
+    addDetected: (preset: ProvidersPanelPreset) => Promise<void>;
+    /** The credential select's `@update`: a NAME writes, the two actions open an editor. */
+    onCredentialSelect: (row: ProvidersPanelRow, value: string) => void;
+    setCredentialEnv: (row: ProvidersPanelRow, name: string) => Promise<void>;
+    setEnabled: (row: ProvidersPanelRow, enabled: boolean) => Promise<void>;
+    /** Delete the workspace patch of an inherited entry. */
+    resetPatch: (row: ProvidersPanelRow) => Promise<void>;
+    /** Row id with a write in flight. */
+    rowBusy: Ref<string | null>;
+    rowError: Ref<{
+        id: string;
+        message: string;
+    } | null>;
+    /** "Enter a key…" is offered: the scope has an editable `.env` route. */
+    canEnterKey: ComputedRef<boolean>;
+    /** Row id whose key editor is open. */
+    keyEditing: Ref<string | null>;
+    keyForm: {
+        name: string;
+        value: string;
+    };
+    keyError: Ref<string | null>;
+    openKeyEditor: (row: ProvidersPanelRow) => void;
+    cancelKeyEditor: () => void;
+    saveKeyEditor: () => Promise<void>;
+    /** Row id whose reference editor is open. */
+    refEditing: Ref<string | null>;
+    refForm: {
+        ref: string;
+    };
+    refError: Ref<string | null>;
+    openRefEditor: (row: ProvidersPanelRow) => void;
+    cancelRefEditor: () => void;
+    saveRefEditor: () => Promise<void>;
+    envDocument: Ref<EnvSettingsDocument | null>;
+    /** The environment document says the caller may write its layer. */
+    envEditable: ComputedRef<boolean>;
+    /** Draft new values per variable name. */
+    envValues: Record<string, string>;
+    envError: Ref<string | null>;
+    envBusy: Ref<boolean>;
+    setEnvValue: (name: string) => Promise<void>;
+}
+export declare function useProvidersPanel(props: ProvidersPanelProps, emit: ProvidersPanelEmit): ProvidersPanelState;