@systemfsoftware/effect-schema-law 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ryan Lee
+
+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/README.md

@@ -0,0 +1,60 @@
+# @systemfsoftware/effect-schema-law
+
+Codec-law property tests for [Effect](https://effect.website) `Schema`, in one call.
+
+A schema is a two-way codec. `ruleOfSchemas` asserts the two laws every well-formed codec must obey, generating its inputs from the schema itself (via `@effect/vitest`'s `it.prop` + fast-check):
+
+- **Round-trip identity** — `decode(encode(x))` equals `x` (by the schema's type equivalence).
+- **Encode stability** — re-encoding the decoded value reproduces the original encoded form (by the encoded-side equivalence).
+
+```ts
+import { ruleOfSchemas } from '@systemfsoftware/effect-schema-law'
+import { Schema as S } from 'effect'
+
+const Email = S.String.pipe(S.brand('Email'))
+
+// inside a Vitest file — registers two property tests
+ruleOfSchemas('Email', Email)
+```
+
+## Recursive schemas
+
+`ruleOfSchemas` generates its inputs from the schema. Effect bounds that generation at array seams, but a **union that recurses through a non-array field** — `Binary.left: Expression`, `Member.object: Expression` — is generated as an unbounded `fc.oneof(...members)`. A single sample can then recurse until the call stack overflows, and the test crashes before it ever checks a law.
+
+`boundedUnion` builds the same union — decode, encode, and equivalence are identical to `S.Union(...)` — but caps generation depth. Past `maxDepth` (default `2`), generation collapses to the base case, so every variant stays reachable while the recursion always terminates. Split the members into the non-recursive `base` (the leaves, used as the base case) and the self-referential `recur`:
+
+```ts
+import { boundedUnion, ruleOfSchemas } from '@systemfsoftware/effect-schema-law'
+import { Schema as S } from 'effect'
+
+interface Lit {
+  readonly _tag: 'Lit'
+  readonly value: number
+}
+interface Add {
+  readonly _tag: 'Add'
+  readonly left: Expr
+  readonly right: Expr
+}
+type Expr = Lit | Add
+
+const Lit = S.Struct({ _tag: S.Literal('Lit'), value: S.JsonNumber })
+const Add: S.Schema<Add> = S.suspend((): S.Schema<Add> => S.Struct({ _tag: S.Literal('Add'), left: Expr, right: Expr }))
+
+const Expr: S.Schema<Expr> = boundedUnion('Expr', {
+  base: [Lit],
+  recur: [Add],
+})
+
+ruleOfSchemas('Expr', Expr) // generates and law-tests, no stack overflow
+```
+
+The first argument is both the schema's `identifier` and the `depthIdentifier` fast-check counts depth against — keep it unique per recursive cycle.
+
+## Install
+
+```bash
+pnpm add -D @systemfsoftware/effect-schema-law
+```
+
+Install it as a **devDependency** — it's a test helper. `effect`, `vitest`, and `@effect/vitest` are peer dependencies: you bring your own (you already have them to run your tests), so the helper shares your single test-runner instance. Call `ruleOfSchemas(name, schema)` at the top level of a Vitest test file; it registers the two `it.prop` cases for you.

package/dist/index.d.mts

@@ -0,0 +1,13 @@
+import { Schema } from "effect";
+
+//#region src/bounded-union.d.ts
+declare const boundedUnion: <Base extends readonly [Schema.Schema.Any, ...ReadonlyArray<Schema.Schema.Any>], Recur extends readonly [Schema.Schema.Any, ...ReadonlyArray<Schema.Schema.Any>]>(identifier: string, options: {
+  readonly base: Base;
+  readonly recur: Recur;
+  readonly maxDepth?: number;
+}) => Schema.Schema<Schema.Schema.Type<Base[number] | Recur[number]>, Schema.Schema.Encoded<Base[number] | Recur[number]>, Schema.Schema.Context<Base[number] | Recur[number]>>;
+//#endregion
+//#region src/schema.d.ts
+declare const ruleOfSchemas: <A, I>(name: string, schema: Schema.Schema<A, I, never>) => void;
+//#endregion
+export { boundedUnion, ruleOfSchemas };

package/dist/index.mjs

@@ -0,0 +1,35 @@
+import { Arbitrary, Either, Schema } from "effect";
+import { it } from "@effect/vitest";
+//#region src/bounded-union.ts
+const boundedUnion = (identifier, options) => {
+	const { base, maxDepth = 2, recur } = options;
+	const baseArbitraries = base.map((member) => Arbitrary.make(member));
+	const recurArbitraries = recur.map((member) => Arbitrary.make(member));
+	return Schema.Union(...base, ...recur).annotations({
+		identifier,
+		arbitrary: () => (fc) => fc.oneof({
+			depthIdentifier: identifier,
+			maxDepth
+		}, fc.oneof(...baseArbitraries), ...recurArbitraries)
+	});
+};
+//#endregion
+//#region src/schema.ts
+const ruleOfSchemas = (name, schema) => {
+	const decodeEither = Schema.decodeEither(schema);
+	const encodeSync = Schema.encodeSync(schema);
+	const typeEq = Schema.equivalence(schema);
+	const encodedEq = Schema.equivalence(Schema.encodedSchema(schema));
+	it.prop(`∀x_${name}Enc_=x`, [schema], ([value]) => {
+		const encoded = encodeSync(value);
+		const result = decodeEither(encoded);
+		if (Either.isLeft(result)) return false;
+		return encodedEq(encodeSync(result.right), encoded);
+	});
+	it.prop(`∀x_${name}_=x`, [schema], ([value]) => {
+		const result = decodeEither(encodeSync(value));
+		return Either.isRight(result) && typeEq(result.right, value);
+	});
+};
+//#endregion
+export { boundedUnion, ruleOfSchemas };

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@systemfsoftware/effect-schema-law",
+  "license": "MIT",
+  "version": "0.1.0",
+  "author": "Ryan Lee <drdgvhbh@gmail.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/systemfsoftware/systemfsoftware.git",
+    "directory": "packages/effect-schema-law"
+  },
+  "homepage": "https://github.com/systemfsoftware/systemfsoftware/tree/main/packages/effect-schema-law#readme",
+  "bugs": "https://github.com/systemfsoftware/systemfsoftware/issues",
+  "description": "Property-test the codec laws of any Effect Schema in one call — decode/encode round-trip identity and encode stability, generated with @effect/vitest and fast-check.",
+  "keywords": [
+    "effect",
+    "effect-ts",
+    "schema",
+    "codec",
+    "property-testing",
+    "fast-check",
+    "vitest",
+    "roundtrip",
+    "law-testing",
+    "serialization",
+    "typescript"
+  ],
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "@effect/vitest": "0.29.0",
+    "@types/node": "^24",
+    "effect": "^3.21.2",
+    "fast-check": "^3",
+    "rimraf": "^6.1.3",
+    "tsdown": "^0.22.3",
+    "vite-tsconfig-paths": "^6.1.1",
+    "vitest": "^4",
+    "@systemfsoftware/vitest-config": "^0.1.0",
+    "@systemfsoftware/oxlint-config": "^0.1.0",
+    "@systemfsoftware/tsconfig": "^1.0.0"
+  },
+  "peerDependencies": {
+    "@effect/vitest": "*",
+    "effect": "*",
+    "vitest": "*"
+  },
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "tsdown",
+    "typecheck": "tsgo --noEmit --incremental",
+    "test": "vitest run",
+    "test:run": "vitest run",
+    "lint": "oxlint . ${AGENT:+--format=unix --quiet}"
+  }
+}