montycat 1.1.3 → 1.1.5

package/dist/classes/generic.d.ts

@@ -173,5 +173,18 @@ declare class GenericKV {
      * @returns The current instance of GenericKV.
      */
     showStoreProperties(): this;
+    /**
+     * Subscribes to changes in the keyspace.
+     * Inherited by InMemory and Persistent - `this.persistent` resolves correctly per subclass.
+     * @param callback - A callback function to handle incoming data.
+     * @param key - A specific key to subscribe to.
+     * @param customKey - A custom key to subscribe to (will be hashed with XXH32).
+     * @returns A promise that resolves with a subscription handle ({ stop() }).
+     */
+    static subscribe({ callback, key, customKey }: {
+        callback?: (data: any) => void;
+        key?: string;
+        customKey?: string;
+    }): Promise<any>;
 }
 export default GenericKV;

package/dist/classes/generic.js

@@ -34,15 +34,15 @@ class GenericKV {
      * @return A promise that resolves with the retrieved value.
      */
     static async getValue({ key = "", customKey = null, withPointers = false, keyIncluded = false, pointersMetadata = false } = {}) {
-        if (pointersMetadata && withPointers) {
-            throw new Error("You select both pointers value and pointers metadata. Choose one");
-        }
         try {
+            if (key && customKey) {
+                throw new Error("Provide either 'key' or 'customKey', not both.");
+            }
+            if (!key && !customKey) {
+                throw new Error("Provide either 'key' or 'customKey'.");
+            }
             if (customKey)
                 key = convertCustomKey(customKey);
-            if (!key) {
-                throw new Error("No key provided");
-            }
             this.command = "get_value";
             const query = convertToBinaryQuery(this, { key, withPointers, keyIncluded, pointersMetadata });
             return runQuery(this, query);
@@ -59,11 +59,14 @@ class GenericKV {
      * */
     static async listAllDependingKeys({ key = "", customKey = null } = {}) {
         try {
+            if (key && customKey) {
+                throw new Error("Provide either 'key' or 'customKey', not both.");
+            }
+            if (!key && !customKey) {
+                throw new Error("Provide either 'key' or 'customKey'.");
+            }
             if (customKey)
                 key = convertCustomKey(customKey);
-            if (!key) {
-                throw new Error("No key provided");
-            }
             this.command = "list_all_depending_keys";
             const query = convertToBinaryQuery(this, { key });
             return runQuery(this, query);
@@ -85,6 +88,9 @@ class GenericKV {
      * */
     static async deleteKey({ key = "", customKey = null } = {}) {
         try {
+            if (key && customKey) {
+                throw new Error("Provide either 'key' or 'customKey', not both.");
+            }
             if (customKey)
                 key = convertCustomKey(customKey);
             if (!key) {
@@ -132,19 +138,15 @@ class GenericKV {
      * @returns A promise that resolves with the retrieved keys.
      */
     static async getBulk({ bulkKeys = [], bulkCustomKeys = [], limitOutput = { start: 0, stop: 0 }, withPointers = false, keyIncluded = false, pointersMetadata = false, volumes = [], latestVolume = false } = {}) {
-        if (pointersMetadata && withPointers) {
-            throw new Error("You select both pointers value and pointers metadata. Choose one");
-        }
         try {
             if (bulkCustomKeys.length)
                 bulkKeys = bulkKeys.concat(convertCustomKeys(bulkCustomKeys));
             const selectedOptions = [
                 bulkKeys.length > 0,
-                volumes.length > 0,
-                latestVolume
+                volumes.length > 0 || latestVolume || (limitOutput.start !== 0 || limitOutput.stop !== 0),
             ].filter(Boolean).length;
             if (selectedOptions !== 1) {
-                throw new Error("Multiple conflicting options provided. Please provide exactly one of the following: keys, volumes, or latest volume.");
+                throw new Error("Please provide keys or volumes/latest volume or limit.");
             }
             this.command = "get_bulk";
             const query = convertToBinaryQuery(this, { bulkKeys, limitOutput, withPointers, keyIncluded, pointersMetadata, volumes, latestVolume });
@@ -204,9 +206,6 @@ class GenericKV {
      * @return A promise that resolves with the result of the lookup.
      */
     static async lookupValuesWhere({ searchCriteria = {}, limitOutput = { start: 0, stop: 0 }, withPointers = false, schema = null, keyIncluded = false, pointersMetadata = false } = {}) {
-        if (pointersMetadata && withPointers) {
-            throw new Error("You select both pointers value and pointers metadata. Choose one");
-        }
         try {
             this.command = "lookup_values";
             const query = convertToBinaryQuery(this, { searchCriteria, limitOutput, withPointers, schema, keyIncluded, pointersMetadata });
@@ -308,5 +307,29 @@ class GenericKV {
     showStoreProperties() {
         return this;
     }
+    /**
+     * Subscribes to changes in the keyspace.
+     * Inherited by InMemory and Persistent - `this.persistent` resolves correctly per subclass.
+     * @param callback - A callback function to handle incoming data.
+     * @param key - A specific key to subscribe to.
+     * @param customKey - A custom key to subscribe to (will be hashed with XXH32).
+     * @returns A promise that resolves with a subscription handle ({ stop() }).
+     */
+    static async subscribe({ callback, key, customKey }) {
+        if (key && customKey) {
+            throw new Error("Provide either 'key' or 'customKey', not both.");
+        }
+        const effectiveKey = customKey ? convertCustomKey(customKey) : (key || null);
+        const queryObj = {
+            subscribe: true,
+            store: this.store,
+            keyspace: this.keyspace,
+            username: this.username,
+            password: this.password,
+            persistent: this.persistent,
+            key: effectiveKey,
+        };
+        return await runQuery(this, JSON.stringify(queryObj), callback, true);
+    }
 }
 export default GenericKV;

package/dist/core/inmemory.js

@@ -151,8 +151,8 @@ class InMemory extends GenericKV {
      * @returns A promise that resolves with the retrieved keys.
      */
     static async getKeys({ volumes = [], latestVolume = false } = {}) {
-        if (latestVolume && volumes.length > 0) {
-            throw new Error("Select either latest volume or volumes list, not both.");
+        if ((!volumes || volumes.length === 0) && !latestVolume) {
+            throw new Error("Please provide volumes/latest volume.");
         }
         this.command = "get_keys";
         const query = convertToBinaryQuery(this, { volumes, latestVolume });

package/dist/core/persistent.d.ts

@@ -6,8 +6,6 @@ import GenericKV from '../classes/generic.js';
 declare class Persistent extends GenericKV {
     static persistent: boolean;
     static distributed: boolean;
-    static cache: number | null;
-    static compression: boolean;
     keyspace: string;
     constructor(options: {
         keyspace: string;
@@ -15,11 +13,6 @@ declare class Persistent extends GenericKV {
         password: string;
         [key: string]: any;
     });
-    static subscribe({ callback, key, customKey }: {
-        callback?: (data: any) => void;
-        key?: string;
-        customKey?: string;
-    }): Promise<any>;
     /**
      * Inserts a value into the persistent store.
      * @param value - The value to insert.
@@ -29,9 +22,8 @@ declare class Persistent extends GenericKV {
         value?: any;
     }): Promise<any>;
     /**
-     * Inserts a key-value pair into the persistent store.
-     * @param key - The key for the value.
-     * @param value - The value to insert.
+     * Inserts a custom key into the persistent store.
+     * @param customKey - The custom key to insert.
      * @return A promise that resolves with the result of the insertion.
      */
     static insertCustomKey({ customKey }: {
@@ -60,19 +52,19 @@ declare class Persistent extends GenericKV {
         value?: any;
     }): Promise<any>;
     /**
-     * Retrieves a value from the persistent store.
-     * @param key - The key for the value to retrieve.
-     * @param customKey - The custom key for the value to retrieve.
-     * @return A promise that resolves with the retrieved value.
+     * Inserts multiple key-value pairs into the persistent store in bulk.
+     * @param bulk - An array of key-value pairs to insert.
+     * @return A promise that resolves with the result of the bulk insertion.
      */
     static insertBulk({ bulk }?: {
         bulk?: any[];
     }): Promise<any>;
     /**
-     * Retrieves a value from the persistent store.
-     * @param key - The key for the value to retrieve.
-     * @param customKey - The custom key for the value to retrieve.
-     * @return A promise that resolves with the retrieved value.
+     * Retrieves keys from the persistent store based on provided options.
+     * @param limitOutput - An object specifying the start and stop limits for output.
+     * @param latestVolume - A boolean indicating whether to retrieve keys from the latest volume.
+     * @param volumes - An array of volume names to retrieve keys from.
+     * @returns A promise that resolves with the retrieved keys.
      */
     static getKeys({ limitOutput, latestVolume, volumes }?: {
         limitOutput?: {
@@ -84,16 +76,22 @@ declare class Persistent extends GenericKV {
     }): Promise<any>;
     /**
      * Updates the cache and compression settings for the persistent store.
-     * @param cache - The cache settings to apply.
-     * @param compression - Whether to enable compression.
+     * @param options - Optional cache (number) and compression (boolean) settings.
      * @return A promise that resolves with the result of the update.
      */
-    static updateCacheAndCompression(): Promise<any>;
+    static updateCacheAndCompression({ cache, compression }?: {
+        cache?: number;
+        compression?: boolean;
+    }): Promise<any>;
     /**
      * Creates a keyspace in the persistent store.
+     * @param options - Optional cache (number) and compression (boolean) settings.
      * @return A promise that resolves with the result of the keyspace creation.
      */
-    static createKeyspace(): Promise<any>;
+    static createKeyspace({ cache, compression }?: {
+        cache?: number;
+        compression?: boolean;
+    }): Promise<any>;
 }
 /**
  * PersistentDistributed class that extends Persistent for distributed persistent keyspace operations.

package/dist/core/persistent.js

@@ -7,26 +7,11 @@ import GenericKV from '../classes/generic.js';
 class Persistent extends GenericKV {
     static persistent = true;
     static distributed = false;
-    static cache = null;
-    static compression = false;
     keyspace;
     constructor(options) {
         super(options);
         this.keyspace = options.keyspace;
     }
-    static async subscribe({ callback, key, customKey }) {
-        const effectiveKey = customKey ? convertCustomKey(customKey) : (key || null);
-        const queryObj = {
-            subscribe: true,
-            key: effectiveKey,
-            keyspace: this.keyspace,
-            store: this.store,
-            username: this.username,
-            password: this.password
-        };
-        const query = JSON.stringify(queryObj);
-        return await runQuery(this, query, callback, true);
-    }
     /**
      * Inserts a value into the persistent store.
      * @param value - The value to insert.
@@ -38,9 +23,8 @@ class Persistent extends GenericKV {
         return runQuery(this, query);
     }
     /**
-     * Inserts a key-value pair into the persistent store.
-     * @param key - The key for the value.
-     * @param value - The value to insert.
+     * Inserts a custom key into the persistent store.
+     * @param customKey - The custom key to insert.
      * @return A promise that resolves with the result of the insertion.
      */
     static async insertCustomKey({ customKey }) {
@@ -82,10 +66,9 @@ class Persistent extends GenericKV {
         return runQuery(this, query);
     }
     /**
-     * Retrieves a value from the persistent store.
-     * @param key - The key for the value to retrieve.
-     * @param customKey - The custom key for the value to retrieve.
-     * @return A promise that resolves with the retrieved value.
+     * Inserts multiple key-value pairs into the persistent store in bulk.
+     * @param bulk - An array of key-value pairs to insert.
+     * @return A promise that resolves with the result of the bulk insertion.
      */
     static async insertBulk({ bulk = [] } = {}) {
         if (!bulk || bulk.length === 0) {
@@ -96,14 +79,15 @@ class Persistent extends GenericKV {
         return runQuery(this, query);
     }
     /**
-     * Retrieves a value from the persistent store.
-     * @param key - The key for the value to retrieve.
-     * @param customKey - The custom key for the value to retrieve.
-     * @return A promise that resolves with the retrieved value.
+     * Retrieves keys from the persistent store based on provided options.
+     * @param limitOutput - An object specifying the start and stop limits for output.
+     * @param latestVolume - A boolean indicating whether to retrieve keys from the latest volume.
+     * @param volumes - An array of volume names to retrieve keys from.
+     * @returns A promise that resolves with the retrieved keys.
      */
     static async getKeys({ limitOutput = { start: 0, stop: 0 }, latestVolume = false, volumes = [] } = {}) {
-        if (latestVolume && volumes.length > 0) {
-            throw new Error("Select either latest volume or volumes list, not both.");
+        if ((!volumes || volumes.length === 0) && !latestVolume && (!limitOutput || (limitOutput.start === 0 && limitOutput.stop === 0))) {
+            throw new Error("Please provide volumes/latest volume or limit.");
         }
         this.command = "get_keys";
         const query = convertToBinaryQuery(this, { limitOutput, latestVolume, volumes });
@@ -111,21 +95,22 @@ class Persistent extends GenericKV {
     }
     /**
      * Updates the cache and compression settings for the persistent store.
-     * @param cache - The cache settings to apply.
-     * @param compression - Whether to enable compression.
+     * @param options - Optional cache (number) and compression (boolean) settings.
      * @return A promise that resolves with the result of the update.
      */
-    static async updateCacheAndCompression() {
+    static async updateCacheAndCompression({ cache, compression } = {}) {
         if (!this.persistent) {
             throw new Error("Cache and compression settings can only be updated for persistent keyspaces.");
         }
+        const cacheValue = cache !== undefined ? cache.toString() : "0";
+        const compressionValue = compression === true ? "y" : "n";
         const query = {
             raw: [
                 "update-cache-compression",
                 "store", this.store,
                 "keyspace", this.keyspace,
-                "cache", this.cache ? this.cache : "0",
-                "compression", this.compression ? "y" : "n"
+                "cache", cacheValue,
+                "compression", compressionValue
             ],
             credentials: [this.username, this.password],
         };
@@ -133,9 +118,12 @@ class Persistent extends GenericKV {
     }
     /**
      * Creates a keyspace in the persistent store.
+     * @param options - Optional cache (number) and compression (boolean) settings.
      * @return A promise that resolves with the result of the keyspace creation.
      */
-    static async createKeyspace() {
+    static async createKeyspace({ cache, compression } = {}) {
+        const cacheValue = cache !== undefined ? cache.toString() : "0";
+        const compressionValue = compression === true ? "y" : "n";
         const query = {
             raw: [
                 "create-keyspace",
@@ -143,8 +131,8 @@ class Persistent extends GenericKV {
                 "keyspace", this.keyspace,
                 "persistent", this.persistent ? "y" : "n",
                 "distributed", this.distributed ? "y" : "n",
-                "cache", this.cache ? this.cache : "0",
-                "compression", this.compression ? "y" : "n"
+                "cache", cacheValue,
+                "compression", compressionValue
             ],
             credentials: [this.username, this.password],
         };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "montycat",
-  "version": "1.1.3",
+  "version": "1.1.5",
   "description": "A Node.js client for Montycat, NoSQL database utilizing Data Mesh architecture.",
   "type": "module",
   "main": "dist/index.js",