@rocicorp/zero 0.25.0 → 0.26.0-canary.0

package/out/shared/src/must.js

@@ -1,8 +1,10 @@
-export function must(v, msg) {
-    // oxlint-disable-next-line eqeqeq
-    if (v == null) {
-        throw new Error(msg ?? `Unexpected ${v} value`);
-    }
-    return v;
+function must(v, msg) {
+  if (v == null) {
+    throw new Error(msg ?? `Unexpected ${v} value`);
+  }
+  return v;
 }
-//# sourceMappingURL=must.js.map
+export {
+  must
+};
+//# sourceMappingURL=must.js.map

package/out/shared/src/must.js.map

@@ -1 +1 @@
-{"version":3,"file":"must.js","sourceRoot":"","sources":["../../../../shared/src/must.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,IAAI,CAAI,CAAuB,EAAE,GAAY;IAC3D,kCAAkC;IAClC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,cAAc,CAAC,QAAQ,CAAC,CAAC;IAClD,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC"}
+{"version":3,"file":"must.js","sources":["../../../../shared/src/must.ts"],"sourcesContent":["export function must<T>(v: T | undefined | null, msg?: string): T {\n  // oxlint-disable-next-line eqeqeq\n  if (v == null) {\n    throw new Error(msg ?? `Unexpected ${v} value`);\n  }\n  return v;\n}\n"],"names":[],"mappings":"AAAO,SAAS,KAAQ,GAAyB,KAAiB;AAEhE,MAAI,KAAK,MAAM;AACb,UAAM,IAAI,MAAM,OAAO,cAAc,CAAC,QAAQ;AAAA,EAChD;AACA,SAAO;AACT;"}

package/out/shared/src/navigator.js

@@ -0,0 +1,5 @@
+const localNavigator = typeof navigator !== "undefined" ? navigator : void 0;
+export {
+  localNavigator as navigator
+};
+//# sourceMappingURL=navigator.js.map

package/out/shared/src/navigator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"navigator.js","sources":["../../../../shared/src/navigator.ts"],"sourcesContent":["type Navigator = {\n  onLine: boolean;\n  userAgent: string;\n  // add more as needed\n};\n\nconst localNavigator: Navigator | undefined =\n  typeof navigator !== 'undefined' ? navigator : undefined;\n\nexport {localNavigator as navigator};\n"],"names":[],"mappings":"AAMA,MAAM,iBACJ,OAAO,cAAc,cAAc,YAAY;"}

package/out/shared/src/object-traversal.d.ts

@@ -0,0 +1,19 @@
+type Split<S extends string, Sep extends string> = S extends `${infer Head}${Sep}${infer Tail}` ? [Head, ...Split<Tail, Sep>] : S extends '' ? [] : [S];
+type GetAtPath<T, Parts extends readonly string[]> = Parts extends readonly [
+    infer Head extends string,
+    ...infer Tail extends readonly string[]
+] ? Head extends keyof T ? GetAtPath<T[Head], Tail> : undefined : T;
+type ValueAtPath<Path extends string, T, Sep extends string> = GetAtPath<T, Split<Path, Sep>>;
+export declare function getValueAtPath(obj: object, path: string, sep: RegExp): unknown;
+export declare function getValueAtPath<const Path extends string, const T extends object, const Sep extends string>(obj: T, path: Path, sep: Sep): ValueAtPath<Path, T, Sep>;
+/**
+ * Recursively iterates over all leaf values in a nested object tree.
+ * A value is considered a leaf if `isLeaf(value)` returns true,
+ * or if it's not a plain object.
+ *
+ * @param obj - The object to iterate over
+ * @param isLeaf - A function that returns true if a value should be yielded as a leaf
+ */
+export declare function iterateLeaves<T>(obj: object, isLeaf: (value: unknown) => value is T): Iterable<T>;
+export {};
+//# sourceMappingURL=object-traversal.d.ts.map

package/out/shared/src/object-traversal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"object-traversal.d.ts","sourceRoot":"","sources":["../../../../shared/src/object-traversal.ts"],"names":[],"mappings":"AAAA,KAAK,KAAK,CACR,CAAC,SAAS,MAAM,EAChB,GAAG,SAAS,MAAM,IAChB,CAAC,SAAS,GAAG,MAAM,IAAI,GAAG,GAAG,GAAG,MAAM,IAAI,EAAE,GAC5C,CAAC,IAAI,EAAE,GAAG,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,GAC3B,CAAC,SAAS,EAAE,GACV,EAAE,GACF,CAAC,CAAC,CAAC,CAAC;AAEV,KAAK,SAAS,CAAC,CAAC,EAAE,KAAK,SAAS,SAAS,MAAM,EAAE,IAAI,KAAK,SAAS,SAAS;IAC1E,MAAM,IAAI,SAAS,MAAM;IACzB,GAAG,MAAM,IAAI,SAAS,SAAS,MAAM,EAAE;CACxC,GACG,IAAI,SAAS,MAAM,CAAC,GAClB,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,GACxB,SAAS,GACX,CAAC,CAAC;AAEN,KAAK,WAAW,CAAC,IAAI,SAAS,MAAM,EAAE,CAAC,EAAE,GAAG,SAAS,MAAM,IAAI,SAAS,CACtE,CAAC,EACD,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CACjB,CAAC;AAEF,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;AAChF,wBAAgB,cAAc,CAC5B,KAAK,CAAC,IAAI,SAAS,MAAM,EACzB,KAAK,CAAC,CAAC,SAAS,MAAM,EACtB,KAAK,CAAC,GAAG,SAAS,MAAM,EACxB,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;AAkB3D;;;;;;;GAOG;AACH,wBAAiB,aAAa,CAAC,CAAC,EAC9B,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,GACrC,QAAQ,CAAC,CAAC,CAAC,CASb"}

package/out/shared/src/object-traversal.js

@@ -0,0 +1,27 @@
+function getValueAtPath(obj, path, sep) {
+  const parts = path.split(sep);
+  let current = obj;
+  for (const part of parts) {
+    if (current && typeof current === "object" && part in current) {
+      current = current[part];
+    } else {
+      return void 0;
+    }
+  }
+  return current;
+}
+function* iterateLeaves(obj, isLeaf) {
+  for (const key of Object.keys(obj)) {
+    const value = obj[key];
+    if (isLeaf(value)) {
+      yield value;
+    } else if (value && typeof value === "object") {
+      yield* iterateLeaves(value, isLeaf);
+    }
+  }
+}
+export {
+  getValueAtPath,
+  iterateLeaves
+};
+//# sourceMappingURL=object-traversal.js.map

package/out/shared/src/object-traversal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"object-traversal.js","sources":["../../../../shared/src/object-traversal.ts"],"sourcesContent":["type Split<\n  S extends string,\n  Sep extends string,\n> = S extends `${infer Head}${Sep}${infer Tail}`\n  ? [Head, ...Split<Tail, Sep>]\n  : S extends ''\n    ? []\n    : [S];\n\ntype GetAtPath<T, Parts extends readonly string[]> = Parts extends readonly [\n  infer Head extends string,\n  ...infer Tail extends readonly string[],\n]\n  ? Head extends keyof T\n    ? GetAtPath<T[Head], Tail>\n    : undefined\n  : T;\n\ntype ValueAtPath<Path extends string, T, Sep extends string> = GetAtPath<\n  T,\n  Split<Path, Sep>\n>;\n\nexport function getValueAtPath(obj: object, path: string, sep: RegExp): unknown;\nexport function getValueAtPath<\n  const Path extends string,\n  const T extends object,\n  const Sep extends string,\n>(obj: T, path: Path, sep: Sep): ValueAtPath<Path, T, Sep>;\nexport function getValueAtPath(\n  obj: object,\n  path: string,\n  sep: string | RegExp,\n): unknown {\n  const parts = path.split(sep);\n  let current: unknown = obj;\n  for (const part of parts) {\n    if (current && typeof current === 'object' && part in current) {\n      current = (current as Record<string, unknown>)[part];\n    } else {\n      return undefined;\n    }\n  }\n  return current;\n}\n\n/**\n * Recursively iterates over all leaf values in a nested object tree.\n * A value is considered a leaf if `isLeaf(value)` returns true,\n * or if it's not a plain object.\n *\n * @param obj - The object to iterate over\n * @param isLeaf - A function that returns true if a value should be yielded as a leaf\n */\nexport function* iterateLeaves<T>(\n  obj: object,\n  isLeaf: (value: unknown) => value is T,\n): Iterable<T> {\n  for (const key of Object.keys(obj)) {\n    const value = (obj as Record<string, unknown>)[key];\n    if (isLeaf(value)) {\n      yield value;\n    } else if (value && typeof value === 'object') {\n      yield* iterateLeaves(value, isLeaf);\n    }\n  }\n}\n"],"names":[],"mappings":"AA6BO,SAAS,eACd,KACA,MACA,KACS;AACT,QAAM,QAAQ,KAAK,MAAM,GAAG;AAC5B,MAAI,UAAmB;AACvB,aAAW,QAAQ,OAAO;AACxB,QAAI,WAAW,OAAO,YAAY,YAAY,QAAQ,SAAS;AAC7D,gBAAW,QAAoC,IAAI;AAAA,IACrD,OAAO;AACL,aAAO;AAAA,IACT;AAAA,EACF;AACA,SAAO;AACT;AAUO,UAAU,cACf,KACA,QACa;AACb,aAAW,OAAO,OAAO,KAAK,GAAG,GAAG;AAClC,UAAM,QAAS,IAAgC,GAAG;AAClD,QAAI,OAAO,KAAK,GAAG;AACjB,YAAM;AAAA,IACR,WAAW,SAAS,OAAO,UAAU,UAAU;AAC7C,aAAO,cAAc,OAAO,MAAM;AAAA,IACpC;AAAA,EACF;AACF;"}

package/out/shared/src/objects.js

@@ -1,25 +1,24 @@
-export function mapValues(input, mapper) {
-    return mapEntries(input, (k, v) => [k, mapper(v)]);
+function mapValues(input, mapper) {
+  return mapEntries(input, (k, v) => [k, mapper(v)]);
 }
-export function mapEntries(input, mapper) {
-    // Direct assignment is faster than Object.fromEntries()
-    // https://github.com/rocicorp/mono/pull/3927#issuecomment-2706059475
-    const output = {};
-    // In chrome Object.entries is faster than for-in (13x) or Object.keys (15x)
-    // https://gist.github.com/arv/1b4e113724f6a14e2d4742bcc760d1fa
-    for (const entry of Object.entries(input)) {
-        const mapped = mapper(entry[0], entry[1]);
-        output[mapped[0]] = mapped[1];
-    }
-    return output;
+function mapEntries(input, mapper) {
+  const output = {};
+  for (const entry of Object.entries(input)) {
+    const mapped = mapper(entry[0], entry[1]);
+    output[mapped[0]] = mapped[1];
+  }
+  return output;
 }
-export function mapAllEntries(input, mapper) {
-    // Direct assignment is faster than Object.fromEntries()
-    // https://github.com/rocicorp/mono/pull/3927#issuecomment-2706059475
-    const output = {};
-    for (const mapped of mapper(Object.entries(input))) {
-        output[mapped[0]] = mapped[1];
-    }
-    return output;
+function mapAllEntries(input, mapper) {
+  const output = {};
+  for (const mapped of mapper(Object.entries(input))) {
+    output[mapped[0]] = mapped[1];
+  }
+  return output;
 }
-//# sourceMappingURL=objects.js.map
+export {
+  mapAllEntries,
+  mapEntries,
+  mapValues
+};
+//# sourceMappingURL=objects.js.map

package/out/shared/src/objects.js.map

@@ -1 +1 @@
-{"version":3,"file":"objects.js","sourceRoot":"","sources":["../../../../shared/src/objects.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,SAAS,CACvB,KAAQ,EACR,MAAgC;IAEhC,OAAO,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAe,CAAC,CAAC,CAE9D,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,UAAU,CACxB,KAAwB,EACxB,MAAsD;IAEtD,wDAAwD;IACxD,qEAAqE;IACrE,MAAM,MAAM,GAAsB,EAAE,CAAC;IAErC,4EAA4E;IAC5E,+DAA+D;IAC/D,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1C,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1C,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAChC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,aAAa,CAC3B,KAAwB,EACxB,MAAqE;IAErE,wDAAwD;IACxD,qEAAqE;IACrE,MAAM,MAAM,GAAsB,EAAE,CAAC;IACrC,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QACnD,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAChC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}
+{"version":3,"file":"objects.js","sources":["../../../../shared/src/objects.ts"],"sourcesContent":["export function mapValues<T extends Record<string, unknown>, U>(\n  input: T,\n  mapper: (value: T[keyof T]) => U,\n): {[K in keyof T]: U} {\n  return mapEntries(input, (k, v) => [k, mapper(v as T[keyof T])]) as {\n    [K in keyof T]: U;\n  };\n}\n\nexport function mapEntries<T, U>(\n  input: Record<string, T>,\n  mapper: (key: string, val: T) => [key: string, val: U],\n): Record<string, U> {\n  // Direct assignment is faster than Object.fromEntries()\n  // https://github.com/rocicorp/mono/pull/3927#issuecomment-2706059475\n  const output: Record<string, U> = {};\n\n  // In chrome Object.entries is faster than for-in (13x) or Object.keys (15x)\n  // https://gist.github.com/arv/1b4e113724f6a14e2d4742bcc760d1fa\n  for (const entry of Object.entries(input)) {\n    const mapped = mapper(entry[0], entry[1]);\n    output[mapped[0]] = mapped[1];\n  }\n  return output;\n}\n\nexport function mapAllEntries<T, U>(\n  input: Record<string, T>,\n  mapper: (entries: [key: string, val: T][]) => [key: string, val: U][],\n): Record<string, U> {\n  // Direct assignment is faster than Object.fromEntries()\n  // https://github.com/rocicorp/mono/pull/3927#issuecomment-2706059475\n  const output: Record<string, U> = {};\n  for (const mapped of mapper(Object.entries(input))) {\n    output[mapped[0]] = mapped[1];\n  }\n  return output;\n}\n"],"names":[],"mappings":"AAAO,SAAS,UACd,OACA,QACqB;AACrB,SAAO,WAAW,OAAO,CAAC,GAAG,MAAM,CAAC,GAAG,OAAO,CAAe,CAAC,CAAC;AAGjE;AAEO,SAAS,WACd,OACA,QACmB;AAGnB,QAAM,SAA4B,CAAA;AAIlC,aAAW,SAAS,OAAO,QAAQ,KAAK,GAAG;AACzC,UAAM,SAAS,OAAO,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC;AACxC,WAAO,OAAO,CAAC,CAAC,IAAI,OAAO,CAAC;AAAA,EAC9B;AACA,SAAO;AACT;AAEO,SAAS,cACd,OACA,QACmB;AAGnB,QAAM,SAA4B,CAAA;AAClC,aAAW,UAAU,OAAO,OAAO,QAAQ,KAAK,CAAC,GAAG;AAClD,WAAO,OAAO,CAAC,CAAC,IAAI,OAAO,CAAC;AAAA,EAC9B;AACA,SAAO;AACT;"}

package/out/shared/src/options-types.d.ts

@@ -0,0 +1,113 @@
+import type * as v from './valita.ts';
+type RequiredOptionType = v.Type<string> | v.Type<number> | v.Type<boolean> | v.Type<string[]> | v.Type<number[]> | v.Type<boolean[]>;
+type OptionalOptionType = v.Optional<string> | v.Optional<number> | v.Optional<boolean> | v.Optional<string[]> | v.Optional<number[]> | v.Optional<boolean[]>;
+type OptionType = RequiredOptionType | OptionalOptionType;
+export type WrappedOptionType = {
+    type: OptionType;
+    /** Description lines to be displayed in --help. */
+    desc?: string[];
+    /** Logged as a warning when parsed. */
+    deprecated?: string[];
+    /** One-character alias for getopt-style short flags, e.g. -m */
+    alias?: string;
+    /**
+     * Exclude this flag from --help text. Used for internal flags.
+     * Deprecated options are hidden by default.
+     */
+    hidden?: boolean;
+};
+export type Option = OptionType | WrappedOptionType;
+export type Group = Record<string, Option>;
+/**
+ * # Options
+ *
+ * An `Options` object specifies of a set of (possibly grouped) configuration
+ * values that are parsed from environment variables and/or command line flags.
+ *
+ * Each option is represented by a `valita` schema object. The `Options`
+ * type supports one level of grouping for organizing related options.
+ *
+ * ```ts
+ * {
+ *   port: v.number().default(8080),
+ *
+ *   numWorkers: v.number(),
+ *
+ *   log: {
+ *     level: v.union(v.literal('debug'), v.literal('info'), ...),
+ *     format: v.union(v.literal('text'), v.literal('json')).default('text'),
+ *   }
+ * }
+ * ```
+ *
+ * {@link parseOptions()} will use an `Options` object to populate a {@link Config}
+ * instance of the corresponding shape, consulting SNAKE_CASE environment variables
+ * and/or camelCase command line flags, with flags taking precedence, based on the field
+ * (and group) names:
+ *
+ * | Option          | Flag          | Env         |
+ * | --------------  | ------------- | ----------- |
+ * | port            | --port        | PORT        |
+ * | numWorkers      | --num-workers | NUM_WORKERS |
+ * | log: { level }  | --log-level   | LOG_LEVEL   |
+ * | log: { format } | --log-format  | LOG_FORMAT  |
+ *
+ * `Options` supports:
+ * * primitive valita types `string`, `number`, `boolean`
+ * * single-type arrays or tuples of primitives
+ * * optional values
+ * * default values
+ *
+ * ### Additional Flag Configuration
+ *
+ * {@link parseOptions()} will generate a usage guide that is displayed for
+ * the `--help` or `-h` flags, displaying the flag name, env name, value
+ * type (or enumeration), and default values based on the valita schema.
+ *
+ * For additional configuration, each object can instead by represented by
+ * a {@link WrappedOptionType}, where the valita schema is held in the `type`
+ * field, along with additional optional fields:
+ * * `desc` for documentation displayed in `--help`
+ * * `alias` for getopt-style short flags like `-m`
+ */
+export type Options = Record<string, Group | Option>;
+/** Unwrap the Value type from an Option<V>. */
+type ValueOf<T extends Option> = T extends v.Optional<infer V> ? V | undefined : T extends v.Type<infer V> ? V : T extends WrappedOptionType ? ValueOf<T['type']> : never;
+type Required = RequiredOptionType | (WrappedOptionType & {
+    type: RequiredOptionType;
+});
+type Optional = OptionalOptionType | (WrappedOptionType & {
+    type: OptionalOptionType;
+});
+type ConfigGroup<G extends Group> = {
+    [P in keyof G as G[P] extends Required ? P : never]: ValueOf<G[P]>;
+} & {
+    [P in keyof G as G[P] extends Optional ? P : never]?: ValueOf<G[P]>;
+};
+/**
+ * A Config is an object containing values parsed from an {@link Options} object.
+ *
+ * Example:
+ *
+ * ```ts
+ * {
+ *   port: number;
+ *
+ *   numWorkers: number;
+ *
+ *   // The "log" group
+ *   log: {
+ *     level: 'debug' | 'info' | 'warn' | 'error';
+ *     format: 'text' | 'json'
+ *   };
+ *   ...
+ * }
+ * ```
+ */
+export type Config<O extends Options> = {
+    [P in keyof O as O[P] extends Required | Group ? P : never]: O[P] extends Required ? ValueOf<O[P]> : O[P] extends Group ? ConfigGroup<O[P]> : never;
+} & {
+    [P in keyof O as O[P] extends Optional ? P : never]?: O[P] extends Optional ? ValueOf<O[P]> : never;
+};
+export {};
+//# sourceMappingURL=options-types.d.ts.map

package/out/shared/src/options-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"options-types.d.ts","sourceRoot":"","sources":["../../../../shared/src/options-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,CAAC,MAAM,aAAa,CAAC;AAEtC,KAAK,kBAAkB,GACnB,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,GACd,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,GACd,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GACf,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,GAChB,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,GAChB,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;AAEtB,KAAK,kBAAkB,GACnB,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,GAClB,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,GAClB,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,GACnB,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,GACpB,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,GACpB,CAAC,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;AAE1B,KAAK,UAAU,GAAG,kBAAkB,GAAG,kBAAkB,CAAC;AAE1D,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,UAAU,CAAC;IAEjB,mDAAmD;IACnD,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhB,uCAAuC;IACvC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IAEtB,gEAAgE;IAChE,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG,UAAU,GAAG,iBAAiB,CAAC;AAGpD,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,GAAG,MAAM,CAAC,CAAC;AAErD,+CAA+C;AAC/C,KAAK,OAAO,CAAC,CAAC,SAAS,MAAM,IAC3B,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,GACzB,CAAC,GAAG,SAAS,GACb,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GACvB,CAAC,GACD,CAAC,SAAS,iBAAiB,GACzB,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,GAClB,KAAK,CAAC;AAEhB,KAAK,QAAQ,GACT,kBAAkB,GAClB,CAAC,iBAAiB,GAAG;IAAC,IAAI,EAAE,kBAAkB,CAAA;CAAC,CAAC,CAAC;AACrD,KAAK,QAAQ,GACT,kBAAkB,GAClB,CAAC,iBAAiB,GAAG;IAAC,IAAI,EAAE,kBAAkB,CAAA;CAAC,CAAC,CAAC;AAGrD,KAAK,WAAW,CAAC,CAAC,SAAS,KAAK,IAAI;KACjC,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,GAAG,CAAC,GAAG,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACnE,GAAG;KAED,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACpE,CAAC;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,SAAS,OAAO,IAAI;KACrC,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,GAAG,KAAK,GAC1C,CAAC,GACD,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,GAC7B,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACb,CAAC,CAAC,CAAC,CAAC,SAAS,KAAK,GAChB,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACjB,KAAK;CACZ,GAAG;KAED,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,GACvE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACb,KAAK;CACV,CAAC"}

package/out/shared/src/options.d.ts

@@ -1,115 +1,7 @@
 import type { OptionalLogger } from '@rocicorp/logger';
+import type { Config, Group, Option, Options, WrappedOptionType } from './options-types.ts';
 import * as v from './valita.ts';
-type RequiredOptionType = v.Type<string> | v.Type<number> | v.Type<boolean> | v.Type<string[]> | v.Type<number[]> | v.Type<boolean[]>;
-type OptionalOptionType = v.Optional<string> | v.Optional<number> | v.Optional<boolean> | v.Optional<string[]> | v.Optional<number[]> | v.Optional<boolean[]>;
-type OptionType = RequiredOptionType | OptionalOptionType;
-export type WrappedOptionType = {
-    type: OptionType;
-    /** Description lines to be displayed in --help. */
-    desc?: string[];
-    /** Logged as a warning when parsed. */
-    deprecated?: string[];
-    /** One-character alias for getopt-style short flags, e.g. -m */
-    alias?: string;
-    /**
-     * Exclude this flag from --help text. Used for internal flags.
-     * Deprecated options are hidden by default.
-     */
-    hidden?: boolean;
-};
-export type Option = OptionType | WrappedOptionType;
-export type Group = Record<string, Option>;
-/**
- * # Options
- *
- * An `Options` object specifies of a set of (possibly grouped) configuration
- * values that are parsed from environment variables and/or command line flags.
- *
- * Each option is represented by a `valita` schema object. The `Options`
- * type supports one level of grouping for organizing related options.
- *
- * ```ts
- * {
- *   port: v.number().default(8080),
- *
- *   numWorkers: v.number(),
- *
- *   log: {
- *     level: v.union(v.literal('debug'), v.literal('info'), ...),
- *     format: v.union(v.literal('text'), v.literal('json')).default('text'),
- *   }
- * }
- * ```
- *
- * {@link parseOptions()} will use an `Options` object to populate a {@link Config}
- * instance of the corresponding shape, consulting SNAKE_CASE environment variables
- * and/or camelCase command line flags, with flags taking precedence, based on the field
- * (and group) names:
- *
- * | Option          | Flag          | Env         |
- * | --------------  | ------------- | ----------- |
- * | port            | --port        | PORT        |
- * | numWorkers      | --num-workers | NUM_WORKERS |
- * | log: { level }  | --log-level   | LOG_LEVEL   |
- * | log: { format } | --log-format  | LOG_FORMAT  |
- *
- * `Options` supports:
- * * primitive valita types `string`, `number`, `boolean`
- * * single-type arrays or tuples of primitives
- * * optional values
- * * default values
- *
- * ### Additional Flag Configuration
- *
- * {@link parseOptions()} will generate a usage guide that is displayed for
- * the `--help` or `-h` flags, displaying the flag name, env name, value
- * type (or enumeration), and default values based on the valita schema.
- *
- * For additional configuration, each object can instead by represented by
- * a {@link WrappedOptionType}, where the valita schema is held in the `type`
- * field, along with additional optional fields:
- * * `desc` for documentation displayed in `--help`
- * * `alias` for getopt-style short flags like `-m`
- */
-export type Options = Record<string, Group | Option>;
-/** Unwrap the Value type from an Option<V>. */
-type ValueOf<T extends Option> = T extends v.Optional<infer V> ? V | undefined : T extends v.Type<infer V> ? V : T extends WrappedOptionType ? ValueOf<T['type']> : never;
-type Required = RequiredOptionType | (WrappedOptionType & {
-    type: RequiredOptionType;
-});
-type Optional = OptionalOptionType | (WrappedOptionType & {
-    type: OptionalOptionType;
-});
-type ConfigGroup<G extends Group> = {
-    [P in keyof G as G[P] extends Required ? P : never]: ValueOf<G[P]>;
-} & {
-    [P in keyof G as G[P] extends Optional ? P : never]?: ValueOf<G[P]>;
-};
-/**
- * A Config is an object containing values parsed from an {@link Options} object.
- *
- * Example:
- *
- * ```ts
- * {
- *   port: number;
- *
- *   numWorkers: number;
- *
- *   // The "log" group
- *   log: {
- *     level: 'debug' | 'info' | 'warn' | 'error';
- *     format: 'text' | 'json'
- *   };
- *   ...
- * }
- * ```
- */
-export type Config<O extends Options> = {
-    [P in keyof O as O[P] extends Required | Group ? P : never]: O[P] extends Required ? ValueOf<O[P]> : O[P] extends Group ? ConfigGroup<O[P]> : never;
-} & {
-    [P in keyof O as O[P] extends Optional ? P : never]?: O[P] extends Optional ? ValueOf<O[P]> : never;
-};
+export type { Config, Group, Option, Options, WrappedOptionType };
 /**
  * Converts an Options instance into an "env schema", which is an object with
  * ENV names as its keys, mapped to optional or required string values
@@ -137,6 +29,8 @@ export type ParseOptions = {
     env?: NodeJS.ProcessEnv;
     /** Defaults to `true`. */
     emitDeprecationWarnings?: boolean;
+    /** Defaults to `true`. When false, excludes default values from both config and env return values. */
+    includeDefaults?: boolean;
     /** Defaults to `console` */
     logger?: OptionalLogger;
     /** Defaults to `process.exit` */
@@ -149,5 +43,4 @@ export declare function parseOptionsAdvanced<T extends Options>(appOptions: T, o
     unknown?: string[];
 };
 export declare function parseBoolean(optionName: string, input: string): boolean;
-export {};
 //# sourceMappingURL=options.d.ts.map

package/out/shared/src/options.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../../../shared/src/options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,kBAAkB,CAAC;AAUrD,OAAO,KAAK,CAAC,MAAM,aAAa,CAAC;AAKjC,KAAK,kBAAkB,GACnB,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,GACd,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,GACd,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GACf,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,GAChB,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,GAChB,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;AAEtB,KAAK,kBAAkB,GACnB,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,GAClB,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,GAClB,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,GACnB,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,GACpB,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,GACpB,CAAC,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;AAE1B,KAAK,UAAU,GAAG,kBAAkB,GAAG,kBAAkB,CAAC;AAE1D,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,UAAU,CAAC;IAEjB,mDAAmD;IACnD,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhB,uCAAuC;IACvC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IAEtB,gEAAgE;IAChE,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG,UAAU,GAAG,iBAAiB,CAAC;AAGpD,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,GAAG,MAAM,CAAC,CAAC;AAErD,+CAA+C;AAC/C,KAAK,OAAO,CAAC,CAAC,SAAS,MAAM,IAC3B,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,GACzB,CAAC,GAAG,SAAS,GACb,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GACvB,CAAC,GACD,CAAC,SAAS,iBAAiB,GACzB,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,GAClB,KAAK,CAAC;AAEhB,KAAK,QAAQ,GACT,kBAAkB,GAClB,CAAC,iBAAiB,GAAG;IAAC,IAAI,EAAE,kBAAkB,CAAA;CAAC,CAAC,CAAC;AACrD,KAAK,QAAQ,GACT,kBAAkB,GAClB,CAAC,iBAAiB,GAAG;IAAC,IAAI,EAAE,kBAAkB,CAAA;CAAC,CAAC,CAAC;AAGrD,KAAK,WAAW,CAAC,CAAC,SAAS,KAAK,IAAI;KACjC,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,GAAG,CAAC,GAAG,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACnE,GAAG;KAED,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACpE,CAAC;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,SAAS,OAAO,IAAI;KACrC,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,GAAG,KAAK,GAC1C,CAAC,GACD,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,GAC7B,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACb,CAAC,CAAC,CAAC,CAAC,SAAS,KAAK,GAChB,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACjB,KAAK;CACZ,GAAG;KAED,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,GACvE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACb,KAAK;CACV,CAAC;AA4DF;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,aAAa,SAAK;;cAgC1E;AAeD,MAAM,MAAM,YAAY,GAAG;IACzB,wCAAwC;IACxC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,WAAW,CAAC,EAAE;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAC,EAAE,CAAC;IAElD,0BAA0B;IAC1B,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,0BAA0B;IAC1B,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,iCAAiC;IACjC,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;IAExB,0BAA0B;IAC1B,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC,4BAA4B;IAC5B,MAAM,CAAC,EAAE,cAAc,CAAC;IAExB,iCAAiC;IACjC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,KAAK,KAAK,CAAC;CACjD,CAAC;AAEF,wBAAgB,YAAY,CAAC,CAAC,SAAS,OAAO,EAC5C,UAAU,EAAE,CAAC,EACb,IAAI,GAAE,YAAiB,GACtB,MAAM,CAAC,CAAC,CAAC,CAEX;AAED,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,OAAO,EACpD,UAAU,EAAE,CAAC,EACb,IAAI,GAAE,YAAiB,GACtB;IAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;CAAC,CAqKtE;AA6FD,wBAAgB,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,WAQ7D"}
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../../../shared/src/options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,kBAAkB,CAAC;AAUrD,OAAO,KAAK,EACV,MAAM,EACN,KAAK,EACL,MAAM,EACN,OAAO,EACP,iBAAiB,EAClB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,CAAC,MAAM,aAAa,CAAC;AAEjC,YAAY,EAAC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,EAAC,CAAC;AAiFhE;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,aAAa,SAAK;;cAgC1E;AAeD,MAAM,MAAM,YAAY,GAAG;IACzB,wCAAwC;IACxC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,WAAW,CAAC,EAAE;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAC,EAAE,CAAC;IAElD,0BAA0B;IAC1B,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,0BAA0B;IAC1B,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,iCAAiC;IACjC,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;IAExB,0BAA0B;IAC1B,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC,sGAAsG;IACtG,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,4BAA4B;IAC5B,MAAM,CAAC,EAAE,cAAc,CAAC;IAExB,iCAAiC;IACjC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,KAAK,KAAK,CAAC;CACjD,CAAC;AAEF,wBAAgB,YAAY,CAAC,CAAC,SAAS,OAAO,EAC5C,UAAU,EAAE,CAAC,EACb,IAAI,GAAE,YAAiB,GACtB,MAAM,CAAC,CAAC,CAAC,CAEX;AAED,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,OAAO,EACpD,UAAU,EAAE,CAAC,EACb,IAAI,GAAE,YAAiB,GACtB;IAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;CAAC,CA0KtE;AA6FD,wBAAgB,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,WAQ7D"}