@baukit/purchases-core 0.18.1 → 0.18.3
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/dist/react.d.ts +5 -1
- package/dist/react.d.ts.map +1 -1
- package/dist/react.js +7 -3
- package/dist/react.js.map +1 -1
- package/package.json +1 -1
- package/src/organization.test.ts +20 -1
- package/src/react.ts +11 -3
package/dist/react.d.ts
CHANGED
|
@@ -19,8 +19,12 @@ export interface FeatureOptions {
|
|
|
19
19
|
}
|
|
20
20
|
/** Access to a feature key from the backend-verified entitlement. See `featureAccess`. */
|
|
21
21
|
export declare function useFeature(key: string, options?: FeatureOptions): FeatureAccess;
|
|
22
|
+
/** An organization's plan state with `retry`, which reads the plan again. */
|
|
23
|
+
export type OrganizationPlan = OrganizationPlanState & {
|
|
24
|
+
readonly retry: () => void;
|
|
25
|
+
};
|
|
22
26
|
/** Loads the plan of the organization the account acts for. */
|
|
23
|
-
export declare function useOrganizationPlan(backend: Pick<EntitlementBackend, 'organizationEntitlement'>, organizationId: string):
|
|
27
|
+
export declare function useOrganizationPlan(backend: Pick<EntitlementBackend, 'organizationEntitlement'>, organizationId: string): OrganizationPlan;
|
|
24
28
|
export interface LockedFeatureProps {
|
|
25
29
|
readonly feature: string;
|
|
26
30
|
readonly children?: ReactNode;
|
package/dist/react.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"react.d.ts","sourceRoot":"","sources":["../src/react.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"react.d.ts","sourceRoot":"","sources":["../src/react.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAEvC,OAAO,EAGL,KAAK,aAAa,EAClB,KAAK,qBAAqB,EAC3B,MAAM,aAAa,CAAC;AAErB,OAAO,KAAK,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAChF,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC7D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAS5C,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,0DAA0D;IAC1D,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC;CAC/B;AAED,wBAAgB,iBAAiB,CAAC,EAChC,IAAI,EACJ,SAAS,EACT,QAAQ,GACT,EAAE,sBAAsB,GAAG,SAAS,CAEpC;AAQD,wBAAgB,eAAe,IAAI,YAAY,CAE9C;AAED,wBAAgB,gBAAgB,IAAI,aAAa,CAGhD;AAED,wBAAgB,cAAc,IAAI,mBAAmB,GAAG,IAAI,CAE3D;AAED,MAAM,WAAW,cAAc;IAC7B,yFAAyF;IACzF,QAAQ,CAAC,YAAY,CAAC,EAAE,qBAAqB,CAAC;CAC/C;AAED,0FAA0F;AAC1F,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,cAAmB,GAAG,aAAa,CAMnF;AAQD,6EAA6E;AAC7E,MAAM,MAAM,gBAAgB,GAAG,qBAAqB,GAAG;IAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,IAAI,CAAA;CAAE,CAAC;AAEtF,+DAA+D;AAC/D,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,IAAI,CAAC,kBAAkB,EAAE,yBAAyB,CAAC,EAC5D,cAAc,EAAE,MAAM,GACrB,gBAAgB,CA0BlB;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC;IAC9B,+EAA+E;IAC/E,QAAQ,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,SAAS,CAAC;IACjD,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC;IAC7B,8EAA8E;IAC9E,QAAQ,CAAC,WAAW,CAAC,EAAE,SAAS,CAAC;IACjC,QAAQ,CAAC,YAAY,CAAC,EAAE,qBAAqB,CAAC;CAC/C;AAED,+EAA+E;AAC/E,wBAAgB,aAAa,CAAC,KAAK,EAAE,kBAAkB,GAAG,SAAS,CAelE"}
|
package/dist/react.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { createContext, createElement, Fragment, useContext, useEffect, useState, useSyncExternalStore, } from 'react';
|
|
1
|
+
import { createContext, createElement, Fragment, useCallback, useContext, useEffect, useState, useSyncExternalStore, } from 'react';
|
|
2
2
|
import { featureAccess, organizationFeatureAccess, } from './access.js';
|
|
3
3
|
import { AccountPlanError } from './account-plan.js';
|
|
4
4
|
const PurchaseFlowContext = createContext(null);
|
|
@@ -37,6 +37,10 @@ function organizationFailure(error) {
|
|
|
37
37
|
/** Loads the plan of the organization the account acts for. */
|
|
38
38
|
export function useOrganizationPlan(backend, organizationId) {
|
|
39
39
|
const [state, setState] = useState({ status: 'loading' });
|
|
40
|
+
const [attempt, setAttempt] = useState(0);
|
|
41
|
+
const retry = useCallback(() => {
|
|
42
|
+
setAttempt((previous) => previous + 1);
|
|
43
|
+
}, []);
|
|
40
44
|
useEffect(() => {
|
|
41
45
|
let active = true;
|
|
42
46
|
setState({ status: 'loading' });
|
|
@@ -51,8 +55,8 @@ export function useOrganizationPlan(backend, organizationId) {
|
|
|
51
55
|
return () => {
|
|
52
56
|
active = false;
|
|
53
57
|
};
|
|
54
|
-
}, [backend, organizationId]);
|
|
55
|
-
return state;
|
|
58
|
+
}, [backend, organizationId, attempt]);
|
|
59
|
+
return { ...state, retry };
|
|
56
60
|
}
|
|
57
61
|
/** Renders `children` only while the verified entitlement grants `feature`. */
|
|
58
62
|
export function LockedFeature(props) {
|
package/dist/react.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"react.js","sourceRoot":"","sources":["../src/react.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,aAAa,EACb,QAAQ,EACR,UAAU,EACV,SAAS,EACT,QAAQ,EACR,oBAAoB,GACrB,MAAM,OAAO,CAAC;AAGf,OAAO,EACL,aAAa,EACb,yBAAyB,GAG1B,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAUrD,MAAM,mBAAmB,GAAG,aAAa,CAA0B,IAAI,CAAC,CAAC;AASzE,MAAM,UAAU,iBAAiB,CAAC,EAChC,IAAI,EACJ,SAAS,EACT,QAAQ,GACe;IACvB,OAAO,aAAa,CAAC,mBAAmB,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC;AAC/F,CAAC;AAED,SAAS,mBAAmB;IAC1B,MAAM,OAAO,GAAG,UAAU,CAAC,mBAAmB,CAAC,CAAC;IAChD,IAAI,OAAO,KAAK,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;IACtF,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,UAAU,eAAe;IAC7B,OAAO,mBAAmB,EAAE,CAAC,IAAI,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,gBAAgB;IAC9B,MAAM,IAAI,GAAG,eAAe,EAAE,CAAC;IAC/B,OAAO,oBAAoB,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;AAC5E,CAAC;AAED,MAAM,UAAU,cAAc;IAC5B,OAAO,gBAAgB,EAAE,CAAC,WAAW,CAAC;AACxC,CAAC;AAOD,0FAA0F;AAC1F,MAAM,UAAU,UAAU,CAAC,GAAW,EAAE,UAA0B,EAAE;IAClE,MAAM,EAAE,SAAS,EAAE,GAAG,mBAAmB,EAAE,CAAC;IAC5C,MAAM,KAAK,GAAG,gBAAgB,EAAE,CAAC;IACjC,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS;QACpC,OAAO,yBAAyB,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7E,OAAO,aAAa,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;AAClD,CAAC;AAED,SAAS,mBAAmB,CAAC,KAAc;IACzC,IAAI,KAAK,YAAY,gBAAgB,IAAI,KAAK,CAAC,IAAI,KAAK,6BAA6B;QACnF,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC;IACtC,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC;AACnC,CAAC;
|
|
1
|
+
{"version":3,"file":"react.js","sourceRoot":"","sources":["../src/react.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,aAAa,EACb,QAAQ,EACR,WAAW,EACX,UAAU,EACV,SAAS,EACT,QAAQ,EACR,oBAAoB,GACrB,MAAM,OAAO,CAAC;AAGf,OAAO,EACL,aAAa,EACb,yBAAyB,GAG1B,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAUrD,MAAM,mBAAmB,GAAG,aAAa,CAA0B,IAAI,CAAC,CAAC;AASzE,MAAM,UAAU,iBAAiB,CAAC,EAChC,IAAI,EACJ,SAAS,EACT,QAAQ,GACe;IACvB,OAAO,aAAa,CAAC,mBAAmB,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC;AAC/F,CAAC;AAED,SAAS,mBAAmB;IAC1B,MAAM,OAAO,GAAG,UAAU,CAAC,mBAAmB,CAAC,CAAC;IAChD,IAAI,OAAO,KAAK,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;IACtF,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,UAAU,eAAe;IAC7B,OAAO,mBAAmB,EAAE,CAAC,IAAI,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,gBAAgB;IAC9B,MAAM,IAAI,GAAG,eAAe,EAAE,CAAC;IAC/B,OAAO,oBAAoB,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;AAC5E,CAAC;AAED,MAAM,UAAU,cAAc;IAC5B,OAAO,gBAAgB,EAAE,CAAC,WAAW,CAAC;AACxC,CAAC;AAOD,0FAA0F;AAC1F,MAAM,UAAU,UAAU,CAAC,GAAW,EAAE,UAA0B,EAAE;IAClE,MAAM,EAAE,SAAS,EAAE,GAAG,mBAAmB,EAAE,CAAC;IAC5C,MAAM,KAAK,GAAG,gBAAgB,EAAE,CAAC;IACjC,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS;QACpC,OAAO,yBAAyB,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7E,OAAO,aAAa,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;AAClD,CAAC;AAED,SAAS,mBAAmB,CAAC,KAAc;IACzC,IAAI,KAAK,YAAY,gBAAgB,IAAI,KAAK,CAAC,IAAI,KAAK,6BAA6B;QACnF,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC;IACtC,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC;AACnC,CAAC;AAKD,+DAA+D;AAC/D,MAAM,UAAU,mBAAmB,CACjC,OAA4D,EAC5D,cAAsB;IAEtB,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAwB,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IACjF,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC1C,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE;QAC7B,UAAU,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC;IACzC,CAAC,EAAE,EAAE,CAAC,CAAC;IACP,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,MAAM,GAAG,IAAI,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;QAChC,MAAM,IAAI,GAAG,OAAO,CAAC,uBAAuB,EAAE,CAAC,cAAc,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACxF,IAAI,CAAC,IAAI,CACP,CAAC,WAAW,EAAE,EAAE;YACd,IAAI,MAAM;gBACR,QAAQ,CACN,WAAW,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,CACvF,CAAC;QACN,CAAC,EACD,CAAC,KAAc,EAAE,EAAE;YACjB,IAAI,MAAM;gBAAE,QAAQ,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC;QACnD,CAAC,CACF,CAAC;QACF,OAAO,GAAG,EAAE;YACV,MAAM,GAAG,KAAK,CAAC;QACjB,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,OAAO,EAAE,cAAc,EAAE,OAAO,CAAC,CAAC,CAAC;IACvC,OAAO,EAAE,GAAG,KAAK,EAAE,KAAK,EAAE,CAAC;AAC7B,CAAC;AAaD,+EAA+E;AAC/E,MAAM,UAAU,aAAa,CAAC,KAAyB;IACrD,MAAM,MAAM,GAAG,UAAU,CACvB,KAAK,CAAC,OAAO,EACb,KAAK,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,KAAK,CAAC,YAAY,EAAE,CAC7E,CAAC;IACF,QAAQ,MAAM,CAAC,MAAM,EAAE,CAAC;QACtB,KAAK,SAAS;YACZ,OAAO,aAAa,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;QACvD,KAAK,QAAQ;YACX,OAAO,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACtC,KAAK,SAAS;YACZ,OAAO,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC;QAC/B,KAAK,aAAa;YAChB,OAAO,KAAK,CAAC,WAAW,IAAI,IAAI,CAAC;IACrC,CAAC;AACH,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@baukit/purchases-core",
|
|
3
|
-
"version": "0.18.
|
|
3
|
+
"version": "0.18.3",
|
|
4
4
|
"description": "Store-neutral mobile purchases: a purchases port, a no-op client, a purchase flow that waits for suite identity and the refreshed entitlement, and feature-key gating hooks.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Patrick Koss",
|
package/src/organization.test.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
// @vitest-environment jsdom
|
|
2
|
-
import { cleanup, renderHook, waitFor } from '@testing-library/react';
|
|
2
|
+
import { act, cleanup, renderHook, waitFor } from '@testing-library/react';
|
|
3
3
|
import { createElement, type ReactNode } from 'react';
|
|
4
4
|
import { afterEach, describe, expect, it, vi } from 'vitest';
|
|
5
5
|
|
|
@@ -211,4 +211,23 @@ describe('useFeature with an organization plan', () => {
|
|
|
211
211
|
expect(view.result.current).toEqual({ status: 'unavailable' });
|
|
212
212
|
});
|
|
213
213
|
});
|
|
214
|
+
|
|
215
|
+
it('reads the plan again on retry after the hub was unavailable', async () => {
|
|
216
|
+
const organizationEntitlement = vi
|
|
217
|
+
.fn<(id: string) => Promise<VerifiedEntitlement | null>>()
|
|
218
|
+
.mockRejectedValueOnce(new AccountPlanError(503, 'entitlements_unavailable', 5))
|
|
219
|
+
.mockResolvedValueOnce(studio);
|
|
220
|
+
const backend = { organizationEntitlement };
|
|
221
|
+
const view = renderHook(() => useOrganizationPlan(backend, STUDIO));
|
|
222
|
+
await waitFor(() => {
|
|
223
|
+
expect(view.result.current.status).toBe('unavailable');
|
|
224
|
+
});
|
|
225
|
+
act(() => {
|
|
226
|
+
view.result.current.retry();
|
|
227
|
+
});
|
|
228
|
+
await waitFor(() => {
|
|
229
|
+
expect(view.result.current).toMatchObject({ status: 'ready', entitlement: studio });
|
|
230
|
+
});
|
|
231
|
+
expect(organizationEntitlement).toHaveBeenCalledTimes(2);
|
|
232
|
+
});
|
|
214
233
|
});
|
package/src/react.ts
CHANGED
|
@@ -2,6 +2,7 @@ import {
|
|
|
2
2
|
createContext,
|
|
3
3
|
createElement,
|
|
4
4
|
Fragment,
|
|
5
|
+
useCallback,
|
|
5
6
|
useContext,
|
|
6
7
|
useEffect,
|
|
7
8
|
useState,
|
|
@@ -81,12 +82,19 @@ function organizationFailure(error: unknown): OrganizationPlanState {
|
|
|
81
82
|
return { status: 'unavailable' };
|
|
82
83
|
}
|
|
83
84
|
|
|
85
|
+
/** An organization's plan state with `retry`, which reads the plan again. */
|
|
86
|
+
export type OrganizationPlan = OrganizationPlanState & { readonly retry: () => void };
|
|
87
|
+
|
|
84
88
|
/** Loads the plan of the organization the account acts for. */
|
|
85
89
|
export function useOrganizationPlan(
|
|
86
90
|
backend: Pick<EntitlementBackend, 'organizationEntitlement'>,
|
|
87
91
|
organizationId: string,
|
|
88
|
-
):
|
|
92
|
+
): OrganizationPlan {
|
|
89
93
|
const [state, setState] = useState<OrganizationPlanState>({ status: 'loading' });
|
|
94
|
+
const [attempt, setAttempt] = useState(0);
|
|
95
|
+
const retry = useCallback(() => {
|
|
96
|
+
setAttempt((previous) => previous + 1);
|
|
97
|
+
}, []);
|
|
90
98
|
useEffect(() => {
|
|
91
99
|
let active = true;
|
|
92
100
|
setState({ status: 'loading' });
|
|
@@ -105,8 +113,8 @@ export function useOrganizationPlan(
|
|
|
105
113
|
return () => {
|
|
106
114
|
active = false;
|
|
107
115
|
};
|
|
108
|
-
}, [backend, organizationId]);
|
|
109
|
-
return state;
|
|
116
|
+
}, [backend, organizationId, attempt]);
|
|
117
|
+
return { ...state, retry };
|
|
110
118
|
}
|
|
111
119
|
|
|
112
120
|
export interface LockedFeatureProps {
|