@spare-technologies/spare-link 0.1.0-beta.0 → 0.1.0-beta.1

package/CHANGELOG.md

@@ -1,10 +1,20 @@
 # @spare-technologies/spare-link
 
+## 0.1.0-beta.1
+
+### Patch Changes
+
+- [#4](https://github.com/spare-technologies/link-rn/pull/4) [`af05ad2`](https://github.com/spare-technologies/link-rn/commit/af05ad2372b2c96c619f7fc9c06c9085768a406b) Thanks [@bkmehata](https://github.com/bkmehata)! - Clean up published docs and package metadata.
+
+  - Fix the `LICENSE` link in the README so it resolves inside the published package.
+  - Remove README references to an internal-only test package that consumers can't install, plus a stale changelog section describing a removed API.
+  - Drop an internal, dev-only entry from the published `package.json` dependency list.
+
 ## 0.1.0-beta.0
 
 ### Minor Changes
 
-- [#1](https://github.com/spare-technologies/link-rn/pull/1) [`bc3040c`](https://github.com/spare-technologies/link-rn/commit/bc3040c58ab63934d81f1ead0083293f2e0ed164) Thanks [@bdspare](https://github.com/bdspare)! - Initial public beta of `@spare-technologies/spare-link` — the React Native SDK for Spare Link open-banking payments (port of the Flutter `spare_link` SDK, with byte-for-byte parity on retry/timeout/state-machine semantics).
+- [#1](https://github.com/spare-technologies/link-rn/pull/1) [`bc3040c`](https://github.com/spare-technologies/link-rn/commit/bc3040c58ab63934d81f1ead0083293f2e0ed164) Thanks [@bdspare](https://github.com/bdspare)! - Initial public beta of `@spare-technologies/spare-link` — the React Native SDK for Spare Link open-banking payments.
 
   - Instance-based API: construct one `SpareLink`, mount one `<SpareLinkHost>`, and call `spareLink.start({ linkToken })` — `session.result` resolves to a discriminated `PaymentResult` (`success | cancelled | failed | abandoned`).
   - 9-phase `PaymentFlowController` with a 5-minute awaiting-callback timeout, single/multi-payment (mandate) and international consent UIs, and Confirmation-of-Payee gating.
@@ -13,54 +23,3 @@
   - Deep-link wiring via `useSpareLinkDeepLinks(spareLink)` and `spareLink.handleRedirect(uri)`.
   - Expo config plugin (`@spare-technologies/spare-link/expo-plugin`) shipping iOS + Android permission and deep-link setup.
   - Ships compiled CommonJS + ESM + TypeScript declarations, with `src` retained for Metro consumers.
-  - Companion `@spare-technologies/link-test-harness` MSW mock Link server for TDD.
-
-## Unreleased
-
-### Changed
-
-- Package name finalized as `@spare-technologies/spare-link`, aligned with the Flutter `spare_link` package. Earlier pre-release development used a different scope and a `link-rn` suffix; nothing was published under those names, so no consumer action is required.
-
-### Fixed
-
-- Payment flow recovery now buffers bank-return URIs on cold start, clears pending sessions on completion, and polls `/link/status` every 10s while awaiting the bank (production + sandbox).
-- Sandbox auto-success on status poll only applies after `callback_received` (bank returned), not while still `redirected` — fixes false success on app restart before bank authorization.
-- Failed-screen copy is sanitized via `userFriendlyMessageFor` — raw backend messages are no longer shown.
-- Cancel during bank processing now shows a confirmation dialog (Flutter parity).
-
-### Added
-
-- Instance-based `SpareLink` + `SpareLinkHost` API (Flutter-aligned: one instance, one host), replacing the earlier static `SpareLink.start`/`SpareLinkProvider` shape.
-- `spareLink.resumeIfNeeded()` returning typed `RecoveryResult` (`recovered` | `awaitingUser` | `none`).
-- `merchantRef` on `PaymentSuccess` when present in the bank callback URI.
-- `abandoned` lifecycle event when the modal dismiss control is used mid-flow.
-- Corrected CTA copy: `Proceed using Altareq` / `Pay using Altareq` (was `AlTareq` on some screens).
-- Accordion section headers, chevron color, and dividers now match Flutter consent UI.
-- Payment setup card border radius aligned with Flutter (12px).
-
-### Added
-
-- MetroSans font assets loaded automatically by `SpareLinkHost`.
-- `showDismissButton` prop on `SpareLinkHost` (default `true`; merchant demo sets `false` for Flutter parity).
-- Multi-payment (mandate) consent UI for all six schedule types, porting Flutter `spare_link` parity.
-- International payment consent UI with read-only charge bearer display.
-- `MandateSetupSuccessScreen` recap before the success callback for mandate flows.
-- `summaryFromState()` returning discriminated `ConsentSummaryData` (`singlePayment` | `international` | `multiPayment`).
-- CoP skipped for international payments.
-- Test harness scenarios `multipaymentFixedOnDemand`, `multipaymentFixedDefinedSchedule`, and `internationalPayment`.
-
-## 0.1.0-beta.1
-
-### Initial public beta
-
-- `SpareLink.start({ config, callbacks? })` — launches the native Link payment Modal and resolves with a `PaymentResult`.
-- `SpareLink.handleRedirect(uri)` — forwards bank-return URIs to the active flow.
-- `SpareLink.resumeIfNeeded({ config, callbacks? })` — recovers in-flight sessions on cold-start; auto-fails after `kMaxRecoveryAttempts` (3).
-- `SpareLink.delegate` swap point for tests.
-- `SpareLinkProvider` host component mounting the SDK Modal + delegating `start/handleRedirect/resumeIfNeeded`.
-- `useSpareLinkDeepLinks()` hook wiring `Linking` to `SpareLink.handleRedirect`.
-- `SecureStorePendingSessionStore` backed by `expo-secure-store`.
-- Expo config plugin (`@spare-technologies/spare-link/expo-plugin`) injecting iOS location permission + URL scheme + Android permissions + intent-filters.
-- 9-phase `PaymentFlowController` with 5-minute awaiting-callback timeout.
-- `LinkApiClient` with header parity, retry/timeout, and stable Idempotency-Key for POST `/link/consent`.
-- 34 jest tests + 25 harness tests at green.

package/README.md

@@ -10,9 +10,8 @@ npm i @spare-technologies/spare-link
 
 ## Quickstart
 
-The SDK is instance-based (mirrors the Flutter `spare_link` API): create one `SpareLink`
-instance, mount one `SpareLinkHost` near your app root, and pass that instance to every
-screen that starts a payment.
+The SDK is instance-based: create one `SpareLink` instance, mount one `SpareLinkHost` near
+your app root, and pass that instance to every screen that starts a payment.
 
 ```tsx
 import { SpareLink, SpareLinkHost, useSpareLinkDeepLinks } from '@spare-technologies/spare-link';
@@ -53,7 +52,7 @@ plugins: [
     '@spare-technologies/spare-link/expo-plugin',
     {
       locationUsageDescription: 'We use your location to verify the payment.',
-      merchantScheme: 'sparemerchantrn',
+      merchantScheme: 'myapp',
       merchantHost: 'callback',
     },
   ],
@@ -62,8 +61,8 @@ plugins: [
 
 The plugin injects:
 
-- **iOS**: `NSLocationWhenInUseUsageDescription` + `CFBundleURLSchemes` entry for the merchant scheme.
-- **Android**: `ACCESS_FINE_LOCATION` permission + intent-filter for `sparemerchantrn://callback` (and an optional `autoVerify=true` App Link for the Spare universal-link host).
+- **iOS**: `NSLocationWhenInUseUsageDescription` + `CFBundleURLSchemes` entry for your app scheme.
+- **Android**: `ACCESS_FINE_LOCATION` permission + intent-filter for `myapp://callback` (and an optional `autoVerify=true` App Link for the Spare universal-link host).
 
 ## Deep-link handling
 
@@ -107,23 +106,6 @@ AppState.addEventListener('change', (state) => {
 
 After `kMaxRecoveryAttempts` (3) non-terminal attempts the SDK resolves `PaymentFailed('recovery_exhausted')` and clears the record.
 
-## Testing with the harness
-
-Add `@spare-technologies/link-test-harness` as a dev dep — it ships a stateful MSW mock Link API with tofa-accurate `{ data }` envelopes:
-
-```ts
-import { setupMockLinkApi } from '@spare-technologies/link-test-harness';
-
-const server = setupMockLinkApi({ scenario: 'happyPath' });
-beforeAll(() => server.start());
-afterAll(() => server.stop());
-afterEach(() => server.reset());
-```
-
-Available scenarios: `happyPath`, `sessionAlreadyInitialized`, `networkTimeout`, `consentRetry`, `sessionTimeout`, `recoveryViaStatus`, `appReturn`, `terminalCompleted | Failed | Cancelled | Expired`, `tenantMismatch`, `providerUnavailable`, `multipaymentFixedOnDemand`, `multipaymentFixedDefinedSchedule`, `internationalPayment`.
-
-For tests that don't want to mount `SpareLinkHost`, drive the instance's internal host delegate directly (see `SpareLink._attachHost` usage in the SDK's own `spare-link-instance.test.ts` for the pattern), or stub the app-level function that wraps `spareLink.start(...)` in your own integration layer.
-
 ## API reference
 
 ### `new SpareLink(options)`
@@ -170,4 +152,4 @@ type SpareLinkEventType =
 
 ## License
 
-MIT — see [LICENSE](../../LICENSE).
+MIT — see [LICENSE](./LICENSE).

package/lib/commonjs/version.js

@@ -5,10 +5,12 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.SDK_VERSION = void 0;
 /**
- * SDK version reported in telemetry and the default User-Agent. This file is
- * regenerated from `package.json` by the root `version` npm script on every
- * release bump (see the `version` script in the repo-root package.json), so it
- * always matches the published version — do not edit the literal by hand.
+ * SDK version reported in telemetry and the default User-Agent.
+ *
+ * GENERATED FILE — do not edit by hand. Written from package.json by
+ * scripts/sync-sdk-version.mjs (run by the root `version` npm script after
+ * `changeset version`). The src/index.ts smoke test asserts this matches
+ * package.json's version.
  */
-const SDK_VERSION = exports.SDK_VERSION = '0.1.0-beta.0';
+const SDK_VERSION = exports.SDK_VERSION = '0.1.0-beta.1';
 //# sourceMappingURL=version.js.map

package/lib/commonjs/version.js.map

@@ -1 +1 @@
-{"version":3,"names":["SDK_VERSION","exports"],"sourceRoot":"../../src","sources":["version.ts"],"mappings":";;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMA,WAAW,GAAAC,OAAA,CAAAD,WAAA,GAAG,cAAuB","ignoreList":[]}
+{"version":3,"names":["SDK_VERSION","exports"],"sourceRoot":"../../src","sources":["version.ts"],"mappings":";;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMA,WAAW,GAAAC,OAAA,CAAAD,WAAA,GAAG,cAAuB","ignoreList":[]}

package/lib/module/version.js

@@ -1,10 +1,12 @@
 "use strict";
 
 /**
- * SDK version reported in telemetry and the default User-Agent. This file is
- * regenerated from `package.json` by the root `version` npm script on every
- * release bump (see the `version` script in the repo-root package.json), so it
- * always matches the published version — do not edit the literal by hand.
+ * SDK version reported in telemetry and the default User-Agent.
+ *
+ * GENERATED FILE — do not edit by hand. Written from package.json by
+ * scripts/sync-sdk-version.mjs (run by the root `version` npm script after
+ * `changeset version`). The src/index.ts smoke test asserts this matches
+ * package.json's version.
  */
-export const SDK_VERSION = '0.1.0-beta.0';
+export const SDK_VERSION = '0.1.0-beta.1';
 //# sourceMappingURL=version.js.map

package/lib/module/version.js.map

@@ -1 +1 @@
-{"version":3,"names":["SDK_VERSION"],"sourceRoot":"../../src","sources":["version.ts"],"mappings":";;AAAA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMA,WAAW,GAAG,cAAuB","ignoreList":[]}
+{"version":3,"names":["SDK_VERSION"],"sourceRoot":"../../src","sources":["version.ts"],"mappings":";;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMA,WAAW,GAAG,cAAuB","ignoreList":[]}

package/lib/typescript/commonjs/version.d.ts

@@ -1,8 +1,10 @@
 /**
- * SDK version reported in telemetry and the default User-Agent. This file is
- * regenerated from `package.json` by the root `version` npm script on every
- * release bump (see the `version` script in the repo-root package.json), so it
- * always matches the published version — do not edit the literal by hand.
+ * SDK version reported in telemetry and the default User-Agent.
+ *
+ * GENERATED FILE — do not edit by hand. Written from package.json by
+ * scripts/sync-sdk-version.mjs (run by the root `version` npm script after
+ * `changeset version`). The src/index.ts smoke test asserts this matches
+ * package.json's version.
  */
-export declare const SDK_VERSION: "0.1.0-beta.0";
+export declare const SDK_VERSION: "0.1.0-beta.1";
 //# sourceMappingURL=version.d.ts.map

package/lib/typescript/commonjs/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../../src/version.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,WAAW,EAAG,cAAuB,CAAC"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../../src/version.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW,EAAG,cAAuB,CAAC"}

package/lib/typescript/module/version.d.ts

@@ -1,8 +1,10 @@
 /**
- * SDK version reported in telemetry and the default User-Agent. This file is
- * regenerated from `package.json` by the root `version` npm script on every
- * release bump (see the `version` script in the repo-root package.json), so it
- * always matches the published version — do not edit the literal by hand.
+ * SDK version reported in telemetry and the default User-Agent.
+ *
+ * GENERATED FILE — do not edit by hand. Written from package.json by
+ * scripts/sync-sdk-version.mjs (run by the root `version` npm script after
+ * `changeset version`). The src/index.ts smoke test asserts this matches
+ * package.json's version.
  */
-export declare const SDK_VERSION: "0.1.0-beta.0";
+export declare const SDK_VERSION: "0.1.0-beta.1";
 //# sourceMappingURL=version.d.ts.map

package/lib/typescript/module/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../../src/version.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,WAAW,EAAG,cAAuB,CAAC"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../../src/version.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW,EAAG,cAAuB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spare-technologies/spare-link",
-  "version": "0.1.0-beta.0",
+  "version": "0.1.0-beta.1",
   "description": "React Native SDK for Spare Link — open banking payments via a native checkout sheet.",
   "main": "./lib/commonjs/index.js",
   "module": "./lib/module/index.js",
@@ -97,7 +97,6 @@
     "react-native-svg": "15.8.0"
   },
   "devDependencies": {
-    "@spare-technologies/link-test-harness": "workspace:*",
     "@testing-library/jest-native": "^5.4.3",
     "@testing-library/react-native": "^13.0.0",
     "@types/jest": "^29.5.13",

package/src/version.ts

@@ -1,7 +1,9 @@
 /**
- * SDK version reported in telemetry and the default User-Agent. This file is
- * regenerated from `package.json` by the root `version` npm script on every
- * release bump (see the `version` script in the repo-root package.json), so it
- * always matches the published version — do not edit the literal by hand.
+ * SDK version reported in telemetry and the default User-Agent.
+ *
+ * GENERATED FILE — do not edit by hand. Written from package.json by
+ * scripts/sync-sdk-version.mjs (run by the root `version` npm script after
+ * `changeset version`). The src/index.ts smoke test asserts this matches
+ * package.json's version.
  */
-export const SDK_VERSION = '0.1.0-beta.0' as const;
+export const SDK_VERSION = '0.1.0-beta.1' as const;