diff --git a/README.md b/README.md index 8b17331..dbe92a7 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,6 @@ A TypeScript library for validated, immutable primitive wrappers and small utili It provides ready-to-use objects for strings, numbers, identifiers, dates, coordinates, hashes, media, and collections. Validation happens when an object is created, so code receiving one of these objects can rely on its shape. -Cryptographic operations are intentionally outside this package. Pigeon Swarm-specific cryptography lives in `@haskou/pigeon-swarm-crypto`; dependency direction is one-way, with the crypto package allowed to consume generic value-object representations and never the reverse. - The package publishes ESM and CommonJS entry points plus TypeScript declarations. Both entry points share one runtime implementation, so class identity and NullObject configuration stay consistent when imports and requires are mixed. It does not declare a Node.js engine requirement. Identifier generation uses the installed `uuid` dependency with platform-specific Node and browser implementations. ## Documentation @@ -20,8 +18,6 @@ Full documentation is available at **https://haskou.github.io/value-objects/**. The documentation includes installation, quick start, examples, error handling, serialization notes, and one reference page per exported class. -Reusable agent instructions and engineering skills are available at **https://github.com/haskou/ddd-engineer-skills**. - ## Installation ```bash diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 3f44a2d..c15f41c 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -21,7 +21,6 @@ const guideSidebar = [ { text: 'Serialization', link: '/guides/serialization' }, { text: 'Null object', link: '/guides/null-object' }, { text: 'Release flow', link: '/guides/release-flow' }, - { text: 'Agent skill', link: '/guides/agent-skill' }, ], }, ]; diff --git a/docs/getting-started/introduction.md b/docs/getting-started/introduction.md index e71d16f..9b41cf1 100644 --- a/docs/getting-started/introduction.md +++ b/docs/getting-started/introduction.md @@ -39,8 +39,6 @@ amount.isGreaterThan(5); // true | Media | `Media` | | Collections | `UniqueObjectArray` | -Cryptographic behavior is intentionally not part of this generic package. Pigeon Swarm-specific cryptography lives in `@haskou/pigeon-swarm-crypto`, which may depend on `@haskou/value-objects`; the dependency never points back from this package into Pigeon Swarm. - The package provides separate ESM and CommonJS entry points and does not declare a Node.js engine requirement. Identifier generation delegates to the installed `uuid` dependency for Node and browser support. ## Design expectations diff --git a/docs/guides/agent-skill.md b/docs/guides/agent-skill.md deleted file mode 100644 index 7af01b3..0000000 --- a/docs/guides/agent-skill.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Agent skill -description: Link to the reusable agent skill repository. ---- - -# Agent skill - -A reusable agent skill is available here: - -https://github.com/haskou/ddd-engineer-skills - -The skill repository is separate from this package. This keeps the runtime library focused on code, tests, and documentation, while the agent skill can evolve independently. - -## Use cases - -The skill can help coding agents with repetitive maintenance tasks around this style of value object: - -- creating a new value object with validation and tests -- reviewing public exports -- checking serialization behavior -- checking error behavior -- keeping examples consistent with the package API - -## Repository split - -| Repository | Purpose | -| --- | --- | -| `haskou/value-objects` | Runtime package and documentation. | -| `haskou/ddd-engineer-skills` | Reusable agent instructions and workflows. | diff --git a/docs/guides/index.md b/docs/guides/index.md index 4707805..c5d451a 100644 --- a/docs/guides/index.md +++ b/docs/guides/index.md @@ -14,4 +14,3 @@ Use these guides when you need to adapt value objects to application code, handl - [Serialization](/guides/serialization) - [Null object](/guides/null-object) - [Release flow](/guides/release-flow) -- [Agent skill](/guides/agent-skill) diff --git a/docs/guides/serialization.md b/docs/guides/serialization.md index f667c84..4ecb43b 100644 --- a/docs/guides/serialization.md +++ b/docs/guides/serialization.md @@ -41,4 +41,3 @@ const createdAt = new Timestamp(stored.createdAt); - `valueOf()` is the safest default for persistence payloads. - Use explicit helper methods when available. -- Cryptographic serialization belongs to the separate `@haskou/crypto` package. diff --git a/docs/index.md b/docs/index.md index b9d366b..71c1c7a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -42,11 +42,3 @@ yarn add @haskou/value-objects | [Hashes](/reference/hash) | `Hash`, `MD5Hash`, `SHA256Hash`, `SHA512Hash` | | [Media](/reference/media) | `Media` | | [Collections](/reference/unique-object-array) | `UniqueObjectArray` | - -Cryptographic operations are being extracted to `@haskou/crypto` and are intentionally not part of this package's value-object API. - -## Agent skill - -Reusable agent instructions and engineering skills live in [`haskou/ddd-engineer-skills`](https://github.com/haskou/ddd-engineer-skills). - -This repository documents and ships the runtime library. The skill repository is separate on purpose. diff --git a/docs/reference/index.md b/docs/reference/index.md index e2b9059..a49c592 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -49,5 +49,3 @@ Each exported class has its own page. - [`Timestamp`](/reference/timestamp) - [`TimestampInterval`](/reference/timestamp-interval) - [`Year`](/reference/year) - -Cryptographic operations are being extracted to `@haskou/crypto`. diff --git a/docs/reference/md5-hash.md b/docs/reference/md5-hash.md index 72d11c6..1ecb33f 100644 --- a/docs/reference/md5-hash.md +++ b/docs/reference/md5-hash.md @@ -53,7 +53,6 @@ hash.toString(); // '5d41402abc4b2a76b9719d911017c592' ## Notes -- This package validates MD5 values; digest computation belongs to `@haskou/crypto`. - MD5 is available for compatibility and identifiers. Do not use MD5 as a secure password hash. ## Related diff --git a/docs/reference/sha256-hash.md b/docs/reference/sha256-hash.md index ceed810..5316e8e 100644 --- a/docs/reference/sha256-hash.md +++ b/docs/reference/sha256-hash.md @@ -56,7 +56,6 @@ hash.toString().length; // 64 ## Notes - Validation is case-insensitive. -- This package validates SHA-256 values; digest computation belongs to `@haskou/crypto`. ## Related diff --git a/docs/reference/sha512-hash.md b/docs/reference/sha512-hash.md index b2bda13..44faef9 100644 --- a/docs/reference/sha512-hash.md +++ b/docs/reference/sha512-hash.md @@ -56,7 +56,6 @@ hash.toString().length; // 128 ## Notes - Validation is case-insensitive. -- This package validates SHA-512 values; digest computation belongs to `@haskou/crypto`. ## Related