@b3-business/cherry 0.2.5 → 0.2.7

package/README.md

@@ -4,16 +4,17 @@
 
 A tree-shakeable, minimal API client factory. Import only the routes you need — nothing more.
 
-<a href="https://www.npmjs.com/package/@b3-business/cherry" target="_blank"><img src="https://img.shields.io/npm/v/@b3-business/cherry" alt="npm"></a>
-<a href="https://jsr.io/@b3-business/cherry" target="_blank"><img src="https://jsr.io/badges/@b3-business/cherry" alt="JSR"></a>
-<a href="https://github.com/b3-business/cherry" target="_blank"><img src="https://img.shields.io/badge/GitHub-b3--business%2Fcherry-blue?logo=github" alt="GitHub"></a>
+[![npm](https://img.shields.io/npm/v/@b3-business/cherry)](https://www.npmjs.com/package/@b3-business/cherry)
+[![JSR](https://jsr.io/badges/@b3-business/cherry)](https://jsr.io/@b3-business/cherry)
+[![GitHub](https://img.shields.io/badge/GitHub-b3--business%2Fcherry-blue?logo=github)](https://github.com/b3-business/cherry)
 
 ---
 
-## Latest Changelog - 0.2.5
+## Latest Changelog - 0.2.7
 
-- README badges now open in new tab
-- GitHub badge shows repo name instead of stars
+- README: Reconcile documentation with actual API (`createCherryClient`, `route`, `path` tagged template)
+- README: Remove unimplemented OpenAPI generator section
+- Example: JSONPlaceholder now uses sub-namespaced routes (`posts.list`, `users.get`)
 
 See [CHANGELOG.md](https://github.com/b3-business/cherry/blob/main/packages/cherry/CHANGELOG.md) for full history.
 
@@ -24,10 +25,10 @@ See [CHANGELOG.md](https://github.com/b3-business/cherry/blob/main/packages/cher
 Cherry is a lightweight API client library that separates **route definitions** from the **client runtime**. Routes are plain objects with validation schemas — import only what you use, bundle only what you import.
 
 ```ts
-import { createClient } from "@b3b/cherry";
+import { createCherryClient } from "@b3b/cherry";
 import { listZones, getZone } from "./routes/cloudflare";
 
-const cf = createClient({
+const cf = createCherryClient({
   baseUrl: "https://api.cloudflare.com/client/v4",
   headers: () => ({ Authorization: `Bearer ${process.env.CF_TOKEN}` }),
   routes: { listZones, getZone },
@@ -96,12 +97,12 @@ deno add jsr:@b3b/cherry
 
 ```ts
 import * as v from "valibot";
-import { defineRoute } from "@b3b/cherry";
+import { route, path, param } from "@b3b/cherry";
 
-export const listZones = defineRoute({
+export const listZones = route({
   method: "GET",
-  path: "/zones",
-  params: v.object({
+  path: path`/zones`,
+  queryParams: v.object({
     account_id: v.string(),
     page: v.optional(v.number()),
   }),
@@ -114,10 +115,10 @@ export const listZones = defineRoute({
 ### 2. Create a Client
 
 ```ts
-import { createClient } from "@b3b/cherry";
+import { createCherryClient } from "@b3b/cherry";
 import { listZones, getZone, createDnsRecord } from "./routes/cloudflare";
 
-const cf = createClient({
+const cf = createCherryClient({
   baseUrl: "https://api.cloudflare.com/client/v4",
   headers: () => ({ Authorization: `Bearer ${process.env.CF_TOKEN}` }),
   routes: { listZones, getZone, createDnsRecord },
@@ -141,10 +142,10 @@ const zones = await cf.call(listZones, { account_id: "abc" });
 ### Dynamic Path Parameters
 
 ```ts
-export const getZone = defineRoute({
+export const getZone = route({
   method: "GET",
-  path: (p) => `/zones/${p.zone_id}`,
-  params: v.object({ zone_id: v.string() }),
+  path: path`/zones/${param("zone_id")}`,
+  pathParams: v.object({ zone_id: v.string() }),
   response: v.object({ /* ... */ }),
 });
 ```
@@ -154,7 +155,7 @@ export const getZone = defineRoute({
 Replace the underlying fetch logic for logging, retries, auth refresh, etc.
 
 ```ts
-createClient({
+createCherryClient({
   baseUrl: "...",
   fetcher: async (req) => {
     console.log(`→ ${req.init.method} ${req.url}`);
@@ -187,8 +188,11 @@ const withLogging = (fetcher: Fetcher): Fetcher =>
     return fetcher(req);
   };
 
-createClient({
-  fetcher: withLogging(withRetry(defaultFetcher)),
+const baseFetcher: Fetcher = (req) => fetch(req.url, req.init);
+
+createCherryClient({
+  baseUrl: "...",
+  fetcher: withLogging(withRetry(baseFetcher)),
 });
 ```
 
@@ -204,18 +208,6 @@ createClient({
 
 ---
 
-## Generating Routes from OpenAPI
-
-Cherry includes a generator that transforms OpenAPI 3.x specs into route definitions:
-
-```bash
-cherry generate --input ./openapi.json --output ./routes/
-```
-
-See [ARCHITECTURE.md](./agent/ARCHITECTURE.md) for generator implementation details.
-
----
-
 ## Stack
 
 - **Runtime:** Bun

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@b3-business/cherry",
-  "version": "0.2.5",
+  "version": "0.2.7",
   "description": "A tree-shakeable, minimal API client factory. Import only the routes you need — nothing more.",
   "repository": {
     "type": "git",