montycat 1.1.3 → 1.1.4

package/dist/classes/generic.js

@@ -132,19 +132,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 +200,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 });

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

@@ -15,6 +15,35 @@ declare class Persistent extends GenericKV {
         password: string;
         [key: string]: any;
     });
+    /**
+     * Subscribes to changes in the persistent store based on the provided options.
+     * @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.
+     * @return A promise that resolves with the result of the subscription.
+     * Note: Subscriptions are only allowed on non-persistent keyspaces, so this method will throw an error if called on a persistent keyspace.
+     * The effective key for the subscription is determined by the presence of a custom key or a regular key, with the custom key taking precedence if both are provided.
+     * The subscription query is constructed with the appropriate parameters and sent to the server using the runQuery function, with the callback function passed to handle incoming data.
+     * If the subscription is successful, the promise will resolve with the result of the subscription; otherwise, it will reject with an error.
+     * Error handling is implemented to ensure that subscriptions are not allowed on persistent keyspaces, and that a key is provided for the subscription.
+     * The method is designed to facilitate real-time updates and notifications for changes in the keyspace, allowing clients to react to data changes as they occur.
+     * Overall, this method provides a mechanism for clients to stay informed about changes in the persistent store, while enforcing the constraints of the keyspace type and ensuring that necessary parameters are provided for the subscription.
+     * @throws Will throw an error if subscriptions are attempted on a persistent keyspace or if no key is provided for the subscription.
+     * @example
+     * Persistent.subscribe({
+     *   callback: (data) => {
+     *    console.log("Received data:", data);
+     *  },
+     *  key: "myKey"
+     * });
+     * @example
+     * Persistent.subscribe({
+     *  callback: (data) => {
+     *   console.log("Received data for custom key:", data);
+     * },
+     * customKey: "myCustomKey"
+     * });
+     */
     static subscribe({ callback, key, customKey }: {
         callback?: (data: any) => void;
         key?: string;
@@ -29,9 +58,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 +88,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?: {

package/dist/core/persistent.js

@@ -14,6 +14,35 @@ class Persistent extends GenericKV {
         super(options);
         this.keyspace = options.keyspace;
     }
+    /**
+     * Subscribes to changes in the persistent store based on the provided options.
+     * @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.
+     * @return A promise that resolves with the result of the subscription.
+     * Note: Subscriptions are only allowed on non-persistent keyspaces, so this method will throw an error if called on a persistent keyspace.
+     * The effective key for the subscription is determined by the presence of a custom key or a regular key, with the custom key taking precedence if both are provided.
+     * The subscription query is constructed with the appropriate parameters and sent to the server using the runQuery function, with the callback function passed to handle incoming data.
+     * If the subscription is successful, the promise will resolve with the result of the subscription; otherwise, it will reject with an error.
+     * Error handling is implemented to ensure that subscriptions are not allowed on persistent keyspaces, and that a key is provided for the subscription.
+     * The method is designed to facilitate real-time updates and notifications for changes in the keyspace, allowing clients to react to data changes as they occur.
+     * Overall, this method provides a mechanism for clients to stay informed about changes in the persistent store, while enforcing the constraints of the keyspace type and ensuring that necessary parameters are provided for the subscription.
+     * @throws Will throw an error if subscriptions are attempted on a persistent keyspace or if no key is provided for the subscription.
+     * @example
+     * Persistent.subscribe({
+     *   callback: (data) => {
+     *    console.log("Received data:", data);
+     *  },
+     *  key: "myKey"
+     * });
+     * @example
+     * Persistent.subscribe({
+     *  callback: (data) => {
+     *   console.log("Received data for custom key:", data);
+     * },
+     * customKey: "myCustomKey"
+     * });
+     */
     static async subscribe({ callback, key, customKey }) {
         const effectiveKey = customKey ? convertCustomKey(customKey) : (key || null);
         const queryObj = {
@@ -38,9 +67,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 +110,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 +123,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 });

package/package.json

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