@asaidimu/utils-database 3.1.5 → 3.1.7

package/index.d.mts

@@ -738,7 +738,8 @@ declare class IndexedDBStore<T extends Record<string, any>> implements Store<T>
  */
 declare const createIndexedDbStore: <T extends Record<string, any>>(config: StoreConfig) => Store<T>;
 
-declare function DatabaseConnection(config: Omit<DatabaseConfig, "keyPath">, createStore: <T extends Record<string, any>>(config: StoreConfig, indexes: IndexDefinition[]) => Store<T>): Promise<Database>;
+type StoreFactory = <T extends Record<string, any>>(config: StoreConfig, indexes: IndexDefinition[]) => Store<T>;
+declare function DatabaseConnection(config: Omit<DatabaseConfig, "keyPath">, createStore: StoreFactory): Promise<Database>;
 
 interface MutexOptions {
     /**
@@ -843,10 +844,18 @@ interface EventBus<TEventMap extends Record<string, any>> {
     metrics: () => EventMetrics;
     /**
      * Clears all subscriptions and resets metrics.
-     * After calling clear(), the bus is fully reset and can be reused —
+     *
+     * After calling `clear()`, the bus is fully reset and can be reused
      * cross-tab communication is re-established if it was previously enabled.
+     *
+     * @param options - Optional configuration object.
+     * @param options.permanent - If `true`, the bus becomes permanently unusable after clearing.
+     *                            Defaults to `false`.
+     * @returns {void}
      */
-    clear: () => void;
+    clear: (options?: {
+        permanent?: boolean;
+    }) => void;
 }
 /**
  * Interface defining the metrics tracked by the EventBus.
@@ -977,4 +986,4 @@ declare class DatabaseError extends Error {
     constructor(type: DatabaseErrorType, message: string, schema?: SchemaDefinition, cause?: unknown, issues?: any);
 }
 
-export { type BufferedOperation, type Collection, type CollectionEvent, type CollectionEventType, type CollectionMigrationOptions, ConnectionManager, type CursorCallback, type CursorCallbackResult, type CursorPaginationOptions, DEFAULT_KEYPATH, type Database, type DatabaseConfig, DatabaseConnection, DatabaseError, DatabaseErrorType, type DatabaseEvent, type DatabaseEventType, type Document, type DocumentEvent, type DocumentEventType, type DocumentMetadata, IndexedDBStore, type Store, type StoreConfig, type StoreKeyRange, type TelemetryEvent, type TelemetryEventType, createDocument, createEphemeralStore, createIndexedDbStore, openCollection };
+export { type BufferedOperation, type Collection, type CollectionEvent, type CollectionEventType, type CollectionMigrationOptions, ConnectionManager, type CursorCallback, type CursorCallbackResult, type CursorPaginationOptions, DEFAULT_KEYPATH, type Database, type DatabaseConfig, DatabaseConnection, DatabaseError, DatabaseErrorType, type DatabaseEvent, type DatabaseEventType, type Document, type DocumentEvent, type DocumentEventType, type DocumentMetadata, IndexedDBStore, type Store, type StoreConfig, type StoreFactory, type StoreKeyRange, type TelemetryEvent, type TelemetryEventType, createDocument, createEphemeralStore, createIndexedDbStore, openCollection };

package/index.d.ts

@@ -738,7 +738,8 @@ declare class IndexedDBStore<T extends Record<string, any>> implements Store<T>
  */
 declare const createIndexedDbStore: <T extends Record<string, any>>(config: StoreConfig) => Store<T>;
 
-declare function DatabaseConnection(config: Omit<DatabaseConfig, "keyPath">, createStore: <T extends Record<string, any>>(config: StoreConfig, indexes: IndexDefinition[]) => Store<T>): Promise<Database>;
+type StoreFactory = <T extends Record<string, any>>(config: StoreConfig, indexes: IndexDefinition[]) => Store<T>;
+declare function DatabaseConnection(config: Omit<DatabaseConfig, "keyPath">, createStore: StoreFactory): Promise<Database>;
 
 interface MutexOptions {
     /**
@@ -843,10 +844,18 @@ interface EventBus<TEventMap extends Record<string, any>> {
     metrics: () => EventMetrics;
     /**
      * Clears all subscriptions and resets metrics.
-     * After calling clear(), the bus is fully reset and can be reused —
+     *
+     * After calling `clear()`, the bus is fully reset and can be reused
      * cross-tab communication is re-established if it was previously enabled.
+     *
+     * @param options - Optional configuration object.
+     * @param options.permanent - If `true`, the bus becomes permanently unusable after clearing.
+     *                            Defaults to `false`.
+     * @returns {void}
      */
-    clear: () => void;
+    clear: (options?: {
+        permanent?: boolean;
+    }) => void;
 }
 /**
  * Interface defining the metrics tracked by the EventBus.
@@ -977,4 +986,4 @@ declare class DatabaseError extends Error {
     constructor(type: DatabaseErrorType, message: string, schema?: SchemaDefinition, cause?: unknown, issues?: any);
 }
 
-export { type BufferedOperation, type Collection, type CollectionEvent, type CollectionEventType, type CollectionMigrationOptions, ConnectionManager, type CursorCallback, type CursorCallbackResult, type CursorPaginationOptions, DEFAULT_KEYPATH, type Database, type DatabaseConfig, DatabaseConnection, DatabaseError, DatabaseErrorType, type DatabaseEvent, type DatabaseEventType, type Document, type DocumentEvent, type DocumentEventType, type DocumentMetadata, IndexedDBStore, type Store, type StoreConfig, type StoreKeyRange, type TelemetryEvent, type TelemetryEventType, createDocument, createEphemeralStore, createIndexedDbStore, openCollection };
+export { type BufferedOperation, type Collection, type CollectionEvent, type CollectionEventType, type CollectionMigrationOptions, ConnectionManager, type CursorCallback, type CursorCallbackResult, type CursorPaginationOptions, DEFAULT_KEYPATH, type Database, type DatabaseConfig, DatabaseConnection, DatabaseError, DatabaseErrorType, type DatabaseEvent, type DatabaseEventType, type Document, type DocumentEvent, type DocumentEventType, type DocumentMetadata, IndexedDBStore, type Store, type StoreConfig, type StoreFactory, type StoreKeyRange, type TelemetryEvent, type TelemetryEventType, createDocument, createEphemeralStore, createIndexedDbStore, openCollection };