@nokinc-flur/sdk 0.1.0 → 0.1.1

package/LICENSE

@@ -1 +1,21 @@
-MIT
+MIT License
+
+Copyright (c) 2026 NokInc Flur
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -22,3 +22,59 @@ npm run gen
 ```bash
 FLUR_BASE_URL=http://localhost:8080 RUN_E2E=1 npm test
 ```
+
+## Onboarding flow methods
+
+```ts
+import { FlurClient } from "@nokinc-flur/sdk";
+
+const client = new FlurClient({ baseUrl: "https://api.example.com" });
+
+const started = await client.onboardingStart({ phoneE164: "+14155550123" });
+// started: { requestId, checkUrl?, expiresInSec, fallback }
+
+const completed = await client.onboardingComplete({
+	requestId: started.requestId,
+	code: "123456",
+});
+// completed: { sessionToken, userId, restricted, risk_reasons }
+```
+
+## Lean prod release workflow (one-person team)
+
+PowerShell script (Windows):
+
+```powershell
+# patch release (recommended for this onboarding addition)
+./scripts/release.ps1 -Bump patch
+
+# exact version release (example: 1.0.1)
+./scripts/release.ps1 -Version 1.0.1
+
+# include E2E run (uses default OCI API Gateway URL from release script)
+./scripts/release.ps1 -Version 1.0.1 -RunE2E
+
+# include E2E run with override URL
+./scripts/release.ps1 -Version 1.0.1 -RunE2E -E2EBaseUrl https://your-api.example.com
+
+# publish to npm after all checks pass
+./scripts/release.ps1 -Bump patch -Publish
+./scripts/release.ps1 -Version 1.0.1 -Publish
+```
+
+What it does:
+- verifies git working tree is clean
+- runs `npm ci`
+- runs `npm run lint`, `npm run typecheck`, `npm test`, `npm run build`
+- creates tarball via `npm pack` and smoke-tests install in a temp project
+- bumps version (`patch`/`minor`/`major`) and creates git tag
+- pushes commit and tag (`git push`, `git push --tags`)
+- optionally publishes to npm (`-Publish`)
+
+NPM aliases:
+
+```bash
+npm run release:patch
+npm run release:minor
+npm run release:major
+```

package/dist/index.d.ts

@@ -3,6 +3,27 @@ type FlurClientOptions = {
     fetchImpl?: typeof fetch;
     timeoutMs?: number;
 };
+type OnboardingFallback = "SILENT_AUTH" | "OTP";
+type OnboardingStartInput = {
+    phoneE164: string;
+};
+type OnboardingStartResponse = {
+    requestId: string;
+    checkUrl?: string;
+    expiresInSec: number;
+    fallback: OnboardingFallback;
+};
+type OnboardingRiskReason = "SIM_SWAP_RECENT" | "ROAMING" | "CARRIER_CHANGED";
+type OnboardingCompleteInput = {
+    requestId: string;
+    code: string;
+};
+type OnboardingCompleteResponse = {
+    sessionToken: string;
+    userId: string;
+    restricted: boolean;
+    risk_reasons: OnboardingRiskReason[];
+};
 declare class FlurClient {
     private readonly baseUrl;
     private readonly fetchImpl;
@@ -14,6 +35,9 @@ declare class FlurClient {
     welcome(): Promise<{
         message: string;
     }>;
+    onboardingStart(input: OnboardingStartInput): Promise<OnboardingStartResponse>;
+    onboardingComplete(input: OnboardingCompleteInput): Promise<OnboardingCompleteResponse>;
+    private requestJson;
 }
 
 type FlurErrorCode = "NETWORK_ERROR" | "HTTP_ERROR" | "TIMEOUT" | "UNKNOWN";
@@ -27,4 +51,4 @@ declare class FlurError extends Error {
     });
 }
 
-export { FlurClient, type FlurClientOptions, FlurError };
+export { FlurClient, type FlurClientOptions, FlurError, type OnboardingCompleteInput, type OnboardingCompleteResponse, type OnboardingFallback, type OnboardingRiskReason, type OnboardingStartInput, type OnboardingStartResponse };

package/dist/index.js

@@ -32,29 +32,31 @@ var FlurClient = class {
     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);
-    }
+    return this.requestJson("/health", { method: "GET" });
   }
   async welcome() {
-    const url = `${this.baseUrl}/welcome`;
+    return this.requestJson("/welcome", { method: "GET" });
+  }
+  async onboardingStart(input) {
+    return this.requestJson("/v1/onboarding/start", {
+      method: "POST",
+      headers: { "content-type": "application/json" },
+      body: JSON.stringify(input)
+    });
+  }
+  async onboardingComplete(input) {
+    return this.requestJson("/v1/onboarding/complete", {
+      method: "POST",
+      headers: { "content-type": "application/json" },
+      body: JSON.stringify(input)
+    });
+  }
+  async requestJson(path, init) {
+    const url = `${this.baseUrl}${path}`;
     const controller = new AbortController();
     const t = setTimeout(() => controller.abort(), this.timeoutMs);
     try {
-      const res = await this.fetchImpl(url, { method: "GET", signal: controller.signal });
+      const res = await this.fetchImpl(url, { ...init, signal: controller.signal });
       if (!res.ok) throw await mapToFlurError(res);
       return await res.json();
     } catch (err) {

package/openapi/flur.openapi.json

@@ -53,6 +53,183 @@
           }
         }
       }
+    },
+    "/v1/onboarding/start": {
+      "post": {
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "phoneE164": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "phoneE164"
+                ]
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Verification started",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "requestId": {
+                      "type": "string"
+                    },
+                    "checkUrl": {
+                      "type": "string"
+                    },
+                    "expiresInSec": {
+                      "type": "integer"
+                    },
+                    "fallback": {
+                      "type": "string",
+                      "enum": [
+                        "SILENT_AUTH",
+                        "OTP"
+                      ]
+                    }
+                  },
+                  "required": [
+                    "requestId",
+                    "expiresInSec",
+                    "fallback"
+                  ]
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Unable to start verification",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "error": {
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "error"
+                  ]
+                }
+              }
+            }
+          },
+          "429": {
+            "description": "Rate limited",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "error": {
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "error"
+                  ]
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/onboarding/complete": {
+      "post": {
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "requestId": {
+                    "type": "string"
+                  },
+                  "code": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "requestId",
+                  "code"
+                ]
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Verification completed",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "sessionToken": {
+                      "type": "string"
+                    },
+                    "userId": {
+                      "type": "string"
+                    },
+                    "restricted": {
+                      "type": "boolean"
+                    },
+                    "risk_reasons": {
+                      "type": "array",
+                      "items": {
+                        "type": "string",
+                        "enum": [
+                          "SIM_SWAP_RECENT",
+                          "ROAMING",
+                          "CARRIER_CHANGED"
+                        ]
+                      }
+                    }
+                  },
+                  "required": [
+                    "sessionToken",
+                    "userId",
+                    "restricted",
+                    "risk_reasons"
+                  ]
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Verification failed",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "error": {
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "error"
+                  ]
+                }
+              }
+            }
+          }
+        }
+      }
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nokinc-flur/sdk",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Flur Wallet SDK (sprint 1 scaffold)",
   "license": "MIT",
   "type": "module",
@@ -23,7 +23,10 @@
     "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"
+    "gen": "openapi-typescript openapi/flur.openapi.json -o src/gen/openapi-types.ts",
+    "release:patch": "pwsh -NoProfile -ExecutionPolicy Bypass -File ./scripts/release.ps1 -Bump patch",
+    "release:minor": "pwsh -NoProfile -ExecutionPolicy Bypass -File ./scripts/release.ps1 -Bump minor",
+    "release:major": "pwsh -NoProfile -ExecutionPolicy Bypass -File ./scripts/release.ps1 -Bump major"
   },
   "dependencies": {
     "zod": "^3.23.8"
@@ -40,4 +43,4 @@
     "typescript": "^5.4.5",
     "vitest": "^1.5.0"
   }
-}
+}