@adobe/spacecat-shared-data-access 2.65.2 → 2.66.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-data-access-v2.66.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.65.2...@adobe/spacecat-shared-data-access-v2.66.0) (2025-10-03)
+
+
+### Features
+
+* Add configuration methods to register audits ([#1000](https://github.com/adobe/spacecat-shared/issues/1000)) ([f58670e](https://github.com/adobe/spacecat-shared/commit/f58670e5b3561bef09911102cc947fa6ba2a4955))
+
 # [@adobe/spacecat-shared-data-access-v2.65.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.65.1...@adobe/spacecat-shared-data-access-v2.65.2) (2025-10-01)
 
 

package/package.json

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

package/src/models/configuration/configuration.model.js

@@ -14,6 +14,7 @@ import { isNonEmptyObject, isNonEmptyArray } from '@adobe/spacecat-shared-utils'
 
 import { sanitizeIdAndAuditFields } from '../../util/util.js';
 import BaseModel from '../base/base.model.js';
+import { Audit } from '../audit/index.js';
 
 /**
  * Configuration - A class representing an Configuration entity.
@@ -248,6 +249,70 @@ class Configuration extends BaseModel {
     this.updateHandlerOrgs(type, orgId, false);
   }
 
+  registerAudit(type, enabledByDefault = false, interval = Configuration.JOB_INTERVALS.NEVER) {
+    // Validate audit type
+    if (!Object.values(Audit.AUDIT_TYPES).includes(type)) {
+      throw new Error(`Audit type ${type} is not a valid audit type in the data model`);
+    }
+
+    // Validate job interval
+    if (!Object.values(Configuration.JOB_INTERVALS).includes(interval)) {
+      throw new Error(`Invalid interval ${interval}`);
+    }
+
+    // Add to handlers if not already registered
+    const handlers = this.getHandlers();
+    if (!handlers[type]) {
+      handlers[type] = {
+        enabledByDefault,
+        enabled: {
+          sites: [],
+          orgs: [],
+        },
+        disabled: {
+          sites: [],
+          orgs: [],
+        },
+        dependencies: [],
+      };
+      this.setHandlers(handlers);
+    }
+
+    // Add to jobs if not already registered
+    const jobs = this.getJobs();
+    const exists = jobs.find((job) => job.group === 'audits' && job.type === type);
+    if (!exists) {
+      jobs.push({
+        group: 'audits',
+        type,
+        interval,
+      });
+      this.setJobs(jobs);
+    }
+  }
+
+  unregisterAudit(type) {
+    // Validate audit type
+    if (!Object.values(Audit.AUDIT_TYPES).includes(type)) {
+      throw new Error(`Audit type ${type} is not a valid audit type in the data model`);
+    }
+
+    // Remove from handlers
+    const handlers = this.getHandlers();
+    if (handlers[type]) {
+      delete handlers[type];
+      this.setHandlers(handlers);
+    }
+
+    // Remove from jobs
+    const jobs = this.getJobs();
+    const jobIndex = jobs.findIndex((job) => job.group === 'audits' && job.type === type);
+    if (jobIndex !== -1) {
+      jobs.splice(jobIndex, 1);
+      this.setJobs(jobs);
+    }
+  }
+
   async save() {
     return this.collection.create(sanitizeIdAndAuditFields(this.constructor.name, this.toJSON()));
   }

package/src/models/configuration/index.d.ts

@@ -39,6 +39,8 @@ export interface Configuration extends BaseModel {
   setSlackRoles(slackRoles: object): void;
   updateHandlerOrgs(type: string, orgId: string, enabled: boolean): void;
   updateHandlerSites(type: string, siteId: string, enabled: boolean): void;
+  registerAudit(type: string, enabledByDefault?: boolean, interval?: string): void;
+  unregisterAudit(type: string): void;
 }
 
 export interface ConfigurationCollection extends BaseCollection<Configuration> {