Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 13 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "lo_event",
"version": "0.0.5",
"version": "0.0.7",
"description": "Event logging library for the Learning Observer",
"main": "dist/loEvent.js",
"types": "dist/loEvent.d.ts",
Expand Down Expand Up @@ -61,6 +61,18 @@
"./types": {
"types": "./dist/types.d.ts",
"import": "./dist/types.js"
},
"./hooks": {
"types": "./dist/hooks.d.ts",
"import": "./dist/hooks.js"
}
},
"peerDependencies": {
"react": ">=18.0.0"
},
"peerDependenciesMeta": {
"react": {
"optional": true
}
},
"scripts": {
Expand Down
48 changes: 48 additions & 0 deletions src/hooks.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
/**
* React hooks for lo_event persistence status.
*
* These use useSyncExternalStore against a plain module-level store
* in reduxLogger (NOT Redux state — see reduxLogger.ts for rationale).
*
* Import from 'lo_event/hooks' — this entry point depends on React.
*/
import { useSyncExternalStore } from 'react';
import {
subscribeStatus,
getSaveStatus,
getConnected,
getLoaded,
} from './reduxLogger.js';

export type { SaveStatus } from './reduxLogger.js';

/**
* Whether the current state has been persisted.
*
* 'saved' — all changes have been sent to the server / localStorage
* 'modified' — changes exist, debounce timer running
*/
export function useSaved() {
return useSyncExternalStore(subscribeStatus, getSaveStatus, () => 'saved' as const);
}

/**
* WebSocket connection status.
*
* true — connected
* false — disconnected (show offline indicator)
* null — no WebSocket configured (don't show indicator)
*/
export function useConnected() {
return useSyncExternalStore(subscribeStatus, getConnected, () => null);
}

/**
* Whether initialization is complete (fetch_blob has resolved or
* no persistence is configured).
*
* Use this to gate the UI — show a loading screen until true.
*/
export function useLoaded() {
return useSyncExternalStore(subscribeStatus, getLoaded, () => false);
}
Loading