@skaile/forge-settings 0.0.0-stage → 1.0.0

package/src/runtime/vue/settings-modal-scope.ts

@@ -0,0 +1,66 @@
+/**
+ * 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 const DEFAULT_PROVIDERS_URL = "/api/providers";
+
+/** Default `GET`/`PUT` route of the instance `.env` layer. */
+export const DEFAULT_ENVIRONMENT_URL = "/api/settings/env";