@infra-blocks/aws-dynamodb 0.26.0 → 0.27.0

package/lib/esm/commands/expressions/condition/comparisons.js

@@ -0,0 +1,200 @@
+import { unreachable } from "@infra-blocks/types";
+import { ConditionExpression } from "./expression.js";
+// TODO: don't export publicly through index.
+export function comparison(params) {
+    if (isBetween(params)) {
+        return between(params);
+    }
+    if (isEquals(params)) {
+        return equals(params);
+    }
+    if (isGreaterThan(params)) {
+        return greaterThan(params);
+    }
+    if (isGreaterThanOrEquals(params)) {
+        return greaterThanOrEquals(params);
+    }
+    if (isIn(params)) {
+        return inComparison(params);
+    }
+    if (isLowerThan(params)) {
+        return lowerThan(params);
+    }
+    if (isLowerThanOrEquals(params)) {
+        return lowerThanOrEquals(params);
+    }
+    if (isNotEquals(params)) {
+        return notEquals(params);
+    }
+    unreachable(params);
+}
+export function isComparison(params) {
+    const casted = params;
+    return (isBetween(casted) ||
+        isEquals(casted) ||
+        isGreaterThan(casted) ||
+        isGreaterThanOrEquals(casted) ||
+        isIn(casted) ||
+        isLowerThan(casted) ||
+        isLowerThanOrEquals(casted) ||
+        isNotEquals(casted));
+}
+/**
+ * Returns a condition that uses the `BETWEEN` operator.
+ *
+ * Both bounds are inclusive, meaning that the returned condition corresponds to `lower <= lhs <= upper`.
+ *
+ * @param params - The parameters of the `BETWEEN` comparison. The first element contains the left-hand side operand,
+ * the third element contains the lower inclusive bound, and the fifth element contains the upper inclusive bound.
+ *
+ * @returns A {@link ConditionExpression} that evaluates to true if this operand is within the provided bounds.
+ *
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Comparators
+ */
+function between(params) {
+    return ConditionExpression.from({
+        stringify: ({ names, values }) => {
+            return `${params[0].substitute({ names, values })} BETWEEN ${params[2].substitute({ names, values })} AND ${params[4].substitute({ names, values })}`;
+        },
+    });
+}
+function isBetween(value) {
+    return value[1] === "BETWEEN" && value[3] === "AND";
+}
+/**
+ * Returns a condition that uses the `=` operator.
+ *
+ * @param params - The parameters of the `=` comparison. The first element contains the left-hand side operand,
+ * and the third element contains the right-hand side operand.
+ *
+ * @returns A {@link ConditionExpression} that evaluates to true if this operand is equal to the provided one.
+ *
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Comparators
+ */
+function equals(params) {
+    return binaryOperation(params);
+}
+function isEquals(value) {
+    return value[1] === "=";
+}
+/**
+ * Returns a condition that uses the `>` operator.
+ *
+ * @param params - The parameters of the `>` comparison. The first element contains the left-hand side operand,
+ * the third element contains the right-hand side operand.
+ *
+ * @returns A {@link ConditionExpression} that evaluates to true if this operand is greater than the provided one.
+ *
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Comparators
+ */
+function greaterThan(params) {
+    return binaryOperation(params);
+}
+function isGreaterThan(value) {
+    return value[1] === ">";
+}
+/**
+ * Returns a condition that uses the `>=` operator.
+ *
+ * @param params - The parameters of the `>=` comparison. The first element contains the left-hand side operand,
+ * the third element contains the right-hand side operand.
+ *
+ * @returns A {@link ConditionExpression} that evaluates to true if this operand is greater than or equal to the provided one.
+ *
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Comparators
+ */
+function greaterThanOrEquals(params) {
+    return binaryOperation(params);
+}
+function isGreaterThanOrEquals(value) {
+    return value[1] === ">=";
+}
+/**
+ * Returns a condition that uses the `IN` operator.
+ *
+ * This function throws if the list of elements to compared against is empty or exceeds 100 elements.
+ *
+ * @param params - The parameters of the `IN` comparison. The first element contains the left-hand side operand,
+ * the third element contains the list of elements to compare against.
+ *
+ * @returns A {@link ConditionExpression} that evaluates to true if this operand is equal to any of the provided ones.
+ *
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Comparators
+ */
+function inComparison(params) {
+    const containerElements = params[2];
+    // TODO: unit test those limits
+    if (containerElements.length === 0) {
+        throw new Error("the IN operator requires at least one operand.");
+    }
+    if (containerElements.length > 100) {
+        throw new Error(`up to 100 operands are support for the IN operator, got ${containerElements.length}`);
+    }
+    return ConditionExpression.from({
+        stringify: ({ names, values }) => {
+            const operands = containerElements
+                .map((operand) => operand.substitute({ names, values }))
+                .join(",");
+            return `${params[0].substitute({ names, values })} IN (${operands})`;
+        },
+    });
+}
+function isIn(value) {
+    return value[1] === "IN";
+}
+/**
+ * Returns a condition that uses the `<` operator
+ *
+ * @param params - The parameters of the `<` comparison. The first element contains the left-hand side operand,
+ * the third element contains the right-hand side operand.
+ *
+ * @returns A {@link ConditionExpression} that evaluates to true if this operand is lower than the provided one.
+ *
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Comparators
+ */
+function lowerThan(params) {
+    return binaryOperation(params);
+}
+function isLowerThan(value) {
+    return value[1] === "<";
+}
+/**
+ * Returns a condition that uses the `<=` operator.
+ *
+ * @param params - The parameters of the `<=` comparison. The first element contains the left-hand side operand,
+ * the third element contains the right-hand side operand.
+ *
+ * @returns A {@link ConditionExpression} that evaluates to true if this operand is lower than or equal to the provided one.
+ *
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Comparators
+ */
+function lowerThanOrEquals(params) {
+    return binaryOperation(params);
+}
+function isLowerThanOrEquals(value) {
+    return value[1] === "<=";
+}
+/**
+ * Returns a condition that uses the `<>` operator.
+ *
+ * @param params - The parameters of the `<>` comparison. The first element contains the left-hand side operand,
+ * the third element contains the right-hand side operand.
+ *
+ * @returns A {@link ConditionExpression} that evaluates to true if this operand is not equal to the provided one.
+ *
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Comparators
+ */
+function notEquals(params) {
+    return binaryOperation(params);
+}
+function isNotEquals(value) {
+    return value[1] === "<>";
+}
+function binaryOperation(params) {
+    return ConditionExpression.from({
+        stringify: ({ names, values }) => {
+            return `${params[0].substitute({ names, values })} ${params[1]} ${params[2].substitute({ names, values })}`;
+        },
+    });
+}
+//# sourceMappingURL=comparisons.js.map

package/lib/esm/commands/expressions/condition/comparisons.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"comparisons.js","sourceRoot":"","sources":["../../../../../src/commands/expressions/condition/comparisons.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAQlD,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAgCtD,6CAA6C;AAC7C,MAAM,UAAU,UAAU,CACxB,MAAiC;IAEjC,IAAI,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;QACtB,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC;IACzB,CAAC;IACD,IAAI,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACrB,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC;IACD,IAAI,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1B,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;IACD,IAAI,qBAAqB,CAAC,MAAM,CAAC,EAAE,CAAC;QAClC,OAAO,mBAAmB,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACjB,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC;IAC9B,CAAC;IACD,IAAI,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;QACxB,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC;IAC3B,CAAC;IACD,IAAI,mBAAmB,CAAC,MAAM,CAAC,EAAE,CAAC;QAChC,OAAO,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IACD,IAAI,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;QACxB,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC;IAC3B,CAAC;IACD,WAAW,CAAC,MAAM,CAAC,CAAC;AACtB,CAAC;AAED,MAAM,UAAU,YAAY,CAC1B,MAAuB;IAEvB,MAAM,MAAM,GAAG,MAAmC,CAAC;IACnD,OAAO,CACL,SAAS,CAAC,MAAM,CAAC;QACjB,QAAQ,CAAC,MAAM,CAAC;QAChB,aAAa,CAAC,MAAM,CAAC;QACrB,qBAAqB,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,MAAM,CAAC;QACZ,WAAW,CAAC,MAAM,CAAC;QACnB,mBAAmB,CAAC,MAAM,CAAC;QAC3B,WAAW,CAAC,MAAM,CAAC,CACpB,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAS,OAAO,CAAC,MAAe;IAC9B,OAAO,mBAAmB,CAAC,IAAI,CAAC;QAC9B,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE;YAC/B,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,YAAY,MAAM,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,QAAQ,MAAM,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;QACxJ,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED,SAAS,SAAS,CAAC,KAAgC;IACjD,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,SAAS,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC;AACtD,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,MAAM,CAAC,MAAc;IAC5B,OAAO,eAAe,CAAC,MAAM,CAAC,CAAC;AACjC,CAAC;AAED,SAAS,QAAQ,CAAC,KAAgC;IAChD,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC;AAC1B,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,WAAW,CAAC,MAAmB;IACtC,OAAO,eAAe,CAAC,MAAM,CAAC,CAAC;AACjC,CAAC;AAED,SAAS,aAAa,CAAC,KAAgC;IACrD,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC;AAC1B,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,mBAAmB,CAAC,MAA2B;IACtD,OAAO,eAAe,CAAC,MAAM,CAAC,CAAC;AACjC,CAAC;AAED,SAAS,qBAAqB,CAC5B,KAAgC;IAEhC,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;AAC3B,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAS,YAAY,CAAC,MAAU;IAC9B,MAAM,iBAAiB,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IACpC,+BAA+B;IAC/B,IAAI,iBAAiB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;IACpE,CAAC;IACD,IAAI,iBAAiB,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CACb,2DAA2D,iBAAiB,CAAC,MAAM,EAAE,CACtF,CAAC;IACJ,CAAC;IAED,OAAO,mBAAmB,CAAC,IAAI,CAAC;QAC9B,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE;YAC/B,MAAM,QAAQ,GAAG,iBAAiB;iBAC/B,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAE,OAAmB,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;iBACpE,IAAI,CAAC,GAAG,CAAC,CAAC;YACb,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,QAAQ,QAAQ,GAAG,CAAC;QACvE,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED,SAAS,IAAI,CAAC,KAAgC;IAC5C,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;AAC3B,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,SAAS,CAAC,MAAiB;IAClC,OAAO,eAAe,CAAC,MAAM,CAAC,CAAC;AACjC,CAAC;AAED,SAAS,WAAW,CAAC,KAAgC;IACnD,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC;AAC1B,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,iBAAiB,CAAC,MAAyB;IAClD,OAAO,eAAe,CAAC,MAAM,CAAC,CAAC;AACjC,CAAC;AAED,SAAS,mBAAmB,CAC1B,KAAgC;IAEhC,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;AAC3B,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,SAAS,CAAC,MAAiB;IAClC,OAAO,eAAe,CAAC,MAAM,CAAC,CAAC;AACjC,CAAC;AAED,SAAS,WAAW,CAAC,KAAgC;IACnD,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;AAC3B,CAAC;AAED,SAAS,eAAe,CACtB,MAAoC;IAEpC,OAAO,mBAAmB,CAAC,IAAI,CAAC;QAC9B,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE;YAC/B,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;QAC9G,CAAC;KACF,CAAC,CAAC;AACL,CAAC"}

package/lib/esm/commands/expressions/condition/condition.d.ts

@@ -0,0 +1,24 @@
+import type { AttributeValue } from "../../../types.js";
+import type { AttributeNames } from "../../attributes/names.js";
+import type { AttributeValues } from "../../attributes/values.js";
+import type { IExpression } from "../expression.js";
+import type { PathOperand } from "../operands/path.js";
+import type { ValueOperand } from "../operands/value.js";
+import type { ConditionComparisonParams } from "./comparisons.js";
+import { type ConditionExpression } from "./expression.js";
+import type { Size } from "./size.js";
+export type ConditionParams = ConditionExpression | ConditionComparisonParams | ConditionExpression;
+export type ConditionOperand<T extends AttributeValue = AttributeValue> = PathOperand | ValueOperand<T> | Size;
+export declare class Condition implements IExpression {
+    private readonly inner;
+    private constructor();
+    stringify(params: {
+        names: AttributeNames;
+        values: AttributeValues;
+    }): string;
+    /**
+     * @private
+     */
+    static from(params: ConditionParams): Condition;
+}
+export declare function condition(params: ConditionParams): Condition;

package/lib/esm/commands/expressions/condition/condition.js

@@ -0,0 +1,22 @@
+import { conditionExpression } from "./expression.js";
+// TODO: remove/rename?
+export class Condition {
+    inner;
+    constructor(params) {
+        this.inner = params;
+    }
+    stringify(params) {
+        return this.inner.stringify(params);
+    }
+    /**
+     * @private
+     */
+    static from(params) {
+        return new Condition(conditionExpression(params));
+    }
+}
+// TODO: not meant to be exported publicly.
+export function condition(params) {
+    return Condition.from(params);
+}
+//# sourceMappingURL=condition.js.map

package/lib/esm/commands/expressions/condition/condition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"condition.js","sourceRoot":"","sources":["../../../../../src/commands/expressions/condition/condition.ts"],"names":[],"mappings":"AAOA,OAAO,EAA4B,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAahF,uBAAuB;AACvB,MAAM,OAAO,SAAS;IACH,KAAK,CAAsB;IAE5C,YAAoB,MAA2B;QAC7C,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC;IACtB,CAAC;IAED,SAAS,CAAC,MAGT;QACC,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IACtC,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,IAAI,CAAC,MAAuB;QACjC,OAAO,IAAI,SAAS,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC;IACpD,CAAC;CACF;AAED,2CAA2C;AAC3C,MAAM,UAAU,SAAS,CAAC,MAAuB;IAC/C,OAAO,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AAChC,CAAC"}

package/lib/esm/commands/expressions/condition/expression.d.ts

@@ -0,0 +1,19 @@
+import type { AttributeNames } from "../../attributes/names.js";
+import type { AttributeValues } from "../../attributes/values.js";
+import type { IExpression, Stringifier } from "../expression.js";
+import type { ConditionParams } from "./condition.js";
+export declare class ConditionExpression implements IExpression {
+    private readonly stringifier;
+    private constructor();
+    stringify(params: {
+        names: AttributeNames;
+        values: AttributeValues;
+    }): string;
+    /**
+     * @private
+     */
+    static from(params: {
+        stringify: Stringifier;
+    }): ConditionExpression;
+}
+export declare function conditionExpression(params: ConditionParams): ConditionExpression;

package/lib/esm/commands/expressions/condition/expression.js

@@ -0,0 +1,23 @@
+import { comparison, isComparison } from "./comparisons.js";
+export class ConditionExpression {
+    stringifier;
+    constructor(stringifier) {
+        this.stringifier = stringifier;
+    }
+    stringify(params) {
+        const { names, values } = params;
+        return this.stringifier({ names, values });
+    }
+    /**
+     * @private
+     */
+    static from(params) {
+        const { stringify } = params;
+        return new ConditionExpression(stringify);
+    }
+}
+// TODO: module visibility.
+export function conditionExpression(params) {
+    return isComparison(params) ? comparison(params) : params;
+}
+//# sourceMappingURL=expression.js.map

package/lib/esm/commands/expressions/condition/expression.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"expression.js","sourceRoot":"","sources":["../../../../../src/commands/expressions/condition/expression.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAG5D,MAAM,OAAO,mBAAmB;IACb,WAAW,CAAc;IAE1C,YAAoB,WAAwB;QAC1C,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;IAED,SAAS,CAAC,MAGT;QACC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QACjC,OAAO,IAAI,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;IAC7C,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,IAAI,CAAC,MAAkC;QAC5C,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;QAC7B,OAAO,IAAI,mBAAmB,CAAC,SAAS,CAAC,CAAC;IAC5C,CAAC;CACF;AAED,2BAA2B;AAC3B,MAAM,UAAU,mBAAmB,CACjC,MAAuB;IAEvB,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;AAC5D,CAAC"}

package/lib/esm/commands/expressions/condition/functions.d.ts

@@ -0,0 +1,70 @@
+import type { NativeBinary, NativeString, NativeType } from "../../../types.js";
+import type { PathOperand } from "../operands/path.js";
+import type { ValueOperand } from "../operands/value.js";
+import { ConditionExpression } from "./expression.js";
+import type { Size } from "./size.js";
+/**
+ * Returns a condition that uses the `attribute_exists` function.
+ *
+ * @param attribute - The attribute path to check for existence.
+ * @returns A {@link ConditionExpression} that evaluates to true if the provided attribute path exists.
+ *
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Functions
+ */
+export declare function attributeExists(attribute: PathOperand): ConditionExpression;
+/**
+ * Returns a condition that uses the `attribute_not_exists` function.
+ *
+ * @param attribute - The attribute path to check for non-existence.
+ * @returns A {@link ConditionExpression} that evaluates to true if the provided attribute path does not exist.
+ *
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Functions
+ */
+export declare function attributeNotExists(attribute: PathOperand): ConditionExpression;
+/**
+ * Returns a condition that uses the `attribute_type` function.
+ *
+ * @param attribute - The attribute path to check.
+ * @param type - The expected type of the attribute.
+ *
+ * @returns A {@link ConditionExpression} that evaluates to true if the attribute is of the expected type.
+ *
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Functions
+ */
+export declare function attributeType(attribute: PathOperand, type: ValueOperand<NativeType>): ConditionExpression;
+/**
+ * This type aggregates the types of operands that can be used with the {@link beginsWith} function.
+ *
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Functions
+ */
+export type BeginsWithOperand = PathOperand | ValueOperand<NativeString | NativeBinary>;
+/**
+ * Returns a condition that uses the `begins_with` function.
+ *
+ * @param first - The first function operand, which is the attribute or value to check.
+ * @param second - The second function operand, which is the prefix to validate against.
+ *
+ * @returns A {@link ConditionExpression} that evaluates to true if the first operand begins with the second.
+ *
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Functions
+ */
+export declare function beginsWith(first: BeginsWithOperand, second: BeginsWithOperand): ConditionExpression;
+/**
+ * This type aggregates the types of operands that can be used as the first operand of the {@link contains} function.
+ */
+export type ContainsFirstOperand = PathOperand | ValueOperand;
+/**
+ * This type aggregates the types of operands that can be used as the second operand of the {@link contains} function.
+ */
+export type ContainsSecondOperand = PathOperand | ValueOperand | Size;
+/**
+ * Returns a condition that uses the `contains` function.
+ *
+ * @param first - The first function operand, which is the attribute or value to check.
+ * @param second - The second function operand, which is the value to check for containment.
+ *
+ * @returns A {@link ConditionExpression} that evaluates to true if this operand contains the provided one.
+ *
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Functions
+ */
+export declare function contains(first: ContainsFirstOperand, second: ContainsSecondOperand): ConditionExpression;

package/lib/esm/commands/expressions/condition/functions.js

@@ -0,0 +1,73 @@
+import { ConditionExpression } from "./expression.js";
+/**
+ * Returns a condition that uses the `attribute_exists` function.
+ *
+ * @param attribute - The attribute path to check for existence.
+ * @returns A {@link ConditionExpression} that evaluates to true if the provided attribute path exists.
+ *
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Functions
+ */
+export function attributeExists(attribute) {
+    return ConditionExpression.from({
+        stringify: ({ names }) => `attribute_exists(${attribute.substitute({ names })})`,
+    });
+}
+/**
+ * Returns a condition that uses the `attribute_not_exists` function.
+ *
+ * @param attribute - The attribute path to check for non-existence.
+ * @returns A {@link ConditionExpression} that evaluates to true if the provided attribute path does not exist.
+ *
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Functions
+ */
+export function attributeNotExists(attribute) {
+    return ConditionExpression.from({
+        stringify: ({ names }) => `attribute_not_exists(${attribute.substitute({ names })})`,
+    });
+}
+/**
+ * Returns a condition that uses the `attribute_type` function.
+ *
+ * @param attribute - The attribute path to check.
+ * @param type - The expected type of the attribute.
+ *
+ * @returns A {@link ConditionExpression} that evaluates to true if the attribute is of the expected type.
+ *
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Functions
+ */
+export function attributeType(attribute, type) {
+    return ConditionExpression.from({
+        stringify: ({ names, values }) => `attribute_type(${attribute.substitute({ names })}, ${type.substitute({ values })})`,
+    });
+}
+/**
+ * Returns a condition that uses the `begins_with` function.
+ *
+ * @param first - The first function operand, which is the attribute or value to check.
+ * @param second - The second function operand, which is the prefix to validate against.
+ *
+ * @returns A {@link ConditionExpression} that evaluates to true if the first operand begins with the second.
+ *
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Functions
+ */
+export function beginsWith(first, second) {
+    return ConditionExpression.from({
+        stringify: ({ names, values }) => `begins_with(${first.substitute({ names, values })}, ${second.substitute({ names, values })})`,
+    });
+}
+/**
+ * Returns a condition that uses the `contains` function.
+ *
+ * @param first - The first function operand, which is the attribute or value to check.
+ * @param second - The second function operand, which is the value to check for containment.
+ *
+ * @returns A {@link ConditionExpression} that evaluates to true if this operand contains the provided one.
+ *
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Functions
+ */
+export function contains(first, second) {
+    return ConditionExpression.from({
+        stringify: ({ names, values }) => `contains(${first.substitute({ names, values })}, ${second.substitute({ names, values })})`,
+    });
+}
+//# sourceMappingURL=functions.js.map

package/lib/esm/commands/expressions/condition/functions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"functions.js","sourceRoot":"","sources":["../../../../../src/commands/expressions/condition/functions.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAGtD;;;;;;;GAOG;AACH,MAAM,UAAU,eAAe,CAAC,SAAsB;IACpD,OAAO,mBAAmB,CAAC,IAAI,CAAC;QAC9B,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CACvB,oBAAoB,SAAS,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG;KACzD,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,kBAAkB,CAChC,SAAsB;IAEtB,OAAO,mBAAmB,CAAC,IAAI,CAAC;QAC9B,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CACvB,wBAAwB,SAAS,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG;KAC7D,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,aAAa,CAC3B,SAAsB,EACtB,IAA8B;IAE9B,OAAO,mBAAmB,CAAC,IAAI,CAAC;QAC9B,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,CAC/B,kBAAkB,SAAS,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG;KACvF,CAAC,CAAC;AACL,CAAC;AAWD;;;;;;;;;GASG;AACH,MAAM,UAAU,UAAU,CACxB,KAAwB,EACxB,MAAyB;IAEzB,OAAO,mBAAmB,CAAC,IAAI,CAAC;QAC9B,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,CAC/B,eAAe,KAAK,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,KAAK,MAAM,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,GAAG;KACjG,CAAC,CAAC;AACL,CAAC;AAWD;;;;;;;;;GASG;AACH,MAAM,UAAU,QAAQ,CACtB,KAA2B,EAC3B,MAA6B;IAE7B,OAAO,mBAAmB,CAAC,IAAI,CAAC;QAC9B,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,CAC/B,YAAY,KAAK,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,KAAK,MAAM,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,GAAG;KAC9F,CAAC,CAAC;AACL,CAAC"}

package/lib/esm/commands/expressions/condition/index.d.ts

@@ -0,0 +1,5 @@
+export type { Between, ComparableOperand, ComparableValue, ConditionComparisonParams, Equals, GreaterThan, GreaterThanOrEquals, In, LowerThan, LowerThanOrEquals, NotEquals, } from "./comparisons.js";
+export * from "./condition.js";
+export * from "./functions.js";
+export * from "./logic.js";
+export * from "./size.js";

package/lib/esm/commands/expressions/condition/index.js

@@ -0,0 +1,5 @@
+export * from "./condition.js";
+export * from "./functions.js";
+export * from "./logic.js";
+export * from "./size.js";
+//# sourceMappingURL=index.js.map

package/lib/esm/commands/expressions/condition/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/commands/expressions/condition/index.ts"],"names":[],"mappings":"AAaA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC"}

package/lib/esm/commands/expressions/condition/logic.d.ts

@@ -0,0 +1,34 @@
+import type { ConditionParams } from "./condition.js";
+import { ConditionExpression } from "./expression.js";
+/**
+ * Negates the provided condition using the `NOT` operator.
+ *
+ * @param condition - The condition to negate.
+ *
+ * @returns A {@link ConditionExpression} that evaluates to the opposite of what the provided condition evaluates to.
+ *
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.LogicalEvaluations
+ */
+export declare function not(condition: ConditionParams): ConditionExpression;
+/**
+ * Returns a condition that combines the provided ones using the `AND` operator.
+ *
+ * @param lhs - The first condition to combine.
+ * @param rhs - The second condition to combine.
+ *
+ * @returns A {@link ConditionExpression} that evaluates to true only if both conditions evaluate to true.
+ *
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.LogicalEvaluations
+ */
+export declare function and(lhs: ConditionParams, rhs: ConditionParams): ConditionExpression;
+/**
+ * Returns a condition that combines the provided ones using the `OR` operator.
+ *
+ * @param lhs - The first condition to combine.
+ * @param rhs - The second condition to combine.
+ *
+ * @returns A {@link ConditionExpression} that evaluates to true if any conditions evaluate to true.
+ *
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.LogicalEvaluations
+ */
+export declare function or(lhs: ConditionParams, rhs: ConditionParams): ConditionExpression;

package/lib/esm/commands/expressions/condition/logic.js

@@ -0,0 +1,63 @@
+import { ConditionExpression, conditionExpression } from "./expression.js";
+/**
+ * Negates the provided condition using the `NOT` operator.
+ *
+ * @param condition - The condition to negate.
+ *
+ * @returns A {@link ConditionExpression} that evaluates to the opposite of what the provided condition evaluates to.
+ *
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.LogicalEvaluations
+ */
+export function not(condition) {
+    const expression = conditionExpression(condition);
+    return ConditionExpression.from({
+        stringify: ({ names, values }) => {
+            return `(NOT ${expression.stringify({ names, values })})`;
+        },
+    });
+}
+/**
+ * Returns a condition that combines the provided ones using the `AND` operator.
+ *
+ * @param lhs - The first condition to combine.
+ * @param rhs - The second condition to combine.
+ *
+ * @returns A {@link ConditionExpression} that evaluates to true only if both conditions evaluate to true.
+ *
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.LogicalEvaluations
+ */
+export function and(lhs, rhs) {
+    const left = conditionExpression(lhs);
+    const right = conditionExpression(rhs);
+    return ConditionExpression.from({
+        stringify: ({ names, values }) => {
+            return `(${left.stringify({ names, values })} AND ${right.stringify({
+                names,
+                values,
+            })})`;
+        },
+    });
+}
+/**
+ * Returns a condition that combines the provided ones using the `OR` operator.
+ *
+ * @param lhs - The first condition to combine.
+ * @param rhs - The second condition to combine.
+ *
+ * @returns A {@link ConditionExpression} that evaluates to true if any conditions evaluate to true.
+ *
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.LogicalEvaluations
+ */
+export function or(lhs, rhs) {
+    const left = conditionExpression(lhs);
+    const right = conditionExpression(rhs);
+    return ConditionExpression.from({
+        stringify: ({ names, values }) => {
+            return `(${left.stringify({ names, values })} OR ${right.stringify({
+                names,
+                values,
+            })})`;
+        },
+    });
+}
+//# sourceMappingURL=logic.js.map

package/lib/esm/commands/expressions/condition/logic.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logic.js","sourceRoot":"","sources":["../../../../../src/commands/expressions/condition/logic.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAE3E;;;;;;;;GAQG;AACH,MAAM,UAAU,GAAG,CAAC,SAA0B;IAC5C,MAAM,UAAU,GAAG,mBAAmB,CAAC,SAAS,CAAC,CAAC;IAClD,OAAO,mBAAmB,CAAC,IAAI,CAAC;QAC9B,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE;YAC/B,OAAO,QAAQ,UAAU,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC;QAC5D,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,GAAG,CACjB,GAAoB,EACpB,GAAoB;IAEpB,MAAM,IAAI,GAAG,mBAAmB,CAAC,GAAG,CAAC,CAAC;IACtC,MAAM,KAAK,GAAG,mBAAmB,CAAC,GAAG,CAAC,CAAC;IACvC,OAAO,mBAAmB,CAAC,IAAI,CAAC;QAC9B,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE;YAC/B,OAAO,IAAI,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,QAAQ,KAAK,CAAC,SAAS,CAAC;gBAClE,KAAK;gBACL,MAAM;aACP,CAAC,GAAG,CAAC;QACR,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,EAAE,CAChB,GAAoB,EACpB,GAAoB;IAEpB,MAAM,IAAI,GAAG,mBAAmB,CAAC,GAAG,CAAC,CAAC;IACtC,MAAM,KAAK,GAAG,mBAAmB,CAAC,GAAG,CAAC,CAAC;IACvC,OAAO,mBAAmB,CAAC,IAAI,CAAC;QAC9B,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE;YAC/B,OAAO,IAAI,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,OAAO,KAAK,CAAC,SAAS,CAAC;gBACjE,KAAK;gBACL,MAAM;aACP,CAAC,GAAG,CAAC;QACR,CAAC;KACF,CAAC,CAAC;AACL,CAAC"}

package/lib/esm/commands/expressions/condition/size.d.ts

@@ -0,0 +1,37 @@
+import type { NativeBinary, NativeList, NativeMap, NativeSet, NativeString } from "../../../types.js";
+import type { AttributeNames, AttributeValues } from "../../attributes/index.js";
+import type { PathOperand } from "../operands/path.js";
+import type { IOperand } from "../operands/type.js";
+import type { ValueOperand } from "../operands/value.js";
+/**
+ * This type aggregates the types of operands that can be used with the {@link size} function.
+ *
+ * @see size
+ * @see PathOperand
+ * @see ValueOperand
+ */
+export type SizeOperand = PathOperand | ValueOperand<NativeBinary | NativeList | NativeMap | NativeSet | NativeString>;
+/**
+ * A type representing the result of the {@link size} function as an operand to be used in expressions.
+ */
+export declare class Size implements IOperand {
+    private readonly inner;
+    constructor(operand: SizeOperand);
+    substitute(params: {
+        names: AttributeNames;
+        values: AttributeValues;
+    }): string;
+    /**
+     * @private
+     */
+    static from(operand: SizeOperand): Size;
+}
+/**
+ * Creates a new {@link Size} operand to be nested in expressions.
+ *
+ * @param operand - The operand to calculate the size of.
+ * @returns A new {@link Size} operand.
+ *
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Functions
+ */
+export declare function size(operand: SizeOperand): Size;

package/lib/esm/commands/expressions/condition/size.js

@@ -0,0 +1,30 @@
+/**
+ * A type representing the result of the {@link size} function as an operand to be used in expressions.
+ */
+export class Size {
+    inner;
+    constructor(operand) {
+        this.inner = operand;
+    }
+    substitute(params) {
+        return `size(${this.inner.substitute(params)})`;
+    }
+    /**
+     * @private
+     */
+    static from(operand) {
+        return new Size(operand);
+    }
+}
+/**
+ * Creates a new {@link Size} operand to be nested in expressions.
+ *
+ * @param operand - The operand to calculate the size of.
+ * @returns A new {@link Size} operand.
+ *
+ * @see https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Functions
+ */
+export function size(operand) {
+    return Size.from(operand);
+}
+//# sourceMappingURL=size.js.map

package/lib/esm/commands/expressions/condition/size.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"size.js","sourceRoot":"","sources":["../../../../../src/commands/expressions/condition/size.ts"],"names":[],"mappings":"AA4BA;;GAEG;AACH,MAAM,OAAO,IAAI;IACE,KAAK,CAAc;IAEpC,YAAY,OAAoB;QAC9B,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC;IACvB,CAAC;IAED,UAAU,CAAC,MAGV;QACC,OAAO,QAAQ,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC;IAClD,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,IAAI,CAAC,OAAoB;QAC9B,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,IAAI,CAAC,OAAoB;IACvC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AAC5B,CAAC"}