Merge pull request #538 from traversable/seed-algebra-type

optimize(*): optimizes type-level performance of `catamorphism`, `fold` functions

Author: ahrjarrett

.changeset/bright-adults-itch.md

@@ -0,0 +1,5 @@
+---
+"@traversable/registry": patch
+---
+
+feat(registry): adds more robust type for `catamorphism`

.changeset/little-parents-hope.md

@@ -0,0 +1,6 @@
+---
+"@traversable/arktype-types": patch
+"@traversable/arktype-test": patch
+---
+
+optimize(arktype-test,arktype-types): optimizes type-level performance of `ark.fold`

.changeset/rotten-melons-wave.md

@@ -0,0 +1,6 @@
+---
+"@traversable/json-schema-types": patch
+"@traversable/json-schema-test": patch
+---
+
+optimize(json-schema-test,json-schema-types): optimizes type-level performance of `JsonSchema.fold`

.changeset/rude-trams-clap.md

@@ -0,0 +1,6 @@
+---
+"@traversable/typebox-types": patch
+"@traversable/typebox-test": patch
+---
+
+optimize(typebox-test,typebox-types): optimizes type-level performance of `box.fold`

.changeset/smooth-queens-allow.md

@@ -0,0 +1,7 @@
+---
+"@traversable/zod-types": patch
+"@traversable/zod-test": patch
+"@traversable/zod": patch
+---
+
+optimize(zod,zod-test,zod-types): optimizes type-level performance of `zx.fold`

.changeset/wicked-buckets-shave.md

@@ -0,0 +1,5 @@
+---
+"@traversable/schema": patch
+---
+
+optimize(schema): optimizes type-level performance of `t.fold`

.changeset/young-flies-drop.md

@@ -0,0 +1,7 @@
+---
+"@traversable/valibot-types": patch
+"@traversable/valibot-test": patch
+"@traversable/valibot": patch
+---
+
+optimize(valibot,valibot-test,valibot-types): optimizes type-level performance of `vx.fold`

packages/arktype-test/README.md

@@ -37,6 +37,7 @@
 1. [`arktype`](https://arktype.io/) (v2.1)
 2. [`fast-check`](https://fast-check.dev/)
 
+
 ## Usage
 
 ```bash
@@ -52,12 +53,28 @@ import { arkTest } from '@traversable/arktype-test'
 // see below for specifc examples
 ```
 
+
 ## Table of contents
 
-- [`arkTest.SeedGenerator`](https://github.com/traversable/schema/tree/main/packages/arktype-test#arktestseedgenerator)
 - [`arkTest.seedToSchema`](https://github.com/traversable/schema/tree/main/packages/arktype-test#arktestseedtoschema)
 - [`arkTest.seedToValidData`](https://github.com/traversable/schema/tree/main/packages/arktype-test#arktestseedtovaliddata)
 - [`arkTest.seedToInvalidData`](https://github.com/traversable/schema/tree/main/packages/arktype-test#arktestseedtoinvaliddata)
+- [`arkTest.SeedGenerator`](https://github.com/traversable/schema/tree/main/packages/arktype-test#arktestseedgenerator)
+- [`arkTest.SeedValidDataGenerator`](https://github.com/traversable/schema/tree/main/packages/arktype-test#arkseedvaliddatagenerator)
+- [`arkTest.SeedInvalidDataGenerator`](https://github.com/traversable/schema/tree/main/packages/arktype-test#arkseedinvaliddatagenerator)
+
+
+## Track record
+
+`@traversable/arktype-test` has found several upstream bugs:
+
+1. Array + tuple union unsatisfied by empty array
+  - [Issue](https://github.com/arktypeio/arktype/issues/1441)
+  - [Sandbox](https://stackblitz.com/edit/vitest-dev-vitest-nho5vqwa?file=test%2Frepro.test.ts)
+
+2. Discriminated union bug
+  - [Issue](https://github.com/arktypeio/arktype/issues/1440)
+  - [Sandbox](https://stackblitz.com/edit/vitest-dev-vitest-ddhwwn9j?file=test%2Frepro.test.ts)
 
 
 ### `arkTest.seedToSchema`
@@ -78,6 +95,7 @@ const mySchema = arkTest.seedToSchema(mySeed)
 //    ^? const mySchema: type.Any
 ```
 
+
 ### `arkTest.seedToValidData`
 
 Use `arkTest.seedToValidData` to convert a seed generated by `arkTest.SeedGenerator` into
@@ -101,6 +119,7 @@ const validData = arkTest.seedToValidData(mySeed)
 mySchema(validData) instanceof type.errors // always `false`
 ```
 
+
 ### `arkTest.seedToInvalidData`
 
 Use `arkTest.seedToInvalidData` to convert a seed generated by `arkTest.SeedGenerator` into
@@ -124,8 +143,13 @@ const invalidData = arkTest.seedToValidData(mySeed)
 mySchema(invalidData) instanceof type.errors // always `true`
 ```
 
+
 ### `arkTest.SeedGenerator`
 
+> [!NOTE]
+>
+> `arkTest.SeedGenerator` is fairly low-level. All of the other exports of this library have been implemented in terms of `arkTest.SeedGenerator`.
+
 Generates a configurable, pseudo-random "seed builder".
 
 - Use [`arkTest.seedToSchema`](https://github.com/traversable/schema/tree/main/packages/arktype-test#arktestseedtoschema) to convert a seed into an ArkType schema
@@ -136,13 +160,13 @@ Generates a configurable, pseudo-random "seed builder".
 
 ```typescript
 import { type } from 'arktype'
-import { arkTest } from '@traversable/arktype-test'
 import * as fc from 'fast-check'
+import { arkTest } from '@traversable/arktype-test'
 
 const builder = arkTest.SeedGenerator({
   include: ["boolean", "string", "object"],
   // 𐙘 use `include` to only include certain schema types
-  exclude: ["boolean", "unknown"],
+  exclude: ["boolean", "any"],
   // 𐙘 use `exclude` to exclude certain schema types altogether (overrides `include`)
   object: { maxKeys: 5 },
   // 𐙘 specific arbitraries are configurable by name
@@ -180,14 +204,20 @@ const invalidData = arkTest.seedToInvalidData(mySeed)
 //       parsing `invalidData` should always fail
 ```
 
-#### Track record
 
-`arkTest.SeedGenerator` has found several upstream bugs:
+### `arkTest.SeedValidDataGenerator`
 
-1. Array + tuple union unsatisfied by empty array
-  - [Issue](https://github.com/arktypeio/arktype/issues/1441)
-  - [Sandbox](https://stackblitz.com/edit/vitest-dev-vitest-nho5vqwa?file=test%2Frepro.test.ts)
+Like [`arkTest.SeedGenerator`](https://github.com/traversable/schema/tree/main/packages/arktype-test#arktestseedgenerator), except `arkTest.SeedValidDataGenerator` comes pre-configured to exclude schemas that make it impossible to reliably generate valid data.
 
-2. Discriminated union bug
-  - [Issue](https://github.com/arktypeio/arktype/issues/1440)
-  - [Sandbox](https://stackblitz.com/edit/vitest-dev-vitest-ddhwwn9j?file=test%2Frepro.test.ts)
+> [!NOTE]
+>
+> `arkTest.SeedValidDataGenerator` does not accept any options. If you need more fine-grained control of the schemas being generated, use [`arkTest.SeedGenerator`](https://github.com/traversable/schema/tree/main/packages/arktype-test#arktestseedgenerator).
+
+
+### `arkTest.SeedInvalidDataGenerator`
+
+Like [`arkTest.SeedGenerator`](https://github.com/traversable/schema/tree/main/packages/arktype-test#arktestseedgenerator), except `arkTest.SeedValidDataGenerator` comes pre-configured to exclude schemas that make it impossible to reliably generate invalid data.
+
+> [!NOTE]
+>
+> `arkTest.SeedInvalidDataGenerator` does not accept any options. If you need more fine-grained control of the schemas being generated, use [`arkTest.SeedGenerator`](https://github.com/traversable/schema/tree/main/packages/arktype-test#arktestseedgenerator).

packages/arktype-test/src/generator-options.ts

@@ -77,8 +77,8 @@ export interface OptionsBase<
 export interface Config<T = never> extends OptionsBase<T>, byTypeName {}
 
 export type Constraints = {
-  array?: { minLength?: number, maxLength?: number }
-  bigint?: { min: undefined | bigint, max: undefined | bigint, multipleOf?: bigint | null }
+  array?: { minLength?: number, maxLength?: number, unbounded?: boolean }
+  bigint?: { min: undefined | bigint, max: undefined | bigint, multipleOf?: bigint | null, unbounded?: boolean }
   boolean?: {}
   date?: {}
   enum?: {}
@@ -87,11 +87,11 @@ export type Constraints = {
   literal?: {}
   never?: {}
   null?: {}
-  number?: { min?: undefined | number, max?: undefined | number, multipleOf?: number } & fc.DoubleConstraints
+  number?: { min?: undefined | number, max?: undefined | number, multipleOf?: number, unbounded?: boolean } & fc.DoubleConstraints
   object?: ObjectConstraints
   optional?: {}
   record?: fc.DictionaryConstraints
-  string?: fc.StringConstraints
+  string?: fc.StringConstraints & { unbounded?: boolean }
   symbol?: {}
   tuple?: fc.ArrayConstraints
   undefined?: {}
@@ -103,7 +103,7 @@ export type Constraints = {
 
 export interface byTypeName extends Required<Omit<Constraints, 'array' | 'object'>> {
   object: fc.UniqueArrayConstraintsRecommended<[k: string, v: unknown], string>
-  array: fc.IntegerConstraints
+  array: fc.IntegerConstraints & { unbounded?: boolean }
 }
 
 export type ObjectConstraints =
@@ -127,12 +127,14 @@ export const defaultConstraints = {
   object: objectDefaults,
   array: {
     minLength: 0,
-    maxLength: 0x10
+    maxLength: 0x10,
+    unbounded: false,
   },
   bigint: {
     min: undefined,
     max: undefined,
     multipleOf: null,
+    unbounded: false,
   },
   boolean: {},
   date: {},
@@ -155,6 +157,7 @@ export const defaultConstraints = {
     minExcluded: false,
     maxExcluded: false,
     noInteger: false,
+    unbounded: false,
   },
   optional: {},
   record: {
@@ -169,7 +172,8 @@ export const defaultConstraints = {
     maxLength: 0x100,
     size: 'xsmall',
     unit: 'grapheme-ascii',
-  } satisfies fc.StringConstraints,
+    unbounded: false,
+  },
   symbol: {},
   tuple: {
     minLength: 1,
@@ -224,6 +228,7 @@ export function parseOptions(options: Options<any> = defaults as never): Config
     array: {
       maxLength: arrayMax = defaultConstraints.array.maxLength,
       minLength: arrayMin = defaultConstraints.array.minLength,
+      unbounded: arrayUnbounded = defaultConstraints.array.unbounded,
       ...ARRAY
     } = defaultConstraints.array,
     bigint: {
@@ -248,6 +253,7 @@ export function parseOptions(options: Options<any> = defaults as never): Config
       maxExcluded: numberMaxExcluded,
       min: numberMin,
       minExcluded: numberMinExcluded,
+      unbounded: numberUnbounded,
       // ...NUMBER
     } = defaultConstraints.number,
     optional = defaultConstraints.optional,
@@ -261,6 +267,7 @@ export function parseOptions(options: Options<any> = defaults as never): Config
       minLength: stringMinLength,
       maxLength: stringMaxLength,
       size: stringSize = defaultConstraints.string.size,
+      unbounded: stringUnbounded,
       // ...STRING
     } = defaultConstraints.string,
     symbol = defaultConstraints.symbol,
@@ -315,6 +322,7 @@ export function parseOptions(options: Options<any> = defaults as never): Config
       ...ARRAY,
       min: arrayMin,
       max: arrayMax,
+      unbounded: arrayUnbounded,
     },
     bigint: {
       ...BIGINT,
@@ -338,6 +346,7 @@ export function parseOptions(options: Options<any> = defaults as never): Config
       min: numberMin,
       maxExcluded: numberMaxExcluded,
       minExcluded: numberMinExcluded,
+      unbounded: numberUnbounded,
     },
     optional,
     record: {
@@ -351,6 +360,7 @@ export function parseOptions(options: Options<any> = defaults as never): Config
       minLength: stringMinLength,
       maxLength: stringMaxLength,
       size: stringSize,
+      unbounded: stringUnbounded,
     },
     symbol,
     tuple: {

packages/arktype-test/src/generator-seed.ts

@@ -148,7 +148,7 @@ export declare namespace Seed {
   type AllOf<T = unknown> = [intersection: byTag['allOf'], def: [A: T, B: T]]
 }
 
-export const Functor: T.Functor.Ix<boolean, Seed.Free, Seed.F<unknown>> = {
+export const Functor: T.Functor.Ix<boolean, Seed.Free, Seed.F<any>> = {
   map(f) {
     return (x) => {
       switch (true) {
@@ -205,6 +205,4 @@ export const Functor: T.Functor.Ix<boolean, Seed.Free, Seed.F<unknown>> = {
   }
 }
 
-export const fold
-  : <T>(g: (src: Seed.F<T>, ix: boolean, x: Seed.Fixpoint) => T) => (src: Seed.F<T>, isProperty?: boolean) => T
-  = (g) => (src, isProperty = false) => fn.catamorphism(Functor, false)(g)(src, isProperty)
+export const fold = fn.catamorphism(Functor, false)