@fjell/validation 4.4.4 → 4.4.6

package/LICENSE

@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2025 Fjell Project
+   Copyright 2026 Tim O'Brien
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

package/guide/index.md

@@ -0,0 +1,30 @@
+# @fjell/validation - Agentic Guide
+
+## Purpose
+
+Validation utilities for keys, item payloads, schema constraints, and location metadata.
+
+This guide is optimized for AI-assisted code generation and integration workflows.
+
+## Documentation
+
+- **[Usage Guide](./usage.md)** - API-oriented usage patterns and model-safe examples
+- **[Integration Guide](./integration.md)** - Architecture placement, composition rules, and implementation guidance
+
+## Key Capabilities
+
+- Validates primary and contained key shapes before persistence operations
+- Checks location metadata and schema-level constraints
+- Returns structured validation errors for API and UI layers
+
+## Installation
+
+```bash
+npm install @fjell/validation
+```
+
+## Public API Highlights
+
+- `validateKey`, `validatePriKey`, `validateComKey`
+- `validatePK`, `validateKeys`, `validateLocations`
+- `validateSchema` and `ValidationError` for schema-driven validation

package/guide/integration.md

@@ -0,0 +1,32 @@
+# Integration Guide
+
+Guide for integrating `@fjell/validation` into larger Fjell-based systems.
+
+## Where It Fits
+
+Validation utilities for keys, item payloads, schema constraints, and location metadata.
+
+## Recommended Integration Pattern
+
+- Run validation at API boundaries before calling @fjell/lib or backend libraries
+- Convert validation failures into deterministic HTTP error payloads
+- Use the same validation functions in tests to keep fixtures aligned with runtime rules
+
+## System Composition Checklist
+
+- Define package boundaries: schema/types, transport, operations, adapters, and UI.
+- Keep contracts stable by sharing @fjell/types interfaces where applicable.
+- Centralize retries/timeouts/logging around infrastructure-facing operations.
+- Validate inputs at API boundaries before invoking persistence or provider layers.
+- Add contract and integration tests for every generated workflow.
+
+## Cross-Library Pairings
+
+- Pair with @fjell/types for shared contracts.
+- Pair with @fjell/validation for input and schema checks.
+- Pair with @fjell/logging for observability in integration flows.
+- Pair with storage/router/provider packages based on your runtime architecture.
+
+## Integration Example Shape
+
+Use this package behind an application service layer that exposes stable domain methods. Generated code should call those service methods, not raw infrastructure primitives, unless your architecture intentionally keeps infrastructure at the edge.

package/guide/usage.md

@@ -0,0 +1,40 @@
+# Usage Guide
+
+Comprehensive usage guidance for `@fjell/validation`.
+
+## Installation
+
+```bash
+npm install @fjell/validation
+```
+
+## API Highlights
+
+- `validateKey`, `validatePriKey`, `validateComKey`
+- `validatePK`, `validateKeys`, `validateLocations`
+- `validateSchema` and `ValidationError` for schema-driven validation
+
+## Quick Example
+
+```ts
+import { validatePriKey, ValidationError } from "@fjell/validation";
+
+const result = validatePriKey({ pk: "widget#123", sk: "meta" });
+if (!result.valid) {
+  throw new ValidationError("Invalid key", result.errors);
+}
+```
+
+## Model Consumption Rules
+
+1. Import from the package root (`@fjell/validation`) instead of deep-internal paths unless explicitly documented.
+2. Keep usage aligned with exported public symbols listed in this guide.
+3. Prefer explicit typing at package boundaries so generated code remains robust during upgrades.
+4. Keep error handling deterministic and map infrastructure failures into domain-level errors.
+5. Co-locate integration wrappers in your app so model-generated code has one canonical entry point.
+
+## Best Practices
+
+- Keep examples and abstractions consistent with existing Fjell package conventions.
+- Favor composable wrappers over one-off inline integration logic.
+- Add targeted tests around generated integration code paths.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@fjell/validation",
   "description": "Validation Logic for Fjell Items and Keys",
-  "version": "4.4.4",
+  "version": "4.4.6",
   "keywords": [
     "validation",
     "fjell"
@@ -27,13 +27,13 @@
     "prepublishOnly": "npm run clean && npm run build"
   },
   "dependencies": {
-    "@fjell/logging": "^4.4.67",
-    "@fjell/types": "4.4.6"
+    "@fjell/logging": "^4.4.72",
+    "@fjell/types": "^4.4.9"
   },
   "devDependencies": {
     "@eslint/eslintrc": "^3.3.1",
     "@eslint/js": "^9.39.1",
-    "@fjell/common-config": "^1.1.37",
+    "@fjell/common-config": "^1.1.38",
     "@swc/core": "^1.15.2",
     "@tsconfig/recommended": "^1.0.13",
     "@types/luxon": "^3.7.1",