@adobe/spacecat-shared-data-access 1.61.0 → 1.61.2

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-data-access-v1.61.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.61.1...@adobe/spacecat-shared-data-access-v1.61.2) (2024-12-27)
+
+
+### Bug Fixes
+
+* various missing ([#506](https://github.com/adobe/spacecat-shared/issues/506)) ([8fc72f0](https://github.com/adobe/spacecat-shared/commit/8fc72f0545eb17fb9ccdf0caa35872734f518883))
+
+# [@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)
 
 

package/package.json

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

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/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/audit/audit.model.js

@@ -15,71 +15,72 @@ import { isObject } from '@adobe/spacecat-shared-utils';
 import { ValidationError } from '../../errors/index.js';
 import BaseModel from '../base/base.model.js';
 
-const AUDIT_TYPES = {
-  404: '404',
-  BROKEN_BACKLINKS: 'broken-backlinks',
-  EXPERIMENTATION: 'experimentation',
-  ORGANIC_KEYWORDS: 'organic-keywords',
-  ORGANIC_TRAFFIC: 'organic-traffic',
-  CWV: 'cwv',
-  LHS_DESKTOP: 'lhs-desktop',
-  LHS_MOBILE: 'lhs-mobile',
-  EXPERIMENTATION_ESS_MONTHLY: 'experimentation-ess-monthly',
-  EXPERIMENTATION_ESS_DAILY: 'experimentation-ess-daily',
-};
+/**
+ * Audit - A class representing an Audit entity.
+ * Provides methods to access and manipulate Audit-specific data.
+ *
+ * @class Audit
+ * @extends BaseModel
+ */
+class Audit extends BaseModel {
+  static AUDIT_TYPES = {
+    404: '404',
+    BROKEN_BACKLINKS: 'broken-backlinks',
+    EXPERIMENTATION: 'experimentation',
+    ORGANIC_KEYWORDS: 'organic-keywords',
+    ORGANIC_TRAFFIC: 'organic-traffic',
+    CWV: 'cwv',
+    LHS_DESKTOP: 'lhs-desktop',
+    LHS_MOBILE: 'lhs-mobile',
+    EXPERIMENTATION_ESS_MONTHLY: 'experimentation-ess-monthly',
+    EXPERIMENTATION_ESS_DAILY: 'experimentation-ess-daily',
+  };
 
-const AUDIT_TYPE_PROPERTIES = {
-  [AUDIT_TYPES.LHS_DESKTOP]: ['performance', 'seo', 'accessibility', 'best-practices'],
-  [AUDIT_TYPES.LHS_MOBILE]: ['performance', 'seo', 'accessibility', 'best-practices'],
-};
+  static AUDIT_TYPE_PROPERTIES = {
+    [Audit.AUDIT_TYPES.LHS_DESKTOP]: ['performance', 'seo', 'accessibility', 'best-practices'],
+    [Audit.AUDIT_TYPES.LHS_MOBILE]: ['performance', 'seo', 'accessibility', 'best-practices'],
+  };
 
-export const AUDIT_CONFIG = {
-  TYPES: AUDIT_TYPES,
-  PROPERTIES: AUDIT_TYPE_PROPERTIES,
-};
+  static AUDIT_CONFIG = {
+    TYPES: Audit.AUDIT_TYPES,
+    PROPERTIES: Audit.AUDIT_TYPE_PROPERTIES,
+  };
 
-/**
- * Validates if the auditResult contains the required properties for the given audit type.
- * @param {object} auditResult - The audit result to validate.
- * @param {string} auditType - The type of the audit.
- * @returns {boolean} - True if valid, false otherwise.
- */
-export const validateAuditResult = (auditResult, auditType) => {
-  if (!isObject(auditResult) && !Array.isArray(auditResult)) {
-    throw new ValidationError('Audit result must be an object or array');
-  }
+  /**
+   * Validates if the auditResult contains the required properties for the given audit type.
+   * @param {object} auditResult - The audit result to validate.
+   * @param {string} auditType - The type of the audit.
+   * @returns {boolean} - True if valid, false otherwise.
+   */
+  static validateAuditResult = (auditResult, auditType) => {
+    if (!isObject(auditResult) && !Array.isArray(auditResult)) {
+      throw new ValidationError('Audit result must be an object or array');
+    }
 
-  if (isObject(auditResult.runtimeError)) {
-    return true;
-  }
+    if (isObject(auditResult.runtimeError)) {
+      return true;
+    }
 
-  if ((auditType === AUDIT_CONFIG.TYPES.LHS_MOBILE || auditType === AUDIT_CONFIG.TYPES.LHS_DESKTOP)
-    && !isObject(auditResult.scores)) {
-    throw new ValidationError(`Missing scores property for audit type '${auditType}'`);
-  }
+    if ((
+      auditType === Audit.AUDIT_CONFIG.TYPES.LHS_MOBILE
+        || auditType === Audit.AUDIT_CONFIG.TYPES.LHS_DESKTOP
+    )
+      && !isObject(auditResult.scores)) {
+      throw new ValidationError(`Missing scores property for audit type '${auditType}'`);
+    }
 
-  const expectedProperties = AUDIT_CONFIG.PROPERTIES[auditType];
+    const expectedProperties = Audit.AUDIT_CONFIG.PROPERTIES[auditType];
 
-  if (expectedProperties) {
-    for (const prop of expectedProperties) {
-      if (!(prop in auditResult.scores)) {
-        throw new ValidationError(`Missing expected property '${prop}' for audit type '${auditType}'`);
+    if (expectedProperties) {
+      for (const prop of expectedProperties) {
+        if (!(prop in auditResult.scores)) {
+          throw new ValidationError(`Missing expected property '${prop}' for audit type '${auditType}'`);
+        }
       }
     }
-  }
 
-  return true;
-};
-
-/**
- * Audit - A class representing an Audit entity.
- * Provides methods to access and manipulate Audit-specific data.
- *
- * @class Audit
- * @extends BaseModel
- */
-class Audit extends BaseModel {
-  // add your custom methods or overrides here
+    return true;
+  };
 
   getScores() {
     return this.getAuditResult()?.scores;

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

@@ -15,7 +15,7 @@
 import { isIsoDate, isNonEmptyObject } from '@adobe/spacecat-shared-utils';
 
 import SchemaBuilder from '../base/schema.builder.js';
-import Audit, { validateAuditResult } from './audit.model.js';
+import Audit from './audit.model.js';
 import AuditCollection from './audit.collection.js';
 
 /*
@@ -37,7 +37,7 @@ const schema = new SchemaBuilder(Audit, AuditCollection)
     set: (value, attributes) => {
       // as the electroDb validate function does not provide access to the model instance
       // we need to call the validate function from the model on setting the value
-      validateAuditResult(value, attributes.auditType);
+      Audit.validateAuditResult(value, attributes.auditType);
       return value;
     },
   })

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

@@ -11,7 +11,7 @@
  */
 
 import type {
-  BaseCollection, BaseModel, LatestAudit, Opportunity, Site,
+  BaseCollection, BaseModel, LatestAudit, Opportunity, QueryOptions, Site,
 } from '../index';
 
 export interface Audit extends BaseModel {
@@ -33,7 +33,11 @@ export interface Audit extends BaseModel {
 
 export interface AuditCollection extends BaseCollection<Audit> {
   allBySiteId(siteId: string): Promise<Audit[]>;
-  allBySiteIdAndAuditType(siteId: string, auditType: string): Promise<Audit[]>;
+  allBySiteIdAndAuditType(
+    siteId: string,
+    auditType: string,
+    options?: QueryOptions
+  ): Promise<Audit[]>;
   allBySiteIdAndAuditTypeAndAuditedAt(
     siteId: string, auditType: string, auditedAt: string
   ): Promise<Audit[]>;

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

@@ -326,6 +326,23 @@ class BaseCollection {
     return this.#createInstance(record?.data);
   }
 
+  /**
+   * Checks if an entity exists by its ID.
+   * @param {string} id - The UUID of the entity to check.
+   * @return {Promise<boolean>} - A promise that resolves to true if the entity exists,
+   * otherwise false.
+   * @throws {ValidationError} - Throws an error if the ID is not provided.
+   */
+  async existsById(id) {
+    guardId(this.idName, id, this.entityName);
+
+    const record = await this.entity.get({ [this.idName]: id }).go({
+      attributes: [this.idName],
+    });
+
+    return isNonEmptyObject(record?.data);
+  }
+
   /**
    * Finds a single entity by index keys.
    * @param {Object} keys - The index keys to use for the query.

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

@@ -30,7 +30,7 @@ export interface BaseModel {
 export interface QueryOptions {
   index?: string;
   limit?: number;
-  sort?: string;
+  order?: string;
   attributes?: string[];
 }
 
@@ -42,6 +42,7 @@ export interface BaseCollection<T extends BaseModel> {
   allByIndexKeys(keys: object, options?: QueryOptions): Promise<T[]>;
   create(item: object): Promise<T>;
   createMany(items: object[], parent?: T): Promise<MultiStatusCreateResult<T>>;
+  existsById(id: string): Promise<boolean>;
   findByAll(sortKeys?: object, options?: QueryOptions): Promise<T> | null;
   findById(id: string): Promise<T> | null;
   findByIndexKeys(indexKeys: object): Promise<T>;

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

@@ -78,9 +78,9 @@ const schema = new SchemaBuilder(Configuration, ConfigurationCollection)
     items: {
       type: 'map',
       properties: {
-        group: { type: ['audits', 'imports', 'reports'] },
+        group: { type: ['audits', 'imports', 'reports', 'scrapes'] },
         type: { type: 'string', required: true },
-        interval: { type: ['daily', 'weekly'] },
+        interval: { type: ['daily', 'weekly', 'every-saturday', 'every-sunday', 'fortnightly', 'monthly'] },
       },
     },
   })

package/src/v2/models/experiment/experiment.model.js

@@ -12,8 +12,6 @@
 
 import BaseModel from '../base/base.model.js';
 
-export const DEFAULT_UPDATED_BY = 'spacecat';
-
 /**
  * Experiment - A class representing an Experiment entity.
  * Provides methods to access and manipulate Experiment-specific data.
@@ -22,6 +20,8 @@ export const DEFAULT_UPDATED_BY = 'spacecat';
  * @extends BaseModel
  */
 class Experiment extends BaseModel {
+  static DEFAULT_UPDATED_BY = 'spacecat';
+
   // add your custom methods or overrides here
 }
 

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

@@ -12,10 +12,12 @@
 
 /* c8 ignore start */
 
-import { isIsoDate, isNonEmptyObject, isValidUrl } from '@adobe/spacecat-shared-utils';
+import {
+  isIsoDate, isNonEmptyObject, isString, isValidUrl,
+} from '@adobe/spacecat-shared-utils';
 
 import SchemaBuilder from '../base/schema.builder.js';
-import Experiment, { DEFAULT_UPDATED_BY } from './experiment.model.js';
+import Experiment from './experiment.model.js';
 import ExperimentCollection from './experiment.collection.js';
 
 /*
@@ -28,8 +30,12 @@ const schema = new SchemaBuilder(Experiment, ExperimentCollection)
   .addReference('belongs_to', 'Site', ['expId', 'url', 'updatedAt'])
   .addAttribute('conversionEventName', {
     type: 'string',
+    validate: (value) => !value || isString(value),
+  })
+  .addAttribute('conversionEventValue', {
+    type: 'string',
+    validate: (value) => !value || isString(value),
   })
-  .addAttribute('conversionEventValue', { type: 'string' })
   .addAttribute('endDate', {
     type: 'string',
     validate: (value) => !value || isIsoDate(value),
@@ -47,7 +53,10 @@ const schema = new SchemaBuilder(Experiment, ExperimentCollection)
     type: ['ACTIVE', 'INACTIVE'],
     required: true,
   })
-  .addAttribute('type', { type: 'string' })
+  .addAttribute('type', {
+    type: 'string',
+    validate: (value) => !value || isString(value),
+  })
   .addAttribute('url', {
     type: 'string',
     required: true,
@@ -56,7 +65,7 @@ const schema = new SchemaBuilder(Experiment, ExperimentCollection)
   .addAttribute('updatedBy', {
     type: 'string',
     required: true,
-    default: DEFAULT_UPDATED_BY,
+    default: Experiment.DEFAULT_UPDATED_BY,
   })
   .addAttribute('variants', {
     type: 'list',

package/src/v2/models/import-job/import-job.collection.js

@@ -12,8 +12,8 @@
 
 import { isIsoDate } from '@adobe/spacecat-shared-utils';
 
-import BaseCollection from '../base/base.collection.js';
 import { ValidationError } from '../../errors/index.js';
+import BaseCollection from '../base/base.collection.js';
 
 /**
  * ImportJobCollection - A collection class responsible for managing ImportJob entities.

package/src/v2/models/import-job/import-job.model.js

@@ -12,35 +12,6 @@
 
 import BaseModel from '../base/base.model.js';
 
-/**
- * Supported Import Options.
- */
-export const ImportOptions = {
-  ENABLE_JAVASCRIPT: 'enableJavascript',
-  PAGE_LOAD_TIMEOUT: 'pageLoadTimeout',
-};
-
-/**
- * Import Job Status types.
- * Any changes to this object needs to be reflected in the index.d.ts file as well.
- */
-export const ImportJobStatus = {
-  RUNNING: 'RUNNING',
-  COMPLETE: 'COMPLETE',
-  FAILED: 'FAILED',
-  STOPPED: 'STOPPED',
-};
-
-/**
- * ImportURL Status types.
- * Any changes to this object needs to be reflected in the index.d.ts file as well.
- */
-export const ImportUrlStatus = {
-  PENDING: 'PENDING',
-  REDIRECT: 'REDIRECT',
-  ...ImportJobStatus,
-};
-
 /**
  * ImportJob - A class representing an ImportJob entity.
  * Provides methods to access and manipulate ImportJob-specific data.
@@ -49,6 +20,35 @@ export const ImportUrlStatus = {
  * @extends BaseModel
  */
 class ImportJob extends BaseModel {
+  /**
+   * Import Job Status types.
+   * Any changes to this object needs to be reflected in the index.d.ts file as well.
+   */
+  static ImportJobStatus = {
+    RUNNING: 'RUNNING',
+    COMPLETE: 'COMPLETE',
+    FAILED: 'FAILED',
+    STOPPED: 'STOPPED',
+  };
+
+  /**
+   * ImportURL Status types.
+   * Any changes to this object needs to be reflected in the index.d.ts file as well.
+   */
+  static ImportUrlStatus = {
+    PENDING: 'PENDING',
+    REDIRECT: 'REDIRECT',
+    ...ImportJob.ImportJobStatus,
+  };
+
+  /**
+   * Supported Import Options.
+   */
+  static ImportOptions = {
+    ENABLE_JAVASCRIPT: 'enableJavascript',
+    PAGE_LOAD_TIMEOUT: 'pageLoadTimeout',
+  };
+
   // add your custom methods or overrides here
 }
 

package/src/v2/models/import-job/import-job.schema.js

@@ -21,18 +21,18 @@ import {
 } from '@adobe/spacecat-shared-utils';
 
 import SchemaBuilder from '../base/schema.builder.js';
-import ImportJob, { ImportJobStatus, ImportOptions } from './import-job.model.js';
+import ImportJob from './import-job.model.js';
 import ImportJobCollection from './import-job.collection.js';
 
 const ImportOptionTypeValidator = {
-  [ImportOptions.ENABLE_JAVASCRIPT]: (value) => {
+  [ImportJob.ImportOptions.ENABLE_JAVASCRIPT]: (value) => {
     if (value !== true && value !== false) {
-      throw new Error(`Invalid value for ${ImportOptions.ENABLE_JAVASCRIPT}: ${value}`);
+      throw new Error(`Invalid value for ${ImportJob.ImportOptions.ENABLE_JAVASCRIPT}: ${value}`);
     }
   },
-  [ImportOptions.PAGE_LOAD_TIMEOUT]: (value) => {
+  [ImportJob.ImportOptions.PAGE_LOAD_TIMEOUT]: (value) => {
     if (!isInteger(value) || value < 0) {
-      throw new Error(`Invalid value for ${ImportOptions.PAGE_LOAD_TIMEOUT}: ${value}`);
+      throw new Error(`Invalid value for ${ImportJob.ImportOptions.PAGE_LOAD_TIMEOUT}: ${value}`);
     }
   },
 };
@@ -43,7 +43,7 @@ const validateOptions = (options) => {
   }
 
   const invalidOptions = Object.keys(options).filter(
-    (key) => !Object.values(ImportOptions)
+    (key) => !Object.values(ImportJob.ImportOptions)
       .some((value) => value.toLowerCase() === key.toLowerCase()),
   );
 
@@ -122,7 +122,7 @@ const schema = new SchemaBuilder(ImportJob, ImportJobCollection)
     validate: (value) => !value || isInteger(value),
   })
   .addAttribute('status', {
-    type: Object.values(ImportJobStatus),
+    type: Object.values(ImportJob.ImportJobStatus),
     required: true,
   })
   .addAttribute('startedAt', {

package/src/v2/models/import-url/import-url.model.js

@@ -12,8 +12,6 @@
 
 import BaseModel from '../base/base.model.js';
 
-export const IMPORT_URL_EXPIRES_IN_DAYS = 30;
-
 /**
  * ImportUrl - A class representing an ImportUrl entity.
  * Provides methods to access and manipulate ImportUrl-specific data.
@@ -22,6 +20,8 @@ export const IMPORT_URL_EXPIRES_IN_DAYS = 30;
  * @extends BaseModel
  */
 class ImportUrl extends BaseModel {
+  static IMPORT_URL_EXPIRES_IN_DAYS = 30;
+
   // add your custom methods or overrides here
 }
 

package/src/v2/models/import-url/import-url.schema.js

@@ -14,10 +14,10 @@
 
 import { isIsoDate, isValidUrl } from '@adobe/spacecat-shared-utils';
 
-import { ImportUrlStatus } from '../import-job/import-job.model.js';
 import SchemaBuilder from '../base/schema.builder.js';
-import ImportUrl, { IMPORT_URL_EXPIRES_IN_DAYS } from './import-url.model.js';
+import ImportUrl from './import-url.model.js';
 import ImportUrlCollection from './import-url.collection.js';
+import { ImportJob } from '../import-job/index.js';
 
 /*
 Schema Doc: https://electrodb.dev/en/modeling/schema/
@@ -33,7 +33,7 @@ const schema = new SchemaBuilder(ImportUrl, ImportUrlCollection)
     validate: (value) => isIsoDate(value),
     default: () => {
       const date = new Date();
-      date.setDate(date.getDate() + IMPORT_URL_EXPIRES_IN_DAYS);
+      date.setDate(date.getDate() + ImportUrl.IMPORT_URL_EXPIRES_IN_DAYS);
       return date.toISOString();
     },
   })
@@ -47,7 +47,7 @@ const schema = new SchemaBuilder(ImportUrl, ImportUrlCollection)
     type: 'string',
   })
   .addAttribute('status', {
-    type: Object.values(ImportUrlStatus),
+    type: Object.values(ImportJob.ImportUrlStatus),
     required: true,
   })
   .addAttribute('url', {

package/src/v2/models/key-event/key-event.model.js

@@ -12,17 +12,6 @@
 
 import BaseModel from '../base/base.model.js';
 
-export const KEY_EVENT_TYPES = {
-  PERFORMANCE: 'PERFORMANCE',
-  SEO: 'SEO',
-  CONTENT: 'CONTENT',
-  CODE: 'CODE',
-  THIRD_PARTY: 'THIRD PARTY',
-  EXPERIMENTATION: 'EXPERIMENTATION',
-  NETWORK: 'NETWORK',
-  STATUS_CHANGE: 'STATUS CHANGE',
-};
-
 /**
  * KeyEvent - A class representing an KeyEvent entity.
  * Provides methods to access and manipulate KeyEvent-specific data.
@@ -31,6 +20,17 @@ export const KEY_EVENT_TYPES = {
  * @extends BaseModel
  */
 class KeyEvent extends BaseModel {
+  static KEY_EVENT_TYPES = {
+    PERFORMANCE: 'PERFORMANCE',
+    SEO: 'SEO',
+    CONTENT: 'CONTENT',
+    CODE: 'CODE',
+    THIRD_PARTY: 'THIRD PARTY',
+    EXPERIMENTATION: 'EXPERIMENTATION',
+    NETWORK: 'NETWORK',
+    STATUS_CHANGE: 'STATUS CHANGE',
+  };
+
   // add your custom methods or overrides here
 }
 

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

@@ -15,7 +15,6 @@
 import { hasText, isIsoDate } from '@adobe/spacecat-shared-utils';
 
 import SchemaBuilder from '../base/schema.builder.js';
-import { KEY_EVENT_TYPES } from '../../../models/key-event.js';
 import KeyEvent from './key-event.model.js';
 import KeyEventCollection from './key-event.collection.js';
 
@@ -33,7 +32,7 @@ const schema = new SchemaBuilder(KeyEvent, KeyEventCollection)
     validate: (value) => hasText(value),
   })
   .addAttribute('type', {
-    type: Object.values(KEY_EVENT_TYPES),
+    type: Object.values(KeyEvent.KEY_EVENT_TYPES),
     required: true,
   })
   .addAttribute('time', {

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

@@ -11,7 +11,7 @@
  */
 
 import type {
-  Audit, BaseCollection, BaseModel, Opportunity, Site,
+  Audit, BaseCollection, BaseModel, Opportunity, QueryOptions, Site,
 } from '../index';
 
 export interface LatestAudit extends BaseModel {
@@ -32,7 +32,7 @@ export interface LatestAudit extends BaseModel {
 export interface LatestAuditCollection extends BaseCollection<LatestAudit> {
   allByAuditId(auditId: string): Promise<LatestAudit[]>;
   allByAuditIdAndAuditType(auditId: string, auditType: string): Promise<LatestAudit[]>;
-  allByAuditType(auditType: string): Promise<LatestAudit[]>;
+  allByAuditType(auditType: string, options?: QueryOptions): Promise<LatestAudit[]>;
   allBySiteId(siteId: string): Promise<LatestAudit[]>;
   allBySiteIdAndAuditType(siteId: string, auditType: string): Promise<LatestAudit[]>;
   findByAuditId(auditId: string): Promise<LatestAudit | null>;

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

@@ -14,7 +14,7 @@
 
 import { isIsoDate, isNonEmptyObject } from '@adobe/spacecat-shared-utils';
 
-import { validateAuditResult } from '../audit/audit.model.js';
+import Audit from '../audit/audit.model.js';
 import SchemaBuilder from '../base/schema.builder.js';
 import LatestAudit from './latest-audit.model.js';
 import LatestAuditCollection from './latest-audit.collection.js';
@@ -41,7 +41,7 @@ const schema = new SchemaBuilder(LatestAudit, LatestAuditCollection)
     set: (value, attributes) => {
       // as the electroDb validate function does not provide access to the model instance
       // we need to call the validate function from the model on setting the value
-      validateAuditResult(value, attributes.auditType);
+      Audit.validateAuditResult(value, attributes.auditType);
       return value;
     },
   })

package/src/v2/models/opportunity/opportunity.model.js

@@ -12,19 +12,6 @@
 
 import BaseModel from '../base/base.model.js';
 
-export const ORIGINS = {
-  ESS_OPS: 'ESS_OPS',
-  AI: 'AI',
-  AUTOMATION: 'AUTOMATION',
-};
-
-export const STATUSES = {
-  NEW: 'NEW',
-  IN_PROGRESS: 'IN_PROGRESS',
-  IGNORED: 'IGNORED',
-  RESOLVED: 'RESOLVED',
-};
-
 /**
  * Opportunity - A class representing an Opportunity entity.
  * Provides methods to access and manipulate Opportunity-specific data,
@@ -35,6 +22,19 @@ export const STATUSES = {
  */
 
 class Opportunity extends BaseModel {
+  static ORIGINS = {
+    ESS_OPS: 'ESS_OPS',
+    AI: 'AI',
+    AUTOMATION: 'AUTOMATION',
+  };
+
+  static STATUSES = {
+    NEW: 'NEW',
+    IN_PROGRESS: 'IN_PROGRESS',
+    IGNORED: 'IGNORED',
+    RESOLVED: 'RESOLVED',
+  };
+
   /**
    * Adds the given suggestions to this Opportunity. Sets this opportunity as the parent
    * of each suggestion, as such the opportunity ID does not need to be provided.

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

@@ -15,7 +15,7 @@
 import { isNonEmptyObject, isValidUrl } from '@adobe/spacecat-shared-utils';
 
 import SchemaBuilder from '../base/schema.builder.js';
-import Opportunity, { ORIGINS, STATUSES } from './opportunity.model.js';
+import Opportunity from './opportunity.model.js';
 import OpportunityCollection from './opportunity.collection.js';
 
 /*
@@ -43,7 +43,7 @@ const schema = new SchemaBuilder(Opportunity, OpportunityCollection)
     validate: (value) => !value || isNonEmptyObject(value),
   })
   .addAttribute('origin', {
-    type: Object.values(ORIGINS),
+    type: Object.values(Opportunity.ORIGINS),
     required: true,
   })
   .addAttribute('title', {
@@ -54,7 +54,7 @@ const schema = new SchemaBuilder(Opportunity, OpportunityCollection)
     type: 'string',
   })
   .addAttribute('status', {
-    type: Object.values(STATUSES),
+    type: Object.values(Opportunity.STATUSES),
     required: true,
     default: 'NEW',
   })

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

@@ -43,7 +43,6 @@ export interface Site extends BaseModel {
   getKeyEvents(): Promise<KeyEvent[]>
   getKeyEventsByTimestamp(timestamp: string): Promise<KeyEvent[]>
   getLatestAudit(): Promise<LatestAudit>;
-  getLatestAuditByAuditType(auditType: string): Promise<LatestAudit>;
   getLatestAudits(): Promise<LatestAudit>;
   getLatestAuditByAuditType(auditType: string): Promise<LatestAudit>;
   getOpportunities(): Promise<Opportunity[]>;
@@ -74,6 +73,7 @@ export interface SiteCollection extends BaseCollection<Organization> {
   allByDeliveryType(deliveryType: string): Promise<Site[]>;
   allByOrganizationId(organizationId: string): Promise<Site[]>;
   allSitesToAudit(): Promise<string[]>;
+  allWithLatestAudit(auditType: string, order?: string, deliveryType?: string): Promise<Site[]>;
   findByBaseURL(baseURL: string): Promise<Site | null>;
   findByDeliveryType(deliveryType: string): Promise<Site | null>;
   findByOrganizationId(organizationId: string): Promise<Site | null>;

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

@@ -10,8 +10,13 @@
  * governing permissions and limitations under the License.
  */
 
+import { hasText } from '@adobe/spacecat-shared-utils';
+
+import DataAccessError from '../../errors/data-access.error.js';
 import BaseCollection from '../base/base.collection.js';
 
+import Site from './site.model.js';
+
 /**
  * SiteCollection - A collection class responsible for managing Site entities.
  * Extends the BaseCollection to provide specific methods for interacting with Site records.
@@ -23,6 +28,47 @@ class SiteCollection extends BaseCollection {
   async allSitesToAudit() {
     return (await this.all({ attributes: ['siteId'] })).map((site) => site.getId());
   }
+
+  async allWithLatestAudit(auditType, order = 'asc', deliveryType = null) {
+    if (!hasText(auditType)) {
+      throw new DataAccessError('auditType is required', this);
+    }
+
+    const latestAuditCollection = this.entityRegistry.getCollection('LatestAuditCollection');
+
+    const sitesQuery = Object.values(Site.DELIVERY_TYPES)
+      .includes(deliveryType)
+      ? this.allByDeliveryType(deliveryType)
+      : this.all();
+
+    const [sites, latestAudits] = await Promise.all([
+      sitesQuery,
+      latestAuditCollection.all([auditType], { order }),
+    ]);
+
+    const sitesMap = new Map(sites.map((site) => [site.getId(), site]));
+    const orderedSites = [];
+
+    // First, append sites with a latest audit in the sorted order
+    latestAudits.forEach((audit) => {
+      const site = sitesMap.get(audit.getSiteId());
+      if (site) {
+        // eslint-disable-next-line no-underscore-dangle
+        site._accessorCache['getLatestAuditByAuditType:_'] = audit;
+        orderedSites.push(site);
+        sitesMap.delete(site.getId()); // Remove the site from the map to avoid adding it again
+      }
+    });
+
+    // Then, append the remaining sites (without a latest audit)
+    sitesMap.forEach((site) => {
+      // eslint-disable-next-line no-underscore-dangle,no-param-reassign
+      site._accessorCache['getLatestAuditByAuditType:_'] = null;
+      orderedSites.push(site);
+    });
+
+    return orderedSites;
+  }
 }
 
 export default SiteCollection;

package/src/v2/models/site/site.model.js

@@ -13,20 +13,20 @@
 import { Config } from '../../../models/site/config.js';
 import BaseModel from '../base/base.model.js';
 
-export const DELIVERY_TYPES = {
-  AEM_CS: 'aem_cs',
-  AEM_EDGE: 'aem_edge',
-  OTHER: 'other',
-};
-
-export const DEFAULT_DELIVERY_TYPE = DELIVERY_TYPES.AEM_EDGE;
-
 /**
  * A class representing a Site entity. Provides methods to access and manipulate Site-specific data.
  * @class Site
  * @extends BaseModel
  */
 class Site extends BaseModel {
+  static DELIVERY_TYPES = {
+    AEM_CS: 'aem_cs',
+    AEM_EDGE: 'aem_edge',
+    OTHER: 'other',
+  };
+
+  static DEFAULT_DELIVERY_TYPE = Site.DELIVERY_TYPES.AEM_EDGE;
+
   getConfig() {
     return Config(this.record.config);
   }

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

@@ -22,10 +22,7 @@ import {
 import { Config, DEFAULT_CONFIG, validateConfiguration } from '../../../models/site/config.js';
 import SchemaBuilder from '../base/schema.builder.js';
 
-import Site, {
-  DEFAULT_DELIVERY_TYPE,
-  DELIVERY_TYPES,
-} from './site.model.js';
+import Site from './site.model.js';
 import SiteCollection from './site.collection.js';
 
 /*
@@ -59,8 +56,8 @@ const schema = new SchemaBuilder(Site, SiteCollection)
     get: (value) => Config(value),
   })
   .addAttribute('deliveryType', {
-    type: Object.values(DELIVERY_TYPES),
-    default: DEFAULT_DELIVERY_TYPE,
+    type: Object.values(Site.DELIVERY_TYPES),
+    default: Site.DEFAULT_DELIVERY_TYPE,
     required: true,
   })
   .addAttribute('gitHubURL', {

package/src/v2/models/site-candidate/site-candidate.model.js

@@ -12,21 +12,6 @@
 
 import BaseModel from '../base/base.model.js';
 
-export const DEFAULT_UPDATED_BY = 'spacecat';
-
-export const SITE_CANDIDATE_SOURCES = {
-  SPACECAT_SLACK_BOT: 'SPACECAT_SLACK_BOT',
-  RUM: 'RUM',
-  CDN: 'CDN',
-};
-
-export const SITE_CANDIDATE_STATUS = {
-  PENDING: 'PENDING', // site candidate notification sent and waiting for human input
-  IGNORED: 'IGNORED', // site candidate discarded: not to be added to star catalogue
-  APPROVED: 'APPROVED', // site candidate is added to star catalogue
-  ERROR: 'ERROR', // site candidate is discovered
-};
-
 /**
  * SiteCandidate - A class representing an SiteCandidate entity.
  * Provides methods to access and manipulate SiteCandidate-specific data.
@@ -35,6 +20,21 @@ export const SITE_CANDIDATE_STATUS = {
  * @extends BaseModel
  */
 class SiteCandidate extends BaseModel {
+  static DEFAULT_UPDATED_BY = 'spacecat';
+
+  static SITE_CANDIDATE_SOURCES = {
+    SPACECAT_SLACK_BOT: 'SPACECAT_SLACK_BOT',
+    RUM: 'RUM',
+    CDN: 'CDN',
+  };
+
+  static SITE_CANDIDATE_STATUS = {
+    PENDING: 'PENDING', // site candidate notification sent and waiting for human input
+    IGNORED: 'IGNORED', // site candidate discarded: not to be added to star catalogue
+    APPROVED: 'APPROVED', // site candidate is added to star catalogue
+    ERROR: 'ERROR', // site candidate is discovered
+  };
+
   // add your custom methods or overrides here
 }
 

package/src/v2/models/site-candidate/site-candidate.schema.js

@@ -17,7 +17,7 @@ import { isObject, isValidUrl } from '@adobe/spacecat-shared-utils';
 import { validate as uuidValidate } from 'uuid';
 
 import SchemaBuilder from '../base/schema.builder.js';
-import SiteCandidate, { SITE_CANDIDATE_SOURCES, SITE_CANDIDATE_STATUS } from './site-candidate.model.js';
+import SiteCandidate from './site-candidate.model.js';
 import SiteCandidateCollection from './site-candidate.collection.js';
 
 /*
@@ -44,11 +44,11 @@ const schema = new SchemaBuilder(SiteCandidate, SiteCandidateCollection)
     validate: (value) => isObject(value),
   })
   .addAttribute('source', {
-    type: Object.values(SITE_CANDIDATE_SOURCES),
+    type: Object.values(SiteCandidate.SITE_CANDIDATE_SOURCES),
     required: true,
   })
   .addAttribute('status', {
-    type: Object.values(SITE_CANDIDATE_STATUS),
+    type: Object.values(SiteCandidate.SITE_CANDIDATE_STATUS),
     required: true,
   })
   .addAttribute('updatedBy', {

package/src/v2/models/site-top-page/site-top-page.model.js

@@ -12,8 +12,6 @@
 
 import BaseModel from '../base/base.model.js';
 
-export const DEFAULT_GEO = 'global';
-
 /**
  * SiteTopPage - A class representing an SiteTopPage entity.
  * Provides methods to access and manipulate SiteTopPage-specific data.
@@ -22,6 +20,8 @@ export const DEFAULT_GEO = 'global';
  * @extends BaseModel
  */
 class SiteTopPage extends BaseModel {
+  static DEFAULT_GEO = 'global';
+
   // add your custom methods or overrides here
 }
 

package/src/v2/models/site-top-page/site-top-page.schema.js

@@ -17,7 +17,7 @@ import { isInteger, isIsoDate, isValidUrl } from '@adobe/spacecat-shared-utils';
 import { validate as uuidValidate } from 'uuid';
 
 import SchemaBuilder from '../base/schema.builder.js';
-import SiteTopPage, { DEFAULT_GEO } from './site-top-page.model.js';
+import SiteTopPage from './site-top-page.model.js';
 import SiteTopPageCollection from './site-top-page.collection.js';
 
 /*
@@ -53,7 +53,7 @@ const schema = new SchemaBuilder(SiteTopPage, SiteTopPageCollection)
   .addAttribute('geo', {
     type: 'string',
     required: false,
-    default: DEFAULT_GEO,
+    default: SiteTopPage.DEFAULT_GEO,
   })
   .addAttribute('importedAt', {
     type: 'string',

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

@@ -11,7 +11,7 @@
  */
 
 import BaseCollection from '../base/base.collection.js';
-import { STATUSES } from './suggestion.model.js';
+import Suggestion from './suggestion.model.js';
 
 /**
  * SuggestionCollection - A collection class responsible for managing Suggestion entities.
@@ -38,8 +38,8 @@ class SuggestionCollection extends BaseCollection {
       throw new Error('Suggestions must be an array');
     }
 
-    if (!Object.values(STATUSES).includes(status)) {
-      throw new Error(`Invalid status: ${status}. Must be one of: ${Object.values(STATUSES).join(', ')}`);
+    if (!Object.values(Suggestion.STATUSES).includes(status)) {
+      throw new Error(`Invalid status: ${status}. Must be one of: ${Object.values(Suggestion.STATUSES).join(', ')}`);
     }
 
     suggestions.forEach((suggestion) => {

package/src/v2/models/suggestion/suggestion.model.js

@@ -12,21 +12,6 @@
 
 import BaseModel from '../base/base.model.js';
 
-export const STATUSES = {
-  NEW: 'NEW',
-  APPROVED: 'APPROVED',
-  SKIPPED: 'SKIPPED',
-  FIXED: 'FIXED',
-  ERROR: 'ERROR',
-};
-
-export const TYPES = {
-  CODE_CHANGE: 'CODE_CHANGE',
-  CONTENT_UPDATE: 'CONTENT_UPDATE',
-  REDIRECT_UPDATE: 'REDIRECT_UPDATE',
-  METADATA_UPDATE: 'METADATA_UPDATE',
-};
-
 /**
  * Suggestion - A class representing a Suggestion entity.
  * Provides methods to access and manipulate Suggestion-specific data,
@@ -36,6 +21,21 @@ export const TYPES = {
  * @extends BaseModel
  */
 class Suggestion extends BaseModel {
+  static STATUSES = {
+    NEW: 'NEW',
+    APPROVED: 'APPROVED',
+    SKIPPED: 'SKIPPED',
+    FIXED: 'FIXED',
+    ERROR: 'ERROR',
+  };
+
+  static TYPES = {
+    CODE_CHANGE: 'CODE_CHANGE',
+    CONTENT_UPDATE: 'CONTENT_UPDATE',
+    REDIRECT_UPDATE: 'REDIRECT_UPDATE',
+    METADATA_UPDATE: 'METADATA_UPDATE',
+  };
+
   // add your customized methods here
 }
 

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

@@ -15,7 +15,7 @@
 import { isNonEmptyObject } from '@adobe/spacecat-shared-utils';
 
 import SchemaBuilder from '../base/schema.builder.js';
-import Suggestion, { STATUSES, TYPES } from './suggestion.model.js';
+import Suggestion from './suggestion.model.js';
 import SuggestionCollection from './suggestion.collection.js';
 
 /*
@@ -27,7 +27,7 @@ Indexes Doc: https://electrodb.dev/en/modeling/indexes/
 const schema = new SchemaBuilder(Suggestion, SuggestionCollection)
   .addReference('belongs_to', 'Opportunity', ['status', 'rank'])
   .addAttribute('type', {
-    type: Object.values(TYPES),
+    type: Object.values(Suggestion.TYPES),
     required: true,
     readOnly: true,
   })
@@ -45,9 +45,9 @@ const schema = new SchemaBuilder(Suggestion, SuggestionCollection)
     validate: (value) => !value || isNonEmptyObject(value),
   })
   .addAttribute('status', {
-    type: Object.values(STATUSES),
+    type: Object.values(Suggestion.STATUSES),
     required: true,
-    default: STATUSES.NEW,
+    default: Suggestion.STATUSES.NEW,
   });
 
 export default schema.build();