@adobe/spacecat-shared-data-access 2.88.2 → 2.88.3

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-data-access-v2.88.3](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.88.2...@adobe/spacecat-shared-data-access-v2.88.3) (2025-11-26)
+
+
+### Bug Fixes
+
+* Bundler-Agnostic Explicit COLLECTION_NAME ([#1174](https://github.com/adobe/spacecat-shared/issues/1174)) ([d08b4b8](https://github.com/adobe/spacecat-shared/commit/d08b4b82521da524dd37e64fa85258451dc4a3fa)), closes [#1173](https://github.com/adobe/spacecat-shared/issues/1173) [#1173](https://github.com/adobe/spacecat-shared/issues/1173) [#1173](https://github.com/adobe/spacecat-shared/issues/1173) [#1173](https://github.com/adobe/spacecat-shared/issues/1173)
+
 # [@adobe/spacecat-shared-data-access-v2.88.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.88.1...@adobe/spacecat-shared-data-access-v2.88.2) (2025-11-26)
 
 

package/package.json

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

package/src/models/api-key/api-key.collection.js

@@ -20,6 +20,8 @@ import BaseCollection from '../base/base.collection.js';
  * @extends BaseCollection
  */
 class ApiKeyCollection extends BaseCollection {
+  static COLLECTION_NAME = 'ApiKeyCollection';
+
   // add custom methods here
 }
 

package/src/models/async-job/async-job.collection.js

@@ -20,6 +20,8 @@ import BaseCollection from '../base/base.collection.js';
  * @extends BaseCollection
  */
 class AsyncJobCollection extends BaseCollection {
+  static COLLECTION_NAME = 'AsyncJobCollection';
+
   // Add custom methods or overrides here if needed
 }
 

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

@@ -20,6 +20,8 @@ import BaseCollection from '../base/base.collection.js';
  * @extends BaseCollection
  */
 class AuditCollection extends BaseCollection {
+  static COLLECTION_NAME = 'AuditCollection';
+
   // create a copy of the audit as a LatestAudit entity
   async _onCreate(item) {
     const collection = this.entityRegistry.getCollection('LatestAuditCollection');

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

@@ -47,6 +47,14 @@ function isValidParent(parent, child) {
  * @abstract
  */
 class BaseCollection {
+  /**
+   * The collection name for this collection. Must be overridden by subclasses.
+   * This ensures the collection name is explicit and not dependent on class names
+   * which can be mangled by bundlers.
+   * @type {string}
+   */
+  static COLLECTION_NAME = undefined;
+
   /**
    * Constructs an instance of BaseCollection.
    * @constructor

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

@@ -101,7 +101,7 @@ class EntityRegistry {
   #initialize() {
     Object.values(EntityRegistry.entities).forEach(({ collection: Collection, schema }) => {
       const collection = new Collection(this.service, this, schema, this.log);
-      this.collections.set(Collection.name, collection);
+      this.collections.set(Collection.COLLECTION_NAME, collection);
     });
   }
 

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

@@ -115,6 +115,10 @@ class SchemaBuilder {
       throw new SchemaBuilderError(this, `Model class ${modelClass.name} must define a static ENTITY_NAME property.`);
     }
 
+    if (!hasText(collectionClass.COLLECTION_NAME)) {
+      throw new SchemaBuilderError(this, `Collection class ${collectionClass.name} must define a static COLLECTION_NAME property.`);
+    }
+
     this.modelClass = modelClass;
     this.collectionClass = collectionClass;
     this.schemaVersion = schemaVersion;

package/src/models/base/schema.js

@@ -116,7 +116,7 @@ class Schema {
   }
 
   getCollectionName() {
-    return this.collectionClass.name;
+    return this.collectionClass.COLLECTION_NAME;
   }
 
   getEntityName() {
@@ -257,7 +257,7 @@ class Schema {
   }
 
   getModelName() {
-    return this.modelClass.name;
+    return this.modelClass.ENTITY_NAME;
   }
 
   /**

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

@@ -22,6 +22,8 @@ import BaseCollection from '../base/base.collection.js';
  * @extends BaseCollection
  */
 class ConfigurationCollection extends BaseCollection {
+  static COLLECTION_NAME = 'ConfigurationCollection';
+
   async create(data) {
     const latestConfiguration = await this.findLatest();
     const version = latestConfiguration ? incrementVersion(latestConfiguration.getVersion()) : 1;

package/src/models/entitlement/entitlement.collection.js

@@ -20,6 +20,8 @@ import BaseCollection from '../base/base.collection.js';
  * @extends BaseCollection
  */
 class EntitlementCollection extends BaseCollection {
+  static COLLECTION_NAME = 'EntitlementCollection';
+
   // add custom methods here
 }
 

package/src/models/experiment/experiment.collection.js

@@ -20,6 +20,8 @@ import BaseCollection from '../base/base.collection.js';
  * @extends BaseCollection
  */
 class ExperimentCollection extends BaseCollection {
+  static COLLECTION_NAME = 'ExperimentCollection';
+
   // add custom methods here
 }
 

package/src/models/fix-entity/fix-entity.collection.js

@@ -28,6 +28,8 @@ import { resolveUpdates } from '../../util/util.js';
  * @extends BaseCollection
  */
 class FixEntityCollection extends BaseCollection {
+  static COLLECTION_NAME = 'FixEntityCollection';
+
   /**
    * Gets all suggestions associated with a specific FixEntity.
    *

package/src/models/fix-entity-suggestion/fix-entity-suggestion.collection.js

@@ -26,6 +26,8 @@ import BaseCollection from '../base/base.collection.js';
  * @extends BaseCollection
  */
 class FixEntitySuggestionCollection extends BaseCollection {
+  static COLLECTION_NAME = 'FixEntitySuggestionCollection';
+
   /**
    * Gets all junction records associated with a specific Suggestion.
    *

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

@@ -23,6 +23,8 @@ import BaseCollection from '../base/base.collection.js';
  * @extends BaseCollection
  */
 class ImportJobCollection extends BaseCollection {
+  static COLLECTION_NAME = 'ImportJobCollection';
+
   async allByDateRange(startDate, endDate) {
     if (!isIsoDate(startDate)) {
       throw new ValidationError(`Invalid start date: ${startDate}`);

package/src/models/import-url/import-url.collection.js

@@ -20,6 +20,8 @@ import BaseCollection from '../base/base.collection.js';
  * @extends BaseCollection
  */
 class ImportUrlCollection extends BaseCollection {
+  static COLLECTION_NAME = 'ImportUrlCollection';
+
   // add custom methods here
 }
 

package/src/models/key-event/key-event.collection.js

@@ -20,6 +20,8 @@ import BaseCollection from '../base/base.collection.js';
  * @extends BaseCollection
  */
 class KeyEventCollection extends BaseCollection {
+  static COLLECTION_NAME = 'KeyEventCollection';
+
   // add custom methods here
 }
 

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

@@ -21,6 +21,8 @@ import { guardId, guardString } from '../../util/index.js';
  * @extends AuditCollection
  */
 class LatestAuditCollection extends BaseCollection {
+  static COLLECTION_NAME = 'LatestAuditCollection';
+
   async create(item) {
     return super.create(item, { upsert: true });
   }

package/src/models/opportunity/opportunity.collection.js

@@ -20,6 +20,8 @@ import BaseCollection from '../base/base.collection.js';
  * @extends BaseCollection
  */
 class OpportunityCollection extends BaseCollection {
+  static COLLECTION_NAME = 'OpportunityCollection';
+
   // add custom methods here
 }
 

package/src/models/organization/organization.collection.js

@@ -20,6 +20,8 @@ import BaseCollection from '../base/base.collection.js';
  * @extends BaseCollection
  */
 class OrganizationCollection extends BaseCollection {
+  static COLLECTION_NAME = 'OrganizationCollection';
+
   // add custom methods here
 }
 

package/src/models/page-citability/page-citability.collection.js

@@ -19,6 +19,8 @@ import BaseCollection from '../base/base.collection.js';
  * @extends BaseCollection
  */
 class PageCitabilityCollection extends BaseCollection {
+  static COLLECTION_NAME = 'PageCitabilityCollection';
+
   // add custom collection-level methods here, if needed
 }
 

package/src/models/page-intent/page-intent.collection.js

@@ -19,6 +19,8 @@ import BaseCollection from '../base/base.collection.js';
  * @extends BaseCollection
  */
 class PageIntentCollection extends BaseCollection {
+  static COLLECTION_NAME = 'PageIntentCollection';
+
   // add custom collection-level methods here, if needed
 }
 

package/src/models/project/project.collection.js

@@ -20,6 +20,7 @@ import BaseCollection from '../base/base.collection.js';
  * @extends BaseCollection
  */
 class ProjectCollection extends BaseCollection {
+  static COLLECTION_NAME = 'ProjectCollection';
 }
 
 export default ProjectCollection;

package/src/models/report/report.collection.js

@@ -20,6 +20,8 @@ import BaseCollection from '../base/base.collection.js';
  * @extends BaseCollection
  */
 class ReportCollection extends BaseCollection {
+  static COLLECTION_NAME = 'ReportCollection';
+
   async create(item) {
     const report = await super.create(item, { upsert: true });
 

package/src/models/scrape-job/scrape-job.collection.js

@@ -23,6 +23,8 @@ import BaseCollection from '../base/base.collection.js';
  * @extends BaseCollection
  */
 class ScrapeJobCollection extends BaseCollection {
+  static COLLECTION_NAME = 'ScrapeJobCollection';
+
   async allByDateRange(startDate, endDate) {
     if (!isIsoDate(startDate)) {
       throw new ValidationError(`Invalid start date: ${startDate}`);

package/src/models/scrape-url/scrape-url.collection.js

@@ -20,6 +20,8 @@ import BaseCollection from '../base/base.collection.js';
  * @extends BaseCollection
  */
 class ScrapeUrlCollection extends BaseCollection {
+  static COLLECTION_NAME = 'ScrapeUrlCollection';
+
   async allRecentByUrlAndProcessingType(url, processingType, maxAgeInHours = 168) {
     const now = new Date();
     const pastDate = new Date(now.getTime() - maxAgeInHours * 60 * 60 * 1000);

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

@@ -25,6 +25,8 @@ import Site, { AEM_CS_HOST, getAuthoringType } from './site.model.js';
  * @extends BaseCollection
  */
 class SiteCollection extends BaseCollection {
+  static COLLECTION_NAME = 'SiteCollection';
+
   async allSitesToAudit() {
     return (await this.all({}, { attributes: ['siteId'] })).map((site) => site.getId());
   }

package/src/models/site-candidate/site-candidate.collection.js

@@ -21,6 +21,8 @@ import BaseCollection from '../base/base.collection.js';
  * @extends BaseCollection
  */
 class SiteCandidateCollection extends BaseCollection {
+  static COLLECTION_NAME = 'SiteCandidateCollection';
+
   // add custom methods here
 }
 

package/src/models/site-enrollment/site-enrollment.collection.js

@@ -20,6 +20,8 @@ import BaseCollection from '../base/base.collection.js';
  * @extends BaseCollection
  */
 class SiteEnrollmentCollection extends BaseCollection {
+  static COLLECTION_NAME = 'SiteEnrollmentCollection';
+
   // add your custom collection methods here
 }
 

package/src/models/site-top-form/site-top-form.collection.js

@@ -22,6 +22,8 @@ import BaseCollection from '../base/base.collection.js';
  * @extends BaseCollection
  */
 class SiteTopFormCollection extends BaseCollection {
+  static COLLECTION_NAME = 'SiteTopFormCollection';
+
   /**
    * Override create method to validate URL presence and handle optional formSource
    * @param {Object} item - The data for the entity to be created

package/src/models/site-top-page/site-top-page.collection.js

@@ -22,6 +22,8 @@ import BaseCollection from '../base/base.collection.js';
  * @extends BaseCollection
  */
 class SiteTopPageCollection extends BaseCollection {
+  static COLLECTION_NAME = 'SiteTopPageCollection';
+
   async removeForSiteId(siteId, source, geo) {
     if (!hasText(siteId)) {
       throw new Error('SiteId is required');

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

@@ -28,6 +28,8 @@ import { guardId } from '../../util/guards.js';
  * @extends BaseCollection
  */
 class SuggestionCollection extends BaseCollection {
+  static COLLECTION_NAME = 'SuggestionCollection';
+
   /**
    * Updates the status of multiple given suggestions. The given status must conform
    * to the status enum defined in the Suggestion schema.

package/src/models/trial-user/trial-user.collection.js

@@ -20,6 +20,8 @@ import BaseCollection from '../base/base.collection.js';
  * @extends BaseCollection
  */
 class TrialUserCollection extends BaseCollection {
+  static COLLECTION_NAME = 'TrialUserCollection';
+
   // add custom methods here
 }
 

package/src/models/trial-user-activity/trial-user-activity.collection.js

@@ -22,6 +22,8 @@ import BaseCollection from '../base/base.collection.js';
  * @extends BaseCollection
  */
 class TrialUserActivityCollection extends BaseCollection {
+  static COLLECTION_NAME = 'TrialUserActivityCollection';
+
   // add custom methods here
 }
 

package/src/readme.md

@@ -31,6 +31,8 @@ A *Collection* operates on sets of entities. While `Model` focuses on individual
 
 Collections extend `BaseCollection`, which generates query methods at runtime based on your schema definitions.
 
+**Required:** All collection classes must define a `static COLLECTION_NAME` property to ensure bundler-agnostic operation.
+
 ### Schema Builder
 The `SchemaBuilder` is a fluent API to define an entity’s schema:
 
@@ -42,20 +44,25 @@ The `SchemaBuilder` enforces naming conventions and sets defaults, reducing repe
 
 **Note on Indexes:** Add indexes thoughtfully. Every extra index adds cost and complexity. Only create indexes for well-understood, frequently-needed query patterns.
 
-### Entity Naming (ENTITY_NAME)
+### Entity and Collection Naming
 
-All model classes **must** define a static `ENTITY_NAME` property:
+All model and collection classes **must** define explicit static name properties:
 
 ```js
 class User extends BaseModel {
   static ENTITY_NAME = 'User';
   // ...
 }
+
+class UserCollection extends BaseCollection {
+  static COLLECTION_NAME = 'UserCollection';
+  // ...
+}
 ```
 
-This requirement ensures entity names remain consistent regardless of build tool transformations. Modern JavaScript bundlers (webpack, esbuild) may mangle class names during the build process (e.g., `Configuration` → `_Configuration`), which would break ElectroDB's key generation. By explicitly declaring the entity name, the framework operates correctly in all bundling scenarios.
+This requirement ensures names remain consistent regardless of build tool transformations. Modern JavaScript bundlers (webpack, esbuild) may mangle class names during the build process (e.g., `Configuration` → `_Configuration`), which would break ElectroDB's key generation and internal lookups. By explicitly declaring both entity and collection names, the framework operates correctly in all bundling scenarios.
 
-The `SchemaBuilder` validates that `ENTITY_NAME` is defined and will throw a descriptive error if it's missing.
+The `SchemaBuilder` validates that both `ENTITY_NAME` and `COLLECTION_NAME` are defined and will throw descriptive errors if either is missing.
 
 ### Entity Registry
 The `EntityRegistry` aggregates all entities, their schemas, and their collections. It ensures consistent lookup and retrieval of any registered entity’s collection. When you add a new entity, you must register it with the `EntityRegistry` so the rest of the application can discover it.
@@ -383,6 +390,8 @@ Create `user.collection.js`:
 import BaseCollection from '../base/base.collection.js';
 
 class UserCollection extends BaseCollection {
+  static COLLECTION_NAME = 'UserCollection';
+
   // Additional domain logic collection methods can be added here if needed.
   async findByEmail(email) {
     return this.findByIndexKeys({ email });
@@ -392,6 +401,8 @@ class UserCollection extends BaseCollection {
 export default UserCollection;
 ```
 
+**Important:** Every collection class **must** define a `static COLLECTION_NAME` property for the same bundler-related reasons as `ENTITY_NAME`.
+
 ### 4. Register the Entity
 In `entity.registry.js` (or equivalent):
 

package/src/util/util.js

@@ -35,7 +35,7 @@ const referenceToBaseMethodName = (reference) => {
   return `get${baseName}`;
 };
 
-const entityNameToAllPKValue = (entityName) => `ALL_${pluralize.plural(entityName.toUpperCase())}`;
+const entityNameToAllPKValue = (entityName) => `all_${pluralize.plural(entityName.toLowerCase())}`;
 
 const idNameToEntityName = (idName) => {
   let result = idName;