@ark/fast-check 0.0.12

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2025 ArkType
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/out/arbitraries/array.d.ts

@@ -0,0 +1,5 @@
+import type { nodeOfKind, SequenceTuple } from "@ark/schema";
+import * as fc from "fast-check";
+import type { Ctx } from "../fastCheckContext.ts";
+export declare const getPossiblyWeightedArray: (arrArbitrary: fc.Arbitrary<unknown[]>, node: nodeOfKind<"sequence">, ctx: Ctx) => fc.Arbitrary<unknown[]>;
+export declare const spreadVariadicElements: (tupleArbitraries: fc.Arbitrary<unknown>[], tupleElements: SequenceTuple) => fc.Arbitrary<unknown[]>;

package/out/arbitraries/array.js

@@ -0,0 +1,31 @@
+import * as fc from "fast-check";
+export const getPossiblyWeightedArray = (arrArbitrary, node, ctx) => ctx.tieStack.length ?
+    fc.oneof({
+        maxDepth: 2,
+        depthIdentifier: `id:${node.id}`
+    }, { arbitrary: fc.constant([]), weight: 1 }, {
+        arbitrary: arrArbitrary,
+        weight: 2
+    })
+    : arrArbitrary;
+export const spreadVariadicElements = (tupleArbitraries, tupleElements) => fc.tuple(...tupleArbitraries).chain(arr => {
+    const arrayWithoutOptionals = [];
+    const arrayWithOptionals = [];
+    for (const i in arr) {
+        if (tupleElements[i].kind === "variadic") {
+            const generatedValuesArray = arr[i].map(val => fc.constant(val));
+            arrayWithoutOptionals.push(...generatedValuesArray);
+            arrayWithOptionals.push(...generatedValuesArray);
+        }
+        else if (tupleElements[i].kind === "optionals")
+            arrayWithOptionals.push(fc.constant(arr[i]));
+        else {
+            arrayWithoutOptionals.push(fc.constant(arr[i]));
+            arrayWithOptionals.push(fc.constant(arr[i]));
+        }
+    }
+    if (arrayWithOptionals.length !== arrayWithoutOptionals.length) {
+        return fc.oneof(fc.tuple(...arrayWithoutOptionals), fc.tuple(...arrayWithOptionals));
+    }
+    return fc.tuple(...arrayWithOptionals);
+});

package/out/arbitraries/date.d.ts

@@ -0,0 +1,3 @@
+import * as fc from "fast-check";
+import type { ProtoInputNode } from "./proto.ts";
+export declare const buildDateArbitrary: (node: ProtoInputNode) => fc.Arbitrary<Date>;

package/out/arbitraries/date.js

@@ -0,0 +1,12 @@
+import * as fc from "fast-check";
+export const buildDateArbitrary = (node) => {
+    if (node.hasKind("intersection")) {
+        const fastCheckDateConstraints = {};
+        if (node.inner.after)
+            fastCheckDateConstraints.min = node.inner.after.rule;
+        if (node.inner.before)
+            fastCheckDateConstraints.max = node.inner.before.rule;
+        return fc.date(fastCheckDateConstraints);
+    }
+    return fc.date();
+};

package/out/arbitraries/domain.d.ts

@@ -0,0 +1,14 @@
+import type { nodeOfKind } from "@ark/schema";
+import * as fc from "fast-check";
+import type { Ctx } from "../fastCheckContext.ts";
+export declare const buildDomainArbitrary: BuildDomainArbitrary;
+export type DomainArbitrary<t = unknown> = (node: DomainInputNode, ctx: Ctx) => fc.Arbitrary<t>;
+type BuildDomainArbitrary = {
+    number: DomainArbitrary<number>;
+    string: DomainArbitrary<string>;
+    symbol: DomainArbitrary<symbol>;
+    bigint: DomainArbitrary<bigint>;
+    object: DomainArbitrary;
+};
+export type DomainInputNode = nodeOfKind<"intersection"> | nodeOfKind<"domain">;
+export {};

package/out/arbitraries/domain.js

@@ -0,0 +1,11 @@
+import * as fc from "fast-check";
+import { buildStructureArbitrary } from "../arktypeFastCheck.js";
+import { buildNumberArbitrary } from "./number.js";
+import { buildStringArbitrary } from "./string.js";
+export const buildDomainArbitrary = {
+    number: node => buildNumberArbitrary(node),
+    string: node => buildStringArbitrary(node),
+    object: (node, ctx) => node.hasKind("domain") ? fc.object() : buildStructureArbitrary(node, ctx),
+    symbol: () => fc.constant(Symbol()),
+    bigint: () => fc.bigInt()
+};

package/out/arbitraries/number.d.ts

@@ -0,0 +1,3 @@
+import * as fc from "fast-check";
+import type { DomainInputNode } from "./domain.ts";
+export declare const buildNumberArbitrary: (node: DomainInputNode) => fc.Arbitrary<number>;

package/out/arbitraries/number.js

@@ -0,0 +1,67 @@
+import { hasKey, nearestFloat, throwInternalError } from "@ark/util";
+import * as fc from "fast-check";
+export const buildNumberArbitrary = (node) => {
+    if (node.hasKind("domain")) {
+        return fc.double({
+            noNaN: !node.numberAllowsNaN
+        });
+    }
+    const numberConstraints = getFastCheckNumberConstraints(node);
+    const hasMax = hasKey(numberConstraints, "max");
+    const hasMin = hasKey(numberConstraints, "min");
+    if (!hasKey(numberConstraints, "divisor"))
+        return fc.double(numberConstraints);
+    const divisor = numberConstraints.divisor;
+    if (divisor === undefined)
+        throwInternalError("Expected a divisor.");
+    if (hasMin && hasMax) {
+        if (numberConstraints.min === undefined ||
+            numberConstraints.max === undefined) {
+            throwInternalError(`Expected min and max node refinements to not be undefined. (was min: ${numberConstraints.min} max: ${numberConstraints.max})`);
+        }
+        if (numberConstraints.min > numberConstraints.max) {
+            throw new Error(`No integer value satisfies >${numberConstraints.min} & <${numberConstraints.max}`);
+        }
+    }
+    const min = numberConstraints.min ?? Number.MIN_SAFE_INTEGER;
+    const max = numberConstraints.max ?? Number.MAX_SAFE_INTEGER;
+    const firstDivisibleInRange = Math.ceil(min / divisor) * divisor;
+    if (firstDivisibleInRange > max || firstDivisibleInRange < min) {
+        throw new Error(`No values within range ${numberConstraints.min} - ${numberConstraints.max} are divisible by ${numberConstraints.divisor}.`);
+    }
+    numberConstraints.min = firstDivisibleInRange;
+    //fast-check defaults max to 0x7fffffff which prevents larger divisible numbers from being produced
+    numberConstraints.max = max;
+    const integerArbitrary = fc.integer(numberConstraints);
+    const integersDivisibleByDivisor = integerArbitrary.map(value => {
+        const remainder = value % divisor;
+        if (remainder === 0)
+            return value;
+        const lowerPossibleValue = value - remainder;
+        if (lowerPossibleValue >= firstDivisibleInRange &&
+            lowerPossibleValue % divisor === 0)
+            return lowerPossibleValue;
+        return value + remainder;
+    });
+    return integersDivisibleByDivisor;
+};
+const getFastCheckNumberConstraints = (node) => {
+    const hasDivisor = node.prestructurals.find(refinement => refinement.hasKind("divisor"));
+    const numberConstraints = {
+        noNaN: !node.inner.domain?.numberAllowsNaN
+    };
+    for (const refinement of node.prestructurals) {
+        if (refinement.hasKindIn("min", "max")) {
+            let rule = refinement.rule;
+            if ("exclusive" in refinement) {
+                rule = nearestFloat(refinement.rule, refinement.hasKind("min") ? "+" : "-");
+            }
+            if (hasDivisor !== undefined)
+                rule = refinement.hasKind("min") ? Math.ceil(rule) : Math.floor(rule);
+            numberConstraints[refinement.kind] = rule;
+        }
+        else if (refinement.hasKind("divisor"))
+            numberConstraints["divisor"] = refinement.rule;
+    }
+    return numberConstraints;
+};

package/out/arbitraries/object.d.ts

@@ -0,0 +1,4 @@
+import type { nodeOfKind } from "@ark/schema";
+import { type Arbitrary } from "fast-check";
+import type { Ctx } from "../fastCheckContext.ts";
+export declare const buildCyclicArbitrary: (node: nodeOfKind<"structure">, ctx: Ctx) => Arbitrary<Record<string, unknown>>;

package/out/arbitraries/object.js

@@ -0,0 +1,14 @@
+import { letrec } from "fast-check";
+import { buildObjectArbitrary } from "../arktypeFastCheck.js";
+export const buildCyclicArbitrary = (node, ctx) => {
+    const objectArbitrary = letrec(tie => {
+        ctx.tieStack.push(tie);
+        const arbitraries = {
+            root: buildObjectArbitrary(node, ctx),
+            ...ctx.arbitrariesByIntersectionId
+        };
+        ctx.tieStack.pop();
+        return arbitraries;
+    });
+    return objectArbitrary["root"];
+};

package/out/arbitraries/proto.d.ts

@@ -0,0 +1,14 @@
+import type { nodeOfKind } from "@ark/schema";
+import * as fc from "fast-check";
+import type { Ctx } from "../fastCheckContext.ts";
+import type { DomainInputNode } from "./domain.ts";
+export declare const buildProtoArbitrary: BuildProtoArbitrary;
+type BuildProtoArbitrary = {
+    Array: ProtoArbitrary;
+    Set: ProtoArbitrary<Set<unknown>>;
+    Date: ProtoArbitrary<Date>;
+    [key: string]: ProtoArbitrary;
+};
+type ProtoArbitrary<t = unknown> = (node: ProtoInputNode | DomainInputNode, ctx: Ctx) => fc.Arbitrary<t>;
+export type ProtoInputNode = nodeOfKind<"intersection"> | nodeOfKind<"domain">;
+export {};

package/out/arbitraries/proto.js

@@ -0,0 +1,10 @@
+import * as fc from "fast-check";
+import { buildStructureArbitrary } from "../arktypeFastCheck.js";
+import { buildDateArbitrary } from "./date.js";
+export const buildProtoArbitrary = {
+    Array: (node, ctx) => node.hasKind("proto") ?
+        fc.array(fc.anything())
+        : buildStructureArbitrary(node, ctx),
+    Set: () => fc.uniqueArray(fc.anything()).map(arr => new Set(arr)),
+    Date: node => buildDateArbitrary(node)
+};

package/out/arbitraries/string.d.ts

@@ -0,0 +1,3 @@
+import * as fc from "fast-check";
+import type { DomainInputNode } from "./domain.ts";
+export declare const buildStringArbitrary: (node: DomainInputNode) => fc.Arbitrary<string>;

package/out/arbitraries/string.js

@@ -0,0 +1,31 @@
+import { throwInternalError } from "@ark/util";
+import * as fc from "fast-check";
+export const buildStringArbitrary = (node) => {
+    if (node.hasKind("domain"))
+        return fc.string();
+    const stringConstraints = getFastCheckStringConstraints(node.prestructurals);
+    if ("pattern" in stringConstraints) {
+        if (stringConstraints.minLength || stringConstraints.maxLength)
+            throwInternalError("Bounded regex is not supported.");
+        return fc.stringMatching(new RegExp(stringConstraints.pattern));
+    }
+    return fc.string(stringConstraints);
+};
+const getFastCheckStringConstraints = (refinements) => {
+    const stringConstraints = {};
+    for (const refinement of refinements) {
+        if (refinement.hasKind("pattern")) {
+            if (stringConstraints.pattern !== undefined) {
+                throwInternalError("Multiple regexes on a single node is not supported.");
+            }
+            stringConstraints["pattern"] = refinement.rule;
+        }
+        else if (refinement.hasKind("exactLength")) {
+            stringConstraints["minLength"] = refinement.rule;
+            stringConstraints["maxLength"] = refinement.rule;
+        }
+        else
+            stringConstraints[refinement.kind] = refinement.rule;
+    }
+    return stringConstraints;
+};

package/out/arktypeFastCheck.d.ts

@@ -0,0 +1,7 @@
+import type { nodeOfKind } from "@ark/schema";
+import type { type } from "arktype";
+import * as fc from "fast-check";
+import { type Ctx } from "./fastCheckContext.ts";
+export declare const arkToArbitrary: (schema: type.Any) => fc.Arbitrary<unknown>;
+export declare const buildStructureArbitrary: (node: nodeOfKind<"intersection">, ctx: Ctx) => fc.Arbitrary<unknown>;
+export declare const buildObjectArbitrary: (node: nodeOfKind<"structure">, ctx: Ctx) => fc.Arbitrary<Record<string, unknown>>;

package/out/arktypeFastCheck.js

@@ -0,0 +1,141 @@
+import { hasKey, stringAndSymbolicEntriesOf, throwInternalError } from "@ark/util";
+import * as fc from "fast-check";
+import { getPossiblyWeightedArray, spreadVariadicElements } from "./arbitraries/array.js";
+import { buildDomainArbitrary } from "./arbitraries/domain.js";
+import { buildCyclicArbitrary } from "./arbitraries/object.js";
+import { buildProtoArbitrary } from "./arbitraries/proto.js";
+import { initializeContext } from "./fastCheckContext.js";
+export const arkToArbitrary = (schema) => {
+    const ctx = initializeContext();
+    return buildArbitrary(schema, ctx);
+};
+const buildArbitrary = (node, ctx) => {
+    switch (node.kind) {
+        case "intersection":
+            ctx.seenIntersectionIds[node.id] = true;
+            ctx.isCyclic = node.isCyclic;
+            //specifically in the case of unknown, it is represented as an empty intersection so we just return anything here.
+            if (node.basis === null)
+                return fc.anything();
+            const intersectionArbitrary = node.basis?.kind === "domain" ?
+                buildDomainArbitrary[node.basis?.domain](node, ctx)
+                : buildProtoArbitrary[node.basis?.proto.name](node, ctx);
+            ctx.arbitrariesByIntersectionId[node.id] = intersectionArbitrary;
+            return intersectionArbitrary;
+        case "domain":
+            if (node.domain in buildDomainArbitrary)
+                return buildDomainArbitrary[node.domain](node, ctx);
+            return throwInternalError(`${node.domain} is not supported`);
+        case "union":
+            const arbitraries = node.children.map(node => buildArbitrary(node, ctx));
+            return fc.oneof(...arbitraries);
+        case "unit":
+            return fc.constant(node.unit);
+        case "proto":
+            return buildProtoArbitrary[node.proto.name](node, ctx);
+        case "structure":
+            return buildStructureArbitrary(node, ctx);
+        case "index":
+            return buildIndexSignatureArbitrary([node], ctx);
+        case "required":
+        case "optional":
+            if (node.value.hasKind("alias") && node.required)
+                throwInternalError("Infinitely deep cycles are not supported.");
+            return buildArbitrary(node.value, ctx);
+        case "morph":
+            if (node.inner.in === undefined)
+                throwInternalError(`Expected the morph to have an 'In' value.`);
+            return buildArbitrary(node.inner.in, ctx);
+        case "alias":
+            if (ctx.tieStack.length < 1)
+                throwInternalError("Tie has not been initialized");
+            const tie = ctx.tieStack[ctx.tieStack.length - 1];
+            const id = node.resolutionId;
+            /**
+             * Synthetic aliases cause the original structure to not contain the resolved alias node when
+             * iterating through children so we explicitly build the resolved node
+             */
+            if (!(id in ctx.seenIntersectionIds)) {
+                ctx.seenIntersectionIds[id] = true;
+                ctx.arbitrariesByIntersectionId[id] = buildArbitrary(node.resolution, ctx);
+            }
+            return tie(id);
+    }
+    throwInternalError(`${node.kind} is not supported`);
+};
+export const buildStructureArbitrary = (node, ctx) => {
+    const structure = node.structure;
+    if (node.basis?.hasKind("domain")) {
+        if (structure === undefined)
+            throwInternalError("Expected a structure node.");
+        if (hasKey(structure, "index") && structure.index)
+            return buildIndexSignatureArbitrary(structure.index, ctx);
+        return buildObjectArbitrary(structure, ctx);
+    }
+    if (node.inner.exactLength?.rule === 0)
+        return fc.tuple();
+    const fcArrayConstraints = {};
+    if (node.inner.minLength)
+        fcArrayConstraints.minLength = node.inner.minLength.rule;
+    if (node.inner.maxLength)
+        fcArrayConstraints.maxLength = node.inner.maxLength.rule;
+    const arrArbitrary = structure?.sequence ?
+        buildArrayArbitrary(structure.sequence, fcArrayConstraints, ctx)
+        : fc.array(fc.anything(), fcArrayConstraints);
+    if (structure?.required || structure?.optional) {
+        const objectArbitrary = buildObjectArbitrary(structure, ctx);
+        return fc
+            .tuple(arrArbitrary, objectArbitrary)
+            .map(([arr, record]) => Object.assign(arr, record));
+    }
+    return arrArbitrary;
+};
+export const buildObjectArbitrary = (node, ctx) => {
+    if (ctx.isCyclic && !ctx.tieStack.length)
+        return buildCyclicArbitrary(node, ctx);
+    const entries = stringAndSymbolicEntriesOf(node.propsByKey);
+    const requiredKeys = node.requiredKeys;
+    const arbitrariesByKey = {};
+    for (const [key, value] of entries)
+        arbitrariesByKey[key] = buildArbitrary(value, ctx);
+    return fc.record(arbitrariesByKey, { requiredKeys });
+};
+const buildIndexSignatureArbitrary = (indexNodes, ctx) => {
+    if (indexNodes.length === 1)
+        return getDictionaryArbitrary(indexNodes[0], ctx);
+    const dictionaryArbitraries = [];
+    for (const indexNode of indexNodes)
+        dictionaryArbitraries.push(getDictionaryArbitrary(indexNode, ctx));
+    return fc.tuple(...dictionaryArbitraries).map(arbs => {
+        const recordArb = {};
+        for (const arb of arbs)
+            Object.assign(recordArb, arb);
+        return recordArb;
+    });
+};
+const getDictionaryArbitrary = (node, ctx) => {
+    const signatureArbitrary = buildArbitrary(node.signature, ctx);
+    const valueArbitrary = buildArbitrary(node.value, ctx);
+    //signatureArbitrary can be a symbol or string arbitrary
+    return fc.dictionary(signatureArbitrary, valueArbitrary);
+};
+const buildArrayArbitrary = (node, refinements, ctx) => {
+    //Arrays will always have a single element and the kind will be variadic
+    if (node.tuple.length === 1 && node.tuple[0].kind === "variadic") {
+        const elementsArbitrary = buildArbitrary(node.tuple[0].node, ctx);
+        const arrArbitrary = fc.array(elementsArbitrary, refinements);
+        return getPossiblyWeightedArray(arrArbitrary, node, ctx);
+    }
+    return getSpreadVariadicElementsTuple(node.tuple, ctx);
+};
+const getSpreadVariadicElementsTuple = (tupleElements, ctx) => {
+    const tupleArbitraries = [];
+    for (const element of tupleElements) {
+        const arbitrary = buildArbitrary(element.node, ctx);
+        if (element.kind === "variadic")
+            tupleArbitraries.push(fc.array(arbitrary));
+        else
+            tupleArbitraries.push(arbitrary);
+    }
+    return spreadVariadicElements(tupleArbitraries, tupleElements);
+};

package/out/fastCheckContext.d.ts

@@ -0,0 +1,8 @@
+import type { Arbitrary, LetrecLooselyTypedTie } from "fast-check";
+export type Ctx = {
+    seenIntersectionIds: Record<string, true>;
+    arbitrariesByIntersectionId: Record<string, Arbitrary<unknown>>;
+    isCyclic: boolean;
+    tieStack: LetrecLooselyTypedTie[];
+};
+export declare const initializeContext: () => Ctx;

package/out/fastCheckContext.js

@@ -0,0 +1,6 @@
+export const initializeContext = () => ({
+    seenIntersectionIds: {},
+    arbitrariesByIntersectionId: {},
+    isCyclic: false,
+    tieStack: []
+});

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@ark/fast-check",
+  "version": "0.0.12",
+  "license": "MIT",
+  "author": {
+    "name": "David Blass",
+    "email": "david@arktype.io",
+    "url": "https://arktype.io"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/arktypeio/arktype.git",
+    "directory": "ark/fast-check"
+  },
+  "type": "module",
+  "main": "./out/arktypeFastCheck.js",
+  "types": "./out/arktypeFastCheck.d.ts",
+  "exports": {
+    ".": {
+      "ark-ts": "./arktypeFastCheck.ts",
+      "default": "./out/arktypeFastCheck.js"
+    },
+    "./internal/*.ts": {
+      "ark-ts": "./*.ts",
+      "default": "./out/*.js"
+    },
+    "./internal/*.js": {
+      "ark-ts": "./*.ts",
+      "default": "./out/*.js"
+    }
+  },
+  "files": [
+    "out"
+  ],
+  "dependencies": {
+    "arktype": "2.2.1",
+    "@ark/schema": "0.56.0",
+    "@ark/util": "0.56.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "fast-check": "3"
+  },
+  "scripts": {
+    "build": "ts ../repo/build.ts",
+    "test": "tsx ../repo/testPackage.ts"
+  }
+}