@openpalm/lib 0.9.4

package/src/index.ts

@@ -0,0 +1,295 @@
+/**
+ * @openpalm/lib — shared control-plane library.
+ *
+ * All portable control-plane logic lives here. Both CLI and admin
+ * import from this package. Admin is a thin SvelteKit UI layer;
+ * the CLI calls these functions directly.
+ */
+
+// ── Provider Constants ──────────────────────────────────────────────────
+export {
+  LLM_PROVIDERS,
+  PROVIDER_DEFAULT_URLS,
+  PROVIDER_KEY_MAP,
+  EMBEDDING_DIMS,
+  PROVIDER_LABELS,
+  mem0ProviderName,
+  mem0BaseUrlConfig,
+  OLLAMA_DEFAULT_MODELS,
+  OLLAMA_INSTACK_URL,
+  LOCAL_PROVIDER_HELP,
+} from "./provider-constants.js";
+
+// ── Logger ──────────────────────────────────────────────────────────────
+export { createLogger } from "./logger.js";
+
+// ── Types ───────────────────────────────────────────────────────────────
+export type {
+  ControlPlaneState,
+  CoreServiceName,
+  OptionalServiceName,
+  AccessScope,
+  ChannelInfo,
+  CallerType,
+  ConnectionKind,
+  ConnectionAuthMode,
+  ArtifactMeta,
+  AuditEntry,
+  RequiredCapability,
+  OptionalCapability,
+  Capability,
+  LlmAssignment,
+  EmbeddingsAssignment,
+  RerankerAssignment,
+  TtsAssignment,
+  SttAssignment,
+  CapabilityAssignments,
+  CanonicalConnectionProfile,
+  CanonicalConnectionsDocument,
+} from "./control-plane/types.js";
+export {
+  CORE_SERVICES,
+  OPTIONAL_SERVICES,
+  CONNECTION_KINDS,
+  REQUIRED_CAPABILITIES,
+  OPTIONAL_CAPABILITIES,
+} from "./control-plane/types.js";
+
+// ── Interfaces ──────────────────────────────────────────────────────────
+export type { CoreAssetProvider } from "./control-plane/core-asset-provider.js";
+export type { RegistryProvider } from "./control-plane/registry-provider.js";
+
+// ── Filesystem Providers ────────────────────────────────────────────────
+export { FilesystemAssetProvider } from "./control-plane/fs-asset-provider.js";
+export { FilesystemRegistryProvider } from "./control-plane/fs-registry-provider.js";
+
+// ── Paths ───────────────────────────────────────────────────────────────
+export {
+  resolveConfigHome,
+  resolveStateHome,
+  resolveDataHome,
+  ensureXdgDirs,
+} from "./control-plane/paths.js";
+
+// ── Env ─────────────────────────────────────────────────────────────────
+export {
+  parseEnvContent,
+  parseEnvFile,
+  mergeEnvContent,
+} from "./control-plane/env.js";
+
+// ── Audit ───────────────────────────────────────────────────────────────
+export { appendAudit } from "./control-plane/audit.js";
+
+// ── Secrets ─────────────────────────────────────────────────────────────
+export {
+  ALLOWED_CONNECTION_KEYS,
+  REQUIRED_LLM_PROVIDER_KEYS,
+  PLAIN_CONFIG_KEYS,
+  ensureSecrets,
+  updateSecretsEnv,
+  readSecretsEnvFile,
+  patchSecretsEnvFile,
+  maskConnectionValue,
+  loadSecretsEnvFile,
+  ensureOpenCodeConfig,
+} from "./control-plane/secrets.js";
+
+// ── Setup Status ────────────────────────────────────────────────────────
+export {
+  readSecretsKeys,
+  detectUserId,
+  isSetupComplete,
+} from "./control-plane/setup-status.js";
+
+// ── Channels ────────────────────────────────────────────────────────────
+export {
+  discoverChannels,
+  isAllowedService,
+  isValidChannel,
+  installChannelFromRegistry,
+  uninstallChannel,
+  installAutomationFromRegistry,
+  uninstallAutomation,
+} from "./control-plane/channels.js";
+
+// ── Connection Profiles ─────────────────────────────────────────────────
+export {
+  getConnectionProfilesDir,
+  getConnectionProfilesPath,
+  writeConnectionProfilesDocument,
+  readConnectionProfilesDocument,
+  ensureConnectionProfilesStore,
+  writeConnectionsDocument,
+  listConnectionProfiles,
+  getCapabilityAssignments,
+  createConnectionProfile,
+  updateConnectionProfile,
+  deleteConnectionProfile,
+  saveCapabilityAssignments,
+} from "./control-plane/connection-profiles.js";
+export type { WriteConnectionsInput } from "./control-plane/connection-profiles.js";
+
+// ── Connection Mapping ──────────────────────────────────────────────────
+export {
+  buildOpenCodeMapping,
+  writeOpenCodeProviderConfig,
+  buildMem0Mapping,
+  resolveApiKeyRef,
+  buildMem0MappingFromProfiles,
+} from "./control-plane/connection-mapping.js";
+export type {
+  OpenCodeConnectionMappingInput,
+  OpenCodeConnectionMapping,
+  Mem0ConnectionMappingInput,
+  Mem0ConnectionMapping,
+} from "./control-plane/connection-mapping.js";
+
+// ── Connection Migration Flags ──────────────────────────────────────────
+export type {
+  ConnectionMigrationFlags,
+  ConnectionCompatibilityMode,
+} from "./control-plane/connection-migration-flags.js";
+export {
+  readConnectionMigrationFlags,
+  detectConnectionCompatibilityMode,
+} from "./control-plane/connection-migration-flags.js";
+
+// ── Memory Config ───────────────────────────────────────────────────────
+export type {
+  MemoryConfig,
+  ModelDiscoveryReason,
+  ProviderModelsResult,
+  VectorDimensionResult,
+  QdrantDimensionResult,
+} from "./control-plane/memory-config.js";
+export {
+  EMBED_PROVIDERS,
+  resolveApiKey,
+  fetchProviderModels,
+  getDefaultConfig,
+  readMemoryConfig,
+  writeMemoryConfig,
+  ensureMemoryConfig,
+  resolveConfigForPush,
+  checkVectorDimensions,
+  checkQdrantDimensions,
+  resetVectorStore,
+  resetQdrantCollection,
+  pushConfigToMemory,
+  fetchConfigFromMemory,
+  provisionMemoryUser,
+} from "./control-plane/memory-config.js";
+
+// ── Core Assets ─────────────────────────────────────────────────────────
+export {
+  PUBLIC_ACCESS_IMPORT,
+  LAN_ONLY_IMPORT,
+  ensureCoreCaddyfile,
+  readCoreCaddyfile,
+  ensureSecretsSchema,
+  ensureStackSchema,
+  detectAccessScope,
+  setCoreCaddyAccessScope,
+  ensureMemoryDir,
+  ensureCoreCompose,
+  readCoreCompose,
+  ensureOllamaCompose,
+  readOllamaCompose,
+  ensureOpenCodeSystemConfig,
+  ensureAdminOpenCodeConfig,
+  ensureCoreAutomations,
+  refreshCoreAssets,
+} from "./control-plane/core-assets.js";
+
+// ── Staging ─────────────────────────────────────────────────────────────
+export {
+  sha256,
+  randomHex,
+  isOllamaEnabled,
+  stagedEnvFile,
+  stagedStackEnvFile,
+  buildEnvFiles,
+  discoverStagedChannelYmls,
+  stageArtifacts,
+  buildArtifactMeta,
+  persistArtifacts,
+} from "./control-plane/staging.js";
+
+// ── Lifecycle ───────────────────────────────────────────────────────────
+export {
+  createState,
+  writeSetupTokenFile,
+  applyInstall,
+  applyUpdate,
+  applyUninstall,
+  applyUpgrade,
+  updateStackEnvToLatestImageTag,
+  buildComposeFileList,
+  buildManagedServices,
+  normalizeCaller,
+  isAllowedAction,
+  validateEnvironment,
+} from "./control-plane/lifecycle.js";
+
+// ── Docker ──────────────────────────────────────────────────────────────
+export type { DockerResult } from "./control-plane/docker.js";
+export {
+  checkDocker,
+  checkDockerCompose,
+  composeUp,
+  composeDown,
+  composeRestart,
+  composeStop,
+  composeStart,
+  composePs,
+  composeLogs,
+  caddyReload,
+  composePullService,
+  composePull,
+  composeStats,
+  getDockerEvents,
+  selfRecreateAdmin,
+} from "./control-plane/docker.js";
+
+// ── Scheduler ───────────────────────────────────────────────────────────
+export type {
+  ActionType,
+  AutomationAction,
+  AutomationConfig,
+  ExecutionLogEntry,
+} from "./control-plane/scheduler.js";
+export {
+  SCHEDULE_PRESETS,
+  SAFE_PATH_RE,
+  resolveSchedule,
+  parseAutomationYaml,
+  loadAutomations,
+  executeAction,
+  startScheduler,
+  stopScheduler,
+  reloadScheduler,
+  getSchedulerStatus,
+  getExecutionLog,
+  getAllExecutionLogs,
+} from "./control-plane/scheduler.js";
+
+// ── Model Runner (local provider detection) ─────────────────────────────
+export type { LocalProviderDetection } from "./control-plane/model-runner.js";
+export { detectLocalProviders } from "./control-plane/model-runner.js";
+
+// ── Setup ────────────────────────────────────────────────────────────────
+export type {
+  SetupConnection,
+  SetupAssignments,
+  SetupInput,
+  SetupResult,
+  DetectedProvider,
+} from "./control-plane/setup.js";
+export {
+  validateSetupInput,
+  buildSecretsFromSetup,
+  buildConnectionEnvVarMap,
+  performSetup,
+  detectProviders,
+} from "./control-plane/setup.js";

package/src/logger.ts

@@ -0,0 +1,14 @@
+export type LogLevel = 'debug' | 'info' | 'warn' | 'error';
+
+export function createLogger(service: string) {
+  function log(level: LogLevel, msg: string, extra?: Record<string, unknown>): void {
+    const entry = { ts: new Date().toISOString(), level, service, msg, ...(extra ? { extra } : {}) };
+    (level === 'error' || level === 'warn' ? console.error : console.log)(JSON.stringify(entry));
+  }
+  return {
+    info: (msg: string, extra?: Record<string, unknown>) => log('info', msg, extra),
+    warn: (msg: string, extra?: Record<string, unknown>) => log('warn', msg, extra),
+    error: (msg: string, extra?: Record<string, unknown>) => log('error', msg, extra),
+    debug: (msg: string, extra?: Record<string, unknown>) => log('debug', msg, extra),
+  };
+}

package/src/provider-constants.ts

@@ -0,0 +1,106 @@
+/**
+ * Shared LLM provider constants.
+ *
+ * Single source of truth for provider configuration used by both
+ * server-side endpoints and client-side Svelte components.
+ */
+
+/** Supported LLM providers. */
+export const LLM_PROVIDERS = [
+  "openai", "anthropic", "ollama", "groq", "together",
+  "mistral", "deepseek", "xai", "lmstudio", "model-runner"
+] as const;
+
+/** Default base URLs per provider. */
+export const PROVIDER_DEFAULT_URLS: Record<string, string> = {
+  openai: "https://api.openai.com",
+  groq: "https://api.groq.com/openai",
+  mistral: "https://api.mistral.ai",
+  together: "https://api.together.xyz",
+  deepseek: "https://api.deepseek.com",
+  xai: "https://api.x.ai",
+  lmstudio: "http://host.docker.internal:1234",
+  ollama: "http://host.docker.internal:11434",
+  "model-runner": "http://model-runner.docker.internal/engines",
+};
+
+/** Map provider name → env var for the API key. */
+export const PROVIDER_KEY_MAP: Record<string, string> = {
+  openai: "OPENAI_API_KEY",
+  anthropic: "ANTHROPIC_API_KEY",
+  groq: "GROQ_API_KEY",
+  mistral: "MISTRAL_API_KEY",
+  google: "GOOGLE_API_KEY",
+};
+
+/** Known embedding model dimensions (cloud providers). */
+export const EMBEDDING_DIMS: Record<string, number> = {
+  "openai/text-embedding-3-small": 1536,
+  "openai/text-embedding-3-large": 3072,
+  "openai/text-embedding-ada-002": 1536,
+  "ollama/nomic-embed-text": 768,
+  "ollama/mxbai-embed-large": 1024,
+  "ollama/all-minilm": 384,
+  "ollama/snowflake-arctic-embed": 1024,
+};
+
+/** Provider display labels for UI. */
+export const PROVIDER_LABELS: Record<string, string> = {
+  openai: "OpenAI",
+  anthropic: "Anthropic",
+  ollama: "Ollama",
+  groq: "Groq",
+  together: "Together AI",
+  mistral: "Mistral",
+  deepseek: "DeepSeek",
+  xai: "xAI (Grok)",
+  lmstudio: "LM Studio",
+  "model-runner": "Docker Model Runner",
+};
+
+/**
+ * Map provider name → mem0-compatible provider name.
+ * mem0 doesn't know "model-runner" or "lmstudio" — both speak OpenAI protocol.
+ * Ollama also maps to "openai" because Ollama exposes an OpenAI-compatible API
+ * at /v1, and using provider "ollama" in mem0 requires the `ollama` Python
+ * package which we don't install in the memory container.
+ */
+export function mem0ProviderName(provider: string): string {
+  if (provider === "model-runner" || provider === "lmstudio" || provider === "ollama") return "openai";
+  return provider;
+}
+
+/**
+ * Map provider/base URL input to the mem0 config key/value pair.
+ * All local providers (Ollama, Model Runner, LM Studio) use the OpenAI-compatible
+ * endpoint, so we always set openai_base_url with a /v1 suffix.
+ */
+export function mem0BaseUrlConfig(
+  _provider: string,
+  baseUrl: string
+): { key: "openai_base_url"; value: string } | null {
+  const trimmed = baseUrl.trim();
+  if (!trimmed) return null;
+
+  const normalized = trimmed.replace(/\/+$/, "");
+  return { key: "openai_base_url", value: `${normalized}/v1` };
+}
+
+/** Default models to pull when enabling Ollama from the wizard. */
+export const OLLAMA_DEFAULT_MODELS = {
+  chat: "llama3.2:latest",
+  embedding: "nomic-embed-text",
+} as const;
+
+/**
+ * Base URL for Ollama when running as an in-stack compose service.
+ * Uses Docker network name instead of host.docker.internal.
+ */
+export const OLLAMA_INSTACK_URL = "http://ollama:11434";
+
+/** Contextual help for local/self-hosted providers. */
+export const LOCAL_PROVIDER_HELP: Record<string, string> = {
+  "model-runner": "Add models with: docker model pull ai/model-name",
+  ollama: "Add models with: ollama pull model-name",
+  lmstudio: "Download models from the LM Studio Discover tab.",
+};