dyna-record 0.4.0 → 0.4.6

package/README.md

@@ -357,6 +357,25 @@ const grade: Grade = await Grade.create({
 });
 ```
 
+#### Skipping Referential Integrity Checks
+
+By default, when creating entities with foreign key references, dyna-record performs condition checks to ensure that referenced entities exist. This prevents creating entities with invalid foreign key references. However, in high-contention or high-throughput systems where the same foreign key may be referenced in parallel operations, these condition checks can fail due to transaction conflicts. In scenarios such as bulk imports or when you've already verified the references, you may want to skip these checks to prevent such failures.
+
+To skip referential integrity checks, pass an options object as the second parameter with `referentialIntegrityCheck: false`:
+
+```typescript
+const grade: Grade = await Grade.create(
+  {
+    gradeValue: "A+",
+    assignmentId: "123",
+    studentId: "456"
+  },
+  { referentialIntegrityCheck: false }
+);
+```
+
+**Note:** When `referentialIntegrityCheck` is set to `false`, the condition checks that verify foreign key references exist are skipped. This means you can create entities even if the referenced entities don't exist, which may lead to data integrity issues. Use this option with caution.
+
 #### 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).
@@ -549,6 +568,31 @@ const updatedInstance = await petInstance.update({
 });
 ```
 
+#### Skipping Referential Integrity Checks
+
+By default, when updating entities with foreign key references, dyna-record performs condition checks to ensure that referenced entities exist. This prevents updating entities with invalid foreign key references. However, in high-contention or high-throughput systems where the same foreign key may be referenced in parallel operations, these condition checks can fail due to transaction conflicts. In scenarios such as bulk updates or when you've already verified the references, you may want to skip these checks to prevent such failures.
+
+To skip referential integrity checks, pass an options object as the third parameter with `referentialIntegrityCheck: false`:
+
+```typescript
+await PaymentMethod.update(
+  "123",
+  { customerId: "456" },
+  { referentialIntegrityCheck: false }
+);
+```
+
+For instance methods:
+
+```typescript
+const updatedInstance = await paymentMethodInstance.update(
+  { customerId: "456" },
+  { referentialIntegrityCheck: false }
+);
+```
+
+**Note:** When `referentialIntegrityCheck` is set to `false`, the condition checks that verify foreign key references exist are skipped. This means you can update entities even if the referenced entities don't exist, which may lead to data integrity issues. Use this option with caution.
+
 ### Delete
 
 [Docs](https://dyna-record.com/classes/default.html#delete)

package/dist/src/DynaRecord.d.ts

@@ -1,3 +1,4 @@
+import { type TableMetadata } from "./metadata";
 import { type FindByIdOptions, type FindByIdIncludesRes, type EntityKeyConditions, type QueryResults, Create, type CreateOptions, type UpdateOptions, type EntityAttributesInstance, type IncludedAssociations, type IndexKeyConditions, type OptionsWithoutIndex, type OptionsWithIndex } from "./operations";
 import type { DynamoTableItem, EntityClass, Optional } from "./types";
 interface DynaRecordBase {
@@ -181,24 +182,36 @@ declare abstract class DynaRecord implements DynaRecordBase {
      */
     static query<T extends DynaRecord>(this: EntityClass<T>, key: IndexKeyConditions<T>, options: OptionsWithIndex): Promise<QueryResults<T>>;
     /**
-     * Create an entity. If foreign keys are included in the attributes then links will be demoralized accordingly
+     * Create an entity. If foreign keys are included in the attributes then links will be denormalized accordingly
      * @param attributes - Attributes of the model to create
+     * @param options - Optional operation options including referentialIntegrityCheck flag
      * @returns The new Entity
      *
+     * @example Basic usage
      * ```typescript
      * const newUser = await User.create({ name: "Alice", email: "alice@example.com", profileId: "123" });
      * ```
+     *
+     * @example With referential integrity check disabled
+     * ```typescript
+     * const newUser = await User.create(
+     *   { name: "Alice", email: "alice@example.com", profileId: "123" },
+     *   { referentialIntegrityCheck: false }
+     * );
+     * ```
      */
-    static create<T extends DynaRecord>(this: EntityClass<T>, attributes: CreateOptions<T>): Promise<ReturnType<Create<T>["run"]>>;
+    static create<T extends DynaRecord>(this: EntityClass<T>, attributes: CreateOptions<T>, options?: {
+        referentialIntegrityCheck?: boolean;
+    }): Promise<ReturnType<Create<T>["run"]>>;
     /**
-     * Update an entity. If foreign keys are included in the attribute then:
+     * Update an entity. If foreign keys are included in the attributes then:
      *   - 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
      * @param attributes - Attributes to update
-     *
+     * @param options - Optional operation options including referentialIntegrityCheck flag
      *
      * @example Updating an entity.
      * ```typescript
@@ -209,12 +222,22 @@ declare abstract class DynaRecord implements DynaRecordBase {
      * ```typescript
      * await User.update("userId", { email: "newemail@example.com", someKey: null });
      * ```
+     *
+     * @example With referential integrity check disabled
+     * ```typescript
+     * await User.update(
+     *   "userId",
+     *   { email: "newemail@example.com", profileId: 789 },
+     *   { referentialIntegrityCheck: false }
+     * );
+     * ```
      */
-    static update<T extends DynaRecord>(this: EntityClass<T>, id: string, attributes: UpdateOptions<T>): Promise<void>;
+    static update<T extends DynaRecord>(this: EntityClass<T>, id: string, attributes: UpdateOptions<T>, options?: {
+        referentialIntegrityCheck?: boolean;
+    }): Promise<void>;
     /**
      *  Same as the static `update` method but on an instance. Returns the full updated instance
      *
-     *
      * @example Updating an entity.
      * ```typescript
      * const updatedInstance = await instance.update({ email: "newemail@example.com", profileId: 789 });
@@ -224,8 +247,18 @@ declare abstract class DynaRecord implements DynaRecordBase {
      * ```typescript
      * const updatedInstance = await instance.update({ email: "newemail@example.com", someKey: null });
      * ```
+     *
+     * @example With referential integrity check disabled
+     * ```typescript
+     * const updatedInstance = await instance.update(
+     *   { email: "newemail@example.com", profileId: 789 },
+     *   { referentialIntegrityCheck: false }
+     * );
+     * ```
      */
-    update<T extends this>(attributes: UpdateOptions<T>): Promise<EntityAttributesInstance<T>>;
+    update<T extends this>(attributes: UpdateOptions<T>, options?: {
+        referentialIntegrityCheck?: boolean;
+    }): Promise<EntityAttributesInstance<T>>;
     /**
      * Delete an entity by ID
      *   - Delete all denormalized records
@@ -258,6 +291,20 @@ declare abstract class DynaRecord implements DynaRecordBase {
      * @returns The partition key of the entity
      */
     partitionKeyValue(): string;
+    /**
+     * Returns serialized table metadata containing only serializable values.
+     * This method returns a plain object representation of the table metadata,
+     * with functions, class instances, and other non-serializable data converted
+     * to their string representations or omitted.
+     * @returns A plain object representation of the table metadata
+     *
+     * @example
+     * ```typescript
+     * const metadata = User.metadata();
+     * // Returns a serialized object with all metadata information
+     * ```
+     */
+    static metadata(): ReturnType<TableMetadata["toJSON"]>;
 }
 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":"AAEA,OAAO,EAEL,KAAK,eAAe,EACpB,KAAK,mBAAmB,EAExB,KAAK,mBAAmB,EACxB,KAAK,YAAY,EACjB,MAAM,EACN,KAAK,aAAa,EAElB,KAAK,aAAa,EAGlB,KAAK,wBAAwB,EAC7B,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,gBAAgB,EAEtB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAE,eAAe,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAGtE,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;WAEiB,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;WAG7B,QAAQ,CAC1B,CAAC,SAAS,UAAU,EACpB,GAAG,SAAS,oBAAoB,CAAC,CAAC,CAAC,GAAG,EAAE,EAExC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,EACpB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,eAAe,CAAC,CAAC,EAAE,GAAG,CAAC,GAC/B,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAgBjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;WACiB,KAAK,CAAC,CAAC,SAAS,UAAU,EAC5C,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,EACpB,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqDG;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;;;;;;;;;;;;;;;OAeG;WACiB,KAAK,CAAC,CAAC,SAAS,UAAU,EAC5C,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,EACpB,GAAG,EAAE,kBAAkB,CAAC,CAAC,CAAC,EAC1B,OAAO,EAAE,gBAAgB,GACxB,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,wBAAwB,CAAC,CAAC,CAAC,CAAC;IAkBvC;;;;;;;;;;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;IAKnD;;OAEG;WACW,iBAAiB,CAAC,CAAC,SAAS,UAAU,EAClD,IAAI,EAAE,UAAU,CAAC,EACjB,SAAS,EAAE,eAAe,GACzB,wBAAwB,CAAC,CAAC,CAAC;IAW9B;;;OAGG;IACI,iBAAiB,IAAI,MAAM;CAGnC;AAED,eAAe,UAAU,CAAC"}
+{"version":3,"file":"DynaRecord.d.ts","sourceRoot":"","sources":["../../src/DynaRecord.ts"],"names":[],"mappings":"AAAA,OAAiB,EAAsB,KAAK,aAAa,EAAE,MAAM,YAAY,CAAC;AAE9E,OAAO,EAEL,KAAK,eAAe,EACpB,KAAK,mBAAmB,EAExB,KAAK,mBAAmB,EACxB,KAAK,YAAY,EACjB,MAAM,EACN,KAAK,aAAa,EAElB,KAAK,aAAa,EAGlB,KAAK,wBAAwB,EAC7B,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,gBAAgB,EAEtB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAE,eAAe,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAGtE,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;WAEiB,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;WAG7B,QAAQ,CAC1B,CAAC,SAAS,UAAU,EACpB,GAAG,SAAS,oBAAoB,CAAC,CAAC,CAAC,GAAG,EAAE,EAExC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,EACpB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,eAAe,CAAC,CAAC,EAAE,GAAG,CAAC,GAC/B,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAgBjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;WACiB,KAAK,CAAC,CAAC,SAAS,UAAU,EAC5C,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,EACpB,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqDG;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;;;;;;;;;;;;;;;OAeG;WACiB,KAAK,CAAC,CAAC,SAAS,UAAU,EAC5C,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,EACpB,GAAG,EAAE,kBAAkB,CAAC,CAAC,CAAC,EAC1B,OAAO,EAAE,gBAAgB,GACxB,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAW3B;;;;;;;;;;;;;;;;;;OAkBG;WACiB,MAAM,CAAC,CAAC,SAAS,UAAU,EAC7C,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,EACpB,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC,EAC5B,OAAO,CAAC,EAAE;QAAE,yBAAyB,CAAC,EAAE,OAAO,CAAA;KAAE,GAChD,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IAKxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;WACiB,MAAM,CAAC,CAAC,SAAS,UAAU,EAC7C,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,EACpB,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC,EAC5B,OAAO,CAAC,EAAE;QAAE,yBAAyB,CAAC,EAAE,OAAO,CAAA;KAAE,GAChD,OAAO,CAAC,IAAI,CAAC;IAKhB;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,MAAM,CAAC,CAAC,SAAS,IAAI,EAChC,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC,EAC5B,OAAO,CAAC,EAAE;QAAE,yBAAyB,CAAC,EAAE,OAAO,CAAA;KAAE,GAChD,OAAO,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC;IAkBvC;;;;;;;;;;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;IAKnD;;OAEG;WACW,iBAAiB,CAAC,CAAC,SAAS,UAAU,EAClD,IAAI,EAAE,UAAU,CAAC,EACjB,SAAS,EAAE,eAAe,GACzB,wBAAwB,CAAC,CAAC,CAAC;IAW9B;;;OAGG;IACI,iBAAiB,IAAI,MAAM;IAIlC;;;;;;;;;;;;OAYG;WACW,QAAQ,IAAI,UAAU,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;CAK9D;AAED,eAAe,UAAU,CAAC"}

package/dist/src/DynaRecord.js

@@ -145,27 +145,37 @@ let DynaRecord = (() => {
             return await op.run(key, options);
         }
         /**
-         * Create an entity. If foreign keys are included in the attributes then links will be demoralized accordingly
+         * Create an entity. If foreign keys are included in the attributes then links will be denormalized accordingly
          * @param attributes - Attributes of the model to create
+         * @param options - Optional operation options including referentialIntegrityCheck flag
          * @returns The new Entity
          *
+         * @example Basic usage
          * ```typescript
          * const newUser = await User.create({ name: "Alice", email: "alice@example.com", profileId: "123" });
          * ```
+         *
+         * @example With referential integrity check disabled
+         * ```typescript
+         * const newUser = await User.create(
+         *   { name: "Alice", email: "alice@example.com", profileId: "123" },
+         *   { referentialIntegrityCheck: false }
+         * );
+         * ```
          */
-        static async create(attributes) {
+        static async create(attributes, options) {
             const op = new operations_1.Create(this);
-            return await op.run(attributes);
+            return await op.run(attributes, options);
         }
         /**
-         * Update an entity. If foreign keys are included in the attribute then:
+         * Update an entity. If foreign keys are included in the attributes then:
          *   - 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
          * @param attributes - Attributes to update
-         *
+         * @param options - Optional operation options including referentialIntegrityCheck flag
          *
          * @example Updating an entity.
          * ```typescript
@@ -176,15 +186,23 @@ let DynaRecord = (() => {
          * ```typescript
          * await User.update("userId", { email: "newemail@example.com", someKey: null });
          * ```
+         *
+         * @example With referential integrity check disabled
+         * ```typescript
+         * await User.update(
+         *   "userId",
+         *   { email: "newemail@example.com", profileId: 789 },
+         *   { referentialIntegrityCheck: false }
+         * );
+         * ```
          */
-        static async update(id, attributes) {
+        static async update(id, attributes, options) {
             const op = new operations_1.Update(this);
-            await op.run(id, attributes);
+            await op.run(id, attributes, options);
         }
         /**
          *  Same as the static `update` method but on an instance. Returns the full updated instance
          *
-         *
          * @example Updating an entity.
          * ```typescript
          * const updatedInstance = await instance.update({ email: "newemail@example.com", profileId: 789 });
@@ -194,11 +212,19 @@ let DynaRecord = (() => {
          * ```typescript
          * const updatedInstance = await instance.update({ email: "newemail@example.com", someKey: null });
          * ```
+         *
+         * @example With referential integrity check disabled
+         * ```typescript
+         * const updatedInstance = await instance.update(
+         *   { email: "newemail@example.com", profileId: 789 },
+         *   { referentialIntegrityCheck: false }
+         * );
+         * ```
          */
-        async update(attributes) {
+        async update(attributes, options) {
             const InstanceClass = this.constructor;
             const op = new operations_1.Update(InstanceClass);
-            const updatedAttributes = await op.run(this.id, attributes);
+            const updatedAttributes = await op.run(this.id, attributes, options);
             const clone = structuredClone(this);
             // Update the current instance with new attributes
             Object.assign(clone, updatedAttributes);
@@ -253,6 +279,24 @@ let DynaRecord = (() => {
         partitionKeyValue() {
             return this.constructor.partitionKeyValue(this.id);
         }
+        /**
+         * Returns serialized table metadata containing only serializable values.
+         * This method returns a plain object representation of the table metadata,
+         * with functions, class instances, and other non-serializable data converted
+         * to their string representations or omitted.
+         * @returns A plain object representation of the table metadata
+         *
+         * @example
+         * ```typescript
+         * const metadata = User.metadata();
+         * // Returns a serialized object with all metadata information
+         * ```
+         */
+        static metadata() {
+            const tableMetadata = metadata_1.default.getTable(this.name);
+            const entities = metadata_1.default.getEntitiesForTable(this.name);
+            return tableMetadata.toJSON(entities);
+        }
         constructor() {
             __runInitializers(this, _updatedAt_extraInitializers);
         }

package/dist/src/metadata/MetadataStorage.d.ts

@@ -4,7 +4,7 @@ import TableMetadata from "./TableMetadata";
 import EntityMetadata from "./EntityMetadata";
 import JoinTableMetadata from "./JoinTableMetadata";
 import type { RelationshipMetadata } from "./relationship-metadata";
-import type { AttributeMetadataStorage, TableMetadataOptions, AttributeMetadataOptions } from "./types";
+import type { AttributeMetadataStorage, EntityMetadataStorage, TableMetadataOptions, AttributeMetadataOptions } from "./types";
 /**
  * Central storage for managing and accessing all metadata related to entities, attributes, relationships, and tables within the ORM.
  * It provides methods for retrieving and adding metadata for entities and their corresponding tables, handling relationships
@@ -36,6 +36,12 @@ declare class MetadataStorage {
      * @returns joinTableName metadata
      */
     getJoinTable(joinTableName: string): JoinTableMetadata[];
+    /**
+     * Returns all entities that belong to a specific table
+     * @param {string} tableClassName - Name of the table class
+     * @returns Record of entity metadata keyed by entity class name
+     */
+    getEntitiesForTable(tableClassName: string): EntityMetadataStorage;
     /**
      * Returns attribute metadata for attributes defined keyed by entity key
      * @returns - {@link AttributeMetadataStorage}

package/dist/src/metadata/MetadataStorage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MetadataStorage.d.ts","sourceRoot":"","sources":["../../../src/metadata/MetadataStorage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,UAAU,MAAM,eAAe,CAAC;AAC5C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAC5C,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAE9C,OAAO,iBAAiB,MAAM,qBAAqB,CAAC;AAEpD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AACpE,OAAO,KAAK,EACV,wBAAwB,EAIxB,oBAAoB,EAEpB,wBAAwB,EACzB,MAAM,SAAS,CAAC;AAEjB;;;;GAIG;AACH,cAAM,eAAe;;IAOnB;;;;OAIG;IACI,SAAS,CAAC,UAAU,EAAE,MAAM,GAAG,cAAc;IAKpD;;;;OAIG;IACI,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,aAAa;IAKjD;;;;OAIG;IACI,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,aAAa;IAMxD;;;;OAIG;IACI,YAAY,CAAC,aAAa,EAAE,MAAM,GAAG,iBAAiB,EAAE;IAK/D;;;OAGG;IACI,mBAAmB,CAAC,UAAU,EAAE,MAAM,GAAG,wBAAwB;IAYxE;;;;OAIG;IACI,wBAAwB,CAC7B,UAAU,EAAE,MAAM,GACjB,wBAAwB;IAY3B;;;;OAIG;IACI,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,EAAE,oBAAoB,GAAG,IAAI;IAI5E;;;;OAIG;IACI,SAAS,CACd,WAAW,EAAE,cAAc,CAAC,aAAa,CAAC,EAC1C,cAAc,EAAE,MAAM,GACrB,IAAI;IAOP;;;;OAIG;IACI,qBAAqB,CAC1B,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,oBAAoB,GAC5B,IAAI;IAQP;;;;OAIG;IACI,YAAY,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,GAAG,IAAI;IAa5E;;;;OAIG;IACI,kBAAkB,CACvB,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,YAAY,CAAC,wBAAwB,EAAE,OAAO,CAAC,GACvD,IAAI;IAYP;;;;OAIG;IACI,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKpE;;;;OAIG;IACI,wBAAwB,CAC7B,WAAW,EAAE,UAAU,EACvB,OAAO,EAAE,UAAU,CAAC,aAAa,CAAC,0BAA0B,CAAC,CAAC,CAAC,MAAM,CAAC,GACrE,IAAI;IAQP;;;;OAIG;IACI,mBAAmB,CACxB,WAAW,EAAE,UAAU,EACvB,OAAO,EAAE,UAAU,CAAC,aAAa,CAAC,0BAA0B,CAAC,CAAC,CAAC,MAAM,CAAC,GACrE,IAAI;IAQP;;OAEG;IACH,OAAO,CAAC,IAAI;IAUZ;;;;OAIG;IACH,OAAO,CAAC,sBAAsB;CAa/B;AAED,eAAe,eAAe,CAAC"}
+{"version":3,"file":"MetadataStorage.d.ts","sourceRoot":"","sources":["../../../src/metadata/MetadataStorage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,UAAU,MAAM,eAAe,CAAC;AAC5C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAC5C,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAE9C,OAAO,iBAAiB,MAAM,qBAAqB,CAAC;AAEpD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AACpE,OAAO,KAAK,EACV,wBAAwB,EAExB,qBAAqB,EAErB,oBAAoB,EAEpB,wBAAwB,EACzB,MAAM,SAAS,CAAC;AAEjB;;;;GAIG;AACH,cAAM,eAAe;;IAOnB;;;;OAIG;IACI,SAAS,CAAC,UAAU,EAAE,MAAM,GAAG,cAAc;IAKpD;;;;OAIG;IACI,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,aAAa;IAKjD;;;;OAIG;IACI,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,aAAa;IAMxD;;;;OAIG;IACI,YAAY,CAAC,aAAa,EAAE,MAAM,GAAG,iBAAiB,EAAE;IAK/D;;;;OAIG;IACI,mBAAmB,CAAC,cAAc,EAAE,MAAM,GAAG,qBAAqB;IAWzE;;;OAGG;IACI,mBAAmB,CAAC,UAAU,EAAE,MAAM,GAAG,wBAAwB;IAYxE;;;;OAIG;IACI,wBAAwB,CAC7B,UAAU,EAAE,MAAM,GACjB,wBAAwB;IAY3B;;;;OAIG;IACI,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,EAAE,oBAAoB,GAAG,IAAI;IAI5E;;;;OAIG;IACI,SAAS,CACd,WAAW,EAAE,cAAc,CAAC,aAAa,CAAC,EAC1C,cAAc,EAAE,MAAM,GACrB,IAAI;IAOP;;;;OAIG;IACI,qBAAqB,CAC1B,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,oBAAoB,GAC5B,IAAI;IAQP;;;;OAIG;IACI,YAAY,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,GAAG,IAAI;IAa5E;;;;OAIG;IACI,kBAAkB,CACvB,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,YAAY,CAAC,wBAAwB,EAAE,OAAO,CAAC,GACvD,IAAI;IAYP;;;;OAIG;IACI,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKpE;;;;OAIG;IACI,wBAAwB,CAC7B,WAAW,EAAE,UAAU,EACvB,OAAO,EAAE,UAAU,CAAC,aAAa,CAAC,0BAA0B,CAAC,CAAC,CAAC,MAAM,CAAC,GACrE,IAAI;IAQP;;;;OAIG;IACI,mBAAmB,CACxB,WAAW,EAAE,UAAU,EACvB,OAAO,EAAE,UAAU,CAAC,aAAa,CAAC,0BAA0B,CAAC,CAAC,CAAC,MAAM,CAAC,GACrE,IAAI;IAQP;;OAEG;IACH,OAAO,CAAC,IAAI;IAUZ;;;;OAIG;IACH,OAAO,CAAC,sBAAsB;CAa/B;AAED,eAAe,eAAe,CAAC"}

package/dist/src/metadata/MetadataStorage.js

@@ -55,6 +55,21 @@ class MetadataStorage {
         this.init();
         return this.#joinTables[joinTableName];
     }
+    /**
+     * Returns all entities that belong to a specific table
+     * @param {string} tableClassName - Name of the table class
+     * @returns Record of entity metadata keyed by entity class name
+     */
+    getEntitiesForTable(tableClassName) {
+        this.init();
+        const entities = {};
+        for (const [entityName, entityMetadata] of Object.entries(this.#entities)) {
+            if (entityMetadata.tableClassName === tableClassName) {
+                entities[entityName] = entityMetadata;
+            }
+        }
+        return entities;
+    }
     /**
      * Returns attribute metadata for attributes defined keyed by entity key
      * @returns - {@link AttributeMetadataStorage}

package/dist/src/metadata/TableMetadata.d.ts

@@ -1,5 +1,6 @@
 import { AttributeMetadata } from ".";
-import type { TableMetadataOptions, DefaultFields, KeysAttributeMetadataOptions } from "./types";
+import type { TableMetadataOptions, DefaultFields, KeysAttributeMetadataOptions, EntityMetadataStorage } from "./types";
+import { type SerializedTableMetadata } from "./schemas";
 export declare const defaultTableKeys: {
     readonly partitionKey: "PK";
     readonly sortKey: "SK";
@@ -66,6 +67,13 @@ declare class TableMetadata {
      * @param options
      */
     addSortKeyAttribute(options: KeysAttributeMetadataOptions): void;
+    /**
+     * Serializes the table metadata to a plain object containing only serializable values.
+     * This removes functions, Zod types, serializers, and other non-serializable data.
+     * @param {EntityMetadataStorage} entities - Entities that belong to this table, keyed by entity class name
+     * @returns A plain object representation of the metadata
+     */
+    toJSON(entities: EntityMetadataStorage): SerializedTableMetadata;
 }
 export default TableMetadata;
 //# sourceMappingURL=TableMetadata.d.ts.map

package/dist/src/metadata/TableMetadata.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TableMetadata.d.ts","sourceRoot":"","sources":["../../../src/metadata/TableMetadata.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,GAAG,CAAC;AAEtC,OAAO,KAAK,EACV,oBAAoB,EACpB,aAAa,EAGb,4BAA4B,EAC7B,MAAM,SAAS,CAAC;AAEjB,eAAO,MAAM,gBAAgB;;;CAAiD,CAAC;AAE/E;;GAEG;AACH,eAAO,MAAM,kBAAkB,EAAE,MAAM,CACrC,aAAa,EACb;IAAE,KAAK,EAAE,aAAa,CAAA;CAAE,CAMhB,CAAC;AAEX;;;;;;;;;;;;;GAaG;AACH,cAAM,aAAa;IACjB,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,SAAS,EAAE,MAAM,CAAC;IAClC,SAAgB,iBAAiB,EAAE,MAAM,CAAC,aAAa,EAAE,iBAAiB,CAAC,CAAC;IAC5E,SAAgB,sBAAsB,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IACnE,qBAAqB,EAAE,iBAAiB,CAAC;IACzC,gBAAgB,EAAE,iBAAiB,CAAC;IAE3C;;;;;;;;;;;;;;;;OAgBG;IACI,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;gBAE9B,OAAO,EAAE,oBAAoB;IA4BzC;;;;OAIG;IACH,OAAO,CAAC,8BAA8B;IAgCtC;;;OAGG;IACI,wBAAwB,CAAC,OAAO,EAAE,4BAA4B,GAAG,IAAI;IAO5E;;;OAGG;IACI,mBAAmB,CAAC,OAAO,EAAE,4BAA4B,GAAG,IAAI;CAMxE;AAED,eAAe,aAAa,CAAC"}
+{"version":3,"file":"TableMetadata.d.ts","sourceRoot":"","sources":["../../../src/metadata/TableMetadata.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,GAAG,CAAC;AAEtC,OAAO,KAAK,EACV,oBAAoB,EACpB,aAAa,EAGb,4BAA4B,EAC5B,qBAAqB,EACtB,MAAM,SAAS,CAAC;AACjB,OAAO,EACL,KAAK,uBAAuB,EAE7B,MAAM,WAAW,CAAC;AAEnB,eAAO,MAAM,gBAAgB;;;CAAiD,CAAC;AAE/E;;GAEG;AACH,eAAO,MAAM,kBAAkB,EAAE,MAAM,CACrC,aAAa,EACb;IAAE,KAAK,EAAE,aAAa,CAAA;CAAE,CAMhB,CAAC;AAEX;;;;;;;;;;;;;GAaG;AACH,cAAM,aAAa;IACjB,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,SAAS,EAAE,MAAM,CAAC;IAClC,SAAgB,iBAAiB,EAAE,MAAM,CAAC,aAAa,EAAE,iBAAiB,CAAC,CAAC;IAC5E,SAAgB,sBAAsB,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IACnE,qBAAqB,EAAE,iBAAiB,CAAC;IACzC,gBAAgB,EAAE,iBAAiB,CAAC;IAE3C;;;;;;;;;;;;;;;;OAgBG;IACI,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;gBAE9B,OAAO,EAAE,oBAAoB;IA4BzC;;;;OAIG;IACH,OAAO,CAAC,8BAA8B;IAgCtC;;;OAGG;IACI,wBAAwB,CAAC,OAAO,EAAE,4BAA4B,GAAG,IAAI;IAO5E;;;OAGG;IACI,mBAAmB,CAAC,OAAO,EAAE,4BAA4B,GAAG,IAAI;IAOvE;;;;;OAKG;IACI,MAAM,CAAC,QAAQ,EAAE,qBAAqB,GAAG,uBAAuB;CAMxE;AAED,eAAe,aAAa,CAAC"}

package/dist/src/metadata/TableMetadata.js

@@ -4,6 +4,7 @@ exports.tableDefaultFields = exports.defaultTableKeys = void 0;
 const zod_1 = require("zod");
 const _1 = require(".");
 const decorators_1 = require("../decorators");
+const schemas_1 = require("./schemas");
 exports.defaultTableKeys = { partitionKey: "PK", sortKey: "SK" };
 /**
  * Default fields with default table alias. Can be overwritten through {@link TableMetadataOptions} defaultFields
@@ -121,5 +122,17 @@ class TableMetadata {
         // Set the user defined primary key as reserved key so that its managed by dyna-record
         this.reservedKeys[options.attributeName] = true;
     }
+    /**
+     * Serializes the table metadata to a plain object containing only serializable values.
+     * This removes functions, Zod types, serializers, and other non-serializable data.
+     * @param {EntityMetadataStorage} entities - Entities that belong to this table, keyed by entity class name
+     * @returns A plain object representation of the metadata
+     */
+    toJSON(entities) {
+        return schemas_1.TableMetadataTransform.parse({
+            ...this,
+            entities
+        });
+    }
 }
 exports.default = TableMetadata;