@oscarpalmer/mora 0.18.1 → 0.19.0

package/types/index.d.cts

@@ -0,0 +1,246 @@
+// Generated by dts-bundle-generator v9.5.1
+
+export type GenericCallback = (...args: any[]) => any;
+/**
+ * A useful key type
+ */
+export type Key = number | string;
+/**
+ * A generic object
+ */
+export type PlainObject = Record<PropertyKey, unknown>;
+export declare class Effect {
+	private readonly $mora;
+	private readonly state;
+	constructor(callback: GenericCallback);
+}
+/**
+ * Create an effect
+ */
+export declare function effect(callback: GenericCallback): Effect;
+export declare class Computed<Value> extends Reactive<Value> {
+	private readonly effect;
+	constructor(callback: () => Value, options?: ReactiveOptions<Value>);
+	/**
+	 * @inheritdoc
+	 */
+	get(): Value;
+}
+/**
+ * Create a computed value
+ */
+export declare function computed<Value>(callback: () => Value, options?: ReactiveOptions<Value>): Computed<Value>;
+export declare abstract class Reactive<Value, Equal = Value> {
+	protected readonly state: ReactiveState<Value, Equal>;
+	constructor(name: string, value: Value, options?: ReactiveOptions<Equal>);
+	/**
+	 * Get the value
+	 */
+	abstract get(): Value;
+	/**
+	 * Get the value _(without reactivity)_
+	 */
+	peek(): Value;
+	/**
+	 * Subscribe to changes
+	 */
+	subscribe(callback: (value: Value) => void): Unsubscribe;
+	/**
+	 * JSON representation of the value
+	 */
+	toJSON(): Value;
+	/**
+	 * String representation of the value
+	 */
+	toString(): string;
+	/**
+	 * Unsubscribe from changes
+	 */
+	unsubscribe(callback: (value: Value) => void): void;
+}
+export type ReactiveOptions<Value> = {
+	/**
+	 * Method to compare values for equality
+	 */
+	equal?: (first: Value, second: Value) => boolean;
+};
+export type ReactiveState<Value, Equal> = {
+	computeds: Set<Computed<unknown>>;
+	effects: Set<Effect>;
+	equal: (first: Equal, second: Equal) => boolean;
+	subscriptions: Map<(value: Value) => void, Subscription<Value>>;
+	value: Value;
+};
+declare class Subscription<Value> {
+	state: ReactiveState<Value, never>;
+	callback: GenericCallback;
+	constructor(state: ReactiveState<Value, never>, callback: GenericCallback);
+}
+/**
+ * Unsubscribe from changes
+ */
+export type Unsubscribe = () => void;
+/**
+ * Start batching effects _(use `stopBatch` to flush and run batched effects)_
+ */
+export declare function startBatch(): void;
+/**
+ * Stop batching effects and flush _(run)_ them
+ */
+export declare function stopBatch(): void;
+export declare class ReactiveArray<Item> extends Reactive<Item[], Item> {
+	#private;
+	/**
+	 * The length of the array
+	 */
+	get length(): number;
+	/**
+	 * Set the length of the array
+	 */
+	set length(value: number);
+	constructor(value: Item[], options?: ReactiveOptions<Item>);
+	/**
+	 * Clear the array
+	 */
+	clear(): void;
+	/**
+	 * @inheritdoc
+	 */
+	get(): Item[];
+	get(index: number): Item | undefined;
+	get(property: "length"): number;
+	/**
+	 * Create a computed, filtered array
+	 */
+	filter(callback: (item: Item, index: number, array: Item[]) => boolean): Computed<Item[]>;
+	/**
+	 * Create a computed, mapped array
+	 */
+	map<Mapped>(callback: (item: Item, index: number, array: Item[]) => Mapped): Computed<Mapped[]>;
+	/**
+	 * @inheritdoc
+	 */
+	peek(): Item[];
+	/**
+	 * Get the length of the array _(without reactivity)_
+	 */
+	peek(length: true): number;
+	/**
+	 * Remove and return the last item of the array
+	 */
+	pop(): Item | undefined;
+	/**
+	 * Add items to the end of the array
+	 */
+	push(...items: Item[]): number;
+	/**
+	 * Set the value
+	 */
+	set(value: Item[]): void;
+	/**
+	 * Set the value at an index
+	 */
+	set(index: number, value: Item): void;
+	/**
+	 * Set the length of the array
+	 */
+	set(property: "length", value: number): void;
+	/**
+	 * Remove and return the first item of the array
+	 */
+	shift(): Item | undefined;
+	/**
+	 * Remove and return items from the array _(and optionally add new items)_
+	 */
+	splice(from: number, to?: number, ...items: Item[]): Item[];
+	/**
+	 * Add items to the beginning of the array
+	 */
+	unshift(...items: Item[]): number;
+}
+/**
+ * Create a reactive array
+ */
+export declare function array<Item>(value: Item[], options?: ReactiveOptions<Item>): ReactiveArray<Item>;
+export declare class Signal<Value> extends Reactive<Value> {
+	constructor(value: Value, options?: ReactiveOptions<Value>);
+	/**
+	 * @inheritdoc
+	 */
+	get(): Value;
+	/**
+	 * Set the value
+	 */
+	set(value: Value): void;
+	/**
+	 * Update the value
+	 */
+	update(callback: (value: Value) => Value): void;
+}
+/**
+ * Create a reactive value
+ */
+export declare function signal<Value>(value: Value, options?: ReactiveOptions<Value>): Signal<Value>;
+export declare class Store<Value extends PlainObject> extends Reactive<Value, Value> {
+	#private;
+	constructor(value: Value, options?: ReactiveOptions<Value>);
+	/**
+	 * @inheritdoc
+	 */
+	get(): Value;
+	/**
+	 * Get a value by key _(without reactivity)_
+	 */
+	get(key: keyof Value): Value[keyof Value];
+	/**
+	 * Get a value by key _(without reactivity)_
+	 */
+	get(key: Key): unknown;
+	/**
+	 * Get the value _(without reactivity)_
+	 */
+	peek(): Value;
+	/**
+	 * Get a value by key _(without reactivity)_
+	 */
+	peek(key: keyof Value): Value[keyof Value];
+	/**
+	 * Get a value by key _(without reactivity)_
+	 */
+	peek(key: Key): unknown;
+	/**
+	 * Set the value
+	 */
+	set(value?: Value): void;
+	/**
+	 * Set a value by key
+	 */
+	set(key: keyof Value, value: Value[keyof Value]): void;
+	/**
+	 * Set a value by key
+	 */
+	set(key: Key, value: unknown): void;
+}
+/**
+ * Create a reactive store
+ */
+export declare function store<Value extends PlainObject>(value: Value, options?: ReactiveOptions<Value>): Store<Value>;
+/**
+ * Is the value a reactive array?
+ */
+export declare function isArray(value: unknown): value is ReactiveArray<unknown>;
+/**
+ * Is the value a computed signal?
+ */
+export declare function isComputed(value: unknown): value is Computed<unknown>;
+/**
+ * Is the value an effect?
+ */
+export declare function isEffect(value: unknown): value is Effect;
+export declare function isReactive(value: unknown): value is Reactive<unknown>;
+/**
+ * Is the value a signal?
+ */
+export declare function isSignal(value: unknown): value is Signal<unknown>;
+
+export {};

package/types/subscription.d.cts

@@ -0,0 +1,71 @@
+// Generated by dts-bundle-generator v9.5.1
+
+export type GenericCallback = (...args: any[]) => any;
+declare class Effect {
+	private readonly $mora;
+	private readonly state;
+	constructor(callback: GenericCallback);
+}
+declare class Computed<Value> extends Reactive<Value> {
+	private readonly effect;
+	constructor(callback: () => Value, options?: ReactiveOptions<Value>);
+	/**
+	 * @inheritdoc
+	 */
+	get(): Value;
+}
+declare abstract class Reactive<Value, Equal = Value> {
+	protected readonly state: ReactiveState<Value, Equal>;
+	constructor(name: string, value: Value, options?: ReactiveOptions<Equal>);
+	/**
+	 * Get the value
+	 */
+	abstract get(): Value;
+	/**
+	 * Get the value _(without reactivity)_
+	 */
+	peek(): Value;
+	/**
+	 * Subscribe to changes
+	 */
+	subscribe(callback: (value: Value) => void): Unsubscribe;
+	/**
+	 * JSON representation of the value
+	 */
+	toJSON(): Value;
+	/**
+	 * String representation of the value
+	 */
+	toString(): string;
+	/**
+	 * Unsubscribe from changes
+	 */
+	unsubscribe(callback: (value: Value) => void): void;
+}
+export type ReactiveOptions<Value> = {
+	/**
+	 * Method to compare values for equality
+	 */
+	equal?: (first: Value, second: Value) => boolean;
+};
+export type ReactiveState<Value, Equal> = {
+	computeds: Set<Computed<unknown>>;
+	effects: Set<Effect>;
+	equal: (first: Equal, second: Equal) => boolean;
+	subscriptions: Map<(value: Value) => void, Subscription<Value>>;
+	value: Value;
+};
+export declare class Subscription<Value> {
+	state: ReactiveState<Value, never>;
+	callback: GenericCallback;
+	constructor(state: ReactiveState<Value, never>, callback: GenericCallback);
+}
+/**
+ * Unsubscribe from changes
+ */
+export type Unsubscribe = () => void;
+export declare function noop(): void;
+export declare function subscribe<Value>(state: ReactiveState<Value, never>, callback: (value: Value) => void): Unsubscribe;
+export declare function unsubscribe<Value>(state: ReactiveState<Value, never>, callback: (value: Value) => void): void;
+
+export {};

package/types/value/array.d.cts

@@ -0,0 +1,142 @@
+// Generated by dts-bundle-generator v9.5.1
+
+export type GenericCallback = (...args: any[]) => any;
+declare class Effect {
+	private readonly $mora;
+	private readonly state;
+	constructor(callback: GenericCallback);
+}
+declare class Computed<Value> extends Reactive<Value> {
+	private readonly effect;
+	constructor(callback: () => Value, options?: ReactiveOptions<Value>);
+	/**
+	 * @inheritdoc
+	 */
+	get(): Value;
+}
+declare abstract class Reactive<Value, Equal = Value> {
+	protected readonly state: ReactiveState<Value, Equal>;
+	constructor(name: string, value: Value, options?: ReactiveOptions<Equal>);
+	/**
+	 * Get the value
+	 */
+	abstract get(): Value;
+	/**
+	 * Get the value _(without reactivity)_
+	 */
+	peek(): Value;
+	/**
+	 * Subscribe to changes
+	 */
+	subscribe(callback: (value: Value) => void): Unsubscribe;
+	/**
+	 * JSON representation of the value
+	 */
+	toJSON(): Value;
+	/**
+	 * String representation of the value
+	 */
+	toString(): string;
+	/**
+	 * Unsubscribe from changes
+	 */
+	unsubscribe(callback: (value: Value) => void): void;
+}
+export type ReactiveOptions<Value> = {
+	/**
+	 * Method to compare values for equality
+	 */
+	equal?: (first: Value, second: Value) => boolean;
+};
+export type ReactiveState<Value, Equal> = {
+	computeds: Set<Computed<unknown>>;
+	effects: Set<Effect>;
+	equal: (first: Equal, second: Equal) => boolean;
+	subscriptions: Map<(value: Value) => void, Subscription<Value>>;
+	value: Value;
+};
+declare class Subscription<Value> {
+	state: ReactiveState<Value, never>;
+	callback: GenericCallback;
+	constructor(state: ReactiveState<Value, never>, callback: GenericCallback);
+}
+/**
+ * Unsubscribe from changes
+ */
+export type Unsubscribe = () => void;
+export declare class ReactiveArray<Item> extends Reactive<Item[], Item> {
+	#private;
+	/**
+	 * The length of the array
+	 */
+	get length(): number;
+	/**
+	 * Set the length of the array
+	 */
+	set length(value: number);
+	constructor(value: Item[], options?: ReactiveOptions<Item>);
+	/**
+	 * Clear the array
+	 */
+	clear(): void;
+	/**
+	 * @inheritdoc
+	 */
+	get(): Item[];
+	get(index: number): Item | undefined;
+	get(property: "length"): number;
+	/**
+	 * Create a computed, filtered array
+	 */
+	filter(callback: (item: Item, index: number, array: Item[]) => boolean): Computed<Item[]>;
+	/**
+	 * Create a computed, mapped array
+	 */
+	map<Mapped>(callback: (item: Item, index: number, array: Item[]) => Mapped): Computed<Mapped[]>;
+	/**
+	 * @inheritdoc
+	 */
+	peek(): Item[];
+	/**
+	 * Get the length of the array _(without reactivity)_
+	 */
+	peek(length: true): number;
+	/**
+	 * Remove and return the last item of the array
+	 */
+	pop(): Item | undefined;
+	/**
+	 * Add items to the end of the array
+	 */
+	push(...items: Item[]): number;
+	/**
+	 * Set the value
+	 */
+	set(value: Item[]): void;
+	/**
+	 * Set the value at an index
+	 */
+	set(index: number, value: Item): void;
+	/**
+	 * Set the length of the array
+	 */
+	set(property: "length", value: number): void;
+	/**
+	 * Remove and return the first item of the array
+	 */
+	shift(): Item | undefined;
+	/**
+	 * Remove and return items from the array _(and optionally add new items)_
+	 */
+	splice(from: number, to?: number, ...items: Item[]): Item[];
+	/**
+	 * Add items to the beginning of the array
+	 */
+	unshift(...items: Item[]): number;
+}
+/**
+ * Create a reactive array
+ */
+export declare function array<Item>(value: Item[], options?: ReactiveOptions<Item>): ReactiveArray<Item>;
+
+export {};

package/types/value/array.d.ts

@@ -11,10 +11,6 @@ export declare class ReactiveArray<Item> extends Reactive<Item[], Item> {
      */
     set length(value: number);
     constructor(value: Item[], options?: ReactiveOptions<Item>);
-    /**
-     * Get an indexed item
-     */
-    at(index: number): Item | undefined;
     /**
      * Clear the array
      */
@@ -23,6 +19,8 @@ export declare class ReactiveArray<Item> extends Reactive<Item[], Item> {
      * @inheritdoc
      */
     get(): Item[];
+    get(index: number): Item | undefined;
+    get(property: 'length'): number;
     /**
      * Create a computed, filtered array
      */

package/types/value/computed.d.cts

@@ -0,0 +1,81 @@
+// Generated by dts-bundle-generator v9.5.1
+
+export type GenericCallback = (...args: any[]) => any;
+declare class Effect {
+	private readonly $mora;
+	private readonly state;
+	constructor(callback: GenericCallback);
+}
+export type ComputedEffect = {
+	dirty: boolean;
+	instance: Effect;
+};
+export type InternalComputed = {
+	readonly effect: ComputedEffect;
+	readonly state: ReactiveState<unknown, unknown>;
+};
+export declare let activeComputed: Computed<unknown> | undefined;
+export declare class Computed<Value> extends Reactive<Value> {
+	private readonly effect;
+	constructor(callback: () => Value, options?: ReactiveOptions<Value>);
+	/**
+	 * @inheritdoc
+	 */
+	get(): Value;
+}
+/**
+ * Create a computed value
+ */
+export declare function computed<Value>(callback: () => Value, options?: ReactiveOptions<Value>): Computed<Value>;
+declare abstract class Reactive<Value, Equal = Value> {
+	protected readonly state: ReactiveState<Value, Equal>;
+	constructor(name: string, value: Value, options?: ReactiveOptions<Equal>);
+	/**
+	 * Get the value
+	 */
+	abstract get(): Value;
+	/**
+	 * Get the value _(without reactivity)_
+	 */
+	peek(): Value;
+	/**
+	 * Subscribe to changes
+	 */
+	subscribe(callback: (value: Value) => void): Unsubscribe;
+	/**
+	 * JSON representation of the value
+	 */
+	toJSON(): Value;
+	/**
+	 * String representation of the value
+	 */
+	toString(): string;
+	/**
+	 * Unsubscribe from changes
+	 */
+	unsubscribe(callback: (value: Value) => void): void;
+}
+export type ReactiveOptions<Value> = {
+	/**
+	 * Method to compare values for equality
+	 */
+	equal?: (first: Value, second: Value) => boolean;
+};
+export type ReactiveState<Value, Equal> = {
+	computeds: Set<Computed<unknown>>;
+	effects: Set<Effect>;
+	equal: (first: Equal, second: Equal) => boolean;
+	subscriptions: Map<(value: Value) => void, Subscription<Value>>;
+	value: Value;
+};
+declare class Subscription<Value> {
+	state: ReactiveState<Value, never>;
+	callback: GenericCallback;
+	constructor(state: ReactiveState<Value, never>, callback: GenericCallback);
+}
+/**
+ * Unsubscribe from changes
+ */
+export type Unsubscribe = () => void;
+
+export {};

package/types/value/reactive.d.cts

@@ -0,0 +1,68 @@
+// Generated by dts-bundle-generator v9.5.1
+
+export type GenericCallback = (...args: any[]) => any;
+declare class Effect {
+	private readonly $mora;
+	private readonly state;
+	constructor(callback: GenericCallback);
+}
+declare class Computed<Value> extends Reactive<Value> {
+	private readonly effect;
+	constructor(callback: () => Value, options?: ReactiveOptions<Value>);
+	/**
+	 * @inheritdoc
+	 */
+	get(): Value;
+}
+export declare abstract class Reactive<Value, Equal = Value> {
+	protected readonly state: ReactiveState<Value, Equal>;
+	constructor(name: string, value: Value, options?: ReactiveOptions<Equal>);
+	/**
+	 * Get the value
+	 */
+	abstract get(): Value;
+	/**
+	 * Get the value _(without reactivity)_
+	 */
+	peek(): Value;
+	/**
+	 * Subscribe to changes
+	 */
+	subscribe(callback: (value: Value) => void): Unsubscribe;
+	/**
+	 * JSON representation of the value
+	 */
+	toJSON(): Value;
+	/**
+	 * String representation of the value
+	 */
+	toString(): string;
+	/**
+	 * Unsubscribe from changes
+	 */
+	unsubscribe(callback: (value: Value) => void): void;
+}
+export type ReactiveOptions<Value> = {
+	/**
+	 * Method to compare values for equality
+	 */
+	equal?: (first: Value, second: Value) => boolean;
+};
+export type ReactiveState<Value, Equal> = {
+	computeds: Set<Computed<unknown>>;
+	effects: Set<Effect>;
+	equal: (first: Equal, second: Equal) => boolean;
+	subscriptions: Map<(value: Value) => void, Subscription<Value>>;
+	value: Value;
+};
+declare class Subscription<Value> {
+	state: ReactiveState<Value, never>;
+	callback: GenericCallback;
+	constructor(state: ReactiveState<Value, never>, callback: GenericCallback);
+}
+/**
+ * Unsubscribe from changes
+ */
+export type Unsubscribe = () => void;
+
+export {};

package/types/value/signal.d.cts

@@ -0,0 +1,87 @@
+// Generated by dts-bundle-generator v9.5.1
+
+export type GenericCallback = (...args: any[]) => any;
+declare class Effect {
+	private readonly $mora;
+	private readonly state;
+	constructor(callback: GenericCallback);
+}
+declare class Computed<Value> extends Reactive<Value> {
+	private readonly effect;
+	constructor(callback: () => Value, options?: ReactiveOptions<Value>);
+	/**
+	 * @inheritdoc
+	 */
+	get(): Value;
+}
+declare abstract class Reactive<Value, Equal = Value> {
+	protected readonly state: ReactiveState<Value, Equal>;
+	constructor(name: string, value: Value, options?: ReactiveOptions<Equal>);
+	/**
+	 * Get the value
+	 */
+	abstract get(): Value;
+	/**
+	 * Get the value _(without reactivity)_
+	 */
+	peek(): Value;
+	/**
+	 * Subscribe to changes
+	 */
+	subscribe(callback: (value: Value) => void): Unsubscribe;
+	/**
+	 * JSON representation of the value
+	 */
+	toJSON(): Value;
+	/**
+	 * String representation of the value
+	 */
+	toString(): string;
+	/**
+	 * Unsubscribe from changes
+	 */
+	unsubscribe(callback: (value: Value) => void): void;
+}
+export type ReactiveOptions<Value> = {
+	/**
+	 * Method to compare values for equality
+	 */
+	equal?: (first: Value, second: Value) => boolean;
+};
+export type ReactiveState<Value, Equal> = {
+	computeds: Set<Computed<unknown>>;
+	effects: Set<Effect>;
+	equal: (first: Equal, second: Equal) => boolean;
+	subscriptions: Map<(value: Value) => void, Subscription<Value>>;
+	value: Value;
+};
+declare class Subscription<Value> {
+	state: ReactiveState<Value, never>;
+	callback: GenericCallback;
+	constructor(state: ReactiveState<Value, never>, callback: GenericCallback);
+}
+/**
+ * Unsubscribe from changes
+ */
+export type Unsubscribe = () => void;
+export declare class Signal<Value> extends Reactive<Value> {
+	constructor(value: Value, options?: ReactiveOptions<Value>);
+	/**
+	 * @inheritdoc
+	 */
+	get(): Value;
+	/**
+	 * Set the value
+	 */
+	set(value: Value): void;
+	/**
+	 * Update the value
+	 */
+	update(callback: (value: Value) => Value): void;
+}
+/**
+ * Create a reactive value
+ */
+export declare function signal<Value>(value: Value, options?: ReactiveOptions<Value>): Signal<Value>;
+
+export {};