@ominity/api-typescript 0.0.1

package/src/types/primitives.ts

@@ -0,0 +1,165 @@
+
+import * as z from "zod/v4";
+import { defaultToZeroValue } from "./default-to-zero-value.js";
+import { unrecognized } from "./unrecognized.js";
+
+export function string(): z.ZodType<string> {
+  return z.union([
+    z.string(),
+
+    // Null or undefined -> ""
+    zodDefaultToZeroValue(""),
+
+    // Any other value -> String(x)
+    z.pipe(z.any(), z.transform((x) => unrecognized(JSON.stringify(x)))),
+  ]);
+}
+
+export function boolean(): z.ZodType<boolean> {
+  return z.union([
+    z.boolean(),
+
+    // String "true" (case insensitive) -> true, "false" -> false
+    z.pipe(
+      z.string(),
+      z.transform((x, ctx) => {
+        const lower = x.toLowerCase();
+        if (lower === "true") return unrecognized(true);
+        if (lower === "false") return unrecognized(false);
+        ctx.issues.push({
+          input: x,
+          code: "invalid_type",
+          expected: "boolean",
+          received: "string",
+        });
+        return z.NEVER;
+      }),
+    ),
+
+    zodDefaultToZeroValue(false),
+  ]);
+}
+
+export function number(): z.ZodType<number> {
+  return z.union([
+    z.number(),
+
+    // String -> Number
+    z.pipe(
+      z.string(),
+      z.transform((x, ctx) => {
+        const num = Number(x);
+        if (isNaN(num)) {
+          ctx.issues.push({
+            input: x,
+            code: "invalid_type",
+            expected: "number",
+            received: "string",
+          });
+          return z.NEVER;
+        }
+        return unrecognized(num);
+      }),
+    ),
+
+    // Null or undefined -> 0
+    zodDefaultToZeroValue(0),
+  ]);
+}
+
+export function bigint(): z.ZodType<bigint> {
+  return z.union([
+    z.pipe(
+      z.string(),
+      z.transform((x, ctx) => {
+        try {
+          return BigInt(x);
+        } catch (error) {
+          ctx.issues.push({
+            input: x,
+            code: "invalid_type",
+            expected: "bigint",
+            received: "string",
+          });
+          return z.NEVER;
+        }
+      }),
+    ),
+    zodDefaultToZeroValue(0n),
+  ]);
+}
+
+export function date(): z.ZodType<Date> {
+  return z.union([
+    z.pipe(
+      z.pipe(
+        z.union([z.string(), zodDefaultToZeroValue(0)]),
+        z.transform((x) => new Date(x)),
+      ),
+      z.date(),
+    ),
+    z.pipe(
+      z.number(),
+      z.transform((x, ctx) => {
+        const date = new Date(x);
+        if (isNaN(date.getTime())) {
+          ctx.issues.push({
+            input: x,
+            code: "invalid_type",
+            expected: "date",
+            received: "number",
+          });
+          return z.NEVER;
+        }
+        return unrecognized(date);
+      }),
+    ),
+  ]);
+}
+
+export function literal<T extends string | number | boolean>(
+  value: T,
+): z.ZodType<T> {
+  return z.union([z.literal(value), zodDefaultToZeroValue(value)]);
+}
+
+export function literalBigInt<T extends bigint>(value: T): z.ZodType<T> {
+  return z.pipe(z.literal(String(value)), z.transform((x) => BigInt(x))) as any;
+}
+
+export function optional<T extends z.ZodType>(t: T) {
+  return z.union([
+    z.undefined(),
+
+    // Null -> undefined
+    z.pipe(z.null(), z.transform(() => unrecognized(undefined))),
+    t,
+  ]);
+}
+
+export function nullable<T extends z.ZodType>(t: T) {
+  return z.union([
+    z.null(),
+
+    // Undefined -> null
+    z.pipe(z.undefined(), z.transform(() => defaultToZeroValue(null))),
+    t,
+  ]);
+}
+
+function zodDefaultToZeroValue<T>(value: T): z.ZodType<T> {
+  return z.pipe(
+    z.any(),
+    z.transform((input, ctx) => {
+      if (input === undefined) return defaultToZeroValue(value);
+      if (input === null) return defaultToZeroValue(value);
+      ctx.issues.push({
+        input: input,
+        code: "invalid_type",
+        expected: "undefined",
+        received: "unknown",
+      });
+      return z.NEVER;
+    }),
+  );
+}

package/src/types/rfcdate.ts

@@ -0,0 +1,51 @@
+
+const dateRE = /^\d{4}-\d{2}-\d{2}$/;
+
+export class RFCDate {
+  private serialized: string;
+
+  /**
+   * Creates a new RFCDate instance using today's date.
+   */
+  static today(): RFCDate {
+    return new RFCDate(new Date());
+  }
+
+  /**
+   * Creates a new RFCDate instance using the provided input.
+   * If a string is used then in must be in the format YYYY-MM-DD.
+   *
+   * @param date A Date object or a date string in YYYY-MM-DD format
+   * @example
+   * new RFCDate("2022-01-01")
+   * @example
+   * new RFCDate(new Date())
+   */
+  constructor(date: Date | string) {
+    if (typeof date === "string" && !dateRE.test(date)) {
+      throw new RangeError(
+        "RFCDate: date strings must be in the format YYYY-MM-DD: " + date,
+      );
+    }
+
+    const value = new Date(date);
+    if (isNaN(+value)) {
+      throw new RangeError("RFCDate: invalid date provided: " + date);
+    }
+
+    this.serialized = value.toISOString().slice(0, "YYYY-MM-DD".length);
+    if (!dateRE.test(this.serialized)) {
+      throw new TypeError(
+        `RFCDate: failed to build valid date with given value: ${date} serialized to ${this.serialized}`,
+      );
+    }
+  }
+
+  toJSON(): string {
+    return this.toString();
+  }
+
+  toString(): string {
+    return this.serialized;
+  }
+}

package/src/types/smart-union.ts

@@ -0,0 +1,142 @@
+
+// Not needed if lax mode
+import * as z from "zod/v4";
+import { startCountingDefaultToZeroValue } from "./default-to-zero-value.js";
+import { RFCDate } from "./rfcdate.js";
+import { startCountingUnrecognized } from "./unrecognized.js";
+
+interface Candidate {
+  data: unknown;
+  /** Total number of fields in the parsed data */
+  fieldCount: number;
+  /** Number of fields which only matched due to lax parsing */
+  inexactCount: number;
+  /** Number of fields which defaulted to zero values */
+  zeroDefaultCount: number;
+}
+
+/**
+ * Smart union parser that tries all schemas and returns the best match
+ * based on the number of populated fields.
+ */
+export function smartUnion<
+  Options extends readonly [z.ZodType, z.ZodType, ...z.ZodType[]],
+>(
+  options: Options,
+): z.ZodType<z.output<Options[number]>, z.input<Options[number]>> {
+  return z.pipe(
+    z.unknown(),
+    z.transform((input, ctx) => {
+      const candidates: Candidate[] = [];
+      const errors: z.core.$ZodIssue[][] = options.map(() => []);
+
+      const parentUnrecognizedCtr = startCountingUnrecognized();
+      const parentZeroDefaultCtr = startCountingDefaultToZeroValue();
+
+      // Filter out invalid options
+      for (const [i, option] of options.entries()) {
+        const unrecognizedCtr = startCountingUnrecognized();
+        const zeroDefaultCtr = startCountingDefaultToZeroValue();
+        const result = option.safeParse(input);
+        const inexactCount = unrecognizedCtr.end();
+        const zeroDefaultCount = zeroDefaultCtr.end();
+        if (result.success) {
+          candidates.push({
+            data: result.data,
+            inexactCount,
+            zeroDefaultCount,
+            fieldCount: -1, // We'll count this later if needed
+          });
+          continue;
+        }
+        errors[i]!.push(...result.error.issues);
+      }
+
+      // No valid options
+      if (candidates.length === 0) {
+        parentUnrecognizedCtr.end(0);
+        parentZeroDefaultCtr.end(0);
+        ctx.issues.push({
+          input: input,
+          code: "invalid_union",
+          errors: errors,
+        });
+        return z.NEVER;
+      }
+
+      let best = candidates[0]!;
+
+      // Find the best option
+      for (const candidate of candidates) {
+        // Minor optimization to avoid counting fields if there's only one candidate
+        if (candidates.length > 1) {
+          candidate.fieldCount = countFieldsRecursive(candidate.data);
+        }
+        best = better(candidate, best);
+      }
+
+      // The cost of this union should be the cost of the best candidate not all the candidates
+      parentUnrecognizedCtr.end(best.inexactCount);
+      parentZeroDefaultCtr.end(best.zeroDefaultCount);
+
+      return best.data;
+    }),
+  ) as any;
+}
+
+function better(a: Candidate, b: Candidate): Candidate {
+  const actualFieldCountA = a.fieldCount - a.zeroDefaultCount;
+  const actualFieldCountB = b.fieldCount - b.zeroDefaultCount;
+  if (actualFieldCountA !== actualFieldCountB) {
+    return actualFieldCountA > actualFieldCountB ? a : b;
+  }
+  return a.inexactCount < b.inexactCount ? a : b;
+}
+
+/**
+ * Counts the number of fields in a parsed value recursively.
+ * @param `parsed` assumed to *not* contain cycles
+ * fieldCount: total number of fields found
+ * inexactCount: number of primitive values that are not unrecognized enum values
+ */
+function countFieldsRecursive(parsed: unknown): number {
+  let fieldCount = 0;
+
+  const queue: unknown[] = [parsed];
+  let index = 0;
+
+  while (index < queue.length) {
+    const value = queue[index++];
+    if (value === undefined) {
+      continue;
+    }
+
+    // Check if it's a primitive value
+    const type = typeof value;
+    if (
+      value === null
+      || type === "number"
+      || type === "string"
+      || type === "boolean"
+      || type === "bigint"
+      || value instanceof Date
+      || value instanceof RFCDate
+    ) {
+      fieldCount++;
+      continue;
+    }
+
+    // Handle arrays
+    if (Array.isArray(value)) {
+      queue.push(...value);
+      continue;
+    }
+
+    // Handle objects
+    if (type === "object") {
+      queue.push(...Object.values(value));
+    }
+  }
+
+  return fieldCount;
+}

package/src/types/streams.ts

@@ -0,0 +1,18 @@
+
+export function isReadableStream<T = Uint8Array>(
+  val: unknown,
+): val is ReadableStream<T> {
+  if (typeof val !== "object" || val === null) {
+    return false;
+  }
+
+  // Check for the presence of methods specific to ReadableStream
+  const stream = val as ReadableStream<Uint8Array>;
+
+  // ReadableStream has methods like getReader, cancel, and tee
+  return (
+    typeof stream.getReader === "function" &&
+    typeof stream.cancel === "function" &&
+    typeof stream.tee === "function"
+  );
+}

package/src/types/unrecognized.ts

@@ -0,0 +1,32 @@
+
+declare const __brand: unique symbol;
+export type Unrecognized<T> = T & { [__brand]: "unrecognized" };
+
+function unrecognized<T>(value: T): Unrecognized<T> {
+  globalCount++;
+  return value as Unrecognized<T>;
+}
+
+let globalCount = 0;
+let refCount = 0;
+export function startCountingUnrecognized() {
+  refCount++;
+  const start = globalCount;
+  return {
+    /**
+     * Ends counting and returns the delta.
+     * @param delta - If provided, only this amount is added to the parent counter
+     *   (used for nested unions where we only want to record the winning option's count).
+     *   If not provided, records all counts since start().
+     */
+    end: (delta?: number) => {
+      const count = globalCount - start;
+      // Reset globalCount back to start, then add only the specified delta
+      globalCount = start + (delta ?? count);
+      if (--refCount === 0) globalCount = 0;
+      return count;
+    },
+  };
+}
+
+export { unrecognized };

package/tsconfig.json

@@ -0,0 +1,40 @@
+{
+  "compilerOptions": {
+    "incremental": false,
+    "target": "ES2020",
+    "lib": ["ES2022", "DOM", "DOM.Iterable"],
+    "jsx": "react-jsx",
+
+    "module": "Node16",
+    "moduleResolution": "Node16",
+
+    "allowJs": true,
+
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "outDir": ".",
+    
+
+    // https://github.com/tsconfig/bases/blob/a1bf7c0fa2e094b068ca3e1448ca2ece4157977e/bases/strictest.json
+    "strict": true,
+    "allowUnusedLabels": false,
+    "allowUnreachableCode": false,
+    "exactOptionalPropertyTypes": true,
+    "useUnknownInCatchVariables": true,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noUncheckedIndexedAccess": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "isolatedModules": true,
+    "checkJs": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": ["src"],
+  "exclude": ["node_modules"]
+}