dyna-record 0.1.5 → 0.2.0

package/dist/src/utils.js

@@ -3,9 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.safeAssign = exports.isString = exports.isPropertyKey = exports.chunkArray = exports.isBelongsToLinkDynamoItem = exports.isKeyOfObject = exports.isKeyOfEntity = exports.tableItemToBelongsToLink = exports.createInstance = exports.tableItemToEntity = exports.entityToTableItem = void 0;
+exports.isNullableString = exports.safeAssign = exports.isString = exports.chunkArray = exports.isKeyOfObject = exports.isKeyOfEntity = exports.createInstance = exports.tableItemToEntity = exports.entityToTableItem = void 0;
 const metadata_1 = __importDefault(require("./metadata"));
-const relationships_1 = require("./relationships");
 /**
  * Convert an entity to its aliased table item fields to for dynamo interactions
  * @param entityClassName
@@ -19,7 +18,9 @@ const entityToTableItem = (EntityClass, entityData) => {
         if (attrMeta !== undefined) {
             const { alias, serializers } = attrMeta;
             // If the attribute has a custom serializer, serialize it
-            const value = serializers === undefined ? val : serializers.toTableAttribute(val);
+            const value = serializers === undefined || val === null
+                ? val
+                : serializers.toTableAttribute(val);
             acc[alias] = value;
         }
         return acc;
@@ -64,35 +65,6 @@ const createInstance = (EntityClass, attributes) => {
     return entity;
 };
 exports.createInstance = createInstance;
-/**
- * Serialize a dynamo table item response to a BelongsToLink
- * @param tableMeta - Table metadata
- * @param tableItem - Table item from dynamo response
- * @returns - { @link BelongsToLink }
- */
-const tableItemToBelongsToLink = (tableMeta, tableItem) => {
-    const link = new relationships_1.BelongsToLink();
-    const belongsToLinkAttrs = {
-        ...{
-            [tableMeta.partitionKeyAttribute.alias]: tableMeta.partitionKeyAttribute
-        },
-        ...{ [tableMeta.sortKeyAttribute.alias]: tableMeta.sortKeyAttribute },
-        ...tableMeta.defaultTableAttributes
-    };
-    Object.keys(tableItem).forEach(attrName => {
-        const attrMeta = belongsToLinkAttrs[attrName];
-        if (attrMeta !== undefined) {
-            const { name: entityKey, serializers } = attrMeta;
-            const rawVal = tableItem[attrName];
-            const val = serializers?.toEntityAttribute === undefined
-                ? rawVal
-                : serializers?.toEntityAttribute(rawVal);
-            (0, exports.safeAssign)(link, entityKey, val);
-        }
-    });
-    return link;
-};
-exports.tableItemToBelongsToLink = tableItemToBelongsToLink;
 /**
  * Type guard to check if the key is defined on the entity
  */
@@ -110,15 +82,6 @@ const isKeyOfObject = (entity, key) => {
     return key in entity;
 };
 exports.isKeyOfObject = isKeyOfObject;
-/**
- * Type guard to check if the DynamoTableItem is a BelongsToLink
- * @param res DynamoTableItem
- * @returns boolean
- */
-const isBelongsToLinkDynamoItem = (res, tableMeta) => {
-    return res[tableMeta.defaultAttributes.type.alias] === relationships_1.BelongsToLink.name;
-};
-exports.isBelongsToLinkDynamoItem = isBelongsToLinkDynamoItem;
 /**
  * Break an array into chunks
  * @param array
@@ -129,24 +92,6 @@ const chunkArray = (array, size) => {
     return Array.from({ length: Math.ceil(array.length / size) }, (_, index) => array.slice(index * size, (index + 1) * size));
 };
 exports.chunkArray = chunkArray;
-/**
- * Checks if a value is a valid property key (string, number, or symbol).
- *
- * @param value The value to be checked. This can be of any type.
- * @returns `true` if the value is a `string`, `number`, or `symbol` (i.e., a valid property key); otherwise, `false`.
- *
- * @example
- * Logger.log(isPropertyKey('test')); // true
- * Logger.log(isPropertyKey(123)); // true
- * Logger.log(isPropertyKey(Symbol('sym'))); // true
- * Logger.log(isPropertyKey({})); // false
- */
-const isPropertyKey = (value) => {
-    return (typeof value === "string" ||
-        typeof value === "number" ||
-        typeof value === "symbol");
-};
-exports.isPropertyKey = isPropertyKey;
 /**
  * Checks if the given value is a string.
  *
@@ -179,3 +124,12 @@ const safeAssign = (object, key, value) => {
     object[key] = value;
 };
 exports.safeAssign = safeAssign;
+/**
+ * Type guard to check if a string is a Nullable<string>
+ * @param val
+ * @returns
+ */
+const isNullableString = (val) => {
+    return typeof val === "string" || val === null;
+};
+exports.isNullableString = isNullableString;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dyna-record",
-  "version": "0.1.5",
+  "version": "0.2.0",
   "description": "Typescript Object Relational Mapper (ORM) for Dynamo",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -49,9 +49,9 @@
     "prettier": "^3.2.5",
     "ts-jest": "^29.1.2",
     "ts-node": "^10.9.2",
-    "typedoc": "^0.25.12",
-    "typedoc-plugin-missing-exports": "^2.2.0",
-    "typescript": "^5.3.3"
+    "typedoc": "^0.27.6",
+    "typedoc-plugin-missing-exports": "^3.1.0",
+    "typescript": "^5.7.2"
   },
   "engines": {
     "npm": ">=10.0.0",

package/dist/src/operations/utils/RelationshipTransactions.d.ts

@@ -1,64 +0,0 @@
-import type DynaRecord from "../../DynaRecord";
-import type { TransactWriteBuilder } from "../../dynamo-utils";
-import { type BelongsToRelationship } from "../../metadata";
-import type { EntityClass } from "../../types";
-type EntityData<T extends DynaRecord> = Pick<T, "id"> & Partial<T>;
-interface RelationshipTransactionsProps<T extends DynaRecord> {
-    /**
-     * Entity for which relationships are being persisted
-     */
-    readonly Entity: EntityClass<T>;
-    /**
-     * TransactionBuilder instance to add relationship transactions to
-     */
-    readonly transactionBuilder: TransactWriteBuilder;
-    /**
-     * Optional callback to add logic to persisting BelongsTo HasMany relationships
-     * @param rel The BelongsToRelationship metadata of which the Entity BelongsTo HasMany of
-     * @param entityId The ID of the entity
-     * @returns
-     */
-    belongsToHasManyCb?: (rel: BelongsToRelationship, entityId: string) => Promise<void>;
-    /**
-     * Optional callback to add logic to persisting BelongsTo HasOne relationships
-     * @param rel The BelongsToRelationship metadata of which the Entity BelongsTo HasOne of
-     * @param entityId The ID of the entity
-     * @returns
-     */
-    belongsToHasOneCb?: (rel: BelongsToRelationship, entityId: string) => Promise<void>;
-}
-/**
- * Builds transactions for persisting create/update relationships
- *   - Sets/removes ForeignKeys
- *   - Adds/removes BelongsToLinks
- */
-declare class RelationshipTransactions<T extends DynaRecord> {
-    #private;
-    constructor(props: RelationshipTransactionsProps<T>);
-    build<T extends DynaRecord>(entityData: EntityData<T>): Promise<void>;
-    /**
-     * Builds a ConditionCheck transaction that ensures the associated relationship exists
-     * @param rel
-     * @param relationshipId
-     * @returns
-     */
-    private buildRelationshipExistsConditionTransaction;
-    /**
-     * Creates a BelongsToLink transaction item in the parents partition if the entity BelongsTo a HasOne association
-     * Adds conditional check to ensure the parent doesn't already have one of the entity being associated
-     * @param entityId Id of the entity being persisted
-     * @param rel BelongsTo relationship metadata for which the entity being persisted is a BelongsTo HasOne
-     * @param relationshipId Id of the parent entity of which the entity being persisted BelongsTo
-     */
-    private buildBelongsToHasOne;
-    /**
-     * Creates a BelongsToLink transaction item in the parents partition if the entity BelongsTo a HasMany association
-     * @param rel BelongsTo relationship metadata for which the entity being persisted is a BelongsTo HasMany
-     * @param entityId Id of the entity being persisted
-     * @param relationshipId Id of the parent entity of which the entity being persisted BelongsTo
-     */
-    private buildBelongsToHasMany;
-    private isNullableString;
-}
-export default RelationshipTransactions;
-//# sourceMappingURL=RelationshipTransactions.d.ts.map

package/dist/src/operations/utils/RelationshipTransactions.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"RelationshipTransactions.d.ts","sourceRoot":"","sources":["../../../../src/operations/utils/RelationshipTransactions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,UAAU,MAAM,kBAAkB,CAAC;AAC/C,OAAO,KAAK,EAGV,oBAAoB,EACrB,MAAM,oBAAoB,CAAC;AAC5B,OAAiB,EAEf,KAAK,qBAAqB,EAE3B,MAAM,gBAAgB,CAAC;AAOxB,OAAO,KAAK,EAAE,WAAW,EAAY,MAAM,aAAa,CAAC;AAIzD,KAAK,UAAU,CAAC,CAAC,SAAS,UAAU,IAAI,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAEnE,UAAU,6BAA6B,CAAC,CAAC,SAAS,UAAU;IAC1D;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAChC;;OAEG;IACH,QAAQ,CAAC,kBAAkB,EAAE,oBAAoB,CAAC;IAClD;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,CACnB,GAAG,EAAE,qBAAqB,EAC1B,QAAQ,EAAE,MAAM,KACb,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,CAClB,GAAG,EAAE,qBAAqB,EAC1B,QAAQ,EAAE,MAAM,KACb,OAAO,CAAC,IAAI,CAAC,CAAC;CACpB;AAED;;;;GAIG;AACH,cAAM,wBAAwB,CAAC,CAAC,SAAS,UAAU;;gBAOrC,KAAK,EAAE,6BAA6B,CAAC,CAAC,CAAC;IAUtC,KAAK,CAAC,CAAC,SAAS,UAAU,EACrC,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,GACxB,OAAO,CAAC,IAAI,CAAC;IAoChB;;;;;OAKG;IACH,OAAO,CAAC,2CAA2C;IAoBnD;;;;;;OAMG;YACW,oBAAoB;IAgClC;;;;;OAKG;YACW,qBAAqB;IAkCnC,OAAO,CAAC,gBAAgB;CAGzB;AAED,eAAe,wBAAwB,CAAC"}

package/dist/src/operations/utils/RelationshipTransactions.js

@@ -1,125 +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"));
-const utils_1 = require("../../metadata/utils");
-const relationships_1 = require("../../relationships");
-const utils_2 = require("../../utils");
-const utils_3 = require("./utils");
-/**
- * Builds transactions for persisting create/update relationships
- *   - Sets/removes ForeignKeys
- *   - Adds/removes BelongsToLinks
- */
-class RelationshipTransactions {
-    #props;
-    #entityMetadata;
-    #tableMetadata;
-    #partitionKeyAlias;
-    #sortKeyAlias;
-    constructor(props) {
-        this.#props = props;
-        this.#entityMetadata = metadata_1.default.getEntity(props.Entity.name);
-        this.#tableMetadata = metadata_1.default.getTable(this.#entityMetadata.tableClassName);
-        this.#partitionKeyAlias = this.#tableMetadata.partitionKeyAttribute.alias;
-        this.#sortKeyAlias = this.#tableMetadata.sortKeyAttribute.alias;
-    }
-    async build(entityData) {
-        const { relationships } = this.#entityMetadata;
-        for (const rel of Object.values(relationships)) {
-            const isBelongsTo = (0, utils_1.isBelongsToRelationship)(rel);
-            if (isBelongsTo) {
-                const relationshipId = (0, utils_3.extractForeignKeyFromEntity)(rel, entityData);
-                const isUpdatingRelationshipId = relationshipId !== undefined;
-                if (isUpdatingRelationshipId && this.isNullableString(relationshipId)) {
-                    if (relationshipId !== null) {
-                        this.buildRelationshipExistsConditionTransaction(rel, relationshipId);
-                    }
-                    const callbackParams = [rel, entityData.id, relationshipId];
-                    if ((0, utils_1.doesEntityBelongToRelAsHasMany)(this.#props.Entity, rel)) {
-                        await this.buildBelongsToHasMany(...callbackParams);
-                    }
-                    if ((0, utils_1.doesEntityBelongToRelAsHasOne)(this.#props.Entity, rel)) {
-                        await this.buildBelongsToHasOne(...callbackParams);
-                    }
-                }
-            }
-        }
-    }
-    /**
-     * Builds a ConditionCheck transaction that ensures the associated relationship exists
-     * @param rel
-     * @param relationshipId
-     * @returns
-     */
-    buildRelationshipExistsConditionTransaction(rel, relationshipId) {
-        const { name: tableName } = this.#tableMetadata;
-        const errMsg = `${rel.target.name} with ID '${relationshipId}' does not exist`;
-        const conditionCheck = {
-            TableName: tableName,
-            Key: {
-                [this.#partitionKeyAlias]: rel.target.partitionKeyValue(relationshipId),
-                [this.#sortKeyAlias]: rel.target.name
-            },
-            ConditionExpression: `attribute_exists(${this.#partitionKeyAlias})`
-        };
-        this.#props.transactionBuilder.addConditionCheck(conditionCheck, errMsg);
-    }
-    /**
-     * Creates a BelongsToLink transaction item in the parents partition if the entity BelongsTo a HasOne association
-     * Adds conditional check to ensure the parent doesn't already have one of the entity being associated
-     * @param entityId Id of the entity being persisted
-     * @param rel BelongsTo relationship metadata for which the entity being persisted is a BelongsTo HasOne
-     * @param relationshipId Id of the parent entity of which the entity being persisted BelongsTo
-     */
-    async buildBelongsToHasOne(rel, entityId, relationshipId) {
-        const { name: tableName } = this.#tableMetadata;
-        if (this.#props.belongsToHasOneCb !== undefined) {
-            await this.#props.belongsToHasOneCb(rel, entityId);
-        }
-        if (relationshipId !== null) {
-            const link = relationships_1.BelongsToLink.build(this.#props.Entity.name, entityId);
-            const keys = {
-                [this.#partitionKeyAlias]: rel.target.partitionKeyValue(relationshipId),
-                [this.#sortKeyAlias]: this.#props.Entity.name
-            };
-            const putExpression = {
-                TableName: tableName,
-                Item: { ...keys, ...(0, utils_2.entityToTableItem)(rel.target, link) },
-                ConditionExpression: `attribute_not_exists(${this.#partitionKeyAlias})` // Ensure item doesn't already exist
-            };
-            this.#props.transactionBuilder.addPut(putExpression, `${rel.target.name} with id: ${relationshipId} already has an associated ${this.#props.Entity.name}`);
-        }
-    }
-    /**
-     * Creates a BelongsToLink transaction item in the parents partition if the entity BelongsTo a HasMany association
-     * @param rel BelongsTo relationship metadata for which the entity being persisted is a BelongsTo HasMany
-     * @param entityId Id of the entity being persisted
-     * @param relationshipId Id of the parent entity of which the entity being persisted BelongsTo
-     */
-    async buildBelongsToHasMany(rel, entityId, relationshipId) {
-        const { name: tableName } = this.#tableMetadata;
-        if (this.#props.belongsToHasManyCb !== undefined) {
-            await this.#props.belongsToHasManyCb(rel, entityId);
-        }
-        if (relationshipId !== null) {
-            const link = relationships_1.BelongsToLink.build(this.#props.Entity.name, entityId);
-            const keys = {
-                [this.#partitionKeyAlias]: rel.target.partitionKeyValue(relationshipId),
-                [this.#sortKeyAlias]: this.#props.Entity.partitionKeyValue(link.foreignKey)
-            };
-            const putExpression = {
-                TableName: tableName,
-                Item: { ...keys, ...(0, utils_2.entityToTableItem)(rel.target, link) },
-                ConditionExpression: `attribute_not_exists(${this.#partitionKeyAlias})` // Ensure item doesn't already exist
-            };
-            this.#props.transactionBuilder.addPut(putExpression, `${this.#props.Entity.name} with ID '${entityId}' already belongs to ${rel.target.name} with Id '${relationshipId}'`);
-        }
-    }
-    isNullableString(val) {
-        return typeof val === "string" || val === null;
-    }
-}
-exports.default = RelationshipTransactions;

package/dist/src/relationships/BelongsToLink.d.ts

@@ -1,51 +0,0 @@
-import type DynaRecord from "../DynaRecord";
-import type { ForeignKey } from "../types";
-import type { EntityAttributes } from "../operations";
-/**
- * Extends `DynaRecord` with properties specific to "BelongsTo" relationships, such as `foreignEntityType` and `foreignKey`.
- */
-interface BelongsToLinkProps extends EntityAttributes<DynaRecord> {
-    foreignEntityType: string;
-    foreignKey: string;
-}
-/**
- * Represents a "BelongsTo" relationship link between entities within the ORM system. Instances of this class are used to track and manage associations where one entity belongs to another, encapsulating the connection details including the type of the foreign entity and its foreign key.
- *
- * This class implements the `BelongsToLinkProps` interface, ensuring consistency in the properties used to describe the "BelongsTo" relationship.
- */
-declare class BelongsToLink implements BelongsToLinkProps {
-    /**
-     * A unique identifier for the link itself, automatically generated upon creation.
-     */
-    readonly id: string;
-    /**
-     * The type of the link, statically set to "BelongsToLink".
-     */
-    readonly type: string;
-    /**
-     * The name of the entity type to which the link points (the "parent" entity in the relationship).
-     */
-    readonly foreignEntityType: string;
-    /**
-     * The foreign key value identifying the specific instance of the foreign entity to which the link belongs. While it is a string, it represents the value of a `ForeignKey` attribute in the related entity.
-     */
-    readonly foreignKey: ForeignKey;
-    /**
-     * The timestamp marking when the link was created
-     */
-    readonly createdAt: Date;
-    /**
-     * The timestamp marking the last update to the link. Initially set to the same value as `createdAt`.
-     */
-    readonly updatedAt: Date;
-    constructor(item?: BelongsToLink);
-    /**
-     * A static method to construct a `BelongsToLinkProps` object with specified properties, including auto-generated `id` and timestamp fields. This method facilitates the creation of new link instances without directly instantiating the class.
-     * @param {string} foreignEntityType - The name of the entity type to which the new link will belong.
-     * @param {string} foreignKey - The foreign key value identifying the specific instance of the foreign entity.
-     * @returns {BelongsToLinkProps} - A new `BelongsToLinkProps` object ready for use in creating or managing a "BelongsTo" relationship.
-     */
-    static build(foreignEntityType: string, foreignKey: string): BelongsToLinkProps;
-}
-export default BelongsToLink;
-//# sourceMappingURL=BelongsToLink.d.ts.map

package/dist/src/relationships/BelongsToLink.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"BelongsToLink.d.ts","sourceRoot":"","sources":["../../../src/relationships/BelongsToLink.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,UAAU,MAAM,eAAe,CAAC;AAC5C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAEtD;;GAEG;AACH,UAAU,kBAAmB,SAAQ,gBAAgB,CAAC,UAAU,CAAC;IAC/D,iBAAiB,EAAE,MAAM,CAAC;IAC1B,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,cAAM,aAAc,YAAW,kBAAkB;IAC/C;;OAEG;IACH,SAAgB,EAAE,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,SAAgB,iBAAiB,EAAE,MAAM,CAAC;IAC1C;;OAEG;IACH,SAAgB,UAAU,EAAE,UAAU,CAAC;IACvC;;OAEG;IACH,SAAgB,SAAS,EAAE,IAAI,CAAC;IAChC;;OAEG;IACH,SAAgB,SAAS,EAAE,IAAI,CAAC;gBAEpB,IAAI,CAAC,EAAE,aAAa;IAMhC;;;;;OAKG;WACW,KAAK,CACjB,iBAAiB,EAAE,MAAM,EACzB,UAAU,EAAE,MAAM,GACjB,kBAAkB;CAYtB;AAED,eAAe,aAAa,CAAC"}

package/dist/src/relationships/BelongsToLink.js

@@ -1,57 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const uuid_1 = require("uuid");
-/**
- * Represents a "BelongsTo" relationship link between entities within the ORM system. Instances of this class are used to track and manage associations where one entity belongs to another, encapsulating the connection details including the type of the foreign entity and its foreign key.
- *
- * This class implements the `BelongsToLinkProps` interface, ensuring consistency in the properties used to describe the "BelongsTo" relationship.
- */
-class BelongsToLink {
-    /**
-     * A unique identifier for the link itself, automatically generated upon creation.
-     */
-    id;
-    /**
-     * The type of the link, statically set to "BelongsToLink".
-     */
-    type;
-    /**
-     * The name of the entity type to which the link points (the "parent" entity in the relationship).
-     */
-    foreignEntityType;
-    /**
-     * The foreign key value identifying the specific instance of the foreign entity to which the link belongs. While it is a string, it represents the value of a `ForeignKey` attribute in the related entity.
-     */
-    foreignKey;
-    /**
-     * The timestamp marking when the link was created
-     */
-    createdAt;
-    /**
-     * The timestamp marking the last update to the link. Initially set to the same value as `createdAt`.
-     */
-    updatedAt;
-    constructor(item) {
-        if (item !== undefined) {
-            Object.assign(this, item);
-        }
-    }
-    /**
-     * A static method to construct a `BelongsToLinkProps` object with specified properties, including auto-generated `id` and timestamp fields. This method facilitates the creation of new link instances without directly instantiating the class.
-     * @param {string} foreignEntityType - The name of the entity type to which the new link will belong.
-     * @param {string} foreignKey - The foreign key value identifying the specific instance of the foreign entity.
-     * @returns {BelongsToLinkProps} - A new `BelongsToLinkProps` object ready for use in creating or managing a "BelongsTo" relationship.
-     */
-    static build(foreignEntityType, foreignKey) {
-        const createdAt = new Date();
-        return {
-            id: (0, uuid_1.v4)(),
-            type: BelongsToLink.name,
-            foreignKey,
-            foreignEntityType,
-            createdAt,
-            updatedAt: createdAt
-        };
-    }
-}
-exports.default = BelongsToLink;