@yaasl/core 0.9.0 → 0.9.2

package/dist/@types/base/Stateful.d.ts

@@ -1,6 +1,7 @@
 type Callback<Value> = (value: Value, previous: Value) => void;
 export declare class Stateful<Value = unknown> {
     protected value: Value;
+    /** Promise that resolves when the states initialization was finished. */
     didInit: PromiseLike<void> | boolean;
     private listeners;
     constructor(value: Value);

package/dist/@types/base/createAtom.d.ts

@@ -2,7 +2,7 @@ import { SetStateAction } from "@yaasl/utils";
 import { Actions, Reducers } from "./createActions";
 import { Stateful } from "./Stateful";
 import { EffectAtomCallback } from "../effects/createEffect";
-export interface AtomConfig<Value, R extends Reducers<Value> = {}> {
+export interface AtomConfig<Value, R extends Reducers<Value> = Reducers<Value>> {
     /** Value that will be used initially. */
     defaultValue: Value;
     /** Name of the atom. Must be unique among all atoms. Defaults to "atom-{number}". */
@@ -12,9 +12,12 @@ export interface AtomConfig<Value, R extends Reducers<Value> = {}> {
     /** Reducers for custom actions to set the atom's value. */
     reducers?: R;
 }
-export declare class Atom<Value = unknown, R extends Reducers<Value> = {}> extends Stateful<Value> {
+export declare class Atom<Value = unknown, R extends Reducers<Value> = Reducers<Value>> extends Stateful<Value> {
+    /** Default value of the atom. */
     readonly defaultValue: Value;
+    /** Identifier of the atom. */
     readonly name: string;
+    /** Actions that can be used to set the atom's value. */
     readonly actions: Actions<Value, R>;
     constructor({ defaultValue, name, effects, reducers, }: AtomConfig<Value, R>);
     /** Set the value of the atom.
@@ -32,11 +35,5 @@ export declare class Atom<Value = unknown, R extends Reducers<Value> = {}> exten
  * @param config.reducers Reducers for custom actions to set the atom's value.
  *
  * @returns An atom instance.
- * - `result.get`: Read the value of state.
- * - `result.subscribe`: Subscribe to value changes.
- * - `result.set`: Set the value of the atom.
- * - `result.actions`: All actions that were created with reducers.
- * - `result.didInit`: State of the atom's effects initialization process.
- *   Will be a promise if the initialization is pending and `true` if finished.
  **/
-export declare const createAtom: <Value, R extends Reducers<Value> = {}>(config: AtomConfig<Value, R>) => Atom<Value, R>;
+export declare const createAtom: <Value, R extends Reducers<Value> = Reducers<Value>>(config: AtomConfig<Value, R>) => Atom<Value, R>;

package/dist/@types/base/createDerived.d.ts

@@ -17,7 +17,7 @@ export declare class Derive<Value> extends Stateful<Value> {
 }
 export declare class SettableDerive<Value = unknown> extends Derive<Value> {
     private readonly setter;
-    protected readonly setterDependencies: Set<Atom<any, {}> | SettableDerive<any>>;
+    protected readonly setterDependencies: Set<Atom<any, import("./createActions").Reducers<any>> | SettableDerive<any>>;
     constructor(getter: GetterFn<Value>, setter: SetterFn<Value>);
     /** Set the value of the derived atom.
      *

package/dist/@types/base/createSelector.d.ts

@@ -1,20 +1,33 @@
 import { Stateful } from "./Stateful";
-type Selectable = Record<string | number, unknown>;
-type DeepKeys<T> = T extends object ? {
-    [K in keyof T]: `${Exclude<K, symbol>}${"" | `.${DeepKeys<T[K]>}`}`;
-}[keyof T] : never;
-type DeepValue<T, Path> = T extends Record<string | number, unknown> ? Path extends `${infer Current}.${infer Next}` ? DeepValue<T[Current], Next> : T[Path & string] : never;
-export declare class Selector<Path extends DeepKeys<State>, State extends Selectable> extends Stateful<DeepValue<State, Path>> {
-    protected readonly parent: Stateful<State>;
-    protected readonly path: Path;
-    constructor(parent: Stateful<State>, path: Path);
+type PathableState = Record<string | number, unknown>;
+type DeepKeys<State> = State extends PathableState ? {
+    [K in keyof State]: `${Exclude<K, symbol>}${"" | `.${DeepKeys<State[K]>}`}`;
+}[keyof State] : never;
+type DeepValue<State, Path> = State extends PathableState ? Path extends `${infer Current}.${infer Next}` ? DeepValue<State[Current], Next> : State[Path & string] : never;
+export declare class PathSelector<State, Path extends DeepKeys<State>> extends Stateful<DeepValue<State, Path>> {
+    constructor(atom: Stateful<State>, path: Path);
 }
-/** Creates a value, selected from any stateful value.
- *
- *  @param parent The parent element to select a value from. The internal state must be an object.
- *  @param path The path to the value you want to select.
- *
- *  @returns A selector instance.
- **/
-export declare const createSelector: <Path extends DeepKeys<State>, State extends Selectable>(parent: Stateful<State>, path: Path) => Selector<Path, State>;
+type InferValuesFromAtoms<Atoms extends readonly unknown[], States extends unknown[] = []> = Atoms extends [Stateful<infer Value>, ...infer Rest] ? InferValuesFromAtoms<Rest, [...States, Value]> : States;
+export declare class CombinerSelector<State, Atoms extends [Stateful<any>, ...Stateful<any>[]]> extends Stateful<State> {
+    constructor(atoms: Atoms, combiner: (...res: InferValuesFromAtoms<Atoms>) => State);
+}
+interface CreateSelectorOverloads {
+    /** Creates a value, selected from one atom with an object value by using a key path.
+     *
+     *  @param atom The atom to select a value from. The internal state must be an object.
+     *  @param path The path to the value you want to select.
+     *
+     *  @returns A PathSelector instance.
+     **/
+    <State, Path extends DeepKeys<State>>(atom: Stateful<State>, path: Path): PathSelector<State, Path>;
+    /** Creates a value, selected from one atom with an object value by using a key path.
+     *
+     *  @param atoms Atoms you need to combine to receive the new value.
+     *  @param combiner Combiner function to use the atom values and create a new value.
+     *
+     *  @returns A CombinerSelector instance.
+     **/
+    <Atoms extends [Stateful<any>, ...Stateful<any>[]], CombinedState>(states: Atoms, combiner: (...res: InferValuesFromAtoms<Atoms>) => CombinedState): CombinerSelector<CombinedState, Atoms>;
+}
+export declare const createSelector: CreateSelectorOverloads;
 export {};

package/dist/@types/base/index.d.ts

@@ -1,5 +1,5 @@
+export * from "./config";
 export * from "./createAtom";
 export * from "./createDerived";
-export * from "./config";
 export * from "./createSelector";
 export * from "./Stateful";

package/dist/cjs/base/Stateful.js

@@ -4,6 +4,7 @@ exports.Stateful = void 0;
 class Stateful {
     constructor(value) {
         this.value = value;
+        /** Promise that resolves when the states initialization was finished. */
         this.didInit = false;
         this.listeners = new Set();
     }

package/dist/cjs/base/createAtom.js

@@ -37,12 +37,6 @@ exports.Atom = Atom;
  * @param config.reducers Reducers for custom actions to set the atom's value.
  *
  * @returns An atom instance.
- * - `result.get`: Read the value of state.
- * - `result.subscribe`: Subscribe to value changes.
- * - `result.set`: Set the value of the atom.
- * - `result.actions`: All actions that were created with reducers.
- * - `result.didInit`: State of the atom's effects initialization process.
- *   Will be a promise if the initialization is pending and `true` if finished.
  **/
 const createAtom = (config) => new Atom(config);
 exports.createAtom = createAtom;

package/dist/cjs/base/createSelector.js

@@ -1,26 +1,46 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createSelector = exports.Selector = void 0;
+exports.createSelector = exports.CombinerSelector = exports.PathSelector = void 0;
+const utils_1 = require("@yaasl/utils");
 const Stateful_1 = require("./Stateful");
-const selectValue = (state, path) => path
+const selectPath = (state, path) => path
     .split(".")
     .reduce((result, key) => result[key], state);
-class Selector extends Stateful_1.Stateful {
-    constructor(parent, path) {
-        super(selectValue(parent.get(), path));
-        this.parent = parent;
-        this.path = path;
-        parent.subscribe(state => this.update(selectValue(state, path)));
-        this.setDidInit(parent.didInit);
+class PathSelector extends Stateful_1.Stateful {
+    constructor(atom, path) {
+        super(selectPath(atom.get(), path));
+        atom.subscribe(state => this.update(selectPath(state, path)));
+        this.setDidInit(atom.didInit);
     }
 }
-exports.Selector = Selector;
-/** Creates a value, selected from any stateful value.
- *
- *  @param parent The parent element to select a value from. The internal state must be an object.
- *  @param path The path to the value you want to select.
- *
- *  @returns A selector instance.
- **/
-const createSelector = (parent, path) => new Selector(parent, path);
+exports.PathSelector = PathSelector;
+// -- Combiner selector
+const allDidInit = (atoms) => {
+    const inits = atoms
+        .map(atom => atom.didInit)
+        .filter((didInit) => typeof didInit !== "boolean");
+    return inits.length === 0 ? true : Promise.all(inits).then(utils_1.toVoid);
+};
+class CombinerSelector extends Stateful_1.Stateful {
+    constructor(atoms, combiner) {
+        const selectState = () => {
+            const values = atoms.map(atom => atom.get());
+            return combiner(...values);
+        };
+        super(selectState());
+        atoms.forEach(atom => atom.subscribe(() => this.update(selectState())));
+        this.setDidInit(allDidInit(atoms));
+    }
+}
+exports.CombinerSelector = CombinerSelector;
+const createSelector = (atoms, selector) => {
+    if (atoms instanceof Stateful_1.Stateful && typeof selector === "string") {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+        return new PathSelector(atoms, selector);
+    }
+    if (Array.isArray(atoms) && typeof selector === "function") {
+        return new CombinerSelector(atoms, selector);
+    }
+    throw new Error("Selector args do not match any overload");
+};
 exports.createSelector = createSelector;

package/dist/cjs/base/index.js

@@ -14,8 +14,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./config"), exports);
 __exportStar(require("./createAtom"), exports);
 __exportStar(require("./createDerived"), exports);
-__exportStar(require("./config"), exports);
 __exportStar(require("./createSelector"), exports);
 __exportStar(require("./Stateful"), exports);

package/dist/mjs/base/Stateful.js

@@ -1,6 +1,7 @@
 export class Stateful {
     constructor(value) {
         this.value = value;
+        /** Promise that resolves when the states initialization was finished. */
         this.didInit = false;
         this.listeners = new Set();
     }

package/dist/mjs/base/createAtom.js

@@ -33,11 +33,5 @@ export class Atom extends Stateful {
  * @param config.reducers Reducers for custom actions to set the atom's value.
  *
  * @returns An atom instance.
- * - `result.get`: Read the value of state.
- * - `result.subscribe`: Subscribe to value changes.
- * - `result.set`: Set the value of the atom.
- * - `result.actions`: All actions that were created with reducers.
- * - `result.didInit`: State of the atom's effects initialization process.
- *   Will be a promise if the initialization is pending and `true` if finished.
  **/
 export const createAtom = (config) => new Atom(config);

package/dist/mjs/base/createSelector.js

@@ -1,21 +1,40 @@
+import { toVoid } from "@yaasl/utils";
 import { Stateful } from "./Stateful";
-const selectValue = (state, path) => path
+const selectPath = (state, path) => path
     .split(".")
     .reduce((result, key) => result[key], state);
-export class Selector extends Stateful {
-    constructor(parent, path) {
-        super(selectValue(parent.get(), path));
-        this.parent = parent;
-        this.path = path;
-        parent.subscribe(state => this.update(selectValue(state, path)));
-        this.setDidInit(parent.didInit);
+export class PathSelector extends Stateful {
+    constructor(atom, path) {
+        super(selectPath(atom.get(), path));
+        atom.subscribe(state => this.update(selectPath(state, path)));
+        this.setDidInit(atom.didInit);
     }
 }
-/** Creates a value, selected from any stateful value.
- *
- *  @param parent The parent element to select a value from. The internal state must be an object.
- *  @param path The path to the value you want to select.
- *
- *  @returns A selector instance.
- **/
-export const createSelector = (parent, path) => new Selector(parent, path);
+// -- Combiner selector
+const allDidInit = (atoms) => {
+    const inits = atoms
+        .map(atom => atom.didInit)
+        .filter((didInit) => typeof didInit !== "boolean");
+    return inits.length === 0 ? true : Promise.all(inits).then(toVoid);
+};
+export class CombinerSelector extends Stateful {
+    constructor(atoms, combiner) {
+        const selectState = () => {
+            const values = atoms.map(atom => atom.get());
+            return combiner(...values);
+        };
+        super(selectState());
+        atoms.forEach(atom => atom.subscribe(() => this.update(selectState())));
+        this.setDidInit(allDidInit(atoms));
+    }
+}
+export const createSelector = (atoms, selector) => {
+    if (atoms instanceof Stateful && typeof selector === "string") {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+        return new PathSelector(atoms, selector);
+    }
+    if (Array.isArray(atoms) && typeof selector === "function") {
+        return new CombinerSelector(atoms, selector);
+    }
+    throw new Error("Selector args do not match any overload");
+};

package/dist/mjs/base/index.js

@@ -1,5 +1,5 @@
+export * from "./config";
 export * from "./createAtom";
 export * from "./createDerived";
-export * from "./config";
 export * from "./createSelector";
 export * from "./Stateful";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yaasl/core",
-  "version": "0.9.0",
+  "version": "0.9.2",
   "description": "yet another atomic store library (vanilla-js)",
   "author": "PrettyCoffee",
   "license": "MIT",
@@ -38,7 +38,7 @@
     "validate": "run-s lint test build"
   },
   "dependencies": {
-    "@yaasl/utils": "0.9.0"
+    "@yaasl/utils": "0.9.2"
   },
   "eslintConfig": {
     "extends": [