@nokinc-flur/sdk 0.1.0

package/LICENSE

@@ -0,0 +1 @@
+MIT

package/README.md

@@ -0,0 +1,24 @@
+# flur-sdk (Sprint 1 / Week 1)
+
+Typed client scaffold aligned to backend OpenAPI.
+
+## Install (local dev)
+```bash
+npm ci
+npm test
+npm run build
+```
+
+## Generate types (optional)
+This repo includes a minimal OpenAPI file at `openapi/flur.openapi.json`.
+
+```bash
+npm run gen
+```
+
+## E2E test against a running backend (optional)
+1) Start backend locally (see backend README)
+2) Run (E2E executes when RUN_E2E=1 or FLUR_BASE_URL is set):
+```bash
+FLUR_BASE_URL=http://localhost:8080 RUN_E2E=1 npm test
+```

package/dist/index.d.ts

@@ -0,0 +1,30 @@
+type FlurClientOptions = {
+    baseUrl: string;
+    fetchImpl?: typeof fetch;
+    timeoutMs?: number;
+};
+declare class FlurClient {
+    private readonly baseUrl;
+    private readonly fetchImpl;
+    private readonly timeoutMs;
+    constructor(opts: FlurClientOptions);
+    health(): Promise<{
+        ok: boolean;
+    }>;
+    welcome(): Promise<{
+        message: string;
+    }>;
+}
+
+type FlurErrorCode = "NETWORK_ERROR" | "HTTP_ERROR" | "TIMEOUT" | "UNKNOWN";
+declare class FlurError extends Error {
+    readonly code: FlurErrorCode;
+    readonly status?: number;
+    readonly details?: unknown;
+    constructor(message: string, code: FlurErrorCode, opts?: {
+        status?: number;
+        details?: unknown;
+    });
+}
+
+export { FlurClient, type FlurClientOptions, FlurError };

package/dist/index.js

@@ -0,0 +1,74 @@
+// src/errors.ts
+var FlurError = class extends Error {
+  code;
+  status;
+  details;
+  constructor(message, code, opts) {
+    super(message);
+    this.name = "FlurError";
+    this.code = code;
+    this.status = opts?.status;
+    this.details = opts?.details;
+  }
+};
+async function mapToFlurError(res) {
+  let details = void 0;
+  try {
+    const ct = res.headers.get("content-type") ?? "";
+    details = ct.includes("application/json") ? await res.json() : await res.text();
+  } catch {
+  }
+  return new FlurError(`HTTP ${res.status}`, "HTTP_ERROR", { status: res.status, details });
+}
+
+// src/client.ts
+var FlurClient = class {
+  baseUrl;
+  fetchImpl;
+  timeoutMs;
+  constructor(opts) {
+    this.baseUrl = opts.baseUrl.replace(/\/$/, "");
+    this.fetchImpl = opts.fetchImpl ?? fetch;
+    this.timeoutMs = opts.timeoutMs ?? 1e4;
+  }
+  async health() {
+    const url = `${this.baseUrl}/health`;
+    const controller = new AbortController();
+    const t = setTimeout(() => controller.abort(), this.timeoutMs);
+    try {
+      const res = await this.fetchImpl(url, { method: "GET", signal: controller.signal });
+      if (!res.ok) throw await mapToFlurError(res);
+      return await res.json();
+    } catch (err) {
+      if (err instanceof Error && err.name === "AbortError") {
+        throw new FlurError("Request timed out", "TIMEOUT");
+      }
+      if (err instanceof FlurError) throw err;
+      throw new FlurError("Network error", "NETWORK_ERROR", { details: String(err) });
+    } finally {
+      clearTimeout(t);
+    }
+  }
+  async welcome() {
+    const url = `${this.baseUrl}/welcome`;
+    const controller = new AbortController();
+    const t = setTimeout(() => controller.abort(), this.timeoutMs);
+    try {
+      const res = await this.fetchImpl(url, { method: "GET", signal: controller.signal });
+      if (!res.ok) throw await mapToFlurError(res);
+      return await res.json();
+    } catch (err) {
+      if (err instanceof Error && err.name === "AbortError") {
+        throw new FlurError("Request timed out", "TIMEOUT");
+      }
+      if (err instanceof FlurError) throw err;
+      throw new FlurError("Network error", "NETWORK_ERROR", { details: String(err) });
+    } finally {
+      clearTimeout(t);
+    }
+  }
+};
+export {
+  FlurClient,
+  FlurError
+};

package/openapi/flur.openapi.json

@@ -0,0 +1,58 @@
+{
+  "openapi": "3.0.3",
+  "info": {
+    "title": "Flur API",
+    "version": "0.1.0"
+  },
+  "paths": {
+    "/health": {
+      "get": {
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "ok": {
+                      "type": "boolean"
+                    }
+                  },
+                  "required": [
+                    "ok"
+                  ]
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/welcome": {
+      "get": {
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "message": {
+                      "type": "string",
+                      "example": "welcome to flur wallet. Today is 2026-02-07T19:09:53.238Z"
+                    }
+                  },
+                  "required": [
+                    "message"
+                  ]
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@nokinc-flur/sdk",
+  "version": "0.1.0",
+  "description": "Flur Wallet SDK (sprint 1 scaffold)",
+  "license": "MIT",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "openapi",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "lint": "eslint .",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run",
+    "build": "tsup src/index.ts --format esm --dts",
+    "gen": "openapi-typescript openapi/flur.openapi.json -o src/gen/openapi-types.ts"
+  },
+  "dependencies": {
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "@types/node": "^20.11.30",
+    "@typescript-eslint/eslint-plugin": "^7.7.1",
+    "@typescript-eslint/parser": "^7.7.1",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "openapi-typescript": "^7.5.1",
+    "prettier": "^3.2.5",
+    "tsup": "^8.0.2",
+    "typescript": "^5.4.5",
+    "vitest": "^1.5.0"
+  }
+}