@rebilly/framepay-react 14.28.0 → 14.29.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,5 @@
1
- ## 14.28.0 (2026-10-08)
1
+ ## 14.29.0 (2026-10-09)
2
2
 
3
3
  ### 🧱 Updated Dependencies
4
4
 
5
- - Updated framepay-npm to 5.225.0
5
+ - Updated framepay-npm to 5.226.0
@@ -9,7 +9,10 @@ export default class Provider extends React.Component<ProviderProps, FramePayCon
9
9
  onTokenReady: () => {};
10
10
  };
11
11
  readonly state: FramePayContext;
12
+ private listeners;
13
+ private unmounted;
12
14
  componentDidMount(): void;
15
+ componentWillUnmount(): void;
13
16
  onApiError(): void;
14
17
  onApiReady(): Promise<void>;
15
18
  render(): React.JSX.Element;
@@ -60,6 +60,11 @@ class Provider extends React.Component {
60
60
  error: null,
61
61
  ready: false,
62
62
  };
63
+ // The listeners this Provider added to the page's FramePay, removed when
64
+ // it unmounts. FramePay keeps one instance per page, so a Provider that
65
+ // mounts again must not leave the earlier one's callbacks on it.
66
+ this.listeners = {};
67
+ this.unmounted = false;
63
68
  }
64
69
  componentDidMount() {
65
70
  if (this.props.injectScript) {
@@ -69,6 +74,22 @@ class Provider extends React.Component {
69
74
  });
70
75
  }
71
76
  }
77
+ componentWillUnmount() {
78
+ this.unmounted = true;
79
+ const api = (0, get_framepay_api_1.default)();
80
+ if (!api) {
81
+ return;
82
+ }
83
+ if (this.listeners.ready) {
84
+ api.off('ready', this.listeners.ready);
85
+ }
86
+ if (this.listeners.error) {
87
+ api.off('error', this.listeners.error);
88
+ }
89
+ if (this.listeners.tokenReady) {
90
+ api.off('token-ready', this.listeners.tokenReady);
91
+ }
92
+ }
72
93
  onApiError() {
73
94
  return this.setState({
74
95
  error: framepay_error_1.default.codes.remoteScriptError,
@@ -81,20 +102,25 @@ class Provider extends React.Component {
81
102
  });
82
103
  }
83
104
  async onApiReady() {
105
+ if (this.unmounted) {
106
+ return;
107
+ }
84
108
  const api = (0, get_framepay_api_1.default)();
85
109
  try {
86
110
  // eslint-disable-next-line @typescript-eslint/no-unused-vars
87
111
  const _a = this.props, { children } = _a, settings = __rest(_a, ["children"]);
88
- api.initialize(settings);
89
- api.on('ready', () => {
90
- this.setState({ ready: true, api, error: null });
91
- // call onReady callback
92
- if (this.props.onReady) {
93
- this.props.onReady();
94
- }
95
- });
96
- api.on('error', (error) => {
112
+ // FramePay keeps one instance per page and rejects a second
113
+ // initialize() with already-initialized. A Provider that mounts
114
+ // after another one did, on a route change, a remount or under
115
+ // React StrictMode, gives the running instance its own settings
116
+ // once that instance is ready, as framepay-vue does.
117
+ const initializedBefore = api.initialized;
118
+ const onError = (error) => {
97
119
  var _a;
120
+ // A rejected update can land after this Provider unmounted.
121
+ if (this.unmounted) {
122
+ return;
123
+ }
98
124
  this.setState({
99
125
  api,
100
126
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -104,12 +130,50 @@ class Provider extends React.Component {
104
130
  if (this.props.onError) {
105
131
  this.props.onError(error);
106
132
  }
107
- });
108
- api.on('token-ready', (token) => {
133
+ };
134
+ const onReady = () => {
135
+ const applied = initializedBefore
136
+ ? api.update(settings)
137
+ : Promise.resolve();
138
+ applied.then(() => {
139
+ if (this.unmounted) {
140
+ return;
141
+ }
142
+ this.setState({ ready: true, api, error: null });
143
+ // call onReady callback
144
+ if (this.props.onReady) {
145
+ this.props.onReady();
146
+ }
147
+ }, onError);
148
+ };
149
+ const onTokenReady = (token) => {
109
150
  if (this.props.onTokenReady) {
110
151
  this.props.onTokenReady(token);
111
152
  }
112
- });
153
+ };
154
+ // FramePay replays the first error it ever emitted to a listener
155
+ // added later, synchronously, inside on(). A Provider mounting
156
+ // after an earlier wallet or token failure must not hand that
157
+ // old error to the merchant, so the replay is dropped and only
158
+ // errors emitted from now on reach onError.
159
+ let subscribing = true;
160
+ const onLaterError = (error) => {
161
+ if (!subscribing) {
162
+ onError(error);
163
+ }
164
+ };
165
+ this.listeners = {
166
+ ready: onReady,
167
+ error: onLaterError,
168
+ tokenReady: onTokenReady,
169
+ };
170
+ api.on('ready', onReady);
171
+ api.on('error', onLaterError);
172
+ subscribing = false;
173
+ api.on('token-ready', onTokenReady);
174
+ if (!initializedBefore) {
175
+ api.initialize(settings);
176
+ }
113
177
  }
114
178
  catch (e) {
115
179
  return this.setState({
@@ -135,4 +199,4 @@ Provider.defaultProps = {
135
199
  onTokenReady: () => ({}),
136
200
  };
137
201
  exports.default = Provider;
138
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJvdmlkZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvbGliL2NvbXBvbmVudHMvcHJvdmlkZXIudHN4Il0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQSw2Q0FBK0I7QUFDL0Isd0NBQTZDO0FBQzdDLDBDQUEyQztBQUMzQyx1RUFBOEM7QUFDOUMsMkVBQWlEO0FBS2pELE1BQXFCLFFBQVMsU0FBUSxLQUFLLENBQUMsU0FHM0M7SUFIRDs7UUFXYSxVQUFLLEdBQW9CO1lBQzlCLEdBQUcsRUFBRSxJQUFBLDBCQUFjLEdBQUU7WUFDckIsS0FBSyxFQUFFLElBQUk7WUFDWCxLQUFLLEVBQUUsS0FBSztTQUNmLENBQUM7SUFpRk4sQ0FBQztJQS9FRyxpQkFBaUI7UUFDYixJQUFJLElBQUksQ0FBQyxLQUFLLENBQUMsWUFBWSxFQUFFLENBQUM7WUFDMUIsSUFBQSx1QkFBWSxFQUFDO2dCQUNULE9BQU8sRUFBRSxHQUFHLEVBQUUsQ0FBQyxJQUFJLENBQUMsVUFBVSxFQUFFO2dCQUNoQyxPQUFPLEVBQUUsR0FBRyxFQUFFLENBQUMsSUFBSSxDQUFDLFVBQVUsRUFBRTthQUNuQyxDQUFDLENBQUM7UUFDUCxDQUFDO0lBQ0wsQ0FBQztJQUVELFVBQVU7UUFDTixPQUFPLElBQUksQ0FBQyxRQUFRLENBQ2hCO1lBQ0ksS0FBSyxFQUFFLHdCQUFhLENBQUMsS0FBSyxDQUFDLGlCQUFpQjtZQUM1QyxLQUFLLEVBQUUsS0FBSztTQUNmLEVBQ0QsR0FBRyxFQUFFO1lBQ0QsTUFBTSxLQUFLLEdBQUcsSUFBQSx3QkFBYSxFQUFDO2dCQUN4QixJQUFJLEVBQUUsd0JBQWEsQ0FBQyxLQUFLLENBQUMsaUJBQWlCO2FBQzlDLENBQUMsQ0FBQztZQUNILE1BQU0sS0FBSyxDQUFDO1FBQ2hCLENBQUMsQ0FDSixDQUFDO0lBQ04sQ0FBQztJQUVELEtBQUssQ0FBQyxVQUFVO1FBQ1osTUFBTSxHQUFHLEdBQUcsSUFBQSwwQkFBYyxHQUFFLENBQUM7UUFDN0IsSUFBSSxDQUFDO1lBQ0QsNkRBQTZEO1lBQzdELE1BQU0sS0FBNEIsSUFBSSxDQUFDLEtBQUssRUFBdEMsRUFBRSxRQUFRLE9BQTRCLEVBQXZCLFFBQVEsY0FBdkIsWUFBeUIsQ0FBYSxDQUFDO1lBQzdDLEdBQUcsQ0FBQyxVQUFVLENBQUMsUUFBUSxDQUFDLENBQUM7WUFDekIsR0FBRyxDQUFDLEVBQUUsQ0FBQyxPQUFPLEVBQUUsR0FBRyxFQUFFO2dCQUNqQixJQUFJLENBQUMsUUFBUSxDQUFDLEVBQUUsS0FBSyxFQUFFLElBQUksRUFBRSxHQUFHLEVBQUUsS0FBSyxFQUFFLElBQUksRUFBRSxDQUFDLENBQUM7Z0JBRWpELHdCQUF3QjtnQkFDeEIsSUFBSSxJQUFJLENBQUMsS0FBSyxDQUFDLE9BQU8sRUFBRSxDQUFDO29CQUNyQixJQUFJLENBQUMsS0FBSyxDQUFDLE9BQU8sRUFBRSxDQUFDO2dCQUN6QixDQUFDO1lBQ0wsQ0FBQyxDQUFDLENBQUM7WUFDSCxHQUFHLENBQUMsRUFBRSxDQUFDLE9BQU8sRUFBRSxDQUFDLEtBQWEsRUFBRSxFQUFFOztnQkFDOUIsSUFBSSxDQUFDLFFBQVEsQ0FBQztvQkFDVixHQUFHO29CQUNILDhEQUE4RDtvQkFDOUQsS0FBSyxFQUFFLE1BQUMsS0FBYSxhQUFiLEtBQUssdUJBQUwsS0FBSyxDQUFVLElBQUksbUNBQUksQ0FBQztpQkFDbkMsQ0FBQyxDQUFDO2dCQUVILHNCQUFzQjtnQkFDdEIsSUFBSSxJQUFJLENBQUMsS0FBSyxDQUFDLE9BQU8sRUFBRSxDQUFDO29CQUNyQixJQUFJLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxLQUFLLENBQUMsQ0FBQztnQkFDOUIsQ0FBQztZQUNMLENBQUMsQ0FBQyxDQUFDO1lBQ0gsR0FBRyxDQUFDLEVBQUUsQ0FBQyxhQUFhLEVBQUUsQ0FBQyxLQUFnQixFQUFFLEVBQUU7Z0JBQ3ZDLElBQUksSUFBSSxDQUFDLEtBQUssQ0FBQyxZQUFZLEVBQUUsQ0FBQztvQkFDMUIsSUFBSSxDQUFDLEtBQUssQ0FBQyxZQUFZLENBQUMsS0FBSyxDQUFDLENBQUM7Z0JBQ25DLENBQUM7WUFDTCxDQUFDLENBQUMsQ0FBQztRQUNQLENBQUM7UUFBQyxPQUFPLENBQUMsRUFBRSxDQUFDO1lBQ1QsT0FBTyxJQUFJLENBQUMsUUFBUSxDQUNoQjtnQkFDSSxLQUFLLEVBQUUsd0JBQWEsQ0FBQyxLQUFLLENBQUMsZUFBZTtnQkFDMUMsS0FBSyxFQUFFLEtBQUs7YUFDZixFQUNELEdBQUcsRUFBRTtnQkFDRCxNQUFNLElBQUEsd0JBQWEsRUFBQztvQkFDaEIsSUFBSSxFQUFFLHdCQUFhLENBQUMsS0FBSyxDQUFDLGVBQWU7b0JBQ3pDLE9BQU8sRUFBRSxzQkFBc0I7b0JBQy9CLEtBQUssRUFBRSxDQUFDO2lCQUNYLENBQUMsQ0FBQztZQUNQLENBQUMsQ0FDSixDQUFDO1FBQ04sQ0FBQztJQUNMLENBQUM7SUFFRCxNQUFNO1FBQ0YsT0FBTyxDQUNILG9CQUFDLHlCQUFlLElBQUMsS0FBSyxFQUFFLElBQUksQ0FBQyxLQUFLLElBQzdCLElBQUksQ0FBQyxLQUFLLENBQUMsUUFBUSxDQUNOLENBQ3JCLENBQUM7SUFDTixDQUFDOztBQTNGZSxxQkFBWSxHQUFHO0lBQzNCLFlBQVksRUFBRSxJQUFJO0lBQ2xCLE9BQU8sRUFBRSxHQUFHLEVBQUUsQ0FBQyxDQUFDLEVBQUUsQ0FBQztJQUNuQixPQUFPLEVBQUUsR0FBRyxFQUFFLENBQUMsQ0FBQyxFQUFFLENBQUM7SUFDbkIsWUFBWSxFQUFFLEdBQUcsRUFBRSxDQUFDLENBQUMsRUFBRSxDQUFDO0NBQzNCLEFBTDJCLENBSzFCO2tCQVRlLFFBQVEifQ==
202
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJvdmlkZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvbGliL2NvbXBvbmVudHMvcHJvdmlkZXIudHN4Il0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQSw2Q0FBK0I7QUFDL0Isd0NBQTZDO0FBQzdDLDBDQUEyQztBQUMzQyx1RUFBOEM7QUFDOUMsMkVBQWlEO0FBV2pELE1BQXFCLFFBQVMsU0FBUSxLQUFLLENBQUMsU0FHM0M7SUFIRDs7UUFXYSxVQUFLLEdBQW9CO1lBQzlCLEdBQUcsRUFBRSxJQUFBLDBCQUFjLEdBQUU7WUFDckIsS0FBSyxFQUFFLElBQUk7WUFDWCxLQUFLLEVBQUUsS0FBSztTQUNmLENBQUM7UUFFRix5RUFBeUU7UUFDekUsd0VBQXdFO1FBQ3hFLGlFQUFpRTtRQUN6RCxjQUFTLEdBQWMsRUFBRSxDQUFDO1FBRTFCLGNBQVMsR0FBRyxLQUFLLENBQUM7SUE2STlCLENBQUM7SUEzSUcsaUJBQWlCO1FBQ2IsSUFBSSxJQUFJLENBQUMsS0FBSyxDQUFDLFlBQVksRUFBRSxDQUFDO1lBQzFCLElBQUEsdUJBQVksRUFBQztnQkFDVCxPQUFPLEVBQUUsR0FBRyxFQUFFLENBQUMsSUFBSSxDQUFDLFVBQVUsRUFBRTtnQkFDaEMsT0FBTyxFQUFFLEdBQUcsRUFBRSxDQUFDLElBQUksQ0FBQyxVQUFVLEVBQUU7YUFDbkMsQ0FBQyxDQUFDO1FBQ1AsQ0FBQztJQUNMLENBQUM7SUFFRCxvQkFBb0I7UUFDaEIsSUFBSSxDQUFDLFNBQVMsR0FBRyxJQUFJLENBQUM7UUFDdEIsTUFBTSxHQUFHLEdBQUcsSUFBQSwwQkFBYyxHQUFFLENBQUM7UUFDN0IsSUFBSSxDQUFDLEdBQUcsRUFBRSxDQUFDO1lBQ1AsT0FBTztRQUNYLENBQUM7UUFDRCxJQUFJLElBQUksQ0FBQyxTQUFTLENBQUMsS0FBSyxFQUFFLENBQUM7WUFDdkIsR0FBRyxDQUFDLEdBQUcsQ0FBQyxPQUFPLEVBQUUsSUFBSSxDQUFDLFNBQVMsQ0FBQyxLQUFLLENBQUMsQ0FBQztRQUMzQyxDQUFDO1FBQ0QsSUFBSSxJQUFJLENBQUMsU0FBUyxDQUFDLEtBQUssRUFBRSxDQUFDO1lBQ3ZCLEdBQUcsQ0FBQyxHQUFHLENBQUMsT0FBTyxFQUFFLElBQUksQ0FBQyxTQUFTLENBQUMsS0FBSyxDQUFDLENBQUM7UUFDM0MsQ0FBQztRQUNELElBQUksSUFBSSxDQUFDLFNBQVMsQ0FBQyxVQUFVLEVBQUUsQ0FBQztZQUM1QixHQUFHLENBQUMsR0FBRyxDQUFDLGFBQWEsRUFBRSxJQUFJLENBQUMsU0FBUyxDQUFDLFVBQVUsQ0FBQyxDQUFDO1FBQ3RELENBQUM7SUFDTCxDQUFDO0lBRUQsVUFBVTtRQUNOLE9BQU8sSUFBSSxDQUFDLFFBQVEsQ0FDaEI7WUFDSSxLQUFLLEVBQUUsd0JBQWEsQ0FBQyxLQUFLLENBQUMsaUJBQWlCO1lBQzVDLEtBQUssRUFBRSxLQUFLO1NBQ2YsRUFDRCxHQUFHLEVBQUU7WUFDRCxNQUFNLEtBQUssR0FBRyxJQUFBLHdCQUFhLEVBQUM7Z0JBQ3hCLElBQUksRUFBRSx3QkFBYSxDQUFDLEtBQUssQ0FBQyxpQkFBaUI7YUFDOUMsQ0FBQyxDQUFDO1lBQ0gsTUFBTSxLQUFLLENBQUM7UUFDaEIsQ0FBQyxDQUNKLENBQUM7SUFDTixDQUFDO0lBRUQsS0FBSyxDQUFDLFVBQVU7UUFDWixJQUFJLElBQUksQ0FBQyxTQUFTLEVBQUUsQ0FBQztZQUNqQixPQUFPO1FBQ1gsQ0FBQztRQUNELE1BQU0sR0FBRyxHQUFHLElBQUEsMEJBQWMsR0FBRSxDQUFDO1FBQzdCLElBQUksQ0FBQztZQUNELDZEQUE2RDtZQUM3RCxNQUFNLEtBQTRCLElBQUksQ0FBQyxLQUFLLEVBQXRDLEVBQUUsUUFBUSxPQUE0QixFQUF2QixRQUFRLGNBQXZCLFlBQXlCLENBQWEsQ0FBQztZQUM3Qyw0REFBNEQ7WUFDNUQsZ0VBQWdFO1lBQ2hFLCtEQUErRDtZQUMvRCxnRUFBZ0U7WUFDaEUscURBQXFEO1lBQ3JELE1BQU0saUJBQWlCLEdBQUcsR0FBRyxDQUFDLFdBQVcsQ0FBQztZQUMxQyxNQUFNLE9BQU8sR0FBRyxDQUFDLEtBQWEsRUFBRSxFQUFFOztnQkFDOUIsNERBQTREO2dCQUM1RCxJQUFJLElBQUksQ0FBQyxTQUFTLEVBQUUsQ0FBQztvQkFDakIsT0FBTztnQkFDWCxDQUFDO2dCQUNELElBQUksQ0FBQyxRQUFRLENBQUM7b0JBQ1YsR0FBRztvQkFDSCw4REFBOEQ7b0JBQzlELEtBQUssRUFBRSxNQUFDLEtBQWEsYUFBYixLQUFLLHVCQUFMLEtBQUssQ0FBVSxJQUFJLG1DQUFJLENBQUM7aUJBQ25DLENBQUMsQ0FBQztnQkFFSCxzQkFBc0I7Z0JBQ3RCLElBQUksSUFBSSxDQUFDLEtBQUssQ0FBQyxPQUFPLEVBQUUsQ0FBQztvQkFDckIsSUFBSSxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFDLENBQUM7Z0JBQzlCLENBQUM7WUFDTCxDQUFDLENBQUM7WUFDRixNQUFNLE9BQU8sR0FBRyxHQUFHLEVBQUU7Z0JBQ2pCLE1BQU0sT0FBTyxHQUFHLGlCQUFpQjtvQkFDN0IsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxNQUFNLENBQUMsUUFBUSxDQUFDO29CQUN0QixDQUFDLENBQUMsT0FBTyxDQUFDLE9BQU8sRUFBRSxDQUFDO2dCQUN4QixPQUFPLENBQUMsSUFBSSxDQUFDLEdBQUcsRUFBRTtvQkFDZCxJQUFJLElBQUksQ0FBQyxTQUFTLEVBQUUsQ0FBQzt3QkFDakIsT0FBTztvQkFDWCxDQUFDO29CQUNELElBQUksQ0FBQyxRQUFRLENBQUMsRUFBRSxLQUFLLEVBQUUsSUFBSSxFQUFFLEdBQUcsRUFBRSxLQUFLLEVBQUUsSUFBSSxFQUFFLENBQUMsQ0FBQztvQkFFakQsd0JBQXdCO29CQUN4QixJQUFJLElBQUksQ0FBQyxLQUFLLENBQUMsT0FBTyxFQUFFLENBQUM7d0JBQ3JCLElBQUksQ0FBQyxLQUFLLENBQUMsT0FBTyxFQUFFLENBQUM7b0JBQ3pCLENBQUM7Z0JBQ0wsQ0FBQyxFQUFFLE9BQU8sQ0FBQyxDQUFDO1lBQ2hCLENBQUMsQ0FBQztZQUNGLE1BQU0sWUFBWSxHQUFHLENBQUMsS0FBZ0IsRUFBRSxFQUFFO2dCQUN0QyxJQUFJLElBQUksQ0FBQyxLQUFLLENBQUMsWUFBWSxFQUFFLENBQUM7b0JBQzFCLElBQUksQ0FBQyxLQUFLLENBQUMsWUFBWSxDQUFDLEtBQUssQ0FBQyxDQUFDO2dCQUNuQyxDQUFDO1lBQ0wsQ0FBQyxDQUFDO1lBQ0YsaUVBQWlFO1lBQ2pFLCtEQUErRDtZQUMvRCw4REFBOEQ7WUFDOUQsK0RBQStEO1lBQy9ELDRDQUE0QztZQUM1QyxJQUFJLFdBQVcsR0FBRyxJQUFJLENBQUM7WUFDdkIsTUFBTSxZQUFZLEdBQUcsQ0FBQyxLQUFhLEVBQUUsRUFBRTtnQkFDbkMsSUFBSSxDQUFDLFdBQVcsRUFBRSxDQUFDO29CQUNmLE9BQU8sQ0FBQyxLQUFLLENBQUMsQ0FBQztnQkFDbkIsQ0FBQztZQUNMLENBQUMsQ0FBQztZQUNGLElBQUksQ0FBQyxTQUFTLEdBQUc7Z0JBQ2IsS0FBSyxFQUFFLE9BQU87Z0JBQ2QsS0FBSyxFQUFFLFlBQVk7Z0JBQ25CLFVBQVUsRUFBRSxZQUFZO2FBQzNCLENBQUM7WUFDRixHQUFHLENBQUMsRUFBRSxDQUFDLE9BQU8sRUFBRSxPQUFPLENBQUMsQ0FBQztZQUN6QixHQUFHLENBQUMsRUFBRSxDQUFDLE9BQU8sRUFBRSxZQUFZLENBQUMsQ0FBQztZQUM5QixXQUFXLEdBQUcsS0FBSyxDQUFDO1lBQ3BCLEdBQUcsQ0FBQyxFQUFFLENBQUMsYUFBYSxFQUFFLFlBQVksQ0FBQyxDQUFDO1lBQ3BDLElBQUksQ0FBQyxpQkFBaUIsRUFBRSxDQUFDO2dCQUNyQixHQUFHLENBQUMsVUFBVSxDQUFDLFFBQVEsQ0FBQyxDQUFDO1lBQzdCLENBQUM7UUFDTCxDQUFDO1FBQUMsT0FBTyxDQUFDLEVBQUUsQ0FBQztZQUNULE9BQU8sSUFBSSxDQUFDLFFBQVEsQ0FDaEI7Z0JBQ0ksS0FBSyxFQUFFLHdCQUFhLENBQUMsS0FBSyxDQUFDLGVBQWU7Z0JBQzFDLEtBQUssRUFBRSxLQUFLO2FBQ2YsRUFDRCxHQUFHLEVBQUU7Z0JBQ0QsTUFBTSxJQUFBLHdCQUFhLEVBQUM7b0JBQ2hCLElBQUksRUFBRSx3QkFBYSxDQUFDLEtBQUssQ0FBQyxlQUFlO29CQUN6QyxPQUFPLEVBQUUsc0JBQXNCO29CQUMvQixLQUFLLEVBQUUsQ0FBQztpQkFDWCxDQUFDLENBQUM7WUFDUCxDQUFDLENBQ0osQ0FBQztRQUNOLENBQUM7SUFDTCxDQUFDO0lBRUQsTUFBTTtRQUNGLE9BQU8sQ0FDSCxvQkFBQyx5QkFBZSxJQUFDLEtBQUssRUFBRSxJQUFJLENBQUMsS0FBSyxJQUM3QixJQUFJLENBQUMsS0FBSyxDQUFDLFFBQVEsQ0FDTixDQUNyQixDQUFDO0lBQ04sQ0FBQzs7QUE5SmUscUJBQVksR0FBRztJQUMzQixZQUFZLEVBQUUsSUFBSTtJQUNsQixPQUFPLEVBQUUsR0FBRyxFQUFFLENBQUMsQ0FBQyxFQUFFLENBQUM7SUFDbkIsT0FBTyxFQUFFLEdBQUcsRUFBRSxDQUFDLENBQUMsRUFBRSxDQUFDO0lBQ25CLFlBQVksRUFBRSxHQUFHLEVBQUUsQ0FBQyxDQUFDLEVBQUUsQ0FBQztDQUMzQixBQUwyQixDQUsxQjtrQkFUZSxRQUFRIn0=
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rebilly/framepay-react",
3
- "version": "14.28.0",
3
+ "version": "14.29.0",
4
4
  "description": "A React wrapper for Rebilly's FramePay offering out-of-the-box support for Redux and other common React features",
5
5
  "main": "build/index.js",
6
6
  "author": "Rebilly",
@@ -1,4 +1,4 @@
1
- import { render } from '@testing-library/react';
1
+ import { act, render } from '@testing-library/react';
2
2
  import * as React from 'react';
3
3
  import Provider from './provider';
4
4
 
@@ -53,3 +53,204 @@ describe('Provider', () => {
53
53
  `);
54
54
  });
55
55
  });
56
+
57
+ describe('Provider on a page where framepay.js is loaded', () => {
58
+ interface Api {
59
+ initialized: boolean;
60
+ initialize: jest.Mock;
61
+ update: jest.Mock;
62
+ on: jest.Mock;
63
+ off: jest.Mock;
64
+ }
65
+
66
+ const page = window as unknown as { Framepay?: Api };
67
+ const publishableKey = 'pk_sandbox_1234567890';
68
+ // The loader resolves the page's FramePay in a task, and the Provider
69
+ // settles its listeners in the microtasks after it.
70
+ const flush = () =>
71
+ act(() => new Promise((resolve) => setTimeout(resolve, 0)));
72
+ let api: Api;
73
+
74
+ beforeEach(() => {
75
+ api = {
76
+ initialized: false,
77
+ initialize: jest.fn(() => Promise.resolve()),
78
+ update: jest.fn(() => Promise.resolve()),
79
+ on: jest.fn(),
80
+ off: jest.fn(),
81
+ };
82
+ page.Framepay = api;
83
+ });
84
+
85
+ afterEach(() => {
86
+ delete page.Framepay;
87
+ });
88
+
89
+ it('initializes FramePay on its first mount', async () => {
90
+ render(<Provider publishableKey={publishableKey} />);
91
+ await flush();
92
+
93
+ expect(api.initialize).toHaveBeenCalledWith(
94
+ expect.objectContaining({ publishableKey }),
95
+ );
96
+ expect(api.update).not.toHaveBeenCalled();
97
+ });
98
+
99
+ it('gives an initialized FramePay its settings instead of initializing again', async () => {
100
+ api.initialized = true;
101
+ // FramePay replays ready to a listener added after the frames came up.
102
+ api.on.mockImplementation((event: string, handler: () => void) => {
103
+ if (event === 'ready') {
104
+ handler();
105
+ }
106
+ });
107
+ const onReady = jest.fn();
108
+ const transactionData = { amount: 5, currency: 'USD', label: 'Plan' };
109
+
110
+ render(
111
+ <Provider
112
+ publishableKey={publishableKey}
113
+ transactionData={transactionData}
114
+ onReady={onReady}
115
+ />,
116
+ );
117
+ await flush();
118
+
119
+ expect(api.initialize).not.toHaveBeenCalled();
120
+ expect(api.update).toHaveBeenCalledWith(
121
+ expect.objectContaining({ transactionData }),
122
+ );
123
+ expect(onReady).toHaveBeenCalledTimes(1);
124
+ });
125
+
126
+ it('reports settings FramePay rejects through onError', async () => {
127
+ api.initialized = true;
128
+ api.on.mockImplementation((event: string, handler: () => void) => {
129
+ if (event === 'ready') {
130
+ handler();
131
+ }
132
+ });
133
+ const rejection = { code: 'invalid-methods-configuration' };
134
+ api.update.mockImplementation(() => Promise.reject(rejection));
135
+ const onReady = jest.fn();
136
+ const onError = jest.fn();
137
+
138
+ render(
139
+ <Provider
140
+ publishableKey={publishableKey}
141
+ onReady={onReady}
142
+ onError={onError}
143
+ />,
144
+ );
145
+ await flush();
146
+
147
+ expect(onError).toHaveBeenCalledWith(rejection);
148
+ expect(onReady).not.toHaveBeenCalled();
149
+ });
150
+
151
+ it('removes its listeners from FramePay when it unmounts', async () => {
152
+ const { unmount } = render(
153
+ <Provider publishableKey={publishableKey} />,
154
+ );
155
+ await flush();
156
+ expect(api.on).toHaveBeenCalledTimes(3);
157
+
158
+ unmount();
159
+
160
+ api.on.mock.calls.forEach(([event, handler]) => {
161
+ expect(api.off).toHaveBeenCalledWith(event, handler);
162
+ });
163
+ expect(api.off).toHaveBeenCalledTimes(3);
164
+ });
165
+
166
+ it('stays quiet when it unmounts while its settings are applied', async () => {
167
+ api.initialized = true;
168
+ api.on.mockImplementation((event: string, handler: () => void) => {
169
+ if (event === 'ready') {
170
+ handler();
171
+ }
172
+ });
173
+ let settle: { resolve: () => void; reject: (error: object) => void };
174
+ api.update.mockImplementation(
175
+ () =>
176
+ new Promise<void>((resolve, reject) => {
177
+ settle = { resolve, reject };
178
+ }),
179
+ );
180
+ const onReady = jest.fn();
181
+ const onError = jest.fn();
182
+
183
+ const { unmount } = render(
184
+ <Provider
185
+ publishableKey={publishableKey}
186
+ onReady={onReady}
187
+ onError={onError}
188
+ />,
189
+ );
190
+ await flush();
191
+ unmount();
192
+ settle.resolve();
193
+ await flush();
194
+
195
+ expect(onReady).not.toHaveBeenCalled();
196
+
197
+ api.update.mockImplementation(
198
+ () =>
199
+ new Promise<void>((resolve, reject) => {
200
+ settle = { resolve, reject };
201
+ }),
202
+ );
203
+ const second = render(
204
+ <Provider
205
+ publishableKey={publishableKey}
206
+ onReady={onReady}
207
+ onError={onError}
208
+ />,
209
+ );
210
+ await flush();
211
+ second.unmount();
212
+ settle.reject({ code: 'invalid-methods-configuration' });
213
+ await flush();
214
+
215
+ expect(onError).not.toHaveBeenCalled();
216
+ });
217
+
218
+ it('ignores the error FramePay replays from before it mounted', async () => {
219
+ api.initialized = true;
220
+ const stale = { code: 'apple-pay-error' };
221
+ let errorListener: (error: object) => void;
222
+ api.on.mockImplementation(
223
+ (event: string, handler: (error?: object) => void) => {
224
+ if (event === 'ready') {
225
+ handler();
226
+ }
227
+ if (event === 'error') {
228
+ errorListener = handler;
229
+ // FramePay replays the first cached error inside on().
230
+ handler(stale);
231
+ }
232
+ },
233
+ );
234
+ const onError = jest.fn();
235
+ const onReady = jest.fn();
236
+
237
+ render(
238
+ <Provider
239
+ publishableKey={publishableKey}
240
+ onReady={onReady}
241
+ onError={onError}
242
+ />,
243
+ );
244
+ await flush();
245
+
246
+ expect(onError).not.toHaveBeenCalled();
247
+ expect(onReady).toHaveBeenCalledTimes(1);
248
+
249
+ const later = { code: 'google-pay-error' };
250
+ await act(async () => {
251
+ errorListener(later);
252
+ });
253
+ expect(onError).toHaveBeenCalledWith(later);
254
+ expect(onError).not.toHaveBeenCalledWith(stale);
255
+ });
256
+ });
@@ -7,6 +7,12 @@ import type { ProviderProps } from '../../../types/provider';
7
7
  import type { FramePayContext } from '../../../types/context';
8
8
  import type { TokenData } from '@rebilly/framepay';
9
9
 
10
+ interface Listeners {
11
+ ready?: () => void;
12
+ error?: (error: object) => void;
13
+ tokenReady?: (token: TokenData) => void;
14
+ }
15
+
10
16
  export default class Provider extends React.Component<
11
17
  ProviderProps,
12
18
  FramePayContext
@@ -24,6 +30,13 @@ export default class Provider extends React.Component<
24
30
  ready: false,
25
31
  };
26
32
 
33
+ // The listeners this Provider added to the page's FramePay, removed when
34
+ // it unmounts. FramePay keeps one instance per page, so a Provider that
35
+ // mounts again must not leave the earlier one's callbacks on it.
36
+ private listeners: Listeners = {};
37
+
38
+ private unmounted = false;
39
+
27
40
  componentDidMount() {
28
41
  if (this.props.injectScript) {
29
42
  injectScript({
@@ -33,6 +46,23 @@ export default class Provider extends React.Component<
33
46
  }
34
47
  }
35
48
 
49
+ componentWillUnmount() {
50
+ this.unmounted = true;
51
+ const api = getFramepayApi();
52
+ if (!api) {
53
+ return;
54
+ }
55
+ if (this.listeners.ready) {
56
+ api.off('ready', this.listeners.ready);
57
+ }
58
+ if (this.listeners.error) {
59
+ api.off('error', this.listeners.error);
60
+ }
61
+ if (this.listeners.tokenReady) {
62
+ api.off('token-ready', this.listeners.tokenReady);
63
+ }
64
+ }
65
+
36
66
  onApiError() {
37
67
  return this.setState(
38
68
  {
@@ -49,20 +79,24 @@ export default class Provider extends React.Component<
49
79
  }
50
80
 
51
81
  async onApiReady() {
82
+ if (this.unmounted) {
83
+ return;
84
+ }
52
85
  const api = getFramepayApi();
53
86
  try {
54
87
  // eslint-disable-next-line @typescript-eslint/no-unused-vars
55
88
  const { children, ...settings } = this.props;
56
- api.initialize(settings);
57
- api.on('ready', () => {
58
- this.setState({ ready: true, api, error: null });
59
-
60
- // call onReady callback
61
- if (this.props.onReady) {
62
- this.props.onReady();
89
+ // FramePay keeps one instance per page and rejects a second
90
+ // initialize() with already-initialized. A Provider that mounts
91
+ // after another one did, on a route change, a remount or under
92
+ // React StrictMode, gives the running instance its own settings
93
+ // once that instance is ready, as framepay-vue does.
94
+ const initializedBefore = api.initialized;
95
+ const onError = (error: object) => {
96
+ // A rejected update can land after this Provider unmounted.
97
+ if (this.unmounted) {
98
+ return;
63
99
  }
64
- });
65
- api.on('error', (error: object) => {
66
100
  this.setState({
67
101
  api,
68
102
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -73,12 +107,51 @@ export default class Provider extends React.Component<
73
107
  if (this.props.onError) {
74
108
  this.props.onError(error);
75
109
  }
76
- });
77
- api.on('token-ready', (token: TokenData) => {
110
+ };
111
+ const onReady = () => {
112
+ const applied = initializedBefore
113
+ ? api.update(settings)
114
+ : Promise.resolve();
115
+ applied.then(() => {
116
+ if (this.unmounted) {
117
+ return;
118
+ }
119
+ this.setState({ ready: true, api, error: null });
120
+
121
+ // call onReady callback
122
+ if (this.props.onReady) {
123
+ this.props.onReady();
124
+ }
125
+ }, onError);
126
+ };
127
+ const onTokenReady = (token: TokenData) => {
78
128
  if (this.props.onTokenReady) {
79
129
  this.props.onTokenReady(token);
80
130
  }
81
- });
131
+ };
132
+ // FramePay replays the first error it ever emitted to a listener
133
+ // added later, synchronously, inside on(). A Provider mounting
134
+ // after an earlier wallet or token failure must not hand that
135
+ // old error to the merchant, so the replay is dropped and only
136
+ // errors emitted from now on reach onError.
137
+ let subscribing = true;
138
+ const onLaterError = (error: object) => {
139
+ if (!subscribing) {
140
+ onError(error);
141
+ }
142
+ };
143
+ this.listeners = {
144
+ ready: onReady,
145
+ error: onLaterError,
146
+ tokenReady: onTokenReady,
147
+ };
148
+ api.on('ready', onReady);
149
+ api.on('error', onLaterError);
150
+ subscribing = false;
151
+ api.on('token-ready', onTokenReady);
152
+ if (!initializedBefore) {
153
+ api.initialize(settings);
154
+ }
82
155
  } catch (e) {
83
156
  return this.setState(
84
157
  {