@oscarpalmer/mora 0.30.0 → 0.32.0

package/dist/models.d.mts

@@ -1,25 +1,26 @@
 import { PROPERTY_LENGTH } from "./constants.mjs";
-import { GenericCallback, Key } from "@oscarpalmer/atoms/models";
+import { Subscription, Subscriptions } from "@oscarpalmer/atoms/subscription";
+import { GenericCallback, Key, PlainObject } from "@oscarpalmer/atoms/models";
 //#region src/models.d.ts
-type Active = {
+export type Active = {
   computed?: ComputedEffect;
   effect?: EffectState;
 };
-type Batch = {
+export type Batch = {
   depth: number;
   flushing: boolean;
-  handlers: Set<EffectState | Subscription>;
+  handlers: Map<EffectState | Subscription, EffectState | StoredSubscription>;
 };
-type Computed<Value> = Reactive<Value> & SimpleReactive<Value>;
-type ComputedEffect = {
+export type Computed<Value> = Reactive<Value> & SimpleReactive<Value>;
+export type ComputedEffect = {
   dirty: boolean;
   instance: EffectState;
 };
-type Effect = {};
-type EffectState = {
+export type Effect = {};
+export type EffectState = {
   callback: GenericCallback;
 };
-type Reactive<Value> = {
+export type Reactive<Value> = {
   /**
    * JSON representation of the value
    *
@@ -33,7 +34,7 @@ type Reactive<Value> = {
    */
   toString(): string;
 };
-type ReactiveArray<Item> = {
+export type ReactiveArray<Item> = {
   /**
    * The length of the array
    */
@@ -42,6 +43,20 @@ type ReactiveArray<Item> = {
    * Set the length of the array
    */
   set length(value: number);
+  /**
+   * Get a readonly version of the reactive array
+   *
+   * @param frozen Freeze the array? _(defaults to `false`)_
+   * @returns Readonly reactive array
+   */
+  asReadonly(frozen: true): ReadonlyFrozenSignal<Item[]>;
+  /**
+   * Get a readonly version of the reactive array
+   *
+   * @param frozen Freeze the array? _(defaults to `false`)_
+   * @returns Readonly reactive array
+   */
+  asReadonly(frozen?: boolean): typeof frozen extends true ? ReadonlyFrozenSignal<Item[]> : ReadonlySignal<Item[]>;
   /**
    * Get the value at an index
    *
@@ -96,16 +111,18 @@ type ReactiveArray<Item> = {
   /**
    * Get the array _(without reactivity)_
    *
+   * @param copy Copy the array? _(defaults to `false`)_
    * @returns Array of items
    */
-  peek(): Item[];
+  peek(copy?: boolean): Item[];
   /**
    * Get the value at an index _(without reactivity)_
    *
    * @param index Index of item to get _(if negative, starts from the end)_
+   * @param copy If the item is an array or record, should it be copied? _(defaults to `false`)_
    * @returns Item at index, or `undefined` if it doesn't exist
    */
-  peek(index: number): Item | undefined;
+  peek(index: number, copy?: boolean): Item | undefined;
   /**
    * Get the length of the array _(without reactivity)_
    *
@@ -171,36 +188,25 @@ type ReactiveArray<Item> = {
    * Subscribe to changes
    *
    * @param callback Callback for changes
-   * @returns Unsubscribe callback
+   * @param copy Copy the array? _(defaults to `false`)_
+   * @returns Subscription
    */
-  subscribe(callback: (value: Item[]) => void): Unsubscribe;
+  subscribe(callback: (value: Item[]) => void, copy?: boolean): Subscription;
   /**
    * Subscribe to changes at a specific index
    *
    * @param index Index of item to subscribe to
    * @param callback Callback for changes
-   * @returns Unsubscribe callback
+   * @param copy If the item is an array or record, should it be copied? _(defaults to `false`)_
+   * @returns Subscription
    */
-  subscribe(index: number, callback: (value: Item | undefined) => void): Unsubscribe;
+  subscribe(index: number, callback: (value: Item | undefined) => void, copy?: boolean): Subscription;
   /**
    * Add items to the beginning of the array
    * @param items Items to add
    * @returns New array length
    */
   unshift(...items: Item[]): number;
-  /**
-   * Unsubscribe from changes for a specific index
-   *
-   * @param index Index of the value to unsubscribe from
-   * @param callback Callback to unsubscribe
-   */
-  unsubscribe(index: number, callback: (item: Item | undefined) => void): void;
-  /**
-   * Unsubscribe from changes
-   *
-   * @param callback Callback to unsubscribe
-   */
-  unsubscribe(callback: (array: Item[]) => void): void;
   /**
    * Update the value _(based on the current value)_
    *
@@ -208,7 +214,7 @@ type ReactiveArray<Item> = {
    */
   update(callback: (value: Item[]) => Item[]): void;
 } & Reactive<Item[]>;
-type ReactiveOptions<Value> = {
+export type ReactiveOptions<Value> = {
   /**
    * Method for comparing values for equality
    * @param first First value
@@ -218,29 +224,43 @@ type ReactiveOptions<Value> = {
    */
   equal?: (first: Value, second: Value) => boolean;
 };
-type ReactiveState<Value, Equal> = {
+export type ReactiveState<Value, Item = Value> = {
   computeds: Set<ComputedEffect>;
   effects: Set<EffectState>;
-  equal: (first: Equal, second: Equal) => boolean;
+  equal: (first: Item, second: Item) => boolean;
   promise?: Promise<Value>;
   promises?: Map<Key, Promise<never>>;
-  subscriptions: Map<GenericCallback, Subscription>;
+  subscriptions?: Subscriptions<GenericCallback>;
   value: Value;
 };
-type ReactiveStore<Value> = {
+export type ReactiveStore<Store> = {
+  /**
+   * Get a readonly version of the reactive store
+   *
+   * @param frozen Freeze the store? _(defaults to `false`)_
+   * @returns Readonly reactive store
+   */
+  asReadonly(frozen: true): ReadonlyFrozenSignal<Store>;
+  /**
+   * Get a readonly version of the reactive store
+   *
+   * @param frozen Freeze the store? _(defaults to `false`)_
+   * @returns Readonly reactive store
+   */
+  asReadonly(frozen?: boolean): typeof frozen extends true ? ReadonlyFrozenSignal<Store> : ReadonlySignal<Store>;
   /**
    * Get the value
    *
    * @returns Current value
    */
-  get(): Value;
+  get(): Store;
   /**
    * Get a value by key
    *
    * @param key Key of the value to get
    * @returns Value for the specified key, or `undefined` if it doesn't exist
    */
-  get<Key extends keyof Value>(key: Key): Value[Key];
+  get<Key extends keyof Store>(key: Key): Store[Key];
   /**
    * Get a value by key
    *
@@ -258,36 +278,39 @@ type ReactiveStore<Value> = {
   /**
    * Get the value _(without reactivity)_
    *
+   * @param copy Copy the store? _(defaults to `false`)_
    * @returns Current value
    */
-  peek(): Value;
+  peek(copy?: boolean): Store;
   /**
    * Get a value by key _(without reactivity)_
    *
    * @param key Key of the value to get
+   * @param copy If the value is an array or record, should it be copied? _(defaults to `false`)_
    * @returns Value for the specified key, or `undefined` if it doesn't exist
    */
-  peek<Key extends keyof Value>(key: Key): Value[Key];
+  peek<Key extends keyof Store>(key: Key, copy?: boolean): Store[Key];
   /**
    * Get a value by key _(without reactivity)_
    *
    * @param key Key of the value to get
+   * @param copy If the value is an array or record, should it be copied? _(defaults to `false`)_
    * @returns Value for the specified key, or `undefined` if it doesn't exist
    */
-  peek(key: Key): unknown;
+  peek(key: Key, copy?: boolean): unknown;
   /**
    * Set the value
    *
    * @param value New value _(defaults to an empty object)_
    */
-  set(value?: Value | (() => null | undefined | Value | Promise<null | undefined | Value>) | Promise<null | undefined | Value>): void;
+  set(value?: Store | (() => null | undefined | Store | Promise<null | undefined | Store>) | Promise<null | undefined | Store>): void;
   /**
    * Set a value by key
    *
    * @param key Key of the value to set
    * @param value New value
    */
-  set<Key extends keyof Value>(key: Key, value: Value[Key] | (() => Value[Key] | Promise<Value[Key]>) | Promise<Value[Key]>): void;
+  set<Key extends keyof Store>(key: Key, value: Store[Key] | (() => Store[Key] | Promise<Store[Key]>) | Promise<Store[Key]>): void;
   /**
    * Set a value by key
    *
@@ -299,54 +322,62 @@ type ReactiveStore<Value> = {
    * Subscribe to changes
    *
    * @param callback Callback for changes
-   * @returns Unsubscribe callback
+   * @param copy Copy the store? _(defaults to `false`)_
+   * @returns Subscription
    */
-  subscribe(callback: (value: Value) => void): Unsubscribe;
+  subscribe(callback: (value: Store) => void, copy?: boolean): Subscription;
   /**
    * Subscribe to changes for a specific key
    *
    * @param key Key of the value to subscribe to
    * @param callback Callback for changes
-   * @returns Unsubscribe callback
+   * @param copy If the value is an array or record, should it be copied? _(defaults to `false`)_
+   * @returns Subscription
    */
-  subscribe<Key extends keyof Value>(key: Key, callback: (value: Value[Key] | undefined) => void): Unsubscribe;
+  subscribe<Key extends keyof Store>(key: Key, callback: (value: Store[Key] | undefined) => void, copy?: boolean): Subscription;
   /**
    * Subscribe to changes for a specific key
    *
    * @param key Key of the value to subscribe to
    * @param callback Callback for changes
-   * @returns Unsubscribe callback
+   * @param copy If the value is an array or record, should it be copied? _(defaults to `false`)_
+   * @returns Subscription
    */
-  subscribe(key: Key, callback: (value: unknown) => void): Unsubscribe;
+  subscribe(key: Key, callback: (value: unknown) => void, copy?: boolean): Subscription;
   /**
-   * Unsubscribe from changes for a specific key
+   * Update the value _(based on the current value)_
    *
-   * @param key Key of the value to unsubscribe from
-   * @param callback Callback to unsubscribe
+   * @param callback Callback to update the value
+   */
+  update(callback: (value: Store) => Store): void;
+} & Reactive<Store>;
+export type ReadonlyInstances<Value> = {
+  frozen?: ReadonlyFrozenSignal<Value>;
+  original?: ReadonlySignal<Value>;
+};
+export type ReadonlyFrozenSignal<Value> = ReadonlySignal<ReadonlySignalValue<Value>>;
+export type ReadonlySignal<Value> = {
+  /**
+   * Is the signal frozen?
    */
-  unsubscribe<Key extends keyof Value>(key: Key, callback: (value: Value[Key] | undefined) => void): void;
+  get frozen(): boolean;
+} & Reactive<Value> & SimpleReactive<Value>;
+export type ReadonlySignalValue<Value> = Value extends unknown[] ? Readonly<Value> : Value extends PlainObject ? Readonly<Value> : Value;
+export type Signal<Value> = {
   /**
-   * Unsubscribe from changes
+   * Get a readonly version of the signal
    *
-   * @param callback Callback to unsubscribe
+   * @param frozen Freeze the signal? _(defaults to `false`)_
+   * @returns Readonly signal
    */
-  unsubscribe(callback: (value: Value) => void): void;
+  asReadonly(frozen: true): ReadonlyFrozenSignal<Value>;
   /**
-   * Update the value _(based on the current value)_
+   * Get a readonly version of the signal
    *
-   * @param callback Callback to update the value
+   * @param frozen Freeze the signal? _(defaults to `false`)_
+   * @returns Readonly signal
    */
-  update(callback: (value: Value) => Value): void;
-} & Reactive<Value>;
-type SetValueInProxyParameters<Value, Equal> = {
-  target: Value;
-  property: PropertyKey;
-  value: unknown;
-  state: ReactiveState<Value, Equal>;
-  isArray: boolean;
-  length?: Signal<number>;
-};
-type Signal<Value> = {
+  asReadonly(frozen?: boolean): typeof frozen extends true ? ReadonlyFrozenSignal<Value> : ReadonlySignal<Value>;
   /**
    * Set the value
    *
@@ -370,31 +401,24 @@ type SimpleReactive<Value> = {
   /**
    * Get the value _(without reactivity)_
    *
+   * @param copy If the value is an array or record, should it be copied? _(defaults to `false`)_
    * @returns Current value
    */
-  peek(): Value;
+  peek(copy?: boolean): Value;
   /**
    * Subscribe to changes
    *
    * @param callback Callback for changes
-   * @returns Unsubscribe callback
-   */
-  subscribe(callback: (value: Value) => void): Unsubscribe;
-  /**
-   * Unsubscribe from changes
-   *
-   * @param callback Callback to unsubscribe
+   * @param copy If the value is an array or record, should it be copied? _(defaults to `false`)_
+   * @returns Subscription
    */
-  unsubscribe(callback: (value: Value) => void): void;
+  subscribe(callback: (value: Value) => void, copy?: boolean): Subscription;
 };
-type Subscription = {
+export type StoredSubscription = {
   callback: GenericCallback;
+  copy: boolean;
+  frozen: boolean;
   state: ReactiveState<unknown, never>;
-  destroy(): void;
 };
-/**
- * Unsubscribe from changes
- */
-type Unsubscribe = () => void;
-//#endregion
-export { Active, Batch, Computed, ComputedEffect, Effect, EffectState, Reactive, ReactiveArray, ReactiveOptions, ReactiveState, ReactiveStore, SetValueInProxyParameters, Signal, Subscription, Unsubscribe };
+export type SubscriptionType = 'copy' | 'frozen' | 'original' | 'readonly';
+//#endregion