Merge pull request #47 from dsdavis4/create_return_type_fix

Create return type fix

package.json

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

src/DynaRecord.ts

@@ -224,7 +224,7 @@ abstract class DynaRecord implements DynaRecordBase {
   public static async create<T extends DynaRecord>(
     this: EntityClass<T>,
     attributes: CreateOptions<T>
-  ): Promise<T> {
+  ): Promise<ReturnType<Create<T>["run"]>> {
     const op = new Create<T>(this);
     return await op.run(attributes);
   }

src/operations/Create/Create.ts

@@ -6,6 +6,7 @@ import { entityToTableItem, tableItemToEntity } from "../../utils";
 import OperationBase from "../OperationBase";
 import { RelationshipTransactions } from "../utils";
 import type { CreateOptions } from "./types";
+import { type EntityAttributes } from "../types";
 
 /**
  * Represents the operation for creating a new entity in the database, including handling its attributes and any related entities' associations. It will handle de-normalizing data to support relationships
@@ -27,7 +28,7 @@ class Create<T extends DynaRecord> extends OperationBase<T> {
    * @param attributes
    * @returns
    */
-  public async run(attributes: CreateOptions<T>): Promise<T> {
+  public async run(attributes: CreateOptions<T>): Promise<EntityAttributes<T>> {
     const entityData = this.buildEntityData(attributes);
 
     const tableItem = entityToTableItem(this.EntityClass, entityData);

tests/integration/Create.test.ts

@@ -815,5 +815,15 @@ describe("Create", () => {
         myAttribute: null
       });
     });
+
+    it("relationships are not part of return value", async () => {
+      const res = await Order.create({
+        // @ts-expect-error default fields are not accepted on create, they are managed by dyna-record
+        createdAt: new Date()
+      });
+
+      // @ts-expect-error relationships are not part of return value
+      console.log(res.paymentMethod);
+    });
   });
 });