react-router-define-api 0.1.0 → 0.1.1

package/README.md

@@ -16,103 +16,48 @@ npm install react-router-define-api
 // app/routes/api.users.ts
 import { defineApi } from 'react-router-define-api';
 
-const api = defineApi({
+export const { loader, action } = defineApi({
   GET: async ({ params }) => {
     const users = await db.users.findMany();
     return { users };
   },
   POST: async ({ request }) => {
     const body = await request.formData();
-    const user = await db.users.create({ name: body.get('name') });
-    return { user };
+    return { user: await db.users.create({ name: body.get('name') }) };
   },
   DELETE: async ({ params }) => {
     await db.users.delete(params.id);
     return { deleted: true };
   },
 });
-
-export const loader = api.loader;
-export const action = api.action;
 ```
 
 ### How it works
 
-- `GET` handler → exported as `loader`
-- `POST`, `PUT`, `PATCH`, `DELETE` handlers → dispatched inside `action` by `request.method`
-- Undefined methods return a `405 Method Not Allowed` response
-
-### All methods
-
-```ts
-const api = defineApi({
-  GET: async (args) => {
-    /* ... */
-  },
-  POST: async (args) => {
-    /* ... */
-  },
-  PUT: async (args) => {
-    /* ... */
-  },
-  PATCH: async (args) => {
-    /* ... */
-  },
-  DELETE: async (args) => {
-    /* ... */
-  },
-});
-```
-
-## API
-
-### `defineApi(handlers)`
+- `GET` → `loader`
+- `POST`, `PUT`, `PATCH`, `DELETE` → dispatched inside `action` by `request.method`
+- Undefined methods → `405 Method Not Allowed`
 
-| Parameter  | Type          | Description                              |
-| ---------- | ------------- | ---------------------------------------- |
-| `handlers` | `ApiHandlers` | Map of HTTP methods to handler functions |
-
-Returns `{ loader, action }` — each is `undefined` if no relevant methods are defined.
-
-Handler args are the same as React Router's `LoaderFunctionArgs` / `ActionFunctionArgs`:
-
-- `request` — the incoming `Request` object
-- `params` — route parameters
-- `context` — app context
-
-## TypeScript
+### Response type helpers
 
-Full type inference — return types are inferred from your handler functions.
+Access inferred response types for client-side fetchers or shared contracts:
 
 ```ts
 const api = defineApi({
   GET: async ({ params }) => ({ id: params.id, name: 'John' }),
-  POST: async ({ request }) => {
-    const body = await request.formData();
-    return { created: true, name: body.get('name') };
-  },
+  POST: async () => ({ created: true }),
 });
 
-// api.loader return type is inferred as { id: string | undefined, name: string }
-// api.action is undefined when no action methods defined
-```
-
-### Response type helpers
+export const { loader, action } = api;
 
-Access inferred response types via `typeof api.*Response` — useful for typing client-side fetchers or shared contracts:
-
-```ts
 type GetRes = typeof api.GetResponse;
 // → { id: string | undefined; name: string }
 
 type PostRes = typeof api.PostResponse;
-// → { created: boolean; name: FormDataEntryValue | null }
-
-// Undefined methods → never
-type PutRes = typeof api.PutResponse; // → never
+// → { created: boolean }
 ```
 
-These are **type-only** — zero runtime cost.
+These are **type-only** — zero runtime cost. Undefined methods resolve to `never`.
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-router-define-api",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Define HTTP method handlers for React Router v7 routes",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -49,5 +49,13 @@
     "typescript": "^6.0.2",
     "ultracite": "^7.4.0",
     "vitest": "^4.1.2"
-  }
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sonicname/react-router-define-api.git"
+  },
+  "bugs": {
+    "url": "https://github.com/sonicname/react-router-define-api/issues"
+  },
+  "homepage": "https://github.com/sonicname/react-router-define-api#readme"
 }