Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
1 change: 0 additions & 1 deletion docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -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' },
],
},
];
Expand Down
2 changes: 0 additions & 2 deletions docs/getting-started/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
29 changes: 0 additions & 29 deletions docs/guides/agent-skill.md

This file was deleted.

1 change: 0 additions & 1 deletion docs/guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
1 change: 0 additions & 1 deletion docs/guides/serialization.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
8 changes: 0 additions & 8 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 0 additions & 2 deletions docs/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
1 change: 0 additions & 1 deletion docs/reference/md5-hash.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion docs/reference/sha256-hash.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 0 additions & 1 deletion docs/reference/sha512-hash.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading