dynoquery 0.1.8 → 0.1.9

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,9 +67,8 @@ 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');
   await john.create('PROFILE', { 
     name: 'John Doe', 
     email: 'john@example.com', 

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,10 +60,11 @@ 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) => {
                     return new IndexQuery(this, {
                         indexName: def.indexName,
                         pkName: def.pkName,

package/package.json

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