@nitrotool/errors 0.0.5 → 0.0.7

package/README.md

@@ -0,0 +1,72 @@
+# @nitrotool/errors
+
+Reusable error utilities for H3-based applications.  
+This package provides a collection of typed error helpers that create `H3Error` instances with standardized HTTP status
+codes and messages.
+
+## Installation
+
+```bash
+pnpm install @nitrotool/errors
+```
+
+```bash
+npm install @nitrotool/errors
+```
+
+## Usage
+
+```ts
+import {
+    UnauthenticatedError,
+    UnauthorizedError,
+    NotFoundError,
+    EntityAlreadyExistsError,
+    ServerError,
+    ClientError,
+    UnprocessableEntityError,
+    BadRequestError,
+} from '@nitrotool/errors';
+
+// Example in an API handler
+export default defineEventHandler((event) => {
+    const authHeader = getHeader(event, 'authorization');
+    if (!authHeader) {
+        throw UnauthenticatedError('Missing auth token');
+    }
+
+    if (!isUserAllowed(authHeader)) {
+        throw UnauthorizedError('You do not have access to this resource');
+    }
+
+// ...
+});
+```
+
+## API
+
+| Function                     | Status Code | Status Message            |
+|------------------------------|-------------|---------------------------|
+| `UnauthenticatedError`     | `401`     | `Unauthenticated`       |
+| `UnauthorizedError`        | `403`     | `Unauthorized`          |
+| `NotFoundError`            | `404`     | `Not found`             |
+| `EntityAlreadyExistsError` | `409`     | `Entity Already Exists` |
+| `ClientError`              | `400`     | `Client Error`          |
+| `BadRequestError`          | `400`     | `Bad Request`           |
+| `UnprocessableEntityError` | `422`     | `Unprocessable Entity`  |
+| `ServerError`              | `500`     | `Internal Server Error` |
+
+## Development
+
+Build the package:
+
+```bash
+pnpm build
+```
+
+The package uses [unbuild](https://github.com/unjs/unbuild) for generating `dist/` with both `index.mjs` and type
+definitions.
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,12 @@
+import * as h3 from 'h3';
+
+declare const UnauthenticatedError: (message?: string) => h3.H3Error<unknown>;
+declare const UnauthorizedError: (message?: string) => h3.H3Error<unknown>;
+declare const NotFoundError: (message?: string) => h3.H3Error<unknown>;
+declare const EntityAlreadyExistsError: (message?: string) => h3.H3Error<unknown>;
+declare const ServerError: (message?: string) => h3.H3Error<unknown>;
+declare const ClientError: (message?: string) => h3.H3Error<unknown>;
+declare const UnprocessableEntityError: (message?: string) => h3.H3Error<unknown>;
+declare const BadRequestError: (message?: string) => h3.H3Error<unknown>;
+
+export { BadRequestError, ClientError, EntityAlreadyExistsError, NotFoundError, ServerError, UnauthenticatedError, UnauthorizedError, UnprocessableEntityError };

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+import * as h3 from 'h3';
+
+declare const UnauthenticatedError: (message?: string) => h3.H3Error<unknown>;
+declare const UnauthorizedError: (message?: string) => h3.H3Error<unknown>;
+declare const NotFoundError: (message?: string) => h3.H3Error<unknown>;
+declare const EntityAlreadyExistsError: (message?: string) => h3.H3Error<unknown>;
+declare const ServerError: (message?: string) => h3.H3Error<unknown>;
+declare const ClientError: (message?: string) => h3.H3Error<unknown>;
+declare const UnprocessableEntityError: (message?: string) => h3.H3Error<unknown>;
+declare const BadRequestError: (message?: string) => h3.H3Error<unknown>;
+
+export { BadRequestError, ClientError, EntityAlreadyExistsError, NotFoundError, ServerError, UnauthenticatedError, UnauthorizedError, UnprocessableEntityError };

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@nitrotool/errors",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "type": "module",
   "main": "./dist/index.mjs",
   "exports": {
     ".": "./dist/index.mjs"
   },
+  "types": "./dist/index.d.ts",
   "dependencies": {
     "h3": "^1.15.3"
   },

package/src/index.ts

@@ -1,31 +0,0 @@
-import { createError } from 'h3';
-
-export const UnauthenticatedError = (message?: string) =>
-  createError({ statusCode: 401, statusMessage: 'Unauthenticated', message });
-export const UnauthorizedError = (message?: string) =>
-  createError({ statusCode: 403, statusMessage: 'Unauthorized', message });
-export const NotFoundError = (message?: string) =>
-  createError({ statusCode: 404, statusMessage: 'Not found', message });
-export const EntityAlreadyExistsError = (message?: string) =>
-  createError({
-    statusCode: 409,
-    statusMessage: 'Entity Already Exists',
-    message,
-  });
-export const ServerError = (message?: string) =>
-  createError({
-    statusCode: 500,
-    statusMessage: 'Internal Server Error',
-    message,
-  });
-export const ClientError = (message?: string) =>
-  createError({ statusCode: 400, statusMessage: 'Client Error', message });
-export const UnprocessableEntityError = (message?: string) =>
-  createError({
-    statusCode: 422,
-    statusMessage: 'Unprocessable Entity',
-    message,
-  });
-
-export const BadRequestError = (message?: string) =>
-  createError({ statusCode: 400, statusMessage: 'Bad Request', message });