dyna-record 0.0.2 → 0.0.4

package/README.md

@@ -3,4 +3,4 @@
 Typescript Object Relational Mapper (ORM) for Dynamo
 
 Domain moving soon. More documentation to come soon as well
-[Documentation Site](https://dsdavis4.github.io/dyna-record/)
+[Documentation Site](https://dyna-record.com/)

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

@@ -4,6 +4,8 @@ import type { AttributeOptions } from "../types";
 /**
  * A decorator for annotating class fields as foreign keys within the context of a single-table design entity, aimed at establishing and managing relationships between different entities in a relational manner. This decorator enables the clear and explicit declaration of foreign key relationships, contributing to the ORM's ability to navigate and resolve these associations efficiently.
  *
+ * The entity can belong to its associated entity has a {@link HasOne} or {@link HasMany}
+ *
  * Does not allow property to be optional.
  *
  * @template T The entity the decorator is applied to.
@@ -14,7 +16,10 @@ import type { AttributeOptions } from "../types";
  * ```typescript
  * class Order extends BaseEntity {
  *   @ForeignKeyAttribute({ alias: 'UserID' })
- *   public userId: string; // Foreign key to the User entity
+ *   public userId: ForeignKey; // Foreign key to the User entity. Cannot be optional. See {@link NullableForeignKeyAttribute} if it is nullable
+ *
+ *   @BelongsTo(() => User, { foreignKey: "userId" })
+ *   public readonly user: User; // 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":"AAAA,OAAO,KAAK,UAAU,MAAM,kBAAkB,CAAC;AAE/C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAEjD;;;;;;;;;;;;;;;;;;GAkBG;AACH,iBAAS,mBAAmB,CAAC,CAAC,SAAS,UAAU,EAAE,KAAK,CAAC,EAAE,gBAAgB,YAE/D,SAAS,WACR,2BAA2B,CAAC,EAAE,UAAU,CAAC,UAcrD;AAED,eAAe,mBAAmB,CAAC"}
+{"version":3,"file":"ForeignKeyAttribute.d.ts","sourceRoot":"","sources":["../../../../src/decorators/attributes/ForeignKeyAttribute.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,UAAU,MAAM,kBAAkB,CAAC;AAE/C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAEjD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,iBAAS,mBAAmB,CAAC,CAAC,SAAS,UAAU,EAAE,KAAK,CAAC,EAAE,gBAAgB,YAE/D,SAAS,WACR,2BAA2B,CAAC,EAAE,UAAU,CAAC,UAcrD;AAED,eAAe,mBAAmB,CAAC"}

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

@@ -7,6 +7,8 @@ const metadata_1 = __importDefault(require("../../metadata"));
 /**
  * A decorator for annotating class fields as foreign keys within the context of a single-table design entity, aimed at establishing and managing relationships between different entities in a relational manner. This decorator enables the clear and explicit declaration of foreign key relationships, contributing to the ORM's ability to navigate and resolve these associations efficiently.
  *
+ * The entity can belong to its associated entity has a {@link HasOne} or {@link HasMany}
+ *
  * Does not allow property to be optional.
  *
  * @template T The entity the decorator is applied to.
@@ -17,7 +19,10 @@ const metadata_1 = __importDefault(require("../../metadata"));
  * ```typescript
  * class Order extends BaseEntity {
  *   @ForeignKeyAttribute({ alias: 'UserID' })
- *   public userId: string; // Foreign key to the User entity
+ *   public userId: ForeignKey; // Foreign key to the User entity. Cannot be optional. See {@link NullableForeignKeyAttribute} if it is nullable
+ *
+ *   @BelongsTo(() => User, { foreignKey: "userId" })
+ *   public readonly user: User; // Cannot be optional
  * }
  * ```
  *

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

@@ -6,6 +6,8 @@ import type { AttributeOptions } from "../types";
  *
  * IMPORTANT - For optimal type safety mark the class field property as optional
  *
+ * The entity can belong to its associated entity has a {@link HasOne} or {@link HasMany}
+ *
  * @template T The entity the decorator is applied to.
  * @param props An optional object of {@link AttributeOptions}, including configuration options such as metadata attributes.
  * @returns A class field decorator function that targets and initializes the class's prototype to register the field with the ORM's metadata system.
@@ -14,7 +16,10 @@ import type { AttributeOptions } from "../types";
  * ```typescript
  * class User extends BaseEntity {
  *   @NullableForeignKeyAttribute({ alias: 'ProfileId' })
- *   public profileId?: string; // Set to optional. Nullable foreign key to another entity (e.g., UserProfile)
+ *   public profileId?: NullableForeignKey; // Set to optional. Nullable foreign key to another entity (e.g., UserProfile)
+ *
+ *   @BelongsTo(() => Profile, { foreignKey: "profileId" })
+ *   public readonly profile?: Profile; // Set to optional because its linked via a NullableForeignKey
  * }
  * ```
  *

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

@@ -1 +1 @@
-{"version":3,"file":"NullableForeignKeyAttribute.d.ts","sourceRoot":"","sources":["../../../../src/decorators/attributes/NullableForeignKeyAttribute.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,UAAU,MAAM,kBAAkB,CAAC;AAE/C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAEjD;;;;;;;;;;;;;;;;;;GAkBG;AACH,iBAAS,2BAA2B,CAAC,CAAC,SAAS,UAAU,EACvD,KAAK,CAAC,EAAE,gBAAgB,YAGd,SAAS,WACR,2BAA2B,CAAC,EAAE,kBAAkB,CAAC,UAc7D;AAED,eAAe,2BAA2B,CAAC"}
+{"version":3,"file":"NullableForeignKeyAttribute.d.ts","sourceRoot":"","sources":["../../../../src/decorators/attributes/NullableForeignKeyAttribute.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,UAAU,MAAM,kBAAkB,CAAC;AAE/C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAEjD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,iBAAS,2BAA2B,CAAC,CAAC,SAAS,UAAU,EACvD,KAAK,CAAC,EAAE,gBAAgB,YAGd,SAAS,WACR,2BAA2B,CAAC,EAAE,kBAAkB,CAAC,UAc7D;AAED,eAAe,2BAA2B,CAAC"}

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

@@ -9,6 +9,8 @@ const metadata_1 = __importDefault(require("../../metadata"));
  *
  * IMPORTANT - For optimal type safety mark the class field property as optional
  *
+ * The entity can belong to its associated entity has a {@link HasOne} or {@link HasMany}
+ *
  * @template T The entity the decorator is applied to.
  * @param props An optional object of {@link AttributeOptions}, including configuration options such as metadata attributes.
  * @returns A class field decorator function that targets and initializes the class's prototype to register the field with the ORM's metadata system.
@@ -17,7 +19,10 @@ const metadata_1 = __importDefault(require("../../metadata"));
  * ```typescript
  * class User extends BaseEntity {
  *   @NullableForeignKeyAttribute({ alias: 'ProfileId' })
- *   public profileId?: string; // Set to optional. Nullable foreign key to another entity (e.g., UserProfile)
+ *   public profileId?: NullableForeignKey; // Set to optional. Nullable foreign key to another entity (e.g., UserProfile)
+ *
+ *   @BelongsTo(() => Profile, { foreignKey: "profileId" })
+ *   public readonly profile?: Profile; // Set to optional because its linked via a NullableForeignKey
  * }
  * ```
  *

package/dist/src/decorators/relationships/HasAndBelongsToMany.d.ts

@@ -68,12 +68,12 @@ interface HasAndBelongsToManyProps<T extends DynaRecord, K extends DynaRecord, J
  *   public users: User[];
  * }
  *
- * class AuthorBook extends JoinTable<User, Group> {
+ * class UserGroup extends JoinTable<User, Group> {
  *    public readonly userId: ForeignKey;
  *    public readonly groupId: ForeignKey;
  * }
  * ```
- * In this example, `User` entities are related to `Group` entities through a many-to-many relationship, with `UserGroupJoin` serving as the join table. The decorator indicates this relationship, allowing for efficient querying and manipulation of related entities.
+ * In this example, `User` entities are related to `Group` entities through a many-to-many relationship, with `UserGroup` serving as the join table. The decorator indicates this relationship, allowing for efficient querying and manipulation of related entities.
  */
 declare function HasAndBelongsToMany<T extends DynaRecord, K extends DynaRecord, J extends JoinTable<T, K>, L extends JoinTable<K, T>>(getTarget: () => EntityClass<T>, props: HasAndBelongsToManyProps<T, K, J, L>): (_value: undefined, context: ClassFieldDecoratorContext<K, T[]>) => void;
 export default HasAndBelongsToMany;

package/dist/src/decorators/relationships/HasAndBelongsToMany.js

@@ -39,12 +39,12 @@ const metadata_1 = __importDefault(require("../../metadata"));
  *   public users: User[];
  * }
  *
- * class AuthorBook extends JoinTable<User, Group> {
+ * class UserGroup extends JoinTable<User, Group> {
  *    public readonly userId: ForeignKey;
  *    public readonly groupId: ForeignKey;
  * }
  * ```
- * In this example, `User` entities are related to `Group` entities through a many-to-many relationship, with `UserGroupJoin` serving as the join table. The decorator indicates this relationship, allowing for efficient querying and manipulation of related entities.
+ * In this example, `User` entities are related to `Group` entities through a many-to-many relationship, with `UserGroup` serving as the join table. The decorator indicates this relationship, allowing for efficient querying and manipulation of related entities.
  */
 function HasAndBelongsToMany(getTarget, props) {
     return (_value, context) => {

package/package.json

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