dyna-record 0.1.3 → 0.1.4

package/README.md

@@ -142,6 +142,7 @@ Use the attribute decorators below to define attributes on a model. The decorato
   - [@NumberAttribute](https://dyna-record.com/functions/NumberAttribute.html)
   - [@BooleanAttribute](https://dyna-record.com/functions/BooleanAttribute.html)
   - [@DateAttribute](https://dyna-record.com/functions/DateAttribute.html)
+  - [@EnumAttribute](https://dyna-record.com/functions/EnumAttribute.html)
 
 - The [alias](https://dyna-record.com/interfaces/AttributeOptions.html#alias) option allows you to specify the attribute name as it appears in the DynamoDB table, different from your class property name.
 - Set nullable attributes as optional for optimal type safety

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

@@ -0,0 +1,32 @@
+import type DynaRecord from "../../DynaRecord";
+import type { AttributeDecoratorContext, AttributeOptions } from "../types";
+/**
+ * Extends {@link AttributeOptions} but requires that the allowed values are set on `values`
+ */
+export interface EnumAttributeOptions extends AttributeOptions {
+    values: [string, ...string[]];
+}
+/**
+ * A decorator for marking class fields as enum attributes within the context of a single-table design entity. Only the types specified in `values` are allowed via both the type system and runtime schema checks.
+ *
+ * This enforces a union type of the specified fields listed in `values`
+ *
+ * @template T The entity the decorator is applied to.
+ * @template K The type of the attribute, restricted to the values listed in `values` prop of EnumAttributeOptions
+ * @param props An optional object of {@link EnumAttributeOptions}, including the allowed values, 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 enum values.
+ *
+ * Usage example:
+ * ```typescript
+ * class Product extends BaseEntity {
+ *   @EnumAttribute({ alias: 'SomeField', values: ["val-1", "val-2"] })
+ *   public someField: "val-1" | "val-2"; // Attribute representing the union/enum types specified in `values`. In this case the only allowed values are "val-1" and "val-2"
+ *
+ *   @EnumAttribute({ alias: 'MyNullableField', nullable: true, values: ["val-1", "val-2"] })
+ *   public myNullableField?: "val-1" | "val-2"; // Set to Optional for nullable attributes
+ * }
+ * ```
+ */
+declare function EnumAttribute<T extends DynaRecord, const K extends P["values"][number], const P extends EnumAttributeOptions>(props: P): (_value: undefined, context: AttributeDecoratorContext<T, K, P>) => void;
+export default EnumAttribute;
+//# sourceMappingURL=EnumAttribute.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"EnumAttribute.d.ts","sourceRoot":"","sources":["../../../../src/decorators/attributes/EnumAttribute.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,UAAU,MAAM,kBAAkB,CAAC;AAE/C,OAAO,KAAK,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5E;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAG5D,MAAM,EAAE,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;CAC/B;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,iBAAS,aAAa,CACpB,CAAC,SAAS,UAAU,EACpB,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,EACnC,KAAK,CAAC,CAAC,SAAS,oBAAoB,EACpC,KAAK,EAAE,CAAC,YAEE,SAAS,WACR,0BAA0B,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,UAe9C;AAED,eAAe,aAAa,CAAC"}

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

@@ -0,0 +1,44 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const zod_1 = require("zod");
+const metadata_1 = __importDefault(require("../../metadata"));
+/**
+ * A decorator for marking class fields as enum attributes within the context of a single-table design entity. Only the types specified in `values` are allowed via both the type system and runtime schema checks.
+ *
+ * This enforces a union type of the specified fields listed in `values`
+ *
+ * @template T The entity the decorator is applied to.
+ * @template K The type of the attribute, restricted to the values listed in `values` prop of EnumAttributeOptions
+ * @param props An optional object of {@link EnumAttributeOptions}, including the allowed values, 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 enum values.
+ *
+ * Usage example:
+ * ```typescript
+ * class Product extends BaseEntity {
+ *   @EnumAttribute({ alias: 'SomeField', values: ["val-1", "val-2"] })
+ *   public someField: "val-1" | "val-2"; // Attribute representing the union/enum types specified in `values`. In this case the only allowed values are "val-1" and "val-2"
+ *
+ *   @EnumAttribute({ alias: 'MyNullableField', nullable: true, values: ["val-1", "val-2"] })
+ *   public myNullableField?: "val-1" | "val-2"; // Set to Optional for nullable attributes
+ * }
+ * ```
+ */
+function EnumAttribute(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: props?.nullable,
+                    type: zod_1.z.enum(props.values),
+                    ...props
+                });
+            });
+        }
+    };
+}
+exports.default = EnumAttribute;

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

@@ -5,5 +5,6 @@ export { default as DateAttribute } from "./DateAttribute";
 export { default as StringAttribute } from "./StringAttribute";
 export { default as BooleanAttribute } from "./BooleanAttribute";
 export { default as NumberAttribute } from "./NumberAttribute";
+export { default as EnumAttribute } from "./EnumAttribute";
 export * from "./serializers";
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/decorators/attributes/index.ts"],"names":[],"mappings":"AAAA,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,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC/D,cAAc,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/decorators/attributes/index.ts"],"names":[],"mappings":"AAAA,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,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAC3D,cAAc,eAAe,CAAC"}

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

@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NumberAttribute = exports.BooleanAttribute = exports.StringAttribute = exports.DateAttribute = exports.ForeignKeyAttribute = exports.SortKeyAttribute = exports.PartitionKeyAttribute = void 0;
+exports.EnumAttribute = exports.NumberAttribute = exports.BooleanAttribute = exports.StringAttribute = exports.DateAttribute = exports.ForeignKeyAttribute = exports.SortKeyAttribute = exports.PartitionKeyAttribute = void 0;
 var PartitionKeyAttribute_1 = require("./PartitionKeyAttribute");
 Object.defineProperty(exports, "PartitionKeyAttribute", { enumerable: true, get: function () { return __importDefault(PartitionKeyAttribute_1).default; } });
 var SortKeyAttribute_1 = require("./SortKeyAttribute");
@@ -32,4 +32,6 @@ var BooleanAttribute_1 = require("./BooleanAttribute");
 Object.defineProperty(exports, "BooleanAttribute", { enumerable: true, get: function () { return __importDefault(BooleanAttribute_1).default; } });
 var NumberAttribute_1 = require("./NumberAttribute");
 Object.defineProperty(exports, "NumberAttribute", { enumerable: true, get: function () { return __importDefault(NumberAttribute_1).default; } });
+var EnumAttribute_1 = require("./EnumAttribute");
+Object.defineProperty(exports, "EnumAttribute", { enumerable: true, get: function () { return __importDefault(EnumAttribute_1).default; } });
 __exportStar(require("./serializers"), exports);

package/package.json

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