@adobe/spacecat-shared-data-access 3.72.1 → 3.73.1

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [@adobe/spacecat-shared-data-access-v3.73.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v3.73.0...@adobe/spacecat-shared-data-access-v3.73.1) (2026-05-28)
+
+### Bug Fixes
+
+* **data-access:** declare Preflight createdBy/error as 'any' so Service construction succeeds ([#1636](https://github.com/adobe/spacecat-shared/issues/1636)) ([4097963](https://github.com/adobe/spacecat-shared/commit/40979638bc65c6e29a1b9cd7b25608ad376161ed)), closes [adobe/spacecat-shared#1601](https://github.com/adobe/spacecat-shared/issues/1601)
+
+## [@adobe/spacecat-shared-data-access-v3.73.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v3.72.1...@adobe/spacecat-shared-data-access-v3.73.0) (2026-05-28)
+
+### Features
+
+* **data-access:** rename BrandSemrushProject accessors (LLMO-5190) ([#1635](https://github.com/adobe/spacecat-shared/issues/1635)) ([f97b09d](https://github.com/adobe/spacecat-shared/commit/f97b09df6f15323baa74ede7aa1f431ba7d68293))
+
 ## [@adobe/spacecat-shared-data-access-v3.72.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v3.72.0...@adobe/spacecat-shared-data-access-v3.72.1) (2026-05-28)
 
 ### Bug Fixes

package/package.json

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

package/src/models/brand-semrush-project/brand-semrush-project.collection.js

@@ -22,17 +22,17 @@ class BrandSemrushProjectCollection extends BaseCollection {
   static COLLECTION_NAME = 'BrandSemrushProjectCollection';
 
   /**
-   * Find the single row for a (brand, semrushLocationId, language) slice, or
-   * null. Used by spacecat-api-service POST /v2/orgs/.../semrush/projects to
-   * 409 on a duplicate slice before calling Semrush.
+   * Find the single row for a (brand, geoTargetId, languageCode) slice, or
+   * null. Used by spacecat-api-service POST /v2/orgs/.../serenity/markets to
+   * 409 on a duplicate slice before calling the upstream.
    *
    * @param {string} brandId
-   * @param {number} semrushLocationId
-   * @param {string} language
+   * @param {number} geoTargetId Google Ads Geo Target ID.
+   * @param {string} languageCode BCP-47 primary subtag.
    * @returns {Promise<BrandSemrushProject|null>}
    */
-  async findBySlice(brandId, semrushLocationId, language) {
-    return this.findByIndexKeys({ brandId, semrushLocationId, language });
+  async findBySlice(brandId, geoTargetId, languageCode) {
+    return this.findByIndexKeys({ brandId, geoTargetId, languageCode });
   }
 }
 

package/src/models/brand-semrush-project/brand-semrush-project.model.js

@@ -13,10 +13,12 @@
 import BaseModel from '../base/base.model.js';
 
 /**
- * BrandSemrushProject - mapping between an Adobe brand and a Semrush AIO
- * project. One row per (brand, semrushLocationId, language) slice. The Semrush
- * workspace is reachable via brand -> organization.getSemrushWorkspaceId() and
- * is not duplicated on this entity.
+ * BrandSemrushProject - mapping between an Adobe brand and an upstream
+ * Semrush AIO project. One row per (brand, geoTargetId, languageCode) slice.
+ * The Semrush workspace is reachable via
+ * brand -> organization.getSemrushWorkspaceId() and is not duplicated on this
+ * entity. Entity + table names retain the `Semrush` prefix as internal
+ * storage identifiers; the public JS accessors do not.
  *
  * @class BrandSemrushProject
  * @extends BaseModel

package/src/models/brand-semrush-project/brand-semrush-project.schema.js

@@ -16,11 +16,16 @@ import SchemaBuilder from '../base/schema.builder.js';
 import BrandSemrushProject from './brand-semrush-project.model.js';
 import BrandSemrushProjectCollection from './brand-semrush-project.collection.js';
 
+// "upstream" in the comments below refers to Semrush AIO — the entity name,
+// table name, and `semrushProjectId` accessor stay because the value IS the
+// upstream identifier. The public API surface decouples via the LLMO-5190
+// rename plan (see the schema attributes' `postgrestField` overrides).
+
 // Mirrors the CHECK constraint on brand_to_semrush_projects.language
 // (db/migrations/20260528000000_brand_to_semrush_projects.sql). The slice
 // uniqueness gate is an exact DB string match, so inconsistent casing or
 // format between callers would silently bypass the 409 and bill a duplicate
-// Semrush project. Accepts BCP-47-shaped tags: 2/3-letter primary subtag
+// upstream project. Accepts BCP-47-shaped tags: 2/3-letter primary subtag
 // (`en`, `de`, `zho`) optionally followed by a 2-4-letter region/script
 // subtag (`de-ch`, `pt-br`, `zh-hant`). All lowercase by contract.
 const LANGUAGE_TAG_REGEX = /^[a-z]{2,3}(-[a-z]{2,4})?$/;
@@ -45,15 +50,23 @@ const schema = new SchemaBuilder(BrandSemrushProject, BrandSemrushProjectCollect
     required: true,
     validate: (value) => hasText(value),
   })
-  .addAttribute('semrushLocationId', {
+  // Google Ads Geo Target ID (criterion_id for the country). Semrush re-uses
+  // it as their location identifier; the value is owned by Google Ads, not
+  // Semrush. DB column stays `semrush_location_id` — the table layout is
+  // subject to change independently (see LLMO-5190 plan §Context).
+  .addAttribute('geoTargetId', {
     type: 'number',
     required: true,
     validate: (value) => Number.isInteger(value) && value > 0,
+    postgrestField: 'semrush_location_id',
   })
-  .addAttribute('language', {
+  // BCP-47 primary subtag (`en`, `de`, `fr`), optionally with a region/script
+  // subtag (`de-ch`, `pt-br`, `zh-hant`). DB column stays `language`.
+  .addAttribute('languageCode', {
     type: 'string',
     required: true,
     validate: (value) => hasText(value) && LANGUAGE_TAG_REGEX.test(value),
+    postgrestField: 'language',
   })
   .addAllIndex(['semrushProjectId']);
 

package/src/models/brand-semrush-project/index.d.ts

@@ -22,11 +22,11 @@ import type {
 export interface BrandSemrushProject extends BaseModel {
   getBrandId(): string;
   getSemrushProjectId(): string;
-  getSemrushLocationId(): number;
-  getLanguage(): string;
+  getGeoTargetId(): number;
+  getLanguageCode(): string;
   setSemrushProjectId(value: string): BrandSemrushProject;
-  setSemrushLocationId(value: number): BrandSemrushProject;
-  setLanguage(value: string): BrandSemrushProject;
+  setGeoTargetId(value: number): BrandSemrushProject;
+  setLanguageCode(value: string): BrandSemrushProject;
 }
 
 export interface BrandSemrushProjectCollection extends
@@ -37,7 +37,7 @@ export interface BrandSemrushProjectCollection extends
   findBySemrushProjectId(semrushProjectId: string): Promise<BrandSemrushProject | null>;
   findBySlice(
     brandId: string,
-    semrushLocationId: number,
-    language: string,
+    geoTargetId: number,
+    languageCode: string,
   ): Promise<BrandSemrushProject | null>;
 }

package/src/models/preflight/preflight.schema.js

@@ -30,8 +30,16 @@ const schema = new SchemaBuilder(Preflight, PreflightCollection)
     required: true,
     default: Preflight.Status.IN_PROGRESS,
   })
+  // `createdBy` and `error` use type 'any' (matching neighbor `result`) because
+  // ElectroDB's `map` type requires a `properties` schema for every sub-key,
+  // and the validate function below already enforces the precise shape — a
+  // duplicate `properties` declaration adds nothing. Declaring `type: 'map'`
+  // here without `properties` was the original definition and throws
+  // `InvalidAttributeDefinition` at Service construction, blocking any
+  // downstream consumer that builds a v1 `new Service(EntityRegistry.getEntities())`
+  // (e.g. spacecat-api-service `fixes.test.js`).
   .addAttribute('createdBy', {
-    type: 'map',
+    type: 'any',
     required: true,
     validate: (value) => isObject(value) && typeof value.email === 'string' && value.email.length > 0,
   })
@@ -48,7 +56,7 @@ const schema = new SchemaBuilder(Preflight, PreflightCollection)
     validate: (value) => !value || isObject(value),
   })
   .addAttribute('error', {
-    type: 'map',
+    type: 'any',
     validate: (value) => !value || (isObject(value) && typeof value.code === 'string' && value.code.length > 0 && typeof value.message === 'string' && value.message.length > 0),
   });