dyna-record 0.0.12 → 0.0.13

package/README.md

@@ -158,7 +158,7 @@ class Student extends MyTable {
 
 ### Foreign Keys
 
-Define foreign keys in order to support [@BelongsTo](https://dyna-record.com/functions/BelongsTo.html) relationships. A foreign key us required for [@HasOne](https://dyna-record.com/functions/HasOne.html) and [@HasMany](https://dyna-record.com/functions/HasMany.html) relationships.
+Define foreign keys in order to support [@BelongsTo](https://dyna-record.com/functions/BelongsTo.html) relationships. A foreign key is required for [@HasOne](https://dyna-record.com/functions/HasOne.html) and [@HasMany](https://dyna-record.com/functions/HasMany.html) relationships.
 
 - The [alias](https://dyna-record.com/interfaces/AttributeOptions.html#alias) option allows you to specify the attribute name as it appears in the DynamoDB table, different from your class property name.
 - Set nullable foreign key attributes as optional for optimal type safety
@@ -190,12 +190,14 @@ Dyna-Record supports defining relationships between entities such as [@HasOne](h
 
 A relationship can be defined as nullable or non-nullable. Non-nullable relationships will be enforced via transactions and violations will result in [NullConstraintViolationError](https://dyna-record.com/classes/NullConstraintViolationError.html)
 
-- `@ForeignKeyAttribute` is used to define a foreign key that links to another entity and is nullable.
-- `@NullableForeignKeyAttribute` is used to define a foreign key that links to another entity and is nullable.
-- Relationship decorators (`@HasOne`, `@HasMany`, `@BelongsTo`, `@HasAndBelongsToMany`) define how entities relate to each other.
+- [@ForeignKeyAttribute](https://dyna-record.com/functions/ForeignKeyAttribute.html) is used to define a foreign key that links to another entity and is not nullable.
+- [@NullableForeignKeyAttribute](https://dyna-record.com/functions/NullableForeignKeyAttribute.html) is used to define a foreign key that links to another entity and is nullable.
+- Relationship decorators ([@HasOne](#hasone), [@HasMany](#hasmany), [@BelongsTo](https://dyna-record.com/functions/BelongsTo.html), [@HasAndBelongsToMany](#hasandbelongstomany)) define how entities relate to each other.
 
 #### HasOne
 
+[Docs](https://dyna-record.com/functions/HasOne.html)
+
 ```typescript
 @Entity
 class Assignment extends MyTable {
@@ -209,7 +211,7 @@ class Grade extends MyTable {
   @ForeignKeyAttribute()
   public readonly assignmentId: ForeignKey;
 
-  // 'assignmentId' Must be defined on self as ForeignKey
+  // 'assignmentId' Must be defined on self as ForeignKey or NullableForeignKey
   @BelongsTo(() => Assignment, { foreignKey: "assignmentId" })
   public readonly assignment: Assignment;
 }
@@ -217,10 +219,12 @@ class Grade extends MyTable {
 
 ### HasMany
 
+[Docs](https://dyna-record.com/functions/HasMany.html)
+
 ```typescript
 @Entity
 class Teacher extends MyTable {
-  // 'teacherId' Must be defined on self as ForeignKey
+  // 'teacherId' must be defined on associated model
   @HasMany(() => Course, { foreignKey: "teacherId" })
   public readonly courses: Course[];
 }
@@ -230,6 +234,7 @@ class Course extends MyTable {
   @NullableForeignKeyAttribute()
   public readonly teacherId?: NullableForeignKey;
 
+  // 'teacherId' Must be defined on self as ForeignKey or NullableForeignKey
   @BelongsTo(() => Teacher, { foreignKey: "teacherId" })
   public readonly teacher?: Teacher;
 }
@@ -237,6 +242,8 @@ class Course extends MyTable {
 
 ### HasAndBelongsToMany
 
+[Docs](https://dyna-record.com/functions/HasAndBelongsToMany.html)
+
 HasAndBelongsToMany relationships require a [JoinTable](https://dyna-record.com/classes/JoinTable.html) class. This represents a virtual table to support the relationship
 
 ```typescript
@@ -270,7 +277,7 @@ class Student extends OtherTable {
 
 [Docs](https://dyna-record.com/classes/default.html#create)
 
-The create method is used to insert a new record into a DynamoDB table. This method automatically handles key generation (using UUIDs), timestamps for `createdAt` and `updatedAt` fields, and the management of relationships between entities. It leverages AWS SDK's `TransactWriteCommand` for transactional integrity, ensuring either complete success or rollback in case of any failure. The method handles conditional checks to ensure data integrity and consistency during creation. If a foreignKey is set on create, dyna-record will de-normalize the data required in order to support the relationship
+The create method is used to insert a new record into a DynamoDB table. This method automatically handles key generation (using UUIDs), timestamps for [createdAt](https://dyna-record.com/classes/default.html#createdAt) and [updatedAt](https://dyna-record.com/classes/default.html#updatedAt) fields, and the management of relationships between entities. It leverages AWS SDK's [TransactWriteCommand](https://www.google.com/search?q=aws+transact+write+command&oq=aws+transact+write+command&gs_lcrp=EgZjaHJvbWUyBggAEEUYOTIGCAEQRRg7MgYIAhBFGDvSAQgzMjAzajBqN6gCALACAA&sourceid=chrome&ie=UTF-8) for transactional integrity, ensuring either complete success or rollback in case of any failure. The method handles conditional checks to ensure data integrity and consistency during creation. If a foreignKey is set on create, dyna-record will de-normalize the data required in order to support the relationship
 
 To use the create method, call it on the model class you wish to create a new record for. Pass the properties of the new record as an object argument to the method.
 
@@ -296,12 +303,12 @@ const grade: Grade = await Grade.create({
 
 #### Error handling
 
-The method is designed to throw errors under various conditions, such as transaction cancellation due to failed conditional checks. For instance, if you attempt to create a Grade for an Assignment that already has one, the method throws a TransactionWriteFailedError.
+The method is designed to throw errors under various conditions, such as transaction cancellation due to failed conditional checks. For instance, if you attempt to create a `Grade` for an `Assignment` that already has one, the method throws a `TransactionWriteFailedError`.
 
 #### Notes
 
-- Automatic Timestamp Management: The createdAt and updatedAt fields are managed automatically and reflect the time of creation and the last update, respectively.
-- Automatic ID Generation: Each entity created gets a unique ID generated by the uuidv4 method.
+- Automatic Timestamp Management: The [createdAt](https://dyna-record.com/classes/default.html#createdAt) and [updatedAt](https://dyna-record.com/classes/default.html#updatedAt) fields are managed automatically and reflect the time of creation and the last update, respectively.
+- Automatic ID Generation: Each entity created gets a unique [id](https://dyna-record.com/classes/default.html#id) generated by the uuidv4 method.
 - Relationship Management: The ORM manages entity relationships through DynamoDB's single-table design patterns, creating and maintaining the necessary links between related entities.
 - Conditional Checks: To ensure data integrity, the create method performs various conditional checks, such as verifying the existence of entities that new records relate to.
 - Error Handling: Errors during the creation process are handled gracefully, with specific errors thrown for different failure scenarios, such as conditional check failures or transaction cancellations.
@@ -374,8 +381,11 @@ const result = await Customer.query("123", {
 
 To be more precise to the underlying data, you can specify the partition key and sort key directly. The keys here will be the partition and sort keys defined on the [table](#table) class.
 
-```
-const orderLinks = await Customer.query({ pk: "Customer#123", sk: { $beginsWith: "Order" } });
+```typescript
+const orderLinks = await Customer.query({
+  pk: "Customer#123",
+  sk: { $beginsWith: "Order" }
+});
 ```
 
 ### Advanced usage
@@ -462,7 +472,7 @@ await PaymentMethod.update("123", {
 
 #### Removing Foreign Key References
 
-Nullable Foreign key references can be removed by setting them to null
+Nullable foreign key references can be removed by setting them to null
 
 Note: Attempting to remove a non nullable foreign key will result in a [NullConstraintViolationError](https://dyna-record.com/classes/NullConstraintViolationError.html)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dyna-record",
-  "version": "0.0.12",
+  "version": "0.0.13",
   "description": "Typescript Object Relational Mapper (ORM) for Dynamo",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",