@ankinize/sdk 0.1.0 → 1.1.0

package/README.md

@@ -5,10 +5,7 @@ The official TypeScript SDK for the Ankinize REST API: one typed function per en
 ```ts
 import { client, createNote, listDecks } from "@ankinize/sdk";
 
-client.setConfig({
-  baseUrl: "https://your-ankinize.example",
-  auth: process.env.ANKINIZE_API_KEY,
-});
+client.setConfig({ auth: process.env.ANKINIZE_API_KEY });
 
 const { decks } = await listDecks();
 await createNote({
@@ -18,6 +15,8 @@ await createNote({
 });
 ```
 
+Requests go to `https://ankinize.com` by default, so only the API key is needed. `baseUrl` is optional: set it if you run your own server (`client.setConfig({ baseUrl: "https://anki.example.com", auth })`), or for a single call (`listDecks({ baseUrl })`).
+
 A note names its note type and deck (`notetypeName`, `deckName`, compared ignoring case) and gives `fields` as an object keyed by each field's name in camelCase (`Back Extra` is `backExtra`). Send `notetypeId` or `deckId` instead when you have the id: exactly one of `notetypeName` and `notetypeId`, and at most one of `deckName` and `deckId`. A key is a field's name cut into words at spaces, punctuation and lower-to-upper changes, the first word in lower case: `The field` is `theField`, `ab_x` is `abX`, `URLText` is `urlText`. A field's exact name works as a key too, and each note type lists its keys in `getNoteType`. Reading a note (`getNote`, `listNotes`) gives `fields` in the same shape, and `updateNote` takes the same object with only the fields that change.
 
 Parameters are camelCase everywhere. To make a write safe to retry, pass `idempotencyKey`; the SDK sends it as the `Idempotency-Key` header the API reads.
@@ -29,7 +28,7 @@ Out of the box the names are plain strings. To have the compiler check them, gen
 ```ts
 import { client, generateTypes } from "@ankinize/sdk";
 
-client.setConfig({ baseUrl, auth });
+client.setConfig({ auth });
 await Bun.write("ankinize.d.ts", await generateTypes());
 ```
 

package/dist/runtime.d.ts

@@ -16,4 +16,6 @@ export declare class AnkinizeError extends Error {
     /** The raw answer, for headers such as `Retry-After`. Its body is already read. */
     response: Response);
 }
+/** Where the SDK sends requests until `baseUrl` says otherwise (self-hosting sets it). */
+export declare const DEFAULT_BASE_URL = "https://ankinize.com";
 export declare const createClientConfig: CreateClientConfig;

package/dist/runtime.js

@@ -51,7 +51,10 @@ const apiFetch = async (input, init) => {
         throw await toError(response);
     return asBytes(response);
 };
+/** Where the SDK sends requests until `baseUrl` says otherwise (self-hosting sets it). */
+export const DEFAULT_BASE_URL = "https://ankinize.com";
 export const createClientConfig = (config) => ({
     ...config,
+    baseUrl: DEFAULT_BASE_URL,
     fetch: apiFetch,
 });

package/package.json

@@ -1,8 +1,13 @@
 {
 	"name": "@ankinize/sdk",
-	"version": "0.1.0",
+	"version": "1.1.0",
 	"description": "Official TypeScript SDK for the Ankinize REST API. Plain fetch, no runtime dependencies.",
 	"license": "MIT",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/0x0501/Ankinize.git",
+		"directory": "packages/sdk"
+	},
 	"publishConfig": {
 		"access": "public"
 	},