enlace 0.0.1-beta.14 → 0.0.1-beta.16

package/README.md

@@ -30,9 +30,7 @@ type ApiSchema = {
 };
 
 // Pass global error type as second generic
-const useAPI = enlaceHookReact<ApiSchema, ApiError>(
-  "https://api.example.com"
-);
+const useAPI = enlaceHookReact<ApiSchema, ApiError>("https://api.example.com");
 ```
 
 ## Schema Conventions
@@ -42,7 +40,7 @@ Defining a schema is **recommended** for full type safety, but **optional**. You
 ```typescript
 // Without schema (untyped, but still works!)
 const useAPI = enlaceHookReact("https://api.example.com");
-const { data } = useAPI((api) => api.any.path.you.want.get());
+const { data } = useAPI((api) => api.any.path.you.want.$get());
 ```
 
 ```typescript
@@ -80,9 +78,9 @@ type ApiSchema = {
 const api = enlace<ApiSchema, ApiError>("https://api.example.com");
 
 // Usage
-api.users.get(); // GET /users
-api.users[123].get(); // GET /users/123
-api.users[123].profile.get(); // GET /users/123/profile
+api.users.$get(); // GET /users
+api.users[123].$get(); // GET /users/123
+api.users[123].profile.$get(); // GET /users/123/profile
 ```
 
 ### Endpoint Types
@@ -98,11 +96,11 @@ import { Endpoint } from "enlace";
 
 type ApiSchema = {
   posts: {
-    $get: Post[];                                   // Direct type (simplest)
-    $post: Endpoint<Post, CreatePost>;              // Data + Body
+    $get: Post[]; // Direct type (simplest)
+    $post: Endpoint<Post, CreatePost>; // Data + Body
     $put: Endpoint<Post, UpdatePost, ValidationError>; // Data + Body + Error
-    $delete: void;                                  // void response
-    $patch: Endpoint<Post, never, NotFoundError>;   // Custom error without body
+    $delete: void; // void response
+    $patch: Endpoint<Post, never, NotFoundError>; // Custom error without body
   };
 };
 ```
@@ -116,16 +114,25 @@ import { EndpointWithQuery } from "enlace";
 
 type ApiSchema = {
   users: {
-    $get: EndpointWithQuery<User[], { page: number; limit: number; search?: string }>;
+    $get: EndpointWithQuery<
+      User[],
+      { page: number; limit: number; search?: string }
+    >;
   };
   posts: {
-    $get: EndpointWithQuery<Post[], { status: "draft" | "published" }, ApiError>;
+    $get: EndpointWithQuery<
+      Post[],
+      { status: "draft" | "published" },
+      ApiError
+    >;
   };
 };
 
 // Usage - query params are fully typed
-const { data } = useAPI((api) => api.users.get({ query: { page: 1, limit: 10 } }));
-// api.users.get({ query: { foo: "bar" } }); // ✗ Error: 'foo' does not exist
+const { data } = useAPI((api) =>
+  api.users.$get({ query: { page: 1, limit: 10 } })
+);
+// api.users.$get({ query: { foo: "bar" } }); // ✗ Error: 'foo' does not exist
 ```
 
 #### `EndpointWithFormData<TData, TFormData, TError?>`
@@ -145,25 +152,25 @@ type ApiSchema = {
 };
 
 // Usage - formData is automatically converted to FormData
-const { trigger } = useAPI((api) => api.uploads.post);
+const { trigger } = useAPI((api) => api.uploads.$post);
 trigger({
   formData: {
-    file: selectedFile,        // File object
-    name: "document.pdf",      // String - converted automatically
-  }
+    file: selectedFile, // File object
+    name: "document.pdf", // String - converted automatically
+  },
 });
 // → Sends as multipart/form-data
 ```
 
 **FormData conversion rules:**
 
-| Type | Conversion |
-|------|------------|
-| `File` / `Blob` | Appended directly |
-| `string` / `number` / `boolean` | Converted to string |
-| `object` (nested) | JSON stringified |
-| `array` of primitives | Each item appended separately |
-| `array` of files | Each file appended with same key |
+| Type                            | Conversion                       |
+| ------------------------------- | -------------------------------- |
+| `File` / `Blob`                 | Appended directly                |
+| `string` / `number` / `boolean` | Converted to string              |
+| `object` (nested)               | JSON stringified                 |
+| `array` of primitives           | Each item appended separately    |
+| `array` of files                | Each file appended with same key |
 
 #### `EndpointFull<T>`
 
@@ -211,7 +218,7 @@ For GET requests that fetch data automatically:
 ```typescript
 function Posts({ page, limit }: { page: number; limit: number }) {
   const { data, loading, error } = useAPI((api) =>
-    api.posts.get({ query: { page, limit, published: true } })
+    api.posts.$get({ query: { page, limit, published: true } })
   );
 
   if (loading) return <div>Loading...</div>;
@@ -242,7 +249,7 @@ Skip fetching with the `enabled` option:
 function ProductForm({ id }: { id: string | "new" }) {
   // Skip fetching when creating a new product
   const { data, loading } = useAPI(
-    (api) => api.products[id].get(),
+    (api) => api.products[id].$get(),
     { enabled: id !== "new" }
   );
 
@@ -255,7 +262,7 @@ function ProductForm({ id }: { id: string | "new" }) {
 ```typescript
 // Also useful when waiting for a dependency
 function UserPosts({ userId }: { userId: string | undefined }) {
-  const { data } = useAPI((api) => api.users[userId!].posts.get(), {
+  const { data } = useAPI((api) => api.users[userId!].posts.$get(), {
     enabled: userId !== undefined,
   });
 }
@@ -264,7 +271,7 @@ function UserPosts({ userId }: { userId: string | undefined }) {
 ```typescript
 function Post({ id }: { id: number }) {
   // Automatically re-fetches when `id` or query values change
-  const { data } = useAPI((api) => api.posts[id].get({ query: { include: "author" } }));
+  const { data } = useAPI((api) => api.posts[id].$get({ query: { include: "author" } }));
   return <div>{data?.title}</div>;
 }
 ```
@@ -276,7 +283,7 @@ Automatically refetch data at intervals using the `pollingInterval` option. Poll
 ```typescript
 function Notifications() {
   const { data } = useAPI(
-    (api) => api.notifications.get(),
+    (api) => api.notifications.$get(),
     { pollingInterval: 5000 } // Refetch every 5 seconds after previous request completes
   );
 
@@ -299,7 +306,7 @@ Use a function to conditionally poll based on the response data or error:
 ```typescript
 function OrderStatus({ orderId }: { orderId: string }) {
   const { data } = useAPI(
-    (api) => api.orders[orderId].get(),
+    (api) => api.orders[orderId].$get(),
     {
       // Poll every 2s while pending, stop when completed
       pollingInterval: (order) => order?.status === "pending" ? 2000 : false,
@@ -311,28 +318,30 @@ function OrderStatus({ orderId }: { orderId: string }) {
 ```
 
 The function receives `(data, error)` and should return:
+
 - `number`: Interval in milliseconds
 - `false`: Stop polling
 
 ```typescript
 // Poll faster when there's an error (retry), slower otherwise
-{ pollingInterval: (data, error) => error ? 1000 : 10000 }
+{
+  pollingInterval: (data, error) => (error ? 1000 : 10000);
+}
 
 // Stop polling once data meets a condition
-{ pollingInterval: (order) => order?.status === "completed" ? false : 3000 }
+{
+  pollingInterval: (order) => (order?.status === "completed" ? false : 3000);
+}
 ```
 
 **Combined with conditional fetching:**
 
 ```typescript
 function OrderStatus({ orderId }: { orderId: string | undefined }) {
-  const { data } = useAPI(
-    (api) => api.orders[orderId!].get(),
-    {
-      enabled: !!orderId,
-      pollingInterval: 10000, // Poll every 10 seconds
-    }
-  );
+  const { data } = useAPI((api) => api.orders[orderId!].$get(), {
+    enabled: !!orderId,
+    pollingInterval: 10000, // Poll every 10 seconds
+  });
   // Polling only runs when orderId is defined
 }
 ```
@@ -344,12 +353,12 @@ Multiple components requesting the same data will share a single network request
 ```typescript
 // Both components render at the same time
 function PostTitle({ id }: { id: number }) {
-  const { data } = useAPI((api) => api.posts[id].get());
+  const { data } = useAPI((api) => api.posts[id].$get());
   return <h1>{data?.title}</h1>;
 }
 
 function PostBody({ id }: { id: number }) {
-  const { data } = useAPI((api) => api.posts[id].get());
+  const { data } = useAPI((api) => api.posts[id].$get());
   return <p>{data?.body}</p>;
 }
 
@@ -371,7 +380,7 @@ For mutations or lazy-loaded requests:
 
 ```typescript
 function DeleteButton({ id }: { id: number }) {
-  const { trigger, loading } = useAPI((api) => api.posts[id].delete);
+  const { trigger, loading } = useAPI((api) => api.posts[id].$delete);
 
   return (
     <button onClick={() => trigger()} disabled={loading}>
@@ -385,7 +394,7 @@ function DeleteButton({ id }: { id: number }) {
 
 ```typescript
 function CreatePost() {
-  const { trigger, loading, data } = useAPI((api) => api.posts.post);
+  const { trigger, loading, data } = useAPI((api) => api.posts.$post);
 
   const handleSubmit = async (title: string) => {
     const result = await trigger({ body: { title } });
@@ -405,7 +414,7 @@ Use `:paramName` syntax for dynamic IDs passed at trigger time:
 ```typescript
 function PostList({ posts }: { posts: Post[] }) {
   // Define once with :id placeholder
-  const { trigger, loading } = useAPI((api) => api.posts[":id"].delete);
+  const { trigger, loading } = useAPI((api) => api.posts[":id"].$delete);
 
   const handleDelete = (postId: number) => {
     // Pass the actual ID when triggering
@@ -431,7 +440,7 @@ function PostList({ posts }: { posts: Post[] }) {
 
 ```typescript
 const { trigger } = useAPI(
-  (api) => api.users[":userId"].posts[":postId"].delete
+  (api) => api.users[":userId"].posts[":postId"].$delete
 );
 
 trigger({ params: { userId: "1", postId: "42" } });
@@ -441,7 +450,7 @@ trigger({ params: { userId: "1", postId: "42" } });
 **With request body:**
 
 ```typescript
-const { trigger } = useAPI((api) => api.products[":id"].patch);
+const { trigger } = useAPI((api) => api.products[":id"].$patch);
 
 trigger({
   params: { id: "123" },
@@ -465,7 +474,7 @@ trigger({
 **Mutations automatically revalidate matching tags:**
 
 ```typescript
-const { trigger } = useAPI((api) => api.posts.post);
+const { trigger } = useAPI((api) => api.posts.$post);
 
 // POST /posts automatically revalidates 'posts' tag
 // All queries with 'posts' tag will refetch!
@@ -482,10 +491,10 @@ This means in most cases, **you don't need to specify any tags manually**. The c
 
 ```typescript
 // Component A: fetches posts (cached with tag 'posts')
-const { data } = useAPI((api) => api.posts.get());
+const { data } = useAPI((api) => api.posts.$get());
 
 // Component B: creates a post
-const { trigger } = useAPI((api) => api.posts.post);
+const { trigger } = useAPI((api) => api.posts.$post);
 trigger({ body: { title: "New" } });
 // → Automatically revalidates 'posts' tag
 // → Component A refetches automatically!
@@ -515,7 +524,7 @@ Override auto-generated tags when needed:
 
 ```typescript
 // Custom cache tags
-const { data } = useAPI((api) => api.posts.get({ tags: ["my-custom-tag"] }));
+const { data } = useAPI((api) => api.posts.$get({ tags: ["my-custom-tag"] }));
 
 // Custom revalidation tags
 trigger({
@@ -583,7 +592,7 @@ This also works for per-request headers:
 
 ```typescript
 const { data } = useAPI((api) =>
-  api.posts.get({
+  api.posts.$get({
     headers: async () => {
       const token = await refreshToken();
       return { Authorization: `Bearer ${token}` };
@@ -648,24 +657,18 @@ type EnlaceErrorCallbackPayload<T> =
 
 ```typescript
 // Basic usage
-const result = useAPI((api) => api.posts.get());
+const result = useAPI((api) => api.posts.$get());
 
 // With options
-const result = useAPI(
-  (api) => api.posts.get(),
-  {
-    enabled: true,        // Skip fetching when false
-    pollingInterval: 5000 // Refetch every 5s after previous request completes
-  }
-);
+const result = useAPI((api) => api.posts.$get(), {
+  enabled: true, // Skip fetching when false
+  pollingInterval: 5000, // Refetch every 5s after previous request completes
+});
 
 // With dynamic polling
-const result = useAPI(
-  (api) => api.orders[id].get(),
-  {
-    pollingInterval: (order) => order?.status === "pending" ? 2000 : false
-  }
-);
+const result = useAPI((api) => api.orders[id].$get(), {
+  pollingInterval: (order) => (order?.status === "pending" ? 2000 : false),
+});
 
 type UseEnlaceQueryResult<TData, TError> = {
   loading: boolean; // No cached data and fetching
@@ -731,7 +734,7 @@ const api = enlaceNext<ApiSchema, ApiError>("https://api.example.com", {}, {
 });
 
 export default async function Page() {
-  const { data } = await api.posts.get({
+  const { data } = await api.posts.$get({
     revalidate: 60, // ISR: revalidate every 60 seconds
   });
 
@@ -750,9 +753,7 @@ import { enlaceHookNext } from "enlace/hook";
 
 type ApiError = { message: string };
 
-const useAPI = enlaceHookNext<ApiSchema, ApiError>(
-  "https://api.example.com"
-);
+const useAPI = enlaceHookNext<ApiSchema, ApiError>("https://api.example.com");
 ```
 
 ### Server-Side Revalidation
@@ -795,7 +796,7 @@ const useAPI = enlaceHookNext<ApiSchema, ApiError>(
 
 ```typescript
 function CreatePost() {
-  const { trigger } = useAPI((api) => api.posts.post);
+  const { trigger } = useAPI((api) => api.posts.$post);
 
   const handleCreate = () => {
     trigger({
@@ -843,7 +844,7 @@ await trigger({ body: data, serverRevalidate: true });
 ### Next.js Request Options
 
 ```typescript
-api.posts.get({
+api.posts.$get({
   tags: ["posts"], // Next.js cache tags
   revalidate: 60, // ISR revalidation (seconds)
   revalidateTags: ["posts"], // Tags to invalidate after mutation
@@ -922,6 +923,28 @@ npm install enlace-openapi
 enlace-openapi --schema ./types/APISchema.ts --output ./openapi.json
 ```
 
+## Framework Adapters
+
+### Hono
+
+Use [`enlace-hono`](../hono/README.md) to automatically generate Enlace schemas from your Hono app:
+
+```typescript
+import { Hono } from "hono";
+import type { HonoToEnlace } from "enlace-hono";
+
+const app = new Hono()
+  .basePath("/api")
+  .get("/posts", (c) => c.json([{ id: 1, title: "Hello" }]))
+  .get("/posts/:id", (c) => c.json({ id: c.req.param("id") }));
+
+// Auto-generate schema from Hono types
+type ApiSchema = HonoToEnlace<typeof app>;
+
+// Use with Enlace
+const client = enlace<ApiSchema["api"]>("http://localhost:3000/api");
+```
+
 ## License
 
 MIT

package/dist/hook/index.d.mts

@@ -121,10 +121,10 @@ type EnlaceHook<TSchema, TDefaultError = unknown> = {
  * const useAPI = enlaceHookReact<ApiSchema>('https://api.com');
  *
  * // Query mode - auto-fetch (auto-tracks changes, no deps array needed)
- * const { loading, data, error } = useAPI((api) => api.posts.get({ query: { userId } }));
+ * const { loading, data, error } = useAPI((api) => api.posts.$get({ query: { userId } }));
  *
  * // Selector mode - typed trigger for lazy calls
- * const { trigger, loading, data, error } = useAPI((api) => api.posts.delete);
+ * const { trigger, loading, data, error } = useAPI((api) => api.posts.$delete);
  * onClick={() => trigger({ body: { id: 1 } })}
  */
 declare function enlaceHookReact<TSchema = unknown, TDefaultError = unknown>(baseUrl: string, defaultOptions?: EnlaceOptions, hookOptions?: EnlaceHookOptions): EnlaceHook<TSchema, TDefaultError>;
@@ -194,10 +194,10 @@ type NextEnlaceHook<TSchema, TDefaultError = unknown> = {
  * });
  *
  * // Query mode - auto-fetch
- * const { loading, data, error } = useAPI((api) => api.posts.get());
+ * const { loading, data, error } = useAPI((api) => api.posts.$get());
  *
  * // Selector mode - trigger for mutations
- * const { trigger } = useAPI((api) => api.posts.delete);
+ * const { trigger } = useAPI((api) => api.posts.$delete);
  */
 declare function enlaceHookNext<TSchema = unknown, TDefaultError = unknown>(baseUrl: string, defaultOptions?: EnlaceOptions, hookOptions?: NextHookOptions): NextEnlaceHook<TSchema, TDefaultError>;
 

package/dist/hook/index.d.ts

@@ -121,10 +121,10 @@ type EnlaceHook<TSchema, TDefaultError = unknown> = {
  * const useAPI = enlaceHookReact<ApiSchema>('https://api.com');
  *
  * // Query mode - auto-fetch (auto-tracks changes, no deps array needed)
- * const { loading, data, error } = useAPI((api) => api.posts.get({ query: { userId } }));
+ * const { loading, data, error } = useAPI((api) => api.posts.$get({ query: { userId } }));
  *
  * // Selector mode - typed trigger for lazy calls
- * const { trigger, loading, data, error } = useAPI((api) => api.posts.delete);
+ * const { trigger, loading, data, error } = useAPI((api) => api.posts.$delete);
  * onClick={() => trigger({ body: { id: 1 } })}
  */
 declare function enlaceHookReact<TSchema = unknown, TDefaultError = unknown>(baseUrl: string, defaultOptions?: EnlaceOptions, hookOptions?: EnlaceHookOptions): EnlaceHook<TSchema, TDefaultError>;
@@ -194,10 +194,10 @@ type NextEnlaceHook<TSchema, TDefaultError = unknown> = {
  * });
  *
  * // Query mode - auto-fetch
- * const { loading, data, error } = useAPI((api) => api.posts.get());
+ * const { loading, data, error } = useAPI((api) => api.posts.$get());
  *
  * // Selector mode - trigger for mutations
- * const { trigger } = useAPI((api) => api.posts.delete);
+ * const { trigger } = useAPI((api) => api.posts.$delete);
  */
 declare function enlaceHookNext<TSchema = unknown, TDefaultError = unknown>(baseUrl: string, defaultOptions?: EnlaceOptions, hookOptions?: NextHookOptions): NextEnlaceHook<TSchema, TDefaultError>;
 

package/dist/hook/index.js

@@ -462,7 +462,7 @@ function enlaceHookReact(baseUrl, defaultOptions = {}, hookOptions = {}) {
     }
     if (!trackingResult.trackedCall) {
       throw new Error(
-        "useAPI query mode requires calling an HTTP method (get, post, etc.). Did you mean to use selector mode? Example: useAPI((api) => api.posts.get())"
+        "useAPI query mode requires calling an HTTP method ($get, $post, etc.). Did you mean to use selector mode? Example: useAPI((api) => api.posts.$get())"
       );
     }
     return useQueryMode(
@@ -579,7 +579,7 @@ function enlaceHookNext(baseUrl, defaultOptions = {}, hookOptions = {}) {
     }
     if (!trackedCall) {
       throw new Error(
-        "useAPI query mode requires calling an HTTP method (get, post, etc.). Did you mean to use selector mode? Example: useAPI((api) => api.posts.get())"
+        "useAPI query mode requires calling an HTTP method ($get, $post, etc.). Did you mean to use selector mode? Example: useAPI((api) => api.posts.$get())"
       );
     }
     return useQueryMode(

package/dist/hook/index.mjs

@@ -437,7 +437,7 @@ function enlaceHookReact(baseUrl, defaultOptions = {}, hookOptions = {}) {
     }
     if (!trackingResult.trackedCall) {
       throw new Error(
-        "useAPI query mode requires calling an HTTP method (get, post, etc.). Did you mean to use selector mode? Example: useAPI((api) => api.posts.get())"
+        "useAPI query mode requires calling an HTTP method ($get, $post, etc.). Did you mean to use selector mode? Example: useAPI((api) => api.posts.$get())"
       );
     }
     return useQueryMode(
@@ -558,7 +558,7 @@ function enlaceHookNext(baseUrl, defaultOptions = {}, hookOptions = {}) {
     }
     if (!trackedCall) {
       throw new Error(
-        "useAPI query mode requires calling an HTTP method (get, post, etc.). Did you mean to use selector mode? Example: useAPI((api) => api.posts.get())"
+        "useAPI query mode requires calling an HTTP method ($get, $post, etc.). Did you mean to use selector mode? Example: useAPI((api) => api.posts.$get())"
       );
     }
     return useQueryMode(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "enlace",
-  "version": "0.0.1-beta.14",
+  "version": "0.0.1-beta.16",
   "license": "MIT",
   "files": [
     "dist"
@@ -18,7 +18,7 @@
     }
   },
   "dependencies": {
-    "enlace-core": "0.0.1-beta.9"
+    "enlace-core": "0.0.1-beta.10"
   },
   "peerDependencies": {
     "react": "^19"