dynoquery 0.1.5 → 0.1.7

package/README.md

@@ -12,7 +12,6 @@ npm install dynoquery
 
 - Basic CRUD operations (create, get, update, delete)
 - Optimized for **Single-Table Design**
-- Model-based approach for easy data management
 - Query and Scan support
 - Batch operations (batchGet, batchWrite)
 - TypeScript support
@@ -30,7 +29,7 @@ const db = new DynoQuery({
   pkPrefix: 'TENANT#A#', // Optional: Global prefix for all partitions (useful for multitenancy)
   // optional endpoint for local development
   // endpoint: 'http://localhost:8000'
-  partitions: {
+  models: {
     User: { pkPrefix: 'USER#' }, // TENANT#A#USER#
   },
   indexes: {
@@ -67,24 +66,23 @@ async function example() {
   console.log(userMetadata);
 
   // Create an item through partition
-  const profileModel = await john.create('PROFILE', { name: 'John Doe', email: 'john@example.com' });
+  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');
-  const profileWithGSI = await john.create('PROFILE', { 
+  await john.create('PROFILE', { 
     name: 'John Doe', 
     email: 'john@example.com', 
     GSI1PK: cat.getPkValue(), 
     GSI1SK: 'john@example.com' 
   });
 
-  // Update the model (updates both DB and partition cache)
-  await profileModel.update({ theme: 'dark' });
+  // Update the item (updates both DB and partition cache)
+  await john.update('PROFILE', { theme: 'dark' });
 
-  // If you need the Model instance for save/delete without immediate create:
-  const metaModel = john.model('METADATA');
-  await metaModel.save({ lastLogin: new Date().toISOString() });
+  // Delete an item
+  await john.delete('METADATA');
 
   // Advanced Partition usage (Subclassing)
   class UserPartition extends Partition {
@@ -154,20 +152,14 @@ The main client for interacting with DynamoDB.
 - `batchGet(params)`: Batch get items.
 - `batchWrite(params)`: Batch write items.
 
-### Model
-A model-based abstraction for a specific data type.
-- `find(id?)`: Find an item by ID (PK suffix).
-- `save(data, id?)`: Save an item.
-- `update(data, id?)`: Update an existing item (partial update).
-- `remove(id?)`: Delete an item.
-
 ### Partition
-A way to manage models and data within a specific partition.
+A way to manage data within a specific partition.
 - `getPkValue()`: Returns the generated partition key value.
 - `get(sk)`: Fetches data for a specific sort key (returns a Promise).
 - `getAll()`: Fetches all items in the partition and caches them. Returns the items.
-- `create(sk, data)`: Creates an item in the partition and returns its `Model`.
-- `model(sk)`: Get a `Model` instance for a specific sort key.
+- `create(sk, data)`: Creates an item in the partition.
+- `update(sk, data)`: Updates an existing item (partial update).
+- `delete(sk)`: Deletes an item.
 - `batchGetInput(...sks)`: Generates items for batch query.
 - `batchWriteInput(...items)`: Generates items for batch write.
 - `batchDeleteInput(...sks)`: Generates items for batch delete.
@@ -181,7 +173,7 @@ A way to query Global Secondary Indexes.
 - `batchGetInput(...sks)`: Generates items for batch query.
 - `batchWriteInput(...items)`: Generates items for batch write.
 - `batchDeleteInput(...sks)`: Generates items for batch delete.
-- Automatically identifies models in results using `__model` and provides `getPartition()` helper.
+- Automatically identifies the model name in results using `__model` (based on registered models) and provides `getPartition()` helper.
 
 ## License
 

package/dist/index-query.js

@@ -119,9 +119,9 @@ class IndexQuery {
         const pkValue = item[pkName];
         if (!pkValue)
             return item;
-        const registeredPartitions = this.db.getRegisteredPartitions();
+        const registeredModels = this.db.getRegisteredModels();
         const globalPrefix = this.db.getPkPrefix();
-        for (const [name, def] of Object.entries(registeredPartitions)) {
+        for (const [name, def] of Object.entries(registeredModels)) {
             const fullPrefix = globalPrefix + def.pkPrefix;
             if (pkValue.startsWith(fullPrefix)) {
                 // Find the ID by removing the prefix

package/dist/index.d.ts

@@ -11,7 +11,7 @@ export interface DynoQueryConfig {
         secretAccessKey: string;
         sessionToken?: string;
     };
-    partitions?: Record<string, {
+    models?: Record<string, {
         pkPrefix: string;
     }>;
     indexes?: Record<string, {
@@ -34,7 +34,7 @@ export declare class DynoQuery {
     private globalPkPrefix;
     private pkName;
     private skName;
-    private registeredPartitions;
+    private registeredModels;
     [key: string]: any;
     constructor(config?: DynoQueryConfig);
     /**
@@ -73,10 +73,9 @@ export declare class DynoQuery {
     getPkPrefix(): string;
     getPkName(): string;
     getSkName(): string;
-    getRegisteredPartitions(): Record<string, {
+    getRegisteredModels(): Record<string, {
         pkPrefix: string;
     }>;
 }
-export * from "./model";
 export * from "./partition";
 export * from "./index-query";

package/dist/index.js

@@ -40,8 +40,8 @@ const lib_dynamodb_1 = require("@aws-sdk/lib-dynamodb");
 const partition_1 = require("./partition");
 class DynoQuery {
     constructor(config = {}) {
-        this.registeredPartitions = {};
-        const { tableName, pkName, skName, pkPrefix, partitions, indexes } = config, clientConfig = __rest(config, ["tableName", "pkName", "skName", "pkPrefix", "partitions", "indexes"]);
+        this.registeredModels = {};
+        const { tableName, pkName, skName, pkPrefix, models, indexes } = config, clientConfig = __rest(config, ["tableName", "pkName", "skName", "pkPrefix", "models", "indexes"]);
         this.client = new client_dynamodb_1.DynamoDBClient(clientConfig);
         this.docClient = lib_dynamodb_1.DynamoDBDocumentClient.from(this.client, {
             marshallOptions: {
@@ -52,9 +52,9 @@ class DynoQuery {
         this.globalPkPrefix = pkPrefix || "";
         this.pkName = pkName || "PK";
         this.skName = skName || "SK";
-        if (partitions) {
-            this.registeredPartitions = partitions;
-            Object.entries(partitions).forEach(([name, def]) => {
+        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);
                 };
@@ -232,11 +232,10 @@ class DynoQuery {
     getSkName() {
         return this.skName;
     }
-    getRegisteredPartitions() {
-        return this.registeredPartitions;
+    getRegisteredModels() {
+        return this.registeredModels;
     }
 }
 exports.DynoQuery = DynoQuery;
-__exportStar(require("./model"), exports);
 __exportStar(require("./partition"), exports);
 __exportStar(require("./index-query"), exports);

package/dist/partition.d.ts

@@ -1,5 +1,4 @@
 import { DynoQuery } from "./index";
-import { Model } from "./model";
 export interface PartitionConfig {
     tableName?: string;
     pk?: string;
@@ -20,9 +19,23 @@ export declare class Partition {
      */
     getAll<T = any>(): Promise<T[]>;
     /**
-     * Get a model instance for a specific SK within this partition.
+     * Create an item in this partition.
      */
-    model<T = any>(sk: string): Model<T>;
+    create<T = any>(sk: string, data: T): Promise<void>;
+    /**
+     * Update an existing item in this partition.
+     */
+    update<T = any>(sk: string, data: Partial<T>): Promise<void>;
+    /**
+     * Delete an item by its SK within this partition.
+     */
+    delete(sk: string): Promise<void>;
+    /**
+     * Get data for a specific SK within this partition.
+     * If the partition is loaded, it returns from cache.
+     * Otherwise, it fetches the data immediately.
+     */
+    get<T = any>(sk: string): Promise<T | null>;
     getPkValue(): string;
     /**
      * Generates items for batch query.
@@ -40,16 +53,6 @@ export declare class Partition {
      * Generates items for batch delete.
      */
     batchDeleteInput(...sks: string[]): any[];
-    /**
-     * Create an item in this partition and return the model.
-     */
-    create<T = any>(sk: string, data: T): Promise<Model<T>>;
-    /**
-     * Get data for a specific SK within this partition.
-     * If the partition is loaded, it returns from cache.
-     * Otherwise, it fetches the data immediately.
-     */
-    get<T = any>(sk: string): Promise<T | null>;
     /**
      * Delete all data in this partition.
      */

package/dist/partition.js

@@ -10,7 +10,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Partition = void 0;
-const model_1 = require("./model");
 class Partition {
     constructor(db, config, id) {
         this.cache = {};
@@ -78,23 +77,69 @@ class Partition {
         });
     }
     /**
-     * Get a model instance for a specific SK within this partition.
+     * Create an item in this partition.
      */
-    model(sk) {
-        const config = {
-            tableName: this.tableName,
-            pkPrefix: this.pkValue, // In this context, pkValue is fixed, so prefix is the full PK
-            skValue: sk,
-            onUpdate: (updatedSk, data) => {
-                if (data === null) {
-                    delete this.cache[updatedSk];
-                }
-                else {
-                    this.cache[updatedSk] = data;
-                }
+    create(sk, data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const item = Object.assign({ [this.pkName]: this.pkValue, [this.skName]: sk }, data);
+            yield this.db.create({
+                TableName: this.tableName,
+                Item: item,
+            });
+            this.cache[sk] = item;
+        });
+    }
+    /**
+     * Update an existing item in this partition.
+     */
+    update(sk, data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const current = (yield this.get(sk)) || {};
+            const updated = Object.assign(Object.assign({}, current), data);
+            yield this.create(sk, updated);
+        });
+    }
+    /**
+     * Delete an item by its SK within this partition.
+     */
+    delete(sk) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.db.delete({
+                TableName: this.tableName,
+                Key: {
+                    [this.pkName]: this.pkValue,
+                    [this.skName]: sk,
+                },
+            });
+            delete this.cache[sk];
+        });
+    }
+    /**
+     * Get data for a specific SK within this partition.
+     * If the partition is loaded, it returns from cache.
+     * Otherwise, it fetches the data immediately.
+     */
+    get(sk) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.cache[sk] !== undefined) {
+                return this.cache[sk] || null;
+            }
+            if (this.isLoaded) {
+                return null;
             }
-        };
-        return new model_1.Model(this.db, config);
+            const response = yield this.db.get({
+                TableName: this.tableName,
+                Key: {
+                    [this.pkName]: this.pkValue,
+                    [this.skName]: sk,
+                },
+            });
+            const data = response.Item || null;
+            if (data) {
+                this.cache[sk] = data;
+            }
+            return data;
+        });
     }
     getPkValue() {
         return this.pkValue;
@@ -146,37 +191,6 @@ class Partition {
             }
         }));
     }
-    /**
-     * Create an item in this partition and return the model.
-     */
-    create(sk, data) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const m = this.model(sk);
-            yield m.save(data);
-            return m;
-        });
-    }
-    /**
-     * Get data for a specific SK within this partition.
-     * If the partition is loaded, it returns from cache.
-     * Otherwise, it fetches the data immediately.
-     */
-    get(sk) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.cache[sk] !== undefined) {
-                return this.cache[sk] || null;
-            }
-            if (this.isLoaded) {
-                return null;
-            }
-            const model = this.model(sk);
-            const data = yield model.find();
-            if (data) {
-                this.cache[sk] = data;
-            }
-            return data;
-        });
-    }
     /**
      * Delete all data in this partition.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dynoquery",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/devspikejs/dynoquery.git"
@@ -15,6 +15,7 @@
   "scripts": {
     "build": "tsc",
     "test": "jest src",
+    "version": "npm run build && git add dist",
     "prepublishOnly": "npm run build"
   },
   "keywords": [

package/dist/model.js

@@ -1,102 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Model = void 0;
-class Model {
-    constructor(db, config) {
-        this.db = db;
-        this.tableName = config.tableName || db.getTableName();
-        this.pkPrefix = config.pkPrefix;
-        this.skValue = config.skValue;
-        this.pkName = db.getPkName();
-        this.skName = db.getSkName();
-        this.onUpdate = config.onUpdate;
-        if (!this.tableName) {
-            throw new Error("TableName must be provided in ModelConfig or DynoQueryConfig");
-        }
-    }
-    getTableName() {
-        return this.tableName;
-    }
-    getPK(id = "") {
-        return `${this.pkPrefix}${id}`;
-    }
-    /**
-     * Find an item by its identifier (part of the PK).
-     * Assumes the SK is fixed as defined in ModelConfig.
-     */
-    find() {
-        return __awaiter(this, arguments, void 0, function* (id = "") {
-            const response = yield this.db.get({
-                TableName: this.getTableName(),
-                Key: {
-                    [this.pkName]: this.getPK(id),
-                    [this.skName]: this.skValue,
-                },
-            });
-            return response.Item || null;
-        });
-    }
-    /**
-     * Save an item.
-     */
-    save(data_1) {
-        return __awaiter(this, arguments, void 0, function* (data, id = "") {
-            const item = Object.assign({ [this.pkName]: this.getPK(id), [this.skName]: this.skValue }, data);
-            yield this.db.create({
-                TableName: this.getTableName(),
-                Item: item,
-            });
-            if (this.onUpdate) {
-                this.onUpdate(this.skValue, item);
-            }
-        });
-    }
-    /**
-     * Update an existing item.
-     */
-    update(data_1) {
-        return __awaiter(this, arguments, void 0, function* (data, id = "") {
-            // For simplicity in this wrapper, we use create (PutItem) to update the whole item
-            // but the user might expect a partial update if we use UpdateCommand.
-            // However, for single table and this kind of wrapper, often we just put the whole item.
-            // If we want to support partial updates in the cache, we need the current item.
-            const response = yield this.db.get({
-                TableName: this.getTableName(),
-                Key: {
-                    [this.pkName]: this.getPK(id),
-                    [this.skName]: this.skValue,
-                },
-            });
-            const current = response.Item || {};
-            const updated = Object.assign(Object.assign({}, current), data);
-            yield this.save(updated, id);
-        });
-    }
-    /**
-     * Delete an item by its identifier.
-     */
-    remove() {
-        return __awaiter(this, arguments, void 0, function* (id = "") {
-            yield this.db.delete({
-                TableName: this.getTableName(),
-                Key: {
-                    [this.pkName]: this.getPK(id),
-                    [this.skName]: this.skValue,
-                },
-            });
-            if (this.onUpdate) {
-                this.onUpdate(this.skValue, null);
-            }
-        });
-    }
-}
-exports.Model = Model;