From b6a4aba2e5fc51585d69b047a9bd22c49ed2098a Mon Sep 17 00:00:00 2001
From: Ali Mihandoost <ali.mihandoost@gmail.com>
Date: Mon, 2 Sep 2024 13:54:20 +0330
Subject: [PATCH] refactor: Update type imports in alwatr-store.ts

Refactor the type imports in alwatr-store.ts to use the `JsonObject` type instead of `JsonifiableObject`. This aligns with the recent refactoring of the type definitions in the repository.
---
 .../reference/src/collection-reference.ts     | 24 ++++++-------
 packages/reference/src/document-reference.ts  | 36 +++++++++----------
 2 files changed, 30 insertions(+), 30 deletions(-)

diff --git a/packages/reference/src/collection-reference.ts b/packages/reference/src/collection-reference.ts
index daaaa409..979d7ad9 100644
--- a/packages/reference/src/collection-reference.ts
+++ b/packages/reference/src/collection-reference.ts
@@ -13,7 +13,7 @@ import {waitForImmediate, waitForTimeout} from '@alwatr/wait';
 import {logger} from './logger.js';
 import {getStoreId, getStorePath} from './util.js';
 
-import type {Dictionary, JsonifiableObject} from '@alwatr/type-helper';
+import type {Dictionary, JsonObject} from '@alwatr/type-helper';
 
 logger.logModule?.('collection-reference');
 
@@ -23,7 +23,7 @@ logger.logModule?.('collection-reference');
  *
  * @template TItem - The data type of the collection items.
  */
-export class CollectionReference<TItem extends JsonifiableObject = JsonifiableObject> {
+export class CollectionReference<TItem extends JsonObject = JsonObject> {
   /**
    * Alwatr store engine version string.
    */
@@ -43,7 +43,7 @@ export class CollectionReference<TItem extends JsonifiableObject = JsonifiableOb
    * @template TItem The collection item data type.
    * @returns A new collection reference class.
    */
-  static newRefFromData<TItem extends JsonifiableObject>(
+  static newRefFromData<TItem extends JsonObject>(
     stat: StoreFileId,
     initialData: CollectionContext<TItem>['data'] | null,
     updatedCallback: (from: CollectionReference<TItem>) => void,
@@ -79,7 +79,7 @@ export class CollectionReference<TItem extends JsonifiableObject = JsonifiableOb
    * @template TItem The collection item data type.
    * @returns A new collection reference class.
    */
-  static newRefFromContext<TItem extends JsonifiableObject>(
+  static newRefFromContext<TItem extends JsonObject>(
     context: CollectionContext<TItem>,
     updatedCallback: (from: CollectionReference<TItem>) => void,
     debugDomain?: string,
@@ -147,7 +147,7 @@ export class CollectionReference<TItem extends JsonifiableObject = JsonifiableOb
       this.context__.meta.fv = 3;
     }
 
-    this.save();
+    this.updated__();
   }
 
   /**
@@ -214,7 +214,7 @@ export class CollectionReference<TItem extends JsonifiableObject = JsonifiableOb
   set schemaVer(ver: number) {
     this.logger__.logMethodArgs?.('set schemaVer', {old: this.context__.meta.schemaVer, new: ver});
     this.context__.meta.schemaVer = ver;
-    this.save();
+    this.updated__();
   }
 
   /**
@@ -420,7 +420,7 @@ export class CollectionReference<TItem extends JsonifiableObject = JsonifiableOb
   removeItem(itemId: string | number): void {
     this.logger__.logMethodArgs?.('removeItem', itemId);
     delete this.context__.data[itemId];
-    this.updated__(null);
+    this.updated__();
   }
 
   /**
@@ -574,13 +574,13 @@ export class CollectionReference<TItem extends JsonifiableObject = JsonifiableOb
    * Update the document metadata and invoke the updated callback.
    * This method is throttled to prevent multiple updates in a short time.
    *
-   * @param id - The ID of the item to update.
+   * @param itemId - The ID of the item to update.
    */
-  private async updated__(id: string | number | null, immediate = false): Promise<void> {
-    this.logger__.logMethodArgs?.('updated__', {id, immediate, delayed: this.updateDelayed_});
+  private async updated__(itemId: string | number | null = null, immediate = false): Promise<void> {
+    this.logger__.logMethodArgs?.('updated__', {id: itemId, immediate, delayed: this.updateDelayed_});
 
     this.hasUnprocessedChanges_ = true;
-    if (id !== null) this.refreshMeta_(id); // meta must updated per item
+    if (itemId !== null) this.refreshMeta_(itemId); // meta must updated per item
 
     if (immediate === false && this.updateDelayed_ === true) return;
     // else
@@ -597,7 +597,7 @@ export class CollectionReference<TItem extends JsonifiableObject = JsonifiableOb
     if (this.updateDelayed_ !== true) return; // another parallel update finished!
     this.updateDelayed_ = false;
 
-    if (id === null) this.refreshMeta_(id); // root meta not updated for null
+    if (itemId === null) this.refreshMeta_(itemId); // root meta not updated for null
 
     if (this._freeze === true) return; // prevent save if frozen
     this.updatedCallback__.call(null, this);
diff --git a/packages/reference/src/document-reference.ts b/packages/reference/src/document-reference.ts
index 959ddf65..b693b700 100644
--- a/packages/reference/src/document-reference.ts
+++ b/packages/reference/src/document-reference.ts
@@ -5,7 +5,7 @@ import {waitForImmediate, waitForTimeout} from '@alwatr/wait';
 import {logger} from './logger.js';
 import {getStoreId, getStorePath} from './util.js';
 
-import type {Dictionary, JsonifiableObject} from '@alwatr/type-helper';
+import type {Dictionary, JsonObject} from '@alwatr/type-helper';
 
 logger.logModule?.('document-reference');
 
@@ -13,7 +13,7 @@ logger.logModule?.('document-reference');
  * Represents a reference to a document of the AlwatrStore.
  * Provides methods to interact with the document, such as get, set, update and save.
  */
-export class DocumentReference<TDoc extends JsonifiableObject = JsonifiableObject> {
+export class DocumentReference<TDoc extends JsonObject = JsonObject> {
   /**
    * Alwatr store engine version string.
    */
@@ -33,7 +33,7 @@ export class DocumentReference<TDoc extends JsonifiableObject = JsonifiableObjec
    * @template TDoc The document data type.
    * @returns A new document reference class.
    */
-  static newRefFromData<TDoc extends JsonifiableObject>(
+  static newRefFromData<TDoc extends JsonObject>(
     statId: StoreFileId,
     initialData: TDoc,
     updatedCallback: (from: DocumentReference<TDoc>) => unknown,
@@ -68,7 +68,7 @@ export class DocumentReference<TDoc extends JsonifiableObject = JsonifiableObjec
    * @template TDoc The document data type.
    * @returns A new document reference class.
    */
-  static newRefFromContext<TDoc extends JsonifiableObject>(
+  static newRefFromContext<TDoc extends JsonObject>(
     context: DocumentContext<TDoc>,
     updatedCallback: (from: DocumentReference<TDoc>) => unknown,
     debugDomain?: string,
@@ -136,7 +136,7 @@ export class DocumentReference<TDoc extends JsonifiableObject = JsonifiableObjec
       this.context__.meta.fv = 3;
     }
 
-    this.save();
+    this.updated__();
   }
 
   /**
@@ -150,7 +150,7 @@ export class DocumentReference<TDoc extends JsonifiableObject = JsonifiableObjec
   readonly path: string;
 
   /**
-   * Indicates whether the collection has unsaved changes.
+   * Indicates whether the document has unsaved changes.
    */
   hasUnprocessedChanges_ = false;
 
@@ -198,22 +198,22 @@ export class DocumentReference<TDoc extends JsonifiableObject = JsonifiableObjec
   set schemaVer(ver: number) {
     this.logger__.logMethodArgs?.('set schemaVer', {old: this.context__.meta.schemaVer, new: ver});
     this.context__.meta.schemaVer = ver;
-    this.save();
+    this.updated__();
   }
 
   /**
-   * Indicates whether the collection data is frozen and cannot be saved.
+   * Indicates whether the document data is frozen and cannot be saved.
    */
   private _freeze = false;
 
   /**
-   * Gets the freeze status of the collection data.
+   * Gets the freeze status of the document data.
    *
-   * @returns `true` if the collection data is frozen, `false` otherwise.
+   * @returns `true` if the document data is frozen, `false` otherwise.
    *
    * @example
    * ```typescript
-   * const isFrozen = collectionRef.freeze;
+   * const isFrozen = documentRef.freeze;
    * console.log(isFrozen); // Output: false
    * ```
    */
@@ -222,14 +222,14 @@ export class DocumentReference<TDoc extends JsonifiableObject = JsonifiableObjec
   }
 
   /**
-   * Sets the freeze status of the collection data.
+   * Sets the freeze status of the document data.
    *
    * @param value - The freeze status to set.
    *
    * @example
    * ```typescript
-   * collectionRef.freeze = true;
-   * console.log(collectionRef.freeze); // Output: true
+   * documentRef.freeze = true;
+   * console.log(documentRef.freeze); // Output: true
    * ```
    */
   set freeze(value: boolean) {
@@ -274,11 +274,11 @@ export class DocumentReference<TDoc extends JsonifiableObject = JsonifiableObjec
    *
    * @example
    * ```typescript
-   * documentRef.overwriteData({ a: 1, b: 2, c: 3 });
+   * documentRef.replaceData({ a: 1, b: 2, c: 3 });
    * ```
    */
   replaceData(data: TDoc): void {
-    this.logger__.logMethodArgs?.('overwriteData', data);
+    this.logger__.logMethodArgs?.('replaceData', data);
     (this.context__.data as unknown) = data;
     this.updated__();
   }
@@ -310,7 +310,7 @@ export class DocumentReference<TDoc extends JsonifiableObject = JsonifiableObjec
    */
   save(): void {
     this.logger__.logMethod?.('save');
-    this.updated__(false);
+    this.updated__();
   }
 
   /**
@@ -323,7 +323,7 @@ export class DocumentReference<TDoc extends JsonifiableObject = JsonifiableObjec
    */
   saveImmediate(): void {
     this.logger__.logMethod?.('saveImmediate');
-    this.updated__(true);
+    this.updated__(/* immediate: */ true);
   }
 
   /**