feat(core/serde): add NumericValue container (#1544)

Author: kuhe

.changeset/neat-queens-peel.md

@@ -0,0 +1,5 @@
+---
+"@smithy/core": minor
+---
+
+add numeric value container for serde

packages/core/package.json

@@ -45,6 +45,13 @@
       "import": "./dist-es/submodules/protocols/index.js",
       "require": "./dist-cjs/submodules/protocols/index.js",
       "types": "./dist-types/submodules/protocols/index.d.ts"
+    },
+    "./serde": {
+      "module": "./dist-es/submodules/serde/index.js",
+      "node": "./dist-cjs/submodules/serde/index.js",
+      "import": "./dist-es/submodules/serde/index.js",
+      "require": "./dist-cjs/submodules/serde/index.js",
+      "types": "./dist-types/submodules/serde/index.d.ts"
     }
   },
   "author": {
@@ -78,6 +85,8 @@
     "./cbor.js",
     "./protocols.d.ts",
     "./protocols.js",
+    "./serde.d.ts",
+    "./serde.js",
     "dist-*/**"
   ],
   "homepage": "https://github.com/awslabs/smithy-typescript/tree/main/packages/core",

packages/core/serde.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Do not edit:
+ * This is a compatibility redirect for contexts that do not understand package.json exports field.
+ */
+declare module "@smithy/core/serde" {
+  export * from "@smithy/core/dist-types/submodules/serde/index.d";
+}

packages/core/serde.js

@@ -0,0 +1,6 @@
+
+/**
+ * Do not edit:
+ * This is a compatibility redirect for contexts that do not understand package.json exports field.
+ */
+module.exports = require("./dist-cjs/submodules/serde/index.js");

packages/core/src/submodules/serde/index.ts

@@ -0,0 +1 @@
+export * from "./value/NumericValue";

packages/core/src/submodules/serde/value/NumericValue.spec.ts

@@ -0,0 +1,12 @@
+import { describe, expect, test as it } from "vitest";
+
+import { NumericValue, nv } from "./NumericValue";
+
+describe(NumericValue.name, () => {
+  it("holds a string representation of a numeric value", () => {
+    const num = nv("1.0");
+    expect(num).toBeInstanceOf(NumericValue);
+    expect(num.string).toEqual("1.0");
+    expect(num.type).toEqual("bigDecimal");
+  });
+});

packages/core/src/submodules/serde/value/NumericValue.ts

@@ -0,0 +1,36 @@
+/**
+ * Types which may be represented by {@link NumericValue}.
+ *
+ * There is currently only one option, because BigInteger and Long should
+ * use JS BigInt directly, and all other numeric types can be contained in JS Number.
+ *
+ * @public
+ */
+export type NumericType = "bigDecimal";
+
+/**
+ * Serialization container for Smithy simple types that do not have a
+ * direct JavaScript runtime representation.
+ *
+ * This container does not perform numeric mathematical operations.
+ * It is a container for discerning a value's true type.
+ *
+ * It allows storage of numeric types not representable in JS without
+ * making a decision on what numeric library to use.
+ *
+ * @public
+ */
+export class NumericValue {
+  public constructor(
+    public readonly string: string,
+    public readonly type: NumericType
+  ) {}
+}
+
+/**
+ * Serde shortcut.
+ * @internal
+ */
+export function nv(string: string): NumericValue {
+  return new NumericValue(string, "bigDecimal");
+}

packages/core/tsconfig.cjs.json

@@ -5,7 +5,8 @@
     "rootDir": "src",
     "paths": {
       "@smithy/core/cbor": ["./src/submodules/cbor/index.ts"],
-      "@smithy/core/protocols": ["./src/submodules/protocols/index.ts"]
+      "@smithy/core/protocols": ["./src/submodules/protocols/index.ts"],
+      "@smithy/core/serde": ["./src/submodules/serde/index.ts"]
     }
   },
   "extends": "../../tsconfig.cjs.json",

packages/core/tsconfig.es.json

@@ -6,7 +6,8 @@
     "rootDir": "src",
     "paths": {
       "@smithy/core/cbor": ["./src/submodules/cbor/index.ts"],
-      "@smithy/core/protocols": ["./src/submodules/protocols/index.ts"]
+      "@smithy/core/protocols": ["./src/submodules/protocols/index.ts"],
+      "@smithy/core/serde": ["./src/submodules/serde/index.ts"]
     }
   },
   "extends": "../../tsconfig.es.json",

packages/core/tsconfig.types.json

@@ -5,7 +5,8 @@
     "rootDir": "src",
     "paths": {
       "@smithy/core/cbor": ["./src/submodules/cbor/index.ts"],
-      "@smithy/core/protocols": ["./src/submodules/protocols/index.ts"]
+      "@smithy/core/protocols": ["./src/submodules/protocols/index.ts"],
+      "@smithy/core/serde": ["./src/submodules/serde/index.ts"]
     }
   },
   "extends": "../../tsconfig.types.json",