@joinremba/beacon 0.3.0 → 0.5.0

package/src/schema.ts

@@ -0,0 +1,56 @@
+import { z } from "zod";
+
+export interface SchemaField {
+  type?: string;
+  default?: unknown;
+  values?: readonly string[];
+}
+
+export function typeToSchema(field: SchemaField): z.ZodType<unknown> {
+  const type = field.type ?? "string";
+  let base: z.ZodType<unknown>;
+
+  switch (type) {
+    case "string":
+    case "host":
+      base = z.string();
+      break;
+    case "url":
+      base = z.string().url();
+      break;
+    case "number":
+      base = z.coerce.number();
+      break;
+    case "integer":
+      base = z.coerce.number().int();
+      break;
+    case "boolean":
+      base = z
+        .string()
+        .transform((v) => v === "true" || v === "1" || v === "yes")
+        .pipe(z.boolean());
+      break;
+    case "enum": {
+      const values = field.values;
+      if (!values || values.length === 0) {
+        throw new Error("Enum field must have values defined");
+      }
+      base = z.enum(values as [string, ...string[]]);
+      break;
+    }
+    case "port":
+      base = z.coerce.number().int().min(1).max(65535);
+      break;
+    case "email":
+      base = z.string().email();
+      break;
+    default:
+      base = z.string();
+  }
+
+  if (field.default !== undefined) {
+    base = base.default(field.default as string | number | boolean);
+  }
+
+  return base;
+}

package/src/types.ts

@@ -1,4 +1,5 @@
 import type { z } from "zod";
+import type { Client } from "@joinremba/core";
 
 export type FieldType =
   | "string"
@@ -40,11 +41,21 @@ export interface BeaconOptions {
   profiles?: Record<string, Record<string, SchemaEntry>>;
   features?: Record<string, FeatureGate>;
   killSwitches?: Record<string, boolean>;
+  client?: Client;
+}
+
+export interface EnsureOptions {
+  /** When true (default), throws ConfigValidationError for missing required vars.
+   *  When false, silently skips missing required vars — useful in test environments. */
+  strict?: boolean;
 }
 
 export interface Beacon {
-  ensure(): Beacon;
+  ensure(options?: EnsureOptions): Promise<Beacon>;
   get<T = unknown>(key: string): T;
+  /** Returns all validated entries as a flat key-value record.
+   *  Secrets are included — callers should redact as needed. */
+  getAll(): Record<string, unknown>;
   readonly secret: Record<string, boolean>;
   isEnabled(feature: string): boolean;
   isKilled(feature: string): boolean;