wavedash-react 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Adrien Guéret
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,215 @@
+# wavedash-react
+
+A React library for integrating Wavedash into your React-based game.
+
+## Installation
+
+```bash
+npm install wavedash-react
+```
+
+## Setup
+
+Wrap your app with the `WavedashProvider` to enable Wavedash features:
+
+```tsx
+import { WavedashProvider } from "wavedash-react";
+
+export function App() {
+  return (
+    <WavedashProvider
+      config={{
+        debug: true,
+      }}
+    >
+      <YourGame />
+    </WavedashProvider>
+  );
+}
+```
+
+## Core Hooks
+
+### useWavedash
+
+Access the Wavedash context to check if your game is running inside Wavedash:
+
+```tsx
+import { useWavedash } from "wavedash-react";
+
+export function GameComponent() {
+  const { isRunningInWavedash, wavedash } = useWavedash();
+
+  if (!isRunningInWavedash) {
+    return <p>Not running in Wavedash environment</p>;
+  }
+
+  return <p>Running in Wavedash!</p>;
+}
+```
+
+You can access the [native Wavedash SDK](https://docs.wavedash.com/sdk/functions) via `wavedash` object.
+
+### useCurrentUser
+
+Get the current logged-in user:
+
+```tsx
+import { useCurrentUser } from "wavedash-react";
+
+export function UserProfile() {
+  const user = useCurrentUser();
+
+  return user ? <p>Welcome, {user.username}!</p> : <p>Not logged in</p>;
+}
+```
+
+### UserAvatar
+
+A React component for displaying a user's avatar:
+
+```tsx
+import { UserAvatar } from "wavedash-react";
+
+export function Avatar() {
+  return <UserAvatar size={64} />;
+}
+
+export function OtherPlayerAvatar() {
+  return <UserAvatar userId="specific_userid_here" size={64} />;
+}
+```
+
+## Leaderboards
+
+Three hooks handle different leaderboard scenarios:
+
+#### useLeaderboardEntries
+
+Fetch a range of leaderboard entries:
+
+```tsx
+import { useLeaderboardEntries } from "wavedash-react";
+
+export function TopPlayers() {
+  const { isLoading, entries } = useLeaderboardEntries("main-leaderboard", {
+    start: 0,
+    count: 10,
+  });
+
+  if (isLoading) return <p>Loading...</p>;
+
+  return (
+    <ul>
+      {entries.map((entry) => (
+        <li key={entry.userId}>
+          {entry.username}: {entry.score} pts
+        </li>
+      ))}
+    </ul>
+  );
+}
+```
+
+#### useLeaderboardCurrentUserEntries
+
+Fetch the current user's leaderboard entries:
+
+```tsx
+import { useLeaderboardCurrentUserEntries } from "wavedash-react";
+
+export function MyStats() {
+  const { isLoading, entries } =
+    useLeaderboardCurrentUserEntries("main-leaderboard");
+
+  return (
+    <div>{entries.length > 0 && <p>Your rank: {entries[0].globalRank}</p>}</div>
+  );
+}
+```
+
+#### useLeaderboardEntriesAroundCurrentUser
+
+Fetch entries around the current user (ahead and behind):
+
+```tsx
+import { useLeaderboardEntriesAroundCurrentUser } from "wavedash-react";
+
+export function NearbyPlayers() {
+  const { isLoading, entries } = useLeaderboardEntriesAroundCurrentUser(
+    "main-leaderboard",
+    { countAhead: 5, countBehind: 5 },
+  );
+
+  return <div>{entries.length} players nearby</div>;
+}
+```
+
+### Submitting a score
+
+Use the `useLeaderboard` hook to access the `submitScore` method:
+
+```tsx
+import { useLeaderboard } from "wavedash-react";
+
+export function GameOver({ finalScore }: { finalScore: number }) {
+  const { submitScore } = useLeaderboard("main-leaderboard");
+
+  const handleSubmitScore = async () => {
+    const response = await submitScore(finalScore);
+    const { globalRank = null } = response ?? {};
+
+    if (globalRank !== null) {
+      alert(`Your rank: #${globalRank}`);
+    }
+  };
+
+  return <button onClick={handleSubmitScore}>Submit Score</button>;
+}
+```
+
+The `submitScore` method accepts:
+
+- `score` (required): The score value to submit
+- `keepBest` (optional): Whether to keep only the best score (default: true)
+- `ugcId` (optional): User-generated content ID for additional context
+
+Returns the player's global rank after submission, or `null` if submission failed.
+
+## Stats
+
+Track custom game stats:
+
+```tsx
+import { useStat } from "wavedash-react";
+
+export function StatsDisplay() {
+  const [stat, setStat] = useStat("player-kills");
+
+  return (
+    <div>
+      <p>Kills: {stat}</p>
+      <button onClick={() => setStat(stat + 1)}>Increment</button>
+    </div>
+  );
+}
+```
+
+## Achievements
+
+Display and unlock achievements:
+
+```tsx
+import { useAchievement } from "wavedash-react";
+
+export function AchievementHandler() {
+  const [achievement, unlockAchievement] = useAchievement("first-kill");
+
+  return (
+    <div>
+      <p>Status: {achievement?.unlocked ? "Unlocked" : "Locked"}</p>
+      <button onClick={() => unlockAchievement()}>Unlock</button>
+    </div>
+  );
+}
+```

package/dist/index.cjs

@@ -0,0 +1,278 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  useAchievement: () => useAchievement,
+  useLeaderboard: () => useLeaderboard,
+  useLeaderboardCurrentUserEntries: () => useLeaderboardCurrentUserEntries,
+  useLeaderboardEntries: () => useLeaderboardEntries,
+  useLeaderboardEntriesAroundCurrentUser: () => useLeaderboardEntriesAroundCurrentUser,
+  useStat: () => useStat,
+  useWavedash: () => useWavedash
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/useAchievement.ts
+var import_react2 = require("react");
+
+// src/WavedashProvider.tsx
+var import_react = require("react");
+var import_jsx_runtime = require("react/jsx-runtime");
+var WavedashContext = (0, import_react.createContext)({
+  isRunningInWavedash: false,
+  wavedash: null
+});
+function useWavedash() {
+  return (0, import_react.useContext)(WavedashContext);
+}
+
+// src/useAchievement.ts
+function useAchievement(achievementName) {
+  const { isRunningInWavedash, wavedash } = useWavedash();
+  const [isUnlocked, setIsUnlocked] = (0, import_react2.useState)(null);
+  (0, import_react2.useEffect)(() => {
+    if (!isRunningInWavedash || isUnlocked !== null) {
+      return;
+    }
+    wavedash.requestStats().then(() => {
+      const value = wavedash.getAchievement(achievementName);
+      setIsUnlocked(value);
+    });
+  }, [isRunningInWavedash, wavedash, achievementName, isUnlocked]);
+  const unlock = (0, import_react2.useCallback)(
+    (storeNow = true) => {
+      if (!isRunningInWavedash) {
+        return false;
+      }
+      const response = wavedash.setAchievement(achievementName, storeNow);
+      if (response) {
+        setIsUnlocked(true);
+      }
+      return response;
+    },
+    [isRunningInWavedash, wavedash, achievementName]
+  );
+  return [isUnlocked, unlock];
+}
+
+// src/useLeaderboards.ts
+var import_react3 = require("react");
+function useLeaderboard(leaderboardName, leaderboardOptions) {
+  const [leaderboard, setLeaderboard] = (0, import_react3.useState)(null);
+  const [isLoading, setIsLoading] = (0, import_react3.useState)(true);
+  const { isRunningInWavedash, wavedash } = useWavedash();
+  const { sortOrder, displayType } = leaderboardOptions ?? {};
+  (0, import_react3.useEffect)(() => {
+    if (!isRunningInWavedash) {
+      setIsLoading(false);
+      return;
+    }
+    setIsLoading(true);
+    wavedash.getOrCreateLeaderboard(
+      leaderboardName,
+      sortOrder ?? wavedash.LeaderboardSortOrder.DESC,
+      displayType ?? wavedash.LeaderboardDisplayType.NUMERIC
+    ).then((result) => {
+      if (result.success) {
+        setLeaderboard(result.data);
+      }
+    }).finally(() => {
+      setIsLoading(false);
+    });
+  }, [isRunningInWavedash, wavedash, leaderboardName, sortOrder, displayType]);
+  const leaderboardId = leaderboard?.id;
+  const submitScore = (0, import_react3.useCallback)(
+    async (score, keepBest = true, ugcId) => {
+      if (!isRunningInWavedash || !leaderboardId) {
+        return null;
+      }
+      const response = await wavedash.uploadLeaderboardScore(
+        leaderboardId,
+        score,
+        keepBest,
+        ugcId
+      );
+      return response.success ? response.data : null;
+    },
+    [isRunningInWavedash, leaderboardId, wavedash]
+  );
+  const getEntryCount = (0, import_react3.useCallback)(() => {
+    if (!isRunningInWavedash || !leaderboardId) {
+      return -1;
+    }
+    return wavedash.getLeaderboardEntryCount(leaderboardId);
+  }, [isRunningInWavedash, leaderboardId, wavedash]);
+  const getEntries = (0, import_react3.useCallback)(
+    async (start, count, friendsOnly) => {
+      if (!isRunningInWavedash || !leaderboardId) {
+        return [];
+      }
+      const response = await wavedash.listLeaderboardEntries(
+        leaderboardId,
+        start,
+        count,
+        friendsOnly
+      );
+      return response.success ? response.data : [];
+    },
+    [isRunningInWavedash, leaderboardId, wavedash]
+  );
+  const getEntriesAroundCurrentUser = (0, import_react3.useCallback)(
+    async (countAhead, countBehind, friendsOnly) => {
+      if (!isRunningInWavedash || !leaderboardId) {
+        return [];
+      }
+      const response = await wavedash.listLeaderboardEntriesAroundUser(
+        leaderboardId,
+        countAhead,
+        countBehind,
+        friendsOnly
+      );
+      return response.success ? response.data : [];
+    },
+    [isRunningInWavedash, leaderboardId, wavedash]
+  );
+  const getCurrentUserEntries = (0, import_react3.useCallback)(async () => {
+    if (!isRunningInWavedash || !leaderboardId) {
+      return [];
+    }
+    const response = await wavedash.getMyLeaderboardEntries(leaderboardId);
+    return response.success ? response.data : [];
+  }, [isRunningInWavedash, leaderboardId, wavedash]);
+  return {
+    isLoading,
+    leaderboard,
+    submitScore,
+    getEntryCount,
+    getEntries,
+    getEntriesAroundCurrentUser,
+    getCurrentUserEntries
+  };
+}
+function useLeaderboardEntries(leaderboardName, leaderboardEntriesOptions, leaderboardOptions) {
+  const { isLoading: isLeaderboardLoading, getEntries } = useLeaderboard(
+    leaderboardName,
+    leaderboardOptions
+  );
+  const [entries, setEntries] = (0, import_react3.useState)([]);
+  const [areEntriesLoading, setAreEntriesLoading] = (0, import_react3.useState)(true);
+  const { start, count, friendsOnly } = leaderboardEntriesOptions;
+  (0, import_react3.useEffect)(() => {
+    if (isLeaderboardLoading) {
+      return;
+    }
+    setAreEntriesLoading(true);
+    getEntries(start, count, friendsOnly).then(setEntries).finally(() => {
+      setAreEntriesLoading(false);
+    });
+  }, [isLeaderboardLoading, getEntries, start, count, friendsOnly]);
+  const isLoading = isLeaderboardLoading || areEntriesLoading;
+  return {
+    isLoading,
+    entries
+  };
+}
+function useLeaderboardCurrentUserEntries(leaderboardName, leaderboardOptions) {
+  const { isLoading: isLeaderboardLoading, getCurrentUserEntries } = useLeaderboard(leaderboardName, leaderboardOptions);
+  const [entries, setEntries] = (0, import_react3.useState)([]);
+  const [areEntriesLoading, setAreEntriesLoading] = (0, import_react3.useState)(true);
+  (0, import_react3.useEffect)(() => {
+    if (isLeaderboardLoading) {
+      return;
+    }
+    setAreEntriesLoading(true);
+    getCurrentUserEntries().then(setEntries).finally(() => {
+      setAreEntriesLoading(false);
+    });
+  }, [isLeaderboardLoading, getCurrentUserEntries]);
+  const isLoading = isLeaderboardLoading || areEntriesLoading;
+  return {
+    isLoading,
+    entries
+  };
+}
+function useLeaderboardEntriesAroundCurrentUser(leaderboardName, leaderboardEntriesOptions, leaderboardOptions) {
+  const { isLoading: isLeaderboardLoading, getEntriesAroundCurrentUser } = useLeaderboard(leaderboardName, leaderboardOptions);
+  const [entries, setEntries] = (0, import_react3.useState)([]);
+  const [areEntriesLoading, setAreEntriesLoading] = (0, import_react3.useState)(true);
+  const { countAhead, countBehind, friendsOnly } = leaderboardEntriesOptions;
+  (0, import_react3.useEffect)(() => {
+    if (isLeaderboardLoading) {
+      return;
+    }
+    setAreEntriesLoading(true);
+    getEntriesAroundCurrentUser(countAhead, countBehind, friendsOnly).then(setEntries).finally(() => {
+      setAreEntriesLoading(false);
+    });
+  }, [
+    isLeaderboardLoading,
+    getEntriesAroundCurrentUser,
+    countAhead,
+    countBehind,
+    friendsOnly
+  ]);
+  const isLoading = isLeaderboardLoading || areEntriesLoading;
+  return {
+    isLoading,
+    entries
+  };
+}
+
+// src/useStat.ts
+var import_react4 = require("react");
+function useStat(statName) {
+  const { isRunningInWavedash, wavedash } = useWavedash();
+  const [statValue, setStatValue] = (0, import_react4.useState)(null);
+  (0, import_react4.useEffect)(() => {
+    if (!isRunningInWavedash || statValue !== null) {
+      return;
+    }
+    wavedash.requestStats().then(() => {
+      const value = wavedash.getStat(statName);
+      setStatValue(value);
+    });
+  }, [isRunningInWavedash, wavedash, statName, statValue]);
+  const set = (0, import_react4.useCallback)(
+    (newValue, storeNow = true) => {
+      if (!isRunningInWavedash) {
+        return false;
+      }
+      const response = wavedash.setStat(statName, newValue, storeNow);
+      if (response) {
+        setStatValue(newValue);
+      }
+      return response;
+    },
+    [isRunningInWavedash, wavedash, statName]
+  );
+  return [statValue, set];
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  useAchievement,
+  useLeaderboard,
+  useLeaderboardCurrentUserEntries,
+  useLeaderboardEntries,
+  useLeaderboardEntriesAroundCurrentUser,
+  useStat,
+  useWavedash
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/useAchievement.ts","../src/WavedashProvider.tsx","../src/useLeaderboards.ts","../src/useStat.ts"],"sourcesContent":["export * from \"./useAchievement\";\r\nexport * from \"./useCurrentUser\";\r\nexport * from \"./useLeaderboards\";\r\nexport * from \"./useStat\";\r\nexport * from \"./UserAvatar\";\r\nexport * from \"./WavedashProvider\";\r\n","import { useCallback, useState, useEffect } from \"react\";\r\n\r\nimport { useWavedash } from \"./WavedashProvider\";\r\n\r\nexport type UseAchievementReturnValue = [\r\n  boolean | null,\r\n  unlock: (storeNow?: boolean) => boolean,\r\n];\r\n\r\nexport function useAchievement(\r\n  achievementName: string,\r\n): UseAchievementReturnValue {\r\n  const { isRunningInWavedash, wavedash } = useWavedash();\r\n\r\n  const [isUnlocked, setIsUnlocked] = useState<boolean | null>(null);\r\n\r\n  useEffect(() => {\r\n    if (!isRunningInWavedash || isUnlocked !== null) {\r\n      return;\r\n    }\r\n\r\n    wavedash.requestStats().then(() => {\r\n      const value = wavedash.getAchievement(achievementName);\r\n      setIsUnlocked(value);\r\n    });\r\n  }, [isRunningInWavedash, wavedash, achievementName, isUnlocked]);\r\n\r\n  const unlock = useCallback(\r\n    (storeNow: boolean = true): boolean => {\r\n      if (!isRunningInWavedash) {\r\n        return false;\r\n      }\r\n\r\n      const response = wavedash.setAchievement(achievementName, storeNow);\r\n\r\n      if (response) {\r\n        setIsUnlocked(true);\r\n      }\r\n\r\n      return response;\r\n    },\r\n    [isRunningInWavedash, wavedash, achievementName],\r\n  );\r\n\r\n  return [isUnlocked, unlock];\r\n}\r\n","import {\r\n  type ReactNode,\r\n  createContext,\r\n  useContext,\r\n  useEffect,\r\n  useMemo,\r\n  useCallback,\r\n  useState,\r\n} from \"react\";\r\nimport type { WavedashSDK, WavedashConfig } from \"@wvdsh/sdk-js\";\r\n\r\nexport type WavedashContextValue =\r\n  | {\r\n      isRunningInWavedash: true;\r\n      wavedash: WavedashSDK;\r\n    }\r\n  | {\r\n      isRunningInWavedash: false;\r\n      wavedash?: null;\r\n    };\r\n\r\nconst WavedashContext = createContext<WavedashContextValue>({\r\n  isRunningInWavedash: false,\r\n  wavedash: null,\r\n});\r\n\r\nexport type WavedashProviderProps = {\r\n  children: ReactNode;\r\n  preload?: Partial<Record<\"audio\" | \"image\" | \"video\", string[]>>;\r\n  config?: WavedashConfig;\r\n};\r\n\r\nexport default function WavedashProvider({\r\n  children,\r\n  preload,\r\n  config,\r\n}: WavedashProviderProps) {\r\n  const [isInit, setIsInit] = useState(false);\r\n\r\n  const contextValue: WavedashContextValue = useMemo(\r\n    () =>\r\n      typeof window !== \"undefined\" && window.Wavedash\r\n        ? {\r\n            isRunningInWavedash: true,\r\n            wavedash: window.Wavedash,\r\n          }\r\n        : {\r\n            isRunningInWavedash: false,\r\n            wavedash: null,\r\n          },\r\n    [],\r\n  );\r\n\r\n  const init = useCallback(() => {\r\n    setIsInit(true);\r\n\r\n    if (isInit || !contextValue.isRunningInWavedash) {\r\n      return;\r\n    }\r\n\r\n    contextValue.wavedash.updateLoadProgressZeroToOne(1);\r\n    contextValue.wavedash.init(config);\r\n  }, [contextValue, config, isInit, preload]);\r\n\r\n  useEffect(() => {\r\n    if (isInit || !contextValue.isRunningInWavedash) {\r\n      return;\r\n    }\r\n\r\n    const { audio = [], image = [], video = [] } = preload ?? {};\r\n    const totalCount = audio.length + image.length + video.length;\r\n    let loadedCount = 0;\r\n\r\n    if (totalCount === 0) {\r\n      init();\r\n      return;\r\n    }\r\n\r\n    const handleAssetLoad = () => {\r\n      loadedCount += 1;\r\n      contextValue.wavedash.updateLoadProgressZeroToOne(\r\n        loadedCount / totalCount,\r\n      );\r\n      if (loadedCount === totalCount) {\r\n        init();\r\n      }\r\n    };\r\n\r\n    audio.forEach((src) => {\r\n      const audioElement = new Audio(src);\r\n      audioElement.addEventListener(\"canplaythrough\", handleAssetLoad, {\r\n        once: true,\r\n      });\r\n      audioElement.addEventListener(\"error\", handleAssetLoad, { once: true });\r\n    });\r\n\r\n    image.forEach((src) => {\r\n      const img = new Image();\r\n      img.src = src;\r\n      img.addEventListener(\"load\", handleAssetLoad, { once: true });\r\n      img.addEventListener(\"error\", handleAssetLoad, { once: true });\r\n    });\r\n\r\n    video.forEach((src) => {\r\n      const videoElement = document.createElement(\"video\");\r\n      videoElement.src = src;\r\n      videoElement.addEventListener(\"canplaythrough\", handleAssetLoad, {\r\n        once: true,\r\n      });\r\n      videoElement.addEventListener(\"error\", handleAssetLoad, { once: true });\r\n    });\r\n  }, [isInit, preload, contextValue]);\r\n\r\n  return (\r\n    <WavedashContext.Provider value={contextValue}>\r\n      {isInit ? children : null}\r\n    </WavedashContext.Provider>\r\n  );\r\n}\r\n\r\nexport function useWavedash(): WavedashContextValue {\r\n  return useContext(WavedashContext);\r\n}\r\n","import { useState, useEffect, useCallback } from \"react\";\r\nimport type {\r\n  Leaderboard,\r\n  LeaderboardSortOrder,\r\n  LeaderboardDisplayType,\r\n  Id,\r\n  LeaderboardEntries,\r\n  UpsertedLeaderboardEntry,\r\n} from \"@wvdsh/sdk-js\";\r\n\r\nimport { useWavedash } from \"./WavedashProvider\";\r\n\r\nexport type UseLeaderBoardReturnValue = {\r\n  isLoading: boolean;\r\n  leaderboard: Leaderboard | null;\r\n  submitScore: (\r\n    score: number,\r\n    keepBest?: boolean,\r\n    ugcId?: Id<\"userGeneratedContent\">,\r\n  ) => Promise<UpsertedLeaderboardEntry | null>;\r\n  getEntryCount: () => number;\r\n  getEntries: (\r\n    start: number,\r\n    count: number,\r\n    friendsOnly?: boolean,\r\n  ) => Promise<LeaderboardEntries>;\r\n  getEntriesAroundCurrentUser: (\r\n    countAhead: number,\r\n    countBehind: number,\r\n    friendsOnly?: boolean,\r\n  ) => Promise<LeaderboardEntries>;\r\n  getCurrentUserEntries: () => Promise<LeaderboardEntries>;\r\n};\r\n\r\nexport type LeaderboardOptions = {\r\n  sortOrder?: LeaderboardSortOrder;\r\n  displayType?: LeaderboardDisplayType;\r\n};\r\n\r\nexport function useLeaderboard(\r\n  leaderboardName: string,\r\n  leaderboardOptions?: LeaderboardOptions,\r\n): UseLeaderBoardReturnValue {\r\n  const [leaderboard, setLeaderboard] = useState<Leaderboard | null>(null);\r\n  const [isLoading, setIsLoading] = useState(true);\r\n  const { isRunningInWavedash, wavedash } = useWavedash();\r\n\r\n  const { sortOrder, displayType } = leaderboardOptions ?? {};\r\n\r\n  useEffect(() => {\r\n    if (!isRunningInWavedash) {\r\n      setIsLoading(false);\r\n      return;\r\n    }\r\n\r\n    setIsLoading(true);\r\n\r\n    wavedash\r\n      .getOrCreateLeaderboard(\r\n        leaderboardName,\r\n        sortOrder ?? wavedash.LeaderboardSortOrder.DESC,\r\n        displayType ?? wavedash.LeaderboardDisplayType.NUMERIC,\r\n      )\r\n      .then((result) => {\r\n        if (result.success) {\r\n          setLeaderboard(result.data);\r\n        }\r\n      })\r\n      .finally(() => {\r\n        setIsLoading(false);\r\n      });\r\n  }, [isRunningInWavedash, wavedash, leaderboardName, sortOrder, displayType]);\r\n\r\n  const leaderboardId = leaderboard?.id;\r\n\r\n  const submitScore = useCallback(\r\n    async (\r\n      score: number,\r\n      keepBest: boolean = true,\r\n      ugcId?: Id<\"userGeneratedContent\">,\r\n    ): Promise<UpsertedLeaderboardEntry | null> => {\r\n      if (!isRunningInWavedash || !leaderboardId) {\r\n        return null;\r\n      }\r\n\r\n      const response = await wavedash.uploadLeaderboardScore(\r\n        leaderboardId,\r\n        score,\r\n        keepBest,\r\n        ugcId,\r\n      );\r\n\r\n      return response.success ? response.data : null;\r\n    },\r\n    [isRunningInWavedash, leaderboardId, wavedash],\r\n  );\r\n\r\n  const getEntryCount = useCallback((): number => {\r\n    if (!isRunningInWavedash || !leaderboardId) {\r\n      return -1;\r\n    }\r\n\r\n    return wavedash.getLeaderboardEntryCount(leaderboardId);\r\n  }, [isRunningInWavedash, leaderboardId, wavedash]);\r\n\r\n  const getEntries = useCallback(\r\n    async (\r\n      start: number,\r\n      count: number,\r\n      friendsOnly?: boolean,\r\n    ): Promise<LeaderboardEntries> => {\r\n      if (!isRunningInWavedash || !leaderboardId) {\r\n        return [];\r\n      }\r\n\r\n      const response = await wavedash.listLeaderboardEntries(\r\n        leaderboardId,\r\n        start,\r\n        count,\r\n        friendsOnly,\r\n      );\r\n\r\n      return response.success ? response.data : [];\r\n    },\r\n    [isRunningInWavedash, leaderboardId, wavedash],\r\n  );\r\n\r\n  const getEntriesAroundCurrentUser = useCallback(\r\n    async (\r\n      countAhead: number,\r\n      countBehind: number,\r\n      friendsOnly?: boolean,\r\n    ): Promise<LeaderboardEntries> => {\r\n      if (!isRunningInWavedash || !leaderboardId) {\r\n        return [];\r\n      }\r\n\r\n      const response = await wavedash.listLeaderboardEntriesAroundUser(\r\n        leaderboardId,\r\n        countAhead,\r\n        countBehind,\r\n        friendsOnly,\r\n      );\r\n\r\n      return response.success ? response.data : [];\r\n    },\r\n    [isRunningInWavedash, leaderboardId, wavedash],\r\n  );\r\n\r\n  const getCurrentUserEntries =\r\n    useCallback(async (): Promise<LeaderboardEntries> => {\r\n      if (!isRunningInWavedash || !leaderboardId) {\r\n        return [];\r\n      }\r\n\r\n      const response = await wavedash.getMyLeaderboardEntries(leaderboardId);\r\n      return response.success ? response.data : [];\r\n    }, [isRunningInWavedash, leaderboardId, wavedash]);\r\n\r\n  return {\r\n    isLoading,\r\n    leaderboard,\r\n    submitScore,\r\n    getEntryCount,\r\n    getEntries,\r\n    getEntriesAroundCurrentUser,\r\n    getCurrentUserEntries,\r\n  };\r\n}\r\n\r\nexport type LeaderboardAllEntriesOptions = {\r\n  start: number;\r\n  count: number;\r\n  friendsOnly?: boolean;\r\n};\r\n\r\nexport type LeaderboardAroundCurrentUserEntriesOptions = {\r\n  countAhead: number;\r\n  countBehind: number;\r\n  friendsOnly?: boolean;\r\n};\r\n\r\nexport function useLeaderboardEntries(\r\n  leaderboardName: string,\r\n  leaderboardEntriesOptions: LeaderboardAllEntriesOptions,\r\n  leaderboardOptions?: LeaderboardOptions,\r\n): { isLoading: boolean; entries: LeaderboardEntries } {\r\n  const { isLoading: isLeaderboardLoading, getEntries } = useLeaderboard(\r\n    leaderboardName,\r\n    leaderboardOptions,\r\n  );\r\n  const [entries, setEntries] = useState<LeaderboardEntries>([]);\r\n\r\n  const [areEntriesLoading, setAreEntriesLoading] = useState(true);\r\n\r\n  const { start, count, friendsOnly } = leaderboardEntriesOptions;\r\n\r\n  useEffect(() => {\r\n    if (isLeaderboardLoading) {\r\n      return;\r\n    }\r\n\r\n    setAreEntriesLoading(true);\r\n\r\n    getEntries(start, count, friendsOnly)\r\n      .then(setEntries)\r\n      .finally(() => {\r\n        setAreEntriesLoading(false);\r\n      });\r\n  }, [isLeaderboardLoading, getEntries, start, count, friendsOnly]);\r\n\r\n  const isLoading = isLeaderboardLoading || areEntriesLoading;\r\n\r\n  return {\r\n    isLoading,\r\n    entries,\r\n  };\r\n}\r\n\r\nexport function useLeaderboardCurrentUserEntries(\r\n  leaderboardName: string,\r\n  leaderboardOptions?: LeaderboardOptions,\r\n): { isLoading: boolean; entries: LeaderboardEntries } {\r\n  const { isLoading: isLeaderboardLoading, getCurrentUserEntries } =\r\n    useLeaderboard(leaderboardName, leaderboardOptions);\r\n  const [entries, setEntries] = useState<LeaderboardEntries>([]);\r\n  const [areEntriesLoading, setAreEntriesLoading] = useState(true);\r\n\r\n  useEffect(() => {\r\n    if (isLeaderboardLoading) {\r\n      return;\r\n    }\r\n\r\n    setAreEntriesLoading(true);\r\n    getCurrentUserEntries()\r\n      .then(setEntries)\r\n      .finally(() => {\r\n        setAreEntriesLoading(false);\r\n      });\r\n  }, [isLeaderboardLoading, getCurrentUserEntries]);\r\n\r\n  const isLoading = isLeaderboardLoading || areEntriesLoading;\r\n\r\n  return {\r\n    isLoading,\r\n    entries,\r\n  };\r\n}\r\n\r\nexport function useLeaderboardEntriesAroundCurrentUser(\r\n  leaderboardName: string,\r\n  leaderboardEntriesOptions: LeaderboardAroundCurrentUserEntriesOptions,\r\n  leaderboardOptions?: LeaderboardOptions,\r\n): { isLoading: boolean; entries: LeaderboardEntries } {\r\n  const { isLoading: isLeaderboardLoading, getEntriesAroundCurrentUser } =\r\n    useLeaderboard(leaderboardName, leaderboardOptions);\r\n  const [entries, setEntries] = useState<LeaderboardEntries>([]);\r\n  const [areEntriesLoading, setAreEntriesLoading] = useState(true);\r\n\r\n  const { countAhead, countBehind, friendsOnly } = leaderboardEntriesOptions;\r\n\r\n  useEffect(() => {\r\n    if (isLeaderboardLoading) {\r\n      return;\r\n    }\r\n\r\n    setAreEntriesLoading(true);\r\n    getEntriesAroundCurrentUser(countAhead, countBehind, friendsOnly)\r\n      .then(setEntries)\r\n      .finally(() => {\r\n        setAreEntriesLoading(false);\r\n      });\r\n  }, [\r\n    isLeaderboardLoading,\r\n    getEntriesAroundCurrentUser,\r\n    countAhead,\r\n    countBehind,\r\n    friendsOnly,\r\n  ]);\r\n\r\n  const isLoading = isLeaderboardLoading || areEntriesLoading;\r\n\r\n  return {\r\n    isLoading,\r\n    entries,\r\n  };\r\n}\r\n","import { useCallback, useState, useEffect } from \"react\";\r\n\r\nimport { useWavedash } from \"./WavedashProvider\";\r\n\r\nexport type UseStatReturnValue = [\r\n  number | null,\r\n  (newValue: number, storeNow?: boolean) => boolean,\r\n];\r\n\r\nexport function useStat(statName: string): UseStatReturnValue {\r\n  const { isRunningInWavedash, wavedash } = useWavedash();\r\n\r\n  const [statValue, setStatValue] = useState<number | null>(null);\r\n\r\n  useEffect(() => {\r\n    if (!isRunningInWavedash || statValue !== null) {\r\n      return;\r\n    }\r\n\r\n    wavedash.requestStats().then(() => {\r\n      const value = wavedash.getStat(statName);\r\n      setStatValue(value);\r\n    });\r\n  }, [isRunningInWavedash, wavedash, statName, statValue]);\r\n\r\n  const set = useCallback(\r\n    (newValue: number, storeNow: boolean = true): boolean => {\r\n      if (!isRunningInWavedash) {\r\n        return false;\r\n      }\r\n\r\n      const response = wavedash.setStat(statName, newValue, storeNow);\r\n\r\n      if (response) {\r\n        setStatValue(newValue);\r\n      }\r\n\r\n      return response;\r\n    },\r\n    [isRunningInWavedash, wavedash, statName],\r\n  );\r\n\r\n  return [statValue, set];\r\n}\r\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,IAAAA,gBAAiD;;;ACAjD,mBAQO;AA0GH;AA7FJ,IAAM,sBAAkB,4BAAoC;AAAA,EAC1D,qBAAqB;AAAA,EACrB,UAAU;AACZ,CAAC;AAgGM,SAAS,cAAoC;AAClD,aAAO,yBAAW,eAAe;AACnC;;;ADjHO,SAAS,eACd,iBAC2B;AAC3B,QAAM,EAAE,qBAAqB,SAAS,IAAI,YAAY;AAEtD,QAAM,CAAC,YAAY,aAAa,QAAI,wBAAyB,IAAI;AAEjE,+BAAU,MAAM;AACd,QAAI,CAAC,uBAAuB,eAAe,MAAM;AAC/C;AAAA,IACF;AAEA,aAAS,aAAa,EAAE,KAAK,MAAM;AACjC,YAAM,QAAQ,SAAS,eAAe,eAAe;AACrD,oBAAc,KAAK;AAAA,IACrB,CAAC;AAAA,EACH,GAAG,CAAC,qBAAqB,UAAU,iBAAiB,UAAU,CAAC;AAE/D,QAAM,aAAS;AAAA,IACb,CAAC,WAAoB,SAAkB;AACrC,UAAI,CAAC,qBAAqB;AACxB,eAAO;AAAA,MACT;AAEA,YAAM,WAAW,SAAS,eAAe,iBAAiB,QAAQ;AAElE,UAAI,UAAU;AACZ,sBAAc,IAAI;AAAA,MACpB;AAEA,aAAO;AAAA,IACT;AAAA,IACA,CAAC,qBAAqB,UAAU,eAAe;AAAA,EACjD;AAEA,SAAO,CAAC,YAAY,MAAM;AAC5B;;;AE7CA,IAAAC,gBAAiD;AAuC1C,SAAS,eACd,iBACA,oBAC2B;AAC3B,QAAM,CAAC,aAAa,cAAc,QAAI,wBAA6B,IAAI;AACvE,QAAM,CAAC,WAAW,YAAY,QAAI,wBAAS,IAAI;AAC/C,QAAM,EAAE,qBAAqB,SAAS,IAAI,YAAY;AAEtD,QAAM,EAAE,WAAW,YAAY,IAAI,sBAAsB,CAAC;AAE1D,+BAAU,MAAM;AACd,QAAI,CAAC,qBAAqB;AACxB,mBAAa,KAAK;AAClB;AAAA,IACF;AAEA,iBAAa,IAAI;AAEjB,aACG;AAAA,MACC;AAAA,MACA,aAAa,SAAS,qBAAqB;AAAA,MAC3C,eAAe,SAAS,uBAAuB;AAAA,IACjD,EACC,KAAK,CAAC,WAAW;AAChB,UAAI,OAAO,SAAS;AAClB,uBAAe,OAAO,IAAI;AAAA,MAC5B;AAAA,IACF,CAAC,EACA,QAAQ,MAAM;AACb,mBAAa,KAAK;AAAA,IACpB,CAAC;AAAA,EACL,GAAG,CAAC,qBAAqB,UAAU,iBAAiB,WAAW,WAAW,CAAC;AAE3E,QAAM,gBAAgB,aAAa;AAEnC,QAAM,kBAAc;AAAA,IAClB,OACE,OACA,WAAoB,MACpB,UAC6C;AAC7C,UAAI,CAAC,uBAAuB,CAAC,eAAe;AAC1C,eAAO;AAAA,MACT;AAEA,YAAM,WAAW,MAAM,SAAS;AAAA,QAC9B;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAEA,aAAO,SAAS,UAAU,SAAS,OAAO;AAAA,IAC5C;AAAA,IACA,CAAC,qBAAqB,eAAe,QAAQ;AAAA,EAC/C;AAEA,QAAM,oBAAgB,2BAAY,MAAc;AAC9C,QAAI,CAAC,uBAAuB,CAAC,eAAe;AAC1C,aAAO;AAAA,IACT;AAEA,WAAO,SAAS,yBAAyB,aAAa;AAAA,EACxD,GAAG,CAAC,qBAAqB,eAAe,QAAQ,CAAC;AAEjD,QAAM,iBAAa;AAAA,IACjB,OACE,OACA,OACA,gBACgC;AAChC,UAAI,CAAC,uBAAuB,CAAC,eAAe;AAC1C,eAAO,CAAC;AAAA,MACV;AAEA,YAAM,WAAW,MAAM,SAAS;AAAA,QAC9B;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAEA,aAAO,SAAS,UAAU,SAAS,OAAO,CAAC;AAAA,IAC7C;AAAA,IACA,CAAC,qBAAqB,eAAe,QAAQ;AAAA,EAC/C;AAEA,QAAM,kCAA8B;AAAA,IAClC,OACE,YACA,aACA,gBACgC;AAChC,UAAI,CAAC,uBAAuB,CAAC,eAAe;AAC1C,eAAO,CAAC;AAAA,MACV;AAEA,YAAM,WAAW,MAAM,SAAS;AAAA,QAC9B;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAEA,aAAO,SAAS,UAAU,SAAS,OAAO,CAAC;AAAA,IAC7C;AAAA,IACA,CAAC,qBAAqB,eAAe,QAAQ;AAAA,EAC/C;AAEA,QAAM,4BACJ,2BAAY,YAAyC;AACnD,QAAI,CAAC,uBAAuB,CAAC,eAAe;AAC1C,aAAO,CAAC;AAAA,IACV;AAEA,UAAM,WAAW,MAAM,SAAS,wBAAwB,aAAa;AACrE,WAAO,SAAS,UAAU,SAAS,OAAO,CAAC;AAAA,EAC7C,GAAG,CAAC,qBAAqB,eAAe,QAAQ,CAAC;AAEnD,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;AAcO,SAAS,sBACd,iBACA,2BACA,oBACqD;AACrD,QAAM,EAAE,WAAW,sBAAsB,WAAW,IAAI;AAAA,IACtD;AAAA,IACA;AAAA,EACF;AACA,QAAM,CAAC,SAAS,UAAU,QAAI,wBAA6B,CAAC,CAAC;AAE7D,QAAM,CAAC,mBAAmB,oBAAoB,QAAI,wBAAS,IAAI;AAE/D,QAAM,EAAE,OAAO,OAAO,YAAY,IAAI;AAEtC,+BAAU,MAAM;AACd,QAAI,sBAAsB;AACxB;AAAA,IACF;AAEA,yBAAqB,IAAI;AAEzB,eAAW,OAAO,OAAO,WAAW,EACjC,KAAK,UAAU,EACf,QAAQ,MAAM;AACb,2BAAqB,KAAK;AAAA,IAC5B,CAAC;AAAA,EACL,GAAG,CAAC,sBAAsB,YAAY,OAAO,OAAO,WAAW,CAAC;AAEhE,QAAM,YAAY,wBAAwB;AAE1C,SAAO;AAAA,IACL;AAAA,IACA;AAAA,EACF;AACF;AAEO,SAAS,iCACd,iBACA,oBACqD;AACrD,QAAM,EAAE,WAAW,sBAAsB,sBAAsB,IAC7D,eAAe,iBAAiB,kBAAkB;AACpD,QAAM,CAAC,SAAS,UAAU,QAAI,wBAA6B,CAAC,CAAC;AAC7D,QAAM,CAAC,mBAAmB,oBAAoB,QAAI,wBAAS,IAAI;AAE/D,+BAAU,MAAM;AACd,QAAI,sBAAsB;AACxB;AAAA,IACF;AAEA,yBAAqB,IAAI;AACzB,0BAAsB,EACnB,KAAK,UAAU,EACf,QAAQ,MAAM;AACb,2BAAqB,KAAK;AAAA,IAC5B,CAAC;AAAA,EACL,GAAG,CAAC,sBAAsB,qBAAqB,CAAC;AAEhD,QAAM,YAAY,wBAAwB;AAE1C,SAAO;AAAA,IACL;AAAA,IACA;AAAA,EACF;AACF;AAEO,SAAS,uCACd,iBACA,2BACA,oBACqD;AACrD,QAAM,EAAE,WAAW,sBAAsB,4BAA4B,IACnE,eAAe,iBAAiB,kBAAkB;AACpD,QAAM,CAAC,SAAS,UAAU,QAAI,wBAA6B,CAAC,CAAC;AAC7D,QAAM,CAAC,mBAAmB,oBAAoB,QAAI,wBAAS,IAAI;AAE/D,QAAM,EAAE,YAAY,aAAa,YAAY,IAAI;AAEjD,+BAAU,MAAM;AACd,QAAI,sBAAsB;AACxB;AAAA,IACF;AAEA,yBAAqB,IAAI;AACzB,gCAA4B,YAAY,aAAa,WAAW,EAC7D,KAAK,UAAU,EACf,QAAQ,MAAM;AACb,2BAAqB,KAAK;AAAA,IAC5B,CAAC;AAAA,EACL,GAAG;AAAA,IACD;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AAED,QAAM,YAAY,wBAAwB;AAE1C,SAAO;AAAA,IACL;AAAA,IACA;AAAA,EACF;AACF;;;AC9RA,IAAAC,gBAAiD;AAS1C,SAAS,QAAQ,UAAsC;AAC5D,QAAM,EAAE,qBAAqB,SAAS,IAAI,YAAY;AAEtD,QAAM,CAAC,WAAW,YAAY,QAAI,wBAAwB,IAAI;AAE9D,+BAAU,MAAM;AACd,QAAI,CAAC,uBAAuB,cAAc,MAAM;AAC9C;AAAA,IACF;AAEA,aAAS,aAAa,EAAE,KAAK,MAAM;AACjC,YAAM,QAAQ,SAAS,QAAQ,QAAQ;AACvC,mBAAa,KAAK;AAAA,IACpB,CAAC;AAAA,EACH,GAAG,CAAC,qBAAqB,UAAU,UAAU,SAAS,CAAC;AAEvD,QAAM,UAAM;AAAA,IACV,CAAC,UAAkB,WAAoB,SAAkB;AACvD,UAAI,CAAC,qBAAqB;AACxB,eAAO;AAAA,MACT;AAEA,YAAM,WAAW,SAAS,QAAQ,UAAU,UAAU,QAAQ;AAE9D,UAAI,UAAU;AACZ,qBAAa,QAAQ;AAAA,MACvB;AAEA,aAAO;AAAA,IACT;AAAA,IACA,CAAC,qBAAqB,UAAU,QAAQ;AAAA,EAC1C;AAEA,SAAO,CAAC,WAAW,GAAG;AACxB;","names":["import_react","import_react","import_react"]}

package/dist/index.d.cts

@@ -0,0 +1,73 @@
+import { LeaderboardSortOrder, LeaderboardDisplayType, Leaderboard, Id, UpsertedLeaderboardEntry, LeaderboardEntries, WavedashSDK, WavedashConfig } from '@wvdsh/sdk-js';
+import { ReactNode } from 'react';
+
+type UseAchievementReturnValue = [
+    boolean | null,
+    unlock: (storeNow?: boolean) => boolean
+];
+declare function useAchievement(achievementName: string): UseAchievementReturnValue;
+
+type UseLeaderBoardReturnValue = {
+    isLoading: boolean;
+    leaderboard: Leaderboard | null;
+    submitScore: (score: number, keepBest?: boolean, ugcId?: Id<"userGeneratedContent">) => Promise<UpsertedLeaderboardEntry | null>;
+    getEntryCount: () => number;
+    getEntries: (start: number, count: number, friendsOnly?: boolean) => Promise<LeaderboardEntries>;
+    getEntriesAroundCurrentUser: (countAhead: number, countBehind: number, friendsOnly?: boolean) => Promise<LeaderboardEntries>;
+    getCurrentUserEntries: () => Promise<LeaderboardEntries>;
+};
+type LeaderboardOptions = {
+    sortOrder?: LeaderboardSortOrder;
+    displayType?: LeaderboardDisplayType;
+};
+declare function useLeaderboard(leaderboardName: string, leaderboardOptions?: LeaderboardOptions): UseLeaderBoardReturnValue;
+type LeaderboardAllEntriesOptions = {
+    start: number;
+    count: number;
+    friendsOnly?: boolean;
+};
+type LeaderboardAroundCurrentUserEntriesOptions = {
+    countAhead: number;
+    countBehind: number;
+    friendsOnly?: boolean;
+};
+declare function useLeaderboardEntries(leaderboardName: string, leaderboardEntriesOptions: LeaderboardAllEntriesOptions, leaderboardOptions?: LeaderboardOptions): {
+    isLoading: boolean;
+    entries: LeaderboardEntries;
+};
+declare function useLeaderboardCurrentUserEntries(leaderboardName: string, leaderboardOptions?: LeaderboardOptions): {
+    isLoading: boolean;
+    entries: LeaderboardEntries;
+};
+declare function useLeaderboardEntriesAroundCurrentUser(leaderboardName: string, leaderboardEntriesOptions: LeaderboardAroundCurrentUserEntriesOptions, leaderboardOptions?: LeaderboardOptions): {
+    isLoading: boolean;
+    entries: LeaderboardEntries;
+};
+
+type UseStatReturnValue = [
+    number | null,
+    (newValue: number, storeNow?: boolean) => boolean
+];
+declare function useStat(statName: string): UseStatReturnValue;
+
+type UserAvatarProps = {
+    userId?: Id<"users">;
+    size?: number;
+    defaultAvatar?: ReactNode;
+};
+
+type WavedashContextValue = {
+    isRunningInWavedash: true;
+    wavedash: WavedashSDK;
+} | {
+    isRunningInWavedash: false;
+    wavedash?: null;
+};
+type WavedashProviderProps = {
+    children: ReactNode;
+    preload?: Partial<Record<"audio" | "image" | "video", string[]>>;
+    config?: WavedashConfig;
+};
+declare function useWavedash(): WavedashContextValue;
+
+export { type LeaderboardAllEntriesOptions, type LeaderboardAroundCurrentUserEntriesOptions, type LeaderboardOptions, type UseAchievementReturnValue, type UseLeaderBoardReturnValue, type UseStatReturnValue, type UserAvatarProps, type WavedashContextValue, type WavedashProviderProps, useAchievement, useLeaderboard, useLeaderboardCurrentUserEntries, useLeaderboardEntries, useLeaderboardEntriesAroundCurrentUser, useStat, useWavedash };

package/dist/index.d.ts

@@ -0,0 +1,73 @@
+import { LeaderboardSortOrder, LeaderboardDisplayType, Leaderboard, Id, UpsertedLeaderboardEntry, LeaderboardEntries, WavedashSDK, WavedashConfig } from '@wvdsh/sdk-js';
+import { ReactNode } from 'react';
+
+type UseAchievementReturnValue = [
+    boolean | null,
+    unlock: (storeNow?: boolean) => boolean
+];
+declare function useAchievement(achievementName: string): UseAchievementReturnValue;
+
+type UseLeaderBoardReturnValue = {
+    isLoading: boolean;
+    leaderboard: Leaderboard | null;
+    submitScore: (score: number, keepBest?: boolean, ugcId?: Id<"userGeneratedContent">) => Promise<UpsertedLeaderboardEntry | null>;
+    getEntryCount: () => number;
+    getEntries: (start: number, count: number, friendsOnly?: boolean) => Promise<LeaderboardEntries>;
+    getEntriesAroundCurrentUser: (countAhead: number, countBehind: number, friendsOnly?: boolean) => Promise<LeaderboardEntries>;
+    getCurrentUserEntries: () => Promise<LeaderboardEntries>;
+};
+type LeaderboardOptions = {
+    sortOrder?: LeaderboardSortOrder;
+    displayType?: LeaderboardDisplayType;
+};
+declare function useLeaderboard(leaderboardName: string, leaderboardOptions?: LeaderboardOptions): UseLeaderBoardReturnValue;
+type LeaderboardAllEntriesOptions = {
+    start: number;
+    count: number;
+    friendsOnly?: boolean;
+};
+type LeaderboardAroundCurrentUserEntriesOptions = {
+    countAhead: number;
+    countBehind: number;
+    friendsOnly?: boolean;
+};
+declare function useLeaderboardEntries(leaderboardName: string, leaderboardEntriesOptions: LeaderboardAllEntriesOptions, leaderboardOptions?: LeaderboardOptions): {
+    isLoading: boolean;
+    entries: LeaderboardEntries;
+};
+declare function useLeaderboardCurrentUserEntries(leaderboardName: string, leaderboardOptions?: LeaderboardOptions): {
+    isLoading: boolean;
+    entries: LeaderboardEntries;
+};
+declare function useLeaderboardEntriesAroundCurrentUser(leaderboardName: string, leaderboardEntriesOptions: LeaderboardAroundCurrentUserEntriesOptions, leaderboardOptions?: LeaderboardOptions): {
+    isLoading: boolean;
+    entries: LeaderboardEntries;
+};
+
+type UseStatReturnValue = [
+    number | null,
+    (newValue: number, storeNow?: boolean) => boolean
+];
+declare function useStat(statName: string): UseStatReturnValue;
+
+type UserAvatarProps = {
+    userId?: Id<"users">;
+    size?: number;
+    defaultAvatar?: ReactNode;
+};
+
+type WavedashContextValue = {
+    isRunningInWavedash: true;
+    wavedash: WavedashSDK;
+} | {
+    isRunningInWavedash: false;
+    wavedash?: null;
+};
+type WavedashProviderProps = {
+    children: ReactNode;
+    preload?: Partial<Record<"audio" | "image" | "video", string[]>>;
+    config?: WavedashConfig;
+};
+declare function useWavedash(): WavedashContextValue;
+
+export { type LeaderboardAllEntriesOptions, type LeaderboardAroundCurrentUserEntriesOptions, type LeaderboardOptions, type UseAchievementReturnValue, type UseLeaderBoardReturnValue, type UseStatReturnValue, type UserAvatarProps, type WavedashContextValue, type WavedashProviderProps, useAchievement, useLeaderboard, useLeaderboardCurrentUserEntries, useLeaderboardEntries, useLeaderboardEntriesAroundCurrentUser, useStat, useWavedash };

package/dist/index.js

@@ -0,0 +1,252 @@
+// src/useAchievement.ts
+import { useCallback as useCallback2, useState as useState2, useEffect as useEffect2 } from "react";
+
+// src/WavedashProvider.tsx
+import {
+  createContext,
+  useContext,
+  useEffect,
+  useMemo,
+  useCallback,
+  useState
+} from "react";
+import { jsx } from "react/jsx-runtime";
+var WavedashContext = createContext({
+  isRunningInWavedash: false,
+  wavedash: null
+});
+function useWavedash() {
+  return useContext(WavedashContext);
+}
+
+// src/useAchievement.ts
+function useAchievement(achievementName) {
+  const { isRunningInWavedash, wavedash } = useWavedash();
+  const [isUnlocked, setIsUnlocked] = useState2(null);
+  useEffect2(() => {
+    if (!isRunningInWavedash || isUnlocked !== null) {
+      return;
+    }
+    wavedash.requestStats().then(() => {
+      const value = wavedash.getAchievement(achievementName);
+      setIsUnlocked(value);
+    });
+  }, [isRunningInWavedash, wavedash, achievementName, isUnlocked]);
+  const unlock = useCallback2(
+    (storeNow = true) => {
+      if (!isRunningInWavedash) {
+        return false;
+      }
+      const response = wavedash.setAchievement(achievementName, storeNow);
+      if (response) {
+        setIsUnlocked(true);
+      }
+      return response;
+    },
+    [isRunningInWavedash, wavedash, achievementName]
+  );
+  return [isUnlocked, unlock];
+}
+
+// src/useLeaderboards.ts
+import { useState as useState3, useEffect as useEffect3, useCallback as useCallback3 } from "react";
+function useLeaderboard(leaderboardName, leaderboardOptions) {
+  const [leaderboard, setLeaderboard] = useState3(null);
+  const [isLoading, setIsLoading] = useState3(true);
+  const { isRunningInWavedash, wavedash } = useWavedash();
+  const { sortOrder, displayType } = leaderboardOptions ?? {};
+  useEffect3(() => {
+    if (!isRunningInWavedash) {
+      setIsLoading(false);
+      return;
+    }
+    setIsLoading(true);
+    wavedash.getOrCreateLeaderboard(
+      leaderboardName,
+      sortOrder ?? wavedash.LeaderboardSortOrder.DESC,
+      displayType ?? wavedash.LeaderboardDisplayType.NUMERIC
+    ).then((result) => {
+      if (result.success) {
+        setLeaderboard(result.data);
+      }
+    }).finally(() => {
+      setIsLoading(false);
+    });
+  }, [isRunningInWavedash, wavedash, leaderboardName, sortOrder, displayType]);
+  const leaderboardId = leaderboard?.id;
+  const submitScore = useCallback3(
+    async (score, keepBest = true, ugcId) => {
+      if (!isRunningInWavedash || !leaderboardId) {
+        return null;
+      }
+      const response = await wavedash.uploadLeaderboardScore(
+        leaderboardId,
+        score,
+        keepBest,
+        ugcId
+      );
+      return response.success ? response.data : null;
+    },
+    [isRunningInWavedash, leaderboardId, wavedash]
+  );
+  const getEntryCount = useCallback3(() => {
+    if (!isRunningInWavedash || !leaderboardId) {
+      return -1;
+    }
+    return wavedash.getLeaderboardEntryCount(leaderboardId);
+  }, [isRunningInWavedash, leaderboardId, wavedash]);
+  const getEntries = useCallback3(
+    async (start, count, friendsOnly) => {
+      if (!isRunningInWavedash || !leaderboardId) {
+        return [];
+      }
+      const response = await wavedash.listLeaderboardEntries(
+        leaderboardId,
+        start,
+        count,
+        friendsOnly
+      );
+      return response.success ? response.data : [];
+    },
+    [isRunningInWavedash, leaderboardId, wavedash]
+  );
+  const getEntriesAroundCurrentUser = useCallback3(
+    async (countAhead, countBehind, friendsOnly) => {
+      if (!isRunningInWavedash || !leaderboardId) {
+        return [];
+      }
+      const response = await wavedash.listLeaderboardEntriesAroundUser(
+        leaderboardId,
+        countAhead,
+        countBehind,
+        friendsOnly
+      );
+      return response.success ? response.data : [];
+    },
+    [isRunningInWavedash, leaderboardId, wavedash]
+  );
+  const getCurrentUserEntries = useCallback3(async () => {
+    if (!isRunningInWavedash || !leaderboardId) {
+      return [];
+    }
+    const response = await wavedash.getMyLeaderboardEntries(leaderboardId);
+    return response.success ? response.data : [];
+  }, [isRunningInWavedash, leaderboardId, wavedash]);
+  return {
+    isLoading,
+    leaderboard,
+    submitScore,
+    getEntryCount,
+    getEntries,
+    getEntriesAroundCurrentUser,
+    getCurrentUserEntries
+  };
+}
+function useLeaderboardEntries(leaderboardName, leaderboardEntriesOptions, leaderboardOptions) {
+  const { isLoading: isLeaderboardLoading, getEntries } = useLeaderboard(
+    leaderboardName,
+    leaderboardOptions
+  );
+  const [entries, setEntries] = useState3([]);
+  const [areEntriesLoading, setAreEntriesLoading] = useState3(true);
+  const { start, count, friendsOnly } = leaderboardEntriesOptions;
+  useEffect3(() => {
+    if (isLeaderboardLoading) {
+      return;
+    }
+    setAreEntriesLoading(true);
+    getEntries(start, count, friendsOnly).then(setEntries).finally(() => {
+      setAreEntriesLoading(false);
+    });
+  }, [isLeaderboardLoading, getEntries, start, count, friendsOnly]);
+  const isLoading = isLeaderboardLoading || areEntriesLoading;
+  return {
+    isLoading,
+    entries
+  };
+}
+function useLeaderboardCurrentUserEntries(leaderboardName, leaderboardOptions) {
+  const { isLoading: isLeaderboardLoading, getCurrentUserEntries } = useLeaderboard(leaderboardName, leaderboardOptions);
+  const [entries, setEntries] = useState3([]);
+  const [areEntriesLoading, setAreEntriesLoading] = useState3(true);
+  useEffect3(() => {
+    if (isLeaderboardLoading) {
+      return;
+    }
+    setAreEntriesLoading(true);
+    getCurrentUserEntries().then(setEntries).finally(() => {
+      setAreEntriesLoading(false);
+    });
+  }, [isLeaderboardLoading, getCurrentUserEntries]);
+  const isLoading = isLeaderboardLoading || areEntriesLoading;
+  return {
+    isLoading,
+    entries
+  };
+}
+function useLeaderboardEntriesAroundCurrentUser(leaderboardName, leaderboardEntriesOptions, leaderboardOptions) {
+  const { isLoading: isLeaderboardLoading, getEntriesAroundCurrentUser } = useLeaderboard(leaderboardName, leaderboardOptions);
+  const [entries, setEntries] = useState3([]);
+  const [areEntriesLoading, setAreEntriesLoading] = useState3(true);
+  const { countAhead, countBehind, friendsOnly } = leaderboardEntriesOptions;
+  useEffect3(() => {
+    if (isLeaderboardLoading) {
+      return;
+    }
+    setAreEntriesLoading(true);
+    getEntriesAroundCurrentUser(countAhead, countBehind, friendsOnly).then(setEntries).finally(() => {
+      setAreEntriesLoading(false);
+    });
+  }, [
+    isLeaderboardLoading,
+    getEntriesAroundCurrentUser,
+    countAhead,
+    countBehind,
+    friendsOnly
+  ]);
+  const isLoading = isLeaderboardLoading || areEntriesLoading;
+  return {
+    isLoading,
+    entries
+  };
+}
+
+// src/useStat.ts
+import { useCallback as useCallback4, useState as useState4, useEffect as useEffect4 } from "react";
+function useStat(statName) {
+  const { isRunningInWavedash, wavedash } = useWavedash();
+  const [statValue, setStatValue] = useState4(null);
+  useEffect4(() => {
+    if (!isRunningInWavedash || statValue !== null) {
+      return;
+    }
+    wavedash.requestStats().then(() => {
+      const value = wavedash.getStat(statName);
+      setStatValue(value);
+    });
+  }, [isRunningInWavedash, wavedash, statName, statValue]);
+  const set = useCallback4(
+    (newValue, storeNow = true) => {
+      if (!isRunningInWavedash) {
+        return false;
+      }
+      const response = wavedash.setStat(statName, newValue, storeNow);
+      if (response) {
+        setStatValue(newValue);
+      }
+      return response;
+    },
+    [isRunningInWavedash, wavedash, statName]
+  );
+  return [statValue, set];
+}
+export {
+  useAchievement,
+  useLeaderboard,
+  useLeaderboardCurrentUserEntries,
+  useLeaderboardEntries,
+  useLeaderboardEntriesAroundCurrentUser,
+  useStat,
+  useWavedash
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/useAchievement.ts","../src/WavedashProvider.tsx","../src/useLeaderboards.ts","../src/useStat.ts"],"sourcesContent":["import { useCallback, useState, useEffect } from \"react\";\r\n\r\nimport { useWavedash } from \"./WavedashProvider\";\r\n\r\nexport type UseAchievementReturnValue = [\r\n  boolean | null,\r\n  unlock: (storeNow?: boolean) => boolean,\r\n];\r\n\r\nexport function useAchievement(\r\n  achievementName: string,\r\n): UseAchievementReturnValue {\r\n  const { isRunningInWavedash, wavedash } = useWavedash();\r\n\r\n  const [isUnlocked, setIsUnlocked] = useState<boolean | null>(null);\r\n\r\n  useEffect(() => {\r\n    if (!isRunningInWavedash || isUnlocked !== null) {\r\n      return;\r\n    }\r\n\r\n    wavedash.requestStats().then(() => {\r\n      const value = wavedash.getAchievement(achievementName);\r\n      setIsUnlocked(value);\r\n    });\r\n  }, [isRunningInWavedash, wavedash, achievementName, isUnlocked]);\r\n\r\n  const unlock = useCallback(\r\n    (storeNow: boolean = true): boolean => {\r\n      if (!isRunningInWavedash) {\r\n        return false;\r\n      }\r\n\r\n      const response = wavedash.setAchievement(achievementName, storeNow);\r\n\r\n      if (response) {\r\n        setIsUnlocked(true);\r\n      }\r\n\r\n      return response;\r\n    },\r\n    [isRunningInWavedash, wavedash, achievementName],\r\n  );\r\n\r\n  return [isUnlocked, unlock];\r\n}\r\n","import {\r\n  type ReactNode,\r\n  createContext,\r\n  useContext,\r\n  useEffect,\r\n  useMemo,\r\n  useCallback,\r\n  useState,\r\n} from \"react\";\r\nimport type { WavedashSDK, WavedashConfig } from \"@wvdsh/sdk-js\";\r\n\r\nexport type WavedashContextValue =\r\n  | {\r\n      isRunningInWavedash: true;\r\n      wavedash: WavedashSDK;\r\n    }\r\n  | {\r\n      isRunningInWavedash: false;\r\n      wavedash?: null;\r\n    };\r\n\r\nconst WavedashContext = createContext<WavedashContextValue>({\r\n  isRunningInWavedash: false,\r\n  wavedash: null,\r\n});\r\n\r\nexport type WavedashProviderProps = {\r\n  children: ReactNode;\r\n  preload?: Partial<Record<\"audio\" | \"image\" | \"video\", string[]>>;\r\n  config?: WavedashConfig;\r\n};\r\n\r\nexport default function WavedashProvider({\r\n  children,\r\n  preload,\r\n  config,\r\n}: WavedashProviderProps) {\r\n  const [isInit, setIsInit] = useState(false);\r\n\r\n  const contextValue: WavedashContextValue = useMemo(\r\n    () =>\r\n      typeof window !== \"undefined\" && window.Wavedash\r\n        ? {\r\n            isRunningInWavedash: true,\r\n            wavedash: window.Wavedash,\r\n          }\r\n        : {\r\n            isRunningInWavedash: false,\r\n            wavedash: null,\r\n          },\r\n    [],\r\n  );\r\n\r\n  const init = useCallback(() => {\r\n    setIsInit(true);\r\n\r\n    if (isInit || !contextValue.isRunningInWavedash) {\r\n      return;\r\n    }\r\n\r\n    contextValue.wavedash.updateLoadProgressZeroToOne(1);\r\n    contextValue.wavedash.init(config);\r\n  }, [contextValue, config, isInit, preload]);\r\n\r\n  useEffect(() => {\r\n    if (isInit || !contextValue.isRunningInWavedash) {\r\n      return;\r\n    }\r\n\r\n    const { audio = [], image = [], video = [] } = preload ?? {};\r\n    const totalCount = audio.length + image.length + video.length;\r\n    let loadedCount = 0;\r\n\r\n    if (totalCount === 0) {\r\n      init();\r\n      return;\r\n    }\r\n\r\n    const handleAssetLoad = () => {\r\n      loadedCount += 1;\r\n      contextValue.wavedash.updateLoadProgressZeroToOne(\r\n        loadedCount / totalCount,\r\n      );\r\n      if (loadedCount === totalCount) {\r\n        init();\r\n      }\r\n    };\r\n\r\n    audio.forEach((src) => {\r\n      const audioElement = new Audio(src);\r\n      audioElement.addEventListener(\"canplaythrough\", handleAssetLoad, {\r\n        once: true,\r\n      });\r\n      audioElement.addEventListener(\"error\", handleAssetLoad, { once: true });\r\n    });\r\n\r\n    image.forEach((src) => {\r\n      const img = new Image();\r\n      img.src = src;\r\n      img.addEventListener(\"load\", handleAssetLoad, { once: true });\r\n      img.addEventListener(\"error\", handleAssetLoad, { once: true });\r\n    });\r\n\r\n    video.forEach((src) => {\r\n      const videoElement = document.createElement(\"video\");\r\n      videoElement.src = src;\r\n      videoElement.addEventListener(\"canplaythrough\", handleAssetLoad, {\r\n        once: true,\r\n      });\r\n      videoElement.addEventListener(\"error\", handleAssetLoad, { once: true });\r\n    });\r\n  }, [isInit, preload, contextValue]);\r\n\r\n  return (\r\n    <WavedashContext.Provider value={contextValue}>\r\n      {isInit ? children : null}\r\n    </WavedashContext.Provider>\r\n  );\r\n}\r\n\r\nexport function useWavedash(): WavedashContextValue {\r\n  return useContext(WavedashContext);\r\n}\r\n","import { useState, useEffect, useCallback } from \"react\";\r\nimport type {\r\n  Leaderboard,\r\n  LeaderboardSortOrder,\r\n  LeaderboardDisplayType,\r\n  Id,\r\n  LeaderboardEntries,\r\n  UpsertedLeaderboardEntry,\r\n} from \"@wvdsh/sdk-js\";\r\n\r\nimport { useWavedash } from \"./WavedashProvider\";\r\n\r\nexport type UseLeaderBoardReturnValue = {\r\n  isLoading: boolean;\r\n  leaderboard: Leaderboard | null;\r\n  submitScore: (\r\n    score: number,\r\n    keepBest?: boolean,\r\n    ugcId?: Id<\"userGeneratedContent\">,\r\n  ) => Promise<UpsertedLeaderboardEntry | null>;\r\n  getEntryCount: () => number;\r\n  getEntries: (\r\n    start: number,\r\n    count: number,\r\n    friendsOnly?: boolean,\r\n  ) => Promise<LeaderboardEntries>;\r\n  getEntriesAroundCurrentUser: (\r\n    countAhead: number,\r\n    countBehind: number,\r\n    friendsOnly?: boolean,\r\n  ) => Promise<LeaderboardEntries>;\r\n  getCurrentUserEntries: () => Promise<LeaderboardEntries>;\r\n};\r\n\r\nexport type LeaderboardOptions = {\r\n  sortOrder?: LeaderboardSortOrder;\r\n  displayType?: LeaderboardDisplayType;\r\n};\r\n\r\nexport function useLeaderboard(\r\n  leaderboardName: string,\r\n  leaderboardOptions?: LeaderboardOptions,\r\n): UseLeaderBoardReturnValue {\r\n  const [leaderboard, setLeaderboard] = useState<Leaderboard | null>(null);\r\n  const [isLoading, setIsLoading] = useState(true);\r\n  const { isRunningInWavedash, wavedash } = useWavedash();\r\n\r\n  const { sortOrder, displayType } = leaderboardOptions ?? {};\r\n\r\n  useEffect(() => {\r\n    if (!isRunningInWavedash) {\r\n      setIsLoading(false);\r\n      return;\r\n    }\r\n\r\n    setIsLoading(true);\r\n\r\n    wavedash\r\n      .getOrCreateLeaderboard(\r\n        leaderboardName,\r\n        sortOrder ?? wavedash.LeaderboardSortOrder.DESC,\r\n        displayType ?? wavedash.LeaderboardDisplayType.NUMERIC,\r\n      )\r\n      .then((result) => {\r\n        if (result.success) {\r\n          setLeaderboard(result.data);\r\n        }\r\n      })\r\n      .finally(() => {\r\n        setIsLoading(false);\r\n      });\r\n  }, [isRunningInWavedash, wavedash, leaderboardName, sortOrder, displayType]);\r\n\r\n  const leaderboardId = leaderboard?.id;\r\n\r\n  const submitScore = useCallback(\r\n    async (\r\n      score: number,\r\n      keepBest: boolean = true,\r\n      ugcId?: Id<\"userGeneratedContent\">,\r\n    ): Promise<UpsertedLeaderboardEntry | null> => {\r\n      if (!isRunningInWavedash || !leaderboardId) {\r\n        return null;\r\n      }\r\n\r\n      const response = await wavedash.uploadLeaderboardScore(\r\n        leaderboardId,\r\n        score,\r\n        keepBest,\r\n        ugcId,\r\n      );\r\n\r\n      return response.success ? response.data : null;\r\n    },\r\n    [isRunningInWavedash, leaderboardId, wavedash],\r\n  );\r\n\r\n  const getEntryCount = useCallback((): number => {\r\n    if (!isRunningInWavedash || !leaderboardId) {\r\n      return -1;\r\n    }\r\n\r\n    return wavedash.getLeaderboardEntryCount(leaderboardId);\r\n  }, [isRunningInWavedash, leaderboardId, wavedash]);\r\n\r\n  const getEntries = useCallback(\r\n    async (\r\n      start: number,\r\n      count: number,\r\n      friendsOnly?: boolean,\r\n    ): Promise<LeaderboardEntries> => {\r\n      if (!isRunningInWavedash || !leaderboardId) {\r\n        return [];\r\n      }\r\n\r\n      const response = await wavedash.listLeaderboardEntries(\r\n        leaderboardId,\r\n        start,\r\n        count,\r\n        friendsOnly,\r\n      );\r\n\r\n      return response.success ? response.data : [];\r\n    },\r\n    [isRunningInWavedash, leaderboardId, wavedash],\r\n  );\r\n\r\n  const getEntriesAroundCurrentUser = useCallback(\r\n    async (\r\n      countAhead: number,\r\n      countBehind: number,\r\n      friendsOnly?: boolean,\r\n    ): Promise<LeaderboardEntries> => {\r\n      if (!isRunningInWavedash || !leaderboardId) {\r\n        return [];\r\n      }\r\n\r\n      const response = await wavedash.listLeaderboardEntriesAroundUser(\r\n        leaderboardId,\r\n        countAhead,\r\n        countBehind,\r\n        friendsOnly,\r\n      );\r\n\r\n      return response.success ? response.data : [];\r\n    },\r\n    [isRunningInWavedash, leaderboardId, wavedash],\r\n  );\r\n\r\n  const getCurrentUserEntries =\r\n    useCallback(async (): Promise<LeaderboardEntries> => {\r\n      if (!isRunningInWavedash || !leaderboardId) {\r\n        return [];\r\n      }\r\n\r\n      const response = await wavedash.getMyLeaderboardEntries(leaderboardId);\r\n      return response.success ? response.data : [];\r\n    }, [isRunningInWavedash, leaderboardId, wavedash]);\r\n\r\n  return {\r\n    isLoading,\r\n    leaderboard,\r\n    submitScore,\r\n    getEntryCount,\r\n    getEntries,\r\n    getEntriesAroundCurrentUser,\r\n    getCurrentUserEntries,\r\n  };\r\n}\r\n\r\nexport type LeaderboardAllEntriesOptions = {\r\n  start: number;\r\n  count: number;\r\n  friendsOnly?: boolean;\r\n};\r\n\r\nexport type LeaderboardAroundCurrentUserEntriesOptions = {\r\n  countAhead: number;\r\n  countBehind: number;\r\n  friendsOnly?: boolean;\r\n};\r\n\r\nexport function useLeaderboardEntries(\r\n  leaderboardName: string,\r\n  leaderboardEntriesOptions: LeaderboardAllEntriesOptions,\r\n  leaderboardOptions?: LeaderboardOptions,\r\n): { isLoading: boolean; entries: LeaderboardEntries } {\r\n  const { isLoading: isLeaderboardLoading, getEntries } = useLeaderboard(\r\n    leaderboardName,\r\n    leaderboardOptions,\r\n  );\r\n  const [entries, setEntries] = useState<LeaderboardEntries>([]);\r\n\r\n  const [areEntriesLoading, setAreEntriesLoading] = useState(true);\r\n\r\n  const { start, count, friendsOnly } = leaderboardEntriesOptions;\r\n\r\n  useEffect(() => {\r\n    if (isLeaderboardLoading) {\r\n      return;\r\n    }\r\n\r\n    setAreEntriesLoading(true);\r\n\r\n    getEntries(start, count, friendsOnly)\r\n      .then(setEntries)\r\n      .finally(() => {\r\n        setAreEntriesLoading(false);\r\n      });\r\n  }, [isLeaderboardLoading, getEntries, start, count, friendsOnly]);\r\n\r\n  const isLoading = isLeaderboardLoading || areEntriesLoading;\r\n\r\n  return {\r\n    isLoading,\r\n    entries,\r\n  };\r\n}\r\n\r\nexport function useLeaderboardCurrentUserEntries(\r\n  leaderboardName: string,\r\n  leaderboardOptions?: LeaderboardOptions,\r\n): { isLoading: boolean; entries: LeaderboardEntries } {\r\n  const { isLoading: isLeaderboardLoading, getCurrentUserEntries } =\r\n    useLeaderboard(leaderboardName, leaderboardOptions);\r\n  const [entries, setEntries] = useState<LeaderboardEntries>([]);\r\n  const [areEntriesLoading, setAreEntriesLoading] = useState(true);\r\n\r\n  useEffect(() => {\r\n    if (isLeaderboardLoading) {\r\n      return;\r\n    }\r\n\r\n    setAreEntriesLoading(true);\r\n    getCurrentUserEntries()\r\n      .then(setEntries)\r\n      .finally(() => {\r\n        setAreEntriesLoading(false);\r\n      });\r\n  }, [isLeaderboardLoading, getCurrentUserEntries]);\r\n\r\n  const isLoading = isLeaderboardLoading || areEntriesLoading;\r\n\r\n  return {\r\n    isLoading,\r\n    entries,\r\n  };\r\n}\r\n\r\nexport function useLeaderboardEntriesAroundCurrentUser(\r\n  leaderboardName: string,\r\n  leaderboardEntriesOptions: LeaderboardAroundCurrentUserEntriesOptions,\r\n  leaderboardOptions?: LeaderboardOptions,\r\n): { isLoading: boolean; entries: LeaderboardEntries } {\r\n  const { isLoading: isLeaderboardLoading, getEntriesAroundCurrentUser } =\r\n    useLeaderboard(leaderboardName, leaderboardOptions);\r\n  const [entries, setEntries] = useState<LeaderboardEntries>([]);\r\n  const [areEntriesLoading, setAreEntriesLoading] = useState(true);\r\n\r\n  const { countAhead, countBehind, friendsOnly } = leaderboardEntriesOptions;\r\n\r\n  useEffect(() => {\r\n    if (isLeaderboardLoading) {\r\n      return;\r\n    }\r\n\r\n    setAreEntriesLoading(true);\r\n    getEntriesAroundCurrentUser(countAhead, countBehind, friendsOnly)\r\n      .then(setEntries)\r\n      .finally(() => {\r\n        setAreEntriesLoading(false);\r\n      });\r\n  }, [\r\n    isLeaderboardLoading,\r\n    getEntriesAroundCurrentUser,\r\n    countAhead,\r\n    countBehind,\r\n    friendsOnly,\r\n  ]);\r\n\r\n  const isLoading = isLeaderboardLoading || areEntriesLoading;\r\n\r\n  return {\r\n    isLoading,\r\n    entries,\r\n  };\r\n}\r\n","import { useCallback, useState, useEffect } from \"react\";\r\n\r\nimport { useWavedash } from \"./WavedashProvider\";\r\n\r\nexport type UseStatReturnValue = [\r\n  number | null,\r\n  (newValue: number, storeNow?: boolean) => boolean,\r\n];\r\n\r\nexport function useStat(statName: string): UseStatReturnValue {\r\n  const { isRunningInWavedash, wavedash } = useWavedash();\r\n\r\n  const [statValue, setStatValue] = useState<number | null>(null);\r\n\r\n  useEffect(() => {\r\n    if (!isRunningInWavedash || statValue !== null) {\r\n      return;\r\n    }\r\n\r\n    wavedash.requestStats().then(() => {\r\n      const value = wavedash.getStat(statName);\r\n      setStatValue(value);\r\n    });\r\n  }, [isRunningInWavedash, wavedash, statName, statValue]);\r\n\r\n  const set = useCallback(\r\n    (newValue: number, storeNow: boolean = true): boolean => {\r\n      if (!isRunningInWavedash) {\r\n        return false;\r\n      }\r\n\r\n      const response = wavedash.setStat(statName, newValue, storeNow);\r\n\r\n      if (response) {\r\n        setStatValue(newValue);\r\n      }\r\n\r\n      return response;\r\n    },\r\n    [isRunningInWavedash, wavedash, statName],\r\n  );\r\n\r\n  return [statValue, set];\r\n}\r\n"],"mappings":";AAAA,SAAS,eAAAA,cAAa,YAAAC,WAAU,aAAAC,kBAAiB;;;ACAjD;AAAA,EAEE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AA0GH;AA7FJ,IAAM,kBAAkB,cAAoC;AAAA,EAC1D,qBAAqB;AAAA,EACrB,UAAU;AACZ,CAAC;AAgGM,SAAS,cAAoC;AAClD,SAAO,WAAW,eAAe;AACnC;;;ADjHO,SAAS,eACd,iBAC2B;AAC3B,QAAM,EAAE,qBAAqB,SAAS,IAAI,YAAY;AAEtD,QAAM,CAAC,YAAY,aAAa,IAAIC,UAAyB,IAAI;AAEjE,EAAAC,WAAU,MAAM;AACd,QAAI,CAAC,uBAAuB,eAAe,MAAM;AAC/C;AAAA,IACF;AAEA,aAAS,aAAa,EAAE,KAAK,MAAM;AACjC,YAAM,QAAQ,SAAS,eAAe,eAAe;AACrD,oBAAc,KAAK;AAAA,IACrB,CAAC;AAAA,EACH,GAAG,CAAC,qBAAqB,UAAU,iBAAiB,UAAU,CAAC;AAE/D,QAAM,SAASC;AAAA,IACb,CAAC,WAAoB,SAAkB;AACrC,UAAI,CAAC,qBAAqB;AACxB,eAAO;AAAA,MACT;AAEA,YAAM,WAAW,SAAS,eAAe,iBAAiB,QAAQ;AAElE,UAAI,UAAU;AACZ,sBAAc,IAAI;AAAA,MACpB;AAEA,aAAO;AAAA,IACT;AAAA,IACA,CAAC,qBAAqB,UAAU,eAAe;AAAA,EACjD;AAEA,SAAO,CAAC,YAAY,MAAM;AAC5B;;;AE7CA,SAAS,YAAAC,WAAU,aAAAC,YAAW,eAAAC,oBAAmB;AAuC1C,SAAS,eACd,iBACA,oBAC2B;AAC3B,QAAM,CAAC,aAAa,cAAc,IAAIC,UAA6B,IAAI;AACvE,QAAM,CAAC,WAAW,YAAY,IAAIA,UAAS,IAAI;AAC/C,QAAM,EAAE,qBAAqB,SAAS,IAAI,YAAY;AAEtD,QAAM,EAAE,WAAW,YAAY,IAAI,sBAAsB,CAAC;AAE1D,EAAAC,WAAU,MAAM;AACd,QAAI,CAAC,qBAAqB;AACxB,mBAAa,KAAK;AAClB;AAAA,IACF;AAEA,iBAAa,IAAI;AAEjB,aACG;AAAA,MACC;AAAA,MACA,aAAa,SAAS,qBAAqB;AAAA,MAC3C,eAAe,SAAS,uBAAuB;AAAA,IACjD,EACC,KAAK,CAAC,WAAW;AAChB,UAAI,OAAO,SAAS;AAClB,uBAAe,OAAO,IAAI;AAAA,MAC5B;AAAA,IACF,CAAC,EACA,QAAQ,MAAM;AACb,mBAAa,KAAK;AAAA,IACpB,CAAC;AAAA,EACL,GAAG,CAAC,qBAAqB,UAAU,iBAAiB,WAAW,WAAW,CAAC;AAE3E,QAAM,gBAAgB,aAAa;AAEnC,QAAM,cAAcC;AAAA,IAClB,OACE,OACA,WAAoB,MACpB,UAC6C;AAC7C,UAAI,CAAC,uBAAuB,CAAC,eAAe;AAC1C,eAAO;AAAA,MACT;AAEA,YAAM,WAAW,MAAM,SAAS;AAAA,QAC9B;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAEA,aAAO,SAAS,UAAU,SAAS,OAAO;AAAA,IAC5C;AAAA,IACA,CAAC,qBAAqB,eAAe,QAAQ;AAAA,EAC/C;AAEA,QAAM,gBAAgBA,aAAY,MAAc;AAC9C,QAAI,CAAC,uBAAuB,CAAC,eAAe;AAC1C,aAAO;AAAA,IACT;AAEA,WAAO,SAAS,yBAAyB,aAAa;AAAA,EACxD,GAAG,CAAC,qBAAqB,eAAe,QAAQ,CAAC;AAEjD,QAAM,aAAaA;AAAA,IACjB,OACE,OACA,OACA,gBACgC;AAChC,UAAI,CAAC,uBAAuB,CAAC,eAAe;AAC1C,eAAO,CAAC;AAAA,MACV;AAEA,YAAM,WAAW,MAAM,SAAS;AAAA,QAC9B;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAEA,aAAO,SAAS,UAAU,SAAS,OAAO,CAAC;AAAA,IAC7C;AAAA,IACA,CAAC,qBAAqB,eAAe,QAAQ;AAAA,EAC/C;AAEA,QAAM,8BAA8BA;AAAA,IAClC,OACE,YACA,aACA,gBACgC;AAChC,UAAI,CAAC,uBAAuB,CAAC,eAAe;AAC1C,eAAO,CAAC;AAAA,MACV;AAEA,YAAM,WAAW,MAAM,SAAS;AAAA,QAC9B;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAEA,aAAO,SAAS,UAAU,SAAS,OAAO,CAAC;AAAA,IAC7C;AAAA,IACA,CAAC,qBAAqB,eAAe,QAAQ;AAAA,EAC/C;AAEA,QAAM,wBACJA,aAAY,YAAyC;AACnD,QAAI,CAAC,uBAAuB,CAAC,eAAe;AAC1C,aAAO,CAAC;AAAA,IACV;AAEA,UAAM,WAAW,MAAM,SAAS,wBAAwB,aAAa;AACrE,WAAO,SAAS,UAAU,SAAS,OAAO,CAAC;AAAA,EAC7C,GAAG,CAAC,qBAAqB,eAAe,QAAQ,CAAC;AAEnD,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;AAcO,SAAS,sBACd,iBACA,2BACA,oBACqD;AACrD,QAAM,EAAE,WAAW,sBAAsB,WAAW,IAAI;AAAA,IACtD;AAAA,IACA;AAAA,EACF;AACA,QAAM,CAAC,SAAS,UAAU,IAAIF,UAA6B,CAAC,CAAC;AAE7D,QAAM,CAAC,mBAAmB,oBAAoB,IAAIA,UAAS,IAAI;AAE/D,QAAM,EAAE,OAAO,OAAO,YAAY,IAAI;AAEtC,EAAAC,WAAU,MAAM;AACd,QAAI,sBAAsB;AACxB;AAAA,IACF;AAEA,yBAAqB,IAAI;AAEzB,eAAW,OAAO,OAAO,WAAW,EACjC,KAAK,UAAU,EACf,QAAQ,MAAM;AACb,2BAAqB,KAAK;AAAA,IAC5B,CAAC;AAAA,EACL,GAAG,CAAC,sBAAsB,YAAY,OAAO,OAAO,WAAW,CAAC;AAEhE,QAAM,YAAY,wBAAwB;AAE1C,SAAO;AAAA,IACL;AAAA,IACA;AAAA,EACF;AACF;AAEO,SAAS,iCACd,iBACA,oBACqD;AACrD,QAAM,EAAE,WAAW,sBAAsB,sBAAsB,IAC7D,eAAe,iBAAiB,kBAAkB;AACpD,QAAM,CAAC,SAAS,UAAU,IAAID,UAA6B,CAAC,CAAC;AAC7D,QAAM,CAAC,mBAAmB,oBAAoB,IAAIA,UAAS,IAAI;AAE/D,EAAAC,WAAU,MAAM;AACd,QAAI,sBAAsB;AACxB;AAAA,IACF;AAEA,yBAAqB,IAAI;AACzB,0BAAsB,EACnB,KAAK,UAAU,EACf,QAAQ,MAAM;AACb,2BAAqB,KAAK;AAAA,IAC5B,CAAC;AAAA,EACL,GAAG,CAAC,sBAAsB,qBAAqB,CAAC;AAEhD,QAAM,YAAY,wBAAwB;AAE1C,SAAO;AAAA,IACL;AAAA,IACA;AAAA,EACF;AACF;AAEO,SAAS,uCACd,iBACA,2BACA,oBACqD;AACrD,QAAM,EAAE,WAAW,sBAAsB,4BAA4B,IACnE,eAAe,iBAAiB,kBAAkB;AACpD,QAAM,CAAC,SAAS,UAAU,IAAID,UAA6B,CAAC,CAAC;AAC7D,QAAM,CAAC,mBAAmB,oBAAoB,IAAIA,UAAS,IAAI;AAE/D,QAAM,EAAE,YAAY,aAAa,YAAY,IAAI;AAEjD,EAAAC,WAAU,MAAM;AACd,QAAI,sBAAsB;AACxB;AAAA,IACF;AAEA,yBAAqB,IAAI;AACzB,gCAA4B,YAAY,aAAa,WAAW,EAC7D,KAAK,UAAU,EACf,QAAQ,MAAM;AACb,2BAAqB,KAAK;AAAA,IAC5B,CAAC;AAAA,EACL,GAAG;AAAA,IACD;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AAED,QAAM,YAAY,wBAAwB;AAE1C,SAAO;AAAA,IACL;AAAA,IACA;AAAA,EACF;AACF;;;AC9RA,SAAS,eAAAE,cAAa,YAAAC,WAAU,aAAAC,kBAAiB;AAS1C,SAAS,QAAQ,UAAsC;AAC5D,QAAM,EAAE,qBAAqB,SAAS,IAAI,YAAY;AAEtD,QAAM,CAAC,WAAW,YAAY,IAAIC,UAAwB,IAAI;AAE9D,EAAAC,WAAU,MAAM;AACd,QAAI,CAAC,uBAAuB,cAAc,MAAM;AAC9C;AAAA,IACF;AAEA,aAAS,aAAa,EAAE,KAAK,MAAM;AACjC,YAAM,QAAQ,SAAS,QAAQ,QAAQ;AACvC,mBAAa,KAAK;AAAA,IACpB,CAAC;AAAA,EACH,GAAG,CAAC,qBAAqB,UAAU,UAAU,SAAS,CAAC;AAEvD,QAAM,MAAMC;AAAA,IACV,CAAC,UAAkB,WAAoB,SAAkB;AACvD,UAAI,CAAC,qBAAqB;AACxB,eAAO;AAAA,MACT;AAEA,YAAM,WAAW,SAAS,QAAQ,UAAU,UAAU,QAAQ;AAE9D,UAAI,UAAU;AACZ,qBAAa,QAAQ;AAAA,MACvB;AAEA,aAAO;AAAA,IACT;AAAA,IACA,CAAC,qBAAqB,UAAU,QAAQ;AAAA,EAC1C;AAEA,SAAO,CAAC,WAAW,GAAG;AACxB;","names":["useCallback","useState","useEffect","useState","useEffect","useCallback","useState","useEffect","useCallback","useState","useEffect","useCallback","useCallback","useState","useEffect","useState","useEffect","useCallback"]}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "wavedash-react",
+  "version": "0.1.0",
+  "description": "React wrapper for Wavedash",
+  "main": "./dist/index.cjs",
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "clean": "rimraf dist",
+    "prepublishOnly": "npm run build",
+    "typecheck": "tsc --noEmit"
+  },
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/react": "^19.2.14",
+    "react": "^19.2.6",
+    "@wvdsh/sdk-js": "^1.3.6",
+    "rimraf": "^6.1.3",
+    "tsup": "^8.5.1",
+    "typescript": "^6.0.3"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "react",
+    "wavedash",
+    "wrapper",
+    "typescript"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "peerDependencies": {
+    "react": ">=18",
+    "@wvdsh/sdk-js": "^1.3.6"
+  }
+}