@yaasl/react 0.11.0-alpha.1 → 0.11.0-alpha.3

package/dist/@types/useAtom.d.ts

@@ -1,29 +1,31 @@
 import type { Stateful } from "@yaasl/core";
-/** Use an atom's value in the react lifecycle.
+/** Use an atom's value in the React lifecycle.
  *
  * @param atom Atom to be used.
+ * @param getServerSnapshot Function to retrieve a value that should be used for SSR.
  *
  * @returns The atom's value.
  **/
-export declare const useAtomValue: <ValueType>(atom: Stateful<ValueType>) => ValueType;
-/** Set an atom's value in the react lifecycle.
+export declare const useAtomValue: <ValueType>(atom: Stateful<ValueType>, getServerSnapshot?: () => ValueType) => ValueType;
+/** Set an atom's value in the React lifecycle.
  *
  * @param atom Atom to be used.
  *
  * @returns A setter function for the atom.
  **/
 export declare const useSetAtom: <ValueType>(atom: Stateful<ValueType>) => (next: import("react").SetStateAction<ValueType>) => void;
-/** Use an atom's initialization state in the react lifecycle.
+/** Use an atom's initialization state in the React lifecycle.
  *
  *  @param atom Atom to be used.
  *
  *  @returns A boolean indicating if the atom has finished initializing yet.
  **/
 export declare const useAtomDidInit: <ValueType>(atom: Stateful<ValueType>) => boolean;
-/** Use an atom's value and setter in the react lifecycle.
+/** Use an atom's value and setter in the React lifecycle.
  *
  * @param atom Atom to be used.
+ * @param getServerSnapshot Function to retrieve a value that should be used for SSR.
  *
  * @returns [value, setValue, didInit]
  **/
-export declare const useAtom: <ValueType>(atom: Stateful<ValueType>) => readonly [ValueType, (next: import("react").SetStateAction<ValueType>) => void, boolean];
+export declare const useAtom: <ValueType>(atom: Stateful<ValueType>, getServerSnapshot?: () => ValueType) => readonly [ValueType, (next: import("react").SetStateAction<ValueType>) => void, boolean];

package/dist/@types/useStateful.d.ts

@@ -1,4 +1,4 @@
 import { SetStateAction } from "react";
-import type { Stateful } from "@yaasl/core";
-export declare const useStatefulValue: <ValueType>(stateful: Stateful<ValueType>) => ValueType;
+import { Stateful } from "@yaasl/core";
+export declare const useStatefulValue: <ValueType>(stateful: Stateful<ValueType>, getServerSnapshot?: () => ValueType) => ValueType;
 export declare const useSetStateful: <ValueType>(stateful: Stateful<ValueType>) => (next: SetStateAction<ValueType>) => void;

package/dist/cjs/useAtom.js

@@ -3,15 +3,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.useAtom = exports.useAtomDidInit = exports.useSetAtom = exports.useAtomValue = void 0;
 const react_1 = require("react");
 const useStateful_1 = require("./useStateful");
-/** Use an atom's value in the react lifecycle.
+/** Use an atom's value in the React lifecycle.
  *
  * @param atom Atom to be used.
+ * @param getServerSnapshot Function to retrieve a value that should be used for SSR.
  *
  * @returns The atom's value.
  **/
-const useAtomValue = (atom) => (0, useStateful_1.useStatefulValue)(atom);
+const useAtomValue = (atom, getServerSnapshot) => (0, useStateful_1.useStatefulValue)(atom, getServerSnapshot);
 exports.useAtomValue = useAtomValue;
-/** Set an atom's value in the react lifecycle.
+/** Set an atom's value in the React lifecycle.
  *
  * @param atom Atom to be used.
  *
@@ -19,7 +20,7 @@ exports.useAtomValue = useAtomValue;
  **/
 const useSetAtom = (atom) => (0, useStateful_1.useSetStateful)(atom);
 exports.useSetAtom = useSetAtom;
-/** Use an atom's initialization state in the react lifecycle.
+/** Use an atom's initialization state in the React lifecycle.
  *
  *  @param atom Atom to be used.
  *
@@ -35,14 +36,15 @@ const useAtomDidInit = (atom) => {
     return didInit;
 };
 exports.useAtomDidInit = useAtomDidInit;
-/** Use an atom's value and setter in the react lifecycle.
+/** Use an atom's value and setter in the React lifecycle.
  *
  * @param atom Atom to be used.
+ * @param getServerSnapshot Function to retrieve a value that should be used for SSR.
  *
  * @returns [value, setValue, didInit]
  **/
-const useAtom = (atom) => {
-    const state = (0, exports.useAtomValue)(atom);
+const useAtom = (atom, getServerSnapshot) => {
+    const state = (0, exports.useAtomValue)(atom, getServerSnapshot);
     const setState = (0, exports.useSetAtom)(atom);
     const didInit = (0, exports.useAtomDidInit)(atom);
     return [state, setState, didInit];

package/dist/cjs/useStateful.js

@@ -3,12 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.useSetStateful = exports.useStatefulValue = void 0;
 const react_1 = require("react");
 const utils_1 = require("@yaasl/utils");
-const useStatefulValue = (stateful) => (0, react_1.useSyncExternalStore)(set => stateful.subscribe(set), () => stateful.get());
+const useStatefulValue = (stateful, getServerSnapshot = () => stateful.get()) => (0, react_1.useSyncExternalStore)(set => stateful.subscribe(set), () => stateful.get(), getServerSnapshot);
 exports.useStatefulValue = useStatefulValue;
 const useSetStateful = (stateful) => (0, react_1.useCallback)((next) => {
     if (!("set" in stateful) || !(stateful.set instanceof Function)) {
         throw new Error((0, utils_1.consoleMessage)("Atom does not have a set method"));
     }
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-call
     stateful.set(next);
 }, [stateful]);
 exports.useSetStateful = useSetStateful;

package/dist/esm/useAtom.js

@@ -1,20 +1,21 @@
 import { useState, useEffect } from "react";
 import { useSetStateful, useStatefulValue } from "./useStateful";
-/** Use an atom's value in the react lifecycle.
+/** Use an atom's value in the React lifecycle.
  *
  * @param atom Atom to be used.
+ * @param getServerSnapshot Function to retrieve a value that should be used for SSR.
  *
  * @returns The atom's value.
  **/
-export const useAtomValue = (atom) => useStatefulValue(atom);
-/** Set an atom's value in the react lifecycle.
+export const useAtomValue = (atom, getServerSnapshot) => useStatefulValue(atom, getServerSnapshot);
+/** Set an atom's value in the React lifecycle.
  *
  * @param atom Atom to be used.
  *
  * @returns A setter function for the atom.
  **/
 export const useSetAtom = (atom) => useSetStateful(atom);
-/** Use an atom's initialization state in the react lifecycle.
+/** Use an atom's initialization state in the React lifecycle.
  *
  *  @param atom Atom to be used.
  *
@@ -29,14 +30,15 @@ export const useAtomDidInit = (atom) => {
     }, [atom.didInit]);
     return didInit;
 };
-/** Use an atom's value and setter in the react lifecycle.
+/** Use an atom's value and setter in the React lifecycle.
  *
  * @param atom Atom to be used.
+ * @param getServerSnapshot Function to retrieve a value that should be used for SSR.
  *
  * @returns [value, setValue, didInit]
  **/
-export const useAtom = (atom) => {
-    const state = useAtomValue(atom);
+export const useAtom = (atom, getServerSnapshot) => {
+    const state = useAtomValue(atom, getServerSnapshot);
     const setState = useSetAtom(atom);
     const didInit = useAtomDidInit(atom);
     return [state, setState, didInit];

package/dist/esm/useStateful.js

@@ -1,9 +1,10 @@
 import { useCallback, useSyncExternalStore } from "react";
 import { consoleMessage } from "@yaasl/utils";
-export const useStatefulValue = (stateful) => useSyncExternalStore(set => stateful.subscribe(set), () => stateful.get());
+export const useStatefulValue = (stateful, getServerSnapshot = () => stateful.get()) => useSyncExternalStore(set => stateful.subscribe(set), () => stateful.get(), getServerSnapshot);
 export const useSetStateful = (stateful) => useCallback((next) => {
     if (!("set" in stateful) || !(stateful.set instanceof Function)) {
         throw new Error(consoleMessage("Atom does not have a set method"));
     }
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-call
     stateful.set(next);
 }, [stateful]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yaasl/react",
-  "version": "0.11.0-alpha.1",
+  "version": "0.11.0-alpha.3",
   "description": "yet another atomic store library (react)",
   "author": "PrettyCoffee",
   "license": "MIT",
@@ -40,23 +40,18 @@
     "validate": "run-s lint test build"
   },
   "peerDependencies": {
-    "react": ">=17"
+    "react": "^18.0.0 || ^19.0.0"
   },
   "dependencies": {
-    "@yaasl/core": "0.11.0-alpha.1",
-    "@yaasl/utils": "0.11.0-alpha.1"
+    "@yaasl/core": "0.11.0-alpha.3",
+    "@yaasl/utils": "0.11.0-alpha.3"
   },
   "devDependencies": {
-    "@testing-library/react": "^14.3.1",
-    "@types/react": "^18.3.12",
+    "@testing-library/react": "^16.2.0",
+    "@types/react": "^18.3.18",
+    "react-dom": "^18.3.1",
     "react": "^18.3.1"
   },
-  "eslintConfig": {
-    "extends": [
-      "../../.eslintrc",
-      "@pretty-cozy/eslint-config/react"
-    ]
-  },
   "lint-staged": {
     "*.{ts,tsx}": [
       "npm run lint:fix"

package/tsconfig.json

@@ -1,3 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-}

package/tsconfig.node.json

@@ -1,9 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "include": ["./src"],
-  "exclude": ["./**/*.test.ts"],
-  "compilerOptions": {
-    "declaration": false,
-    "noEmit": false,
-  }
-}