@openpalm/lib 0.9.9 → 0.10.1

package/src/control-plane/connection-profiles.ts

@@ -1,317 +0,0 @@
-import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs';
-import { PROVIDER_KEY_MAP } from '../provider-constants.js';
-import type {
-  CapabilityAssignments,
-  CanonicalConnectionProfile,
-  CanonicalConnectionsDocument,
-  ConnectionKind,
-} from './types.js';
-
-const CONNECTIONS_DIRNAME = 'connections';
-const CONNECTION_PROFILES_FILENAME = 'profiles.json';
-
-const LOCAL_PROVIDERS = new Set(['ollama', 'lmstudio', 'model-runner']);
-const INSTACK_PROVIDERS = new Set(['ollama-instack']);
-
-function normalizeConnectionKind(provider: string): ConnectionKind {
-  if (INSTACK_PROVIDERS.has(provider)) return 'ollama_local';
-  if (LOCAL_PROVIDERS.has(provider)) return 'openai_compatible_local';
-  return 'openai_compatible_remote';
-}
-
-export function getConnectionProfilesDir(configDir: string): string {
-  return `${configDir}/${CONNECTIONS_DIRNAME}`;
-}
-
-export function getConnectionProfilesPath(configDir: string): string {
-  return `${getConnectionProfilesDir(configDir)}/${CONNECTION_PROFILES_FILENAME}`;
-}
-
-// ── Validation helpers ──────────────────────────────────────────────────
-
-function isRecord(value: unknown): value is Record<string, unknown> {
-  return typeof value === 'object' && value !== null && !Array.isArray(value);
-}
-
-function isNonEmptyString(value: unknown): value is string {
-  return typeof value === 'string' && value.trim().length > 0;
-}
-
-function isValidProfile(value: unknown): value is CanonicalConnectionProfile {
-  if (!isRecord(value)) return false;
-  if (!isNonEmptyString(value.id)) return false;
-  if (!isNonEmptyString(value.name)) return false;
-  if (value.kind !== 'openai_compatible_remote' && value.kind !== 'openai_compatible_local' && value.kind !== 'ollama_local') return false;
-  if (!isNonEmptyString(value.provider)) return false;
-  if (typeof value.baseUrl !== 'string') return false;
-  if (!isRecord(value.auth)) return false;
-  if (value.auth.mode !== 'api_key' && value.auth.mode !== 'none') return false;
-  if (value.auth.mode === 'api_key' && !isNonEmptyString(value.auth.apiKeySecretRef)) return false;
-  return true;
-}
-
-function isValidConnectionDocument(value: unknown): value is CanonicalConnectionsDocument {
-  if (!isRecord(value)) return false;
-  if (value.version !== 1) return false;
-  if (!Array.isArray(value.profiles) || value.profiles.length === 0) return false;
-  if (!isRecord(value.assignments)) return false;
-
-  if (!value.profiles.every(isValidProfile)) return false;
-
-  const llm = value.assignments.llm;
-  const embeddings = value.assignments.embeddings;
-  if (!isRecord(llm) || !isRecord(embeddings)) return false;
-  if (!isNonEmptyString(llm.connectionId) || !isNonEmptyString(llm.model)) return false;
-  if (!isNonEmptyString(embeddings.connectionId) || !isNonEmptyString(embeddings.model)) return false;
-  const embeddingDims = embeddings.embeddingDims;
-  if (
-    embeddingDims !== undefined
-    && (typeof embeddingDims !== 'number' || !Number.isInteger(embeddingDims) || embeddingDims <= 0)
-  ) {
-    return false;
-  }
-
-  return true;
-}
-
-// ── Read / Write ────────────────────────────────────────────────────────
-
-export function writeConnectionProfilesDocument(
-  configDir: string,
-  document: CanonicalConnectionsDocument
-): void {
-  const dir = getConnectionProfilesDir(configDir);
-  mkdirSync(dir, { recursive: true });
-  writeFileSync(
-    getConnectionProfilesPath(configDir),
-    JSON.stringify(document, null, 2) + '\n'
-  );
-}
-
-export function readConnectionProfilesDocument(configDir: string): CanonicalConnectionsDocument {
-  const path = getConnectionProfilesPath(configDir);
-  if (!existsSync(path)) {
-    return {
-      version: 1,
-      profiles: [],
-      assignments: {
-        llm: { connectionId: '', model: '' },
-        embeddings: { connectionId: '', model: '' },
-      },
-    };
-  }
-
-  let parsed: unknown;
-  try {
-    parsed = JSON.parse(readFileSync(path, 'utf8')) as unknown;
-  } catch {
-    throw new Error('connections/profiles.json is invalid JSON');
-  }
-
-  if (!isValidConnectionDocument(parsed)) {
-    throw new Error('connections/profiles.json is invalid: expected CanonicalConnectionsDocument v1');
-  }
-
-  return parsed;
-}
-
-export function ensureConnectionProfilesStore(configDir: string): void {
-  mkdirSync(getConnectionProfilesDir(configDir), { recursive: true });
-}
-
-// ── Multi-connection write ──────────────────────────────────────────────
-
-export type WriteConnectionsInput = {
-  profiles: Array<{
-    id: string;
-    name: string;
-    provider: string;
-    baseUrl: string;
-    hasApiKey: boolean;
-    apiKeyEnvVar: string;
-  }>;
-  assignments: CapabilityAssignments;
-};
-
-export function writeConnectionsDocument(
-  configDir: string,
-  input: WriteConnectionsInput
-): CanonicalConnectionsDocument {
-  if (input.profiles.length === 0) {
-    throw new Error('writeConnectionsDocument: profiles must not be empty');
-  }
-
-  const profileIds = new Set(input.profiles.map((p) => p.id));
-  if (!profileIds.has(input.assignments.llm.connectionId)) {
-    throw new Error(`writeConnectionsDocument: llm.connectionId "${input.assignments.llm.connectionId}" not found in profiles`);
-  }
-  if (!profileIds.has(input.assignments.embeddings.connectionId)) {
-    throw new Error(`writeConnectionsDocument: embeddings.connectionId "${input.assignments.embeddings.connectionId}" not found in profiles`);
-  }
-
-  const document: CanonicalConnectionsDocument = {
-    version: 1,
-    profiles: input.profiles.map((p) => ({
-      id: p.id,
-      name: p.name,
-      kind: normalizeConnectionKind(p.provider),
-      provider: p.provider,
-      baseUrl: p.baseUrl,
-      auth: {
-        mode: p.hasApiKey ? 'api_key' as const : 'none' as const,
-        ...(p.hasApiKey ? { apiKeySecretRef: `env:${p.apiKeyEnvVar}` } : {}),
-      },
-    })),
-    assignments: input.assignments,
-  };
-
-  writeConnectionProfilesDocument(configDir, document);
-  return document;
-}
-
-// ── CRUD operations ─────────────────────────────────────────────────────
-
-type MutationResult<T> =
-  | { ok: true; value: T }
-  | { ok: false; status: 400 | 404 | 409; message: string };
-
-function validateProfile(profile: CanonicalConnectionProfile): MutationResult<CanonicalConnectionProfile> {
-  if (!profile.id.trim()) {
-    return { ok: false, status: 400, message: 'profile.id is required' };
-  }
-  if (!profile.name.trim()) {
-    return { ok: false, status: 400, message: 'profile.name is required' };
-  }
-  if (!profile.provider.trim()) {
-    return { ok: false, status: 400, message: 'profile.provider is required' };
-  }
-  if (profile.auth.mode !== 'api_key' && profile.auth.mode !== 'none') {
-    return { ok: false, status: 400, message: 'profile.auth.mode must be api_key or none' };
-  }
-  if (profile.auth.mode === 'api_key' && !profile.auth.apiKeySecretRef?.trim()) {
-    return { ok: false, status: 400, message: 'profile.auth.apiKeySecretRef is required when auth.mode is api_key' };
-  }
-  return { ok: true, value: profile };
-}
-
-function validateAssignments(
-  assignments: CapabilityAssignments,
-  profileIds: Set<string>
-): MutationResult<CapabilityAssignments> {
-  if (!isRecord(assignments.llm)) {
-    return { ok: false, status: 400, message: 'assignments.llm must be an object' };
-  }
-  if (!isRecord(assignments.embeddings)) {
-    return { ok: false, status: 400, message: 'assignments.embeddings must be an object' };
-  }
-  if (!isNonEmptyString(assignments.llm.connectionId) || !isNonEmptyString(assignments.llm.model)) {
-    return { ok: false, status: 400, message: 'assignments.llm requires connectionId and model' };
-  }
-  if (!isNonEmptyString(assignments.embeddings.connectionId) || !isNonEmptyString(assignments.embeddings.model)) {
-    return { ok: false, status: 400, message: 'assignments.embeddings requires connectionId and model' };
-  }
-  if (!profileIds.has(assignments.llm.connectionId)) {
-    return { ok: false, status: 409, message: `assignments.llm.connectionId not found: ${assignments.llm.connectionId}` };
-  }
-  if (!profileIds.has(assignments.embeddings.connectionId)) {
-    return { ok: false, status: 409, message: `assignments.embeddings.connectionId not found: ${assignments.embeddings.connectionId}` };
-  }
-  if (
-    assignments.embeddings.embeddingDims !== undefined
-    && (!Number.isInteger(assignments.embeddings.embeddingDims) || assignments.embeddings.embeddingDims <= 0)
-  ) {
-    return { ok: false, status: 400, message: 'assignments.embeddings.embeddingDims must be a positive integer' };
-  }
-  return { ok: true, value: assignments };
-}
-
-export function listConnectionProfiles(configDir: string): CanonicalConnectionProfile[] {
-  return readConnectionProfilesDocument(configDir).profiles;
-}
-
-export function getCapabilityAssignments(configDir: string): CapabilityAssignments {
-  return readConnectionProfilesDocument(configDir).assignments;
-}
-
-export function createConnectionProfile(
-  configDir: string,
-  profile: CanonicalConnectionProfile
-): MutationResult<CanonicalConnectionProfile> {
-  const validated = validateProfile(profile);
-  if (!validated.ok) return validated;
-
-  const document = readConnectionProfilesDocument(configDir);
-  if (document.profiles.some((existing) => existing.id === profile.id)) {
-    return { ok: false, status: 409, message: `profile already exists: ${profile.id}` };
-  }
-
-  const updated: CanonicalConnectionsDocument = {
-    ...document,
-    profiles: [...document.profiles, profile],
-  };
-  writeConnectionProfilesDocument(configDir, updated);
-  return { ok: true, value: profile };
-}
-
-export function updateConnectionProfile(
-  configDir: string,
-  profile: CanonicalConnectionProfile
-): MutationResult<CanonicalConnectionProfile> {
-  const validated = validateProfile(profile);
-  if (!validated.ok) return validated;
-
-  const document = readConnectionProfilesDocument(configDir);
-  const index = document.profiles.findIndex((existing) => existing.id === profile.id);
-  if (index < 0) {
-    return { ok: false, status: 404, message: `profile not found: ${profile.id}` };
-  }
-
-  const profiles = [...document.profiles];
-  profiles[index] = profile;
-  writeConnectionProfilesDocument(configDir, { ...document, profiles });
-  return { ok: true, value: profile };
-}
-
-export function deleteConnectionProfile(
-  configDir: string,
-  id: string
-): MutationResult<{ id: string }> {
-  if (!id.trim()) {
-    return { ok: false, status: 400, message: 'profile id is required' };
-  }
-
-  const document = readConnectionProfilesDocument(configDir);
-  const existing = document.profiles.find((profile) => profile.id === id);
-  if (!existing) {
-    return { ok: false, status: 404, message: `profile not found: ${id}` };
-  }
-  const assignmentFields = ['llm', 'embeddings', 'reranking', 'tts', 'stt'] as const;
-  for (const field of assignmentFields) {
-    const assignment = document.assignments[field];
-    if (assignment && 'connectionId' in assignment && assignment.connectionId === id) {
-      return { ok: false, status: 409, message: `Cannot delete profile: it is assigned to ${field}` };
-    }
-  }
-
-  writeConnectionProfilesDocument(configDir, {
-    ...document,
-    profiles: document.profiles.filter((profile) => profile.id !== id),
-  });
-  return { ok: true, value: { id } };
-}
-
-export function saveCapabilityAssignments(
-  configDir: string,
-  assignments: CapabilityAssignments
-): MutationResult<CapabilityAssignments> {
-  const document = readConnectionProfilesDocument(configDir);
-  const profileIds = new Set(document.profiles.map((profile) => profile.id));
-  const validated = validateAssignments(assignments, profileIds);
-  if (!validated.ok) return validated;
-
-  writeConnectionProfilesDocument(configDir, {
-    ...document,
-    assignments,
-  });
-  return { ok: true, value: assignments };
-}

package/src/control-plane/core-asset-provider.ts

@@ -1,21 +0,0 @@
-/**
- * CoreAssetProvider interface — dependency injection for bundled assets.
- *
- * Admin implements this with Vite $assets imports (ViteAssetProvider).
- * CLI/lib implements this by reading from DATA_HOME (FilesystemAssetProvider).
- */
-
-export interface CoreAssetProvider {
-  coreCompose(): string;
-  caddyfile(): string;
-  ollamaCompose(): string;
-  adminCompose(): string;
-  agentsMd(): string;
-  opencodeConfig(): string;
-  adminOpencodeConfig(): string;
-  secretsSchema(): string;
-  stackSchema(): string;
-  cleanupLogs(): string;
-  cleanupData(): string;
-  validateConfig(): string;
-}

package/src/control-plane/fs-asset-provider.ts

@@ -1,65 +0,0 @@
-/**
- * FilesystemAssetProvider — reads core assets from DATA_HOME on disk.
- *
- * Used by the CLI and any non-Vite consumer. Assets are downloaded from
- * GitHub during `openpalm install` and stored in DATA_HOME.
- */
-import { readFileSync } from "node:fs";
-import { join } from "node:path";
-import type { CoreAssetProvider } from "./core-asset-provider.js";
-
-export class FilesystemAssetProvider implements CoreAssetProvider {
-  constructor(private readonly assetsDir: string) {}
-
-  private read(relPath: string): string {
-    return readFileSync(join(this.assetsDir, relPath), "utf-8");
-  }
-
-  coreCompose(): string {
-    return this.read("docker-compose.yml");
-  }
-
-  caddyfile(): string {
-    return this.read("caddy/Caddyfile");
-  }
-
-  ollamaCompose(): string {
-    return this.read("ollama.yml");
-  }
-
-  adminCompose(): string {
-    return this.read("admin.yml");
-  }
-
-  agentsMd(): string {
-    return this.read("assistant/AGENTS.md");
-  }
-
-  opencodeConfig(): string {
-    return this.read("assistant/opencode.jsonc");
-  }
-
-  adminOpencodeConfig(): string {
-    return this.read("admin/opencode.jsonc");
-  }
-
-  secretsSchema(): string {
-    return this.read("secrets.env.schema");
-  }
-
-  stackSchema(): string {
-    return this.read("stack.env.schema");
-  }
-
-  cleanupLogs(): string {
-    return this.read("automations/cleanup-logs.yml");
-  }
-
-  cleanupData(): string {
-    return this.read("automations/cleanup-data.yml");
-  }
-
-  validateConfig(): string {
-    return this.read("automations/validate-config.yml");
-  }
-}

package/src/control-plane/fs-registry-provider.ts

@@ -1,46 +0,0 @@
-/**
- * FilesystemRegistryProvider — reads registry catalog from a directory on disk.
- *
- * Used by the CLI. Reads .yml and .caddy files from the registry/ directory,
- * which is downloaded from GitHub during install or available in the repo.
- */
-import { existsSync, readdirSync, readFileSync } from "node:fs";
-import { join } from "node:path";
-import type { RegistryProvider } from "./registry-provider.js";
-
-export class FilesystemRegistryProvider implements RegistryProvider {
-  constructor(private readonly registryDir: string) {}
-
-  channelYml(): Record<string, string> {
-    return this.loadDir("channels", ".yml");
-  }
-
-  channelCaddy(): Record<string, string> {
-    return this.loadDir("channels", ".caddy");
-  }
-
-  channelNames(): string[] {
-    return Object.keys(this.channelYml());
-  }
-
-  automationYml(): Record<string, string> {
-    return this.loadDir("automations", ".yml");
-  }
-
-  automationNames(): string[] {
-    return Object.keys(this.automationYml());
-  }
-
-  private loadDir(subdir: string, ext: string): Record<string, string> {
-    const dir = join(this.registryDir, subdir);
-    if (!existsSync(dir)) return {};
-
-    const result: Record<string, string> = {};
-    for (const entry of readdirSync(dir, { withFileTypes: true })) {
-      if (!entry.isFile() || !entry.name.endsWith(ext)) continue;
-      const name = entry.name.replace(new RegExp(`\\${ext}$`), "");
-      result[name] = readFileSync(join(dir, entry.name), "utf-8");
-    }
-    return result;
-  }
-}

package/src/control-plane/paths.ts

@@ -1,77 +0,0 @@
-/**
- * XDG path resolution and directory setup for the OpenPalm control plane.
- *
- * Directory model (XDG-compliant):
- *   CONFIG_HOME (~/.config/openpalm)      — user-editable: secrets.env, channels/, assistant/
- *   DATA_HOME   (~/.local/share/openpalm) — opaque service data (memory, etc.)
- *   STATE_HOME  (~/.local/state/openpalm) — assembled runtime, audit logs
- */
-import { mkdirSync } from "node:fs";
-import { resolve as resolvePath } from "node:path";
-
-export function resolveHome(): string {
-  return process.env.HOME ?? "/tmp";
-}
-
-export function resolveConfigHome(): string {
-  const raw = process.env.OPENPALM_CONFIG_HOME;
-  if (!raw) return `${resolveHome()}/.config/openpalm`;
-  return resolvePath(raw);
-}
-
-export function resolveStateHome(): string {
-  const raw = process.env.OPENPALM_STATE_HOME;
-  if (!raw) return `${resolveHome()}/.local/state/openpalm`;
-  return resolvePath(raw);
-}
-
-export function resolveDataHome(): string {
-  const raw = process.env.OPENPALM_DATA_HOME;
-  if (!raw) return `${resolveHome()}/.local/share/openpalm`;
-  return resolvePath(raw);
-}
-
-/**
- * Create the full XDG directory tree.
- *
- * CONFIG_HOME (~/.config/openpalm)      — user-editable configuration
- * DATA_HOME   (~/.local/share/openpalm) — opaque persistent service data
- * STATE_HOME  (~/.local/state/openpalm) — generated artifacts, audit logs
- */
-export function ensureXdgDirs(): void {
-  const dataHome = resolveDataHome();
-  const configHome = resolveConfigHome();
-  const stateHome = resolveStateHome();
-
-  for (const dir of [
-    // CONFIG_HOME — user-editable
-    configHome,
-    `${configHome}/channels`,
-    `${configHome}/connections`,
-    `${configHome}/assistant`,
-    `${configHome}/automations`,
-    `${configHome}/stash`,
-
-    // DATA_HOME — persistent service data (pre-created to avoid root-owned dirs)
-    dataHome,
-    `${dataHome}/admin`,
-    `${dataHome}/memory`,
-    `${dataHome}/assistant`,
-    `${dataHome}/guardian`,
-    `${dataHome}/caddy`,
-    `${dataHome}/caddy/data`,
-    `${dataHome}/caddy/config`,
-    `${dataHome}/automations`,
-    `${dataHome}/opencode`,
-
-    // STATE_HOME — assembled runtime
-    stateHome,
-    `${stateHome}/artifacts`,
-    `${stateHome}/audit`,
-    `${stateHome}/artifacts/channels`,
-    `${stateHome}/automations`,
-    `${stateHome}/opencode`
-  ]) {
-    mkdirSync(dir, { recursive: true });
-  }
-}

package/src/control-plane/registry-provider.ts

@@ -1,19 +0,0 @@
-/**
- * RegistryProvider interface — dependency injection for registry catalog.
- *
- * Admin implements this with Vite import.meta.glob (ViteRegistryProvider).
- * CLI/lib implements this by reading from registry/ directory (FilesystemRegistryProvider).
- */
-
-export interface RegistryProvider {
-  /** Channel compose overlay YMLs, keyed by channel name. */
-  channelYml(): Record<string, string>;
-  /** Channel Caddy routes (optional), keyed by channel name. */
-  channelCaddy(): Record<string, string>;
-  /** Names of available registry channels. */
-  channelNames(): string[];
-  /** Automation configs, keyed by automation name. */
-  automationYml(): Record<string, string>;
-  /** Names of available registry automations. */
-  automationNames(): string[];
-}