betterddb 0.6.0 → 0.6.4

package/.eslintrc.cjs

@@ -0,0 +1,41 @@
+/** @type {import("eslint").Linter.Config} */
+const config = {
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "project": true
+  },
+  "plugins": [
+    "@typescript-eslint"
+  ],
+  "extends": [
+    "plugin:@typescript-eslint/recommended-type-checked",
+    "plugin:@typescript-eslint/stylistic-type-checked"
+  ],
+  "rules": {
+    "@typescript-eslint/array-type": "off",
+    "@typescript-eslint/consistent-type-definitions": "off",
+    "@typescript-eslint/consistent-type-imports": [
+      "warn",
+      {
+        "prefer": "type-imports",
+        "fixStyle": "inline-type-imports"
+      }
+    ],
+    "@typescript-eslint/no-unused-vars": [
+      "warn",
+      {
+        "argsIgnorePattern": "^_"
+      }
+    ],
+    "@typescript-eslint/require-await": "off",
+    "@typescript-eslint/no-misused-promises": [
+      "error",
+      {
+        "checksVoidReturn": {
+          "attributes": false
+        }
+      }
+    ]
+  }
+}
+module.exports = config;

package/lib/betterddb.js

@@ -12,14 +12,24 @@ const batch_get_builder_1 = require("./builders/batch-get-builder");
  * BetterDDB is a definition-based DynamoDB wrapper library.
  */
 class BetterDDB {
+    schema;
+    tableName;
+    entityType;
+    client;
+    keys;
+    timestamps;
+    counter;
     constructor(options) {
-        var _a, _b;
         this.schema = options.schema;
         this.tableName = options.tableName;
-        this.entityType = (_a = options.entityType) === null || _a === void 0 ? void 0 : _a.toUpperCase();
+        this.entityType = options.entityType?.toUpperCase();
         this.keys = options.keys;
         this.client = options.client;
-        this.timestamps = (_b = options.timestamps) !== null && _b !== void 0 ? _b : false;
+        this.timestamps = options.timestamps ?? false;
+        this.counter = options.counter ?? false;
+    }
+    getCounter() {
+        return this.counter;
     }
     getKeys() {
         return this.keys;
@@ -41,7 +51,9 @@ class BetterDDB {
     }
     // Helper: Retrieve the key value from a KeyDefinition.
     getKeyValue(def, rawKey) {
-        if (typeof def === 'string' || typeof def === 'number' || typeof def === 'symbol') {
+        if (typeof def === "string" ||
+            typeof def === "number" ||
+            typeof def === "symbol") {
             return String(rawKey[def]);
         }
         else {
@@ -56,18 +68,18 @@ class BetterDDB {
         // For primary (partition) key:
         const pkConfig = this.keys.primary;
         keyObj[pkConfig.name] =
-            (typeof pkConfig.definition === 'string' ||
-                typeof pkConfig.definition === 'number' ||
-                typeof pkConfig.definition === 'symbol')
+            typeof pkConfig.definition === "string" ||
+                typeof pkConfig.definition === "number" ||
+                typeof pkConfig.definition === "symbol"
                 ? String(rawKey[pkConfig.definition])
                 : pkConfig.definition.build(rawKey);
         // For sort key, if defined:
         if (this.keys.sort) {
             const skConfig = this.keys.sort;
             keyObj[skConfig.name] =
-                (typeof skConfig.definition === 'string' ||
-                    typeof skConfig.definition === 'number' ||
-                    typeof skConfig.definition === 'symbol')
+                typeof skConfig.definition === "string" ||
+                    typeof skConfig.definition === "number" ||
+                    typeof skConfig.definition === "symbol"
                     ? String(rawKey[skConfig.definition])
                     : skConfig.definition.build(rawKey);
         }
@@ -84,18 +96,18 @@ class BetterDDB {
                 // Compute primary index attribute.
                 const primaryConfig = gsiConfig.primary;
                 indexAttributes[primaryConfig.name] =
-                    (typeof primaryConfig.definition === 'string' ||
-                        typeof primaryConfig.definition === 'number' ||
-                        typeof primaryConfig.definition === 'symbol')
+                    typeof primaryConfig.definition === "string" ||
+                        typeof primaryConfig.definition === "number" ||
+                        typeof primaryConfig.definition === "symbol"
                         ? String(rawItem[primaryConfig.definition])
                         : primaryConfig.definition.build(rawItem);
                 // Compute sort index attribute if provided.
-                if (gsiConfig.sort) {
+                if (gsiConfig?.sort) {
                     const sortConfig = gsiConfig.sort;
                     indexAttributes[sortConfig.name] =
-                        (typeof sortConfig.definition === 'string' ||
-                            typeof sortConfig.definition === 'number' ||
-                            typeof sortConfig.definition === 'symbol')
+                        typeof sortConfig.definition === "string" ||
+                            typeof sortConfig.definition === "number" ||
+                            typeof sortConfig.definition === "symbol"
                             ? String(rawItem[sortConfig.definition])
                             : sortConfig.definition.build(rawItem);
                 }

package/lib/builders/batch-get-builder.js

@@ -3,6 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BatchGetBuilder = void 0;
 const lib_dynamodb_1 = require("@aws-sdk/lib-dynamodb");
 class BatchGetBuilder {
+    parent;
+    keys;
     /**
      * @param parent - The BetterDDB instance for the table.
      * @param keys - An array of partial keys for the items you wish to retrieve.
@@ -30,7 +32,7 @@ class BatchGetBuilder {
         });
         const tableName = this.parent.getTableName();
         // Build an array of keys using the parent's key builder.
-        const keysArray = deduplicatedKeys.map(key => this.parent.buildKey(key));
+        const keysArray = deduplicatedKeys.map((key) => this.parent.buildKey(key));
         // Construct the BatchGet parameters.
         const params = {
             RequestItems: {
@@ -39,7 +41,9 @@ class BatchGetBuilder {
                 },
             },
         };
-        const result = await this.parent.getClient().send(new lib_dynamodb_1.BatchGetCommand(params));
+        const result = await this.parent
+            .getClient()
+            .send(new lib_dynamodb_1.BatchGetCommand(params));
         const responses = result.Responses ? result.Responses[tableName] : [];
         if (!responses) {
             return [];

package/lib/builders/create-builder.js

@@ -3,10 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CreateBuilder = void 0;
 const lib_dynamodb_1 = require("@aws-sdk/lib-dynamodb");
 class CreateBuilder {
+    parent;
+    item;
+    extraTransactItems = [];
     constructor(parent, item) {
         this.parent = parent;
         this.item = item;
-        this.extraTransactItems = [];
     }
     async execute() {
         const validated = this.parent.getSchema().parse(this.item);
@@ -16,17 +18,20 @@ class CreateBuilder {
             // Combine with extra transaction items.
             const allItems = [...this.extraTransactItems, myTransactItem];
             await this.parent.getClient().send(new lib_dynamodb_1.TransactWriteCommand({
-                TransactItems: allItems
+                TransactItems: allItems,
             }));
             // After transaction, retrieve the updated item.
             const result = await this.parent.get(this.item).execute();
             if (result === null) {
-                throw new Error('Item not found after transaction create');
+                throw new Error("Item not found after transaction create");
             }
             return result;
         }
         else {
-            let finalItem = { ...this.item, entityType: this.parent.getEntityType() };
+            let finalItem = {
+                ...this.item,
+                entityType: this.parent.getEntityType(),
+            };
             if (this.parent.getTimestamps()) {
                 const now = new Date().toISOString();
                 finalItem = { ...finalItem, createdAt: now, updatedAt: now };
@@ -39,7 +44,7 @@ class CreateBuilder {
             finalItem = { ...finalItem, ...indexAttributes };
             await this.parent.getClient().send(new lib_dynamodb_1.PutCommand({
                 TableName: this.parent.getTableName(),
-                Item: finalItem
+                Item: finalItem,
             }));
             return validated;
         }
@@ -55,7 +60,10 @@ class CreateBuilder {
     }
     toTransactPut() {
         const validated = this.parent.getSchema().parse(this.item);
-        let finalItem = { ...this.item, entityType: this.parent.getEntityType() };
+        let finalItem = {
+            ...this.item,
+            entityType: this.parent.getEntityType(),
+        };
         if (this.parent.getTimestamps()) {
             const now = new Date().toISOString();
             finalItem = { ...finalItem, createdAt: now, updatedAt: now };

package/lib/builders/delete-builder.js

@@ -3,10 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DeleteBuilder = void 0;
 const lib_dynamodb_1 = require("@aws-sdk/lib-dynamodb");
 class DeleteBuilder {
+    parent;
+    key;
+    condition;
+    extraTransactItems = [];
     constructor(parent, key) {
         this.parent = parent;
         this.key = key;
-        this.extraTransactItems = [];
     }
     /**
      * Specify a condition expression for the delete operation.
@@ -28,18 +31,18 @@ class DeleteBuilder {
             // Combine with extra transaction items.
             const allItems = [...this.extraTransactItems, myTransactItem];
             await this.parent.getClient().send(new lib_dynamodb_1.TransactWriteCommand({
-                TransactItems: allItems
+                TransactItems: allItems,
             }));
             // After transaction, retrieve the updated item.
             const result = await this.parent.get(this.key).execute();
             if (result === null) {
-                throw new Error('Item not found after transaction delete');
+                throw new Error("Item not found after transaction delete");
             }
         }
         else {
             const params = {
                 TableName: this.parent.getTableName(),
-                Key: this.parent.buildKey(this.key)
+                Key: this.parent.buildKey(this.key),
             };
             if (this.condition) {
                 params.ConditionExpression = this.condition.expression;
@@ -60,7 +63,7 @@ class DeleteBuilder {
     toTransactDelete() {
         const deleteItem = {
             TableName: this.parent.getTableName(),
-            Key: this.parent.buildKey(this.key)
+            Key: this.parent.buildKey(this.key),
         };
         if (this.condition) {
             deleteItem.ConditionExpression = this.condition.expression;

package/lib/builders/get-builder.js

@@ -3,17 +3,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.GetBuilder = void 0;
 const lib_dynamodb_1 = require("@aws-sdk/lib-dynamodb");
 class GetBuilder {
+    parent;
+    key;
+    projectionExpression;
+    expressionAttributeNames = {};
+    extraTransactItems = [];
     constructor(parent, key) {
         this.parent = parent;
         this.key = key;
-        this.expressionAttributeNames = {};
-        this.extraTransactItems = [];
     }
     /**
      * Specify a projection by providing an array of attribute names.
      */
     withProjection(attributes) {
-        this.projectionExpression = attributes.map(attr => `#${String(attr)}`).join(', ');
+        this.projectionExpression = attributes
+            .map((attr) => `#${String(attr)}`)
+            .join(", ");
         for (const attr of attributes) {
             this.expressionAttributeNames[`#${String(attr)}`] = String(attr);
         }
@@ -26,7 +31,7 @@ class GetBuilder {
             // Combine with extra transaction items.
             const allItems = [...this.extraTransactItems, myTransactItem];
             await this.parent.getClient().send(new lib_dynamodb_1.TransactGetCommand({
-                TransactItems: allItems
+                TransactItems: allItems,
             }));
             // After transaction, retrieve the updated item.
             const result = await this.parent.get(this.key).execute();
@@ -35,7 +40,7 @@ class GetBuilder {
         else {
             const params = {
                 TableName: this.parent.getTableName(),
-                Key: this.parent.buildKey(this.key)
+                Key: this.parent.buildKey(this.key),
             };
             if (this.projectionExpression) {
                 params.ProjectionExpression = this.projectionExpression;
@@ -59,7 +64,7 @@ class GetBuilder {
     toTransactGet() {
         const getItem = {
             TableName: this.parent.getTableName(),
-            Key: this.parent.buildKey(this.key)
+            Key: this.parent.buildKey(this.key),
         };
         if (this.projectionExpression) {
             getItem.ProjectionExpression = this.projectionExpression;

package/lib/builders/query-builder.js

@@ -4,32 +4,37 @@ exports.QueryBuilder = void 0;
 const lib_dynamodb_1 = require("@aws-sdk/lib-dynamodb");
 const operator_1 = require("../operator");
 class QueryBuilder {
+    parent;
+    key;
+    keyConditions = [];
+    filterConditions = [];
+    expressionAttributeNames = {};
+    expressionAttributeValues = {};
+    index;
+    limit;
+    lastKey;
+    ascending = true;
     constructor(parent, key) {
         this.parent = parent;
         this.key = key;
-        this.keyConditions = [];
-        this.filterConditions = [];
-        this.expressionAttributeNames = {};
-        this.expressionAttributeValues = {};
-        this.ascending = true;
         const keys = this.parent.getKeys();
         let pkName = keys.primary.name;
         let builtKey = this.parent.buildKey(this.key);
-        this.expressionAttributeNames['#pk'] = pkName;
-        this.expressionAttributeValues[':pk_value'] = builtKey[pkName];
+        this.expressionAttributeNames["#pk"] = pkName;
+        this.expressionAttributeValues[":pk_value"] = builtKey[pkName];
     }
     usingIndex(indexName) {
         if (!this.parent.getKeys().gsis) {
-            throw new Error('No global secondary indexes defined for this table');
+            throw new Error("No global secondary indexes defined for this table");
         }
         if (!(indexName in this.parent.getKeys().gsis)) {
-            throw new Error('index does not exist');
+            throw new Error("index does not exist");
         }
         this.index = this.parent.getKeys().gsis[indexName];
         const pkName = this.index.primary.name;
         const builtKey = this.parent.buildIndexes(this.key);
-        this.expressionAttributeNames['#pk'] = pkName;
-        this.expressionAttributeValues[':pk_value'] = builtKey[pkName];
+        this.expressionAttributeNames["#pk"] = pkName;
+        this.expressionAttributeValues[":pk_value"] = builtKey[pkName];
         return this;
     }
     sortAscending() {
@@ -41,25 +46,24 @@ class QueryBuilder {
         return this;
     }
     where(operator, values) {
-        var _a, _b;
         const keys = this.parent.getKeys();
         // Determine the sort key name from either the index or the primary keys.
-        const sortKeyName = this.index ? (_a = this.index.sort) === null || _a === void 0 ? void 0 : _a.name : (_b = keys.sort) === null || _b === void 0 ? void 0 : _b.name;
+        const sortKeyName = this.index ? this.index.sort?.name : keys.sort?.name;
         if (!sortKeyName) {
-            throw new Error('Sort key is not defined for this table/index.');
+            throw new Error("Sort key is not defined for this table/index.");
         }
-        const nameKey = '#sk';
+        const nameKey = "#sk";
         this.expressionAttributeNames[nameKey] = sortKeyName;
         // Enforce that a complex sort key requires an object input.
-        if (typeof values !== 'object' || values === null) {
+        if (typeof values !== "object" || values === null) {
             throw new Error(`For complex sort keys, please provide an object with all necessary properties.`);
         }
-        if (operator === 'between') {
+        if (operator === "between") {
             if (!Array.isArray(values) || values.length !== 2) {
                 throw new Error(`For 'between' operator, values must be a tuple of two objects`);
             }
-            const valueKeyStart = ':sk_start';
-            const valueKeyEnd = ':sk_end';
+            const valueKeyStart = ":sk_start";
+            const valueKeyEnd = ":sk_end";
             // Use the key definition's build function to build the key from the full object.
             this.expressionAttributeValues[valueKeyStart] = this.index
                 ? this.parent.buildIndexes(values[0])[sortKeyName]
@@ -69,8 +73,8 @@ class QueryBuilder {
                 : this.parent.buildKey(values[1])[sortKeyName];
             this.keyConditions.push(`${nameKey} BETWEEN ${valueKeyStart} AND ${valueKeyEnd}`);
         }
-        else if (operator === 'begins_with') {
-            const valueKey = ':sk_value';
+        else if (operator === "begins_with") {
+            const valueKey = ":sk_value";
             this.expressionAttributeValues[valueKey] = this.index
                 ? this.parent.buildIndexes(values)[sortKeyName]
                 : this.parent.buildKey(values)[sortKeyName];
@@ -78,7 +82,7 @@ class QueryBuilder {
         }
         else {
             // For eq, lt, lte, gt, gte:
-            const valueKey = ':sk_value';
+            const valueKey = ":sk_value";
             this.expressionAttributeValues[valueKey] = this.index
                 ? this.parent.buildIndexes(values)[sortKeyName]
                 : this.parent.buildKey(values)[sortKeyName];
@@ -92,7 +96,7 @@ class QueryBuilder {
         const randomString = Math.random().toString(36).substring(2, 15);
         const placeholderName = `#attr_${attrStr}_${randomString}`;
         this.expressionAttributeNames[placeholderName] = attrStr;
-        if (operator === 'between') {
+        if (operator === "between") {
             if (!Array.isArray(values) || values.length !== 2) {
                 throw new Error("For 'between' operator, values must be a tuple of two items");
             }
@@ -102,7 +106,7 @@ class QueryBuilder {
             this.expressionAttributeValues[placeholderValueEnd] = values[1];
             this.filterConditions.push(`${placeholderName} BETWEEN ${placeholderValueStart} AND ${placeholderValueEnd}`);
         }
-        else if (operator === 'begins_with' || operator === 'contains') {
+        else if (operator === "begins_with" || operator === "contains") {
             const placeholderValue = `:val_${attrStr}_${randomString}`;
             this.expressionAttributeValues[placeholderValue] = values;
             this.filterConditions.push(`${operator}(${placeholderName}, ${placeholderValue})`);
@@ -127,9 +131,8 @@ class QueryBuilder {
      * Executes the query and returns a Promise that resolves with an array of items.
      */
     async execute() {
-        var _a, _b, _c;
         this.keyConditions.unshift(`#pk = :pk_value`);
-        const keyConditionExpression = this.keyConditions.join(' AND ');
+        const keyConditionExpression = this.keyConditions.join(" AND ");
         const params = {
             TableName: this.parent.getTableName(),
             KeyConditionExpression: keyConditionExpression,
@@ -138,16 +141,20 @@ class QueryBuilder {
             ScanIndexForward: this.ascending,
             Limit: this.limit,
             ExclusiveStartKey: this.lastKey,
-            IndexName: (_b = (_a = this.index) === null || _a === void 0 ? void 0 : _a.name) !== null && _b !== void 0 ? _b : undefined,
+            IndexName: this.index?.name ?? undefined,
         };
         if (this.parent.getEntityType()) {
             this.filterConditions.push(`#entity = :entity_value`);
-            this.expressionAttributeNames['#entity'] = 'entityType';
-            this.expressionAttributeValues[':entity_value'] = this.parent.getEntityType();
+            this.expressionAttributeNames["#entity"] = "entityType";
+            this.expressionAttributeValues[":entity_value"] =
+                this.parent.getEntityType();
         }
-        params.FilterExpression = this.filterConditions.join(' AND ');
+        params.FilterExpression = this.filterConditions.join(" AND ");
         const result = await this.parent.getClient().send(new lib_dynamodb_1.QueryCommand(params));
-        return { items: this.parent.getSchema().array().parse(result.Items), lastKey: (_c = result.LastEvaluatedKey) !== null && _c !== void 0 ? _c : undefined };
+        return {
+            items: this.parent.getSchema().array().parse(result.Items),
+            lastKey: result.LastEvaluatedKey ?? undefined,
+        };
     }
 }
 exports.QueryBuilder = QueryBuilder;

package/lib/builders/scan-builder.js

@@ -4,17 +4,20 @@ exports.ScanBuilder = void 0;
 const lib_dynamodb_1 = require("@aws-sdk/lib-dynamodb");
 const operator_1 = require("../operator");
 class ScanBuilder {
+    parent;
+    filters = [];
+    expressionAttributeNames = {};
+    expressionAttributeValues = {};
+    limit;
+    lastKey;
     constructor(parent) {
         this.parent = parent;
-        this.filters = [];
-        this.expressionAttributeNames = {};
-        this.expressionAttributeValues = {};
     }
     where(attribute, operator, values) {
         const attrStr = String(attribute);
         const nameKey = `#attr_${attrStr}`;
         this.expressionAttributeNames[nameKey] = attrStr;
-        if (operator === 'between') {
+        if (operator === "between") {
             if (!Array.isArray(values) || values.length !== 2) {
                 throw new Error(`For 'between' operator, values must be a tuple of two items`);
             }
@@ -24,7 +27,7 @@ class ScanBuilder {
             this.expressionAttributeValues[valueKeyEnd] = values[1];
             this.filters.push(`${nameKey} BETWEEN ${valueKeyStart} AND ${valueKeyEnd}`);
         }
-        else if (operator === 'begins_with' || operator === 'contains') {
+        else if (operator === "begins_with" || operator === "contains") {
             const valueKey = `:val_${attrStr}`;
             this.expressionAttributeValues[valueKey] = values;
             this.filters.push(`${operator}(${nameKey}, ${valueKey})`);
@@ -49,22 +52,25 @@ class ScanBuilder {
      * Executes the scan and returns a Promise that resolves with an array of items.
      */
     async execute() {
-        var _a;
         const params = {
             TableName: this.parent.getTableName(),
             ExpressionAttributeNames: this.expressionAttributeNames,
             ExpressionAttributeValues: this.expressionAttributeValues,
             Limit: this.limit,
-            ExclusiveStartKey: this.lastKey
+            ExclusiveStartKey: this.lastKey,
         };
         if (this.parent.getEntityType()) {
             this.filters.push(`#entity = :entity_value`);
-            this.expressionAttributeNames['#entity'] = 'entityType';
-            this.expressionAttributeValues[':entity_value'] = this.parent.getEntityType();
+            this.expressionAttributeNames["#entity"] = "entityType";
+            this.expressionAttributeValues[":entity_value"] =
+                this.parent.getEntityType();
         }
-        params.FilterExpression = this.filters.join(' AND ');
+        params.FilterExpression = this.filters.join(" AND ");
         const result = await this.parent.getClient().send(new lib_dynamodb_1.ScanCommand(params));
-        return { items: this.parent.getSchema().array().parse(result.Items), lastKey: (_a = result.LastEvaluatedKey) !== null && _a !== void 0 ? _a : undefined };
+        return {
+            items: this.parent.getSchema().array().parse(result.Items),
+            lastKey: result.LastEvaluatedKey ?? undefined,
+        };
     }
 }
 exports.ScanBuilder = ScanBuilder;