@crustjs/store 0.4.0 → 0.4.2

package/dist/index.d.ts

@@ -1,84 +1,6 @@
-//#region ../utils/src/json.d.ts
-/** Any value representable in a JSON document. */
-type JsonValue = string | number | boolean | null | readonly JsonValue[] | JsonObject;
-interface JsonObject {
-  [key: string]: JsonValue;
-}
-/** Preserve a type when all of its properties are recursively JSON-compatible. */
-type JsonCompatible<T> = T extends JsonValue ? T : T extends ((...arguments_: never[]) => void) ? never : T extends readonly unknown[] ? { [K in keyof T]: JsonCompatible<T[K]>; } : T extends object ? { [K in keyof T]: JsonCompatible<T[K]>; } : never;
-//#endregion
-//#region ../utils/src/primitive.d.ts
-/** Supported primitive type literals shared by Crust packages. */
-type BaseValueType = "string" | "number" | "boolean";
-/**
- * Resolves a primitive type literal to its corresponding TypeScript type.
- *
- * @example
- * ```ts
- * type Port = ResolvePrimitive<"number">;
- * //   ^? number
- * ```
- */
-type ResolvePrimitive<T extends BaseValueType> = T extends "string" ? string : T extends "number" ? number : T extends "boolean" ? boolean : never;
-//#endregion
-//#region ../utils/src/schema.d.ts
-/** The Standard Typed types interface. */
-interface StandardSchemaTypes<Input = unknown, Output = Input> {
-  /** The input type of the schema. */
-  readonly input: Input;
-  /** The output type of the schema. */
-  readonly output: Output;
-}
-/** The result interface if validation succeeds. */
-interface StandardSchemaSuccessResult<Output> {
-  /** The typed output value. */
-  readonly value: Output;
-  /** A falsy value for `issues` indicates success. */
-  readonly issues?: undefined;
-}
-/** The result interface if validation fails. */
-interface StandardSchemaFailureResult {
-  /** The issues of failed validation. */
-  readonly issues: ReadonlyArray<StandardSchemaIssue>;
-}
-/** The result interface of the validate function. */
-type StandardSchemaResult<Output> = StandardSchemaSuccessResult<Output> | StandardSchemaFailureResult;
-/** The issue interface of the failure output. */
-interface StandardSchemaIssue {
-  /** The error message of the issue. */
-  readonly message: string;
-  /** The path of the issue, if any. */
-  readonly path?: ReadonlyArray<PropertyKey | StandardSchemaPathSegment> | undefined;
-}
-/** The path segment interface of the issue. */
-interface StandardSchemaPathSegment {
-  /** The key representing a path segment. */
-  readonly key: PropertyKey;
-}
-/** The Standard Schema properties interface. */
-interface StandardSchemaProps<Input = unknown, Output = Input> {
-  /** The version number of the standard. */
-  readonly version: 1;
-  /** The vendor name of the schema library. */
-  readonly vendor: string;
-  /** Inferred types associated with the schema. */
-  readonly types?: StandardSchemaTypes<Input, Output> | undefined;
-  /** Validates unknown input values. */
-  readonly validate: (value: StandardSchemaTypes["input"]) => StandardSchemaResult<Output> | Promise<StandardSchemaResult<Output>>;
-}
-/**
- * A Standard Schema-compatible schema object.
- *
- * Any schema library implementing the Standard Schema v1 spec
- * (Zod, Effect, Valibot, ArkType, etc.) produces objects matching this type.
- */
-type StandardSchema<Input = unknown, Output = Input> = {
-  /** The Standard Schema properties. */
-  readonly "~standard": StandardSchemaProps<Input, Output>;
-};
-/** Infer the output type produced by a Standard Schema on success. */
-type InferOutput<S extends StandardSchema> = NonNullable<S["~standard"]["types"]>["output"];
-//#endregion
+import { JsonCompatible } from "@crustjs/utils/json";
+import { BaseValueType, ResolvePrimitive } from "@crustjs/utils/primitive";
+import { InferOutput, StandardSchema } from "@crustjs/utils/schema";
 //#region src/types.d.ts
 /** Supported type literals for store fields. */
 type ValueType = BaseValueType;

package/dist/index.js

@@ -1,7 +1,11 @@
 import { homedir } from "node:os";
 import { dirname, join, win32 } from "node:path";
 import { isDeepStrictEqual } from "node:util";
+import { isJsonObject } from "@crustjs/utils/json";
+import { coerceBooleanString, tryCoerceNumber } from "@crustjs/utils/primitive";
+import { normalizeStandardIssues } from "@crustjs/utils/schema";
 import { chmod, mkdir, readFile, rename, rm, writeFile } from "node:fs/promises";
+import { isErrnoException } from "@crustjs/utils/error";
 //#region src/errors.ts
 /**
 * A typed error thrown by `@crustjs/store` for path, parse, IO, and validation failures.
@@ -249,109 +253,24 @@ function resolveStorePath(dirPath, name) {
 	return join(dirPath, `${name}.json`);
 }
 //#endregion
-//#region ../utils/src/json.ts
-/** Narrow a JSON document root to an object (not array/scalar/null). */
-function isJsonObject(value) {
-	return typeof value === "object" && value !== null && !Array.isArray(value);
-}
-//#endregion
-//#region ../utils/src/primitive.ts
-/**
-* Attempts to coerce a string to a number, returning `undefined` only when the
-* result is `NaN`. Callers decide whether `undefined` means throw or fallback.
-*
-* @example
-* ```ts
-* tryCoerceNumber("42"); // 42
-* tryCoerceNumber("abc"); // undefined
-* tryCoerceNumber(""); // 0
-* ```
-*/
-function tryCoerceNumber(raw) {
-	const num = Number(raw);
-	return Number.isNaN(num) ? void 0 : num;
-}
-/**
-* Coerces Crust boolean strings using the existing strict truthy spellings.
-*
-* @example
-* ```ts
-* coerceBooleanString("true"); // true
-* coerceBooleanString("1"); // true
-* coerceBooleanString("false"); // false
-* ```
-*/
-function coerceBooleanString(raw) {
-	return raw === "true" || raw === "1";
-}
-//#endregion
-//#region ../utils/src/schema.ts
-/**
-* Format an issue path into a dot-path string.
-*
-* - Numeric keys (array indexes) are rendered with bracket notation: `items[0]`
-* - String/symbol keys are joined with dots: `flags.verbose`
-* - An empty path array produces an empty string (root-level issue)
-*
-* @example
-* ```ts
-* formatPath(["flags", "verbose"]);
-* // => "flags.verbose"
-*
-* formatPath(["args", 0]);
-* // => "args[0]"
-*
-* formatPath([]);
-* // => ""
-* ```
-*/
-function isNumericPathSegment(segment) {
-	return typeof segment === "number";
-}
-function formatPath(path) {
-	return path.map((segment, index) => isNumericPathSegment(segment) ? `[${segment}]` : index > 0 ? `.${String(segment)}` : String(segment)).join("");
-}
-/**
-* Normalize a Standard Schema issue path to an array of `PropertyKey`.
-*
-* Standard Schema paths contain either bare `PropertyKey` values or
-* `{ key: PropertyKey }` segment objects; both forms are flattened to
-* plain `PropertyKey`. Returns an empty array for a root-level issue
-* (`undefined`).
-*/
-function isStandardPathSegment(segment) {
-	return typeof segment === "object" && segment !== null && "key" in segment;
-}
-function normalizeStandardPath(path) {
-	if (!path) return [];
-	return path.map((segment) => isStandardPathSegment(segment) ? segment.key : segment);
-}
+//#region src/merge.ts
 /**
-* Normalize Standard Schema issues into canonical `ValidationIssue` objects.
-*
-* Applies an optional prefix (e.g. `["flags", "verbose"]`) to each issue
-* path, then formats each path to its canonical dot-path string.
-*
-* @param issues — Raw Standard Schema issues from a failed validation
-* @param prefix — Optional path segments prepended to each issue path
+* Sets an own enumerable data property. Plain assignment would invoke the
+* inherited `__proto__` setter instead of storing a `__proto__` field.
 */
-function normalizeStandardIssues(issues, prefix = []) {
-	return issues.map((issue) => {
-		const resolvedPath = normalizeStandardPath(issue.path);
-		const fullPath = [...prefix, ...resolvedPath];
-		return {
-			message: issue.message,
-			path: formatPath(fullPath)
-		};
+function setDocumentValue(document, key, value) {
+	Object.defineProperty(document, key, {
+		value,
+		writable: true,
+		enumerable: true,
+		configurable: true
 	});
 }
-//#endregion
-//#region src/merge.ts
 /**
 * Applies field defaults to a persisted config object.
 *
 * For each field defined in `fields`:
-* - If the key exists in `persisted`, the persisted value is used.
+* - If `persisted` has the key as an own property, the persisted value is used.
 * - If the key is missing and the field has a `default`, the default is used.
 *   Defaults are deep-copied to prevent shared nested mutation.
 * - If the key is missing and no default exists, the field is omitted
@@ -367,20 +286,14 @@ function normalizeStandardIssues(issues, prefix = []) {
 */
 function applyFieldDefaults(persisted, fields, pruneUnknown = true) {
 	const result = {};
-	for (const [key, def] of Object.entries(fields)) if (persisted && key in persisted) result[key] = persisted[key];
-	else if ("default" in def && def.default !== void 0) result[key] = structuredClone(def.default);
+	for (const [key, def] of Object.entries(fields)) if (persisted && Object.hasOwn(persisted, key)) setDocumentValue(result, key, persisted[key]);
+	else if ("default" in def && def.default !== void 0) setDocumentValue(result, key, structuredClone(def.default));
 	if (!pruneUnknown && persisted !== void 0) {
-		for (const [key, value] of Object.entries(persisted)) if (!(key in fields)) result[key] = value;
+		for (const [key, value] of Object.entries(persisted)) if (!Object.hasOwn(fields, key)) setDocumentValue(result, key, value);
 	}
 	return result;
 }
 //#endregion
-//#region ../utils/src/error.ts
-/** Narrows a caught Node.js system error to its stable errno contract. */
-function isErrnoException(error) {
-	return error instanceof Error && "code" in error && typeof error.code === "string";
-}
-//#endregion
 //#region src/persistence.ts
 /**
 * Reads and parses a JSON config file from disk.
@@ -587,21 +500,25 @@ function createStore(options) {
 	function normalizeStateTypes(state) {
 		const normalized = { ...state };
 		for (const [key, def] of Object.entries(fields)) {
-			if (!(key in normalized) || def.schema !== void 0) continue;
+			if (!Object.hasOwn(normalized, key)) {
+				if (key in normalized) setDocumentValue(normalized, key, void 0);
+				continue;
+			}
+			if (def.schema !== void 0) continue;
 			const value = normalized[key];
 			if (value === void 0) continue;
 			if (def.array === true && Array.isArray(value)) {
-				normalized[key] = value.map((item) => coerceByType(item, def.type));
+				setDocumentValue(normalized, key, value.map((item) => coerceByType(item, def.type)));
 				continue;
 			}
-			normalized[key] = coerceByType(value, def.type);
+			setDocumentValue(normalized, key, coerceByType(value, def.type));
 		}
 		return normalized;
 	}
 	async function runFieldValidators(mutableState, operation) {
 		const issues = [];
 		for (const [key, def] of Object.entries(fields)) {
-			const value = mutableState[key];
+			const value = Object.hasOwn(mutableState, key) ? mutableState[key] : void 0;
 			if (value === void 0 && def.schema === void 0) {
 				if (def.default !== void 0) issues.push({
 					message: expectedTypeMessage(def),
@@ -633,7 +550,7 @@ function createStore(options) {
 			if (isFieldValueResult(result)) {
 				const transformed = result.value;
 				if (operation === "read") {
-					if (def.schema !== void 0) mutableState[key] = transformed;
+					if (def.schema !== void 0) setDocumentValue(mutableState, key, transformed);
 					continue;
 				}
 				if (def.schema === void 0 && !matchesDeclaredType(def, transformed)) {
@@ -662,7 +579,7 @@ function createStore(options) {
 						});
 						continue;
 					}
-					mutableState[key] = transformed;
+					setDocumentValue(mutableState, key, transformed);
 				}
 			}
 		}

package/package.json

@@ -1,69 +1,69 @@
 {
-	"name": "@crustjs/store",
-	"version": "0.4.0",
-	"description": "DX-first, typed persistence for CLI apps with config/data/state/cache separation",
-	"type": "module",
-	"sideEffects": false,
-	"license": "MIT",
-	"author": "chenxin-yan",
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/chenxin-yan/crust.git",
-		"directory": "packages/store"
-	},
-	"homepage": "https://crustjs.com",
-	"bugs": {
-		"url": "https://github.com/chenxin-yan/crust/issues"
-	},
-	"keywords": [
-		"cli",
-		"config",
-		"data",
-		"state",
-		"cache",
-		"store",
-		"persistence",
-		"xdg",
-		"bun",
-		"typescript"
-	],
-	"files": [
-		"dist"
-	],
-	"exports": {
-		".": {
-			"types": "./dist/index.d.ts",
-			"import": "./dist/index.js"
-		}
-	},
-	"publishConfig": {
-		"access": "public"
-	},
-	"scripts": {
-		"build": "tsdown",
-		"dev": "tsdown --watch",
-		"check:types": "tsc --noEmit",
-		"test": "bun test",
-		"prepack": "cp ../../LICENSE LICENSE",
-		"postpack": "rm -f LICENSE"
-	},
-	"devDependencies": {
-		"@crustjs/config": "0.0.0",
-		"zod": "^4.5.4",
-		"@crustjs/utils": "0.0.0",
-		"tsdown": "^0.23.0"
-	},
-	"peerDependencies": {
-		"typescript": "^7.0.0"
-	},
-	"peerDependenciesMeta": {
-		"typescript": {
-			"optional": true
-		}
-	},
-	"engines": {
-		"bun": ">=1.4.0",
-		"node": ">=22",
-		"deno": ">=2.8"
-	}
-}
+  "name": "@crustjs/store",
+  "version": "0.4.2",
+  "description": "DX-first, typed persistence for CLI apps with config/data/state/cache separation",
+  "type": "module",
+  "sideEffects": false,
+  "license": "MIT",
+  "author": "chenxin-yan",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/chenxin-yan/crust.git",
+    "directory": "packages/store"
+  },
+  "homepage": "https://crustjs.com",
+  "bugs": {
+    "url": "https://github.com/chenxin-yan/crust/issues"
+  },
+  "keywords": [
+    "cli",
+    "config",
+    "data",
+    "state",
+    "cache",
+    "store",
+    "persistence",
+    "xdg",
+    "bun",
+    "typescript"
+  ],
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@crustjs/utils": "^0.2.0"
+  },
+  "devDependencies": {
+    "@crustjs/config": "0.0.0",
+    "zod": "^4.5.4",
+    "vite-plus": "1.0.0-rc.0"
+  },
+  "peerDependencies": {
+    "typescript": "^7.0.0"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "bun": ">=1.4.0",
+    "node": ">=22",
+    "deno": ">=2.8"
+  },
+  "scripts": {
+    "build": "vp run build:task",
+    "dev": "vp pack --watch",
+    "check:types": "vp run check:types:task",
+    "test": "vp run test:task"
+  }
+}