Merge pull request #106 from wellcrafted-dev/braden-w/export-json-types

feat!: move JsonValue/JsonObject to wellcrafted/json

Author: braden-w

.changeset/move-json-types.md

@@ -0,0 +1,7 @@
+---
+"wellcrafted": minor
+---
+
+Move `JsonValue` and `JsonObject` types to `wellcrafted/json` export path.
+
+**BREAKING:** `JsonValue` and `JsonObject` are no longer exported from `wellcrafted/error`. Import them from `wellcrafted/json` instead.

package.json

@@ -17,6 +17,10 @@
 			"types": "./dist/error/index.d.ts",
 			"import": "./dist/error/index.js"
 		},
+		"./json": {
+			"types": "./dist/json.d.ts",
+			"import": "./dist/json.js"
+		},
 		"./brand": {
 			"types": "./dist/brand.d.ts",
 			"import": "./dist/brand.js"

src/error/defineErrors.test.ts

@@ -1,12 +1,8 @@
 import { describe, it, expect, expectTypeOf } from "bun:test";
 import { defineErrors } from "./defineErrors.js";
 import { extractErrorMessage } from "./extractErrorMessage.js";
-import type {
-	AnyTaggedError,
-	InferError,
-	InferErrors,
-	JsonObject,
-} from "./types.js";
+import type { AnyTaggedError, InferError, InferErrors } from "./types.js";
+import type { JsonObject } from "../json.js";
 
 // =============================================================================
 // Basic factories — message at call site equivalent

src/error/types.ts

@@ -1,22 +1,5 @@
 import type { Err } from "../result/result.js";
 
-/**
- * JSON-serializable value types for error context.
- * Ensures all error data can be safely serialized via JSON.stringify.
- */
-export type JsonValue =
-	| string
-	| number
-	| boolean
-	| null
-	| JsonValue[]
-	| { [key: string]: JsonValue };
-
-/**
- * JSON-serializable object type for error context.
- */
-export type JsonObject = Record<string, JsonValue>;
-
 /**
  * Base type for any tagged error, used as a minimum constraint.
  */

src/json.ts

@@ -0,0 +1,25 @@
+/**
+ * JSON-serializable value types.
+ * Ensures data can be safely serialized via JSON.stringify.
+ *
+ * @example
+ * ```typescript
+ * import type { JsonValue, JsonObject } from "wellcrafted/json";
+ *
+ * const value: JsonValue = { key: [1, "two", true, null] };
+ * const obj: JsonObject = { name: "Alice", age: 30 };
+ * ```
+ */
+export type JsonValue =
+	| string
+	| number
+	| boolean
+	| null
+	| JsonValue[]
+	| { [key: string]: JsonValue };
+
+/**
+ * JSON-serializable object type.
+ * A record where every value is a {@link JsonValue}.
+ */
+export type JsonObject = Record<string, JsonValue>;

tsdown.config.ts

@@ -4,6 +4,7 @@ export default defineConfig({
 	entry: [
 		"src/result/index.ts",
 		"src/error/index.ts",
+		"src/json.ts",
 		"src/brand.ts",
 		"src/query/index.ts",
 		"src/standard-schema/index.ts",