dyna-record 0.6.0 → 0.6.1

package/README.md

@@ -1,6 +1,6 @@
 # Dyna-Record
 
-[API Documentation](https://dyna-record.com/)
+[API Documentation](https://docs.dyna-record.com/)
 
 [Medium Article](https://medium.com/@drewdavis888/unlock-relational-data-modeling-in-dynamodb-with-dyna-record-5b9cce27c3ce)
 
@@ -51,9 +51,9 @@ Entities in Dyna-Record represent your DynamoDB table structure and relationship
 
 ### Table
 
-[Docs](https://dyna-record.com/functions/Table.html)
+[Docs](https://docs.dyna-record.com/functions/Table.html)
 
-Create a table class that extends [DynaRecord base class](https://dyna-record.com/classes/default.html) and is decorated with the [Table decorator](https://dyna-record.com/functions/Table.html). At a minimum, the table class must define the [PartitionKeyAttribute](https://dyna-record.com/functions/PartitionKeyAttribute.html) and [SortKeyAttribute](https://dyna-record.com/functions/SortKeyAttribute.html).
+Create a table class that extends [DynaRecord base class](https://docs.dyna-record.com/classes/default.html) and is decorated with the [Table decorator](https://docs.dyna-record.com/functions/Table.html). At a minimum, the table class must define the [PartitionKeyAttribute](https://docs.dyna-record.com/functions/PartitionKeyAttribute.html) and [SortKeyAttribute](https://docs.dyna-record.com/functions/SortKeyAttribute.html).
 
 #### Basic usage
 
@@ -108,20 +108,20 @@ abstract class MyTable extends DynaRecord {
 
 ### Entity
 
-[Docs](https://dyna-record.com/functions/Entity.html)
+[Docs](https://docs.dyna-record.com/functions/Entity.html)
 
 Each entity must extend the Table class. To support single table design patterns, they must extend the same tables class.
 
 Each entity **must** declare its `type` property as a string literal matching the class name. This enables compile-time type safety for query filters and return types. Omitting this declaration will produce a compile error at the `@Entity` decorator.
 
-By default, each entity will have [default attributes](https://dyna-record.com/types/_internal_.DefaultFields.html)
+By default, each entity will have [default attributes](https://docs.dyna-record.com/types/_internal_.DefaultFields.html)
 
 - The partition key defined on the [table](#table) class
 - The sort key defined on the [table](#table) class
-- [id](https://dyna-record.com/classes/default.html#id) - The id for the model. This will be an autogenerated uuid unless [IdAttribute](<(https://dyna-record.com/functions/IdAttribute.html)>) is set on a non-nullable entity attribute.
-- [type](https://dyna-record.com/classes/default.html#type) - The type of the entity. Value is the entity class name. Must be declared as a string literal via `declare readonly type: "ClassName"`.
-- [createdAt](https://dyna-record.com/classes/default.html#createdAt) - The timestamp of when the entity was created
-- [updatedAt](https://dyna-record.com/classes/default.html#updatedAt) - Timestamp of when the entity was updated last
+- [id](https://docs.dyna-record.com/classes/default.html#id) - The id for the model. This will be an autogenerated uuid unless [IdAttribute](<(https://docs.dyna-record.com/functions/IdAttribute.html)>) is set on a non-nullable entity attribute.
+- [type](https://docs.dyna-record.com/classes/default.html#type) - The type of the entity. Value is the entity class name. Must be declared as a string literal via `declare readonly type: "ClassName"`.
+- [createdAt](https://docs.dyna-record.com/classes/default.html#createdAt) - The timestamp of when the entity was created
+- [updatedAt](https://docs.dyna-record.com/classes/default.html#updatedAt) - Timestamp of when the entity was updated last
 
 ```typescript
 import { Entity } from "dyna-record";
@@ -147,17 +147,17 @@ Use the attribute decorators below to define attributes on a model. The decorato
 
 - Attribute decorators
 
-  - [@StringAttribute](https://dyna-record.com/functions/StringAttribute.html)
-  - [@NumberAttribute](https://dyna-record.com/functions/NumberAttribute.html)
-  - [@BooleanAttribute](https://dyna-record.com/functions/BooleanAttribute.html)
-  - [@DateAttribute](https://dyna-record.com/functions/DateAttribute.html)
-  - [@EnumAttribute](https://dyna-record.com/functions/EnumAttribute.html)
-  - [@IdAttribute](https://dyna-record.com/functions/IdAttribute.html)
-  - [@ObjectAttribute](https://dyna-record.com/functions/ObjectAttribute.html)
+  - [@StringAttribute](https://docs.dyna-record.com/functions/StringAttribute.html)
+  - [@NumberAttribute](https://docs.dyna-record.com/functions/NumberAttribute.html)
+  - [@BooleanAttribute](https://docs.dyna-record.com/functions/BooleanAttribute.html)
+  - [@DateAttribute](https://docs.dyna-record.com/functions/DateAttribute.html)
+  - [@EnumAttribute](https://docs.dyna-record.com/functions/EnumAttribute.html)
+  - [@IdAttribute](https://docs.dyna-record.com/functions/IdAttribute.html)
+  - [@ObjectAttribute](https://docs.dyna-record.com/functions/ObjectAttribute.html)
 
-- 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.
+- The [alias](https://docs.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 attributes as optional for optimal type safety
-- Attempting to remove a non-nullable attribute will result in a [NullConstrainViolationError](https://dyna-record.com/classes/NullConstraintViolationError.html)
+- Attempting to remove a non-nullable attribute will result in a [NullConstrainViolationError](https://docs.dyna-record.com/classes/NullConstraintViolationError.html)
 
 ```typescript
 import { Entity, Attribute } from "dyna-record";
@@ -251,11 +251,11 @@ The schema must be declared with `as const satisfies ObjectSchema` so TypeScript
 
 ### Foreign Keys
 
-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.
+Define foreign keys in order to support [@BelongsTo](https://docs.dyna-record.com/functions/BelongsTo.html) relationships. A foreign key is required for [@HasOne](https://docs.dyna-record.com/functions/HasOne.html) and [@HasMany](https://docs.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.
+- The [alias](https://docs.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
-- Attempting to remove an entity from a non-nullable foreign key will result in a [NullConstrainViolationError](https://dyna-record.com/classes/NullConstraintViolationError.html)
+- Attempting to remove an entity from a non-nullable foreign key will result in a [NullConstrainViolationError](https://docs.dyna-record.com/classes/NullConstraintViolationError.html)
 - Always provide the referenced entity class to `@ForeignKeyAttribute` (for example `@ForeignKeyAttribute(() => Customer)`); this allows DynaRecord to enforce referential integrity even when no relationship decorator is defined.
 - `Create` and `Update` automatically add DynamoDB condition checks for standalone foreign keys (those without a relationship decorator) to ensure the referenced entity exists, enabling referential integrity even when no denormalised access pattern is required.
 
@@ -293,16 +293,16 @@ class Course extends MyTable {
 
 ### Relationships
 
-Dyna-Record supports defining relationships between entities such as [@HasOne](https://dyna-record.com/functions/HasOne.html), [@HasMany](https://dyna-record.com/functions/HasMany.html), [@BelongsTo](https://dyna-record.com/functions/BelongsTo.html) and [@HasAndBelongsToMany](https://dyna-record.com/functions/HasAndBelongsToMany.html). It does this by de-normalizing records to each of its related entities partitions.
+Dyna-Record supports defining relationships between entities such as [@HasOne](https://docs.dyna-record.com/functions/HasOne.html), [@HasMany](https://docs.dyna-record.com/functions/HasMany.html), [@BelongsTo](https://docs.dyna-record.com/functions/BelongsTo.html) and [@HasAndBelongsToMany](https://docs.dyna-record.com/functions/HasAndBelongsToMany.html). It does this by de-normalizing records to each of its related entities partitions.
 
-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)
+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://docs.dyna-record.com/classes/NullConstraintViolationError.html)
 
-- [@ForeignKeyAttribute](https://dyna-record.com/functions/ForeignKeyAttribute.html) is used to define a foreign key that links to another entity
-- Relationship decorators ([@HasOne](#hasone), [@HasMany](#hasmany), [@BelongsTo](https://dyna-record.com/functions/BelongsTo.html), [@HasAndBelongsToMany](#hasandbelongstomany)) define how entities relate to each other.
+- [@ForeignKeyAttribute](https://docs.dyna-record.com/functions/ForeignKeyAttribute.html) is used to define a foreign key that links to another entity
+- Relationship decorators ([@HasOne](#hasone), [@HasMany](#hasmany), [@BelongsTo](https://docs.dyna-record.com/functions/BelongsTo.html), [@HasAndBelongsToMany](#hasandbelongstomany)) define how entities relate to each other.
 
 #### HasOne
 
-[Docs](https://dyna-record.com/functions/HasOne.html)
+[Docs](https://docs.dyna-record.com/functions/HasOne.html)
 
 ```typescript
 import {
@@ -337,7 +337,7 @@ class Grade extends MyTable {
 
 ### HasMany
 
-[Docs](https://dyna-record.com/functions/HasMany.html)
+[Docs](https://docs.dyna-record.com/functions/HasMany.html)
 
 ```typescript
 import { Entity, NullableForeignKey, BelongsTo, HasMany } from "dyna-record";
@@ -391,9 +391,9 @@ class Course extends MyTable {
 
 ### HasAndBelongsToMany
 
-[Docs](https://dyna-record.com/functions/HasAndBelongsToMany.html)
+[Docs](https://docs.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
+HasAndBelongsToMany relationships require a [JoinTable](https://docs.dyna-record.com/classes/JoinTable.html) class. This represents a virtual table to support the relationship
 
 ```typescript
 import {
@@ -435,9 +435,9 @@ class Student extends OtherTable {
 
 ### Create
 
-[Docs](https://dyna-record.com/classes/default.html#create)
+[Docs](https://docs.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 or custom id field if [IdAttribute](<(https://dyna-record.com/functions/IdAttribute.html)>) is set), 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
+The create method is used to insert a new record into a DynamoDB table. This method automatically handles key generation (using UUIDs or custom id field if [IdAttribute](<(https://docs.dyna-record.com/functions/IdAttribute.html)>) is set), timestamps for [createdAt](https://docs.dyna-record.com/classes/default.html#createdAt) and [updatedAt](https://docs.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. Only attributes defined on the model can be configured, and will be enforced via types and runtime schema validation.
 
@@ -482,20 +482,20 @@ 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](https://dyna-record.com/classes/TransactionWriteFailedError.html).
+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](https://docs.dyna-record.com/classes/TransactionWriteFailedError.html).
 
 #### Notes
 
-- 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.
-  - This can be customized [IdAttribute](<(https://dyna-record.com/functions/IdAttribute.html)>) to support custom id attributes
+- Automatic Timestamp Management: The [createdAt](https://docs.dyna-record.com/classes/default.html#createdAt) and [updatedAt](https://docs.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://docs.dyna-record.com/classes/default.html#id) generated by the uuidv4 method.
+  - This can be customized [IdAttribute](<(https://docs.dyna-record.com/functions/IdAttribute.html)>) to support custom id attributes
 - 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.
 
 ### FindById
 
-[Docs](https://dyna-record.com/classes/default.html#findById)
+[Docs](https://docs.dyna-record.com/classes/default.html#findById)
 
 Retrieve a single record by its primary key.
 
@@ -529,7 +529,7 @@ const course = await Course.findById("123", {
 
 ### Query
 
-[Docs](https://dyna-record.com/classes/default.html#query)
+[Docs](https://docs.dyna-record.com/classes/default.html#query)
 
 The query method is a versatile tool for querying data from DynamoDB tables using primary key conditions and various optional filters. This method enables fetching multiple items that match specific criteria, making it ideal for situations where more than one item needs to be retrieved based on attributes of the primary key (partition key and sort key).
 
@@ -835,7 +835,7 @@ const result = await Customer.query(
 
 ### Update
 
-[Docs](https://dyna-record.com/classes/default.html#update)
+[Docs](https://docs.dyna-record.com/classes/default.html#update)
 
 The update method enables modifications to existing items in a DynamoDB table. It supports updating simple attributes, handling nullable fields, and managing relationships between entities, including updating and removing foreign keys. Only attributes defined on the model can be updated, and will be enforced via types and runtime schema validation.
 
@@ -850,7 +850,7 @@ await Customer.update("123", {
 
 #### Removing attributes
 
-Note: Attempting to remove a non nullable attribute will result in a [NullConstraintViolationError](https://dyna-record.com/classes/NullConstraintViolationError.html)
+Note: Attempting to remove a non nullable attribute will result in a [NullConstraintViolationError](https://docs.dyna-record.com/classes/NullConstraintViolationError.html)
 
 ```typescript
 await ContactInformation.update("123", {
@@ -873,7 +873,7 @@ await PaymentMethod.update("123", {
 
 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)
+Note: Attempting to remove a non nullable foreign key will result in a [NullConstraintViolationError](https://docs.dyna-record.com/classes/NullConstraintViolationError.html)
 
 ```typescript
 await Pet.update("123", {
@@ -967,7 +967,7 @@ const updatedInstance = await paymentMethodInstance.update(
 
 ### Delete
 
-[Docs](https://dyna-record.com/classes/default.html#delete)
+[Docs](https://docs.dyna-record.com/classes/default.html#delete)
 
 The delete method is used to remove an entity from a DynamoDB table, along with handling the deletion of associated items in relationships (like HasMany, HasOne, BelongsTo) to maintain the integrity of the database schema.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dyna-record",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "description": "Typescript Data Modeler and ORM for Dynamo",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",