README.md

Author: fprl

README.md

@@ -21,10 +21,10 @@ throw new Error('User not found') // ← What is this? Who handles it? Who knows
 ## Features
 
 - Central **codes registry** with typed `props`
-- Helpers: `errors.throw`, `errors.is`, `errors.match`, `errors.hasTag`
+- Fully typed helpers with autocomplete: `errors.create()`, `errors.is()`, `errors.match()`, `errors.hasTag()`
 - Built-in **serialize/deserialize** across boundaries
 - Optional **scoped zones** for complex services
-- **Plugins** — import error definitions from Stripe, Prisma, your own packages, etc.
+- **Plugins** — extend with pre-defined error sets from shared packages
 - Zero runtime dependencies
 
 ## Install
@@ -36,17 +36,27 @@ npm install errata
 ## Quick Start
 
 ```ts
-import { errata } from 'errata'
+import { code, errata, props } from 'errata'
 
 const errors = errata({
   codes: {
-    'user.not_found': { status: 404, message: 'User not found' },
-    'auth.unauthorized': { status: 401, message: 'Not authenticated' },
+    'user.not_found': code({
+      status: 404,
+      message: ({ details }) => `User ${details.userId} not found`,
+      details: props<{ userId: string }>(),
+      tags: ['auth', 'user'] as const,
+    }),
+    'auth.unauthorized': code({
+      status: 401,
+      message: 'Not authenticated',
+      expose: true,
+      tags: ['auth', 'security'] as const,
+    }),
   }
 })
 
-// Throw
-errors.throw('user.not_found')
+// Create and throw
+throw errors.create('user.not_found', { userId: '123' })
 
 // Check
 if (errors.is(e, 'auth.unauthorized')) { ... }
@@ -56,28 +66,30 @@ errors.match(e, {
   'user.not_found': () => show404(),
   'auth.unauthorized': () => redirect('/login'),
 })
+
+// Check tags
+if (errors.hasTag(e, 'security')) { ... }
 ```
 
 ## Plugins
 
-Extend your registry with pre-defined error sets:
+Extend your registry with pre-defined error sets from shared packages:
 
 ```ts
 import { myBackendErrors } from '@my-org/api-errors'
 import { errata } from 'errata'
-import { stripeErrors } from 'errata-stripe'
 
 const errors = errata({
   codes: {
     'app.unknown': { status: 500, message: 'Something went wrong' }
   },
-  plugins: [stripeErrors(), myBackendErrors()]
+  plugins: [myBackendErrors()]
 })
 
-// Now you can handle Stripe errors with full type safety
+// Now you can handle backend errors with full type safety
 errors.match(e, {
-  'stripe.card_declined': () => showCardError(),
-  'stripe.rate_limit': () => retry(),
+  'payment.declined': () => showCardError(),
+  'rate_limit': () => retry(),
 })
 ```
 
@@ -102,6 +114,6 @@ Then for future releases, you can run `pnpm run release` and the GitHub Actions
 [bundle-src]: https://img.shields.io/bundlephobia/minzip/errata?style=flat&colorA=080f12&colorB=1fa669&label=minzip
 [bundle-href]: https://bundlephobia.com/result?p=errata
 [license-src]: https://img.shields.io/github/license/fprl/errata.svg?style=flat&colorA=080f12&colorB=1fa669
-[license-href]: https://github.com/fprl/errata/blob/main/LICENSE
+[license-href]: https://github.com/fprl/errata/blob/main/LICENSE.md
 [jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12?style=flat&colorA=080f12&colorB=1fa669
 [jsdocs-href]: https://www.jsdocs.io/package/errata