@timekeeper-countdown/react 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,27 @@
+import { CountdownEngineOptions, CountdownSnapshot, TimerState } from '@timekeeper-countdown/core';
+
+interface UseCountdownOptions extends Omit<CountdownEngineOptions, 'onSnapshot' | 'onStateChange' | 'onError'> {
+    autoStart?: boolean;
+    onSnapshot?: CountdownEngineOptions['onSnapshot'];
+    onStateChange?: CountdownEngineOptions['onStateChange'];
+    onError?: CountdownEngineOptions['onError'];
+}
+interface UseCountdownControls {
+    start: () => boolean;
+    pause: () => boolean;
+    resume: () => boolean;
+    reset: (nextInitialSeconds?: number) => boolean;
+    stop: () => boolean;
+    setSeconds: (value: number) => void;
+}
+interface UseCountdownResult extends UseCountdownControls {
+    snapshot: CountdownSnapshot;
+    state: TimerState;
+    totalSeconds: number;
+    parts: CountdownSnapshot['parts'];
+    isRunning: boolean;
+    isCompleted: boolean;
+}
+declare function useCountdown(initialSeconds: number, options?: UseCountdownOptions): UseCountdownResult;
+
+export { type UseCountdownControls, type UseCountdownOptions, type UseCountdownResult, useCountdown };

package/dist/index.js

@@ -0,0 +1 @@
+import {useRef,useState,useEffect,useMemo,useCallback}from'react';import {CountdownEngine}from'@timekeeper-countdown/core';var M=(a,p)=>{let u=CountdownEngine(a,{tickIntervalMs:p.tickIntervalMs,timeProvider:p.timeProvider}),i=u.getSnapshot();return u.destroy(),i};function P(a,p={}){let{autoStart:u=false,tickIntervalMs:i,timeProvider:c,onSnapshot:l,onStateChange:C,onError:S}=p,d=useRef({onSnapshot:l,onStateChange:C,onError:S}),g=useRef(null),[r,m]=useState(()=>M(a,{tickIntervalMs:i,timeProvider:c}));useEffect(()=>{d.current={onSnapshot:l,onStateChange:C,onError:S};},[S,l,C]);let w=useMemo(()=>({tickIntervalMs:i,timeProvider:c}),[i,c]);useEffect(()=>{let n=true,e=CountdownEngine(a,{...w,onSnapshot:o=>{n&&m(o),d.current.onSnapshot?.(o);},onStateChange:(o,y)=>{d.current.onStateChange?.(o,y);},onError:o=>{d.current.onError?.(o);}});return g.current=e,m(e.getSnapshot()),u&&e.start(),()=>{n=false,e.destroy(),g.current=null;}},[u,w,a]);let t=useCallback((n,e)=>{let o=g.current;return o?n(o):e},[]),E=useCallback(()=>t(n=>n.start(),false),[t]),v=useCallback(()=>t(n=>n.pause(),false),[t]),O=useCallback(()=>t(n=>n.resume(),false),[t]),U=useCallback(()=>t(n=>n.stop(),false),[t]),I=useCallback(n=>t(e=>e.setSeconds(n),void 0),[t]),R=useCallback(n=>t(e=>e.reset(n),false),[t]);return {snapshot:r,state:r.state,totalSeconds:r.totalSeconds,parts:r.parts,isRunning:r.isRunning,isCompleted:r.isCompleted,start:E,pause:v,resume:O,reset:R,stop:U,setSeconds:I}}export{P as useCountdown};

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@timekeeper-countdown/react",
+  "version": "0.1.0",
+  "description": "React adapter for the Timekeeper Countdown engine",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "test:ui": "vitest --ui",
+    "test:coverage": "vitest run --coverage",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --write \"src/**/*.{ts,tsx}\"",
+    "format:check": "prettier --check \"src/**/*.{ts,tsx}\"",
+    "prepublishOnly": "npm run build && npm run test && npm run typecheck"
+  },
+  "peerDependencies": {
+    "react": ">=17.0.0"
+  },
+  "dependencies": {
+    "@timekeeper-countdown/core": "^0.1.0"
+  },
+  "devDependencies": {
+    "@testing-library/jest-dom": "^6.4.2",
+    "@testing-library/react": "^15.0.0",
+    "@types/react": "^18.2.55",
+    "@types/react-dom": "^18.2.19",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1"
+  },
+  "keywords": [
+    "react",
+    "countdown",
+    "timer",
+    "hook",
+    "typescript"
+  ],
+  "sideEffects": false,
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  }
+}