dyna-record 0.1.4 → 0.2.0

package/README.md

@@ -89,9 +89,7 @@ import DynaRecord, {
     id: { alias: "Id" },
     type: { alias: "Type" },
     createdAt: { alias: "CreatedAt" },
-    updatedAt: { alias: "UpdatedAt" },
-    foreignKey: { alias: "ForeignKey" },
-    foreignEntityType: { alias: "ForeignEntityType" }
+    updatedAt: { alias: "UpdatedAt" }
   }
 })
 abstract class MyTable extends DynaRecord {
@@ -113,7 +111,7 @@ By default, each entity will have [default attributes](https://dyna-record.com/t
 
 - 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 auto generated uuid for the model
+- [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
 - [createdAt](https://dyna-record.com/classes/default.html#updatedAt) - 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
@@ -143,6 +141,7 @@ Use the attribute decorators below to define attributes on a model. The decorato
   - [@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)
 
 - 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 attributes as optional for optimal type safety
@@ -202,7 +201,7 @@ 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 [BelongsToLinks](https://dyna-record.com/classes/BelongsToLink.html) according the each pattern to support relational querying.
+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.
 
 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)
 
@@ -309,7 +308,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](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://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
 
 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.
 
@@ -341,6 +340,7 @@ The method is designed to throw errors under various conditions, such as transac
 
 - 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
 - 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.
@@ -391,7 +391,7 @@ There are two main patterns; query by id and query by primary key
 
 To query items using the id, simply pass the partition key value as the first parameter. This fetches all items that share the same partition key value.
 
-The result will be an array of the entity and [BelongsToLinks](https://dyna-record.com/classes/BelongsToLink.html)
+The result will be an array of the entity or related entities that match the filters
 
 ##### Query by id
 
@@ -414,7 +414,7 @@ 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.
 
 ```typescript
-const orderLinks = await Customer.query({
+const orders = await Customer.query({
   pk: "Customer#123",
   sk: { $beginsWith: "Order" }
 });
@@ -431,17 +431,17 @@ const result = await Course.query(
   },
   {
     filter: {
-      type: ["BelongsToLink", "Brewery"],
+      type: ["Assignment", "Teacher"],
       createdAt: { $beginsWith: "202" },
       $or: [
         {
-          foreignKey: "111",
+          name: "Potions",
           updatedAt: { $beginsWith: "2023-02-15" }
         },
         {
-          foreignKey: ["222", "333"],
+          type: ["science", "math"],
           createdAt: { $beginsWith: "2021-09-15T" },
-          foreignEntityType: "Assignment"
+          type: "Assignment"
         },
         {
           id: "123"
@@ -538,14 +538,14 @@ await User.delete("user-id");
 
 When deleting entities involved in HasMany or HasOne relationships:
 
-If a Pet belongs to an Owner (HasMany relationship), deleting the Pet will remove its BelongsToLink from the Owner's partition.
-If a Home belongs to a Person (HasOne relationship), deleting the Home will remove its BelongsToLink from the Person's partition.
+If a Pet belongs to an Owner (HasMany relationship), deleting the Pet will remove its denormalized records from the Owner's partition.
+If a Home belongs to a Person (HasOne relationship), deleting the Home will remove its denormalized records from the Person's partition.
 
 ```typescript
 await Home.delete("123");
 ```
 
-This deletes the Home entity and its BelongsToLink with a Person.
+This deletes the Home entity and its denormalized record with a Person.
 
 #### Deleting Entities from HasAndBelongsToMany Relationships
 

package/dist/src/DynaRecord.d.ts

@@ -1,5 +1,5 @@
 import { type QueryOptions as QueryBuilderOptions } from "./query-utils";
-import { type FindByIdOptions, type FindByIdIncludesRes, type QueryOptions, type EntityKeyConditions, type QueryResults, Create, type CreateOptions, type UpdateOptions } from "./operations";
+import { type FindByIdOptions, type FindByIdIncludesRes, type QueryOptions, type EntityKeyConditions, type QueryResults, Create, type CreateOptions, type UpdateOptions, type EntityAttributesInstance } from "./operations";
 import type { EntityClass, Optional } from "./types";
 interface DynaRecordBase {
     id: string;
@@ -48,22 +48,30 @@ declare abstract class DynaRecord implements DynaRecordBase {
      */
     readonly updatedAt: Date;
     /**
-     * Find an entity by Id and optionally include associations
-     * @param {string} id - Entity Id
-     * @param {Object} options - FindByIdOptions
-     * @returns An entity with included associations serialized
+     * Find an entity by Id and optionally include associations.
+     *
+     * @param {string} id - Entity Id.
+     * @param {undefined} [options] - No options provided, returns the entity without included associations.
+     * @returns {Optional<T>} An entity without included associations serialized.
      *
      * @example Without included relationships
      * ```typescript
      * const user = await User.findById("userId");
      * ```
      *
+     * ---
+     *
+     * @param {string} id - Entity Id.
+     * @param {FindByIdOptions<T>} options - FindByIdOptions specifying associations to include.
+     * @returns {FindByIdIncludesRes<T, FindByIdOptions<T>>} An entity with included associations serialized.
+     *
      * @example With included relationships
      * ```typescript
      * const user = await User.findById("userId", { include: [{ association: "profile" }] });
      * ```
      */
-    static findById<T extends DynaRecord, Opts extends FindByIdOptions<T>>(this: EntityClass<T>, id: string, options?: Opts): Promise<Optional<T | FindByIdIncludesRes<T, Opts>>>;
+    static findById<T extends DynaRecord>(this: EntityClass<T>, id: string, options?: undefined): Promise<Optional<EntityAttributesInstance<T>>>;
+    static findById<T extends DynaRecord, Opts extends FindByIdOptions<T>>(this: EntityClass<T>, id: string, options?: Opts): Promise<Optional<FindByIdIncludesRes<T, Opts>>>;
     /**
      * Query by PartitionKey and optional SortKey/Filter/Index conditions
      * @param {Object} key - PartitionKey value and optional SortKey condition. Keys must be attributes defined on the model
@@ -92,23 +100,22 @@ declare abstract class DynaRecord implements DynaRecordBase {
      *  },
      *  {
      *    filter: {
-     *    type: ["BelongsToLink", "Profile"],
-     *    createdAt: { $beginsWith: "202" },
-     *    $or: [
-     *      {
-     *        foreignKey: "111",
-     *        updatedAt: { $beginsWith: "2023-02-15" }
-     *      },
-     *      {
-     *        foreignKey: ["222", "333"],
-     *        createdAt: { $beginsWith: "2021-09-15T" },
-     *        foreignEntityType: "Order"
-     *      },
-     *      {
-     *        id: "123"
-     *      }
-     *    ]
-     *  }
+     *      type: ["Profile", "Preferences"],
+     *      createdAt: { $beginsWith: "2023" },
+     *      $or: [
+     *        {
+     *         name: "John",
+     *         email: { $beginsWith: "testing }
+     *        },
+     *        {
+     *          name: "Jane",
+     *          updatedAt: { $beginsWith: "2024" },
+     *        },
+     *       {
+     *         id: "123"
+     *       }
+     *      ]
+     *    }
      * }
      *);
      * ```
@@ -150,7 +157,7 @@ declare abstract class DynaRecord implements DynaRecordBase {
      * ```typescript
      * const user = await User.query("123", {
      *   filter: {
-     *     type: "BelongsToLink",
+     *     type: "Profile",
      *     createdAt: "2023-11-21T12:31:21.148Z"
      *    }
      * });
@@ -158,7 +165,7 @@ declare abstract class DynaRecord implements DynaRecordBase {
      */
     static query<T extends DynaRecord>(this: EntityClass<T>, id: string, options?: Omit<QueryOptions, "indexName">): Promise<QueryResults<T>>;
     /**
-     * Create an entity. If foreign keys are included in the attributes then BelongsToLinks will be demoralized accordingly
+     * Create an entity. If foreign keys are included in the attributes then links will be demoralized accordingly
      * @param attributes - Attributes of the model to create
      * @returns The new Entity
      *
@@ -169,8 +176,8 @@ declare abstract class DynaRecord implements DynaRecordBase {
     static create<T extends DynaRecord>(this: EntityClass<T>, attributes: CreateOptions<T>): Promise<ReturnType<Create<T>["run"]>>;
     /**
      * Update an entity. If foreign keys are included in the attribute then:
-     *   - BelongsToLinks will be created accordingly
-     *   - If the entity already had a foreign key relationship, then those BelongsToLinks will be deleted
+     *   - Manages associated relationship links as needed
+     *   - If the entity already had a foreign key relationship, then denormalized records will be deleted from each partition
      *     - If the foreign key is not nullable then a {@link NullConstraintViolationError} is thrown.
      *   - Validation errors will be thrown if the attribute being removed is not nullable
      * @param id - The id of the entity to update
@@ -205,7 +212,7 @@ declare abstract class DynaRecord implements DynaRecordBase {
     update<T extends this>(attributes: UpdateOptions<T>): Promise<T>;
     /**
      * Delete an entity by ID
-     *   - Delete all BelongsToLinks
+     *   - Delete all denormalized records
      *   - Disassociate all foreign keys of linked models
      * @param id - The id of the entity to update
      *
@@ -226,6 +233,7 @@ declare abstract class DynaRecord implements DynaRecordBase {
      * ```
      */
     static partitionKeyValue(id: string): string;
+    partitionKeyValue(): string;
 }
 export default DynaRecord;
 //# sourceMappingURL=DynaRecord.d.ts.map

package/dist/src/DynaRecord.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DynaRecord.d.ts","sourceRoot":"","sources":["../../src/DynaRecord.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,YAAY,IAAI,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAEzE,OAAO,EAEL,KAAK,eAAe,EACpB,KAAK,mBAAmB,EAExB,KAAK,YAAY,EACjB,KAAK,mBAAmB,EACxB,KAAK,YAAY,EACjB,MAAM,EACN,KAAK,aAAa,EAElB,KAAK,aAAa,EAGnB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAGrD,UAAU,cAAc;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;CACjB;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,uBAAe,UAAW,YAAW,cAAc;IACjD;;OAEG;IACH,SACgB,EAAE,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,SACgB,IAAI,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,SACgB,SAAS,EAAE,IAAI,CAAC;IAEhC;;OAEG;IACH,SACgB,SAAS,EAAE,IAAI,CAAC;IAEhC;;;;;;;;;;;;;;;OAeG;WACiB,QAAQ,CAC1B,CAAC,SAAS,UAAU,EACpB,IAAI,SAAS,eAAe,CAAC,CAAC,CAAC,EAE/B,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,EACpB,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,IAAI,GACb,OAAO,CAAC,QAAQ,CAAC,CAAC,GAAG,mBAAmB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;IAKtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2DG;WACiB,KAAK,CAAC,CAAC,SAAS,UAAU,EAC5C,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,EACpB,GAAG,EAAE,mBAAmB,CAAC,CAAC,CAAC,EAC3B,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;WACiB,KAAK,CAAC,CAAC,SAAS,UAAU,EAC5C,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,EACpB,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,WAAW,CAAC,GACxC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAW3B;;;;;;;;OAQG;WACiB,MAAM,CAAC,CAAC,SAAS,UAAU,EAC7C,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,EACpB,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC,GAC3B,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IAKxC;;;;;;;;;;;;;;;;;;;OAmBG;WACiB,MAAM,CAAC,CAAC,SAAS,UAAU,EAC7C,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,EACpB,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC,GAC3B,OAAO,CAAC,IAAI,CAAC;IAKhB;;;;;;;;;;;;;OAaG;IACU,MAAM,CAAC,CAAC,SAAS,IAAI,EAChC,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC,GAC3B,OAAO,CAAC,CAAC,CAAC;IAkBb;;;;;;;;;;OAUG;WACiB,MAAM,CAAC,CAAC,SAAS,UAAU,EAC7C,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,EACpB,EAAE,EAAE,MAAM,GACT,OAAO,CAAC,IAAI,CAAC;IAKhB;;;;;;;;;OASG;WACW,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM;CAIpD;AAED,eAAe,UAAU,CAAC"}
+{"version":3,"file":"DynaRecord.d.ts","sourceRoot":"","sources":["../../src/DynaRecord.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,YAAY,IAAI,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAEzE,OAAO,EAEL,KAAK,eAAe,EACpB,KAAK,mBAAmB,EAExB,KAAK,YAAY,EACjB,KAAK,mBAAmB,EACxB,KAAK,YAAY,EACjB,MAAM,EACN,KAAK,aAAa,EAElB,KAAK,aAAa,EAGlB,KAAK,wBAAwB,EAC9B,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAGrD,UAAU,cAAc;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;CACjB;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,uBAAe,UAAW,YAAW,cAAc;IACjD;;OAEG;IACH,SACgB,EAAE,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,SACgB,IAAI,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,SACgB,SAAS,EAAE,IAAI,CAAC;IAEhC;;OAEG;IACH,SACgB,SAAS,EAAE,IAAI,CAAC;IAEhC;;;;;;;;;;;;;;;;;;;;;;OAsBG;WACiB,QAAQ,CAAC,CAAC,SAAS,UAAU,EAC/C,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,EACpB,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,SAAS,GAClB,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC,CAAC;WAE7B,QAAQ,CAC1B,CAAC,SAAS,UAAU,EACpB,IAAI,SAAS,eAAe,CAAC,CAAC,CAAC,EAE/B,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,EACpB,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,IAAI,GACb,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;IAgBlD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0DG;WACiB,KAAK,CAAC,CAAC,SAAS,UAAU,EAC5C,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,EACpB,GAAG,EAAE,mBAAmB,CAAC,CAAC,CAAC,EAC3B,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;WACiB,KAAK,CAAC,CAAC,SAAS,UAAU,EAC5C,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,EACpB,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,WAAW,CAAC,GACxC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAW3B;;;;;;;;OAQG;WACiB,MAAM,CAAC,CAAC,SAAS,UAAU,EAC7C,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,EACpB,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC,GAC3B,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IAKxC;;;;;;;;;;;;;;;;;;;OAmBG;WACiB,MAAM,CAAC,CAAC,SAAS,UAAU,EAC7C,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,EACpB,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC,GAC3B,OAAO,CAAC,IAAI,CAAC;IAKhB;;;;;;;;;;;;;OAaG;IACU,MAAM,CAAC,CAAC,SAAS,IAAI,EAChC,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC,GAC3B,OAAO,CAAC,CAAC,CAAC;IAkBb;;;;;;;;;;OAUG;WACiB,MAAM,CAAC,CAAC,SAAS,UAAU,EAC7C,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,EACpB,EAAE,EAAE,MAAM,GACT,OAAO,CAAC,IAAI,CAAC;IAKhB;;;;;;;;;OASG;WACW,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM;IAK5C,iBAAiB,IAAI,MAAM;CAGnC;AAED,eAAe,UAAU,CAAC"}

package/dist/src/DynaRecord.js

@@ -49,13 +49,23 @@ var __runInitializers = (this && this.__runInitializers) || function (thisArg, i
     }
     return useValue ? value : void 0;
 };
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 const metadata_1 = __importStar(require("./metadata"));
 const decorators_1 = require("./decorators");
@@ -85,15 +95,18 @@ const utils_1 = require("./utils");
  * ```
  */
 let DynaRecord = (() => {
-    let _instanceExtraInitializers = [];
     let _id_decorators;
     let _id_initializers = [];
+    let _id_extraInitializers = [];
     let _type_decorators;
     let _type_initializers = [];
+    let _type_extraInitializers = [];
     let _createdAt_decorators;
     let _createdAt_initializers = [];
+    let _createdAt_extraInitializers = [];
     let _updatedAt_decorators;
     let _updatedAt_initializers = [];
+    let _updatedAt_extraInitializers = [];
     return class DynaRecord {
         static {
             const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(null) : void 0;
@@ -101,44 +114,28 @@ let DynaRecord = (() => {
             _type_decorators = [(0, decorators_1.StringAttribute)({ alias: metadata_1.tableDefaultFields.type.alias })];
             _createdAt_decorators = [(0, decorators_1.DateAttribute)({ alias: metadata_1.tableDefaultFields.createdAt.alias })];
             _updatedAt_decorators = [(0, decorators_1.DateAttribute)({ alias: metadata_1.tableDefaultFields.updatedAt.alias })];
-            __esDecorate(null, null, _id_decorators, { kind: "field", name: "id", static: false, private: false, access: { has: obj => "id" in obj, get: obj => obj.id, set: (obj, value) => { obj.id = value; } }, metadata: _metadata }, _id_initializers, _instanceExtraInitializers);
-            __esDecorate(null, null, _type_decorators, { kind: "field", name: "type", static: false, private: false, access: { has: obj => "type" in obj, get: obj => obj.type, set: (obj, value) => { obj.type = value; } }, metadata: _metadata }, _type_initializers, _instanceExtraInitializers);
-            __esDecorate(null, null, _createdAt_decorators, { kind: "field", name: "createdAt", static: false, private: false, access: { has: obj => "createdAt" in obj, get: obj => obj.createdAt, set: (obj, value) => { obj.createdAt = value; } }, metadata: _metadata }, _createdAt_initializers, _instanceExtraInitializers);
-            __esDecorate(null, null, _updatedAt_decorators, { kind: "field", name: "updatedAt", static: false, private: false, access: { has: obj => "updatedAt" in obj, get: obj => obj.updatedAt, set: (obj, value) => { obj.updatedAt = value; } }, metadata: _metadata }, _updatedAt_initializers, _instanceExtraInitializers);
+            __esDecorate(null, null, _id_decorators, { kind: "field", name: "id", static: false, private: false, access: { has: obj => "id" in obj, get: obj => obj.id, set: (obj, value) => { obj.id = value; } }, metadata: _metadata }, _id_initializers, _id_extraInitializers);
+            __esDecorate(null, null, _type_decorators, { kind: "field", name: "type", static: false, private: false, access: { has: obj => "type" in obj, get: obj => obj.type, set: (obj, value) => { obj.type = value; } }, metadata: _metadata }, _type_initializers, _type_extraInitializers);
+            __esDecorate(null, null, _createdAt_decorators, { kind: "field", name: "createdAt", static: false, private: false, access: { has: obj => "createdAt" in obj, get: obj => obj.createdAt, set: (obj, value) => { obj.createdAt = value; } }, metadata: _metadata }, _createdAt_initializers, _createdAt_extraInitializers);
+            __esDecorate(null, null, _updatedAt_decorators, { kind: "field", name: "updatedAt", static: false, private: false, access: { has: obj => "updatedAt" in obj, get: obj => obj.updatedAt, set: (obj, value) => { obj.updatedAt = value; } }, metadata: _metadata }, _updatedAt_initializers, _updatedAt_extraInitializers);
             if (_metadata) Object.defineProperty(this, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
         }
         /**
          * A unique identifier for the entity itself, automatically generated upon creation.
          */
-        id = (__runInitializers(this, _instanceExtraInitializers), __runInitializers(this, _id_initializers, void 0));
+        id = __runInitializers(this, _id_initializers, void 0);
         /**
          * The type of the Entity
          */
-        type = __runInitializers(this, _type_initializers, void 0);
+        type = (__runInitializers(this, _id_extraInitializers), __runInitializers(this, _type_initializers, void 0));
         /**
          * The timestamp marking when the entity was created
          */
-        createdAt = __runInitializers(this, _createdAt_initializers, void 0);
+        createdAt = (__runInitializers(this, _type_extraInitializers), __runInitializers(this, _createdAt_initializers, void 0));
         /**
          * The timestamp marking the last update to the entity. Initially set to the same value as `createdAt`.
          */
-        updatedAt = __runInitializers(this, _updatedAt_initializers, void 0);
-        /**
-         * Find an entity by Id and optionally include associations
-         * @param {string} id - Entity Id
-         * @param {Object} options - FindByIdOptions
-         * @returns An entity with included associations serialized
-         *
-         * @example Without included relationships
-         * ```typescript
-         * const user = await User.findById("userId");
-         * ```
-         *
-         * @example With included relationships
-         * ```typescript
-         * const user = await User.findById("userId", { include: [{ association: "profile" }] });
-         * ```
-         */
+        updatedAt = (__runInitializers(this, _createdAt_extraInitializers), __runInitializers(this, _updatedAt_initializers, void 0));
         static async findById(id, options) {
             const op = new operations_1.FindById(this);
             return await op.run(id, options);
@@ -148,7 +145,7 @@ let DynaRecord = (() => {
             return await op.run(key, options);
         }
         /**
-         * Create an entity. If foreign keys are included in the attributes then BelongsToLinks will be demoralized accordingly
+         * Create an entity. If foreign keys are included in the attributes then links will be demoralized accordingly
          * @param attributes - Attributes of the model to create
          * @returns The new Entity
          *
@@ -162,8 +159,8 @@ let DynaRecord = (() => {
         }
         /**
          * Update an entity. If foreign keys are included in the attribute then:
-         *   - BelongsToLinks will be created accordingly
-         *   - If the entity already had a foreign key relationship, then those BelongsToLinks will be deleted
+         *   - Manages associated relationship links as needed
+         *   - If the entity already had a foreign key relationship, then denormalized records will be deleted from each partition
          *     - If the foreign key is not nullable then a {@link NullConstraintViolationError} is thrown.
          *   - Validation errors will be thrown if the attribute being removed is not nullable
          * @param id - The id of the entity to update
@@ -211,7 +208,7 @@ let DynaRecord = (() => {
         }
         /**
          * Delete an entity by ID
-         *   - Delete all BelongsToLinks
+         *   - Delete all denormalized records
          *   - Disassociate all foreign keys of linked models
          * @param id - The id of the entity to update
          *
@@ -238,6 +235,12 @@ let DynaRecord = (() => {
             const { delimiter } = metadata_1.default.getEntityTable(this.name);
             return `${this.name}${delimiter}${id}`;
         }
+        partitionKeyValue() {
+            return this.constructor.partitionKeyValue(this.id);
+        }
+        constructor() {
+            __runInitializers(this, _updatedAt_extraInitializers);
+        }
     };
 })();
 exports.default = DynaRecord;

package/dist/src/decorators/Table.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Table.d.ts","sourceRoot":"","sources":["../../../src/decorators/Table.ts"],"names":[],"mappings":"AAAA,OAAiB,EAAE,KAAK,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAClE,OAAO,KAAK,UAAU,MAAM,eAAe,CAAC;AAE5C;;;;;;;;;;;;;;;;GAgBG;AACH,iBAAS,KAAK,CAAC,KAAK,EAAE,oBAAoB,YACf,iBAAiB,WAAW,qBAAqB,UAK3E;AAED,eAAe,KAAK,CAAC"}
+{"version":3,"file":"Table.d.ts","sourceRoot":"","sources":["../../../src/decorators/Table.ts"],"names":[],"mappings":"AAAA,OAAiB,EAAE,KAAK,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAClE,OAAO,KAAK,UAAU,MAAM,eAAe,CAAC;AAE5C;;;;;;;;;;;;;;;;GAgBG;AACH,iBAAS,KAAK,CAAC,KAAK,EAAE,oBAAoB,YACf,OAAO,UAAU,WAAW,qBAAqB,UAK3E;AAED,eAAe,KAAK,CAAC"}

package/dist/src/decorators/attributes/BooleanAttribute.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BooleanAttribute.d.ts","sourceRoot":"","sources":["../../../../src/decorators/attributes/BooleanAttribute.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,UAAU,MAAM,kBAAkB,CAAC;AAE/C,OAAO,KAAK,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5E;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,iBAAS,gBAAgB,CACvB,CAAC,SAAS,UAAU,EACpB,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,gBAAgB,EAC1B,KAAK,CAAC,EAAE,CAAC,YAEC,SAAS,WACR,0BAA0B,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,UAe9C;AAED,eAAe,gBAAgB,CAAC"}
+{"version":3,"file":"BooleanAttribute.d.ts","sourceRoot":"","sources":["../../../../src/decorators/attributes/BooleanAttribute.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,UAAU,MAAM,kBAAkB,CAAC;AAE/C,OAAO,KAAK,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5E;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,iBAAS,gBAAgB,CACvB,CAAC,SAAS,UAAU,EACpB,CAAC,SAAS,OAAO,EACjB,CAAC,SAAS,gBAAgB,EAC1B,KAAK,CAAC,EAAE,CAAC,YAEC,SAAS,WACR,yBAAyB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,UAa9C;AAED,eAAe,gBAAgB,CAAC"}

package/dist/src/decorators/attributes/BooleanAttribute.js

@@ -32,8 +32,7 @@ function BooleanAttribute(props) {
     return function (_value, context) {
         if (context.kind === "field") {
             context.addInitializer(function () {
-                const entity = Object.getPrototypeOf(this);
-                metadata_1.default.addEntityAttribute(entity.constructor.name, {
+                metadata_1.default.addEntityAttribute(this.constructor.name, {
                     attributeName: context.name.toString(),
                     nullable: props?.nullable,
                     type: zod_1.z.boolean(),

package/dist/src/decorators/attributes/DateAttribute.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DateAttribute.d.ts","sourceRoot":"","sources":["../../../../src/decorators/attributes/DateAttribute.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,UAAU,MAAM,kBAAkB,CAAC;AAE/C,OAAO,KAAK,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAG5E;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,iBAAS,aAAa,CACpB,CAAC,SAAS,UAAU,EACpB,CAAC,SAAS,IAAI,EACd,CAAC,SAAS,gBAAgB,EAC1B,KAAK,CAAC,EAAE,CAAC,YAEC,SAAS,WACR,0BAA0B,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,UAgB9C;AAED,eAAe,aAAa,CAAC"}
+{"version":3,"file":"DateAttribute.d.ts","sourceRoot":"","sources":["../../../../src/decorators/attributes/DateAttribute.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,UAAU,MAAM,kBAAkB,CAAC;AAE/C,OAAO,KAAK,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAG5E;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,iBAAS,aAAa,CACpB,CAAC,SAAS,UAAU,EACpB,CAAC,SAAS,IAAI,EACd,CAAC,SAAS,gBAAgB,EAC1B,KAAK,CAAC,EAAE,CAAC,YAEC,SAAS,WACR,yBAAyB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,UAc9C;AAED,eAAe,aAAa,CAAC"}

package/dist/src/decorators/attributes/DateAttribute.js

@@ -35,8 +35,7 @@ function DateAttribute(props) {
     return function (_value, context) {
         if (context.kind === "field") {
             context.addInitializer(function () {
-                const entity = Object.getPrototypeOf(this);
-                metadata_1.default.addEntityAttribute(entity.constructor.name, {
+                metadata_1.default.addEntityAttribute(this.constructor.name, {
                     attributeName: context.name.toString(),
                     nullable: props?.nullable,
                     serializers: serializers_1.dateSerializer,

package/dist/src/decorators/attributes/EnumAttribute.d.ts

@@ -18,7 +18,7 @@ export interface EnumAttributeOptions extends AttributeOptions {
  *
  * Usage example:
  * ```typescript
- * class Product extends BaseEntity {
+ * class Product extends TableClass {
  *   @EnumAttribute({ alias: 'SomeField', values: ["val-1", "val-2"] })
  *   public someField: "val-1" | "val-2"; // Attribute representing the union/enum types specified in `values`. In this case the only allowed values are "val-1" and "val-2"
  *

package/dist/src/decorators/attributes/EnumAttribute.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EnumAttribute.d.ts","sourceRoot":"","sources":["../../../../src/decorators/attributes/EnumAttribute.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,UAAU,MAAM,kBAAkB,CAAC;AAE/C,OAAO,KAAK,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5E;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAG5D,MAAM,EAAE,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;CAC/B;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,iBAAS,aAAa,CACpB,CAAC,SAAS,UAAU,EACpB,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,EACnC,KAAK,CAAC,CAAC,SAAS,oBAAoB,EACpC,KAAK,EAAE,CAAC,YAEE,SAAS,WACR,0BAA0B,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,UAe9C;AAED,eAAe,aAAa,CAAC"}
+{"version":3,"file":"EnumAttribute.d.ts","sourceRoot":"","sources":["../../../../src/decorators/attributes/EnumAttribute.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,UAAU,MAAM,kBAAkB,CAAC;AAE/C,OAAO,KAAK,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5E;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAG5D,MAAM,EAAE,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;CAC/B;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,iBAAS,aAAa,CACpB,CAAC,SAAS,UAAU,EACpB,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,EACnC,KAAK,CAAC,CAAC,SAAS,oBAAoB,EACpC,KAAK,EAAE,CAAC,YAEE,SAAS,WACR,yBAAyB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,UAa9C;AAED,eAAe,aAAa,CAAC"}

package/dist/src/decorators/attributes/EnumAttribute.js

@@ -17,7 +17,7 @@ const metadata_1 = __importDefault(require("../../metadata"));
  *
  * Usage example:
  * ```typescript
- * class Product extends BaseEntity {
+ * class Product extends TableClass {
  *   @EnumAttribute({ alias: 'SomeField', values: ["val-1", "val-2"] })
  *   public someField: "val-1" | "val-2"; // Attribute representing the union/enum types specified in `values`. In this case the only allowed values are "val-1" and "val-2"
  *
@@ -30,8 +30,7 @@ function EnumAttribute(props) {
     return function (_value, context) {
         if (context.kind === "field") {
             context.addInitializer(function () {
-                const entity = Object.getPrototypeOf(this);
-                metadata_1.default.addEntityAttribute(entity.constructor.name, {
+                metadata_1.default.addEntityAttribute(this.constructor.name, {
                     attributeName: context.name.toString(),
                     nullable: props?.nullable,
                     type: zod_1.z.enum(props.values),

package/dist/src/decorators/attributes/ForeignKeyAttribute.d.ts

@@ -14,7 +14,7 @@ import type { AttributeDecoratorContext, AttributeOptions } from "../types";
  *
  * Usage example:
  * ```typescript
- * class Order extends BaseEntity {
+ * class Order extends TableClass {
  *   @ForeignKeyAttribute({ alias: 'UserID' })
  *   public userId: ForeignKey; // Foreign key to the User entity. Cannot be optional.
  *

package/dist/src/decorators/attributes/ForeignKeyAttribute.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ForeignKeyAttribute.d.ts","sourceRoot":"","sources":["../../../../src/decorators/attributes/ForeignKeyAttribute.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,UAAU,MAAM,kBAAkB,CAAC;AAE/C,OAAO,KAAK,EAAE,UAAU,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAClE,OAAO,KAAK,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,iBAAS,mBAAmB,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,gBAAgB,EAC3E,KAAK,CAAC,EAAE,CAAC,YAGC,SAAS,WACR,0BACP,CAAC,EACD,CAAC,CAAC,UAAU,CAAC,SAAS,IAAI,GAAG,kBAAkB,GAAG,UAAU,EAC5D,CAAC,CACF,UAeJ;AAED,eAAe,mBAAmB,CAAC"}
+{"version":3,"file":"ForeignKeyAttribute.d.ts","sourceRoot":"","sources":["../../../../src/decorators/attributes/ForeignKeyAttribute.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,UAAU,MAAM,kBAAkB,CAAC;AAE/C,OAAO,KAAK,EAAE,UAAU,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAClE,OAAO,KAAK,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,iBAAS,mBAAmB,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,gBAAgB,EAC3E,KAAK,CAAC,EAAE,CAAC,YAGC,SAAS,WACR,yBAAyB,CAChC,CAAC,EACD,CAAC,CAAC,UAAU,CAAC,SAAS,IAAI,GAAG,kBAAkB,GAAG,UAAU,EAC5D,CAAC,CACF,UAaJ;AAED,eAAe,mBAAmB,CAAC"}

package/dist/src/decorators/attributes/ForeignKeyAttribute.js

@@ -18,7 +18,7 @@ const metadata_1 = __importDefault(require("../../metadata"));
  *
  * Usage example:
  * ```typescript
- * class Order extends BaseEntity {
+ * class Order extends TableClass {
  *   @ForeignKeyAttribute({ alias: 'UserID' })
  *   public userId: ForeignKey; // Foreign key to the User entity. Cannot be optional.
  *
@@ -39,8 +39,7 @@ function ForeignKeyAttribute(props) {
     return function (_value, context) {
         if (context.kind === "field") {
             context.addInitializer(function () {
-                const entity = Object.getPrototypeOf(this);
-                metadata_1.default.addEntityAttribute(entity.constructor.name, {
+                metadata_1.default.addEntityAttribute(this.constructor.name, {
                     attributeName: context.name.toString(),
                     nullable: props?.nullable,
                     type: zod_1.z.string(),

package/dist/src/decorators/attributes/IdAttribute.d.ts

@@ -0,0 +1,32 @@
+import type DynaRecord from "../../DynaRecord";
+/**
+ * An optional decorator for marking class fields as the primary identifier (ID) within the context of a single-table design entity.
+ *
+ * By default, if no IdAttribute is specified on an entity, then a uuid is generated for each entity
+ *
+ * Use this decorator to specify the field you want to use as the id for each entity. For example, if you wanted a users email to be their id.
+ *
+ * This decorator registers the decorated field as the unique identifier for the entity, ensuring proper entity identity management within the ORM.
+ *
+ * IMPORTANT! - The ID field is a required field and must be a unique identifier for each entity instance. It cannot be applied to nullable attributes
+ *
+ * @template T The entity the decorator is applied to, extending {@link DynaRecord}.
+ * @template K The type of the field being marked as the ID.
+ * @param _value This parameter is unused but required for compatibility with the class field decorator structure.
+ * @param context Provides metadata about the field being decorated, including its name and class.
+ * @returns A class field decorator function that registers the decorated field as the entity's ID within the ORM metadata system.
+ *
+ * Usage example:
+ * ```typescript
+ * class User extends TableClass {
+ *    @IdAttribute
+ *    @StringAttribute({ alias: "Email" })
+ *    public readonly email: string;
+ * }
+ * ```
+ *
+ * Here, `@IdAttribute` decorates `email` of `User` as the primary identifier, ensuring it is registered and managed as the entity's unique key.
+ */
+declare function IdAttribute<T extends DynaRecord, K extends string>(_value: undefined, context: ClassFieldDecoratorContext<T, K>): (this: T, value: K) => K;
+export default IdAttribute;
+//# sourceMappingURL=IdAttribute.d.ts.map

package/dist/src/decorators/attributes/IdAttribute.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IdAttribute.d.ts","sourceRoot":"","sources":["../../../../src/decorators/attributes/IdAttribute.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,UAAU,MAAM,kBAAkB,CAAC;AAG/C;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,iBAAS,WAAW,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,MAAM,EACzD,MAAM,EAAE,SAAS,EACjB,OAAO,EAAE,0BAA0B,CAAC,CAAC,EAAE,CAAC,CAAC,UAElB,CAAC,SAAS,CAAC,OAInC;AAED,eAAe,WAAW,CAAC"}

package/dist/src/decorators/attributes/IdAttribute.js

@@ -0,0 +1,41 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const metadata_1 = __importDefault(require("../../metadata"));
+/**
+ * An optional decorator for marking class fields as the primary identifier (ID) within the context of a single-table design entity.
+ *
+ * By default, if no IdAttribute is specified on an entity, then a uuid is generated for each entity
+ *
+ * Use this decorator to specify the field you want to use as the id for each entity. For example, if you wanted a users email to be their id.
+ *
+ * This decorator registers the decorated field as the unique identifier for the entity, ensuring proper entity identity management within the ORM.
+ *
+ * IMPORTANT! - The ID field is a required field and must be a unique identifier for each entity instance. It cannot be applied to nullable attributes
+ *
+ * @template T The entity the decorator is applied to, extending {@link DynaRecord}.
+ * @template K The type of the field being marked as the ID.
+ * @param _value This parameter is unused but required for compatibility with the class field decorator structure.
+ * @param context Provides metadata about the field being decorated, including its name and class.
+ * @returns A class field decorator function that registers the decorated field as the entity's ID within the ORM metadata system.
+ *
+ * Usage example:
+ * ```typescript
+ * class User extends TableClass {
+ *    @IdAttribute
+ *    @StringAttribute({ alias: "Email" })
+ *    public readonly email: string;
+ * }
+ * ```
+ *
+ * Here, `@IdAttribute` decorates `email` of `User` as the primary identifier, ensuring it is registered and managed as the entity's unique key.
+ */
+function IdAttribute(_value, context) {
+    return function (value) {
+        metadata_1.default.addEntityIdField(this.constructor.name, context.name.toString());
+        return value;
+    };
+}
+exports.default = IdAttribute;

package/dist/src/decorators/attributes/NumberAttribute.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NumberAttribute.d.ts","sourceRoot":"","sources":["../../../../src/decorators/attributes/NumberAttribute.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,UAAU,MAAM,kBAAkB,CAAC;AAE/C,OAAO,KAAK,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5E;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,iBAAS,eAAe,CACtB,CAAC,SAAS,UAAU,EACpB,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,gBAAgB,EAC1B,KAAK,CAAC,EAAE,CAAC,YAEC,SAAS,WACR,0BAA0B,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,UAe9C;AAED,eAAe,eAAe,CAAC"}
+{"version":3,"file":"NumberAttribute.d.ts","sourceRoot":"","sources":["../../../../src/decorators/attributes/NumberAttribute.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,UAAU,MAAM,kBAAkB,CAAC;AAE/C,OAAO,KAAK,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5E;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,iBAAS,eAAe,CACtB,CAAC,SAAS,UAAU,EACpB,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,gBAAgB,EAC1B,KAAK,CAAC,EAAE,CAAC,YAEC,SAAS,WACR,yBAAyB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,UAa9C;AAED,eAAe,eAAe,CAAC"}

package/dist/src/decorators/attributes/NumberAttribute.js

@@ -32,8 +32,7 @@ function NumberAttribute(props) {
     return function (_value, context) {
         if (context.kind === "field") {
             context.addInitializer(function () {
-                const entity = Object.getPrototypeOf(this);
-                metadata_1.default.addEntityAttribute(entity.constructor.name, {
+                metadata_1.default.addEntityAttribute(this.constructor.name, {
                     attributeName: context.name.toString(),
                     nullable: props?.nullable,
                     type: zod_1.z.number(),

package/dist/src/decorators/attributes/PartitionKeyAttribute.d.ts

@@ -11,7 +11,7 @@ import type { NonNullAttributeOptions } from "../types";
  *
  * Usage example:
  * ```typescript
- * class User extends BaseEntity {
+ * class User extends TableClass {
  *   @PartitionKeyAttribute()
  *   public pk: PartitionKey;
  * }