@nerdware/ddb-single-table/dist/esm/IOActions/transformItem.js

A schema-based DynamoDB modeling tool, high-level API, and type-generator built to supercharge single-table designs!⚡

import { isFunction } from "@nerdware/ts-type-safety-utils";
/**
 * This `IOAction` uses the `transformItem` method (if defined in the Model's
 * schema options), to transform an entire item before it is sent to the database.
 * This is useful for potentially adding/removing/renaming item properties, however
 * **it may necessitate providing explicit Model type params for `ItemOutput` and/or
 * `ItemInput`, depending on the changes made.**
 */
export const transformItem = function (item, { schemaOptions, ioDirection }) {
    // If schemaOptions has transformItem toDB/fromDB, pass the existing item into the fn
    const transformItem = schemaOptions.transformItem?.[ioDirection];
    // If the new item has type mismatches, they're caught by the `typeChecking` method
    if (isFunction(transformItem))
        item = transformItem(item);
    return item;
};