hibi-client 0.0.0

package/README.md

@@ -0,0 +1,40 @@
+# hibi-client
+
+Official TypeScript client for the [Hibi](https://github.com/YannickHerrero/hibi) flashcard API.
+
+## Install
+
+```bash
+pnpm add hibi-client
+```
+
+## Usage
+
+```ts
+import { createHibiClient } from "hibi-client";
+
+const client = createHibiClient({
+  apiKey: "hibi_...",
+  baseUrl: "https://api.hibi.app",
+});
+
+// Cards
+const card = await client.cards.create({ /* ... */ });
+const list = await client.cards.list({ limit: 50 });
+await client.cards.update(card.id, { tags: ["anime"] });
+await client.cards.remove(card.id);
+
+// Reviews
+const due = await client.reviews.due({ limit: 50 });
+const result = await client.reviews.submit({ cardId: card.id, rating: 3 });
+
+// Stats
+const heatmap = await client.stats.heatmap({ year: 2026 });
+const retention = await client.stats.retention();
+```
+
+The surface is intentionally narrow: cards, reviews, stats, account. There is **no dictionary surface** — JMdict and morphological analysis live entirely inside each mining client.
+
+## License
+
+MIT

package/dist/index.cjs

@@ -0,0 +1,97 @@
+'use strict';
+
+var types = require('@hibi/types');
+var zod = require('zod');
+
+// src/client.ts
+var PaginatedCardSchema = types.PaginatedSchema(types.CardSchema);
+var DueResponseSchema = zod.z.object({
+  items: zod.z.array(
+    zod.z.object({ card: types.CardSchema, cardState: types.SubmitReviewResultSchema.shape.cardState })
+  )
+});
+function asError(status, body) {
+  const err = new Error(`Hibi API error: ${status}`);
+  err.status = status;
+  err.body = body;
+  return err;
+}
+function createHibiClient(config) {
+  const fetchImpl = config.fetch ?? fetch;
+  const base = config.baseUrl.replace(/\/+$/, "");
+  async function request(method, path, schema, init = {}) {
+    const url = new URL(`${base}${path}`);
+    if (init.query) {
+      for (const [k, v] of Object.entries(init.query)) {
+        if (v !== void 0) url.searchParams.set(k, String(v));
+      }
+    }
+    const headers = {
+      Authorization: `Bearer ${config.apiKey}`
+    };
+    const requestInit = { method, headers };
+    if (init.body !== void 0) {
+      headers["Content-Type"] = "application/json";
+      requestInit.body = JSON.stringify(init.body);
+    }
+    const res = await fetchImpl(url.toString(), requestInit);
+    if (res.status === 204) return void 0;
+    const text = await res.text();
+    const body = text ? JSON.parse(text) : null;
+    if (!res.ok) throw asError(res.status, body);
+    return schema.parse(body);
+  }
+  return {
+    cards: {
+      async create(input) {
+        const validated = types.CreateCardInputSchema.parse(input);
+        return request("POST", "/v1/cards", types.CardSchema, { body: validated });
+      },
+      async list(query = { limit: 50 }) {
+        return request("GET", "/v1/cards", PaginatedCardSchema, {
+          query: { limit: query.limit, cursor: query.cursor, tag: query.tag, source: query.source }
+        });
+      },
+      async get(id) {
+        return request("GET", `/v1/cards/${id}`, types.CardSchema);
+      },
+      async update(id, input) {
+        const validated = types.UpdateCardInputSchema.parse(input);
+        return request("PATCH", `/v1/cards/${id}`, types.CardSchema, { body: validated });
+      },
+      async remove(id) {
+        await request("DELETE", `/v1/cards/${id}`, zod.z.unknown());
+      }
+    },
+    reviews: {
+      async due(query = {}) {
+        return request("GET", "/v1/reviews/due", DueResponseSchema, {
+          query: { limit: query.limit, before: query.before }
+        });
+      },
+      async submit(input) {
+        const validated = types.SubmitReviewInputSchema.parse(input);
+        return request("POST", "/v1/reviews", types.SubmitReviewResultSchema, { body: validated });
+      }
+    },
+    stats: {
+      async heatmap(query) {
+        return request("GET", "/v1/stats/heatmap", types.HeatmapResponseSchema, {
+          query: { year: query.year }
+        });
+      },
+      async retention() {
+        return request("GET", "/v1/stats/retention", types.RetentionResponseSchema);
+      },
+      async daily(query) {
+        return request("GET", "/v1/stats/daily", types.DailyCountResponseSchema, {
+          query: { from: query.from, to: query.to }
+        });
+      }
+    }
+  };
+}
+
+exports.createHibiClient = createHibiClient;
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/client.ts"],"names":["PaginatedSchema","CardSchema","z","SubmitReviewResultSchema","CreateCardInputSchema","UpdateCardInputSchema","SubmitReviewInputSchema","HeatmapResponseSchema","RetentionResponseSchema","DailyCountResponseSchema"],"mappings":";;;;;;AA8BA,IAAM,mBAAA,GAAsBA,sBAAgBC,gBAAU,CAAA;AACtD,IAAM,iBAAA,GAAoBC,MAAE,MAAA,CAAO;AAAA,EACjC,OAAOA,KAAA,CAAE,KAAA;AAAA,IACPA,KAAA,CAAE,OAAO,EAAE,IAAA,EAAMD,kBAAY,SAAA,EAAWE,8BAAA,CAAyB,KAAA,CAAM,SAAA,EAAW;AAAA;AAEtF,CAAC,CAAA;AAED,SAAS,OAAA,CAAQ,QAAgB,IAAA,EAAgC;AAC/D,EAAA,MAAM,GAAA,GAAM,IAAI,KAAA,CAAM,CAAA,gBAAA,EAAmB,MAAM,CAAA,CAAE,CAAA;AACjD,EAAA,GAAA,CAAI,MAAA,GAAS,MAAA;AACb,EAAA,GAAA,CAAI,IAAA,GAAO,IAAA;AACX,EAAA,OAAO,GAAA;AACT;AAEO,SAAS,iBAAiB,MAAA,EAA0B;AACzD,EAAA,MAAM,SAAA,GAAY,OAAO,KAAA,IAAS,KAAA;AAClC,EAAA,MAAM,IAAA,GAAO,MAAA,CAAO,OAAA,CAAQ,OAAA,CAAQ,QAAQ,EAAE,CAAA;AAE9C,EAAA,eAAe,QACb,MAAA,EACA,IAAA,EACA,MAAA,EACA,IAAA,GAAgF,EAAC,EACrE;AACZ,IAAA,MAAM,MAAM,IAAI,GAAA,CAAI,GAAG,IAAI,CAAA,EAAG,IAAI,CAAA,CAAE,CAAA;AACpC,IAAA,IAAI,KAAK,KAAA,EAAO;AACd,MAAA,KAAA,MAAW,CAAC,GAAG,CAAC,CAAA,IAAK,OAAO,OAAA,CAAQ,IAAA,CAAK,KAAK,CAAA,EAAG;AAC/C,QAAA,IAAI,CAAA,KAAM,QAAW,GAAA,CAAI,YAAA,CAAa,IAAI,CAAA,EAAG,MAAA,CAAO,CAAC,CAAC,CAAA;AAAA,MACxD;AAAA,IACF;AAEA,IAAA,MAAM,OAAA,GAAkC;AAAA,MACtC,aAAA,EAAe,CAAA,OAAA,EAAU,MAAA,CAAO,MAAM,CAAA;AAAA,KACxC;AACA,IAAA,MAAM,WAAA,GAA2B,EAAE,MAAA,EAAQ,OAAA,EAAQ;AACnD,IAAA,IAAI,IAAA,CAAK,SAAS,MAAA,EAAW;AAC3B,MAAA,OAAA,CAAQ,cAAc,CAAA,GAAI,kBAAA;AAC1B,MAAA,WAAA,CAAY,IAAA,GAAO,IAAA,CAAK,SAAA,CAAU,IAAA,CAAK,IAAI,CAAA;AAAA,IAC7C;AAEA,IAAA,MAAM,MAAM,MAAM,SAAA,CAAU,GAAA,CAAI,QAAA,IAAY,WAAW,CAAA;AAEvD,IAAA,IAAI,GAAA,CAAI,MAAA,KAAW,GAAA,EAAK,OAAO,MAAA;AAE/B,IAAA,MAAM,IAAA,GAAO,MAAM,GAAA,CAAI,IAAA,EAAK;AAC5B,IAAA,MAAM,IAAA,GAAO,IAAA,GAAO,IAAA,CAAK,KAAA,CAAM,IAAI,CAAA,GAAI,IAAA;AAEvC,IAAA,IAAI,CAAC,GAAA,CAAI,EAAA,QAAU,OAAA,CAAQ,GAAA,CAAI,QAAQ,IAAI,CAAA;AAC3C,IAAA,OAAO,MAAA,CAAO,MAAM,IAAI,CAAA;AAAA,EAC1B;AAEA,EAAA,OAAO;AAAA,IACL,KAAA,EAAO;AAAA,MACL,MAAM,OAAO,KAAA,EAAwB;AACnC,QAAA,MAAM,SAAA,GAAYC,2BAAA,CAAsB,KAAA,CAAM,KAAK,CAAA;AACnD,QAAA,OAAO,QAAQ,MAAA,EAAQ,WAAA,EAAaH,kBAAY,EAAE,IAAA,EAAM,WAAW,CAAA;AAAA,MACrE,CAAA;AAAA,MACA,MAAM,IAAA,CAAK,KAAA,GAAwB,EAAE,KAAA,EAAO,IAAG,EAAG;AAChD,QAAA,OAAO,OAAA,CAAQ,KAAA,EAAO,WAAA,EAAa,mBAAA,EAAqB;AAAA,UACtD,KAAA,EAAO,EAAE,KAAA,EAAO,KAAA,CAAM,KAAA,EAAO,MAAA,EAAQ,KAAA,CAAM,MAAA,EAAQ,GAAA,EAAK,KAAA,CAAM,GAAA,EAAK,MAAA,EAAQ,MAAM,MAAA;AAAO,SACzF,CAAA;AAAA,MACH,CAAA;AAAA,MACA,MAAM,IAAI,EAAA,EAAY;AACpB,QAAA,OAAO,OAAA,CAAQ,KAAA,EAAO,CAAA,UAAA,EAAa,EAAE,IAAIA,gBAAU,CAAA;AAAA,MACrD,CAAA;AAAA,MACA,MAAM,MAAA,CAAO,EAAA,EAAY,KAAA,EAAwB;AAC/C,QAAA,MAAM,SAAA,GAAYI,2BAAA,CAAsB,KAAA,CAAM,KAAK,CAAA;AACnD,QAAA,OAAO,OAAA,CAAQ,SAAS,CAAA,UAAA,EAAa,EAAE,IAAIJ,gBAAA,EAAY,EAAE,IAAA,EAAM,SAAA,EAAW,CAAA;AAAA,MAC5E,CAAA;AAAA,MACA,MAAM,OAAO,EAAA,EAA2B;AACtC,QAAA,MAAM,QAAQ,QAAA,EAAU,CAAA,UAAA,EAAa,EAAE,CAAA,CAAA,EAAIC,KAAA,CAAE,SAAS,CAAA;AAAA,MACxD;AAAA,KACF;AAAA,IAEA,OAAA,EAAS;AAAA,MACP,MAAM,GAAA,CAAI,KAAA,GAA6C,EAAC,EAAG;AACzD,QAAA,OAAO,OAAA,CAAQ,KAAA,EAAO,iBAAA,EAAmB,iBAAA,EAAmB;AAAA,UAC1D,OAAO,EAAE,KAAA,EAAO,MAAM,KAAA,EAAO,MAAA,EAAQ,MAAM,MAAA;AAAO,SACnD,CAAA;AAAA,MACH,CAAA;AAAA,MACA,MAAM,OAAO,KAAA,EAA0B;AACrC,QAAA,MAAM,SAAA,GAAYI,6BAAA,CAAwB,KAAA,CAAM,KAAK,CAAA;AACrD,QAAA,OAAO,QAAQ,MAAA,EAAQ,aAAA,EAAeH,gCAA0B,EAAE,IAAA,EAAM,WAAW,CAAA;AAAA,MACrF;AAAA,KACF;AAAA,IAEA,KAAA,EAAO;AAAA,MACL,MAAM,QAAQ,KAAA,EAAqB;AACjC,QAAA,OAAO,OAAA,CAAQ,KAAA,EAAO,mBAAA,EAAqBI,2BAAA,EAAuB;AAAA,UAChE,KAAA,EAAO,EAAE,IAAA,EAAM,KAAA,CAAM,IAAA;AAAK,SAC3B,CAAA;AAAA,MACH,CAAA;AAAA,MACA,MAAM,SAAA,GAAY;AAChB,QAAA,OAAO,OAAA,CAAQ,KAAA,EAAO,qBAAA,EAAuBC,6BAAuB,CAAA;AAAA,MACtE,CAAA;AAAA,MACA,MAAM,MAAM,KAAA,EAAwB;AAClC,QAAA,OAAO,OAAA,CAAQ,KAAA,EAAO,iBAAA,EAAmBC,8BAAA,EAA0B;AAAA,UACjE,OAAO,EAAE,IAAA,EAAM,MAAM,IAAA,EAAM,EAAA,EAAI,MAAM,EAAA;AAAG,SACzC,CAAA;AAAA,MACH;AAAA;AACF,GACF;AACF","file":"index.cjs","sourcesContent":["import {\n  CardSchema,\n  type CreateCardInput,\n  CreateCardInputSchema,\n  type DailyCountQuery,\n  DailyCountResponseSchema,\n  type HeatmapQuery,\n  HeatmapResponseSchema,\n  type ListCardsQuery,\n  PaginatedSchema,\n  RetentionResponseSchema,\n  type SubmitReviewInput,\n  SubmitReviewInputSchema,\n  SubmitReviewResultSchema,\n  type UpdateCardInput,\n  UpdateCardInputSchema,\n} from \"@hibi/types\";\nimport { z } from \"zod\";\n\nexport interface HibiClientConfig {\n  apiKey: string;\n  baseUrl: string;\n  fetch?: typeof fetch;\n}\n\nexport interface HibiClientError extends Error {\n  status: number;\n  body: unknown;\n}\n\nconst PaginatedCardSchema = PaginatedSchema(CardSchema);\nconst DueResponseSchema = z.object({\n  items: z.array(\n    z.object({ card: CardSchema, cardState: SubmitReviewResultSchema.shape.cardState }),\n  ),\n});\n\nfunction asError(status: number, body: unknown): HibiClientError {\n  const err = new Error(`Hibi API error: ${status}`) as HibiClientError;\n  err.status = status;\n  err.body = body;\n  return err;\n}\n\nexport function createHibiClient(config: HibiClientConfig) {\n  const fetchImpl = config.fetch ?? fetch;\n  const base = config.baseUrl.replace(/\\/+$/, \"\");\n\n  async function request<T>(\n    method: string,\n    path: string,\n    schema: z.ZodType<T>,\n    init: { body?: unknown; query?: Record<string, string | number | undefined> } = {},\n  ): Promise<T> {\n    const url = new URL(`${base}${path}`);\n    if (init.query) {\n      for (const [k, v] of Object.entries(init.query)) {\n        if (v !== undefined) url.searchParams.set(k, String(v));\n      }\n    }\n\n    const headers: Record<string, string> = {\n      Authorization: `Bearer ${config.apiKey}`,\n    };\n    const requestInit: RequestInit = { method, headers };\n    if (init.body !== undefined) {\n      headers[\"Content-Type\"] = \"application/json\";\n      requestInit.body = JSON.stringify(init.body);\n    }\n\n    const res = await fetchImpl(url.toString(), requestInit);\n\n    if (res.status === 204) return undefined as T;\n\n    const text = await res.text();\n    const body = text ? JSON.parse(text) : null;\n\n    if (!res.ok) throw asError(res.status, body);\n    return schema.parse(body);\n  }\n\n  return {\n    cards: {\n      async create(input: CreateCardInput) {\n        const validated = CreateCardInputSchema.parse(input);\n        return request(\"POST\", \"/v1/cards\", CardSchema, { body: validated });\n      },\n      async list(query: ListCardsQuery = { limit: 50 }) {\n        return request(\"GET\", \"/v1/cards\", PaginatedCardSchema, {\n          query: { limit: query.limit, cursor: query.cursor, tag: query.tag, source: query.source },\n        });\n      },\n      async get(id: string) {\n        return request(\"GET\", `/v1/cards/${id}`, CardSchema);\n      },\n      async update(id: string, input: UpdateCardInput) {\n        const validated = UpdateCardInputSchema.parse(input);\n        return request(\"PATCH\", `/v1/cards/${id}`, CardSchema, { body: validated });\n      },\n      async remove(id: string): Promise<void> {\n        await request(\"DELETE\", `/v1/cards/${id}`, z.unknown());\n      },\n    },\n\n    reviews: {\n      async due(query: { limit?: number; before?: string } = {}) {\n        return request(\"GET\", \"/v1/reviews/due\", DueResponseSchema, {\n          query: { limit: query.limit, before: query.before },\n        });\n      },\n      async submit(input: SubmitReviewInput) {\n        const validated = SubmitReviewInputSchema.parse(input);\n        return request(\"POST\", \"/v1/reviews\", SubmitReviewResultSchema, { body: validated });\n      },\n    },\n\n    stats: {\n      async heatmap(query: HeatmapQuery) {\n        return request(\"GET\", \"/v1/stats/heatmap\", HeatmapResponseSchema, {\n          query: { year: query.year },\n        });\n      },\n      async retention() {\n        return request(\"GET\", \"/v1/stats/retention\", RetentionResponseSchema);\n      },\n      async daily(query: DailyCountQuery) {\n        return request(\"GET\", \"/v1/stats/daily\", DailyCountResponseSchema, {\n          query: { from: query.from, to: query.to },\n        });\n      },\n    },\n  };\n}\n\nexport type HibiClient = ReturnType<typeof createHibiClient>;\n"]}

package/dist/index.d.cts

@@ -0,0 +1,225 @@
+import { CreateCardInput, ListCardsQuery, UpdateCardInput, SubmitReviewInput, HeatmapQuery, DailyCountQuery } from '@hibi/types';
+export { Card, CardStateRow, CardStateValue, CreateCardInput, DailyCount, DailyCountResponse, FuriganaPair, HeatmapDay, HeatmapResponse, KanjiEntry, ListCardsQuery, RetentionPoint, RetentionResponse, Review, ReviewRating, SubmitReviewInput, SubmitReviewResult, UpdateCardInput } from '@hibi/types';
+
+interface HibiClientConfig {
+    apiKey: string;
+    baseUrl: string;
+    fetch?: typeof fetch;
+}
+interface HibiClientError extends Error {
+    status: number;
+    body: unknown;
+}
+declare function createHibiClient(config: HibiClientConfig): {
+    cards: {
+        create(input: CreateCardInput): Promise<{
+            id: string;
+            userId: string;
+            createdAt: string;
+            updatedAt: string;
+            sentence: string;
+            focusWord: string;
+            focusWordReading: string;
+            furigana: {
+                base: string;
+                reading: string;
+            }[];
+            english: string;
+            glosses: string[];
+            grammarNote: string | null;
+            kanjiList: {
+                kanji: string;
+                meaning: string;
+                wanikaniLevel: number | null;
+            }[];
+            imageKey: string | null;
+            audioKey: string | null;
+            source: string;
+            tags: string[];
+        }>;
+        list(query?: ListCardsQuery): Promise<{
+            items: {
+                id: string;
+                userId: string;
+                createdAt: string;
+                updatedAt: string;
+                sentence: string;
+                focusWord: string;
+                focusWordReading: string;
+                furigana: {
+                    base: string;
+                    reading: string;
+                }[];
+                english: string;
+                glosses: string[];
+                grammarNote: string | null;
+                kanjiList: {
+                    kanji: string;
+                    meaning: string;
+                    wanikaniLevel: number | null;
+                }[];
+                imageKey: string | null;
+                audioKey: string | null;
+                source: string;
+                tags: string[];
+            }[];
+            nextCursor: string | null;
+        }>;
+        get(id: string): Promise<{
+            id: string;
+            userId: string;
+            createdAt: string;
+            updatedAt: string;
+            sentence: string;
+            focusWord: string;
+            focusWordReading: string;
+            furigana: {
+                base: string;
+                reading: string;
+            }[];
+            english: string;
+            glosses: string[];
+            grammarNote: string | null;
+            kanjiList: {
+                kanji: string;
+                meaning: string;
+                wanikaniLevel: number | null;
+            }[];
+            imageKey: string | null;
+            audioKey: string | null;
+            source: string;
+            tags: string[];
+        }>;
+        update(id: string, input: UpdateCardInput): Promise<{
+            id: string;
+            userId: string;
+            createdAt: string;
+            updatedAt: string;
+            sentence: string;
+            focusWord: string;
+            focusWordReading: string;
+            furigana: {
+                base: string;
+                reading: string;
+            }[];
+            english: string;
+            glosses: string[];
+            grammarNote: string | null;
+            kanjiList: {
+                kanji: string;
+                meaning: string;
+                wanikaniLevel: number | null;
+            }[];
+            imageKey: string | null;
+            audioKey: string | null;
+            source: string;
+            tags: string[];
+        }>;
+        remove(id: string): Promise<void>;
+    };
+    reviews: {
+        due(query?: {
+            limit?: number;
+            before?: string;
+        }): Promise<{
+            items: {
+                card: {
+                    id: string;
+                    userId: string;
+                    createdAt: string;
+                    updatedAt: string;
+                    sentence: string;
+                    focusWord: string;
+                    focusWordReading: string;
+                    furigana: {
+                        base: string;
+                        reading: string;
+                    }[];
+                    english: string;
+                    glosses: string[];
+                    grammarNote: string | null;
+                    kanjiList: {
+                        kanji: string;
+                        meaning: string;
+                        wanikaniLevel: number | null;
+                    }[];
+                    imageKey: string | null;
+                    audioKey: string | null;
+                    source: string;
+                    tags: string[];
+                };
+                cardState: {
+                    cardId: string;
+                    userId: string;
+                    due: string;
+                    stability: number;
+                    difficulty: number;
+                    elapsedDays: number;
+                    scheduledDays: number;
+                    reps: number;
+                    lapses: number;
+                    learningSteps: number;
+                    state: "new" | "learning" | "review" | "relearning";
+                    lastReview: string | null;
+                };
+            }[];
+        }>;
+        submit(input: SubmitReviewInput): Promise<{
+            review: {
+                id: string;
+                userId: string;
+                cardId: string;
+                rating: 1 | 4 | 2 | 3;
+                reviewedAt: string;
+                elapsedDays: number;
+                scheduledDays: number;
+                stateBefore: "new" | "learning" | "review" | "relearning";
+                stateAfter: "new" | "learning" | "review" | "relearning";
+            };
+            cardState: {
+                cardId: string;
+                userId: string;
+                due: string;
+                stability: number;
+                difficulty: number;
+                elapsedDays: number;
+                scheduledDays: number;
+                reps: number;
+                lapses: number;
+                learningSteps: number;
+                state: "new" | "learning" | "review" | "relearning";
+                lastReview: string | null;
+            };
+        }>;
+    };
+    stats: {
+        heatmap(query: HeatmapQuery): Promise<{
+            year: number;
+            days: {
+                date: string;
+                count: number;
+            }[];
+        }>;
+        retention(): Promise<{
+            generatedAt: string;
+            points: {
+                intervalDays: number;
+                retention: number;
+                sampleSize: number;
+            }[];
+        }>;
+        daily(query: DailyCountQuery): Promise<{
+            days: {
+                date: string;
+                reviews: number;
+                again: number;
+                hard: number;
+                good: number;
+                easy: number;
+            }[];
+        }>;
+    };
+};
+type HibiClient = ReturnType<typeof createHibiClient>;
+
+export { type HibiClient, type HibiClientConfig, type HibiClientError, createHibiClient };

package/dist/index.d.ts

@@ -0,0 +1,225 @@
+import { CreateCardInput, ListCardsQuery, UpdateCardInput, SubmitReviewInput, HeatmapQuery, DailyCountQuery } from '@hibi/types';
+export { Card, CardStateRow, CardStateValue, CreateCardInput, DailyCount, DailyCountResponse, FuriganaPair, HeatmapDay, HeatmapResponse, KanjiEntry, ListCardsQuery, RetentionPoint, RetentionResponse, Review, ReviewRating, SubmitReviewInput, SubmitReviewResult, UpdateCardInput } from '@hibi/types';
+
+interface HibiClientConfig {
+    apiKey: string;
+    baseUrl: string;
+    fetch?: typeof fetch;
+}
+interface HibiClientError extends Error {
+    status: number;
+    body: unknown;
+}
+declare function createHibiClient(config: HibiClientConfig): {
+    cards: {
+        create(input: CreateCardInput): Promise<{
+            id: string;
+            userId: string;
+            createdAt: string;
+            updatedAt: string;
+            sentence: string;
+            focusWord: string;
+            focusWordReading: string;
+            furigana: {
+                base: string;
+                reading: string;
+            }[];
+            english: string;
+            glosses: string[];
+            grammarNote: string | null;
+            kanjiList: {
+                kanji: string;
+                meaning: string;
+                wanikaniLevel: number | null;
+            }[];
+            imageKey: string | null;
+            audioKey: string | null;
+            source: string;
+            tags: string[];
+        }>;
+        list(query?: ListCardsQuery): Promise<{
+            items: {
+                id: string;
+                userId: string;
+                createdAt: string;
+                updatedAt: string;
+                sentence: string;
+                focusWord: string;
+                focusWordReading: string;
+                furigana: {
+                    base: string;
+                    reading: string;
+                }[];
+                english: string;
+                glosses: string[];
+                grammarNote: string | null;
+                kanjiList: {
+                    kanji: string;
+                    meaning: string;
+                    wanikaniLevel: number | null;
+                }[];
+                imageKey: string | null;
+                audioKey: string | null;
+                source: string;
+                tags: string[];
+            }[];
+            nextCursor: string | null;
+        }>;
+        get(id: string): Promise<{
+            id: string;
+            userId: string;
+            createdAt: string;
+            updatedAt: string;
+            sentence: string;
+            focusWord: string;
+            focusWordReading: string;
+            furigana: {
+                base: string;
+                reading: string;
+            }[];
+            english: string;
+            glosses: string[];
+            grammarNote: string | null;
+            kanjiList: {
+                kanji: string;
+                meaning: string;
+                wanikaniLevel: number | null;
+            }[];
+            imageKey: string | null;
+            audioKey: string | null;
+            source: string;
+            tags: string[];
+        }>;
+        update(id: string, input: UpdateCardInput): Promise<{
+            id: string;
+            userId: string;
+            createdAt: string;
+            updatedAt: string;
+            sentence: string;
+            focusWord: string;
+            focusWordReading: string;
+            furigana: {
+                base: string;
+                reading: string;
+            }[];
+            english: string;
+            glosses: string[];
+            grammarNote: string | null;
+            kanjiList: {
+                kanji: string;
+                meaning: string;
+                wanikaniLevel: number | null;
+            }[];
+            imageKey: string | null;
+            audioKey: string | null;
+            source: string;
+            tags: string[];
+        }>;
+        remove(id: string): Promise<void>;
+    };
+    reviews: {
+        due(query?: {
+            limit?: number;
+            before?: string;
+        }): Promise<{
+            items: {
+                card: {
+                    id: string;
+                    userId: string;
+                    createdAt: string;
+                    updatedAt: string;
+                    sentence: string;
+                    focusWord: string;
+                    focusWordReading: string;
+                    furigana: {
+                        base: string;
+                        reading: string;
+                    }[];
+                    english: string;
+                    glosses: string[];
+                    grammarNote: string | null;
+                    kanjiList: {
+                        kanji: string;
+                        meaning: string;
+                        wanikaniLevel: number | null;
+                    }[];
+                    imageKey: string | null;
+                    audioKey: string | null;
+                    source: string;
+                    tags: string[];
+                };
+                cardState: {
+                    cardId: string;
+                    userId: string;
+                    due: string;
+                    stability: number;
+                    difficulty: number;
+                    elapsedDays: number;
+                    scheduledDays: number;
+                    reps: number;
+                    lapses: number;
+                    learningSteps: number;
+                    state: "new" | "learning" | "review" | "relearning";
+                    lastReview: string | null;
+                };
+            }[];
+        }>;
+        submit(input: SubmitReviewInput): Promise<{
+            review: {
+                id: string;
+                userId: string;
+                cardId: string;
+                rating: 1 | 4 | 2 | 3;
+                reviewedAt: string;
+                elapsedDays: number;
+                scheduledDays: number;
+                stateBefore: "new" | "learning" | "review" | "relearning";
+                stateAfter: "new" | "learning" | "review" | "relearning";
+            };
+            cardState: {
+                cardId: string;
+                userId: string;
+                due: string;
+                stability: number;
+                difficulty: number;
+                elapsedDays: number;
+                scheduledDays: number;
+                reps: number;
+                lapses: number;
+                learningSteps: number;
+                state: "new" | "learning" | "review" | "relearning";
+                lastReview: string | null;
+            };
+        }>;
+    };
+    stats: {
+        heatmap(query: HeatmapQuery): Promise<{
+            year: number;
+            days: {
+                date: string;
+                count: number;
+            }[];
+        }>;
+        retention(): Promise<{
+            generatedAt: string;
+            points: {
+                intervalDays: number;
+                retention: number;
+                sampleSize: number;
+            }[];
+        }>;
+        daily(query: DailyCountQuery): Promise<{
+            days: {
+                date: string;
+                reviews: number;
+                again: number;
+                hard: number;
+                good: number;
+                easy: number;
+            }[];
+        }>;
+    };
+};
+type HibiClient = ReturnType<typeof createHibiClient>;
+
+export { type HibiClient, type HibiClientConfig, type HibiClientError, createHibiClient };

package/dist/index.js

@@ -0,0 +1,95 @@
+import { PaginatedSchema, CardSchema, SubmitReviewResultSchema, DailyCountResponseSchema, HeatmapResponseSchema, SubmitReviewInputSchema, UpdateCardInputSchema, CreateCardInputSchema, RetentionResponseSchema } from '@hibi/types';
+import { z } from 'zod';
+
+// src/client.ts
+var PaginatedCardSchema = PaginatedSchema(CardSchema);
+var DueResponseSchema = z.object({
+  items: z.array(
+    z.object({ card: CardSchema, cardState: SubmitReviewResultSchema.shape.cardState })
+  )
+});
+function asError(status, body) {
+  const err = new Error(`Hibi API error: ${status}`);
+  err.status = status;
+  err.body = body;
+  return err;
+}
+function createHibiClient(config) {
+  const fetchImpl = config.fetch ?? fetch;
+  const base = config.baseUrl.replace(/\/+$/, "");
+  async function request(method, path, schema, init = {}) {
+    const url = new URL(`${base}${path}`);
+    if (init.query) {
+      for (const [k, v] of Object.entries(init.query)) {
+        if (v !== void 0) url.searchParams.set(k, String(v));
+      }
+    }
+    const headers = {
+      Authorization: `Bearer ${config.apiKey}`
+    };
+    const requestInit = { method, headers };
+    if (init.body !== void 0) {
+      headers["Content-Type"] = "application/json";
+      requestInit.body = JSON.stringify(init.body);
+    }
+    const res = await fetchImpl(url.toString(), requestInit);
+    if (res.status === 204) return void 0;
+    const text = await res.text();
+    const body = text ? JSON.parse(text) : null;
+    if (!res.ok) throw asError(res.status, body);
+    return schema.parse(body);
+  }
+  return {
+    cards: {
+      async create(input) {
+        const validated = CreateCardInputSchema.parse(input);
+        return request("POST", "/v1/cards", CardSchema, { body: validated });
+      },
+      async list(query = { limit: 50 }) {
+        return request("GET", "/v1/cards", PaginatedCardSchema, {
+          query: { limit: query.limit, cursor: query.cursor, tag: query.tag, source: query.source }
+        });
+      },
+      async get(id) {
+        return request("GET", `/v1/cards/${id}`, CardSchema);
+      },
+      async update(id, input) {
+        const validated = UpdateCardInputSchema.parse(input);
+        return request("PATCH", `/v1/cards/${id}`, CardSchema, { body: validated });
+      },
+      async remove(id) {
+        await request("DELETE", `/v1/cards/${id}`, z.unknown());
+      }
+    },
+    reviews: {
+      async due(query = {}) {
+        return request("GET", "/v1/reviews/due", DueResponseSchema, {
+          query: { limit: query.limit, before: query.before }
+        });
+      },
+      async submit(input) {
+        const validated = SubmitReviewInputSchema.parse(input);
+        return request("POST", "/v1/reviews", SubmitReviewResultSchema, { body: validated });
+      }
+    },
+    stats: {
+      async heatmap(query) {
+        return request("GET", "/v1/stats/heatmap", HeatmapResponseSchema, {
+          query: { year: query.year }
+        });
+      },
+      async retention() {
+        return request("GET", "/v1/stats/retention", RetentionResponseSchema);
+      },
+      async daily(query) {
+        return request("GET", "/v1/stats/daily", DailyCountResponseSchema, {
+          query: { from: query.from, to: query.to }
+        });
+      }
+    }
+  };
+}
+
+export { createHibiClient };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/client.ts"],"names":[],"mappings":";;;;AA8BA,IAAM,mBAAA,GAAsB,gBAAgB,UAAU,CAAA;AACtD,IAAM,iBAAA,GAAoB,EAAE,MAAA,CAAO;AAAA,EACjC,OAAO,CAAA,CAAE,KAAA;AAAA,IACP,CAAA,CAAE,OAAO,EAAE,IAAA,EAAM,YAAY,SAAA,EAAW,wBAAA,CAAyB,KAAA,CAAM,SAAA,EAAW;AAAA;AAEtF,CAAC,CAAA;AAED,SAAS,OAAA,CAAQ,QAAgB,IAAA,EAAgC;AAC/D,EAAA,MAAM,GAAA,GAAM,IAAI,KAAA,CAAM,CAAA,gBAAA,EAAmB,MAAM,CAAA,CAAE,CAAA;AACjD,EAAA,GAAA,CAAI,MAAA,GAAS,MAAA;AACb,EAAA,GAAA,CAAI,IAAA,GAAO,IAAA;AACX,EAAA,OAAO,GAAA;AACT;AAEO,SAAS,iBAAiB,MAAA,EAA0B;AACzD,EAAA,MAAM,SAAA,GAAY,OAAO,KAAA,IAAS,KAAA;AAClC,EAAA,MAAM,IAAA,GAAO,MAAA,CAAO,OAAA,CAAQ,OAAA,CAAQ,QAAQ,EAAE,CAAA;AAE9C,EAAA,eAAe,QACb,MAAA,EACA,IAAA,EACA,MAAA,EACA,IAAA,GAAgF,EAAC,EACrE;AACZ,IAAA,MAAM,MAAM,IAAI,GAAA,CAAI,GAAG,IAAI,CAAA,EAAG,IAAI,CAAA,CAAE,CAAA;AACpC,IAAA,IAAI,KAAK,KAAA,EAAO;AACd,MAAA,KAAA,MAAW,CAAC,GAAG,CAAC,CAAA,IAAK,OAAO,OAAA,CAAQ,IAAA,CAAK,KAAK,CAAA,EAAG;AAC/C,QAAA,IAAI,CAAA,KAAM,QAAW,GAAA,CAAI,YAAA,CAAa,IAAI,CAAA,EAAG,MAAA,CAAO,CAAC,CAAC,CAAA;AAAA,MACxD;AAAA,IACF;AAEA,IAAA,MAAM,OAAA,GAAkC;AAAA,MACtC,aAAA,EAAe,CAAA,OAAA,EAAU,MAAA,CAAO,MAAM,CAAA;AAAA,KACxC;AACA,IAAA,MAAM,WAAA,GAA2B,EAAE,MAAA,EAAQ,OAAA,EAAQ;AACnD,IAAA,IAAI,IAAA,CAAK,SAAS,MAAA,EAAW;AAC3B,MAAA,OAAA,CAAQ,cAAc,CAAA,GAAI,kBAAA;AAC1B,MAAA,WAAA,CAAY,IAAA,GAAO,IAAA,CAAK,SAAA,CAAU,IAAA,CAAK,IAAI,CAAA;AAAA,IAC7C;AAEA,IAAA,MAAM,MAAM,MAAM,SAAA,CAAU,GAAA,CAAI,QAAA,IAAY,WAAW,CAAA;AAEvD,IAAA,IAAI,GAAA,CAAI,MAAA,KAAW,GAAA,EAAK,OAAO,MAAA;AAE/B,IAAA,MAAM,IAAA,GAAO,MAAM,GAAA,CAAI,IAAA,EAAK;AAC5B,IAAA,MAAM,IAAA,GAAO,IAAA,GAAO,IAAA,CAAK,KAAA,CAAM,IAAI,CAAA,GAAI,IAAA;AAEvC,IAAA,IAAI,CAAC,GAAA,CAAI,EAAA,QAAU,OAAA,CAAQ,GAAA,CAAI,QAAQ,IAAI,CAAA;AAC3C,IAAA,OAAO,MAAA,CAAO,MAAM,IAAI,CAAA;AAAA,EAC1B;AAEA,EAAA,OAAO;AAAA,IACL,KAAA,EAAO;AAAA,MACL,MAAM,OAAO,KAAA,EAAwB;AACnC,QAAA,MAAM,SAAA,GAAY,qBAAA,CAAsB,KAAA,CAAM,KAAK,CAAA;AACnD,QAAA,OAAO,QAAQ,MAAA,EAAQ,WAAA,EAAa,YAAY,EAAE,IAAA,EAAM,WAAW,CAAA;AAAA,MACrE,CAAA;AAAA,MACA,MAAM,IAAA,CAAK,KAAA,GAAwB,EAAE,KAAA,EAAO,IAAG,EAAG;AAChD,QAAA,OAAO,OAAA,CAAQ,KAAA,EAAO,WAAA,EAAa,mBAAA,EAAqB;AAAA,UACtD,KAAA,EAAO,EAAE,KAAA,EAAO,KAAA,CAAM,KAAA,EAAO,MAAA,EAAQ,KAAA,CAAM,MAAA,EAAQ,GAAA,EAAK,KAAA,CAAM,GAAA,EAAK,MAAA,EAAQ,MAAM,MAAA;AAAO,SACzF,CAAA;AAAA,MACH,CAAA;AAAA,MACA,MAAM,IAAI,EAAA,EAAY;AACpB,QAAA,OAAO,OAAA,CAAQ,KAAA,EAAO,CAAA,UAAA,EAAa,EAAE,IAAI,UAAU,CAAA;AAAA,MACrD,CAAA;AAAA,MACA,MAAM,MAAA,CAAO,EAAA,EAAY,KAAA,EAAwB;AAC/C,QAAA,MAAM,SAAA,GAAY,qBAAA,CAAsB,KAAA,CAAM,KAAK,CAAA;AACnD,QAAA,OAAO,OAAA,CAAQ,SAAS,CAAA,UAAA,EAAa,EAAE,IAAI,UAAA,EAAY,EAAE,IAAA,EAAM,SAAA,EAAW,CAAA;AAAA,MAC5E,CAAA;AAAA,MACA,MAAM,OAAO,EAAA,EAA2B;AACtC,QAAA,MAAM,QAAQ,QAAA,EAAU,CAAA,UAAA,EAAa,EAAE,CAAA,CAAA,EAAI,CAAA,CAAE,SAAS,CAAA;AAAA,MACxD;AAAA,KACF;AAAA,IAEA,OAAA,EAAS;AAAA,MACP,MAAM,GAAA,CAAI,KAAA,GAA6C,EAAC,EAAG;AACzD,QAAA,OAAO,OAAA,CAAQ,KAAA,EAAO,iBAAA,EAAmB,iBAAA,EAAmB;AAAA,UAC1D,OAAO,EAAE,KAAA,EAAO,MAAM,KAAA,EAAO,MAAA,EAAQ,MAAM,MAAA;AAAO,SACnD,CAAA;AAAA,MACH,CAAA;AAAA,MACA,MAAM,OAAO,KAAA,EAA0B;AACrC,QAAA,MAAM,SAAA,GAAY,uBAAA,CAAwB,KAAA,CAAM,KAAK,CAAA;AACrD,QAAA,OAAO,QAAQ,MAAA,EAAQ,aAAA,EAAe,0BAA0B,EAAE,IAAA,EAAM,WAAW,CAAA;AAAA,MACrF;AAAA,KACF;AAAA,IAEA,KAAA,EAAO;AAAA,MACL,MAAM,QAAQ,KAAA,EAAqB;AACjC,QAAA,OAAO,OAAA,CAAQ,KAAA,EAAO,mBAAA,EAAqB,qBAAA,EAAuB;AAAA,UAChE,KAAA,EAAO,EAAE,IAAA,EAAM,KAAA,CAAM,IAAA;AAAK,SAC3B,CAAA;AAAA,MACH,CAAA;AAAA,MACA,MAAM,SAAA,GAAY;AAChB,QAAA,OAAO,OAAA,CAAQ,KAAA,EAAO,qBAAA,EAAuB,uBAAuB,CAAA;AAAA,MACtE,CAAA;AAAA,MACA,MAAM,MAAM,KAAA,EAAwB;AAClC,QAAA,OAAO,OAAA,CAAQ,KAAA,EAAO,iBAAA,EAAmB,wBAAA,EAA0B;AAAA,UACjE,OAAO,EAAE,IAAA,EAAM,MAAM,IAAA,EAAM,EAAA,EAAI,MAAM,EAAA;AAAG,SACzC,CAAA;AAAA,MACH;AAAA;AACF,GACF;AACF","file":"index.js","sourcesContent":["import {\n  CardSchema,\n  type CreateCardInput,\n  CreateCardInputSchema,\n  type DailyCountQuery,\n  DailyCountResponseSchema,\n  type HeatmapQuery,\n  HeatmapResponseSchema,\n  type ListCardsQuery,\n  PaginatedSchema,\n  RetentionResponseSchema,\n  type SubmitReviewInput,\n  SubmitReviewInputSchema,\n  SubmitReviewResultSchema,\n  type UpdateCardInput,\n  UpdateCardInputSchema,\n} from \"@hibi/types\";\nimport { z } from \"zod\";\n\nexport interface HibiClientConfig {\n  apiKey: string;\n  baseUrl: string;\n  fetch?: typeof fetch;\n}\n\nexport interface HibiClientError extends Error {\n  status: number;\n  body: unknown;\n}\n\nconst PaginatedCardSchema = PaginatedSchema(CardSchema);\nconst DueResponseSchema = z.object({\n  items: z.array(\n    z.object({ card: CardSchema, cardState: SubmitReviewResultSchema.shape.cardState }),\n  ),\n});\n\nfunction asError(status: number, body: unknown): HibiClientError {\n  const err = new Error(`Hibi API error: ${status}`) as HibiClientError;\n  err.status = status;\n  err.body = body;\n  return err;\n}\n\nexport function createHibiClient(config: HibiClientConfig) {\n  const fetchImpl = config.fetch ?? fetch;\n  const base = config.baseUrl.replace(/\\/+$/, \"\");\n\n  async function request<T>(\n    method: string,\n    path: string,\n    schema: z.ZodType<T>,\n    init: { body?: unknown; query?: Record<string, string | number | undefined> } = {},\n  ): Promise<T> {\n    const url = new URL(`${base}${path}`);\n    if (init.query) {\n      for (const [k, v] of Object.entries(init.query)) {\n        if (v !== undefined) url.searchParams.set(k, String(v));\n      }\n    }\n\n    const headers: Record<string, string> = {\n      Authorization: `Bearer ${config.apiKey}`,\n    };\n    const requestInit: RequestInit = { method, headers };\n    if (init.body !== undefined) {\n      headers[\"Content-Type\"] = \"application/json\";\n      requestInit.body = JSON.stringify(init.body);\n    }\n\n    const res = await fetchImpl(url.toString(), requestInit);\n\n    if (res.status === 204) return undefined as T;\n\n    const text = await res.text();\n    const body = text ? JSON.parse(text) : null;\n\n    if (!res.ok) throw asError(res.status, body);\n    return schema.parse(body);\n  }\n\n  return {\n    cards: {\n      async create(input: CreateCardInput) {\n        const validated = CreateCardInputSchema.parse(input);\n        return request(\"POST\", \"/v1/cards\", CardSchema, { body: validated });\n      },\n      async list(query: ListCardsQuery = { limit: 50 }) {\n        return request(\"GET\", \"/v1/cards\", PaginatedCardSchema, {\n          query: { limit: query.limit, cursor: query.cursor, tag: query.tag, source: query.source },\n        });\n      },\n      async get(id: string) {\n        return request(\"GET\", `/v1/cards/${id}`, CardSchema);\n      },\n      async update(id: string, input: UpdateCardInput) {\n        const validated = UpdateCardInputSchema.parse(input);\n        return request(\"PATCH\", `/v1/cards/${id}`, CardSchema, { body: validated });\n      },\n      async remove(id: string): Promise<void> {\n        await request(\"DELETE\", `/v1/cards/${id}`, z.unknown());\n      },\n    },\n\n    reviews: {\n      async due(query: { limit?: number; before?: string } = {}) {\n        return request(\"GET\", \"/v1/reviews/due\", DueResponseSchema, {\n          query: { limit: query.limit, before: query.before },\n        });\n      },\n      async submit(input: SubmitReviewInput) {\n        const validated = SubmitReviewInputSchema.parse(input);\n        return request(\"POST\", \"/v1/reviews\", SubmitReviewResultSchema, { body: validated });\n      },\n    },\n\n    stats: {\n      async heatmap(query: HeatmapQuery) {\n        return request(\"GET\", \"/v1/stats/heatmap\", HeatmapResponseSchema, {\n          query: { year: query.year },\n        });\n      },\n      async retention() {\n        return request(\"GET\", \"/v1/stats/retention\", RetentionResponseSchema);\n      },\n      async daily(query: DailyCountQuery) {\n        return request(\"GET\", \"/v1/stats/daily\", DailyCountResponseSchema, {\n          query: { from: query.from, to: query.to },\n        });\n      },\n    },\n  };\n}\n\nexport type HibiClient = ReturnType<typeof createHibiClient>;\n"]}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "hibi-client",
+  "version": "0.0.0",
+  "description": "Official TypeScript client for the Hibi flashcard API.",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/YannickHerrero/hibi.git",
+    "directory": "packages/api-client"
+  },
+  "homepage": "https://github.com/YannickHerrero/hibi/tree/master/packages/api-client",
+  "bugs": "https://github.com/YannickHerrero/hibi/issues",
+  "keywords": [
+    "hibi",
+    "srs",
+    "anki",
+    "flashcards",
+    "japanese",
+    "fsrs",
+    "sentence-mining"
+  ],
+  "author": "yannickhrr",
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run --passWithNoTests"
+  },
+  "dependencies": {
+    "@hibi/types": "workspace:*",
+    "zod": "4.4.3"
+  },
+  "devDependencies": {
+    "tsup": "8.5.1",
+    "typescript": "6.0.3",
+    "vitest": "4.1.5"
+  }
+}