dynoquery 0.1.16 → 0.1.18

package/README.md

@@ -66,7 +66,7 @@ async function userExample() {
 
 #### Second-Level Objects (Single-Row Operations)
 
-For a more flexible way to work with individual rows, you can use `draft()` and `get()` to obtain an `Item` object, then call `create()`, `update()`, or `save()` on it directly.
+For a more flexible way to work with individual rows, you can use `draft()` and `get()` to obtain an `Item` object, then call `create()`, `update()`, or `save()` on it directly. You can also use a shorthand by passing a second argument to your model function (as shown in the examples below).
 
 ```typescript
 const john = db.User('john@example.com');
@@ -94,7 +94,10 @@ await johnFriend1.update({ Name: 'Alice', rank: 1 });
 const johnPref = john.draft('PREF', { theme: 'dark' });
 await johnPref.save();
 
-````
+// 6. Shorthand access (returns an Item object directly)
+const johnMeta = db.User('john@example.com', 'METADATA');
+await johnMeta.update({ name: 'John Doe' });
+```
 
 ### 2. Global Secondary Indexes (findBy)
 
@@ -153,7 +156,7 @@ await db.Product('p123').update('INFO', { price: 45 }, [electronics]);
 #### Using Item.create() and Item.update()
 ```typescript
 const electronics = db.findByCategory('ELECTRONICS', 'RANK#1');
-const mouse = db.Product('p123').draft('INFO');
+const mouse = db.Product('p123', 'INFO');
 
 // Pass data and indices directly to create()
 await mouse.create({ 
@@ -170,7 +173,7 @@ You can also use `setIndex()` to attach indices to an item so they are used auto
 
 ```typescript
 const electronics = db.findByCategory('ELECTRONICS', 'RANK#1');
-const mouse = db.Product('p123').draft('INFO');
+const mouse = db.Product('p123', 'INFO');
 
 mouse.setIndex(electronics);
 mouse.price = 50;
@@ -232,14 +235,16 @@ if (token) {
 - `delete(params)`: Low-level DeleteCommand wrapper.
 - `query(params)`: Low-level QueryCommand wrapper.
 - `scan(params)`: Low-level ScanCommand wrapper.
+- `[ModelName](id, skValue?)`: Returns a `Partition` instance for the given ID. If `skValue` is provided, returns an `Item` object directly.
+- `findBy[IndexName](id, skValue?)`: Returns an `IndexQuery` instance.
 
 ### Partition
-- `get(sk)`: Fetches data for a specific Sort Key value (returns a Promise).
+- `get(skValue)`: Fetches data for a specific Sort Key value (returns a Promise).
 - `getAll(options?)`: Fetches items in the partition. Options: `{ limit, exclusiveStartKey }`.
-- `create(sk, data, indices?)`: Creates an item. `indices` is an array of `IndexQuery` for GSI population.
-- `update(sk, data)`: Partial update of an item.
-- `delete(sk)`: Deletes an item.
-- `draft(sk, data?)`: Returns an `Item` object initialized with `data` (optional).
+- `create(skValue, data, indices?)`: Creates an item. `indices` is an array of `IndexQuery` for GSI population.
+- `update(skValue, data)`: Partial update of an item.
+- `delete(skValue)`: Deletes an item.
+- `draft(skValue, data?)`: Returns an `Item` object initialized with `data` (optional).
 - `deleteAll()`: Deletes all items in the partition.
 - `getLastEvaluatedKey()`: Returns the pagination token from the last `getAll()`.
 

package/dist/index.js

@@ -55,8 +55,12 @@ class DynoQuery {
         if (models) {
             this.registeredModels = models;
             Object.entries(models).forEach(([name, def]) => {
-                this[name] = (id) => {
-                    return new partition_1.Partition(this, { pkPrefix: this.globalPkPrefix + def.pkPrefix }, id);
+                this[name] = (id, skValue) => {
+                    const partition = new partition_1.Partition(this, { pkPrefix: this.globalPkPrefix + def.pkPrefix }, id);
+                    if (skValue) {
+                        return partition.draft(skValue);
+                    }
+                    return partition;
                 };
             });
         }

package/dist/partition.d.ts

@@ -34,7 +34,7 @@ export declare class Partition {
     /**
      * Create an item in this partition.
      */
-    create<T = any>(sk: string, data: T, indices?: IndexQuery[]): Promise<T>;
+    create<T = any>(skValue: string, data: T, indices?: IndexQuery[]): Promise<T>;
     /**
      * Internal method to get raw data for a specific SK.
      */
@@ -42,21 +42,21 @@ export declare class Partition {
     /**
      * Update an existing item in this partition.
      */
-    update<T = any>(sk: string, data: Partial<T>, indices?: IndexQuery[]): Promise<T>;
+    update<T = any>(skValue: string, data: Partial<T>, indices?: IndexQuery[]): Promise<T>;
     /**
      * Delete an item by its SK within this partition.
      */
-    delete(sk: string): Promise<void>;
+    delete(skValue: string): Promise<void>;
     /**
      * Get data for a specific SK and return it wrapped in a Item object.
      */
-    get<T = any>(sk: string): Promise<T | null>;
+    get<T = any>(skValue: string): Promise<T | null>;
     /**
      * Pre-draft an item for creation. Returns an Item object.
      * @param sk The sort key value
      * @param data Initial data for the row
      */
-    draft<T = any>(sk: string, data?: any): T;
+    draft<T = any>(skValue: string, data?: any): T;
     getPkValue(): string;
     getLastEvaluatedKey(): any;
     /**

package/dist/partition.js

@@ -129,9 +129,9 @@ class Partition {
     /**
      * Create an item in this partition.
      */
-    create(sk, data, indices) {
+    create(skValue, data, indices) {
         return __awaiter(this, void 0, void 0, function* () {
-            const item = Object.assign({ [this.pkName]: this.pkValue, [this.skName]: sk }, data);
+            const item = Object.assign({ [this.pkName]: this.pkValue, [this.skName]: skValue }, data);
             if (indices) {
                 indices.forEach((index) => {
                     item[index.getPkName()] = index.getPkValue();
@@ -144,17 +144,17 @@ class Partition {
                 TableName: this.tableName,
                 Item: item,
             });
-            this.cache[sk] = item;
-            return new Item(this, sk, item);
+            this.cache[skValue] = item;
+            return new Item(this, skValue, item);
         });
     }
     /**
      * Internal method to get raw data for a specific SK.
      */
-    _getRaw(sk) {
+    _getRaw(skValue) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (this.cache[sk] !== undefined) {
-                return this.cache[sk] || null;
+            if (this.cache[skValue] !== undefined) {
+                return this.cache[skValue] || null;
             }
             if (this.isLoaded) {
                 return null;
@@ -163,12 +163,12 @@ class Partition {
                 TableName: this.tableName,
                 Key: {
                     [this.pkName]: this.pkValue,
-                    [this.skName]: sk,
+                    [this.skName]: skValue,
                 },
             });
             const data = response.Item || null;
             if (data) {
-                this.cache[sk] = data;
+                this.cache[skValue] = data;
             }
             return data;
         });
@@ -176,35 +176,35 @@ class Partition {
     /**
      * Update an existing item in this partition.
      */
-    update(sk, data, indices) {
+    update(skValue, data, indices) {
         return __awaiter(this, void 0, void 0, function* () {
-            const current = (yield this._getRaw(sk)) || {};
+            const current = (yield this._getRaw(skValue)) || {};
             const updated = Object.assign(Object.assign({}, current), data);
-            return yield this.create(sk, updated, indices);
+            return yield this.create(skValue, updated, indices);
         });
     }
     /**
      * Delete an item by its SK within this partition.
      */
-    delete(sk) {
+    delete(skValue) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.db.delete({
                 TableName: this.tableName,
                 Key: {
                     [this.pkName]: this.pkValue,
-                    [this.skName]: sk,
+                    [this.skName]: skValue,
                 },
             });
-            delete this.cache[sk];
+            delete this.cache[skValue];
         });
     }
     /**
      * Get data for a specific SK and return it wrapped in a Item object.
      */
-    get(sk) {
+    get(skValue) {
         return __awaiter(this, void 0, void 0, function* () {
-            const data = yield this._getRaw(sk);
-            return data ? new Item(this, sk, data) : null;
+            const data = yield this._getRaw(skValue);
+            return data ? new Item(this, skValue, data) : null;
         });
     }
     /**
@@ -212,8 +212,8 @@ class Partition {
      * @param sk The sort key value
      * @param data Initial data for the row
      */
-    draft(sk, data = {}) {
-        return new Item(this, sk, data);
+    draft(skValue, data = {}) {
+        return new Item(this, skValue, data);
     }
     getPkValue() {
         return this.pkValue;

package/package.json

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