@adobe/spacecat-shared-data-access 1.60.3 → 1.61.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-data-access-v1.61.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.61.0...@adobe/spacecat-shared-data-access-v1.61.1) (2024-12-24)
+
+
+### Bug Fixes
+
+* schema and db init ([#505](https://github.com/adobe/spacecat-shared/issues/505)) ([9b67b9a](https://github.com/adobe/spacecat-shared/commit/9b67b9a9f40f643c648cc5043018bfbc1d2a9c12))
+
+# [@adobe/spacecat-shared-data-access-v1.61.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.60.3...@adobe/spacecat-shared-data-access-v1.61.0) (2024-12-23)
+
+
+### Features
+
+* latest audit entity ([#503](https://github.com/adobe/spacecat-shared/issues/503)) ([2d01b09](https://github.com/adobe/spacecat-shared/commit/2d01b0969c0c046cdbffa480f8e40991e5abf91e))
+
 # [@adobe/spacecat-shared-data-access-v1.60.3](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.60.2...@adobe/spacecat-shared-data-access-v1.60.3) (2024-12-22)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-data-access",
-  "version": "1.60.3",
+  "version": "1.61.1",
   "description": "Shared modules of the Spacecat Services - Data Access",
   "type": "module",
   "engines": {
@@ -34,8 +34,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@adobe/spacecat-shared-dynamo": "1.4.0",
-    "@adobe/spacecat-shared-utils": "1.23.1",
+    "@adobe/spacecat-shared-dynamo": "1.4.2",
+    "@adobe/spacecat-shared-utils": "1.24.1",
     "@aws-sdk/client-dynamodb": "3.716.0",
     "@aws-sdk/lib-dynamodb": "3.716.0",
     "@types/joi": "17.2.3",

package/src/service/index.js

@@ -31,8 +31,8 @@ import { importUrlFunctions } from './import-url/index.js';
 import { experimentFunctions } from './experiments/index.js';
 import { apiKeyFunctions } from './api-key/index.js';
 
-const createRawClient = () => {
-  const dbClient = AWSXray.captureAWSv3Client(new DynamoDB());
+const createRawClient = (client = undefined) => {
+  const dbClient = client || AWSXray.captureAWSv3Client(new DynamoDB());
   return DynamoDBDocument.from(dbClient, {
     marshallOptions: {
       convertEmptyValues: true,
@@ -70,6 +70,7 @@ const createElectroService = (client, config, log) => {
  * tableNameSiteTopPages: string, indexNameAllOrganizations: string,
  * indexNameAllOrganizationsByImsOrgId: string, pkAllOrganizations: string}} config configuration
  * @param {Logger} log log
+ * @param client custom dynamo client
  * @returns {object} data access object
  */
 export const createDataAccess = (config, log = console, client = undefined) => {
@@ -88,7 +89,7 @@ export const createDataAccess = (config, log = console, client = undefined) => {
   const apiKeyFuncs = apiKeyFunctions(dynamoClient, config, log);
 
   // electro-based data access objects
-  const rawClient = createRawClient();
+  const rawClient = createRawClient(client);
   const electroService = createElectroService(rawClient, config, log);
   const entityRegistry = new EntityRegistry(electroService, log);
   const collections = entityRegistry.getCollections();

package/src/v2/errors/data-access.error.js

@@ -0,0 +1,24 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+export default class DataAccessError extends Error {
+  constructor(message, details = {}, cause = null) {
+    super(message);
+    this.name = this.constructor.name;
+    this.details = details;
+    this.cause = cause;
+
+    if (cause?.stack) {
+      this.stack += `\nCaused by: ${cause.stack}`;
+    }
+  }
+}

package/src/v2/errors/index.d.ts

@@ -10,4 +10,8 @@
  * governing permissions and limitations under the License.
  */
 
-export type ValidationError = Error
+export type DataAccessError = Error
+export type SchemaBuilderError = DataAccessError
+export type SchemaError = DataAccessError
+export type SchemaValidationError = DataAccessError
+export type ValidationError = DataAccessError

package/src/v2/errors/index.js

@@ -10,6 +10,16 @@
  * governing permissions and limitations under the License.
  */
 
+import DataAccessError from './data-access.error.js';
+import SchemaBuilderError from './schema.builder.error.js';
+import SchemaError from './schema.error.js';
+import SchemaValidationError from './schema-validation.error.js';
 import ValidationError from './validation.error.js';
 
-export { ValidationError };
+export {
+  DataAccessError,
+  SchemaBuilderError,
+  SchemaError,
+  SchemaValidationError,
+  ValidationError,
+};

package/src/v2/errors/reference.error.js

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import DataAccessError from './data-access.error.js';
+
+export default class ReferenceError extends DataAccessError {
+  constructor(reference, message, cause) {
+    const { type, target } = reference;
+    const prefix = type && target ? `[${type} -> ${target}] ` : '';
+
+    super(`${prefix}${message}`, { reference }, cause);
+  }
+}

package/src/v2/{models/base/constants.js → errors/schema-validation.error.js}

@@ -9,9 +9,7 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-export const INDEX_TYPES = {
-  PRIMARY: 'primary',
-  ALL: 'all',
-  BELONGS_TO: 'belongs_to',
-  OTHER: 'other',
-};
+
+import DataAccessError from './data-access.error.js';
+
+export default class SchemaValidationError extends DataAccessError {}

package/src/v2/errors/schema.builder.error.js

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import { hasText } from '@adobe/spacecat-shared-utils';
+
+import DataAccessError from './data-access.error.js';
+
+export default class SchemaBuilderError extends DataAccessError {
+  constructor(builder, message, cause) {
+    const { serviceName, entityName } = builder;
+    const prefix = hasText(serviceName) && hasText(entityName)
+      ? `[${serviceName} -> ${entityName}] `
+      : '';
+
+    super(`${prefix}${message}`, { builder }, cause);
+    this.name = this.constructor.name;
+  }
+}

package/src/v2/errors/schema.error.js

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import DataAccessError from './data-access.error.js';
+
+export default class SchemaError extends DataAccessError {
+  constructor(schema, message, cause) {
+    super(`[${schema.getModelName()}] ${message}`, { schema }, cause);
+  }
+}

package/src/v2/errors/validation.error.js

@@ -10,4 +10,6 @@
  * governing permissions and limitations under the License.
  */
 
-export default class ValidationError extends Error {}
+import DataAccessError from './data-access.error.js';
+
+export default class ValidationError extends DataAccessError {}

package/src/v2/models/api-key/api-key.schema.js

@@ -31,9 +31,11 @@ const schema = new SchemaBuilder(ApiKey, ApiKeyCollection)
   })
   .addAttribute('imsUserId', {
     type: 'string',
+    default: 'default',
   })
   .addAttribute('imsOrgId', {
     type: 'string',
+    default: 'default',
   })
   .addAttribute('name', {
     type: 'string',

package/src/v2/models/api-key/index.d.ts

@@ -13,6 +13,7 @@
 import type { BaseCollection, BaseModel } from '../base';
 
 export interface ApiKey extends BaseModel {
+  getApiKeyId(): string;
   getDeletedAt(): string | undefined;
   getExpiresAt(): string | undefined;
   getHashedApiKey(): string;
@@ -32,6 +33,18 @@ export interface ApiKey extends BaseModel {
 }
 
 export interface ApiKeyCollection extends BaseCollection<ApiKey> {
-  allByImsOrgIdAndImsUserId: (imsUserId: string, imsOrgId: string) => Promise<ApiKey[]>;
-  findByHashedApiKey: (hashedApiKey: string) => Promise<ApiKey | null>;
+  allByHashedApiKey(hashedApiKey: string): Promise<ApiKey[]>;
+  allByHashedApiKeyAndUpdatedAt(hashedApiKey: string, updatedAt: string): Promise<ApiKey[]>;
+  allByImsOrgId(imsOrgId: string): Promise<ApiKey[]>;
+  allByImsOrgIdAndImsUserId(imsOrgId: string, imsUserId: string): Promise<ApiKey[]>;
+  allByImsOrgIdAndImsUserIdAndUpdatedAt(
+    imsOrgId: string, imsUserId: string, updatedAt: string
+  ): Promise<ApiKey[]>;
+  findByHashedApiKey(hashedApiKey: string): Promise<ApiKey | null>;
+  findByHashedApiKeyAndUpdatedAt(hashedApiKey: string, updatedAt: string): Promise<ApiKey | null>;
+  findByImsOrgId(imsOrgId: string): Promise<ApiKey | null>;
+  findByImsOrgIdAndImsUserId(imsOrgId: string, imsUserId: string): Promise<ApiKey | null>;
+  findByImsOrgIdAndImsUserIdAndUpdatedAt(
+    imsOrgId: string, imsUserId: string, updatedAt: string
+  ): Promise<ApiKey | null>;
 }

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

@@ -20,7 +20,31 @@ import BaseCollection from '../base/base.collection.js';
  * @extends BaseCollection
  */
 class AuditCollection extends BaseCollection {
-  // add custom methods here
+  // create a copy of the audit as a LatestAudit entity
+  async _onCreate(item) {
+    const collection = this.entityRegistry.getCollection('LatestAuditCollection');
+    await collection.create(item.toJSON());
+  }
+
+  // of the created audits, find the latest per site and auditType
+  // and create a LatestAudit copy for each
+  async _onCreateMany(items) {
+    const collection = this.entityRegistry.getCollection('LatestAuditCollection');
+    const latestAudits = items.createdItems.reduce((acc, audit) => {
+      const siteId = audit.getSiteId();
+      const auditType = audit.getAuditType();
+      const auditedAt = audit.getAuditedAt();
+      const key = `${siteId}-${auditType}`;
+
+      if (!acc[key] || acc[key].getAuditedAt() < auditedAt) {
+        acc[key] = audit;
+      }
+
+      return acc;
+    }, {});
+
+    await collection.createMany(Object.values(latestAudits).map((audit) => audit.toJSON()));
+  }
 }
 
 export default AuditCollection;

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

@@ -26,7 +26,10 @@ Indexes Doc: https://electrodb.dev/en/modeling/indexes/
 
 const schema = new SchemaBuilder(Audit, AuditCollection)
   .addReference('belongs_to', 'Site', ['auditType', 'auditedAt'])
+  .addReference('has_one', 'LatestAudit', ['auditType'], { required: false })
   .addReference('has_many', 'Opportunities')
+  .allowUpdates(false)
+  .allowRemove(false)
   .addAttribute('auditResult', {
     type: 'any',
     required: true,

package/src/v2/models/audit/index.d.ts

@@ -11,30 +11,35 @@
  */
 
 import type {
-  BaseCollection, BaseModel, Opportunity, Site,
+  BaseCollection, BaseModel, LatestAudit, Opportunity, Site,
 } from '../index';
 
 export interface Audit extends BaseModel {
+  getAuditedAt(): number;
+  getAuditId(): string;
   getAuditResult(): object;
   getAuditType(): string;
-  getAuditedAt(): number;
   getFullAuditRef(): string;
   getIsError(): boolean;
   getIsLive(): boolean;
+  getLatestAudit(): Promise<LatestAudit | null>;
+  getLatestAuditByAuditType(auditType: string): Promise<LatestAudit | null>;
   getOpportunities(): Promise<Opportunity[]>;
+  getOpportunitiesByUpdatedAt(updatedAt: string): Promise<Opportunity[]>;
+  getScores(): object | undefined;
   getSite(): Promise<Site>;
   getSiteId(): string;
-  setAuditResult(auditResult: object): Audit;
-  setAuditType(auditType: string): Audit;
-  setAuditedAt(auditedAt: number): Audit;
-  setFullAuditRef(fullAuditRef: string): Audit;
-  setIsError(isError: boolean): Audit;
-  setIsLive(isLive: boolean): Audit;
-  setSiteId(siteId: string): Audit;
-  toggleLive(): Audit;
 }
 
 export interface AuditCollection extends BaseCollection<Audit> {
   allBySiteId(siteId: string): Promise<Audit[]>;
-  allBySiteAndType(siteId: string, auditType: string): Promise<Audit[]>;
+  allBySiteIdAndAuditType(siteId: string, auditType: string): Promise<Audit[]>;
+  allBySiteIdAndAuditTypeAndAuditedAt(
+    siteId: string, auditType: string, auditedAt: string
+  ): Promise<Audit[]>;
+  findBySiteId(siteId: string): Promise<Audit | null>;
+  findBySiteIdAndAuditType(siteId: string, auditType: string): Promise<Audit | null>;
+  findBySiteIdAndAuditTypeAndAuditedAt(
+    siteId: string, auditType: string, auditedAt: string
+  ): Promise<Audit | null>;
 }