dinah 0.11.1 → 0.12.0

package/README.md

@@ -99,13 +99,18 @@ const UserTable = new Table(
 
 ### Using the Repository Class
 
-`Repo` is the recommended way to interact with DynamoDB. For a plain repo with no configuration, use `db.createRepo`:
+`Repo` is the recommended way to interact with DynamoDB. Use `db.makeRepo` to create a repo inline, with or without configuration:
 
 ```typescript
 const userRepo = db.makeRepo(UserTable);
+
+const userRepo = db.makeRepo(UserTable, {
+  defaultPutData: () => ({ createdAt: Date.now() }),
+  defaultUpdateData: () => ({ updatedAt: Date.now() }),
+});
 ```
 
-For repos with defaults, transforms, or attribute rules, use `makeRepo` to define a class (see [Repository Configuration](#repository-configuration)):
+To create a named, reusable repo class, use the standalone `makeRepo` (see [Repository Configuration](#repository-configuration)):
 
 ```typescript
 import { makeRepo } from "dinah";

package/dist/index.cjs

@@ -3,6 +3,25 @@ const require_util = require("./util-D88GS6Gt.cjs");
 let _aws_sdk_client_dynamodb = require("@aws-sdk/client-dynamodb");
 let _aws_sdk_lib_dynamodb = require("@aws-sdk/lib-dynamodb");
 _aws_sdk_lib_dynamodb = require_util.__toESM(_aws_sdk_lib_dynamodb, 1);
+//#region src/error.ts
+function dinahErrorMessage(details) {
+	switch (details.type) {
+		case "NOT_FOUND": return `${details.resource ?? "Item"} not found: ${JSON.stringify(details.key)}`;
+		case "CONDITIONAL_CHECK_FAILED": return details.key ? `${details.resource ?? "Item"} condition check failed: ${JSON.stringify(details.key)}` : `${details.resource ?? "Item"} condition check failed`;
+		case "VALIDATION": return `Validation error: ${details.message}`;
+		case "TRANSACTION_CANCELED": return `Transaction canceled: ${details.reasons.map((r) => r.type).join(", ")}`;
+	}
+}
+var DinahError = class extends Error {
+	details;
+	constructor(details, options) {
+		super(dinahErrorMessage(details), options);
+		this.name = "DinahError";
+		this.details = details;
+	}
+};
+const isDinahError = (err) => err instanceof DinahError;
+//#endregion
 //#region src/expression-builder.ts
 const attrTypes = [
 	"S",
@@ -225,6 +244,13 @@ var Repo = class {
 	get tableName() {
 		return `${this.db.config?.tableNamePrefix ?? ""}${this.table.def.name}`;
 	}
+	get resourceName() {
+		if (this.config.resourceName) return this.config.resourceName;
+		const clsName = this.constructor.name;
+		if (clsName && clsName !== "Repo") return clsName.replace(/Repo$/i, "") || clsName;
+		const t = this.table.def.name;
+		return t.charAt(0).toUpperCase() + t.slice(1);
+	}
 	get defaultPutData() {
 		return this.config.defaultPutData?.() ?? {};
 	}
@@ -257,6 +283,7 @@ var Repo = class {
 		const item = await this.db.getOrThrow({
 			table: this.tableName,
 			key: this.extractKey(key),
+			resource: this.resourceName,
 			...options
 		});
 		return this.applyTransformIfNeeded(item, options);
@@ -266,6 +293,7 @@ var Repo = class {
 		const result = await this.db.put({
 			table: this.tableName,
 			item: itemWithDefaults,
+			resource: this.resourceName,
 			...options
 		});
 		return this.applyTransformIfNeeded(result);
@@ -278,6 +306,7 @@ var Repo = class {
 		const result = await this.db.update({
 			table: this.tableName,
 			key: this.extractKey(key),
+			resource: this.resourceName,
 			update: updateWithDefaults,
 			...options
 		});
@@ -296,6 +325,7 @@ var Repo = class {
 		const item = await this.db.delete({
 			table: this.tableName,
 			key: this.extractKey(key),
+			resource: this.resourceName,
 			...options
 		});
 		return item && this.applyTransformIfNeeded(item);
@@ -304,6 +334,7 @@ var Repo = class {
 		const item = await this.db.deleteOrThrow({
 			table: this.tableName,
 			key: this.extractKey(key),
+			resource: this.resourceName,
 			...options
 		});
 		return this.applyTransformIfNeeded(item);
@@ -409,6 +440,7 @@ var Repo = class {
 	async batchGetOrThrow(keys, options) {
 		const result = await this.db.batchGetOrThrow({ [this.tableName]: {
 			keys: keys.map((key) => this.extractKey(key)),
+			resource: this.resourceName,
 			...options
 		} });
 		return this.applyTransformsIfNeeded(result[this.tableName] ?? [], options);
@@ -450,6 +482,7 @@ var Repo = class {
 		const items = await this.db.trxGetOrThrow(...keys.map((key) => ({
 			table: this.tableName,
 			key: this.extractKey(key),
+			resource: this.resourceName,
 			...options
 		})));
 		return this.applyTransformsIfNeeded(items, options);
@@ -657,7 +690,11 @@ var Db = class {
 	}
 	async getOrThrow(data) {
 		const item = await this.get(data);
-		if (!item) throw new Error(`Item not found in "${data.table}" table.`);
+		if (!item) throw new DinahError({
+			type: "NOT_FOUND",
+			key: data.key,
+			resource: data.resource
+		});
 		return item;
 	}
 	async put(data) {
@@ -672,8 +709,16 @@ var Db = class {
 			ExpressionAttributeNames: exp.attributeNames,
 			ExpressionAttributeValues: exp.attributeValues
 		});
-		const output = await this.client.send(input);
-		return data.returnOld ? output.Attributes : item;
+		try {
+			const output = await this.client.send(input);
+			return data.returnOld ? output.Attributes : item;
+		} catch (err) {
+			if (err instanceof _aws_sdk_client_dynamodb.ConditionalCheckFailedException) throw new DinahError({
+				type: "CONDITIONAL_CHECK_FAILED",
+				resource: data.resource
+			}, { cause: err });
+			throw err;
+		}
 	}
 	async update(data) {
 		const exp = new ExpressionBuilder();
@@ -689,7 +734,16 @@ var Db = class {
 			ExpressionAttributeNames: exp.attributeNames,
 			ExpressionAttributeValues: exp.attributeValues
 		});
-		return (await this.client.send(input)).Attributes;
+		try {
+			return (await this.client.send(input)).Attributes;
+		} catch (err) {
+			if (err instanceof _aws_sdk_client_dynamodb.ConditionalCheckFailedException) throw new DinahError({
+				type: "CONDITIONAL_CHECK_FAILED",
+				key: data.key,
+				resource: data.resource
+			}, { cause: err });
+			throw err;
+		}
 	}
 	async delete(data) {
 		const exp = new ExpressionBuilder();
@@ -702,11 +756,24 @@ var Db = class {
 			ExpressionAttributeNames: exp.attributeNames,
 			ExpressionAttributeValues: exp.attributeValues
 		});
-		return (await this.client.send(input)).Attributes;
+		try {
+			return (await this.client.send(input)).Attributes;
+		} catch (err) {
+			if (err instanceof _aws_sdk_client_dynamodb.ConditionalCheckFailedException) throw new DinahError({
+				type: "CONDITIONAL_CHECK_FAILED",
+				key: data.key,
+				resource: data.resource
+			}, { cause: err });
+			throw err;
+		}
 	}
 	async deleteOrThrow(data) {
 		const item = await this.delete(data);
-		if (!item) throw new Error(`Item not found in "${data.table}" table.`);
+		if (!item) throw new DinahError({
+			type: "NOT_FOUND",
+			key: data.key,
+			resource: data.resource
+		});
 		return item;
 	}
 	async *queryPaged(data) {
@@ -863,7 +930,11 @@ var Db = class {
 		const { items, unprocessed } = await this.batchGet(data);
 		for (const table of Object.keys(data)) {
 			if (unprocessed?.[table]) throw new Error(`One or more batch get requests were not processed in "${table}" table.`);
-			if (items[table]?.length !== data[table]?.keys?.length) throw new Error(`One or more items were not found in "${table}" table.`);
+			if (items[table]?.length !== data[table]?.keys?.length) throw new DinahError({
+				type: "NOT_FOUND",
+				key: {},
+				resource: data[table]?.resource
+			});
 		}
 		return items;
 	}
@@ -983,7 +1054,11 @@ var Db = class {
 	}
 	async trxGetOrThrow(...requests) {
 		const items = await this.trxGet(...requests);
-		for (let i = 0; i < items.length; i++) if (!items[i]) throw new Error(`One or more items were not found in "${requests[i]?.table}" table.`);
+		for (let i = 0; i < items.length; i++) if (!items[i]) throw new DinahError({
+			type: "NOT_FOUND",
+			key: requests[i]?.key ?? {},
+			resource: requests[i]?.resource
+		});
 		return items;
 	}
 	async trxWrite(...requests) {
@@ -1013,7 +1088,18 @@ var Db = class {
 			} };
 		});
 		const input = new _aws_sdk_lib_dynamodb.TransactWriteCommand({ TransactItems: trxItems });
-		await this.client.send(input);
+		try {
+			await this.client.send(input);
+		} catch (err) {
+			if (err instanceof _aws_sdk_client_dynamodb.TransactionCanceledException) throw new DinahError({
+				type: "TRANSACTION_CANCELED",
+				reasons: (err.CancellationReasons ?? []).map((r) => ({
+					type: r.Code ?? "Unknown",
+					message: r.Message
+				}))
+			}, { cause: err });
+			throw err;
+		}
 	}
 };
 //#endregion
@@ -1028,10 +1114,12 @@ var Table = class {
 };
 //#endregion
 exports.Db = Db;
+exports.DinahError = DinahError;
 exports.Repo = Repo;
 exports.Table = Table;
 exports.chunk = require_util.chunk;
 exports.extractTableDesc = require_util.extractTableDesc;
+exports.isDinahError = isDinahError;
 exports.makeRepo = makeRepo;
 exports.removeUndefined = require_util.removeUndefined;
 exports.resolveAttrType = require_util.resolveAttrType;