dyna-record 0.0.1

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

@@ -0,0 +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"}

package/dist/src/decorators/Table.js

@@ -0,0 +1,31 @@
+"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"));
+/**
+ * A class decorator for defining and customizing the table metadata associated with an entity class within the ORM system. This decorator enriches the entity with additional metadata, specifying how the entity relates to the underlying database table. By providing custom table options, such as table names or schema definitions, this decorator plays a crucial role in bridging the gap between the ORM's abstract entities and their concrete database representations.
+ *
+ * IMPORTANT - All entity classes should extend a table
+ *
+ * @param props The {@link TableMetadataOptions} object containing metadata configuration for the table. This can include options like the table's name, delimiter and default field customizations.
+ * @returns A class decorator factory function that takes a target class extending `DynaRecord` and a context object provided by the TypeScript runtime. The decorator function registers the provided metadata options with the ORM's metadata system, ensuring the entity is properly configured and recognized by the ORM.
+ *
+ * Usage example:
+ * ```typescript
+ * @Table({ name: 'my-table', delimiter: '"#",' })
+ * class MyTable extends DynaRecord {
+ *   // User entity implementation
+ * }
+ * ```
+ * In this example, the `@Table` decorator is applied to the `User` class, specifying custom table metadata options, including the table name (`users`) and the schema (`public`). These options are registered with the ORM, which then uses them to correctly map the `User` entity to the corresponding table in the database. This mapping is critical for executing ORM operations such as querying, inserting, and updating records in the `users` table.
+ */
+function Table(props) {
+    return function (target, context) {
+        if (context.kind === "class") {
+            metadata_1.default.addTable(target.name, props);
+        }
+    };
+}
+exports.default = Table;

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

@@ -0,0 +1,26 @@
+import type DynaRecord from "../../DynaRecord";
+import type { AttributeOptions, NotForeignKey } from "../types";
+import { type NativeScalarAttributeValue } from "@aws-sdk/util-dynamodb";
+/**
+ * A decorator for marking class fields as attributes within the context of a single-table design entity, with a specific restriction against using foreign key types.
+ *
+ * IMPORTANT! - This decorator explicitly disallows the use of {@link ForeignKey} and {@link NullableForeignKey} types to maintain clear separation between entity relationships and scalar attributes for improved data integrity and type safety.
+ *
+ * @template T The entity the decorator is applied to.
+ * @template K The type of the attribute, restricted to native scalar attribute values and excluding foreign key types.
+ * @param props An optional object of {@link AttributeOptions}, including configuration options such as metadata attributes and additional property characteristics.
+ * @returns A class field decorator function that targets and initializes the class's prototype to register the attribute with the ORM's metadata system, ensuring proper handling and validation of the entity's scalar values.
+ *
+ * Usage example:
+ * ```typescript
+ * class Product extends BaseEntity {
+ *   @Attribute({ alias: 'SKU' })
+ *   public stockKeepingUnit: string; // Simple scalar attribute representing the product's SKU
+ * }
+ * ```
+ *
+ * Here, `@Attribute` decorates `stockKeepingUnit` of `Product` as a simple, non-foreign key attribute, facilitating its management within the ORM system.
+ */
+declare function Attribute<T extends DynaRecord, K extends NativeScalarAttributeValue>(props?: AttributeOptions): (_value: undefined, context: ClassFieldDecoratorContext<T, NotForeignKey<K>>) => void;
+export default Attribute;
+//# sourceMappingURL=Attribute.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Attribute.d.ts","sourceRoot":"","sources":["../../../../src/decorators/attributes/Attribute.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,UAAU,MAAM,kBAAkB,CAAC;AAE/C,OAAO,KAAK,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAChE,OAAO,EAAE,KAAK,0BAA0B,EAAE,MAAM,wBAAwB,CAAC;AAEzE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,iBAAS,SAAS,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,0BAA0B,EAC3E,KAAK,CAAC,EAAE,gBAAgB,YAGd,SAAS,WACR,2BAA2B,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,UAc3D;AAED,eAAe,SAAS,CAAC"}

package/dist/src/decorators/attributes/Attribute.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"));
+/**
+ * A decorator for marking class fields as attributes within the context of a single-table design entity, with a specific restriction against using foreign key types.
+ *
+ * IMPORTANT! - This decorator explicitly disallows the use of {@link ForeignKey} and {@link NullableForeignKey} types to maintain clear separation between entity relationships and scalar attributes for improved data integrity and type safety.
+ *
+ * @template T The entity the decorator is applied to.
+ * @template K The type of the attribute, restricted to native scalar attribute values and excluding foreign key types.
+ * @param props An optional object of {@link AttributeOptions}, including configuration options such as metadata attributes and additional property characteristics.
+ * @returns A class field decorator function that targets and initializes the class's prototype to register the attribute with the ORM's metadata system, ensuring proper handling and validation of the entity's scalar values.
+ *
+ * Usage example:
+ * ```typescript
+ * class Product extends BaseEntity {
+ *   @Attribute({ alias: 'SKU' })
+ *   public stockKeepingUnit: string; // Simple scalar attribute representing the product's SKU
+ * }
+ * ```
+ *
+ * Here, `@Attribute` decorates `stockKeepingUnit` of `Product` as a simple, non-foreign key attribute, facilitating its management within the ORM system.
+ */
+function Attribute(props) {
+    return function (_value, context) {
+        if (context.kind === "field") {
+            context.addInitializer(function () {
+                const entity = Object.getPrototypeOf(this);
+                metadata_1.default.addEntityAttribute(entity.constructor.name, {
+                    attributeName: context.name.toString(),
+                    nullable: false,
+                    ...props
+                });
+            });
+        }
+    };
+}
+exports.default = Attribute;

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

@@ -0,0 +1,25 @@
+import type DynaRecord from "../../DynaRecord";
+import type { AttributeOptions } from "../types";
+/**
+ * Similar to '@Attribute' but specific to Dates since Dates are not native types to dynamo
+ *
+ * Does not allow property to be optional.
+ *
+ * @template T The class type that the decorator is applied to, ensuring type safety and integration within specific class instances.
+ * @template K A type constraint extending `Date`, ensuring that the decorator is only applied to class fields specifically intended to represent dates.
+ * @param props An {@link AttributeOptions} object providing configuration options for the attribute, such as its `alias` which allows the attribute to be referred to by an alternative name in the database context. The `nullable` property is also set to `false` by default; the attribute must not be empty.
+ * @returns A class field decorator function that operates within the class field's context. It configures the field as a date attribute and defines how it should be serialized and deserialized to/from DynamoDB.
+ *
+ * Usage example:
+ * ```typescript
+ * class MyEntity extends MyTable {
+ *   @DateAttribute({ alias: 'MyField' })
+ *   public myField: Date;
+ * }
+ * ```
+ *
+ * Here, `@Attribute` decorates `myField` of `MyEntity`, marking it as an entity attribute with an alias 'MyField' for ORM purposes.
+ */
+declare function DateAttribute<T extends DynaRecord, K extends Date>(props?: AttributeOptions): (_value: undefined, context: ClassFieldDecoratorContext<T, K>) => void;
+export default DateAttribute;
+//# sourceMappingURL=DateAttribute.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DateAttribute.d.ts","sourceRoot":"","sources":["../../../../src/decorators/attributes/DateAttribute.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,UAAU,MAAM,kBAAkB,CAAC;AAE/C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAGjD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,iBAAS,aAAa,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,IAAI,EACzD,KAAK,CAAC,EAAE,gBAAgB,YAGd,SAAS,WACR,2BAA2B,CAAC,EAAE,CAAC,CAAC,UAe5C;AAED,eAAe,aAAa,CAAC"}

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

@@ -0,0 +1,43 @@
+"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"));
+const serializers_1 = require("./serializers");
+/**
+ * Similar to '@Attribute' but specific to Dates since Dates are not native types to dynamo
+ *
+ * Does not allow property to be optional.
+ *
+ * @template T The class type that the decorator is applied to, ensuring type safety and integration within specific class instances.
+ * @template K A type constraint extending `Date`, ensuring that the decorator is only applied to class fields specifically intended to represent dates.
+ * @param props An {@link AttributeOptions} object providing configuration options for the attribute, such as its `alias` which allows the attribute to be referred to by an alternative name in the database context. The `nullable` property is also set to `false` by default; the attribute must not be empty.
+ * @returns A class field decorator function that operates within the class field's context. It configures the field as a date attribute and defines how it should be serialized and deserialized to/from DynamoDB.
+ *
+ * Usage example:
+ * ```typescript
+ * class MyEntity extends MyTable {
+ *   @DateAttribute({ alias: 'MyField' })
+ *   public myField: Date;
+ * }
+ * ```
+ *
+ * Here, `@Attribute` decorates `myField` of `MyEntity`, marking it as an entity attribute with an alias 'MyField' for ORM purposes.
+ */
+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, {
+                    attributeName: context.name.toString(),
+                    nullable: false,
+                    serializers: serializers_1.dateSerializer,
+                    ...props
+                });
+            });
+        }
+    };
+}
+exports.default = DateAttribute;

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

@@ -0,0 +1,26 @@
+import type DynaRecord from "../../DynaRecord";
+import type { Optional } from "../../types";
+import type { AttributeOptions } from "../types";
+/**
+ * Similar to '@Attribute' but specific to Dates since Dates are not native types to dynamo
+ *
+ * IMPORTANT - For optimal type safety mark the class field property as optional
+ *
+ * @template T The class type that the decorator is applied to, ensuring type safety and integration within specific class instances.
+ * @template K A type constraint extending `Date`, ensuring that the decorator is only applied to class fields specifically intended to represent dates.
+ * @param props An {@link AttributeOptions} object providing configuration options for the attribute, such as its `alias` which allows the attribute to be referred to by an alternative name in the database context. The `nullable` property is also set to `false` by default, indicating that the date attribute must not be empty.
+ * @returns A class field decorator function that operates within the class field's context. It configures the field as a date attribute and defines how it should be serialized and deserialized to/from DynamoDB.
+ *
+ * Usage example:
+ * ```typescript
+ * class MyEntity extends MyTable {
+ *   @DateNullableAttribute({ alias: 'MyField' })
+ *   public myField?: Date; // Set to Optional
+ * }
+ * ```
+ *
+ * Here, `@Attribute` decorates `myField` of `MyEntity`, marking it as an entity attribute with an alias 'MyField' for ORM purposes.
+ */
+declare function DateNullableAttribute<T extends DynaRecord, K extends Date>(props?: AttributeOptions): (_value: undefined, context: ClassFieldDecoratorContext<T, Optional<K>>) => void;
+export default DateNullableAttribute;
+//# sourceMappingURL=DateNullableAttribute.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DateNullableAttribute.d.ts","sourceRoot":"","sources":["../../../../src/decorators/attributes/DateNullableAttribute.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,UAAU,MAAM,kBAAkB,CAAC;AAE/C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAGjD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,iBAAS,qBAAqB,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,IAAI,EACjE,KAAK,CAAC,EAAE,gBAAgB,YAGd,SAAS,WACR,2BAA2B,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,UAetD;AAED,eAAe,qBAAqB,CAAC"}

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

@@ -0,0 +1,43 @@
+"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"));
+const serializers_1 = require("./serializers");
+/**
+ * Similar to '@Attribute' but specific to Dates since Dates are not native types to dynamo
+ *
+ * IMPORTANT - For optimal type safety mark the class field property as optional
+ *
+ * @template T The class type that the decorator is applied to, ensuring type safety and integration within specific class instances.
+ * @template K A type constraint extending `Date`, ensuring that the decorator is only applied to class fields specifically intended to represent dates.
+ * @param props An {@link AttributeOptions} object providing configuration options for the attribute, such as its `alias` which allows the attribute to be referred to by an alternative name in the database context. The `nullable` property is also set to `false` by default, indicating that the date attribute must not be empty.
+ * @returns A class field decorator function that operates within the class field's context. It configures the field as a date attribute and defines how it should be serialized and deserialized to/from DynamoDB.
+ *
+ * Usage example:
+ * ```typescript
+ * class MyEntity extends MyTable {
+ *   @DateNullableAttribute({ alias: 'MyField' })
+ *   public myField?: Date; // Set to Optional
+ * }
+ * ```
+ *
+ * Here, `@Attribute` decorates `myField` of `MyEntity`, marking it as an entity attribute with an alias 'MyField' for ORM purposes.
+ */
+function DateNullableAttribute(props) {
+    return function (_value, context) {
+        if (context.kind === "field") {
+            context.addInitializer(function () {
+                const entity = Object.getPrototypeOf(this);
+                metadata_1.default.addEntityAttribute(entity.constructor.name, {
+                    attributeName: context.name.toString(),
+                    nullable: true,
+                    serializers: serializers_1.dateSerializer,
+                    ...props
+                });
+            });
+        }
+    };
+}
+exports.default = DateNullableAttribute;

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

@@ -0,0 +1,25 @@
+import type DynaRecord from "../../DynaRecord";
+import type { ForeignKey } from "../../types";
+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.
+ *
+ * Does not allow property to be optional.
+ *
+ * @template T The entity the decorator is applied to.
+ * @param props An optional object of {@link AttributeOptions}, including configuration options such as metadata attributes. These options allow for additional customization of the foreign key attribute, including aliasing and metadata tagging.
+ * @returns A class field decorator function that targets and initializes the class's prototype to register the foreign key with the ORM's metadata system. This registration is crucial for enabling the ORM to correctly interpret and manage the relationships between entities.
+ *
+ * Usage example:
+ * ```typescript
+ * class Order extends BaseEntity {
+ *   @ForeignKeyAttribute({ alias: 'UserID' })
+ *   public userId: string; // Foreign key to the User entity
+ * }
+ * ```
+ *
+ * Here, `@ForeignKeyAttribute` decorates `userId` of `Order`, designating it as a foreign key that references the `User` entity. This decoration not only clarifies the nature of the relationship but also empowers the ORM to enforce relational integrity and facilitate entity association operations.
+ */
+declare function ForeignKeyAttribute<T extends DynaRecord>(props?: AttributeOptions): (_value: undefined, context: ClassFieldDecoratorContext<T, ForeignKey>) => void;
+export default ForeignKeyAttribute;
+//# sourceMappingURL=ForeignKeyAttribute.d.ts.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,40 @@
+"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"));
+/**
+ * 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.
+ *
+ * Does not allow property to be optional.
+ *
+ * @template T The entity the decorator is applied to.
+ * @param props An optional object of {@link AttributeOptions}, including configuration options such as metadata attributes. These options allow for additional customization of the foreign key attribute, including aliasing and metadata tagging.
+ * @returns A class field decorator function that targets and initializes the class's prototype to register the foreign key with the ORM's metadata system. This registration is crucial for enabling the ORM to correctly interpret and manage the relationships between entities.
+ *
+ * Usage example:
+ * ```typescript
+ * class Order extends BaseEntity {
+ *   @ForeignKeyAttribute({ alias: 'UserID' })
+ *   public userId: string; // Foreign key to the User entity
+ * }
+ * ```
+ *
+ * Here, `@ForeignKeyAttribute` decorates `userId` of `Order`, designating it as a foreign key that references the `User` entity. This decoration not only clarifies the nature of the relationship but also empowers the ORM to enforce relational integrity and facilitate entity association operations.
+ */
+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, {
+                    attributeName: context.name.toString(),
+                    nullable: false,
+                    ...props
+                });
+            });
+        }
+    };
+}
+exports.default = ForeignKeyAttribute;

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

@@ -0,0 +1,27 @@
+import type DynaRecord from "../../DynaRecord";
+import { type Optional } from "../../types";
+import type { AttributeOptions, NotForeignKey } from "../types";
+import { type NativeScalarAttributeValue } from "@aws-sdk/util-dynamodb";
+/**
+ * Similar to '@Attribute' but specific to Dates since Dates are not native types to dynamo
+ *
+ * IMPORTANT - For optimal type safety mark the class field property as optional
+ *
+ * @template T The class type that the decorator is applied to, ensuring type safety and integration within specific class instances.
+ * @template K A type constraint extending `Date`, ensuring that the decorator is only applied to class fields specifically intended to represent dates.
+ * @param props An {@link AttributeOptions} object providing configuration options for the attribute, such as its `alias` which allows the attribute to be referred to by an alternative name in the database context. The `nullable` property is also set to `true` by default, indicating that the date attribute can be empty.
+ * @returns A class field decorator function that operates within the class field's context. It configures the field as a date attribute and defines how it should be serialized and deserialized to/from DynamoDB.
+ *
+ * Usage example:
+ * ```typescript
+ * class MyEntity extends MyTable {
+ *   @NullableAttribute({ alias: 'MyField' })
+ *   public myField?: string; // Set to Optional
+ * }
+ * ```
+ *
+ * Here, `@Attribute` decorates `myField` of `MyEntity`, marking it as an entity attribute with an alias 'MyField' for ORM purposes.
+ */
+declare function NullableAttribute<T extends DynaRecord, K extends NativeScalarAttributeValue>(props?: AttributeOptions): (_value: undefined, context: ClassFieldDecoratorContext<T, Optional<NotForeignKey<K>>>) => void;
+export default NullableAttribute;
+//# sourceMappingURL=NullableAttribute.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"NullableAttribute.d.ts","sourceRoot":"","sources":["../../../../src/decorators/attributes/NullableAttribute.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,UAAU,MAAM,kBAAkB,CAAC;AAE/C,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,KAAK,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAChE,OAAO,EAAE,KAAK,0BAA0B,EAAE,MAAM,wBAAwB,CAAC;AAEzE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,iBAAS,iBAAiB,CACxB,CAAC,SAAS,UAAU,EACpB,CAAC,SAAS,0BAA0B,EACpC,KAAK,CAAC,EAAE,gBAAgB,YAEd,SAAS,WACR,2BAA2B,CAAC,EAAE,SAAS,cAAc,CAAC,CAAC,CAAC,CAAC,UAcrE;AAED,eAAe,iBAAiB,CAAC"}

package/dist/src/decorators/attributes/NullableAttribute.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"));
+/**
+ * Similar to '@Attribute' but specific to Dates since Dates are not native types to dynamo
+ *
+ * IMPORTANT - For optimal type safety mark the class field property as optional
+ *
+ * @template T The class type that the decorator is applied to, ensuring type safety and integration within specific class instances.
+ * @template K A type constraint extending `Date`, ensuring that the decorator is only applied to class fields specifically intended to represent dates.
+ * @param props An {@link AttributeOptions} object providing configuration options for the attribute, such as its `alias` which allows the attribute to be referred to by an alternative name in the database context. The `nullable` property is also set to `true` by default, indicating that the date attribute can be empty.
+ * @returns A class field decorator function that operates within the class field's context. It configures the field as a date attribute and defines how it should be serialized and deserialized to/from DynamoDB.
+ *
+ * Usage example:
+ * ```typescript
+ * class MyEntity extends MyTable {
+ *   @NullableAttribute({ alias: 'MyField' })
+ *   public myField?: string; // Set to Optional
+ * }
+ * ```
+ *
+ * Here, `@Attribute` decorates `myField` of `MyEntity`, marking it as an entity attribute with an alias 'MyField' for ORM purposes.
+ */
+function NullableAttribute(props) {
+    return function (_value, context) {
+        if (context.kind === "field") {
+            context.addInitializer(function () {
+                const entity = Object.getPrototypeOf(this);
+                metadata_1.default.addEntityAttribute(entity.constructor.name, {
+                    attributeName: context.name.toString(),
+                    nullable: true,
+                    ...props
+                });
+            });
+        }
+    };
+}
+exports.default = NullableAttribute;

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

@@ -0,0 +1,25 @@
+import type DynaRecord from "../../DynaRecord";
+import type { NullableForeignKey } from "../../types";
+import type { AttributeOptions } from "../types";
+/**
+ * A decorator for annotating class fields as nullable foreign keys within the context of a single-table design entity. This decorator is specifically designed for attributes that represent nullable foreign keys, facilitating the representation and management of relationships between entities.
+ *
+ * IMPORTANT - For optimal type safety mark the class field property as optional
+ *
+ * @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.
+ *
+ * Usage example:
+ * ```typescript
+ * class User extends BaseEntity {
+ *   @NullableForeignKeyAttribute({ alias: 'ProfileId' })
+ *   public profileId?: string; // Set to optional. Nullable foreign key to another entity (e.g., UserProfile)
+ * }
+ * ```
+ *
+ * Here, `@NullableForeignKeyAttribute` decorates `profileId` of `User`, indicating it as a nullable foreign key.
+ */
+declare function NullableForeignKeyAttribute<T extends DynaRecord>(props?: AttributeOptions): (_value: undefined, context: ClassFieldDecoratorContext<T, NullableForeignKey>) => void;
+export default NullableForeignKeyAttribute;
+//# sourceMappingURL=NullableForeignKeyAttribute.d.ts.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,40 @@
+"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"));
+/**
+ * A decorator for annotating class fields as nullable foreign keys within the context of a single-table design entity. This decorator is specifically designed for attributes that represent nullable foreign keys, facilitating the representation and management of relationships between entities.
+ *
+ * IMPORTANT - For optimal type safety mark the class field property as optional
+ *
+ * @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.
+ *
+ * Usage example:
+ * ```typescript
+ * class User extends BaseEntity {
+ *   @NullableForeignKeyAttribute({ alias: 'ProfileId' })
+ *   public profileId?: string; // Set to optional. Nullable foreign key to another entity (e.g., UserProfile)
+ * }
+ * ```
+ *
+ * Here, `@NullableForeignKeyAttribute` decorates `profileId` of `User`, indicating it as a nullable foreign key.
+ */
+function NullableForeignKeyAttribute(props) {
+    return function (_value, context) {
+        if (context.kind === "field") {
+            context.addInitializer(function () {
+                const entity = Object.getPrototypeOf(this);
+                metadata_1.default.addEntityAttribute(entity.constructor.name, {
+                    attributeName: context.name.toString(),
+                    nullable: true,
+                    ...props
+                });
+            });
+        }
+    };
+}
+exports.default = NullableForeignKeyAttribute;

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

@@ -0,0 +1,24 @@
+import type DynaRecord from "../../DynaRecord";
+import { type PartitionKey } from "../../types";
+import type { AttributeOptions } from "../types";
+/**
+ * A decorator for designating the field for the partition key on the dynamo table.
+ *
+ * @template T The entity to which the decorator is applied.
+ * @template K The type constraint ensuring the field is suitable to be a partition key.
+ * @param props An optional object of {@link AttributeOptions}, providing additional configuration for the partition key attribute, such as custom metadata.
+ * @returns A class field decorator function that targets and initializes the class's prototype to register the partition key with the ORM's metadata system.
+ *
+ * Usage example:
+ * ```typescript
+ * class User extends BaseEntity {
+ *   @PartitionKeyAttribute()
+ *   public pk: PartitionKey;
+ * }
+ * ```
+ *
+ * In this example, `@PartitionKeyAttribute` decorates the `pk` field of `User`, marking it as the entity's partition key.
+ */
+declare function PartitionKeyAttribute<T extends DynaRecord, K extends PartitionKey>(props?: AttributeOptions): (_value: undefined, context: ClassFieldDecoratorContext<T, K>) => void;
+export default PartitionKeyAttribute;
+//# sourceMappingURL=PartitionKeyAttribute.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PartitionKeyAttribute.d.ts","sourceRoot":"","sources":["../../../../src/decorators/attributes/PartitionKeyAttribute.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,UAAU,MAAM,kBAAkB,CAAC;AAE/C,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAEjD;;;;;;;;;;;;;;;;;GAiBG;AACH,iBAAS,qBAAqB,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,YAAY,EACzE,KAAK,CAAC,EAAE,gBAAgB,YAGd,SAAS,WACR,2BAA2B,CAAC,EAAE,CAAC,CAAC,UAa5C;AAED,eAAe,qBAAqB,CAAC"}

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

@@ -0,0 +1,38 @@
+"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"));
+/**
+ * A decorator for designating the field for the partition key on the dynamo table.
+ *
+ * @template T The entity to which the decorator is applied.
+ * @template K The type constraint ensuring the field is suitable to be a partition key.
+ * @param props An optional object of {@link AttributeOptions}, providing additional configuration for the partition key attribute, such as custom metadata.
+ * @returns A class field decorator function that targets and initializes the class's prototype to register the partition key with the ORM's metadata system.
+ *
+ * Usage example:
+ * ```typescript
+ * class User extends BaseEntity {
+ *   @PartitionKeyAttribute()
+ *   public pk: PartitionKey;
+ * }
+ * ```
+ *
+ * In this example, `@PartitionKeyAttribute` decorates the `pk` field of `User`, marking it as the entity's partition key.
+ */
+function PartitionKeyAttribute(props) {
+    return function (_value, context) {
+        if (context.kind === "field") {
+            context.addInitializer(function () {
+                const entity = Object.getPrototypeOf(this);
+                metadata_1.default.addPartitionKeyAttribute(entity, {
+                    attributeName: context.name.toString(),
+                    ...props
+                });
+            });
+        }
+    };
+}
+exports.default = PartitionKeyAttribute;

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

@@ -0,0 +1,24 @@
+import type DynaRecord from "../../DynaRecord";
+import { type SortKey } from "../../types";
+import type { AttributeOptions } from "../types";
+/**
+ * A decorator for designating the field for the sort key on the dynamo table.
+ *
+ * @template T The entity to which the decorator is applied.
+ * @template K The type constraint ensuring the field is suitable to be a partition key.
+ * @param props An optional object of {@link AttributeOptions}, providing additional configuration for the sort key attribute, such as custom metadata.
+ * @returns A class field decorator function that targets and initializes the class's prototype to register the sort key with the ORM's metadata system.
+ *
+ * Usage example:
+ * ```typescript
+ * class User extends BaseEntity {
+ *   @SortKeyAttribute()
+ *   public sk: SortKey;
+ * }
+ * ```
+ *
+ * In this example, `@SortKeyAttribute` decorates the `sk` field of `User`, marking it as the entity's sort key.
+ */
+declare function SortKeyAttribute<T extends DynaRecord, K extends SortKey>(props?: AttributeOptions): (_value: undefined, context: ClassFieldDecoratorContext<T, K>) => void;
+export default SortKeyAttribute;
+//# sourceMappingURL=SortKeyAttribute.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SortKeyAttribute.d.ts","sourceRoot":"","sources":["../../../../src/decorators/attributes/SortKeyAttribute.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,UAAU,MAAM,kBAAkB,CAAC;AAE/C,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAEjD;;;;;;;;;;;;;;;;;GAiBG;AACH,iBAAS,gBAAgB,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,OAAO,EAC/D,KAAK,CAAC,EAAE,gBAAgB,YAGd,SAAS,WACR,2BAA2B,CAAC,EAAE,CAAC,CAAC,UAa5C;AAED,eAAe,gBAAgB,CAAC"}

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

@@ -0,0 +1,38 @@
+"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"));
+/**
+ * A decorator for designating the field for the sort key on the dynamo table.
+ *
+ * @template T The entity to which the decorator is applied.
+ * @template K The type constraint ensuring the field is suitable to be a partition key.
+ * @param props An optional object of {@link AttributeOptions}, providing additional configuration for the sort key attribute, such as custom metadata.
+ * @returns A class field decorator function that targets and initializes the class's prototype to register the sort key with the ORM's metadata system.
+ *
+ * Usage example:
+ * ```typescript
+ * class User extends BaseEntity {
+ *   @SortKeyAttribute()
+ *   public sk: SortKey;
+ * }
+ * ```
+ *
+ * In this example, `@SortKeyAttribute` decorates the `sk` field of `User`, marking it as the entity's sort key.
+ */
+function SortKeyAttribute(props) {
+    return function (_value, context) {
+        if (context.kind === "field") {
+            context.addInitializer(function () {
+                const entity = Object.getPrototypeOf(this);
+                metadata_1.default.addSortKeyAttribute(entity, {
+                    attributeName: context.name.toString(),
+                    ...props
+                });
+            });
+        }
+    };
+}
+exports.default = SortKeyAttribute;

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

@@ -0,0 +1,10 @@
+export { default as Attribute } from "./Attribute";
+export { default as NullableAttribute } from "./NullableAttribute";
+export { default as PartitionKeyAttribute } from "./PartitionKeyAttribute";
+export { default as SortKeyAttribute } from "./SortKeyAttribute";
+export { default as ForeignKeyAttribute } from "./ForeignKeyAttribute";
+export { default as NullableForeignKeyAttribute } from "./NullableForeignKeyAttribute";
+export { default as DateAttribute } from "./DateAttribute";
+export { default as DateNullableAttribute } from "./DateNullableAttribute";
+export * from "./serializers";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/decorators/attributes/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,OAAO,IAAI,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACnE,OAAO,EAAE,OAAO,IAAI,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAC3E,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,EAAE,OAAO,IAAI,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACvE,OAAO,EAAE,OAAO,IAAI,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AACvF,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAAE,OAAO,IAAI,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAC3E,cAAc,eAAe,CAAC"}