@squiz/db-lib 1.68.0 → 1.69.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 1.69.0
+
+### Minor Changes
+
+- 0079f07: allow fields to be stored as json string in dynamodb
+
 ## 1.68.0
 
 ### Minor Changes

package/lib/dynamodb/AbstractDynamoDbRepository.d.ts

@@ -26,6 +26,7 @@ export type KeysFormat = Record<keyof TableKeys | keyof TableIndexes, string>;
 export type EntityDefinition = {
     keys: TableKeys;
     indexes: TableIndexes;
+    fieldsAsJsonString: string[];
 };
 export declare abstract class AbstractDynamoDbRepository<SHAPE extends object, DATA_CLASS extends SHAPE> implements Reader<SHAPE>, Writer<SHAPE> {
     protected tableName: string;
@@ -39,6 +40,7 @@ export declare abstract class AbstractDynamoDbRepository<SHAPE extends object, D
     protected keys: TableKeys;
     protected indexes: TableIndexes;
     protected keysFormat: KeysFormat;
+    protected fieldsAsJsonString: string[];
     constructor(tableName: string, dbManager: DynamoDbManager<Repositories>, entityName: string, entityDefinition: EntityDefinition, classRef: {
         new (data?: Record<string, unknown>): DATA_CLASS;
     });
@@ -99,6 +101,7 @@ export declare abstract class AbstractDynamoDbRepository<SHAPE extends object, D
      * @returns
      */
     protected hydrateItem(item: Record<string, unknown>): DATA_CLASS;
+    protected convertSelectedValuesToJsonString(item: Record<string, unknown>): void;
     /**
      * Evaluate the partition key value from the partial item
      * @param item

package/lib/dynamodb/AbstractDynamoDbRepository.spec.d.ts

@@ -6,12 +6,14 @@ interface ITestItem {
     age: number;
     country: string;
     data?: object;
+    data2?: object;
 }
 declare class TestItem implements ITestItem {
     name: string;
     age: number;
     country: string;
     data: object;
+    data2?: object;
     constructor(data?: Partial<ITestItem>);
 }
 export type TestRepositories = {

package/lib/error/InvalidDataFormatError.d.ts

@@ -0,0 +1,5 @@
+import { InternalServerError } from '@squiz/dx-common-lib';
+export declare class InvalidDataFormatError extends InternalServerError {
+    name: string;
+    constructor(message: string);
+}

package/lib/index.js

@@ -328,12 +328,12 @@ var require_InternalServerError = __commonJS({
     Object.defineProperty(exports, "__esModule", { value: true });
     exports.InternalServerError = void 0;
     var ErrorWithHttpStatusCode_1 = require_ErrorWithHttpStatusCode();
-    var InternalServerError4 = class extends ErrorWithHttpStatusCode_1.ErrorWithHttpStatusCode {
+    var InternalServerError5 = class extends ErrorWithHttpStatusCode_1.ErrorWithHttpStatusCode {
       constructor(message) {
         super(500, message);
       }
     };
-    exports.InternalServerError = InternalServerError4;
+    exports.InternalServerError = InternalServerError5;
   }
 });
 
@@ -56131,6 +56131,15 @@ var DynamoDbManager = class {
   }
 };
 
+// src/error/InvalidDataFormatError.ts
+var import_dx_common_lib3 = __toESM(require_lib5());
+var InvalidDataFormatError = class extends import_dx_common_lib3.InternalServerError {
+  constructor(message) {
+    super(message);
+    this.name = "InvalidDataFormatError";
+  }
+};
+
 // src/dynamodb/AbstractDynamoDbRepository.ts
 var AbstractDynamoDbRepository = class {
   constructor(tableName, dbManager, entityName2, entityDefinition, classRef) {
@@ -56142,6 +56151,7 @@ var AbstractDynamoDbRepository = class {
     this.client = dbManager.client;
     this.keys = entityDefinition.keys;
     this.indexes = entityDefinition.indexes;
+    this.fieldsAsJsonString = entityDefinition.fieldsAsJsonString;
     this.keysFormat = {
       [this.keys.pk.attributeName]: this.keys.pk.format,
       [this.keys.sk.attributeName]: this.keys.sk.format
@@ -56233,7 +56243,9 @@ var AbstractDynamoDbRepository = class {
     if (oldValue === void 0) {
       return void 0;
     }
-    this.assertValueMatchesModel({ ...oldValue, ...newValue });
+    const value = { ...oldValue, ...newValue };
+    this.assertValueMatchesModel(value);
+    this.convertSelectedValuesToJsonString(newValue);
     const updateExpression = [];
     const expressionAttributeNames = {};
     const expressionAttributeValues = {};
@@ -56259,7 +56271,7 @@ var AbstractDynamoDbRepository = class {
       this.dbManager.addWriteTransactionItem(transaction.id, {
         Update: updateCommandInput
       });
-      return new this.classRef({ ...oldValue, ...newValue });
+      return new this.classRef(value);
     }
     let output;
     try {
@@ -56296,6 +56308,7 @@ var AbstractDynamoDbRepository = class {
     for (const modelProperty of Object.keys(value)) {
       columns[modelProperty] = value[modelProperty];
     }
+    this.convertSelectedValuesToJsonString(columns);
     const keyFields = {
       [this.keys.pk.attributeName]: this.getPk(value),
       [this.keys.sk.attributeName]: this.getSk(value)
@@ -56362,8 +56375,24 @@ var AbstractDynamoDbRepository = class {
    * @returns
    */
   hydrateItem(item) {
+    for (const fieldName of Object.keys(item)) {
+      if (this.fieldsAsJsonString.includes(fieldName)) {
+        if (typeof item[fieldName] === "string") {
+          item[fieldName] = JSON.parse(item[fieldName]);
+        } else {
+          throw new InvalidDataFormatError(`Field '${fieldName}' defined as JSON String has a non-string data`);
+        }
+      }
+    }
     return new this.classRef(item);
   }
+  convertSelectedValuesToJsonString(item) {
+    for (const fieldName of Object.keys(item)) {
+      if (this.fieldsAsJsonString.includes(fieldName)) {
+        item[fieldName] = JSON.stringify(item[fieldName]);
+      }
+    }
+  }
   /**
    * Evaluate the partition key value from the partial item
    * @param item
@@ -56502,8 +56531,8 @@ async function getSecret(id) {
 }
 
 // src/error/DuplicateItemError.ts
-var import_dx_common_lib3 = __toESM(require_lib5());
-var DuplicateItemError = class extends import_dx_common_lib3.InternalServerError {
+var import_dx_common_lib4 = __toESM(require_lib5());
+var DuplicateItemError = class extends import_dx_common_lib4.InternalServerError {
   constructor(message) {
     super(message);
     this.name = "DuplicateItemError";
@@ -56511,8 +56540,8 @@ var DuplicateItemError = class extends import_dx_common_lib3.InternalServerError
 };
 
 // src/error/MissingKeyValuesError.ts
-var import_dx_common_lib4 = __toESM(require_lib5());
-var MissingKeyValuesError = class extends import_dx_common_lib4.InternalServerError {
+var import_dx_common_lib5 = __toESM(require_lib5());
+var MissingKeyValuesError = class extends import_dx_common_lib5.InternalServerError {
   constructor(message) {
     super(message);
     this.name = "MissingKeyValuesError";
@@ -56520,8 +56549,8 @@ var MissingKeyValuesError = class extends import_dx_common_lib4.InternalServerEr
 };
 
 // src/error/InvalidDbSchemaError.ts
-var import_dx_common_lib5 = __toESM(require_lib5());
-var InvalidDbSchemaError = class extends import_dx_common_lib5.BadRequestError {
+var import_dx_common_lib6 = __toESM(require_lib5());
+var InvalidDbSchemaError = class extends import_dx_common_lib6.BadRequestError {
   constructor(message) {
     super(message);
     this.name = "InvalidDbSchemaError";