Merge pull request #62 from UN-OCHA/drop-bigint-and-numeric

Define bigint and numeric columns as a union of string and number
UN-OCHA · Dec 1, 2021 · 10fb9af · 10fb9af
2 parents fa37611 + fd15d67
commit 10fb9af
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 5 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@unocha/hpc-api-core",
-  "version": "0.9.0",
+  "version": "0.9.1",
   "description": "Core libraries supporting HPC.Tools API Backend",
   "license": "Apache-2.0",
   "private": false,

diff --git a/src/db/models/flow.ts b/src/db/models/flow.ts
@@ -16,7 +16,15 @@ export default defineIDModel({
       id: { kind: 'branded-integer', brand: FLOW_ID },
     },
     required: {
-      amountUSD: { kind: 'checked', type: t.bigint },
+      /**
+       * Union type of string and number is used because int8 (bigint)
+       * DB type is read as string, but when inserting rows, we don't want
+       * library clients to provide numbers as strings.
+       *
+       * TODO: Add the possibility to define separate types for reading
+       * and writing, then use string for reading and number for writing
+       */
+      amountUSD: { kind: 'checked', type: t.union([t.string, t.number]) },
     },
     nonNullWithDefault: {
       versionID: { kind: 'checked', type: t.number },
@@ -29,9 +37,25 @@ export default defineIDModel({
       decisionDate: { kind: 'checked', type: DATE },
       firstReportedDate: { kind: 'checked', type: DATE },
       budgetYear: { kind: 'checked', type: t.string },
-      origAmount: { kind: 'checked', type: t.bigint },
+      /**
+       * Union type of string and number is used because int8 (bigint)
+       * DB type is read as string, but when inserting rows, we don't want
+       * library clients to provide numbers as strings.
+       *
+       * TODO: Add the possibility to define separate types for reading
+       * and writing, then use string for reading and number for writing
+       */
+      origAmount: { kind: 'checked', type: t.union([t.string, t.number]) },
       origCurrency: { kind: 'checked', type: t.string },
-      exchangeRate: { kind: 'checked', type: t.number },
+      /**
+       * Union type of string and number is used because numeric DB type
+       * is read as string, but when inserting rows, we don't want
+       * library clients to provide numbers as strings.
+       *
+       * TODO: Add the possibility to define separate types for reading
+       * and writing, then use string for reading and number for writing
+       */
+      exchangeRate: { kind: 'checked', type: t.union([t.string, t.number]) },
       description: { kind: 'checked', type: t.string },
       notes: { kind: 'checked', type: t.string },
       versionStartDate: { kind: 'checked', type: DATE },

diff --git a/src/db/models/location.ts b/src/db/models/location.ts
@@ -35,7 +35,15 @@ export default defineIDModel({
       longitude: { kind: 'checked', type: t.number },
       iso3: { kind: 'checked', type: t.string },
       pcode: { kind: 'checked', type: t.string },
-      validOn: { kind: 'checked', type: t.bigint },
+      /**
+       * Union type of string and number is used because int8 (bigint)
+       * DB type is read as string, but when inserting rows, we don't want
+       * library clients to provide numbers as strings.
+       *
+       * TODO: Add the possibility to define separate types for reading
+       * and writing, then use string for reading and number for writing
+       */
+      validOn: { kind: 'checked', type: t.union([t.string, t.number]) },
       parentId: { kind: 'branded-integer', brand: LOCATION_ID },
     },
     accidentallyOptional: {

diff --git a/src/db/models/projectVersion.ts b/src/db/models/projectVersion.ts
@@ -16,6 +16,14 @@ export default defineIDModel({
       id: { kind: 'branded-integer', brand: PROJECT_VERSION_ID },
     },
     optional: {
+      /**
+       * Union type of string and number is used because int8 (bigint)
+       * DB type is read as string, but when inserting rows, we don't want
+       * library clients to provide numbers as strings.
+       *
+       * TODO: Add the possibility to define separate types for reading
+       * and writing, then use string for reading and number for writing
+       */
       currentRequestedFunds: {
         kind: 'checked',
         type: t.union([t.string, t.number]),