dynoquery 0.1.8 → 0.1.10

package/README.md

@@ -31,9 +31,9 @@ const db = new DynoQuery({
   models: {
     User: { pkPrefix: 'USER#' }, // TENANT#A#USER#
   },
-  indexes: {
+  findBy: {
     //  TENANT#A#CAT#
-    ByCategory: { indexName: 'GSI1', pkPrefix: 'CAT#' } // pkName defaults to GSI1PK, skName defaults to GSI1SK
+    Category: { indexName: 'GSI1', pkPrefix: 'CAT#' } // pkName defaults to GSI1PK, skName defaults to GSI1SK
   }
 });
 
@@ -44,7 +44,7 @@ async function example() {
   
   // Use registered index
   // Resulting GSI1PK: TENANT#A#CAT#1
-  const categories = db.ByCategory('1');
+  const categories = db.findByCategory('1');
   const items = await categories.get('100');
   const allItems = await categories.getAll();
   
@@ -67,14 +67,14 @@ async function example() {
   // Create an item through partition
   await john.create('PROFILE', { name: 'John Doe', email: 'john@example.com' });
   
-  // You can also use getPkValue() to get the generated PK for the partition or index
-  // This is useful when you need to store it in another attribute (e.g., GSI)
-  const cat = db.ByCategory('USER');
+  // Resulting GSI1PK: TENANT#A#CAT#USER
+  const cat = db.findByCategory('USER', '1');
+  console.log(cat.getSkValue()); // '1'
   await john.create('PROFILE', { 
     name: 'John Doe', 
     email: 'john@example.com', 
     GSI1PK: cat.getPkValue(), 
-    GSI1SK: 'john@example.com' 
+    GSI1SK: cat.getSkValue() 
   });
 
   // Update the item (updates both DB and partition cache)
@@ -120,8 +120,9 @@ A way to manage data within a specific partition.
 ### IndexQuery
 A way to query Global Secondary Indexes.
 - `getPkValue()`: Returns the generated partition key value for this index.
-- `get(skValue | options)`: Query items in the index. Supports `skValue` (string) for `begins_with` search, or an options object with `skValue`, `limit`, and `scanIndexForward`.
-- `getAll()`: Fetches all items in the index for the given partition key.
+- `getSkValue()`: Returns the sort key value if it was provided when calling the index query method.
+- `get(skValue | options)`: Query items in the index. Supports `skValue` (string) for `begins_with` search, or an options object with `skValue`, `limit`, and `scanIndexForward`. If `skValue` was provided when the `IndexQuery` was created, it will be used as the default if no `skValue` is passed here.
+- `getAll()`: Fetches all items in the index for the given partition key. If `skValue` was provided when the `IndexQuery` was created, it will filter by it using `begins_with`.
 - Automatically identifies the model name in results using `__model` (based on registered models) and provides `getPartition()` helper.
 
 ## License

package/dist/index-query.d.ts

@@ -6,6 +6,7 @@ export interface IndexQueryConfig {
     skName?: string;
     pkPrefix?: string;
     pkValue: string;
+    skValue?: string;
 }
 export declare class IndexQuery {
     protected db: DynoQuery;
@@ -14,6 +15,7 @@ export declare class IndexQuery {
     protected pkName: string;
     protected skName: string;
     protected pkValue: string;
+    protected skValue?: string;
     constructor(db: DynoQuery, config: IndexQueryConfig);
     get<T = any>(skValueOrOptions?: string | {
         skValue?: string;
@@ -22,5 +24,6 @@ export declare class IndexQuery {
     }): Promise<T[]>;
     getAll<T = any>(): Promise<T[]>;
     getPkValue(): string;
+    getSkValue(): string | undefined;
     private mapItemToModel;
 }

package/dist/index-query.js

@@ -18,6 +18,7 @@ class IndexQuery {
         this.indexName = config.indexName;
         this.pkName = config.pkName || (this.indexName + "PK");
         this.skName = config.skName || (this.indexName + "SK");
+        this.skValue = config.skValue;
         const globalPrefix = db.getPkPrefix();
         const indexPrefix = config.pkPrefix || "";
         let finalPrefix = indexPrefix;
@@ -38,6 +39,9 @@ class IndexQuery {
             else if (typeof skValueOrOptions === 'object') {
                 options = skValueOrOptions;
             }
+            else if (this.skValue) {
+                options.skValue = this.skValue;
+            }
             let keyCondition = "#pk = :pk";
             const expressionAttributeNames = {
                 "#pk": this.pkName,
@@ -71,6 +75,9 @@ class IndexQuery {
     getPkValue() {
         return this.pkValue;
     }
+    getSkValue() {
+        return this.skValue;
+    }
     mapItemToModel(item) {
         const pkName = this.db.getPkName();
         const pkValue = item[pkName];

package/dist/index.d.ts

@@ -14,7 +14,7 @@ export interface DynoQueryConfig {
     models?: Record<string, {
         pkPrefix: string;
     }>;
-    indexes?: Record<string, {
+    findBy?: Record<string, {
         indexName: string;
         pkName?: string;
         skName?: string;

package/dist/index.js

@@ -41,7 +41,7 @@ const partition_1 = require("./partition");
 class DynoQuery {
     constructor(config = {}) {
         this.registeredModels = {};
-        const { tableName, pkName, skName, pkPrefix, models, indexes } = config, clientConfig = __rest(config, ["tableName", "pkName", "skName", "pkPrefix", "models", "indexes"]);
+        const { tableName, pkName, skName, pkPrefix, models, findBy } = config, clientConfig = __rest(config, ["tableName", "pkName", "skName", "pkPrefix", "models", "findBy"]);
         this.client = new client_dynamodb_1.DynamoDBClient(clientConfig);
         this.docClient = lib_dynamodb_1.DynamoDBDocumentClient.from(this.client, {
             marshallOptions: {
@@ -60,16 +60,18 @@ class DynoQuery {
                 };
             });
         }
-        if (indexes) {
+        if (findBy) {
             const { IndexQuery } = require("./index-query");
-            Object.entries(indexes).forEach(([name, def]) => {
-                this[name] = (id) => {
+            Object.entries(findBy).forEach(([name, def]) => {
+                const methodName = `findBy${name}`;
+                this[methodName] = (id, skValue) => {
                     return new IndexQuery(this, {
                         indexName: def.indexName,
                         pkName: def.pkName,
                         skName: def.skName,
                         pkPrefix: def.pkPrefix,
-                        pkValue: id
+                        pkValue: id,
+                        skValue: skValue
                     });
                 };
             });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dynoquery",
-  "version": "0.1.8",
+  "version": "0.1.10",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/devspikejs/dynoquery.git"