@lafken/dynamo 0.14.1 → 0.14.3

package/lib/main/table/table.types.d.ts

@@ -27,6 +27,13 @@ interface IndexBase<T extends Function> {
      */
     projection?: (keyof T['prototype'])[] | 'ALL';
 }
+/**
+ * Filter expression for a single DynamoDB attribute.
+ *
+ * Supports exact matches, `anything-but`, `exists`, `prefix`, and empty-string
+ * conditions. Values can be provided as a single value, an array of values,
+ * or null.
+ */
 type AttributeFilter<T> = {
     [key in keyof T]?: (T[key] | {
         'anything-but': T[key][];
@@ -359,18 +366,47 @@ export interface ExternalTableMetadata extends Omit<ExternalTableProps<any>, 'na
     name: string;
 }
 export type TableMetadata = InternalTableMetadata | ExternalTableMetadata;
+/**
+ * Base properties for a DynamoDB table field definition.
+ */
 export interface FieldProps {
+    /** The TypeScript constructor that determines the field's DynamoDB type. */
     type?: StringConstructor | NumberConstructor | BooleanConstructor | [Function] | Function;
 }
+/**
+ * Resolved metadata for a DynamoDB table field after the `@Field`
+ * decorator is processed.
+ */
 export interface FieldMetadata {
+    /** Property name as declared on the class. */
     name: string;
+    /** Resolved DynamoDB type (e.g. `'string'`, `'number'`, `'boolean'`). */
     type: FieldTypes;
 }
+/**
+ * Map of property names to their resolved DynamoDB field metadata.
+ */
 export type FieldsMetadata = Record<string, FieldMetadata>;
+/**
+ * Sentinel type used internally to mark DynamoDB partition key properties.
+ * Properties typed with `PrimaryPartition<T>` are recognized as partition
+ * key candidates during table metadata resolution.
+ */
 type Partition = {
     __special: unknown;
 };
+/**
+ * Marks a type as a DynamoDB partition key candidate.
+ *
+ * @typeParam T - The type to mark as a partition key.
+ */
 export type PrimaryPartition<T = never> = T | (T & Partition);
+/**
+ * Extracts only the partition key properties from a DynamoDB table class.
+ *
+ * Filters the keys of `T` to include only those whose type includes the
+ * {@link Partition} sentinel, giving the list of valid partition key fields.
+ */
 export type TablePartition<T> = {
     [K in keyof T as [Extract<T[K], Partition>] extends [never] ? never : K]: T[K];
 };

package/lib/service/query-builder/query-builder.types.d.ts

@@ -12,7 +12,8 @@ export type OperationExpression<E> = OnlyOne<{
     greaterOrEqualThan: E;
     between: [E, E];
 }>;
-export type InExpression<E extends string | number> = {
+type UnwrapBigInt<T> = NonNullable<T> extends BigInt ? bigint : NonNullable<T>;
+export type InExpression<E extends string | number | bigint> = {
     in: E[];
 };
 export type NullExpression = OnlyOne<{
@@ -30,7 +31,7 @@ export type CommonExpression<E> = OnlyOne<{
     notEqual: E;
 } & NullExpression>;
 export type Filter<E> = {
-    [key in keyof E]?: NonNullable<E[key]> extends PrimaryPartition<number> ? NonNullable<E[key]> | OnlyOne<OperationExpression<number> & CommonExpression<number> & InExpression<number>> : NonNullable<E[key]> extends PrimaryPartition<string> ? NonNullable<E[key]> | OnlyOne<StringExpression & StringFilterExpression & CommonExpression<string> & InExpression<string>> : NonNullable<E[key]> extends string | number | boolean | Date | null ? NonNullable<E[key]> | (NonNullable<E[key]> extends number ? OnlyOne<OperationExpression<number> & CommonExpression<number> & InExpression<number>> : NonNullable<E[key]> extends boolean ? CommonExpression<boolean> : NonNullable<E[key]> extends null ? NullExpression : OnlyOne<StringExpression & StringFilterExpression & CommonExpression<string> & InExpression<string>>) : DeepPartial<Filter<E[key]>>;
+    [key in keyof E]?: NonNullable<E[key]> extends PrimaryPartition<number | bigint | BigInt> ? UnwrapBigInt<E[key]> | OnlyOne<OperationExpression<number | bigint> & CommonExpression<number | bigint> & InExpression<number | bigint>> : NonNullable<E[key]> extends PrimaryPartition<string> ? NonNullable<E[key]> | OnlyOne<StringExpression & StringFilterExpression & CommonExpression<string> & InExpression<string>> : NonNullable<E[key]> extends string | number | bigint | BigInt | boolean | Date | null ? UnwrapBigInt<E[key]> | (NonNullable<E[key]> extends number | bigint | BigInt ? OnlyOne<OperationExpression<number | bigint> & CommonExpression<number | bigint> & InExpression<number | bigint>> : NonNullable<E[key]> extends boolean ? CommonExpression<boolean> : NonNullable<E[key]> extends null ? NullExpression : OnlyOne<StringExpression & StringFilterExpression & CommonExpression<string> & InExpression<string>>) : DeepPartial<Filter<E[key]>>;
 };
 export type OrFilter<E> = {
     OR: Array<Filter<E> | AndFilter<E>>;
@@ -42,7 +43,7 @@ export type SortDirectionType = 'asc' | 'desc';
 export type KeyCondition<E> = {
     partition: Partial<OnlyNumberString<E>>;
     sort?: {
-        [key in keyof E as E[key] extends number | string ? key : never]?: E[key] extends PrimaryPartition<number> ? E[key] | OperationExpression<E[key]> : E[key] extends PrimaryPartition<string> ? E[key] | OnlyOne<OperationExpression<E[key]> & StringExpression> : E[key] | (E[key] extends number ? OperationExpression<E[key]> : OnlyOne<OperationExpression<E[key]> | StringExpression>);
+        [key in keyof E as E[key] extends number | string | bigint | BigInt ? key : never]?: E[key] extends PrimaryPartition<number | bigint | BigInt> ? UnwrapBigInt<E[key]> | OperationExpression<UnwrapBigInt<E[key]>> : E[key] extends PrimaryPartition<string> ? UnwrapBigInt<E[key]> | OnlyOne<OperationExpression<UnwrapBigInt<E[key]>> & StringExpression> : UnwrapBigInt<E[key]> | (E[key] extends number | bigint | BigInt ? OperationExpression<UnwrapBigInt<E[key]>> : OnlyOne<OperationExpression<UnwrapBigInt<E[key]>> | StringExpression>);
     };
 };
 export type Item<E extends Function> = {
@@ -138,16 +139,16 @@ export interface QueryResponse<E extends Function> {
     cursor?: Cursor<E['prototype']>;
 }
 export type ObjectToBoolean<T> = {
-    [K in keyof T]?: T[K] extends number | string | boolean | Array<any> | Date ? true : ObjectToBoolean<T[K]> | true;
+    [K in keyof T]?: T[K] extends number | string | bigint | BigInt | boolean | Array<any> | Date ? true : ObjectToBoolean<T[K]> | true;
 };
 interface ExistValue<T> {
     ifNotExistValue: T;
 }
 interface NumericValues<T> extends ExistValue<T> {
-    incrementValue?: number;
-    decrementValue?: number;
+    incrementValue?: number | bigint;
+    decrementValue?: number | bigint;
 }
-export type NumericOrExist<T> = T extends number ? number | OnlyOne<NumericValues<T>> : T extends string | boolean | Array<any> | Date ? T | ExistValue<T> : (T & {
+export type NumericOrExist<T> = NonNullable<T> extends number | bigint | BigInt ? UnwrapBigInt<T> | OnlyOne<NumericValues<UnwrapBigInt<T>>> : T extends string | boolean | Array<any> | Date ? T | ExistValue<T> : (T & {
     ifNotExistValue?: never;
 }) | (ExistValue<T> & {
     [K in keyof T]?: never;
@@ -156,7 +157,7 @@ export type ReplaceValue<T> = {
     [K in keyof T]?: NumericOrExist<T[K]>;
 };
 export type DeepReplaceValue<T> = {
-    [K in keyof T]?: T[K] extends number | string | boolean | Array<any> | Date ? NumericOrExist<T[K]> : ExistValue<T[K]> | DeepReplaceValue<T[K]>;
+    [K in keyof T]?: NonNullable<T[K]> extends number | string | bigint | BigInt | boolean | Array<any> | Date ? NumericOrExist<T[K]> : ExistValue<T[K]> | DeepReplaceValue<T[K]>;
 };
 export type ReturnValueOption = 'all_new' | 'updated_new' | 'all_old' | 'none';
 export type UpdateReturnType<E extends Function, R extends ReturnValueOption | undefined> = R extends 'all_new' | 'all_old' ? Item<E> : R extends 'updated_new' ? Partial<Item<E>> : undefined;

package/lib/service/query-builder/update/update.js

@@ -5,6 +5,25 @@ const client_dynamodb_1 = require("@aws-sdk/client-dynamodb");
 const util_dynamodb_1 = require("@aws-sdk/util-dynamodb");
 const base_1 = require("../base/base");
 const update_utils_1 = require("./update.utils");
+/**
+ * Recursively removes undefined values from an object.
+ * This prevents DynamoDB expression errors when undefined values
+ * are passed in setValues or replaceValues.
+ */
+function removeUndefinedValues(obj) {
+    const result = {};
+    for (const key in obj) {
+        if (obj[key] !== undefined) {
+            if (typeof obj[key] === 'object' && obj[key] !== null && !Array.isArray(obj[key])) {
+                result[key] = removeUndefinedValues(obj[key]);
+            }
+            else {
+                result[key] = obj[key];
+            }
+        }
+    }
+    return result;
+}
 class UpdateBuilder extends base_1.QueryBuilderBase {
     queryOptions;
     command;
@@ -30,17 +49,21 @@ class UpdateBuilder extends base_1.QueryBuilderBase {
     }
     prepare() {
         const { removeValues = {}, replaceValues = {}, setValues = {}, condition, } = this.queryOptions.inputProps;
+        // Remove undefined values from setValues and replaceValues to prevent
+        // DynamoDB expression errors when undefined values are passed
+        const filteredSetValues = removeUndefinedValues(setValues);
+        const filteredReplaceValues = removeUndefinedValues(replaceValues);
         if (Object.keys(removeValues).length > 0 &&
-            Object.keys(replaceValues).length > 0 &&
-            Object.keys(setValues).length > 0) {
+            Object.keys(filteredReplaceValues).length > 0 &&
+            Object.keys(filteredSetValues).length > 0) {
             throw new Error('You must assign a value to update');
         }
         let setExpression = '';
-        if (Object.keys(setValues).length > 0) {
-            setExpression = this.setValues(setValues, true, [], this.expressionGroupCounter++);
+        if (Object.keys(filteredSetValues).length > 0) {
+            setExpression = this.setValues(filteredSetValues, true, [], this.expressionGroupCounter++);
         }
-        if (Object.keys(replaceValues).length > 0) {
-            setExpression += `${setExpression ? ',' : ''} ${this.setValues(replaceValues, false, [], this.expressionGroupCounter++)}`;
+        if (Object.keys(filteredReplaceValues).length > 0) {
+            setExpression += `${setExpression ? ',' : ''} ${this.setValues(filteredReplaceValues, false, [], this.expressionGroupCounter++)}`;
         }
         const removeExpression = this.removeValues(removeValues);
         const keyCondition = this.queryOptions.inputProps.keyCondition;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lafken/dynamo",
-  "version": "0.14.1",
+  "version": "0.14.3",
   "private": false,
   "description": "Define DynamoDB tables using TypeScript decorators - type-safe, declarative infrastructure with Lafken",
   "keywords": [
@@ -59,7 +59,7 @@
     "@aws-sdk/client-dynamodb": "^3.1106.0",
     "@aws-sdk/util-dynamodb": "^3.996.7",
     "reflect-metadata": "^0.2.2",
-    "@lafken/resolver": "0.14.1"
+    "@lafken/resolver": "0.14.3"
   },
   "devDependencies": {
     "@cdktn/provider-aws": "^25.0.0",
@@ -73,13 +73,13 @@
     "typescript": "7.0.2",
     "unplugin-swc": "^1.5.10",
     "vitest": "^4.1.10",
-    "@lafken/common": "0.14.1"
+    "@lafken/common": "0.14.3"
   },
   "peerDependencies": {
     "@cdktn/provider-aws": ">=23.0.0",
     "cdktn": ">=0.22.0",
     "constructs": ">=10.7.0",
-    "@lafken/common": "0.14.1"
+    "@lafken/common": "0.14.3"
   },
   "engines": {
     "node": ">=20.19"