@domain-first/types 1.0.0 → 1.0.2

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://badge.fury.io/js/@domain-first%2Ftypes.svg" alt="version">
+  <img src="https://img.shields.io/bundlephobia/minzip/%40domain-first%2Ftypes" alt="size">
+  <img src="https://img.shields.io/npm/l/%40domain-first%2Ftypes" 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/dist/errors/index.d.ts

@@ -1,3 +1,2 @@
 export * from './async-schema-in-sync-parsing-error';
 export * from './invalid-data-parsing-error';
-export * from './structured-clone-not-found-error';

package/dist/index.cjs

@@ -30,7 +30,6 @@ __webpack_require__.r(__webpack_exports__);
 __webpack_require__.d(__webpack_exports__, {
     AsyncSchemaInSyncParsingError: ()=>AsyncSchemaInSyncParsingError,
     InvalidDataParsingError: ()=>InvalidDataParsingError,
-    StructuredCloneNotFoundError: ()=>StructuredCloneNotFoundError,
     defineValueObject: ()=>defineValueObject
 });
 const errors_namespaceObject = require("@domain-first/errors");
@@ -40,9 +39,6 @@ const AsyncSchemaInSyncParsingError = (0, errors_namespaceObject.defineErrorClas
 const InvalidDataParsingError = (0, errors_namespaceObject.defineErrorClass)({
     code: 'INVALID_DATA_PARSING'
 });
-const StructuredCloneNotFoundError = (0, errors_namespaceObject.defineErrorClass)({
-    code: 'STRUCTURED_CLONE_NOT_FOUND'
-});
 function parseSync(schema, value) {
     const result = schema['~standard'].validate(value);
     if (result instanceof Promise) throw new AsyncSchemaInSyncParsingError({
@@ -82,12 +78,10 @@ const defineValueObject = (schema)=>{
 };
 exports.AsyncSchemaInSyncParsingError = __webpack_exports__.AsyncSchemaInSyncParsingError;
 exports.InvalidDataParsingError = __webpack_exports__.InvalidDataParsingError;
-exports.StructuredCloneNotFoundError = __webpack_exports__.StructuredCloneNotFoundError;
 exports.defineValueObject = __webpack_exports__.defineValueObject;
 for(var __rspack_i in __webpack_exports__)if (-1 === [
     "AsyncSchemaInSyncParsingError",
     "InvalidDataParsingError",
-    "StructuredCloneNotFoundError",
     "defineValueObject"
 ].indexOf(__rspack_i)) exports[__rspack_i] = __webpack_exports__[__rspack_i];
 Object.defineProperty(exports, '__esModule', {

package/dist/index.js

@@ -5,9 +5,6 @@ const AsyncSchemaInSyncParsingError = defineErrorClass({
 const InvalidDataParsingError = defineErrorClass({
     code: 'INVALID_DATA_PARSING'
 });
-const StructuredCloneNotFoundError = defineErrorClass({
-    code: 'STRUCTURED_CLONE_NOT_FOUND'
-});
 function parseSync(schema, value) {
     const result = schema['~standard'].validate(value);
     if (result instanceof Promise) throw new AsyncSchemaInSyncParsingError({
@@ -45,4 +42,4 @@ const defineValueObject = (schema)=>{
     }
     return ValueObject;
 };
-export { AsyncSchemaInSyncParsingError, InvalidDataParsingError, StructuredCloneNotFoundError, defineValueObject };
+export { AsyncSchemaInSyncParsingError, InvalidDataParsingError, defineValueObject };

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.0",
+    "version": "1.0.2",
     "type": "module",
     "repository": {
         "type": "git",

package/dist/errors/structured-clone-not-found-error.d.ts

@@ -1,46 +0,0 @@
-export declare const StructuredCloneNotFoundError: {
-    new (details: Record<string, any>, options?: ErrorOptions): {
-        readonly metadata: import("@domain-first/errors").PlainPrimitivesObject & {
-            code: string;
-        };
-        readonly details: Record<string, any>;
-        readonly formattedDetails: import("@domain-first/errors").PlainPrimitivesObject;
-        readonly serialized: import("@domain-first/errors").TransportedError<import("@domain-first/errors").PlainPrimitivesObject & {
-            code: string;
-        }>;
-        readonly serializedWithNativeData: import("@domain-first/errors").TransportedErrorWithNativeData<import("@domain-first/errors").PlainPrimitivesObject & {
-            code: string;
-        }>;
-        readonly serializedFull: import("@domain-first/errors").FullTransportedError<Record<string, any>, import("@domain-first/errors").PlainPrimitivesObject & {
-            code: string;
-        }>;
-        name: string;
-        message: string;
-        stack?: string;
-        cause?: unknown;
-    };
-    matches: (target: unknown) => boolean | null;
-    is: (target: unknown) => target is {
-        readonly metadata: import("@domain-first/errors").PlainPrimitivesObject & {
-            code: string;
-        };
-        readonly details: Record<string, any>;
-        get formattedDetails(): import("@domain-first/errors").PlainPrimitivesObject;
-        get serialized(): import("@domain-first/errors").TransportedError<import("@domain-first/errors").PlainPrimitivesObject & {
-            code: string;
-        }>;
-        get serializedWithNativeData(): import("@domain-first/errors").TransportedErrorWithNativeData<import("@domain-first/errors").PlainPrimitivesObject & {
-            code: string;
-        }>;
-        get serializedFull(): import("@domain-first/errors").FullTransportedError<Record<string, any>, import("@domain-first/errors").PlainPrimitivesObject & {
-            code: string;
-        }>;
-        name: string;
-        message: string;
-        stack?: string;
-        cause?: unknown;
-    };
-    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
-    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
-    stackTraceLimit: number;
-};