@adobe/spacecat-shared-data-access 2.88.7 → 2.88.9

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-data-access-v2.88.9](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.88.8...@adobe/spacecat-shared-data-access-v2.88.9) (2025-12-04)
+
+
+### Bug Fixes
+
+* adding toc audit type ([#1214](https://github.com/adobe/spacecat-shared/issues/1214)) ([7dab7d7](https://github.com/adobe/spacecat-shared/commit/7dab7d7afdcd4b56a56c10b65a3dff0fefb52e4e))
+
+# [@adobe/spacecat-shared-data-access-v2.88.8](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.88.7...@adobe/spacecat-shared-data-access-v2.88.8) (2025-12-01)
+
+
+### Bug Fixes
+
+* use correct model name ([#1199](https://github.com/adobe/spacecat-shared/issues/1199)) ([3f5fb03](https://github.com/adobe/spacecat-shared/commit/3f5fb036c961036367376617d04bc1a7181146b1)), closes [#pk](https://github.com/adobe/spacecat-shared/issues/pk) [#sk](https://github.com/adobe/spacecat-shared/issues/sk)
+
 # [@adobe/spacecat-shared-data-access-v2.88.7](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.88.6...@adobe/spacecat-shared-data-access-v2.88.7) (2025-11-30)
 
 

package/package.json

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

package/src/models/audit/audit.model.js

@@ -79,6 +79,7 @@ class Audit extends BaseModel {
     LLMO_REFERRAL_TRAFFIC: 'llmo-referral-traffic',
     PAGE_INTENT: 'page-intent',
     NO_CTA_ABOVE_THE_FOLD: 'no-cta-above-the-fold',
+    TOC: 'toc',
   };
 
   static AUDIT_TYPE_PROPERTIES = {

package/src/models/base/entity.registry.js

@@ -11,17 +11,74 @@
  */
 
 import { DataAccessError } from '../../errors/index.js';
-import { collectionNameToEntityName } from '../../util/util.js';
-import { ENTITY_DEFINITIONS } from './entity-definitions.js';
+import { collectionNameToEntityName, decapitalize } from '../../util/util.js';
+
+import ApiKeyCollection from '../api-key/api-key.collection.js';
+import AsyncJobCollection from '../async-job/async-job.collection.js';
+import AuditCollection from '../audit/audit.collection.js';
+import ConfigurationCollection from '../configuration/configuration.collection.js';
+import ExperimentCollection from '../experiment/experiment.collection.js';
+import EntitlementCollection from '../entitlement/entitlement.collection.js';
+import FixEntityCollection from '../fix-entity/fix-entity.collection.js';
+import FixEntitySuggestionCollection from '../fix-entity-suggestion/fix-entity-suggestion.collection.js';
+import ImportJobCollection from '../import-job/import-job.collection.js';
+import ImportUrlCollection from '../import-url/import-url.collection.js';
+import KeyEventCollection from '../key-event/key-event.collection.js';
+import LatestAuditCollection from '../latest-audit/latest-audit.collection.js';
+import OpportunityCollection from '../opportunity/opportunity.collection.js';
+import OrganizationCollection from '../organization/organization.collection.js';
+import ProjectCollection from '../project/project.collection.js';
+import ScrapeJobCollection from '../scrape-job/scrape-job.collection.js';
+import ScrapeUrlCollection from '../scrape-url/scrape-url.collection.js';
+import SiteCandidateCollection from '../site-candidate/site-candidate.collection.js';
+import SiteCollection from '../site/site.collection.js';
+import SiteEnrollmentCollection from '../site-enrollment/site-enrollment.collection.js';
+import SiteTopFormCollection from '../site-top-form/site-top-form.collection.js';
+import SiteTopPageCollection from '../site-top-page/site-top-page.collection.js';
+import SuggestionCollection from '../suggestion/suggestion.collection.js';
+import PageIntentCollection from '../page-intent/page-intent.collection.js';
+import ReportCollection from '../report/report.collection.js';
+import TrialUserCollection from '../trial-user/trial-user.collection.js';
+import TrialUserActivityCollection from '../trial-user-activity/trial-user-activity.collection.js';
+import PageCitabilityCollection from '../page-citability/page-citability.collection.js';
+
+import ApiKeySchema from '../api-key/api-key.schema.js';
+import AsyncJobSchema from '../async-job/async-job.schema.js';
+import AuditSchema from '../audit/audit.schema.js';
+import ConfigurationSchema from '../configuration/configuration.schema.js';
+import EntitlementSchema from '../entitlement/entitlement.schema.js';
+import FixEntitySchema from '../fix-entity/fix-entity.schema.js';
+import FixEntitySuggestionSchema from '../fix-entity-suggestion/fix-entity-suggestion.schema.js';
+import ExperimentSchema from '../experiment/experiment.schema.js';
+import ImportJobSchema from '../import-job/import-job.schema.js';
+import ImportUrlSchema from '../import-url/import-url.schema.js';
+import KeyEventSchema from '../key-event/key-event.schema.js';
+import LatestAuditSchema from '../latest-audit/latest-audit.schema.js';
+import OpportunitySchema from '../opportunity/opportunity.schema.js';
+import OrganizationSchema from '../organization/organization.schema.js';
+import ProjectSchema from '../project/project.schema.js';
+import ScrapeJobSchema from '../scrape-job/scrape-job.schema.js';
+import ScrapeUrlSchema from '../scrape-url/scrape-url.schema.js';
+import SiteSchema from '../site/site.schema.js';
+import SiteCandidateSchema from '../site-candidate/site-candidate.schema.js';
+import SiteEnrollmentSchema from '../site-enrollment/site-enrollment.schema.js';
+import SiteTopFormSchema from '../site-top-form/site-top-form.schema.js';
+import SiteTopPageSchema from '../site-top-page/site-top-page.schema.js';
+import SuggestionSchema from '../suggestion/suggestion.schema.js';
+import PageIntentSchema from '../page-intent/page-intent.schema.js';
+import ReportSchema from '../report/report.schema.js';
+import TrialUserSchema from '../trial-user/trial-user.schema.js';
+import TrialUserActivitySchema from '../trial-user-activity/trial-user-activity.schema.js';
+import PageCitabilitySchema from '../page-citability/page-citability.schema.js';
 
 /**
  * EntityRegistry - A registry class responsible for managing entities, their schema and collection.
- * This implementation uses pure data structures (no static state) to be resilient
- * to bundler duplication.
  *
  * @class EntityRegistry
  */
 class EntityRegistry {
+  static entities = {};
+
   /**
    * Constructs an instance of EntityRegistry.
    * @constructor
@@ -42,7 +99,7 @@ class EntityRegistry {
    * @private
    */
   #initialize() {
-    ENTITY_DEFINITIONS.forEach(({ schema, collection: Collection }) => {
+    Object.values(EntityRegistry.entities).forEach(({ collection: Collection, schema }) => {
       const collection = new Collection(this.service, this, schema, this.log);
       this.collections.set(Collection.COLLECTION_NAME, collection);
     });
@@ -70,6 +127,46 @@ class EntityRegistry {
     }
     return collections;
   }
+
+  static getEntities() {
+    return Object.keys(this.entities).reduce((acc, key) => {
+      acc[key] = this.entities[key].schema.toElectroDBSchema();
+      return acc;
+    }, {});
+  }
+
+  static registerEntity(schema, collection) {
+    this.entities[decapitalize(schema.getEntityName())] = { schema, collection };
+  }
 }
 
+EntityRegistry.registerEntity(ApiKeySchema, ApiKeyCollection);
+EntityRegistry.registerEntity(AsyncJobSchema, AsyncJobCollection);
+EntityRegistry.registerEntity(AuditSchema, AuditCollection);
+EntityRegistry.registerEntity(ConfigurationSchema, ConfigurationCollection);
+EntityRegistry.registerEntity(EntitlementSchema, EntitlementCollection);
+EntityRegistry.registerEntity(FixEntitySchema, FixEntityCollection);
+EntityRegistry.registerEntity(FixEntitySuggestionSchema, FixEntitySuggestionCollection);
+EntityRegistry.registerEntity(ExperimentSchema, ExperimentCollection);
+EntityRegistry.registerEntity(ImportJobSchema, ImportJobCollection);
+EntityRegistry.registerEntity(ImportUrlSchema, ImportUrlCollection);
+EntityRegistry.registerEntity(KeyEventSchema, KeyEventCollection);
+EntityRegistry.registerEntity(LatestAuditSchema, LatestAuditCollection);
+EntityRegistry.registerEntity(OpportunitySchema, OpportunityCollection);
+EntityRegistry.registerEntity(OrganizationSchema, OrganizationCollection);
+EntityRegistry.registerEntity(ProjectSchema, ProjectCollection);
+EntityRegistry.registerEntity(ScrapeJobSchema, ScrapeJobCollection);
+EntityRegistry.registerEntity(ScrapeUrlSchema, ScrapeUrlCollection);
+EntityRegistry.registerEntity(SiteSchema, SiteCollection);
+EntityRegistry.registerEntity(SiteCandidateSchema, SiteCandidateCollection);
+EntityRegistry.registerEntity(SiteEnrollmentSchema, SiteEnrollmentCollection);
+EntityRegistry.registerEntity(SiteTopFormSchema, SiteTopFormCollection);
+EntityRegistry.registerEntity(SiteTopPageSchema, SiteTopPageCollection);
+EntityRegistry.registerEntity(SuggestionSchema, SuggestionCollection);
+EntityRegistry.registerEntity(PageIntentSchema, PageIntentCollection);
+EntityRegistry.registerEntity(ReportSchema, ReportCollection);
+EntityRegistry.registerEntity(TrialUserSchema, TrialUserCollection);
+EntityRegistry.registerEntity(TrialUserActivitySchema, TrialUserActivityCollection);
+EntityRegistry.registerEntity(PageCitabilitySchema, PageCitabilityCollection);
+
 export default EntityRegistry;

package/src/models/configuration/configuration.collection.js

@@ -27,7 +27,8 @@ class ConfigurationCollection extends BaseCollection {
   async create(data) {
     const latestConfiguration = await this.findLatest();
     const version = latestConfiguration ? incrementVersion(latestConfiguration.getVersion()) : 1;
-    const sanitizedData = sanitizeIdAndAuditFields('Organization', data);
+    const sanitizedData = sanitizeIdAndAuditFields('Configuration', data);
+
     sanitizedData.version = version;
 
     return super.create(sanitizedData);

package/src/models/site/config.js

@@ -14,6 +14,8 @@ import { isNonEmptyObject } from '@adobe/spacecat-shared-utils';
 import crypto from 'crypto';
 import Joi from 'joi';
 
+import { getLogger } from '../../util/logger-registry.js';
+
 export const IMPORT_TYPES = {
   LLMO_QUESTIONS_IMPORT_TYPE: 'llmo-prompts-ahrefs',
   ORGANIC_KEYWORDS: 'organic-keywords',
@@ -404,12 +406,13 @@ export const Config = (data = {}) => {
   try {
     configData = validateConfiguration(data);
   } catch (error) {
-    // Log validation errors to console as this is called from schema getters
-    // where we don't have access to the logger instance
-    console.error('Site configuration validation failed, using provided data', {
-      error: error.message,
-      invalidConfig: data,
-    });
+    const logger = getLogger();
+    if (logger && logger !== console) {
+      logger.error('Site configuration validation failed, using provided data', {
+        error: error.message,
+        invalidConfig: data,
+      });
+    }
     configData = { ...data };
   }
 

package/src/service/index.js

@@ -16,7 +16,7 @@ import { Service } from 'electrodb';
 
 import { instrumentAWSClient } from '@adobe/spacecat-shared-utils';
 import { EntityRegistry } from '../models/index.js';
-import { getEntitySchemas } from '../models/base/entity-definitions.js';
+import { registerLogger } from '../util/logger-registry.js';
 
 export * from '../errors/index.js';
 export * from '../models/index.js';
@@ -56,7 +56,7 @@ const createElectroService = (client, config, log) => {
   /* c8 ignore end */
 
   return new Service(
-    getEntitySchemas(),
+    EntityRegistry.getEntities(),
     {
       client,
       table,
@@ -74,6 +74,8 @@ const createElectroService = (client, config, log) => {
  * @returns {object} Data access collections for interacting with entities
  */
 export const createDataAccess = (config, log = console, client = undefined) => {
+  registerLogger(log);
+
   const rawClient = createRawClient(client);
   const electroService = createElectroService(rawClient, config, log);
   const entityRegistry = new EntityRegistry(electroService, log);

package/src/util/index.js

@@ -21,3 +21,8 @@ export {
   guardSet,
   guardString,
 } from './guards.js';
+
+export {
+  registerLogger,
+  getLogger,
+} from './logger-registry.js';

package/src/util/logger-registry.js

@@ -0,0 +1,50 @@
+/*
+ * Copyright 2025 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.
+ */
+
+class LoggerRegistry {
+  static #instance = null;
+
+  #logger = null;
+
+  static getInstance() {
+    if (!LoggerRegistry.#instance) {
+      LoggerRegistry.#instance = new LoggerRegistry();
+    }
+    return LoggerRegistry.#instance;
+  }
+
+  setLogger(logger) {
+    this.#logger = logger;
+  }
+
+  getLogger() {
+    return this.#logger || console;
+  }
+}
+
+/**
+ * Registers a logger instance for global access.
+ * This should be called during data access initialization.
+ * @param {Object} logger - Logger instance
+ */
+export function registerLogger(logger) {
+  LoggerRegistry.getInstance().setLogger(logger);
+}
+
+/**
+ * Gets the currently registered logger instance.
+ * Falls back to console if no logger is registered.
+ * @returns {Object} Logger instance
+ */
+export function getLogger() {
+  return LoggerRegistry.getInstance().getLogger();
+}

package/src/models/base/entity-definitions.js

@@ -1,122 +0,0 @@
-/*
- * Copyright 2025 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 { decapitalize } from '../../util/util.js';
-
-// Import all schemas
-import ApiKeySchema from '../api-key/api-key.schema.js';
-import AsyncJobSchema from '../async-job/async-job.schema.js';
-import AuditSchema from '../audit/audit.schema.js';
-import ConfigurationSchema from '../configuration/configuration.schema.js';
-import EntitlementSchema from '../entitlement/entitlement.schema.js';
-import FixEntitySchema from '../fix-entity/fix-entity.schema.js';
-import FixEntitySuggestionSchema from '../fix-entity-suggestion/fix-entity-suggestion.schema.js';
-import ExperimentSchema from '../experiment/experiment.schema.js';
-import ImportJobSchema from '../import-job/import-job.schema.js';
-import ImportUrlSchema from '../import-url/import-url.schema.js';
-import KeyEventSchema from '../key-event/key-event.schema.js';
-import LatestAuditSchema from '../latest-audit/latest-audit.schema.js';
-import OpportunitySchema from '../opportunity/opportunity.schema.js';
-import OrganizationSchema from '../organization/organization.schema.js';
-import ProjectSchema from '../project/project.schema.js';
-import ScrapeJobSchema from '../scrape-job/scrape-job.schema.js';
-import ScrapeUrlSchema from '../scrape-url/scrape-url.schema.js';
-import SiteSchema from '../site/site.schema.js';
-import SiteCandidateSchema from '../site-candidate/site-candidate.schema.js';
-import SiteEnrollmentSchema from '../site-enrollment/site-enrollment.schema.js';
-import SiteTopFormSchema from '../site-top-form/site-top-form.schema.js';
-import SiteTopPageSchema from '../site-top-page/site-top-page.schema.js';
-import SuggestionSchema from '../suggestion/suggestion.schema.js';
-import PageIntentSchema from '../page-intent/page-intent.schema.js';
-import ReportSchema from '../report/report.schema.js';
-import TrialUserSchema from '../trial-user/trial-user.schema.js';
-import TrialUserActivitySchema from '../trial-user-activity/trial-user-activity.schema.js';
-import PageCitabilitySchema from '../page-citability/page-citability.schema.js';
-
-// Import all collections
-import ApiKeyCollection from '../api-key/api-key.collection.js';
-import AsyncJobCollection from '../async-job/async-job.collection.js';
-import AuditCollection from '../audit/audit.collection.js';
-import ConfigurationCollection from '../configuration/configuration.collection.js';
-import EntitlementCollection from '../entitlement/entitlement.collection.js';
-import FixEntityCollection from '../fix-entity/fix-entity.collection.js';
-import FixEntitySuggestionCollection from '../fix-entity-suggestion/fix-entity-suggestion.collection.js';
-import ExperimentCollection from '../experiment/experiment.collection.js';
-import ImportJobCollection from '../import-job/import-job.collection.js';
-import ImportUrlCollection from '../import-url/import-url.collection.js';
-import KeyEventCollection from '../key-event/key-event.collection.js';
-import LatestAuditCollection from '../latest-audit/latest-audit.collection.js';
-import OpportunityCollection from '../opportunity/opportunity.collection.js';
-import OrganizationCollection from '../organization/organization.collection.js';
-import ProjectCollection from '../project/project.collection.js';
-import ScrapeJobCollection from '../scrape-job/scrape-job.collection.js';
-import ScrapeUrlCollection from '../scrape-url/scrape-url.collection.js';
-import SiteCollection from '../site/site.collection.js';
-import SiteCandidateCollection from '../site-candidate/site-candidate.collection.js';
-import SiteEnrollmentCollection from '../site-enrollment/site-enrollment.collection.js';
-import SiteTopFormCollection from '../site-top-form/site-top-form.collection.js';
-import SiteTopPageCollection from '../site-top-page/site-top-page.collection.js';
-import SuggestionCollection from '../suggestion/suggestion.collection.js';
-import PageIntentCollection from '../page-intent/page-intent.collection.js';
-import ReportCollection from '../report/report.collection.js';
-import TrialUserCollection from '../trial-user/trial-user.collection.js';
-import TrialUserActivityCollection from '../trial-user-activity/trial-user-activity.collection.js';
-import PageCitabilityCollection from '../page-citability/page-citability.collection.js';
-
-/**
- * Central registry of all entity definitions.
- * This is a plain constant array with no side effects.
- * Each entry pairs a schema with its collection class.
- */
-export const ENTITY_DEFINITIONS = [
-  { schema: ApiKeySchema, collection: ApiKeyCollection },
-  { schema: AsyncJobSchema, collection: AsyncJobCollection },
-  { schema: AuditSchema, collection: AuditCollection },
-  { schema: ConfigurationSchema, collection: ConfigurationCollection },
-  { schema: EntitlementSchema, collection: EntitlementCollection },
-  { schema: FixEntitySchema, collection: FixEntityCollection },
-  { schema: FixEntitySuggestionSchema, collection: FixEntitySuggestionCollection },
-  { schema: ExperimentSchema, collection: ExperimentCollection },
-  { schema: ImportJobSchema, collection: ImportJobCollection },
-  { schema: ImportUrlSchema, collection: ImportUrlCollection },
-  { schema: KeyEventSchema, collection: KeyEventCollection },
-  { schema: LatestAuditSchema, collection: LatestAuditCollection },
-  { schema: OpportunitySchema, collection: OpportunityCollection },
-  { schema: OrganizationSchema, collection: OrganizationCollection },
-  { schema: ProjectSchema, collection: ProjectCollection },
-  { schema: ScrapeJobSchema, collection: ScrapeJobCollection },
-  { schema: ScrapeUrlSchema, collection: ScrapeUrlCollection },
-  { schema: SiteSchema, collection: SiteCollection },
-  { schema: SiteCandidateSchema, collection: SiteCandidateCollection },
-  { schema: SiteEnrollmentSchema, collection: SiteEnrollmentCollection },
-  { schema: SiteTopFormSchema, collection: SiteTopFormCollection },
-  { schema: SiteTopPageSchema, collection: SiteTopPageCollection },
-  { schema: SuggestionSchema, collection: SuggestionCollection },
-  { schema: PageIntentSchema, collection: PageIntentCollection },
-  { schema: ReportSchema, collection: ReportCollection },
-  { schema: TrialUserSchema, collection: TrialUserCollection },
-  { schema: TrialUserActivitySchema, collection: TrialUserActivityCollection },
-  { schema: PageCitabilitySchema, collection: PageCitabilityCollection },
-];
-
-/**
- * Converts entity definitions to ElectroDB schema format.
- * This is a pure function with no side effects.
- *
- * @returns {Object} Map of entity names to ElectroDB schemas
- */
-export function getEntitySchemas() {
-  return ENTITY_DEFINITIONS.reduce((acc, { schema }) => {
-    acc[decapitalize(schema.getEntityName())] = schema.toElectroDBSchema();
-    return acc;
-  }, {});
-}