@tinkerer/sdk 0.1.1 → 0.1.3

package/README.md

@@ -15,12 +15,13 @@ bun add @tinkerer/sdk
 ```ts
 import { createLmsClient } from "@tinkerer/sdk";
 
-const lms = createLmsClient("https://api.tinkerer.space");
+const lms = createLmsClient();
 const { writing } = await lms.getDailyJapaneseWriting({});
 ```
 
-One `create<Name>Client(baseUrl)` helper is exported per service
-(`createDirectoryClient`, `createLmsClient`), plus the request/response
-types.
+## Services
+
+- `createDirectoryClient` — directory of tinkerer.space
+- `createLmsClient` — learning management
 
 ESM-only; type declarations included.

package/dist/index.d.ts

@@ -17,16 +17,16 @@ export type DirectoryClient = Client<typeof DirectoryService>;
 /**
  * Creates a directory service client.
  *
- * @param baseUrl Base URL of the tinkerer.space API gateway,
- *   e.g. `https://api.tinkerer.space`.
+ * @param baseUrl Base URL of the API gateway. Defaults to the production
+ *   gateway.
  */
-export declare function createDirectoryClient(baseUrl: string): DirectoryClient;
+export declare function createDirectoryClient(baseUrl?: string): DirectoryClient;
 /** A client for the lms service. */
 export type LmsClient = Client<typeof LmsService>;
 /**
  * Creates an lms service client.
  *
- * @param baseUrl Base URL of the tinkerer.space API gateway,
- *   e.g. `https://api.tinkerer.space`.
+ * @param baseUrl Base URL of the API gateway. Defaults to the production
+ *   gateway.
  */
-export declare function createLmsClient(baseUrl: string): LmsClient;
+export declare function createLmsClient(baseUrl?: string): LmsClient;

package/dist/index.js

@@ -10,23 +10,25 @@ import { DirectoryService } from "./gen/directory/v1/directory_pb.js";
 import { LmsService } from "./gen/lms/v1/lms_pb.js";
 export { Grade, Jlpt } from "./gen/lms/v1/lms_pb.js";
 export { DirectoryService, LmsService };
+/** Base URL of the production tinkerer.space API gateway. */
+const TINKERER_API_URL = "https://api.tinkerer.space";
 /**
  * Creates a directory service client.
  *
- * @param baseUrl Base URL of the tinkerer.space API gateway,
- *   e.g. `https://api.tinkerer.space`.
+ * @param baseUrl Base URL of the API gateway. Defaults to the production
+ *   gateway.
  */
-export function createDirectoryClient(baseUrl) {
+export function createDirectoryClient(baseUrl = TINKERER_API_URL) {
     const transport = createGrpcWebTransport({ baseUrl });
     return createClient(DirectoryService, transport);
 }
 /**
  * Creates an lms service client.
  *
- * @param baseUrl Base URL of the tinkerer.space API gateway,
- *   e.g. `https://api.tinkerer.space`.
+ * @param baseUrl Base URL of the API gateway. Defaults to the production
+ *   gateway.
  */
-export function createLmsClient(baseUrl) {
+export function createLmsClient(baseUrl = TINKERER_API_URL) {
     const transport = createGrpcWebTransport({ baseUrl });
     return createClient(LmsService, transport);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tinkerer/sdk",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Browser SDK for tinkerer.space services.",
   "license": "UNLICENSED",
   "repository": {
@@ -20,7 +20,8 @@
     "dist"
   ],
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": false
   },
   "scripts": {
     "prepublishOnly": "bun install --frozen-lockfile && rm -rf dist && bun run build",