errore 0.6.0 → 0.7.0

package/README.md

@@ -67,6 +67,78 @@ if (errore.isError(user)) {
 console.log(user.name)
 ```
 
+## Example: API Error Handling
+
+A complete example with custom base class, HTTP status codes, and error reporting:
+
+```ts
+import * as errore from 'errore'
+
+// Base class with shared functionality
+class AppError extends Error {
+  statusCode: number = 500
+  
+  toResponse() {
+    return { error: this.message, code: this.statusCode }
+  }
+}
+
+// Specific errors with status codes
+class NotFoundError extends errore.TaggedError('NotFoundError', AppError)<{
+  resource: string
+  message: string
+}>() {
+  statusCode = 404
+}
+
+class ValidationError extends errore.TaggedError('ValidationError', AppError)<{
+  field: string
+  message: string
+}>() {
+  statusCode = 400
+}
+
+class UnauthorizedError extends errore.TaggedError('UnauthorizedError', AppError)<{
+  message: string
+}>() {
+  statusCode = 401
+}
+
+// Service function
+async function updateUser(
+  userId: string,
+  data: { email?: string }
+): Promise<NotFoundError | ValidationError | UnauthorizedError | User> {
+  const session = await getSession()
+  if (!session) {
+    return new UnauthorizedError({ message: 'Not logged in' })
+  }
+  
+  const user = await db.users.find(userId)
+  if (!user) {
+    return new NotFoundError({ resource: 'user', message: `User ${userId} not found` })
+  }
+  
+  if (data.email && !isValidEmail(data.email)) {
+    return new ValidationError({ field: 'email', message: 'Invalid email format' })
+  }
+  
+  return db.users.update(userId, data)
+}
+
+// API handler
+app.post('/users/:id', async (req, res) => {
+  const result = await updateUser(req.params.id, req.body)
+  
+  if (errore.isError(result)) {
+    // All errors have toResponse() from AppError base
+    return res.status(result.statusCode).json(result.toResponse())
+  }
+  
+  return res.json(result)
+})
+```
+
 ## API
 
 ### Type Guards

package/dist/{index.mjs → index.cjs}

@@ -1,3 +1,48 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  TaggedError: () => TaggedError,
+  UnhandledError: () => UnhandledError,
+  andThen: () => andThen,
+  andThenAsync: () => andThenAsync,
+  flatten: () => flatten,
+  isError: () => isError,
+  isOk: () => isOk,
+  isTaggedError: () => isTaggedError,
+  map: () => map,
+  mapError: () => mapError,
+  match: () => match,
+  matchError: () => matchError,
+  matchErrorPartial: () => matchErrorPartial,
+  partition: () => partition,
+  tap: () => tap,
+  tapAsync: () => tapAsync,
+  tryAsync: () => tryAsync,
+  tryFn: () => tryFn,
+  unwrap: () => unwrap,
+  unwrapOr: () => unwrapOr
+});
+module.exports = __toCommonJS(index_exports);
+
 // src/error.ts
 var serializeCause = (cause) => {
   if (cause instanceof Error) {
@@ -191,7 +236,8 @@ function partition(values) {
 function flatten(value) {
   return value;
 }
-export {
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
   TaggedError,
   UnhandledError,
   andThen,
@@ -212,4 +258,4 @@ export {
   tryFn,
   unwrap,
   unwrapOr
-};
+});

package/dist/index.js

@@ -1,48 +1,3 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var index_exports = {};
-__export(index_exports, {
-  TaggedError: () => TaggedError,
-  UnhandledError: () => UnhandledError,
-  andThen: () => andThen,
-  andThenAsync: () => andThenAsync,
-  flatten: () => flatten,
-  isError: () => isError,
-  isOk: () => isOk,
-  isTaggedError: () => isTaggedError,
-  map: () => map,
-  mapError: () => mapError,
-  match: () => match,
-  matchError: () => matchError,
-  matchErrorPartial: () => matchErrorPartial,
-  partition: () => partition,
-  tap: () => tap,
-  tapAsync: () => tapAsync,
-  tryAsync: () => tryAsync,
-  tryFn: () => tryFn,
-  unwrap: () => unwrap,
-  unwrapOr: () => unwrapOr
-});
-module.exports = __toCommonJS(index_exports);
-
 // src/error.ts
 var serializeCause = (cause) => {
   if (cause instanceof Error) {
@@ -236,8 +191,7 @@ function partition(values) {
 function flatten(value) {
   return value;
 }
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
+export {
   TaggedError,
   UnhandledError,
   andThen,
@@ -258,4 +212,4 @@ function flatten(value) {
   tryFn,
   unwrap,
   unwrapOr
-});
+};

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "errore",
-  "version": "0.6.0",
+  "version": "0.7.0",
+  "type": "module",
   "description": "Type-safe errors as values for TypeScript. Like Go, but with full type inference.",
   "repository": {
     "type": "git",