@aws-sdk/util-dynamodb 3.438.0 → 3.441.0

package/dist-cjs/NumberValue.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NumberValue = void 0;
+class NumberValue {
+    constructor(value) {
+        if (typeof value === "object" && "N" in value) {
+            this.value = String(value.N);
+        }
+        else {
+            this.value = String(value);
+        }
+        const valueOf = typeof value.valueOf() === "number" ? value.valueOf() : 0;
+        const imprecise = valueOf > Number.MAX_SAFE_INTEGER ||
+            valueOf < Number.MIN_SAFE_INTEGER ||
+            Math.abs(valueOf) === Infinity ||
+            Number.isNaN(valueOf);
+        if (imprecise) {
+            throw new Error(`NumberValue should not be initialized with an imprecise number=${valueOf}. Use a string instead.`);
+        }
+    }
+    static from(value) {
+        return new NumberValue(value);
+    }
+    toAttributeValue() {
+        return {
+            N: this.toString(),
+        };
+    }
+    toBigInt() {
+        const stringValue = this.toString();
+        return BigInt(stringValue);
+    }
+    toString() {
+        return String(this.value);
+    }
+    valueOf() {
+        return this.toString();
+    }
+}
+exports.NumberValue = NumberValue;

package/dist-cjs/convertToAttr.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.convertToAttr = void 0;
+const NumberValue_1 = require("./NumberValue");
 const convertToAttr = (data, options) => {
     var _a, _b, _c, _d, _e, _f;
     if (data === undefined) {
@@ -34,6 +35,9 @@ const convertToAttr = (data, options) => {
     else if (typeof data === "number" || ((_e = data === null || data === void 0 ? void 0 : data.constructor) === null || _e === void 0 ? void 0 : _e.name) === "Number") {
         return convertToNumberAttr(data);
     }
+    else if (data instanceof NumberValue_1.NumberValue) {
+        return data.toAttributeValue();
+    }
     else if (typeof data === "bigint") {
         return convertToBigIntAttr(data);
     }
@@ -66,7 +70,12 @@ const convertToSetAttr = (set, options) => {
         throw new Error(`Pass a non-empty set, or options.convertEmptyValues=true.`);
     }
     const item = setToOperate.values().next().value;
-    if (typeof item === "number") {
+    if (item instanceof NumberValue_1.NumberValue) {
+        return {
+            NS: Array.from(setToOperate).map((_) => _.toString()),
+        };
+    }
+    else if (typeof item === "number") {
         return {
             NS: Array.from(setToOperate)
                 .map(convertToNumberAttr)

package/dist-cjs/convertToNative.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.convertToNative = void 0;
+const NumberValue_1 = require("./NumberValue");
 const convertToNative = (data, options) => {
     for (const [key, value] of Object.entries(data)) {
         if (value !== undefined) {
@@ -35,11 +36,12 @@ const convertToNative = (data, options) => {
 exports.convertToNative = convertToNative;
 const convertNumber = (numString, options) => {
     if (options === null || options === void 0 ? void 0 : options.wrapNumbers) {
-        return { value: numString };
+        return NumberValue_1.NumberValue.from(numString);
     }
     const num = Number(numString);
     const infinityValues = [Number.POSITIVE_INFINITY, Number.NEGATIVE_INFINITY];
-    if ((num > Number.MAX_SAFE_INTEGER || num < Number.MIN_SAFE_INTEGER) && !infinityValues.includes(num)) {
+    const isLargeFiniteNumber = (num > Number.MAX_SAFE_INTEGER || num < Number.MIN_SAFE_INTEGER) && !infinityValues.includes(num);
+    if (isLargeFiniteNumber) {
         if (typeof BigInt === "function") {
             try {
                 return BigInt(numString);

package/dist-cjs/index.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.NumberValueImpl = void 0;
 const tslib_1 = require("tslib");
+var NumberValue_1 = require("./NumberValue");
+Object.defineProperty(exports, "NumberValueImpl", { enumerable: true, get: function () { return NumberValue_1.NumberValue; } });
 tslib_1.__exportStar(require("./convertToAttr"), exports);
 tslib_1.__exportStar(require("./convertToNative"), exports);
 tslib_1.__exportStar(require("./marshall"), exports);

package/dist-es/NumberValue.js

@@ -0,0 +1,36 @@
+export class NumberValue {
+    constructor(value) {
+        if (typeof value === "object" && "N" in value) {
+            this.value = String(value.N);
+        }
+        else {
+            this.value = String(value);
+        }
+        const valueOf = typeof value.valueOf() === "number" ? value.valueOf() : 0;
+        const imprecise = valueOf > Number.MAX_SAFE_INTEGER ||
+            valueOf < Number.MIN_SAFE_INTEGER ||
+            Math.abs(valueOf) === Infinity ||
+            Number.isNaN(valueOf);
+        if (imprecise) {
+            throw new Error(`NumberValue should not be initialized with an imprecise number=${valueOf}. Use a string instead.`);
+        }
+    }
+    static from(value) {
+        return new NumberValue(value);
+    }
+    toAttributeValue() {
+        return {
+            N: this.toString(),
+        };
+    }
+    toBigInt() {
+        const stringValue = this.toString();
+        return BigInt(stringValue);
+    }
+    toString() {
+        return String(this.value);
+    }
+    valueOf() {
+        return this.toString();
+    }
+}

package/dist-es/convertToAttr.js

@@ -1,3 +1,4 @@
+import { NumberValue } from "./NumberValue";
 export const convertToAttr = (data, options) => {
     if (data === undefined) {
         throw new Error(`Pass options.removeUndefinedValues=true to remove undefined values from map/array/set.`);
@@ -30,6 +31,9 @@ export const convertToAttr = (data, options) => {
     else if (typeof data === "number" || data?.constructor?.name === "Number") {
         return convertToNumberAttr(data);
     }
+    else if (data instanceof NumberValue) {
+        return data.toAttributeValue();
+    }
     else if (typeof data === "bigint") {
         return convertToBigIntAttr(data);
     }
@@ -61,7 +65,12 @@ const convertToSetAttr = (set, options) => {
         throw new Error(`Pass a non-empty set, or options.convertEmptyValues=true.`);
     }
     const item = setToOperate.values().next().value;
-    if (typeof item === "number") {
+    if (item instanceof NumberValue) {
+        return {
+            NS: Array.from(setToOperate).map((_) => _.toString()),
+        };
+    }
+    else if (typeof item === "number") {
         return {
             NS: Array.from(setToOperate)
                 .map(convertToNumberAttr)

package/dist-es/convertToNative.js

@@ -1,3 +1,4 @@
+import { NumberValue } from "./NumberValue";
 export const convertToNative = (data, options) => {
     for (const [key, value] of Object.entries(data)) {
         if (value !== undefined) {
@@ -31,11 +32,12 @@ export const convertToNative = (data, options) => {
 };
 const convertNumber = (numString, options) => {
     if (options?.wrapNumbers) {
-        return { value: numString };
+        return NumberValue.from(numString);
     }
     const num = Number(numString);
     const infinityValues = [Number.POSITIVE_INFINITY, Number.NEGATIVE_INFINITY];
-    if ((num > Number.MAX_SAFE_INTEGER || num < Number.MIN_SAFE_INTEGER) && !infinityValues.includes(num)) {
+    const isLargeFiniteNumber = (num > Number.MAX_SAFE_INTEGER || num < Number.MIN_SAFE_INTEGER) && !infinityValues.includes(num);
+    if (isLargeFiniteNumber) {
         if (typeof BigInt === "function") {
             try {
                 return BigInt(numString);

package/dist-es/index.js

@@ -1,3 +1,4 @@
+export { NumberValue as NumberValueImpl } from "./NumberValue";
 export * from "./convertToAttr";
 export * from "./convertToNative";
 export * from "./marshall";

package/dist-types/NumberValue.d.ts

@@ -0,0 +1,55 @@
+import { NumberValue as INumberValue } from "./models";
+/**
+ *
+ * Class for storing DynamoDB numbers that exceed the scale of
+ * JavaScript's MAX_SAFE_INTEGER and MIN_SAFE_INTEGER, or the
+ * decimal precision limit.
+ *
+ * This class does not support mathematical operations in JavaScript.
+ * Convert the contained string value to your application-specific
+ * large number implementation to perform mathematical operations.
+ *
+ * @public
+ *
+ */
+export declare class NumberValue implements INumberValue {
+    value: string;
+    /**
+     * This class does not validate that your string input is a valid number.
+     *
+     * @param value - a precise number, or any BigInt or string, or AttributeValue.
+     */
+    constructor(value: number | Number | BigInt | string | {
+        N: string;
+    });
+    /**
+     * This class does not validate that your string input is a valid number.
+     *
+     * @param value - a precise number, or any BigInt or string, or AttributeValue.
+     */
+    static from(value: number | Number | BigInt | string | {
+        N: string;
+    }): NumberValue;
+    /**
+     * @returns the AttributeValue form for DynamoDB.
+     */
+    toAttributeValue(): {
+        N: string;
+    };
+    /**
+     * @returns BigInt representation.
+     *
+     * @throws SyntaxError if the string representation is not convertable to a BigInt.
+     */
+    toBigInt(): bigint;
+    /**
+     * @override
+     *
+     * @returns string representation. This is the canonical format in DynamoDB.
+     */
+    toString(): string;
+    /**
+     * @override
+     */
+    valueOf(): string;
+}

package/dist-types/convertToNative.d.ts

@@ -1,5 +1,5 @@
 import { AttributeValue } from "@aws-sdk/client-dynamodb";
-import { NativeAttributeValue } from "./models";
+import type { NativeAttributeValue } from "./models";
 import { unmarshallOptions } from "./unmarshall";
 /**
  * Convert a DynamoDB AttributeValue object to its equivalent JavaScript type.

package/dist-types/index.d.ts

@@ -1,3 +1,4 @@
+export { NumberValue as NumberValueImpl } from "./NumberValue";
 export * from "./convertToAttr";
 export * from "./convertToNative";
 export * from "./marshall";

package/dist-types/ts3.4/NumberValue.d.ts

@@ -0,0 +1,30 @@
+import { NumberValue as INumberValue } from "./models";
+export declare class NumberValue implements INumberValue {
+  value: string;
+  constructor(
+    value:
+      | number
+      | Number
+      | BigInt
+      | string
+      | {
+          N: string;
+        }
+  );
+  static from(
+    value:
+      | number
+      | Number
+      | BigInt
+      | string
+      | {
+          N: string;
+        }
+  ): NumberValue;
+  toAttributeValue(): {
+    N: string;
+  };
+  toBigInt(): bigint;
+  toString(): string;
+  valueOf(): string;
+}

package/dist-types/ts3.4/index.d.ts

@@ -1,3 +1,4 @@
+export { NumberValue as NumberValueImpl } from "./NumberValue";
 export * from "./convertToAttr";
 export * from "./convertToNative";
 export * from "./marshall";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-sdk/util-dynamodb",
-  "version": "3.438.0",
+  "version": "3.441.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -24,7 +24,7 @@
     "tslib": "^2.5.0"
   },
   "devDependencies": {
-    "@aws-sdk/client-dynamodb": "3.438.0",
+    "@aws-sdk/client-dynamodb": "3.441.0",
     "@tsconfig/recommended": "1.0.1",
     "concurrently": "7.0.0",
     "downlevel-dts": "0.10.1",