@stamprally/react 0.16.0 → 0.17.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/README.md +2 -2
- package/dist/index.cjs +27 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +14 -3
- package/dist/index.d.ts +14 -3
- package/dist/index.js +27 -1
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @stamprally/react v0.
|
|
1
|
+
# @stamprally/react v0.17.0
|
|
2
2
|
|
|
3
3
|
React integration for `@stamprally/core`. `useStampRally` subscribes to immutable client state and exposes check-in, reward-claim, synchronization, and user-switching operations.
|
|
4
4
|
|
|
@@ -9,7 +9,7 @@ import { useStampRally } from "@stamprally/react";
|
|
|
9
9
|
|
|
10
10
|
const config: PublicRallyConfig = {
|
|
11
11
|
id: "city-tour",
|
|
12
|
-
version: "0.
|
|
12
|
+
version: "0.17.0",
|
|
13
13
|
title: "City Tour",
|
|
14
14
|
spots: [{ id: "station", orderIndex: 0, name: "Station", conditions: [{ type: "passcode" }] }],
|
|
15
15
|
rewards: [],
|
package/dist/index.cjs
CHANGED
|
@@ -13,6 +13,15 @@ function useStampRally(client, options = {}) {
|
|
|
13
13
|
const subscribe = react.useCallback((listener) => client.subscribe(listener), [client]);
|
|
14
14
|
const getSnapshot = react.useCallback(() => client.getState(), [client]);
|
|
15
15
|
const state = react.useSyncExternalStore(subscribe, getSnapshot, serverSnapshot);
|
|
16
|
+
const syncSubscribe = react.useCallback(
|
|
17
|
+
(listener) => client.subscribeSyncState(listener),
|
|
18
|
+
[client]
|
|
19
|
+
);
|
|
20
|
+
react.useSyncExternalStore(
|
|
21
|
+
syncSubscribe,
|
|
22
|
+
() => client.getSyncRevision(),
|
|
23
|
+
() => 0
|
|
24
|
+
);
|
|
16
25
|
const [error, setError] = react.useState(null);
|
|
17
26
|
react.useEffect(() => {
|
|
18
27
|
if (options.initialize === false || client.getState() !== null) return;
|
|
@@ -29,6 +38,10 @@ function useStampRally(client, options = {}) {
|
|
|
29
38
|
if (event.type === "error") setError(errorFrom(event.error));
|
|
30
39
|
});
|
|
31
40
|
}, [client]);
|
|
41
|
+
react.useEffect(() => {
|
|
42
|
+
if (options.onSyncEvent === void 0) return;
|
|
43
|
+
return client.subscribeSyncEvents(options.onSyncEvent);
|
|
44
|
+
}, [client, options.onSyncEvent]);
|
|
32
45
|
const onCheckIn = react.useCallback(
|
|
33
46
|
(spotId, proof, checkInOptions = {}) => {
|
|
34
47
|
setError(null);
|
|
@@ -57,6 +70,10 @@ function useStampRally(client, options = {}) {
|
|
|
57
70
|
throw next;
|
|
58
71
|
});
|
|
59
72
|
}, [client]);
|
|
73
|
+
const onSyncEvent = react.useCallback(
|
|
74
|
+
(listener) => client.subscribeSyncEvents(listener),
|
|
75
|
+
[client]
|
|
76
|
+
);
|
|
60
77
|
return {
|
|
61
78
|
state,
|
|
62
79
|
config: client.getConfig(),
|
|
@@ -66,12 +83,21 @@ function useStampRally(client, options = {}) {
|
|
|
66
83
|
onClaimReward,
|
|
67
84
|
onSync,
|
|
68
85
|
retrySync: onSync,
|
|
69
|
-
syncState:
|
|
86
|
+
syncState: {
|
|
87
|
+
isSyncing: client.syncState === "syncing",
|
|
88
|
+
pendingCount: client.pendingCount,
|
|
89
|
+
rejectedHistory: client.rejectedHistory
|
|
90
|
+
},
|
|
91
|
+
syncStatus: client.syncState,
|
|
92
|
+
isSyncing: client.syncState === "syncing",
|
|
70
93
|
pendingCount: client.pendingCount,
|
|
71
94
|
queueCapability: client.queueCapability,
|
|
72
95
|
rejectedHistory: client.rejectedHistory,
|
|
73
96
|
discardRejected: client.discardRejected.bind(client),
|
|
74
97
|
retryRejected: client.retryRejected.bind(client),
|
|
98
|
+
retryOperation: client.retryOperation.bind(client),
|
|
99
|
+
dismissRejectedOperation: client.dismissRejectedOperation.bind(client),
|
|
100
|
+
onSyncEvent,
|
|
75
101
|
anonymousSessionId: client.getAnonymousSessionId(),
|
|
76
102
|
switchUser: client.switchUser.bind(client),
|
|
77
103
|
clearUserState: client.clearUserState.bind(client)
|
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/useStampRally.ts"],"names":["useCallback","useSyncExternalStore","useState","useEffect"],"mappings":";;;;
|
|
1
|
+
{"version":3,"sources":["../src/useStampRally.ts"],"names":["useCallback","useSyncExternalStore","useState","useEffect"],"mappings":";;;;AAmDA,SAAS,cAAA,GAAuB;AAC9B,EAAA,OAAO,IAAA;AACT;AACA,SAAS,UAAU,KAAA,EAAuB;AACxC,EAAA,OAAO,iBAAiB,KAAA,GAAQ,KAAA,GAAQ,IAAI,KAAA,CAAM,MAAA,CAAO,KAAK,CAAC,CAAA;AACjE;AACO,SAAS,aAAA,CACd,MAAA,EACA,OAAA,GAAgC,EAAC,EACZ;AACrB,EAAA,MAAM,SAAA,GAAYA,iBAAA,CAAY,CAAC,QAAA,KAAyB,MAAA,CAAO,UAAU,QAAQ,CAAA,EAAG,CAAC,MAAM,CAAC,CAAA;AAC5F,EAAA,MAAM,WAAA,GAAcA,kBAAY,MAAM,MAAA,CAAO,UAAS,EAAG,CAAC,MAAM,CAAC,CAAA;AACjE,EAAA,MAAM,KAAA,GAAQC,0BAAA,CAAqB,SAAA,EAAW,WAAA,EAAa,cAAc,CAAA;AACzE,EAAA,MAAM,aAAA,GAAgBD,iBAAA;AAAA,IACpB,CAAC,QAAA,KAAyB,MAAA,CAAO,kBAAA,CAAmB,QAAQ,CAAA;AAAA,IAC5D,CAAC,MAAM;AAAA,GACT;AACA,EAAqBC,0BAAA;AAAA,IACnB,aAAA;AAAA,IACA,MAAM,OAAO,eAAA,EAAgB;AAAA,IAC7B,MAAM;AAAA;AAER,EAAA,MAAM,CAAC,KAAA,EAAO,QAAQ,CAAA,GAAIC,eAAuB,IAAI,CAAA;AACrD,EAAAC,eAAA,CAAU,MAAM;AACd,IAAA,IAAI,QAAQ,UAAA,KAAe,KAAA,IAAS,MAAA,CAAO,QAAA,OAAe,IAAA,EAAM;AAChE,IAAA,IAAI,MAAA,GAAS,IAAA;AACb,IAAA,KAAK,MAAA,CAAO,IAAA,EAAK,CAAE,KAAA,CAAM,CAAC,MAAA,KAAoB;AAC5C,MAAA,IAAI,MAAA,EAAQ,QAAA,CAAS,SAAA,CAAU,MAAM,CAAC,CAAA;AAAA,IACxC,CAAC,CAAA;AACD,IAAA,OAAO,MAAM;AACX,MAAA,MAAA,GAAS,KAAA;AAAA,IACX,CAAA;AAAA,EACF,CAAA,EAAG,CAAC,MAAA,EAAQ,OAAA,CAAQ,UAAU,CAAC,CAAA;AAC/B,EAAAA,eAAA,CAAU,MAAM;AACd,IAAA,OAAO,MAAA,CAAO,eAAA,CAAgB,CAAC,KAAA,KAAU;AACvC,MAAA,IAAI,MAAM,IAAA,KAAS,OAAA,WAAkB,SAAA,CAAU,KAAA,CAAM,KAAK,CAAC,CAAA;AAAA,IAC7D,CAAC,CAAA;AAAA,EACH,CAAA,EAAG,CAAC,MAAM,CAAC,CAAA;AACX,EAAAA,eAAA,CAAU,MAAM;AACd,IAAA,IAAI,OAAA,CAAQ,gBAAgB,MAAA,EAAW;AACvC,IAAA,OAAO,MAAA,CAAO,mBAAA,CAAoB,OAAA,CAAQ,WAAW,CAAA;AAAA,EACvD,CAAA,EAAG,CAAC,MAAA,EAAQ,OAAA,CAAQ,WAAW,CAAC,CAAA;AAChC,EAAA,MAAM,SAAA,GAAYH,iBAAA;AAAA,IAChB,CAAC,MAAA,EAAgB,KAAA,EAAgB,cAAA,GAAiC,EAAC,KAAM;AACvE,MAAA,QAAA,CAAS,IAAI,CAAA;AACb,MAAA,OAAO,MAAA,CAAO,QAAQ,MAAA,EAAQ,KAAA,EAAO,cAAc,CAAA,CAAE,IAAA,CAAK,CAAC,MAAA,KAAW;AACpE,QAAA,IAAI,CAAC,MAAA,CAAO,EAAA,WAAa,SAAA,CAAU,MAAA,CAAO,KAAK,CAAC,CAAA;AAChD,QAAA,OAAO,MAAA;AAAA,MACT,CAAC,CAAA;AAAA,IACH,CAAA;AAAA,IACA,CAAC,MAAM;AAAA,GACT;AACA,EAAA,MAAM,aAAA,GAAgBA,iBAAA;AAAA,IACpB,CAAC,QAAA,EAAkB,YAAA,GAA6B,EAAC,KAAM;AACrD,MAAA,QAAA,CAAS,IAAI,CAAA;AACb,MAAA,OAAO,OAAO,WAAA,CAAY,QAAA,EAAU,YAAY,CAAA,CAAE,IAAA,CAAK,CAAC,MAAA,KAAW;AACjE,QAAA,IAAI,CAAC,MAAA,CAAO,EAAA,WAAa,SAAA,CAAU,MAAA,CAAO,KAAK,CAAC,CAAA;AAChD,QAAA,OAAO,MAAA;AAAA,MACT,CAAC,CAAA;AAAA,IACH,CAAA;AAAA,IACA,CAAC,MAAM;AAAA,GACT;AACA,EAAA,MAAM,MAAA,GAASA,kBAAY,MAAM;AAC/B,IAAA,QAAA,CAAS,IAAI,CAAA;AACb,IAAA,OAAO,MAAA,CAAO,IAAA,EAAK,CAAE,KAAA,CAAM,CAAC,MAAA,KAAoB;AAC9C,MAAA,MAAM,IAAA,GAAO,UAAU,MAAM,CAAA;AAC7B,MAAA,QAAA,CAAS,IAAI,CAAA;AACb,MAAA,MAAM,IAAA;AAAA,IACR,CAAC,CAAA;AAAA,EACH,CAAA,EAAG,CAAC,MAAM,CAAC,CAAA;AACX,EAAA,MAAM,WAAA,GAAcA,iBAAA;AAAA,IAClB,CAAC,QAAA,KAAgC,MAAA,CAAO,mBAAA,CAAoB,QAAQ,CAAA;AAAA,IACpE,CAAC,MAAM;AAAA,GACT;AAEA,EAAA,OAAO;AAAA,IACL,KAAA;AAAA,IACA,MAAA,EAAQ,OAAO,SAAA,EAAU;AAAA,IACzB,WAAW,KAAA,KAAU,IAAA;AAAA,IACrB,KAAA;AAAA,IACA,SAAA;AAAA,IACA,aAAA;AAAA,IACA,MAAA;AAAA,IACA,SAAA,EAAW,MAAA;AAAA,IACX,SAAA,EAAW;AAAA,MACT,SAAA,EAAW,OAAO,SAAA,KAAc,SAAA;AAAA,MAChC,cAAc,MAAA,CAAO,YAAA;AAAA,MACrB,iBAAiB,MAAA,CAAO;AAAA,KAC1B;AAAA,IACA,YAAY,MAAA,CAAO,SAAA;AAAA,IACnB,SAAA,EAAW,OAAO,SAAA,KAAc,SAAA;AAAA,IAChC,cAAc,MAAA,CAAO,YAAA;AAAA,IACrB,iBAAiB,MAAA,CAAO,eAAA;AAAA,IACxB,iBAAiB,MAAA,CAAO,eAAA;AAAA,IACxB,eAAA,EAAiB,MAAA,CAAO,eAAA,CAAgB,IAAA,CAAK,MAAM,CAAA;AAAA,IACnD,aAAA,EAAe,MAAA,CAAO,aAAA,CAAc,IAAA,CAAK,MAAM,CAAA;AAAA,IAC/C,cAAA,EAAgB,MAAA,CAAO,cAAA,CAAe,IAAA,CAAK,MAAM,CAAA;AAAA,IACjD,wBAAA,EAA0B,MAAA,CAAO,wBAAA,CAAyB,IAAA,CAAK,MAAM,CAAA;AAAA,IACrE,WAAA;AAAA,IACA,kBAAA,EAAoB,OAAO,qBAAA,EAAsB;AAAA,IACjD,UAAA,EAAY,MAAA,CAAO,UAAA,CAAW,IAAA,CAAK,MAAM,CAAA;AAAA,IACzC,cAAA,EAAgB,MAAA,CAAO,cAAA,CAAe,IAAA,CAAK,MAAM;AAAA,GACnD;AACF","file":"index.cjs","sourcesContent":["import type {\n CheckInOptions,\n CheckInResult,\n ClaimOptions,\n ClaimResult,\n OfflineQueueCapability,\n RejectedOperationHistoryEntry,\n StampRallyClient,\n SyncEventListener,\n SyncState,\n UserRallyState,\n} from \"@stamprally/core\";\nimport { useCallback, useEffect, useState, useSyncExternalStore } from \"react\";\n\nexport interface UseStampRallyOptions {\n readonly initialize?: boolean;\n readonly onSyncEvent?: SyncEventListener;\n}\nexport interface UseStampRallySyncState {\n readonly isSyncing: boolean;\n readonly pendingCount: number;\n readonly rejectedHistory: ReadonlyArray<RejectedOperationHistoryEntry>;\n}\nexport interface UseStampRallyReturn {\n readonly state: UserRallyState | null;\n readonly config: ReturnType<StampRallyClient[\"getConfig\"]>;\n readonly isLoading: boolean;\n readonly error: Error | null;\n readonly onCheckIn: (\n spotId: string,\n proof: unknown,\n options?: CheckInOptions,\n ) => Promise<CheckInResult>;\n readonly onClaimReward: (rewardId: string, options?: ClaimOptions) => Promise<ClaimResult>;\n readonly onSync: () => Promise<void>;\n readonly retrySync: () => Promise<void>;\n readonly syncState: UseStampRallySyncState;\n readonly syncStatus: SyncState;\n readonly isSyncing: boolean;\n readonly pendingCount: number;\n readonly queueCapability: OfflineQueueCapability;\n readonly rejectedHistory: ReadonlyArray<RejectedOperationHistoryEntry>;\n readonly discardRejected: (operationId: string) => Promise<boolean>;\n readonly retryRejected: (operationId: string) => Promise<boolean>;\n readonly retryOperation: (operationId: string) => Promise<boolean>;\n readonly dismissRejectedOperation: (operationId: string) => Promise<boolean>;\n readonly onSyncEvent: (listener: SyncEventListener) => () => void;\n readonly anonymousSessionId: string;\n readonly switchUser: (userId: string | null) => Promise<UserRallyState>;\n readonly clearUserState: (userId?: string) => Promise<void>;\n}\nfunction serverSnapshot(): null {\n return null;\n}\nfunction errorFrom(value: unknown): Error {\n return value instanceof Error ? value : new Error(String(value));\n}\nexport function useStampRally(\n client: StampRallyClient,\n options: UseStampRallyOptions = {},\n): UseStampRallyReturn {\n const subscribe = useCallback((listener: () => void) => client.subscribe(listener), [client]);\n const getSnapshot = useCallback(() => client.getState(), [client]);\n const state = useSyncExternalStore(subscribe, getSnapshot, serverSnapshot);\n const syncSubscribe = useCallback(\n (listener: () => void) => client.subscribeSyncState(listener),\n [client],\n );\n const syncRevision = useSyncExternalStore(\n syncSubscribe,\n () => client.getSyncRevision(),\n () => 0,\n );\n const [error, setError] = useState<Error | null>(null);\n useEffect(() => {\n if (options.initialize === false || client.getState() !== null) return;\n let active = true;\n void client.init().catch((reason: unknown) => {\n if (active) setError(errorFrom(reason));\n });\n return () => {\n active = false;\n };\n }, [client, options.initialize]);\n useEffect(() => {\n return client.subscribeEvents((event) => {\n if (event.type === \"error\") setError(errorFrom(event.error));\n });\n }, [client]);\n useEffect(() => {\n if (options.onSyncEvent === undefined) return;\n return client.subscribeSyncEvents(options.onSyncEvent);\n }, [client, options.onSyncEvent]);\n const onCheckIn = useCallback(\n (spotId: string, proof: unknown, checkInOptions: CheckInOptions = {}) => {\n setError(null);\n return client.checkIn(spotId, proof, checkInOptions).then((result) => {\n if (!result.ok) setError(errorFrom(result.error));\n return result;\n });\n },\n [client],\n );\n const onClaimReward = useCallback(\n (rewardId: string, claimOptions: ClaimOptions = {}) => {\n setError(null);\n return client.claimReward(rewardId, claimOptions).then((result) => {\n if (!result.ok) setError(errorFrom(result.error));\n return result;\n });\n },\n [client],\n );\n const onSync = useCallback(() => {\n setError(null);\n return client.sync().catch((reason: unknown) => {\n const next = errorFrom(reason);\n setError(next);\n throw next;\n });\n }, [client]);\n const onSyncEvent = useCallback(\n (listener: SyncEventListener) => client.subscribeSyncEvents(listener),\n [client],\n );\n void syncRevision;\n return {\n state,\n config: client.getConfig(),\n isLoading: state === null,\n error,\n onCheckIn,\n onClaimReward,\n onSync,\n retrySync: onSync,\n syncState: {\n isSyncing: client.syncState === \"syncing\",\n pendingCount: client.pendingCount,\n rejectedHistory: client.rejectedHistory,\n },\n syncStatus: client.syncState,\n isSyncing: client.syncState === \"syncing\",\n pendingCount: client.pendingCount,\n queueCapability: client.queueCapability,\n rejectedHistory: client.rejectedHistory,\n discardRejected: client.discardRejected.bind(client),\n retryRejected: client.retryRejected.bind(client),\n retryOperation: client.retryOperation.bind(client),\n dismissRejectedOperation: client.dismissRejectedOperation.bind(client),\n onSyncEvent,\n anonymousSessionId: client.getAnonymousSessionId(),\n switchUser: client.switchUser.bind(client),\n clearUserState: client.clearUserState.bind(client),\n };\n}\n"]}
|
package/dist/index.d.cts
CHANGED
|
@@ -1,7 +1,13 @@
|
|
|
1
|
-
import { UserRallyState, StampRallyClient, CheckInOptions, CheckInResult, ClaimOptions, ClaimResult, SyncState, OfflineQueueCapability
|
|
1
|
+
import { SyncEventListener, UserRallyState, StampRallyClient, CheckInOptions, CheckInResult, ClaimOptions, ClaimResult, RejectedOperationHistoryEntry, SyncState, OfflineQueueCapability } from '@stamprally/core';
|
|
2
2
|
|
|
3
3
|
interface UseStampRallyOptions {
|
|
4
4
|
readonly initialize?: boolean;
|
|
5
|
+
readonly onSyncEvent?: SyncEventListener;
|
|
6
|
+
}
|
|
7
|
+
interface UseStampRallySyncState {
|
|
8
|
+
readonly isSyncing: boolean;
|
|
9
|
+
readonly pendingCount: number;
|
|
10
|
+
readonly rejectedHistory: ReadonlyArray<RejectedOperationHistoryEntry>;
|
|
5
11
|
}
|
|
6
12
|
interface UseStampRallyReturn {
|
|
7
13
|
readonly state: UserRallyState | null;
|
|
@@ -12,16 +18,21 @@ interface UseStampRallyReturn {
|
|
|
12
18
|
readonly onClaimReward: (rewardId: string, options?: ClaimOptions) => Promise<ClaimResult>;
|
|
13
19
|
readonly onSync: () => Promise<void>;
|
|
14
20
|
readonly retrySync: () => Promise<void>;
|
|
15
|
-
readonly syncState:
|
|
21
|
+
readonly syncState: UseStampRallySyncState;
|
|
22
|
+
readonly syncStatus: SyncState;
|
|
23
|
+
readonly isSyncing: boolean;
|
|
16
24
|
readonly pendingCount: number;
|
|
17
25
|
readonly queueCapability: OfflineQueueCapability;
|
|
18
26
|
readonly rejectedHistory: ReadonlyArray<RejectedOperationHistoryEntry>;
|
|
19
27
|
readonly discardRejected: (operationId: string) => Promise<boolean>;
|
|
20
28
|
readonly retryRejected: (operationId: string) => Promise<boolean>;
|
|
29
|
+
readonly retryOperation: (operationId: string) => Promise<boolean>;
|
|
30
|
+
readonly dismissRejectedOperation: (operationId: string) => Promise<boolean>;
|
|
31
|
+
readonly onSyncEvent: (listener: SyncEventListener) => () => void;
|
|
21
32
|
readonly anonymousSessionId: string;
|
|
22
33
|
readonly switchUser: (userId: string | null) => Promise<UserRallyState>;
|
|
23
34
|
readonly clearUserState: (userId?: string) => Promise<void>;
|
|
24
35
|
}
|
|
25
36
|
declare function useStampRally(client: StampRallyClient, options?: UseStampRallyOptions): UseStampRallyReturn;
|
|
26
37
|
|
|
27
|
-
export { type UseStampRallyOptions, type UseStampRallyReturn, useStampRally };
|
|
38
|
+
export { type UseStampRallyOptions, type UseStampRallyReturn, type UseStampRallySyncState, useStampRally };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,7 +1,13 @@
|
|
|
1
|
-
import { UserRallyState, StampRallyClient, CheckInOptions, CheckInResult, ClaimOptions, ClaimResult, SyncState, OfflineQueueCapability
|
|
1
|
+
import { SyncEventListener, UserRallyState, StampRallyClient, CheckInOptions, CheckInResult, ClaimOptions, ClaimResult, RejectedOperationHistoryEntry, SyncState, OfflineQueueCapability } from '@stamprally/core';
|
|
2
2
|
|
|
3
3
|
interface UseStampRallyOptions {
|
|
4
4
|
readonly initialize?: boolean;
|
|
5
|
+
readonly onSyncEvent?: SyncEventListener;
|
|
6
|
+
}
|
|
7
|
+
interface UseStampRallySyncState {
|
|
8
|
+
readonly isSyncing: boolean;
|
|
9
|
+
readonly pendingCount: number;
|
|
10
|
+
readonly rejectedHistory: ReadonlyArray<RejectedOperationHistoryEntry>;
|
|
5
11
|
}
|
|
6
12
|
interface UseStampRallyReturn {
|
|
7
13
|
readonly state: UserRallyState | null;
|
|
@@ -12,16 +18,21 @@ interface UseStampRallyReturn {
|
|
|
12
18
|
readonly onClaimReward: (rewardId: string, options?: ClaimOptions) => Promise<ClaimResult>;
|
|
13
19
|
readonly onSync: () => Promise<void>;
|
|
14
20
|
readonly retrySync: () => Promise<void>;
|
|
15
|
-
readonly syncState:
|
|
21
|
+
readonly syncState: UseStampRallySyncState;
|
|
22
|
+
readonly syncStatus: SyncState;
|
|
23
|
+
readonly isSyncing: boolean;
|
|
16
24
|
readonly pendingCount: number;
|
|
17
25
|
readonly queueCapability: OfflineQueueCapability;
|
|
18
26
|
readonly rejectedHistory: ReadonlyArray<RejectedOperationHistoryEntry>;
|
|
19
27
|
readonly discardRejected: (operationId: string) => Promise<boolean>;
|
|
20
28
|
readonly retryRejected: (operationId: string) => Promise<boolean>;
|
|
29
|
+
readonly retryOperation: (operationId: string) => Promise<boolean>;
|
|
30
|
+
readonly dismissRejectedOperation: (operationId: string) => Promise<boolean>;
|
|
31
|
+
readonly onSyncEvent: (listener: SyncEventListener) => () => void;
|
|
21
32
|
readonly anonymousSessionId: string;
|
|
22
33
|
readonly switchUser: (userId: string | null) => Promise<UserRallyState>;
|
|
23
34
|
readonly clearUserState: (userId?: string) => Promise<void>;
|
|
24
35
|
}
|
|
25
36
|
declare function useStampRally(client: StampRallyClient, options?: UseStampRallyOptions): UseStampRallyReturn;
|
|
26
37
|
|
|
27
|
-
export { type UseStampRallyOptions, type UseStampRallyReturn, useStampRally };
|
|
38
|
+
export { type UseStampRallyOptions, type UseStampRallyReturn, type UseStampRallySyncState, useStampRally };
|
package/dist/index.js
CHANGED
|
@@ -11,6 +11,15 @@ function useStampRally(client, options = {}) {
|
|
|
11
11
|
const subscribe = useCallback((listener) => client.subscribe(listener), [client]);
|
|
12
12
|
const getSnapshot = useCallback(() => client.getState(), [client]);
|
|
13
13
|
const state = useSyncExternalStore(subscribe, getSnapshot, serverSnapshot);
|
|
14
|
+
const syncSubscribe = useCallback(
|
|
15
|
+
(listener) => client.subscribeSyncState(listener),
|
|
16
|
+
[client]
|
|
17
|
+
);
|
|
18
|
+
useSyncExternalStore(
|
|
19
|
+
syncSubscribe,
|
|
20
|
+
() => client.getSyncRevision(),
|
|
21
|
+
() => 0
|
|
22
|
+
);
|
|
14
23
|
const [error, setError] = useState(null);
|
|
15
24
|
useEffect(() => {
|
|
16
25
|
if (options.initialize === false || client.getState() !== null) return;
|
|
@@ -27,6 +36,10 @@ function useStampRally(client, options = {}) {
|
|
|
27
36
|
if (event.type === "error") setError(errorFrom(event.error));
|
|
28
37
|
});
|
|
29
38
|
}, [client]);
|
|
39
|
+
useEffect(() => {
|
|
40
|
+
if (options.onSyncEvent === void 0) return;
|
|
41
|
+
return client.subscribeSyncEvents(options.onSyncEvent);
|
|
42
|
+
}, [client, options.onSyncEvent]);
|
|
30
43
|
const onCheckIn = useCallback(
|
|
31
44
|
(spotId, proof, checkInOptions = {}) => {
|
|
32
45
|
setError(null);
|
|
@@ -55,6 +68,10 @@ function useStampRally(client, options = {}) {
|
|
|
55
68
|
throw next;
|
|
56
69
|
});
|
|
57
70
|
}, [client]);
|
|
71
|
+
const onSyncEvent = useCallback(
|
|
72
|
+
(listener) => client.subscribeSyncEvents(listener),
|
|
73
|
+
[client]
|
|
74
|
+
);
|
|
58
75
|
return {
|
|
59
76
|
state,
|
|
60
77
|
config: client.getConfig(),
|
|
@@ -64,12 +81,21 @@ function useStampRally(client, options = {}) {
|
|
|
64
81
|
onClaimReward,
|
|
65
82
|
onSync,
|
|
66
83
|
retrySync: onSync,
|
|
67
|
-
syncState:
|
|
84
|
+
syncState: {
|
|
85
|
+
isSyncing: client.syncState === "syncing",
|
|
86
|
+
pendingCount: client.pendingCount,
|
|
87
|
+
rejectedHistory: client.rejectedHistory
|
|
88
|
+
},
|
|
89
|
+
syncStatus: client.syncState,
|
|
90
|
+
isSyncing: client.syncState === "syncing",
|
|
68
91
|
pendingCount: client.pendingCount,
|
|
69
92
|
queueCapability: client.queueCapability,
|
|
70
93
|
rejectedHistory: client.rejectedHistory,
|
|
71
94
|
discardRejected: client.discardRejected.bind(client),
|
|
72
95
|
retryRejected: client.retryRejected.bind(client),
|
|
96
|
+
retryOperation: client.retryOperation.bind(client),
|
|
97
|
+
dismissRejectedOperation: client.dismissRejectedOperation.bind(client),
|
|
98
|
+
onSyncEvent,
|
|
73
99
|
anonymousSessionId: client.getAnonymousSessionId(),
|
|
74
100
|
switchUser: client.switchUser.bind(client),
|
|
75
101
|
clearUserState: client.clearUserState.bind(client)
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/useStampRally.ts"],"names":[],"mappings":";;
|
|
1
|
+
{"version":3,"sources":["../src/useStampRally.ts"],"names":[],"mappings":";;AAmDA,SAAS,cAAA,GAAuB;AAC9B,EAAA,OAAO,IAAA;AACT;AACA,SAAS,UAAU,KAAA,EAAuB;AACxC,EAAA,OAAO,iBAAiB,KAAA,GAAQ,KAAA,GAAQ,IAAI,KAAA,CAAM,MAAA,CAAO,KAAK,CAAC,CAAA;AACjE;AACO,SAAS,aAAA,CACd,MAAA,EACA,OAAA,GAAgC,EAAC,EACZ;AACrB,EAAA,MAAM,SAAA,GAAY,WAAA,CAAY,CAAC,QAAA,KAAyB,MAAA,CAAO,UAAU,QAAQ,CAAA,EAAG,CAAC,MAAM,CAAC,CAAA;AAC5F,EAAA,MAAM,WAAA,GAAc,YAAY,MAAM,MAAA,CAAO,UAAS,EAAG,CAAC,MAAM,CAAC,CAAA;AACjE,EAAA,MAAM,KAAA,GAAQ,oBAAA,CAAqB,SAAA,EAAW,WAAA,EAAa,cAAc,CAAA;AACzE,EAAA,MAAM,aAAA,GAAgB,WAAA;AAAA,IACpB,CAAC,QAAA,KAAyB,MAAA,CAAO,kBAAA,CAAmB,QAAQ,CAAA;AAAA,IAC5D,CAAC,MAAM;AAAA,GACT;AACA,EAAqB,oBAAA;AAAA,IACnB,aAAA;AAAA,IACA,MAAM,OAAO,eAAA,EAAgB;AAAA,IAC7B,MAAM;AAAA;AAER,EAAA,MAAM,CAAC,KAAA,EAAO,QAAQ,CAAA,GAAI,SAAuB,IAAI,CAAA;AACrD,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,IAAI,QAAQ,UAAA,KAAe,KAAA,IAAS,MAAA,CAAO,QAAA,OAAe,IAAA,EAAM;AAChE,IAAA,IAAI,MAAA,GAAS,IAAA;AACb,IAAA,KAAK,MAAA,CAAO,IAAA,EAAK,CAAE,KAAA,CAAM,CAAC,MAAA,KAAoB;AAC5C,MAAA,IAAI,MAAA,EAAQ,QAAA,CAAS,SAAA,CAAU,MAAM,CAAC,CAAA;AAAA,IACxC,CAAC,CAAA;AACD,IAAA,OAAO,MAAM;AACX,MAAA,MAAA,GAAS,KAAA;AAAA,IACX,CAAA;AAAA,EACF,CAAA,EAAG,CAAC,MAAA,EAAQ,OAAA,CAAQ,UAAU,CAAC,CAAA;AAC/B,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,OAAO,MAAA,CAAO,eAAA,CAAgB,CAAC,KAAA,KAAU;AACvC,MAAA,IAAI,MAAM,IAAA,KAAS,OAAA,WAAkB,SAAA,CAAU,KAAA,CAAM,KAAK,CAAC,CAAA;AAAA,IAC7D,CAAC,CAAA;AAAA,EACH,CAAA,EAAG,CAAC,MAAM,CAAC,CAAA;AACX,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,IAAI,OAAA,CAAQ,gBAAgB,MAAA,EAAW;AACvC,IAAA,OAAO,MAAA,CAAO,mBAAA,CAAoB,OAAA,CAAQ,WAAW,CAAA;AAAA,EACvD,CAAA,EAAG,CAAC,MAAA,EAAQ,OAAA,CAAQ,WAAW,CAAC,CAAA;AAChC,EAAA,MAAM,SAAA,GAAY,WAAA;AAAA,IAChB,CAAC,MAAA,EAAgB,KAAA,EAAgB,cAAA,GAAiC,EAAC,KAAM;AACvE,MAAA,QAAA,CAAS,IAAI,CAAA;AACb,MAAA,OAAO,MAAA,CAAO,QAAQ,MAAA,EAAQ,KAAA,EAAO,cAAc,CAAA,CAAE,IAAA,CAAK,CAAC,MAAA,KAAW;AACpE,QAAA,IAAI,CAAC,MAAA,CAAO,EAAA,WAAa,SAAA,CAAU,MAAA,CAAO,KAAK,CAAC,CAAA;AAChD,QAAA,OAAO,MAAA;AAAA,MACT,CAAC,CAAA;AAAA,IACH,CAAA;AAAA,IACA,CAAC,MAAM;AAAA,GACT;AACA,EAAA,MAAM,aAAA,GAAgB,WAAA;AAAA,IACpB,CAAC,QAAA,EAAkB,YAAA,GAA6B,EAAC,KAAM;AACrD,MAAA,QAAA,CAAS,IAAI,CAAA;AACb,MAAA,OAAO,OAAO,WAAA,CAAY,QAAA,EAAU,YAAY,CAAA,CAAE,IAAA,CAAK,CAAC,MAAA,KAAW;AACjE,QAAA,IAAI,CAAC,MAAA,CAAO,EAAA,WAAa,SAAA,CAAU,MAAA,CAAO,KAAK,CAAC,CAAA;AAChD,QAAA,OAAO,MAAA;AAAA,MACT,CAAC,CAAA;AAAA,IACH,CAAA;AAAA,IACA,CAAC,MAAM;AAAA,GACT;AACA,EAAA,MAAM,MAAA,GAAS,YAAY,MAAM;AAC/B,IAAA,QAAA,CAAS,IAAI,CAAA;AACb,IAAA,OAAO,MAAA,CAAO,IAAA,EAAK,CAAE,KAAA,CAAM,CAAC,MAAA,KAAoB;AAC9C,MAAA,MAAM,IAAA,GAAO,UAAU,MAAM,CAAA;AAC7B,MAAA,QAAA,CAAS,IAAI,CAAA;AACb,MAAA,MAAM,IAAA;AAAA,IACR,CAAC,CAAA;AAAA,EACH,CAAA,EAAG,CAAC,MAAM,CAAC,CAAA;AACX,EAAA,MAAM,WAAA,GAAc,WAAA;AAAA,IAClB,CAAC,QAAA,KAAgC,MAAA,CAAO,mBAAA,CAAoB,QAAQ,CAAA;AAAA,IACpE,CAAC,MAAM;AAAA,GACT;AAEA,EAAA,OAAO;AAAA,IACL,KAAA;AAAA,IACA,MAAA,EAAQ,OAAO,SAAA,EAAU;AAAA,IACzB,WAAW,KAAA,KAAU,IAAA;AAAA,IACrB,KAAA;AAAA,IACA,SAAA;AAAA,IACA,aAAA;AAAA,IACA,MAAA;AAAA,IACA,SAAA,EAAW,MAAA;AAAA,IACX,SAAA,EAAW;AAAA,MACT,SAAA,EAAW,OAAO,SAAA,KAAc,SAAA;AAAA,MAChC,cAAc,MAAA,CAAO,YAAA;AAAA,MACrB,iBAAiB,MAAA,CAAO;AAAA,KAC1B;AAAA,IACA,YAAY,MAAA,CAAO,SAAA;AAAA,IACnB,SAAA,EAAW,OAAO,SAAA,KAAc,SAAA;AAAA,IAChC,cAAc,MAAA,CAAO,YAAA;AAAA,IACrB,iBAAiB,MAAA,CAAO,eAAA;AAAA,IACxB,iBAAiB,MAAA,CAAO,eAAA;AAAA,IACxB,eAAA,EAAiB,MAAA,CAAO,eAAA,CAAgB,IAAA,CAAK,MAAM,CAAA;AAAA,IACnD,aAAA,EAAe,MAAA,CAAO,aAAA,CAAc,IAAA,CAAK,MAAM,CAAA;AAAA,IAC/C,cAAA,EAAgB,MAAA,CAAO,cAAA,CAAe,IAAA,CAAK,MAAM,CAAA;AAAA,IACjD,wBAAA,EAA0B,MAAA,CAAO,wBAAA,CAAyB,IAAA,CAAK,MAAM,CAAA;AAAA,IACrE,WAAA;AAAA,IACA,kBAAA,EAAoB,OAAO,qBAAA,EAAsB;AAAA,IACjD,UAAA,EAAY,MAAA,CAAO,UAAA,CAAW,IAAA,CAAK,MAAM,CAAA;AAAA,IACzC,cAAA,EAAgB,MAAA,CAAO,cAAA,CAAe,IAAA,CAAK,MAAM;AAAA,GACnD;AACF","file":"index.js","sourcesContent":["import type {\n CheckInOptions,\n CheckInResult,\n ClaimOptions,\n ClaimResult,\n OfflineQueueCapability,\n RejectedOperationHistoryEntry,\n StampRallyClient,\n SyncEventListener,\n SyncState,\n UserRallyState,\n} from \"@stamprally/core\";\nimport { useCallback, useEffect, useState, useSyncExternalStore } from \"react\";\n\nexport interface UseStampRallyOptions {\n readonly initialize?: boolean;\n readonly onSyncEvent?: SyncEventListener;\n}\nexport interface UseStampRallySyncState {\n readonly isSyncing: boolean;\n readonly pendingCount: number;\n readonly rejectedHistory: ReadonlyArray<RejectedOperationHistoryEntry>;\n}\nexport interface UseStampRallyReturn {\n readonly state: UserRallyState | null;\n readonly config: ReturnType<StampRallyClient[\"getConfig\"]>;\n readonly isLoading: boolean;\n readonly error: Error | null;\n readonly onCheckIn: (\n spotId: string,\n proof: unknown,\n options?: CheckInOptions,\n ) => Promise<CheckInResult>;\n readonly onClaimReward: (rewardId: string, options?: ClaimOptions) => Promise<ClaimResult>;\n readonly onSync: () => Promise<void>;\n readonly retrySync: () => Promise<void>;\n readonly syncState: UseStampRallySyncState;\n readonly syncStatus: SyncState;\n readonly isSyncing: boolean;\n readonly pendingCount: number;\n readonly queueCapability: OfflineQueueCapability;\n readonly rejectedHistory: ReadonlyArray<RejectedOperationHistoryEntry>;\n readonly discardRejected: (operationId: string) => Promise<boolean>;\n readonly retryRejected: (operationId: string) => Promise<boolean>;\n readonly retryOperation: (operationId: string) => Promise<boolean>;\n readonly dismissRejectedOperation: (operationId: string) => Promise<boolean>;\n readonly onSyncEvent: (listener: SyncEventListener) => () => void;\n readonly anonymousSessionId: string;\n readonly switchUser: (userId: string | null) => Promise<UserRallyState>;\n readonly clearUserState: (userId?: string) => Promise<void>;\n}\nfunction serverSnapshot(): null {\n return null;\n}\nfunction errorFrom(value: unknown): Error {\n return value instanceof Error ? value : new Error(String(value));\n}\nexport function useStampRally(\n client: StampRallyClient,\n options: UseStampRallyOptions = {},\n): UseStampRallyReturn {\n const subscribe = useCallback((listener: () => void) => client.subscribe(listener), [client]);\n const getSnapshot = useCallback(() => client.getState(), [client]);\n const state = useSyncExternalStore(subscribe, getSnapshot, serverSnapshot);\n const syncSubscribe = useCallback(\n (listener: () => void) => client.subscribeSyncState(listener),\n [client],\n );\n const syncRevision = useSyncExternalStore(\n syncSubscribe,\n () => client.getSyncRevision(),\n () => 0,\n );\n const [error, setError] = useState<Error | null>(null);\n useEffect(() => {\n if (options.initialize === false || client.getState() !== null) return;\n let active = true;\n void client.init().catch((reason: unknown) => {\n if (active) setError(errorFrom(reason));\n });\n return () => {\n active = false;\n };\n }, [client, options.initialize]);\n useEffect(() => {\n return client.subscribeEvents((event) => {\n if (event.type === \"error\") setError(errorFrom(event.error));\n });\n }, [client]);\n useEffect(() => {\n if (options.onSyncEvent === undefined) return;\n return client.subscribeSyncEvents(options.onSyncEvent);\n }, [client, options.onSyncEvent]);\n const onCheckIn = useCallback(\n (spotId: string, proof: unknown, checkInOptions: CheckInOptions = {}) => {\n setError(null);\n return client.checkIn(spotId, proof, checkInOptions).then((result) => {\n if (!result.ok) setError(errorFrom(result.error));\n return result;\n });\n },\n [client],\n );\n const onClaimReward = useCallback(\n (rewardId: string, claimOptions: ClaimOptions = {}) => {\n setError(null);\n return client.claimReward(rewardId, claimOptions).then((result) => {\n if (!result.ok) setError(errorFrom(result.error));\n return result;\n });\n },\n [client],\n );\n const onSync = useCallback(() => {\n setError(null);\n return client.sync().catch((reason: unknown) => {\n const next = errorFrom(reason);\n setError(next);\n throw next;\n });\n }, [client]);\n const onSyncEvent = useCallback(\n (listener: SyncEventListener) => client.subscribeSyncEvents(listener),\n [client],\n );\n void syncRevision;\n return {\n state,\n config: client.getConfig(),\n isLoading: state === null,\n error,\n onCheckIn,\n onClaimReward,\n onSync,\n retrySync: onSync,\n syncState: {\n isSyncing: client.syncState === \"syncing\",\n pendingCount: client.pendingCount,\n rejectedHistory: client.rejectedHistory,\n },\n syncStatus: client.syncState,\n isSyncing: client.syncState === \"syncing\",\n pendingCount: client.pendingCount,\n queueCapability: client.queueCapability,\n rejectedHistory: client.rejectedHistory,\n discardRejected: client.discardRejected.bind(client),\n retryRejected: client.retryRejected.bind(client),\n retryOperation: client.retryOperation.bind(client),\n dismissRejectedOperation: client.dismissRejectedOperation.bind(client),\n onSyncEvent,\n anonymousSessionId: client.getAnonymousSessionId(),\n switchUser: client.switchUser.bind(client),\n clearUserState: client.clearUserState.bind(client),\n };\n}\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stamprally/react",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.17.0",
|
|
4
4
|
"description": "React hooks for @stamprally/core.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
}
|
|
35
35
|
},
|
|
36
36
|
"dependencies": {
|
|
37
|
-
"@stamprally/core": "0.
|
|
37
|
+
"@stamprally/core": "0.17.0"
|
|
38
38
|
},
|
|
39
39
|
"peerDependencies": {
|
|
40
40
|
"react": "^18.0.0 || ^19.0.0",
|