@systemfsoftware/effect-schema-law 0.3.0 → 0.3.2

package/dist/effect-schema-law.d.ts

@@ -0,0 +1,20 @@
+import { Schema } from 'effect';
+
+export 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]>>;
+
+/**
+ * Property-test the round-trip and encode-stability laws of any Effect Schema.
+ *
+ * Registers two fast-check properties with `@effect/vitest`:
+ *   1. `∀x. enc(dec(enc(x))) === enc(x)` — encode stability across decode.
+ *   2. `∀x. dec(enc(x)) === x` — round-trip identity.
+ *
+ * Use inside a `describe` block to scope the generated tests.
+ */
+export declare const ruleOfSchemas: <A, I>(name: string, schema: Schema.Schema<A, I, never>) => void;
+
+export { }

package/dist/index.d.ts

@@ -7,6 +7,15 @@ declare const boundedUnion: <Base extends readonly [Schema.Schema.Any, ...Readon
 }) => 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
+/**
+ * Property-test the round-trip and encode-stability laws of any Effect Schema.
+ *
+ * Registers two fast-check properties with `@effect/vitest`:
+ *   1. `∀x. enc(dec(enc(x))) === enc(x)` — encode stability across decode.
+ *   2. `∀x. dec(enc(x)) === x` — round-trip identity.
+ *
+ * Use inside a `describe` block to scope the generated tests.
+ */
 declare const ruleOfSchemas: <A, I>(name: string, schema: Schema.Schema<A, I, never>) => void;
 //#endregion
 export { boundedUnion, ruleOfSchemas };

package/dist/index.mjs

@@ -15,6 +15,15 @@ const boundedUnion = (identifier, options) => {
 };
 //#endregion
 //#region src/schema.ts
+/**
+* Property-test the round-trip and encode-stability laws of any Effect Schema.
+*
+* Registers two fast-check properties with `@effect/vitest`:
+*   1. `∀x. enc(dec(enc(x))) === enc(x)` — encode stability across decode.
+*   2. `∀x. dec(enc(x)) === x` — round-trip identity.
+*
+* Use inside a `describe` block to scope the generated tests.
+*/
 const ruleOfSchemas = (name, schema) => {
 	const decodeEither = Schema.decodeEither(schema);
 	const encodeSync = Schema.encodeSync(schema);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@systemfsoftware/effect-schema-law",
   "license": "MIT",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "author": "Ryan Lee <drdgvhbh@gmail.com>",
   "repository": {
     "type": "git",
@@ -57,7 +57,7 @@
   },
   "scripts": {
     "clean": "rimraf dist",
-    "build": "tsdown",
+    "build": "tsdown && api-extractor run --local",
     "typecheck": "tsc --noEmit --incremental",
     "test": "vitest run",
     "test:run": "vitest run",