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

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-data-access-v2.68.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.67.0...@adobe/spacecat-shared-data-access-v2.68.0) (2025-10-07)
+
+
+### Features
+
+* add query for fetching RUM engagement metrics ([#985](https://github.com/adobe/spacecat-shared/issues/985)) ([0eb8881](https://github.com/adobe/spacecat-shared/commit/0eb88818af000076ea663b2e08ab1fb2b1957510))
+
+# [@adobe/spacecat-shared-data-access-v2.67.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.66.0...@adobe/spacecat-shared-data-access-v2.67.0) (2025-10-07)
+
+
+### Features
+
+* add support for region/language configurations ([#995](https://github.com/adobe/spacecat-shared/issues/995)) ([c5219da](https://github.com/adobe/spacecat-shared/commit/c5219da283370e7de5411aa778773315efdeb869))
+
 # [@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)
 
 

package/package.json

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

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

@@ -26,6 +26,7 @@ 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';
@@ -52,6 +53,7 @@ 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';
@@ -147,6 +149,7 @@ 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);

package/src/models/index.js

@@ -24,6 +24,7 @@ export * from './key-event/index.js';
 export * from './latest-audit/index.js';
 export * from './opportunity/index.js';
 export * from './organization/index.js';
+export * from './project/index.js';
 export * from './scrape-job/index.js';
 export * from './scrape-url/index.js';
 export * from './site-candidate/index.js';

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

@@ -11,7 +11,7 @@
  */
 
 import type {
-  BaseCollection, BaseModel, Site, Entitlement, OrganizationIdentityProvider, TrialUser,
+  BaseCollection, BaseModel, Site, Project, Entitlement, OrganizationIdentityProvider, TrialUser,
 } from '../index';
 
 export interface Organization extends BaseModel {
@@ -20,6 +20,7 @@ export interface Organization extends BaseModel {
   getImsOrgId(): string;
   getName(): string;
   getSites(): Promise<Site[]>;
+  getProjects(): Promise<Project[]>;
   getEntitlements(): Promise<Entitlement[]>;
   getOrganizationIdentityProviders(): Promise<OrganizationIdentityProvider[]>;
   getTrialUsers(): Promise<TrialUser[]>;

package/src/models/organization/organization.schema.js

@@ -28,6 +28,7 @@ Indexes Doc: https://electrodb.dev/en/modeling/indexes/
 const schema = new SchemaBuilder(Organization, OrganizationCollection)
   // this will add an attribute 'organizationId' as well as an index 'byOrganizationId'
   .addReference('has_many', 'Sites')
+  .addReference('has_many', 'Projects')
   .addReference('has_many', 'Entitlements')
   .addReference('has_many', 'TrialUsers')
   .addAttribute('config', {

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

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2024 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 type {
+  BaseCollection, BaseModel, Organization, Site,
+} from '../index';
+
+export interface Project extends BaseModel {
+  getProjectName(): string;
+  getOrganization(): Promise<Organization>;
+  getOrganizationId(): string;
+  getSites(): Promise<Site[]>;
+  getPrimaryLocaleSites(): Promise<Site[]>;
+  setProjectName(projectName: string): Project;
+  setOrganizationId(organizationId: string): Project;
+}
+
+export interface ProjectCollection extends BaseCollection<Project> {
+  allByOrganizationId(organizationId: string): Promise<Project[]>;
+  findByOrganizationId(organizationId: string): Promise<Project | null>;
+  findByProjectName(projectName: string): Promise<Project | null>;
+}

package/src/models/project/index.js

@@ -0,0 +1,14 @@
+/*
+ * Copyright 2024 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.
+ */
+
+export { default as Project } from './project.model.js';
+export { default as ProjectCollection } from './project.collection.js';

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

@@ -0,0 +1,25 @@
+/*
+ * Copyright 2024 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 BaseCollection from '../base/base.collection.js';
+
+/**
+ * ProjectCollection - A collection class responsible for managing Project entities.
+ * Extends the BaseCollection to provide specific methods for interacting with Project records.
+ *
+ * @class ProjectCollection
+ * @extends BaseCollection
+ */
+class ProjectCollection extends BaseCollection {
+}
+
+export default ProjectCollection;

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

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2024 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 BaseModel from '../base/base.model.js';
+
+/**
+ * Project - A class representing a Project entity.
+ * Provides methods to access and manipulate Project-specific data.
+ *
+ * @class Project
+ * @extends BaseModel
+ */
+class Project extends BaseModel {
+  async getPrimaryLocaleSites() {
+    const sites = await this.getSites();
+    return sites.filter((site) => site.getIsPrimaryLocale());
+  }
+}
+
+export default Project;

package/src/models/project/project.schema.js

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2024 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.
+ */
+
+/* c8 ignore start */
+
+import { hasText } from '@adobe/spacecat-shared-utils';
+
+import SchemaBuilder from '../base/schema.builder.js';
+import Project from './project.model.js';
+import ProjectCollection from './project.collection.js';
+
+/*
+Schema Doc: https://electrodb.dev/en/modeling/schema/
+Attribute Doc: https://electrodb.dev/en/modeling/attributes/
+Indexes Doc: https://electrodb.dev/en/modeling/indexes/
+ */
+
+const schema = new SchemaBuilder(Project, ProjectCollection)
+  .addReference('belongs_to', 'Organization')
+  .addReference('has_many', 'Sites')
+  .addAttribute('projectName', {
+    type: 'string',
+    required: true,
+    validate: (value) => hasText(value),
+  })
+  .addAllIndex(['projectName']);
+
+export default schema.build();

package/src/models/site/config.js

@@ -27,6 +27,7 @@ export const IMPORT_TYPES = {
   CWV_WEEKLY: 'cwv-weekly',
   TRAFFIC_ANALYSIS: 'traffic-analysis',
   TOP_FORMS: 'top-forms',
+  USER_ENGAGEMENT: 'user-engagement',
 };
 
 export const IMPORT_DESTINATIONS = {
@@ -152,6 +153,10 @@ export const IMPORT_TYPE_SCHEMAS = {
     limit: Joi.number().integer().min(1).max(2000)
       .optional(),
   }),
+  [IMPORT_TYPES.USER_ENGAGEMENT]: Joi.object({
+    type: Joi.string().valid(IMPORT_TYPES.USER_ENGAGEMENT).required(),
+    ...IMPORT_BASE_KEYS,
+  }),
 };
 
 export const DEFAULT_IMPORT_CONFIGS = {
@@ -228,6 +233,12 @@ export const DEFAULT_IMPORT_CONFIGS = {
     sources: ['rum'],
     enabled: true,
   },
+  'user-engagement': {
+    type: 'user-engagement',
+    destinations: ['default'],
+    sources: ['rum'],
+    enabled: true,
+  },
 };
 
 export const configSchema = Joi.object({

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

@@ -19,6 +19,7 @@ import type {
   LatestAudit,
   Opportunity,
   Organization,
+  Project,
   SiteCandidate,
   SiteEnrollment,
   SiteTopPage,
@@ -214,6 +215,11 @@ export interface Site extends BaseModel {
   getOpportunitiesByStatusAndUpdatedAt(status: string, updatedAt: string): Promise<Opportunity[]>;
   getOrganization(): Promise<Organization>;
   getOrganizationId(): string;
+  getProject(): Promise<Project>;
+  getProjectId(): string;
+  getIsPrimaryLocale(): boolean;
+  getLanguage(): string;
+  getRegion(): string;
   getSiteCandidates(): Promise<SiteCandidate[]>;
   getSiteEnrollments(): Promise<SiteEnrollment[]>;
   getSiteTopPages(): Promise<SiteTopPage[]>;
@@ -234,18 +240,27 @@ export interface Site extends BaseModel {
   setIsSandbox(isSandbox: boolean): Site;
   setIsLiveToggledAt(isLiveToggledAt: string): Site;
   setOrganizationId(organizationId: string): Site;
+  setProjectId(projectId: string): Site;
+  setIsPrimaryLocale(primaryLocale: boolean): Site;
+  setLanguage(language: string): Site;
+  setRegion(region: string): Site;
   toggleLive(): Site;
 }
 
-export interface SiteCollection extends BaseCollection<Organization> {
+export interface SiteCollection extends BaseCollection<Site> {
   allByBaseURL(baseURL: string): Promise<Site[]>;
   allByDeliveryType(deliveryType: string): Promise<Site[]>;
   allByOrganizationId(organizationId: string): Promise<Site[]>;
+  allByProjectId(projectId: string): Promise<Site[]>;
+  allByProjectName(projectName: string): Promise<Site[]>;
+  allByOrganizationIdAndProjectId(organizationId: string, projectId: string): Promise<Site[]>;
+  allByOrganizationIdAndProjectName(organizationId: string, projectName: 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>;
+  findByProjectId(projectId: string): Promise<Site | null>;
   findByPreviewURL(previewURL: string): Promise<Site | null>;
   findByExternalOwnerIdAndExternalSiteId(
     externalOwnerId: string, externalSiteId: string

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

@@ -102,6 +102,72 @@ class SiteCollection extends BaseCollection {
         throw new DataAccessError(`Unsupported preview URL: ${previewURL}`, this);
     }
   }
+
+  async allByProjectName(projectName) {
+    if (!hasText(projectName)) {
+      throw new DataAccessError('projectName is required', this);
+    }
+
+    const projectCollection = this.entityRegistry.getCollection('ProjectCollection');
+    const project = await projectCollection.findByProjectName(projectName);
+
+    if (!project) {
+      return [];
+    }
+    return this.allByProjectId(project.getId());
+  }
+
+  async allByOrganizationIdAndProjectId(organizationId, projectId) {
+    if (!hasText(organizationId)) {
+      throw new DataAccessError('organizationId is required', this);
+    }
+    if (!hasText(projectId)) {
+      throw new DataAccessError('projectId is required', this);
+    }
+
+    const organizationCollection = this.entityRegistry.getCollection('OrganizationCollection');
+    const organization = await organizationCollection.findById(organizationId);
+
+    if (!organization) {
+      return [];
+    }
+
+    const projectCollection = this.entityRegistry.getCollection('ProjectCollection');
+    const projects = await projectCollection.allByOrganizationId(organizationId);
+    const project = projects.find((p) => p.getId() === projectId);
+
+    if (!project) {
+      return [];
+    }
+
+    return this.allByProjectId(projectId);
+  }
+
+  async allByOrganizationIdAndProjectName(organizationId, projectName) {
+    if (!hasText(organizationId)) {
+      throw new DataAccessError('organizationId is required', this);
+    }
+    if (!hasText(projectName)) {
+      throw new DataAccessError('projectName is required', this);
+    }
+
+    const organizationCollection = this.entityRegistry.getCollection('OrganizationCollection');
+    const organization = await organizationCollection.findById(organizationId);
+
+    if (!organization) {
+      return [];
+    }
+
+    const projectCollection = this.entityRegistry.getCollection('ProjectCollection');
+    const projects = await projectCollection.allByOrganizationId(organizationId);
+    const project = projects.find((p) => p.getProjectName() === projectName);
+
+    if (!project) {
+      return [];
+    }
+
+    return this.allByProjectId(project.getId());
+  }
 }
 
 export default SiteCollection;

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

@@ -34,6 +34,8 @@ Indexes Doc: https://electrodb.dev/en/modeling/indexes/
 const schema = new SchemaBuilder(Site, SiteCollection)
   // this will add an attribute 'organizationId' as well as an index 'byOrganizationId'
   .addReference('belongs_to', 'Organization')
+  // this will add an attribute 'projectId' as well as an index 'byProjectId'
+  .addReference('belongs_to', 'Project', ['updatedAt'], { required: false })
   // has_many references do not add attributes or indexes
   .addReference('has_many', 'Audits')
   .addReference('has_many', 'Experiments')
@@ -55,6 +57,20 @@ const schema = new SchemaBuilder(Site, SiteCollection)
   .addAttribute('name', {
     type: 'string',
   })
+  .addAttribute('isPrimaryLocale', {
+    type: 'boolean',
+    required: false,
+  })
+  .addAttribute('language', {
+    type: 'string',
+    required: false,
+    validate: (value) => !value || /^[a-z]{2}$/.test(value), // ISO 639-1 format
+  })
+  .addAttribute('region', {
+    type: 'string',
+    required: false,
+    validate: (value) => !value || /^[A-Z]{2}$/.test(value), // ISO 3166-1 alpha-2 format
+  })
   .addAttribute('config', {
     type: 'any',
     required: true,