@outfitter/config 0.3.0 → 0.3.2

package/dist/shared/@outfitter/config-3n1xvxce.js

@@ -0,0 +1,5 @@
+// @bun
+var __commonJS = (cb, mod) => () => (mod || cb((mod = { exports: {} }).exports, mod), mod.exports);
+var __require = import.meta.require;
+
+export { __commonJS, __require };

package/dist/shared/@outfitter/config-443pb6p2.js

@@ -0,0 +1,34 @@
+// @bun
+// packages/config/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";
+}
+
+export { portSchema, booleanSchema, optionalBooleanSchema, parseEnv, env, getEnvBoolean };

package/dist/shared/@outfitter/config-a6g8nmxw.d.ts

@@ -0,0 +1,90 @@
+/**
+* Unified environment profiles for Outfitter packages.
+*
+* Provides a shared "environment" concept that cascades defaults
+* across all Outfitter packages. The environment is determined by
+* the `OUTFITTER_ENV` environment variable, falling back to
+* `"production"` when unset or invalid.
+*
+* @example
+* ```typescript
+* import { getEnvironment, getEnvironmentDefaults } from "@outfitter/config";
+*
+* const env = getEnvironment(); // "development" | "production" | "test"
+* const defaults = getEnvironmentDefaults(env);
+*
+* if (defaults.verbose) {
+*   console.log("Verbose mode enabled");
+* }
+* ```
+*
+* @module
+*/
+/**
+* Valid Outfitter environment names.
+*
+* - `"development"` — Local development with verbose output and debug logging
+* - `"production"` — Production deployments with minimal output
+* - `"test"` — Test runs with full error detail but no logging
+*/
+type OutfitterEnv = "development" | "production" | "test";
+/**
+* Profile-specific defaults for an environment.
+*
+* These defaults provide sensible starting values that individual
+* packages can override or extend.
+*/
+interface EnvironmentDefaults {
+	/** Default log level. `null` means logging is disabled by default. */
+	logLevel: "debug" | "info" | "warn" | "error" | null;
+	/** Whether verbose output is enabled by default. */
+	verbose: boolean;
+	/** How much error detail to include in output. */
+	errorDetail: "full" | "message";
+}
+/**
+* Determine the current Outfitter environment.
+*
+* Reads the `OUTFITTER_ENV` environment variable. If set to a valid
+* value (`"development"`, `"production"`, or `"test"`), returns that
+* value. Otherwise falls back to `"production"`.
+*
+* @returns The current environment
+*
+* @example
+* ```typescript
+* // With OUTFITTER_ENV=development
+* getEnvironment(); // "development"
+*
+* // With OUTFITTER_ENV unset or invalid
+* getEnvironment(); // "production"
+* ```
+*/
+declare function getEnvironment(): OutfitterEnv;
+/**
+* Get the default settings for an environment profile.
+*
+* Returns a shallow copy of the defaults for the given environment.
+* These defaults are intended as starting values that individual
+* packages can override via their own configuration.
+*
+* | Setting | `development` | `production` | `test` |
+* |---------|--------------|-------------|--------|
+* | logLevel | `"debug"` | `null` | `null` |
+* | verbose | `true` | `false` | `false` |
+* | errorDetail | `"full"` | `"message"` | `"full"` |
+*
+* @param env - The environment to get defaults for
+* @returns Profile-specific default settings
+*
+* @example
+* ```typescript
+* const defaults = getEnvironmentDefaults("development");
+* // { logLevel: "debug", verbose: true, errorDetail: "full" }
+*
+* const prodDefaults = getEnvironmentDefaults("production");
+* // { logLevel: null, verbose: false, errorDetail: "message" }
+* ```
+*/
+declare function getEnvironmentDefaults(env: OutfitterEnv): EnvironmentDefaults;
+export { OutfitterEnv, EnvironmentDefaults, getEnvironment, getEnvironmentDefaults };

package/dist/shared/@outfitter/config-veqxf02x.d.ts

@@ -0,0 +1,143 @@
+import { z } from "zod";
+/**
+* Port number schema (1-65535) with string-to-number coercion.
+*
+* Validates that a string contains only digits, then transforms
+* to a number and validates the port range.
+*
+* @example
+* ```typescript
+* const schema = z.object({ PORT: portSchema });
+* schema.parse({ PORT: "3000" }); // { PORT: 3000 }
+* schema.parse({ PORT: "invalid" }); // throws
+* schema.parse({ PORT: "99999" }); // throws (out of range)
+* ```
+*/
+declare const portSchema: z.ZodType<number, string>;
+/**
+* Boolean schema with proper string coercion.
+*
+* Accepts: "true", "false", "1", "0", ""
+* - "true" or "1" -> true
+* - "false", "0", or "" -> false
+*
+* @example
+* ```typescript
+* const schema = z.object({ DEBUG: booleanSchema });
+* schema.parse({ DEBUG: "true" }); // { DEBUG: true }
+* schema.parse({ DEBUG: "1" }); // { DEBUG: true }
+* schema.parse({ DEBUG: "false" }); // { DEBUG: false }
+* schema.parse({ DEBUG: "" }); // { DEBUG: false }
+* ```
+*/
+declare const booleanSchema: z.ZodType<boolean, string>;
+/**
+* Optional boolean schema - returns undefined if not set.
+*
+* Unlike `booleanSchema`, this returns `undefined` for missing
+* or empty values, allowing callers to distinguish between
+* "explicitly set to false" and "not set".
+*
+* @example
+* ```typescript
+* const schema = z.object({ NO_COLOR: optionalBooleanSchema });
+* schema.parse({ NO_COLOR: "true" }); // { NO_COLOR: true }
+* schema.parse({ NO_COLOR: "" }); // { NO_COLOR: undefined }
+* schema.parse({ NO_COLOR: undefined }); // { NO_COLOR: undefined }
+* ```
+*/
+declare const optionalBooleanSchema: z.ZodType<boolean | undefined, string | undefined>;
+/**
+* Parse and validate environment variables against a Zod schema.
+*
+* By default reads from `process.env`, but accepts a custom env
+* object for testing.
+*
+* @typeParam T - The Zod schema shape
+* @param schema - Zod object schema to validate against
+* @param envObj - Environment object (defaults to process.env)
+* @returns Validated and transformed environment object
+* @throws {z.ZodError} When validation fails
+*
+* @example
+* ```typescript
+* const AppEnv = z.object({
+*   PORT: portSchema,
+*   DEBUG: booleanSchema,
+* });
+*
+* const env = parseEnv(AppEnv);
+* console.log(env.PORT); // number
+* console.log(env.DEBUG); // boolean
+* ```
+*/
+declare function parseEnv<T extends z.ZodRawShape>(schema: z.ZodObject<T>, envObj?: Record<string, string | undefined>): z.infer<z.ZodObject<T>>;
+type AppEnvShape = {
+	NODE_ENV: z.ZodDefault<z.ZodEnum<{
+		development: "development";
+		test: "test";
+		production: "production";
+	}>>;
+	NO_COLOR: typeof optionalBooleanSchema;
+	FORCE_COLOR: typeof optionalBooleanSchema;
+	CI: typeof optionalBooleanSchema;
+	TERM: z.ZodOptional<z.ZodString>;
+	XDG_CONFIG_HOME: z.ZodOptional<z.ZodString>;
+	XDG_DATA_HOME: z.ZodOptional<z.ZodString>;
+	XDG_STATE_HOME: z.ZodOptional<z.ZodString>;
+	XDG_CACHE_HOME: z.ZodOptional<z.ZodString>;
+	HOME: z.ZodOptional<z.ZodString>;
+};
+/**
+* Schema for common application environment variables.
+*/
+declare const appEnvSchema: z.ZodObject<AppEnvShape>;
+/**
+* Type for the pre-parsed application environment.
+*/
+type Env = z.infer<typeof appEnvSchema>;
+/**
+* Pre-parsed application environment.
+*
+* Access common environment variables with proper typing:
+* - `env.NODE_ENV`: "development" | "test" | "production"
+* - `env.NO_COLOR`: boolean | undefined
+* - `env.FORCE_COLOR`: boolean | undefined
+* - `env.CI`: boolean | undefined
+* - `env.TERM`: string | undefined
+* - `env.XDG_*`: string | undefined
+* - `env.HOME`: string | undefined
+*
+* @example
+* ```typescript
+* import { env } from "@outfitter/config";
+*
+* if (env.CI) {
+*   console.log("Running in CI environment");
+* }
+*
+* if (env.NO_COLOR) {
+*   // Disable color output
+* }
+* ```
+*/
+declare const env: Env;
+/**
+* Reads an optional boolean from process.env at call time.
+*
+* Unlike `env.NO_COLOR` (which is static), this reads dynamically
+* for use cases where env vars may change at runtime (e.g., tests).
+*
+* @param key - The environment variable name to read
+* @returns `true` if "true"/"1", `false` if "false"/"0", `undefined` otherwise
+*
+* @example
+* ```typescript
+* // For terminal detection that needs dynamic behavior
+* if (getEnvBoolean("NO_COLOR")) {
+*   // colors disabled
+* }
+* ```
+*/
+declare function getEnvBoolean(key: "NO_COLOR" | "FORCE_COLOR" | "CI"): boolean | undefined;
+export { portSchema, booleanSchema, optionalBooleanSchema, parseEnv, Env, env, getEnvBoolean };

package/dist/shared/@outfitter/config-w3pwcpr2.js

@@ -0,0 +1,36 @@
+// @bun
+// packages/config/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] };
+}
+
+export { getEnvironment, getEnvironmentDefaults };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@outfitter/config",
   "description": "XDG-compliant config loading with schema validation for Outfitter",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "type": "module",
   "files": [
     "dist"
@@ -9,12 +9,6 @@
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {
-    "./environment": {
-      "import": {
-        "types": "./dist/environment.d.ts",
-        "default": "./dist/environment.js"
-      }
-    },
     ".": {
       "import": {
         "types": "./dist/index.d.ts",
@@ -27,6 +21,12 @@
         "default": "./dist/env.js"
       }
     },
+    "./environment": {
+      "import": {
+        "types": "./dist/environment.d.ts",
+        "default": "./dist/environment.js"
+      }
+    },
     "./package.json": "./package.json"
   },
   "sideEffects": false,
@@ -39,8 +39,8 @@
     "clean": "rm -rf dist"
   },
   "dependencies": {
-    "@outfitter/contracts": "0.2.0",
-    "@outfitter/types": "0.2.0",
+    "@outfitter/contracts": "0.4.0",
+    "@outfitter/types": "0.2.2",
     "zod": "^4.3.5"
   },
   "devDependencies": {