@adobe/spacecat-shared-data-access 1.61.16 → 1.61.17

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-data-access-v1.61.17](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.61.16...@adobe/spacecat-shared-data-access-v1.61.17) (2025-01-07)
+
+
+### Bug Fixes
+
+* update latest audit and allByIndexQuery ([#528](https://github.com/adobe/spacecat-shared/issues/528)) ([ff2c5c9](https://github.com/adobe/spacecat-shared/commit/ff2c5c9bfeae1d38c505653818184e5a040bb09c))
+
 # [@adobe/spacecat-shared-data-access-v1.61.16](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.61.15...@adobe/spacecat-shared-data-access-v1.61.16) (2025-01-06)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-data-access",
-  "version": "1.61.16",
+  "version": "1.61.17",
   "description": "Shared modules of the Spacecat Services - Data Access",
   "type": "module",
   "engines": {

package/src/v2/models/base/base.collection.js

@@ -361,11 +361,13 @@ class BaseCollection {
    * the entity.
    * @async
    * @param {Object} item - The data for the entity to be created.
+    * @param {Object} [options] - Additional options for the creation process.
+   * @param {boolean} [options.upsert=false] - Whether to perform an upsert operation.
    * @returns {Promise<BaseModel>} - A promise that resolves to the created model instance.
    * @throws {DataAccessError} - Throws an error if the data is invalid or if the
    * creation process fails.
    */
-  async create(item) {
+  async create(item, { upsert = false } = {}) {
     if (!isNonEmptyObject(item)) {
       const message = `Failed to create [${this.entityName}]: data is required`;
       this.log.error(message);
@@ -373,7 +375,10 @@ class BaseCollection {
     }
 
     try {
-      const record = await this.entity.create(item).go();
+      const record = upsert
+        ? await this.entity.put(item).go()
+        : await this.entity.create(item).go();
+
       const instance = this.#createInstance(record.data);
 
       this.#invalidateCache();

package/src/v2/models/base/schema.builder.js

@@ -209,6 +209,29 @@ class SchemaBuilder {
     return this;
   }
 
+  /**
+   * By default createdAt and updatedAt are readOnly. This method allows
+   * to disable this behavior and allow upserts.
+   *
+   * @param {boolean} allow - Whether to allow upserts.
+   * @returns {SchemaBuilder}
+   */
+  withUpsertable(allow) {
+    if (!isBoolean(allow)) {
+      throw new SchemaBuilderError(this, 'allow must be a boolean.');
+    }
+
+    if (allow) {
+      this.addAttribute('createdAt', {
+        type: 'string',
+        required: true,
+        default: () => new Date().toISOString(),
+      });
+    }
+
+    return this;
+  }
+
   /**
    * By default a schema allows removes. This method allows
    * to disable removes for this entity. Note that this does

package/src/v2/models/latest-audit/latest-audit.collection.js

@@ -21,6 +21,16 @@ import { guardId, guardString } from '../../util/index.js';
  * @extends AuditCollection
  */
 class LatestAuditCollection extends BaseCollection {
+  async create(item) {
+    return super.create(item, { upsert: true });
+  }
+
+  async allByAuditType(auditType) {
+    guardString('auditType', auditType, this.entityName);
+
+    return this.all({ auditType });
+  }
+
   async findById(siteId, auditType) {
     guardId('siteId', siteId, this.entityName);
     guardString('auditType', auditType, this.entityName);

package/src/v2/models/latest-audit/latest-audit.schema.js

@@ -28,11 +28,11 @@ Indexes Doc: https://electrodb.dev/en/modeling/indexes/
 const schema = new SchemaBuilder(LatestAudit, LatestAuditCollection)
   .withPrimaryPartitionKeys(['siteId'])
   .withPrimarySortKeys(['auditType'])
+  .withUpsertable(true)
   .addReference('belongs_to', 'Site', ['auditType'])
   .addReference('belongs_to', 'Audit', ['auditType'])
   .addReference('has_many', 'Opportunities')
   .addAllIndex(['auditType'])
-  .allowUpdates(false)
   .allowRemove(false)
   .addAttribute('auditResult', {
     type: 'any',

package/src/v2/util/accessor.utils.js

@@ -103,6 +103,10 @@ export function createAccessor(config) { /* eslint-disable no-underscore-dangle
     });
   }
 
+  if (context[name]) {
+    return;
+  }
+
   const foreignKeys = {
     ...isNonEmptyObject(foreignKey) && { [foreignKey.name]: foreignKey.value },
   };
@@ -150,9 +154,8 @@ export function createAccessor(config) { /* eslint-disable no-underscore-dangle
   );
 }
 
-export function createAccessors(configs, log) {
+export function createAccessors(configs) {
   configs.forEach((config) => {
     createAccessor(config);
-    log.debug(`Created accessor ${config.name} for ${config.context.schema.getModelName()} to ${config.collection.schema.getModelName()}`);
   });
 }