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

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@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)
+
+
+### Bug Fixes
+
+* Make Entity Naming Bundler-Agnostic with Explicit ENTITY_NAME ([#1173](https://github.com/adobe/spacecat-shared/issues/1173)) ([c6cb69c](https://github.com/adobe/spacecat-shared/commit/c6cb69c6114db686f911afafe8d477b4556d9d49))
+
+# [@adobe/spacecat-shared-data-access-v2.88.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.88.0...@adobe/spacecat-shared-data-access-v2.88.1) (2025-11-24)
+
+
+### Bug Fixes
+
+* remove enrollments when entitlment are removed ([#1161](https://github.com/adobe/spacecat-shared/issues/1161)) ([b82e6c4](https://github.com/adobe/spacecat-shared/commit/b82e6c4c259543bd0d3e3a3ad2d3e2702956d85c))
+
 # [@adobe/spacecat-shared-data-access-v2.88.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.87.1...@adobe/spacecat-shared-data-access-v2.88.0) (2025-11-22)
 
 

package/package.json

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

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

@@ -22,6 +22,8 @@ import BaseModel from '../base/base.model.js';
  * @extends BaseModel
  */
 class ApiKey extends BaseModel {
+  static ENTITY_NAME = 'ApiKey';
+
   static SCOPE_NAMES = [
     'sites.read_all',
     'sites.write_all',

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

@@ -20,6 +20,8 @@ import BaseModel from '../base/base.model.js';
  * @extends BaseModel
  */
 class AsyncJob extends BaseModel {
+  static ENTITY_NAME = 'AsyncJob';
+
   /**
    * Async Job Status types.
    * Any changes to this object needs to be reflected in the index.d.ts file as well.

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

@@ -28,6 +28,8 @@ import BaseModel from '../base/base.model.js';
  * @extends BaseModel
  */
 class Audit extends BaseModel {
+  static ENTITY_NAME = 'Audit';
+
   static AUDIT_TYPES = {
     APEX: 'apex',
     CWV: 'cwv',

package/src/models/base/base.model.js

@@ -39,6 +39,14 @@ import Reference from './reference.js';
  * @class BaseModel
  */
 class BaseModel {
+  /**
+   * The entity name for this model. Must be overridden by subclasses.
+   * This ensures the entity name is explicit and not dependent on class names
+   * which can be mangled by bundlers.
+   * @type {string}
+   */
+  static ENTITY_NAME = undefined;
+
   /**
    * Constructs an instance of BaseModel.
    * @constructor

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

@@ -111,10 +111,14 @@ class SchemaBuilder {
       throw new SchemaBuilderError(this, 'schemaVersion is required and must be a positive integer.');
     }
 
+    if (!hasText(modelClass.ENTITY_NAME)) {
+      throw new SchemaBuilderError(this, `Model class ${modelClass.name} must define a static ENTITY_NAME property.`);
+    }
+
     this.modelClass = modelClass;
     this.collectionClass = collectionClass;
     this.schemaVersion = schemaVersion;
-    this.entityName = modelClass.name;
+    this.entityName = modelClass.ENTITY_NAME;
     this.serviceName = DEFAULT_SERVICE_NAME;
 
     this.idName = entityNameToIdName(this.entityName);

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

@@ -24,6 +24,8 @@ import { Entitlement } from '../entitlement/index.js';
  * @extends BaseModel
  */
 class Configuration extends BaseModel {
+  static ENTITY_NAME = 'Configuration';
+
   static JOB_GROUPS = {
     AUDITS: 'audits',
     IMPORTS: 'imports',

package/src/models/entitlement/entitlement.model.js

@@ -20,6 +20,8 @@ import BaseModel from '../base/base.model.js';
  * @extends BaseModel
  */
 class Entitlement extends BaseModel {
+  static ENTITY_NAME = 'Entitlement';
+
   static TIERS = {
     FREE_TRIAL: 'FREE_TRIAL',
     PAID: 'PAID',

package/src/models/entitlement/entitlement.schema.js

@@ -24,7 +24,7 @@ const schema = new SchemaBuilder(Entitlement, EntitlementCollection)
   // Reference to Organization (many-to-one relationship)
   .addReference('belongs_to', 'Organization')
   // Reference to SiteEnrollments (one-to-many relationship)
-  .addReference('has_many', 'SiteEnrollments')
+  .addReference('has_many', 'SiteEnrollments', [], { removeDependents: true })
   .addReference('has_many', 'TrialUserActivities')
   .addAttribute('productCode', {
     type: Object.values(Entitlement.PRODUCT_CODES),

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

@@ -20,6 +20,8 @@ import BaseModel from '../base/base.model.js';
  * @extends BaseModel
  */
 class Experiment extends BaseModel {
+  static ENTITY_NAME = 'Experiment';
+
   static DEFAULT_UPDATED_BY = 'spacecat';
 
   // add your custom methods or overrides here

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

@@ -19,6 +19,8 @@ import BaseModel from '../base/base.model.js';
  * @extends BaseModel
  */
 class FixEntity extends BaseModel {
+  static ENTITY_NAME = 'FixEntity';
+
   static DEFAULT_UPDATED_BY = 'spacecat';
 
   static STATUSES = {

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

@@ -21,6 +21,8 @@ import BaseModel from '../base/base.model.js';
  * @extends BaseModel
  */
 class FixEntitySuggestion extends BaseModel {
+  static ENTITY_NAME = 'FixEntitySuggestion';
+
   static DEFAULT_UPDATED_BY = 'spacecat';
 
   /**

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

@@ -20,6 +20,8 @@ import BaseModel from '../base/base.model.js';
  * @extends BaseModel
  */
 class ImportJob extends BaseModel {
+  static ENTITY_NAME = 'ImportJob';
+
   /**
    * Import Job Status types.
    * Any changes to this object needs to be reflected in the index.d.ts file as well.

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

@@ -20,6 +20,8 @@ import BaseModel from '../base/base.model.js';
  * @extends BaseModel
  */
 class ImportUrl extends BaseModel {
+  static ENTITY_NAME = 'ImportUrl';
+
   static IMPORT_URL_EXPIRES_IN_DAYS = 30;
 
   // add your custom methods or overrides here

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

@@ -20,6 +20,8 @@ import BaseModel from '../base/base.model.js';
  * @extends BaseModel
  */
 class KeyEvent extends BaseModel {
+  static ENTITY_NAME = 'KeyEvent';
+
   static KEY_EVENT_TYPES = {
     PERFORMANCE: 'PERFORMANCE',
     SEO: 'SEO',

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

@@ -20,6 +20,8 @@ import Audit from '../audit/audit.model.js';
  * @extends Audit
  */
 class LatestAudit extends Audit {
+  static ENTITY_NAME = 'LatestAudit';
+
   // add your custom methods or overrides here
 }
 

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

@@ -22,6 +22,8 @@ import BaseModel from '../base/base.model.js';
  */
 
 class Opportunity extends BaseModel {
+  static ENTITY_NAME = 'Opportunity';
+
   static ORIGINS = {
     ESS_OPS: 'ESS_OPS',
     AI: 'AI',

package/src/models/organization/organization.model.js

@@ -20,6 +20,8 @@ import BaseModel from '../base/base.model.js';
  * @extends BaseModel
  */
 class Organization extends BaseModel {
+  static ENTITY_NAME = 'Organization';
+
   static IMS_ORG_ID_REGEX = /[a-z0-9]{24}@AdobeOrg/i;
 
   // add your custom methods or overrides here

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

@@ -19,6 +19,8 @@ import BaseModel from '../base/base.model.js';
  * @extends BaseModel
  */
 class PageCitability extends BaseModel {
+  static ENTITY_NAME = 'PageCitability';
+
   static DEFAULT_UPDATED_BY = 'spacecat';
 
   // add any custom methods or overrides here

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

@@ -19,6 +19,8 @@ import BaseModel from '../base/base.model.js';
  * @extends BaseModel
  */
 class PageIntent extends BaseModel {
+  static ENTITY_NAME = 'PageIntent';
+
   static DEFAULT_UPDATED_BY = 'spacecat';
 
   static PAGE_INTENTS = {

package/src/models/project/project.model.js

@@ -20,6 +20,8 @@ import BaseModel from '../base/base.model.js';
  * @extends BaseModel
  */
 class Project extends BaseModel {
+  static ENTITY_NAME = 'Project';
+
   async getPrimaryLocaleSites() {
     const sites = await this.getSites();
     return sites.filter((site) => site.getIsPrimaryLocale());

package/src/models/report/report.model.js

@@ -13,6 +13,8 @@
 import BaseModel from '../base/base.model.js';
 
 class Report extends BaseModel {
+  static ENTITY_NAME = 'Report';
+
   static STATUSES = {
     PROCESSING: 'processing',
     SUCCESS: 'success',

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

@@ -20,6 +20,8 @@ import BaseModel from '../base/base.model.js';
  * @extends BaseModel
  */
 class ScrapeJob extends BaseModel {
+  static ENTITY_NAME = 'ScrapeJob';
+
   static SCRAPE_JOB_EXPIRES_IN_DAYS = 120;
 
   /**

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

@@ -20,6 +20,8 @@ import BaseModel from '../base/base.model.js';
  * @extends BaseModel
  */
 class ScrapeUrl extends BaseModel {
+  static ENTITY_NAME = 'ScrapeUrl';
+
   static SCRAPE_URL_EXPIRES_IN_DAYS = 120;
 
   // add your custom methods or overrides here

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

@@ -70,6 +70,8 @@ export const getAuthoringType = (hostname, authoringTypes) => {
  * @extends BaseModel
  */
 class Site extends BaseModel {
+  static ENTITY_NAME = 'Site';
+
   static DELIVERY_TYPES = DELIVERY_TYPES;
 
   static DEFAULT_DELIVERY_TYPE = DELIVERY_TYPES.AEM_EDGE;

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

@@ -20,6 +20,8 @@ import BaseModel from '../base/base.model.js';
  * @extends BaseModel
  */
 class SiteCandidate extends BaseModel {
+  static ENTITY_NAME = 'SiteCandidate';
+
   static DEFAULT_UPDATED_BY = 'spacecat';
 
   static SITE_CANDIDATE_SOURCES = {

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

@@ -20,6 +20,8 @@ import BaseModel from '../base/base.model.js';
  * @extends BaseModel
  */
 class SiteEnrollment extends BaseModel {
+  static ENTITY_NAME = 'SiteEnrollment';
+
   // add your custom methods or overrides here
 }
 

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

@@ -20,6 +20,8 @@ import BaseModel from '../base/base.model.js';
  * @extends BaseModel
  */
 class SiteTopForm extends BaseModel {
+  static ENTITY_NAME = 'SiteTopForm';
+
   // add your custom methods or overrides here
 }
 

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

@@ -20,6 +20,8 @@ import BaseModel from '../base/base.model.js';
  * @extends BaseModel
  */
 class SiteTopPage extends BaseModel {
+  static ENTITY_NAME = 'SiteTopPage';
+
   static DEFAULT_GEO = 'global';
 
   // add your custom methods or overrides here

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

@@ -21,6 +21,8 @@ import BaseModel from '../base/base.model.js';
  * @extends BaseModel
  */
 class Suggestion extends BaseModel {
+  static ENTITY_NAME = 'Suggestion';
+
   static STATUSES = {
     NEW: 'NEW',
     APPROVED: 'APPROVED',

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

@@ -20,6 +20,8 @@ import BaseModel from '../base/base.model.js';
  * @extends BaseModel
  */
 class TrialUser extends BaseModel {
+  static ENTITY_NAME = 'TrialUser';
+
   /**
    * Trial user status types.
    * Any change to this object needs to be reflected in the index.d.ts file as well.

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

@@ -20,6 +20,8 @@ import BaseModel from '../base/base.model.js';
  * @extends BaseModel
  */
 class TrialUserActivity extends BaseModel {
+  static ENTITY_NAME = 'TrialUserActivity';
+
   /**
    * Trial user activity types.
    * Any change to this object needs to be reflected in the index.d.ts file as well.

package/src/readme.md

@@ -20,6 +20,8 @@ A *Model* is a class representing a single instance of an entity. It provides:
 
 Models extend `BaseModel`, which handles most of the common logic.
 
+**Required:** All model classes must define a `static ENTITY_NAME` property to ensure bundler-agnostic operation.
+
 ### Collections
 A *Collection* operates on sets of entities. While `Model` focuses on individual records, `Collection` is for batch and query-level operations:
 
@@ -40,6 +42,21 @@ 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)
+
+All model classes **must** define a static `ENTITY_NAME` property:
+
+```js
+class User extends BaseModel {
+  static ENTITY_NAME = 'User';
+  // ...
+}
+```
+
+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.
+
+The `SchemaBuilder` validates that `ENTITY_NAME` is defined and will throw a descriptive error if it's 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.
 
@@ -348,20 +365,22 @@ Create `user.model.js`:
 ```js
 import BaseModel from '../base/base.model.js';
 
-class UserModel extends BaseModel {
+class User extends BaseModel {
+  static ENTITY_NAME = 'User';
+
   // Additional domain logic methods can be added here if needed.
 }
 
-export default UserModel;
+export default User;
 ```
 
+**Important:** Every model class **must** define a `static ENTITY_NAME` property. This ensures the entity name is explicit and not affected by bundler transformations (like class name mangling in webpack/esbuild). The `SchemaBuilder` will throw an error if this property is missing.
+
 ### 3. Implement the Collection
 Create `user.collection.js`:
 
 ```js
 import BaseCollection from '../base/base.collection.js';
-import UserModel from './user.model.js';
-import userSchema from './user.schema.js';
 
 class UserCollection extends BaseCollection {
   // Additional domain logic collection methods can be added here if needed.