@domain-first/types 1.0.1 → 1.0.3

package/README.md

@@ -5,7 +5,13 @@
 </p>
 
 <p align="center">
-    Type-safe Entities and Value Objects with Standard Schema validation.
+    Type-safe Entities and Value Objects powered by Standard Schema.
+</p>
+
+<p align="center">
+  <img src="https://img.shields.io/npm/v/%40domain-first%2Ftypes?style=for-the-badge" alt="version">
+  <img src="https://img.shields.io/bundlephobia/minzip/%40domain-first%2Ftypes?style=for-the-badge" alt="size">
+  <img src="https://img.shields.io/npm/l/%40domain-first%2Ftypes?style=for-the-badge" alt="license">
 </p>
 
 # Installation
@@ -14,31 +20,49 @@
 npm i @domain-first/types
 ```
 
+# Motivation
+
+Building Entities and Value Objects often involves repetitive boilerplate, such as validation, while each class still needs its own domain-specific behavior. Domain-First Types implements the shared parts while leaving domain-specific behavior to your classes.
+
 # Quick Start
 
 ```ts
-import { defineValueObject, defineEntity } from "@domain-first/types";
+import {
+    defineValueObject,
+    defineEntity,
+    InvalidDataParsingError,
+} from "@domain-first/types";
 // any schema library supporting Standard Schema can be used
 import { z } from "zod";
 
-// User Id (Value Object)
 class UserId extends defineValueObject(
     // model schema
     z.string().nonempty(),
 ) {}
 
-// User (Entity)
 class User extends defineEntity(
     // id schema
-    z.custom<UserId>(UserId.is),
+    z.custom<UserId>(
+        // every Entity and Value Object has a static `is` method
+        // for type-safe instance checks
+        UserId.is,
+    ),
     // model schema
     z.object({ name: z.string().nonempty() }),
 ) {}
 
-const user = new User(
-    // identifier
-    new UserId("user-1"),
-    // model
-    { name: "First User" },
-);
+const user = new User(new UserId("user-1"), { name: "First User" });
+
+console.log(user.id.model); // "user-1", deep readonly
+console.log(user.model); // { name: "First User" }, deep readonly
+
+try {
+    const invalidUserId = new UserId("");
+} catch (e: unknown) {
+    // use static `is` method for error checks
+    if (InvalidDataParsingError.is(e)) {
+        console.error(e.details.parsingIssues);
+        console.error(e.details.value);
+    }
+}
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@domain-first/types",
-    "description": "Type-safe Entities and Value Objects with Standard Schema validation",
+    "description": "Type-safe Entities and Value Objects powered by Standard Schema",
     "license": "MIT",
     "keywords": [
         "entity",
@@ -10,7 +10,7 @@
         "domain model",
         "domain-first"
     ],
-    "version": "1.0.1",
+    "version": "1.0.3",
     "type": "module",
     "repository": {
         "type": "git",