@nokinc-flur/sdk 0.1.6 → 1.0.0

package/LICENSE

@@ -1,21 +1,32 @@
-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.
+Copyright (c) 2026 NokInc / Flur. All rights reserved.
+
+PROPRIETARY AND CONFIDENTIAL
+
+This software (the "Software") is the confidential and proprietary information
+of NokInc / Flur ("Licensor"). It is licensed, not sold, to authorized partners
+and developers ("Licensee") for the sole purpose of integrating with Flur
+services.
+
+Licensee MAY:
+  * Install and use the Software in applications that consume Flur APIs under
+    a valid agreement with Licensor.
+  * Make local copies for backup and development purposes.
+
+Licensee MAY NOT:
+  * Redistribute, sublicense, sell, lease, rent, or otherwise transfer the
+    Software or any derivative works thereof to any third party.
+  * Reverse engineer, decompile, or disassemble the Software, except to the
+    extent permitted by applicable law notwithstanding this limitation.
+  * Remove or alter any proprietary notices.
+  * Use the Software to build a competing product or service.
+
+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
+LICENSOR BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY ARISING FROM,
+OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR ITS USE.
+
+This license terminates automatically upon any breach. Upon termination,
+Licensee must destroy all copies of the Software in their possession.
+
+For licensing inquiries: legal@flur.ng

package/README.md

@@ -3,32 +3,38 @@
 Typed client scaffold aligned to backend OpenAPI.
 
 ## Install (local dev)
+
 ```bash
-npm ci
-npm test
-npm run build
+pnpm install --frozen-lockfile
+pnpm test
+pnpm build
 ```
 
 ## Generate types (optional)
+
 This repo includes a minimal OpenAPI file at `openapi/flur.openapi.json`.
 
 ```bash
-npm run gen
+pnpm 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):
+
+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
+FLUR_BASE_URL=http://localhost:8080 RUN_E2E=1 pnpm test
 ```
 
 Contract-focused E2E only:
+
 ```bash
-FLUR_BASE_URL=https://your-oci-gateway.example.com RUN_E2E=1 npm run test:contract
+FLUR_BASE_URL=https://your-oci-gateway.example.com RUN_E2E=1 pnpm test:contract
 ```
 
 Optional envs for full send-money E2E coverage:
+
 - `FLUR_E2E_SESSION_TOKEN` (required for account/transactions/recipient)
 - `FLUR_E2E_RECIPIENT_IDENTIFIER` (required for recipient resolve / transfer)
 - `FLUR_E2E_SEND_AUTH_TOKEN` (required for transfer create)
@@ -37,35 +43,36 @@ Optional envs for full send-money E2E coverage:
 - `FLUR_E2E_CURRENCY` (optional, default `NGN`)
 
 Generate real E2E auth inputs against deployed backend:
+
 ```bash
 # Step 1: start onboarding and get requestId
-npm run e2e:bootstrap -- --base-url https://your-oci-gateway --phone +23480xxxxxxx
+pnpm e2e:bootstrap -- --base-url https://your-oci-gateway --phone +23480xxxxxxx
 
 # Step 2: rerun with OTP/silent-auth code (and optional recipient)
-npm run e2e:bootstrap -- --base-url https://your-oci-gateway --phone +23480xxxxxxx --code 123456 --recipient +23481xxxxxxx
+pnpm e2e:bootstrap -- --base-url https://your-oci-gateway --phone +23480xxxxxxx --code 123456 --recipient +23481xxxxxxx
 
 # Script prints PowerShell env exports, then run:
-npm run test:contract
+pnpm test:contract
 ```
 
 ## Onboarding flow methods
 
 ```ts
-import { FlurClient } from "@nokinc-flur/sdk";
+import { FlurClient } from '@nokinc-flur/sdk';
 
-const client = new FlurClient({ baseUrl: "https://api.example.com" });
+const client = new FlurClient({ baseUrl: 'https://api.example.com' });
 
 const started = await client.onboardingStart({
-	phoneE164: "+14155550123",
-	appInstanceId: "app-instance-1",
-	platform: "ios",
+  phoneE164: '+14155550123',
+  appInstanceId: 'app-instance-1',
+  platform: 'ios',
 });
 // started: { requestId, checkUrl?, expiresInSec, fallback }
 
 const completed = await client.onboardingComplete({
-	requestId: started.requestId,
-	code: "123456",
-	appInstanceId: "app-instance-1",
+  requestId: started.requestId,
+  code: '123456',
+  appInstanceId: 'app-instance-1',
 });
 // completed: { sessionToken, userId, restricted, risk_reasons }
 ```
@@ -73,27 +80,36 @@ const completed = await client.onboardingComplete({
 ## Auth + device security methods
 
 ```ts
-const registered = await client.registerDevice({
-	userId: completed.userId,
-	appInstanceId: "app-instance-1",
-	platform: "ios",
-	networkSignals: { ip: "1.2.3.4" },
-}, { accessToken: completed.sessionToken });
+const registered = await client.registerDevice(
+  {
+    userId: completed.userId,
+    appInstanceId: 'app-instance-1',
+    platform: 'ios',
+    networkSignals: { ip: '1.2.3.4' },
+  },
+  { accessToken: completed.sessionToken },
+);
 // { deviceId, fingerprintHash, driftScore, trustState, stepUpRequired }
 
 const refreshed = await client.authRefresh({
-	userId: completed.userId,
-	refreshToken: completed.sessionToken,
-	appInstanceId: "app-instance-1",
-	fingerprintHash: registered.fingerprintHash,
+  userId: completed.userId,
+  refreshToken: completed.sessionToken,
+  appInstanceId: 'app-instance-1',
+  fingerprintHash: registered.fingerprintHash,
 });
 // { refreshToken, stepUpRequired }
 
-await client.pinSet({ userId: completed.userId, pin: "123456" }, { accessToken: completed.sessionToken });
-await client.pinVerify({ userId: completed.userId, pin: "123456" }, { accessToken: completed.sessionToken });
+await client.pinSet(
+  { userId: completed.userId, pin: '123456' },
+  { accessToken: completed.sessionToken },
+);
+await client.pinVerify(
+  { userId: completed.userId, pin: '123456' },
+  { accessToken: completed.sessionToken },
+);
 await client.authLogout(
-	{ userId: completed.userId, refreshToken: refreshed.refreshToken },
-	{ accessToken: refreshed.refreshToken }
+  { userId: completed.userId, refreshToken: refreshed.refreshToken },
+  { accessToken: refreshed.refreshToken },
 );
 ```
 
@@ -101,53 +117,66 @@ await client.authLogout(
 
 ```ts
 // Register per-device signing key for send authorization
-await client.registerSendDeviceKey({
-	userId: completed.userId,
-	deviceId: registered.deviceId,
-	publicKey: "-----BEGIN PUBLIC KEY-----...",
-}, { accessToken: completed.sessionToken });
+await client.registerSendDeviceKey(
+  {
+    userId: completed.userId,
+    deviceId: registered.deviceId,
+    publicKey: '-----BEGIN PUBLIC KEY-----...',
+  },
+  { accessToken: completed.sessionToken },
+);
 
 // Obtain challenge and verify signature to get short-lived send token
-const challenge = await client.createSendChallenge({
-	userId: completed.userId,
-	deviceId: registered.deviceId,
-}, { accessToken: completed.sessionToken });
-
-const send = await client.verifySendChallenge({
-	userId: completed.userId,
-	deviceId: registered.deviceId,
-	challengeId: challenge.challengeId,
-	signature: "base64-signature",
-}, { accessToken: completed.sessionToken });
+const challenge = await client.createSendChallenge(
+  {
+    userId: completed.userId,
+    deviceId: registered.deviceId,
+  },
+  { accessToken: completed.sessionToken },
+);
+
+const send = await client.verifySendChallenge(
+  {
+    userId: completed.userId,
+    deviceId: registered.deviceId,
+    challengeId: challenge.challengeId,
+    signature: 'base64-signature',
+  },
+  { accessToken: completed.sessionToken },
+);
 
 // Resolve recipient and create transfer
 const recipient = await client.resolveRecipient(
-	{ identifier: "+14155550123" },
-	{ accessToken: completed.sessionToken }
+  { identifier: '+14155550123' },
+  { accessToken: completed.sessionToken },
 );
 
 await client.createTransfer(
-	{
-		recipientIdentifier: recipient.normalizedIdentifier,
-		amountMinor: 5000,
-		currency: "NGN",
-		sendAuthToken: send.sendAuthToken,
-	},
-	{
-		accessToken: completed.sessionToken,
-		deviceId: registered.deviceId,
-		idempotencyKey: crypto.randomUUID(),
-	}
+  {
+    recipientIdentifier: recipient.normalizedIdentifier,
+    amountMinor: 5000,
+    currency: 'NGN',
+    sendAuthToken: send.sendAuthToken,
+  },
+  {
+    accessToken: completed.sessionToken,
+    deviceId: registered.deviceId,
+    idempotencyKey: crypto.randomUUID(),
+  },
 );
 
 // Account + transaction endpoints
 await client.accountSummary({ accessToken: completed.sessionToken });
-await client.listTransactions({ accessToken: completed.sessionToken, limit: 20 });
+await client.listTransactions({
+  accessToken: completed.sessionToken,
+  limit: 20,
+});
 ```
 
 ## Error code mapping
 
 SDK maps backend error payload `code` into typed `FlurError.code` when available:
+
 - `TOKEN_REPLAYED`
 - `SESSION_MISMATCH`
 - `PIN_INVALID`
@@ -156,6 +185,7 @@ SDK maps backend error payload `code` into typed `FlurError.code` when available
 - `STEP_UP_REQUIRED`
 
 Fallback codes remain:
+
 - `HTTP_ERROR`, `NETWORK_ERROR`, `TIMEOUT`, `UNKNOWN`
 
 ## Lean prod release workflow (one-person team)
@@ -181,18 +211,19 @@ PowerShell script (Windows):
 ```
 
 What it does:
+
 - verifies git working tree is clean
-- runs `npm ci`
-- runs `npm run lint`, `npm run typecheck`, `npm test`, `npm run build`
+- runs `pnpm install --frozen-lockfile`
+- runs `pnpm lint`, `pnpm typecheck`, `pnpm test`, `pnpm 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:
+Release script aliases:
 
 ```bash
-npm run release:patch
-npm run release:minor
-npm run release:major
+pnpm release:patch
+pnpm release:minor
+pnpm release:major
 ```