dyna-record 0.0.19 → 0.1.0

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

@@ -1,27 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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/NullableForeignKeyAttribute.d.ts

@@ -1,30 +0,0 @@
-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
- *
- * 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.
- *
- * Usage example:
- * ```typescript
- * class User extends BaseEntity {
- *   @NullableForeignKeyAttribute({ alias: 'ProfileId' })
- *   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
- * }
- * ```
- *
- * 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

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

@@ -1,45 +0,0 @@
-"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
- *
- * 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.
- *
- * Usage example:
- * ```typescript
- * class User extends BaseEntity {
- *   @NullableForeignKeyAttribute({ alias: 'ProfileId' })
- *   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
- * }
- * ```
- *
- * 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;