@outfitter/config 0.3.3 → 0.4.0

package/dist/index.js

@@ -1,193 +1,35 @@
-// src/environment.ts
-var VALID_ENVIRONMENTS = new Set([
-  "development",
-  "production",
-  "test"
-]);
-var ENVIRONMENT_DEFAULTS = {
-  development: {
-    logLevel: "debug",
-    verbose: true,
-    errorDetail: "full"
-  },
-  production: {
-    logLevel: null,
-    verbose: false,
-    errorDetail: "message"
-  },
-  test: {
-    logLevel: null,
-    verbose: false,
-    errorDetail: "full"
-  }
-};
-function getEnvironment() {
-  const value = process.env["OUTFITTER_ENV"];
-  if (value !== undefined && VALID_ENVIRONMENTS.has(value)) {
-    return value;
-  }
-  return "production";
-}
-function getEnvironmentDefaults(env) {
-  return { ...ENVIRONMENT_DEFAULTS[env] };
-}
-// src/env.ts
-import { z } from "zod";
-var portSchema = z.string().regex(/^\d+$/).transform(Number).pipe(z.number().int().positive().max(65535));
-var booleanSchema = z.enum(["true", "false", "1", "0", ""]).transform((val) => val === "true" || val === "1");
-var optionalBooleanSchema = z.string().optional().transform((val) => {
-  if (val === undefined || val === "")
-    return;
-  return val === "true" || val === "1";
-});
-function parseEnv(schema, envObj = process.env) {
-  return schema.parse(envObj);
-}
-var appEnvSchema = z.object({
-  NODE_ENV: z.enum(["development", "test", "production"]).default("development"),
-  NO_COLOR: optionalBooleanSchema,
-  FORCE_COLOR: optionalBooleanSchema,
-  CI: optionalBooleanSchema,
-  TERM: z.string().optional(),
-  XDG_CONFIG_HOME: z.string().optional(),
-  XDG_DATA_HOME: z.string().optional(),
-  XDG_STATE_HOME: z.string().optional(),
-  XDG_CACHE_HOME: z.string().optional(),
-  HOME: z.string().optional()
-});
-var env = parseEnv(appEnvSchema);
-function getEnvBoolean(key) {
-  const value = process.env[key];
-  if (value === undefined || value === "")
-    return;
-  return value === "true" || value === "1";
-}
-
-// src/index.ts
-import { existsSync, readFileSync } from "node:fs";
-import { dirname, isAbsolute, join, resolve } from "node:path";
+// @bun
 import {
-  NotFoundError,
-  Result,
-  TaggedError,
-  ValidationError
-} from "@outfitter/contracts";
-import { parse as parseToml } from "smol-toml";
-import { parse as parseYaml } from "yaml";
-var ParseErrorBase = TaggedError("ParseError")();
-
-class ParseError extends ParseErrorBase {
-  category = "validation";
-}
-var CircularExtendsErrorBase = TaggedError("CircularExtendsError")();
+  booleanSchema,
+  env,
+  getEnvBoolean,
+  optionalBooleanSchema,
+  parseEnv,
+  portSchema
+} from "./shared/@outfitter/config-443pb6p2.js";
+import {
+  getEnvironment,
+  getEnvironmentDefaults
+} from "./shared/@outfitter/config-w3pwcpr2.js";
+import {
+  getCacheDir,
+  getConfigDir,
+  getDataDir,
+  getStateDir
+} from "./shared/@outfitter/config-pf9xp78h.js";
+import {
+  loadConfig
+} from "./shared/@outfitter/config-br341dr7.js";
+import"./shared/@outfitter/config-aje2en96.js";
+import {
+  CircularExtendsError,
+  ParseError,
+  deepMerge,
+  parseConfigFile
+} from "./shared/@outfitter/config-s4swz8m3.js";
 
-class CircularExtendsError extends CircularExtendsErrorBase {
-  category = "validation";
-}
-function getConfigDir(appName) {
-  const xdgConfigHome = process.env["XDG_CONFIG_HOME"];
-  const home = process.env["HOME"] ?? "";
-  const baseDir = xdgConfigHome ?? join(home, ".config");
-  return join(baseDir, appName);
-}
-function getDataDir(appName) {
-  const xdgDataHome = process.env["XDG_DATA_HOME"];
-  const home = process.env["HOME"] ?? "";
-  const baseDir = xdgDataHome ?? join(home, ".local", "share");
-  return join(baseDir, appName);
-}
-function getCacheDir(appName) {
-  const xdgCacheHome = process.env["XDG_CACHE_HOME"];
-  const home = process.env["HOME"] ?? "";
-  const baseDir = xdgCacheHome ?? join(home, ".cache");
-  return join(baseDir, appName);
-}
-function getStateDir(appName) {
-  const xdgStateHome = process.env["XDG_STATE_HOME"];
-  const home = process.env["HOME"] ?? "";
-  const baseDir = xdgStateHome ?? join(home, ".local", "state");
-  return join(baseDir, appName);
-}
-function isPlainObject(value) {
-  if (value === null || typeof value !== "object") {
-    return false;
-  }
-  if (Array.isArray(value)) {
-    return false;
-  }
-  return true;
-}
-function deepMerge(target, source) {
-  const result = { ...target };
-  for (const key of Object.keys(source)) {
-    const sourceValue = source[key];
-    const targetValue = result[key];
-    if (sourceValue === undefined) {
-      continue;
-    }
-    if (sourceValue === null) {
-      result[key] = null;
-      continue;
-    }
-    if (Array.isArray(sourceValue)) {
-      result[key] = sourceValue;
-      continue;
-    }
-    if (isPlainObject(sourceValue) && isPlainObject(targetValue)) {
-      result[key] = deepMerge(targetValue, sourceValue);
-      continue;
-    }
-    result[key] = sourceValue;
-  }
-  return result;
-}
-function getExtension(filename) {
-  const lastDot = filename.lastIndexOf(".");
-  if (lastDot === -1) {
-    return "";
-  }
-  return filename.slice(lastDot + 1).toLowerCase();
-}
-function parseConfigFile(content, filename) {
-  const ext = getExtension(filename);
-  try {
-    switch (ext) {
-      case "toml": {
-        const parsed = parseToml(content);
-        return Result.ok(parsed);
-      }
-      case "yaml":
-      case "yml": {
-        const parsed = parseYaml(content, { merge: true });
-        if (parsed === null || typeof parsed !== "object") {
-          return Result.ok({});
-        }
-        return Result.ok(parsed);
-      }
-      case "json": {
-        const parsed = JSON.parse(content);
-        return Result.ok(parsed);
-      }
-      case "jsonc":
-      case "json5": {
-        const parsed = Bun.JSON5.parse(content);
-        return Result.ok(parsed);
-      }
-      default: {
-        return Result.err(new ParseError({
-          message: `Unsupported config file extension: .${ext}`,
-          filename
-        }));
-      }
-    }
-  } catch (error) {
-    const message = error instanceof Error ? error.message : "Unknown parse error";
-    return Result.err(new ParseError({
-      message: `Failed to parse ${filename}: ${message}`,
-      filename
-    }));
-  }
-}
+// packages/config/src/index.ts
+import { formatZodIssues, Result, ValidationError } from "@outfitter/contracts";
 function resolveConfig(schema, sources) {
   let merged = {};
   if (sources.defaults) {
@@ -204,133 +46,15 @@ function resolveConfig(schema, sources) {
   }
   const parseResult = schema.safeParse(merged);
   if (!parseResult.success) {
-    const issues = parseResult.error.issues;
-    const firstIssue = issues[0];
-    const path = firstIssue?.path?.join(".") ?? "";
-    const message = firstIssue?.message ?? "Validation failed";
-    const fullMessage = path ? `${path}: ${message}` : message;
+    const fullMessage = formatZodIssues(parseResult.error.issues);
+    const firstPath = parseResult.error.issues[0]?.path?.join(".");
     return Result.err(new ValidationError({
       message: fullMessage,
-      ...path ? { field: path } : {}
+      ...firstPath ? { field: firstPath } : {}
     }));
   }
   return Result.ok(parseResult.data);
 }
-var CONFIG_EXTENSIONS = ["toml", "yaml", "yml", "json", "jsonc", "json5"];
-function findConfigFile(dir) {
-  for (const ext of CONFIG_EXTENSIONS) {
-    const filePath = join(dir, `config.${ext}`);
-    if (existsSync(filePath)) {
-      return filePath;
-    }
-  }
-  return;
-}
-function getDefaultSearchPaths(appName) {
-  const xdgConfigHome = process.env["XDG_CONFIG_HOME"];
-  const home = process.env["HOME"] ?? "";
-  const defaultConfigPath = join(home, ".config", appName);
-  if (xdgConfigHome) {
-    const xdgPath = join(xdgConfigHome, appName);
-    if (xdgPath !== defaultConfigPath) {
-      return [xdgPath, defaultConfigPath];
-    }
-  }
-  return [defaultConfigPath];
-}
-function loadConfig(appName, schema, options) {
-  const searchPaths = options?.searchPaths ? options.searchPaths.map((p) => join(p, appName)) : getDefaultSearchPaths(appName);
-  let configFilePath;
-  for (const searchPath of searchPaths) {
-    const found = findConfigFile(searchPath);
-    if (found) {
-      configFilePath = found;
-      break;
-    }
-  }
-  if (!configFilePath) {
-    return Result.err(new NotFoundError({
-      message: `Configuration file not found for ${appName}`,
-      resourceType: "config",
-      resourceId: appName
-    }));
-  }
-  const loadResult = loadConfigFileWithExtends(configFilePath);
-  if (loadResult.isErr()) {
-    return Result.err(loadResult.error);
-  }
-  const parsed = loadResult.unwrap();
-  const validateResult = schema.safeParse(parsed);
-  if (!validateResult.success) {
-    const issues = validateResult.error.issues;
-    const firstIssue = issues[0];
-    const path = firstIssue?.path?.join(".") ?? "";
-    const message = firstIssue?.message ?? "Validation failed";
-    const fullMessage = path ? `${path}: ${message}` : message;
-    return Result.err(new ValidationError({
-      message: fullMessage,
-      ...path ? { field: path } : {}
-    }));
-  }
-  return Result.ok(validateResult.data);
-}
-function resolveExtendsPath(extendsValue, fromFile) {
-  if (isAbsolute(extendsValue)) {
-    return extendsValue;
-  }
-  return resolve(dirname(fromFile), extendsValue);
-}
-function loadConfigFileWithExtends(filePath, visited = new Set) {
-  const normalizedPath = resolve(filePath);
-  if (visited.has(normalizedPath)) {
-    return Result.err(new CircularExtendsError({
-      message: `Circular extends detected: ${[...visited, normalizedPath].join(" -> ")}`,
-      chain: [...visited, normalizedPath]
-    }));
-  }
-  if (!existsSync(filePath)) {
-    return Result.err(new NotFoundError({
-      message: `Config file not found: ${filePath}`,
-      resourceType: "config",
-      resourceId: filePath
-    }));
-  }
-  let content;
-  try {
-    content = readFileSync(filePath, "utf-8");
-  } catch {
-    return Result.err(new NotFoundError({
-      message: `Failed to read config file: ${filePath}`,
-      resourceType: "config",
-      resourceId: filePath
-    }));
-  }
-  const filename = filePath.split("/").pop() ?? "config";
-  const parseResult = parseConfigFile(content, filename);
-  if (parseResult.isErr()) {
-    return Result.err(parseResult.error);
-  }
-  const parsed = parseResult.unwrap();
-  const extendsValue = parsed["extends"];
-  if (extendsValue === undefined) {
-    return Result.ok(parsed);
-  }
-  if (typeof extendsValue !== "string") {
-    return Result.err(new ParseError({
-      message: `Invalid "extends" value in ${filePath}: expected string, got ${typeof extendsValue}`,
-      filename: filePath
-    }));
-  }
-  visited.add(normalizedPath);
-  const extendsPath = resolveExtendsPath(extendsValue, filePath);
-  const baseResult = loadConfigFileWithExtends(extendsPath, visited);
-  if (baseResult.isErr()) {
-    return Result.err(baseResult.error);
-  }
-  const baseConfig = baseResult.unwrap();
-  const { extends: __, ...currentConfig } = parsed;
-  return Result.ok(deepMerge(baseConfig, currentConfig));
-}
 function mapEnvToConfig(prefix, _schema) {
   const result = {};
   const prefixWithUnderscore = `${prefix}_`;

package/dist/internal/extends.d.ts

@@ -0,0 +1,13 @@
+import { CircularExtendsError, ParseError } from "../shared/@outfitter/config-sp6gradd.js";
+import { NotFoundError, Result } from "@outfitter/contracts";
+/**
+* Resolve an extends path relative to the config file that contains it.
+* @internal
+*/
+declare function resolveExtendsPath(extendsValue: string, fromFile: string): string;
+/**
+* Load a config file and recursively resolve any extends references.
+* @internal
+*/
+declare function loadConfigFileWithExtends(filePath: string, visited?: Set<string>): Result<Record<string, unknown>, InstanceType<typeof NotFoundError> | InstanceType<typeof ParseError> | InstanceType<typeof CircularExtendsError>>;
+export { resolveExtendsPath, loadConfigFileWithExtends };

package/dist/internal/extends.js

@@ -0,0 +1,10 @@
+// @bun
+import {
+  loadConfigFileWithExtends,
+  resolveExtendsPath
+} from "../shared/@outfitter/config-aje2en96.js";
+import"../shared/@outfitter/config-s4swz8m3.js";
+export {
+  resolveExtendsPath,
+  loadConfigFileWithExtends
+};

package/dist/internal/loading.d.ts

@@ -0,0 +1,3 @@
+import { LoadConfigOptions, loadConfig } from "../shared/@outfitter/config-7dyshh4r.js";
+import "../shared/@outfitter/config-sp6gradd.js";
+export { loadConfig, LoadConfigOptions };

package/dist/internal/loading.js

@@ -0,0 +1,9 @@
+// @bun
+import {
+  loadConfig
+} from "../shared/@outfitter/config-br341dr7.js";
+import"../shared/@outfitter/config-aje2en96.js";
+import"../shared/@outfitter/config-s4swz8m3.js";
+export {
+  loadConfig
+};

package/dist/internal/parsing.d.ts

@@ -0,0 +1,2 @@
+import { CircularExtendsError, ParseError, deepMerge, parseConfigFile } from "../shared/@outfitter/config-sp6gradd.js";
+export { parseConfigFile, deepMerge, ParseError, CircularExtendsError };

package/dist/internal/parsing.js

@@ -0,0 +1,13 @@
+// @bun
+import {
+  CircularExtendsError,
+  ParseError,
+  deepMerge,
+  parseConfigFile
+} from "../shared/@outfitter/config-s4swz8m3.js";
+export {
+  parseConfigFile,
+  deepMerge,
+  ParseError,
+  CircularExtendsError
+};

package/dist/internal/xdg.d.ts

@@ -0,0 +1,2 @@
+import { getCacheDir, getConfigDir, getDataDir, getStateDir } from "../shared/@outfitter/config-6449x3br.js";
+export { getStateDir, getDataDir, getConfigDir, getCacheDir };

package/dist/internal/xdg.js

@@ -0,0 +1,13 @@
+// @bun
+import {
+  getCacheDir,
+  getConfigDir,
+  getDataDir,
+  getStateDir
+} from "../shared/@outfitter/config-pf9xp78h.js";
+export {
+  getStateDir,
+  getDataDir,
+  getConfigDir,
+  getCacheDir
+};

package/dist/shared/@outfitter/config-6449x3br.d.ts

@@ -0,0 +1,81 @@
+/**
+* Get the XDG config directory for an application.
+*
+* Uses `XDG_CONFIG_HOME` if set, otherwise defaults to `~/.config`.
+* This follows the XDG Base Directory Specification for storing
+* user-specific configuration files.
+*
+* @param appName - Application name used as subdirectory
+* @returns Absolute path to the application's config directory
+*
+* @example
+* ```typescript
+* // With XDG_CONFIG_HOME="/custom/config"
+* getConfigDir("myapp"); // "/custom/config/myapp"
+*
+* // Without XDG_CONFIG_HOME (uses default)
+* getConfigDir("myapp"); // "/home/user/.config/myapp"
+* ```
+*/
+declare function getConfigDir(appName: string): string;
+/**
+* Get the XDG data directory for an application.
+*
+* Uses `XDG_DATA_HOME` if set, otherwise defaults to `~/.local/share`.
+* This follows the XDG Base Directory Specification for storing
+* user-specific data files (databases, generated content, etc.).
+*
+* @param appName - Application name used as subdirectory
+* @returns Absolute path to the application's data directory
+*
+* @example
+* ```typescript
+* // With XDG_DATA_HOME="/custom/data"
+* getDataDir("myapp"); // "/custom/data/myapp"
+*
+* // Without XDG_DATA_HOME (uses default)
+* getDataDir("myapp"); // "/home/user/.local/share/myapp"
+* ```
+*/
+declare function getDataDir(appName: string): string;
+/**
+* Get the XDG cache directory for an application.
+*
+* Uses `XDG_CACHE_HOME` if set, otherwise defaults to `~/.cache`.
+* This follows the XDG Base Directory Specification for storing
+* non-essential cached data that can be regenerated.
+*
+* @param appName - Application name used as subdirectory
+* @returns Absolute path to the application's cache directory
+*
+* @example
+* ```typescript
+* // With XDG_CACHE_HOME="/custom/cache"
+* getCacheDir("myapp"); // "/custom/cache/myapp"
+*
+* // Without XDG_CACHE_HOME (uses default)
+* getCacheDir("myapp"); // "/home/user/.cache/myapp"
+* ```
+*/
+declare function getCacheDir(appName: string): string;
+/**
+* Get the XDG state directory for an application.
+*
+* Uses `XDG_STATE_HOME` if set, otherwise defaults to `~/.local/state`.
+* This follows the XDG Base Directory Specification for storing
+* state data that should persist between restarts (logs, history, etc.).
+*
+* @param appName - Application name used as subdirectory
+* @returns Absolute path to the application's state directory
+*
+* @example
+* ```typescript
+* // With XDG_STATE_HOME="/custom/state"
+* getStateDir("myapp"); // "/custom/state/myapp"
+*
+* // Without XDG_STATE_HOME (uses default)
+* getStateDir("myapp"); // "/home/user/.local/state/myapp"
+* ```
+*/
+declare function getStateDir(appName: string): string;
+export { getConfigDir, getDataDir, getCacheDir, getStateDir };

package/dist/shared/@outfitter/config-7dyshh4r.d.ts

@@ -0,0 +1,105 @@
+import { CircularExtendsError, ParseError } from "./config-sp6gradd.js";
+import { NotFoundError, Result, ValidationError } from "@outfitter/contracts";
+import { ZodSchema } from "zod";
+/**
+* Options for the {@link loadConfig} function.
+*
+* @example
+* ```typescript
+* const options: LoadConfigOptions = {
+*   searchPaths: ["/etc/myapp", "/opt/myapp/config"],
+* };
+* ```
+*/
+interface LoadConfigOptions {
+	/**
+	* Custom search paths to check for config files.
+	* When provided, overrides the default XDG-based search paths.
+	* Note: `appName` is appended to each path (e.g., `"/etc/myapp"` becomes `"/etc/myapp/{appName}"`).
+	* Paths are searched in order; first match wins.
+	*/
+	searchPaths?: string[];
+}
+/**
+* Load configuration for an application from XDG-compliant paths.
+*
+* Search order (first found wins):
+* 1. Custom `searchPaths` if provided in options
+* 2. `$XDG_CONFIG_HOME/{appName}/config.{ext}`
+* 3. `~/.config/{appName}/config.{ext}`
+*
+* File format preference: `.toml` > `.yaml` > `.yml` > `.json` > `.jsonc` > `.json5`
+*
+* When called without a schema, returns the raw parsed config as `unknown`.
+* When called with a schema, returns the validated typed config.
+*
+* @param appName - Application name for XDG directory lookup
+* @returns Result containing raw config or NotFoundError/ParseError/CircularExtendsError
+*
+* @example
+* ```typescript
+* // Without schema — returns raw parsed config
+* const result = loadConfig("myapp");
+* if (result.isOk()) {
+*   const config = result.value; // type: unknown
+* }
+* ```
+*/
+declare function loadConfig(appName: string): Result<unknown, InstanceType<typeof NotFoundError> | InstanceType<typeof ParseError> | InstanceType<typeof CircularExtendsError>>;
+/**
+* Load configuration for an application from XDG-compliant paths.
+*
+* @param appName - Application name for XDG directory lookup
+* @param options - Configuration options (custom search paths)
+* @returns Result containing raw config or NotFoundError/ParseError/CircularExtendsError
+*
+* @example
+* ```typescript
+* // Without schema, with custom search paths
+* const result = loadConfig("myapp", { searchPaths: ["/etc/myapp"] });
+* ```
+*/
+declare function loadConfig(appName: string, options: LoadConfigOptions): Result<unknown, InstanceType<typeof NotFoundError> | InstanceType<typeof ParseError> | InstanceType<typeof CircularExtendsError>>;
+/**
+* Load configuration for an application from XDG-compliant paths.
+*
+* @typeParam T - The configuration type (inferred from schema)
+* @param appName - Application name for XDG directory lookup
+* @param schema - Zod schema for validation
+* @returns Result containing validated config or NotFoundError/ValidationError/ParseError/CircularExtendsError
+*
+* @example
+* ```typescript
+* import { loadConfig } from "@outfitter/config";
+* import { z } from "zod";
+*
+* const AppConfigSchema = z.object({
+*   apiKey: z.string(),
+*   timeout: z.number().default(5000),
+* });
+*
+* const result = loadConfig("myapp", AppConfigSchema);
+* if (result.isOk()) {
+*   console.log(result.value.apiKey); // typed!
+* }
+* ```
+*/
+declare function loadConfig<T>(appName: string, schema: ZodSchema<T>): Result<T, InstanceType<typeof NotFoundError> | InstanceType<typeof ValidationError> | InstanceType<typeof ParseError> | InstanceType<typeof CircularExtendsError>>;
+/**
+* Load configuration for an application from XDG-compliant paths.
+*
+* @typeParam T - The configuration type (inferred from schema)
+* @param appName - Application name for XDG directory lookup
+* @param schema - Zod schema for validation
+* @param options - Configuration options (custom search paths)
+* @returns Result containing validated config or NotFoundError/ValidationError/ParseError/CircularExtendsError
+*
+* @example
+* ```typescript
+* const result = loadConfig("myapp", AppConfigSchema, {
+*   searchPaths: ["/etc/myapp", "/opt/myapp/config"],
+* });
+* ```
+*/
+declare function loadConfig<T>(appName: string, schema: ZodSchema<T>, options: LoadConfigOptions): Result<T, InstanceType<typeof NotFoundError> | InstanceType<typeof ValidationError> | InstanceType<typeof ParseError> | InstanceType<typeof CircularExtendsError>>;
+export { LoadConfigOptions, loadConfig };