@adobe/spacecat-shared-data-access 3.66.0 → 3.68.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [@adobe/spacecat-shared-data-access-v3.68.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v3.67.0...@adobe/spacecat-shared-data-access-v3.68.0) (2026-05-21)
+
+### Features
+
+* added pending decision in PLG onboarding ([#1610](https://github.com/adobe/spacecat-shared/issues/1610)) ([cf8a1c4](https://github.com/adobe/spacecat-shared/commit/cf8a1c4cc4f43e5d0c792adc69e7593162257f77))
+
+## [@adobe/spacecat-shared-data-access-v3.67.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v3.66.0...@adobe/spacecat-shared-data-access-v3.67.0) (2026-05-21)
+
+### Features
+
+* **data-access:** add BrandSemrushProject entity ([#1615](https://github.com/adobe/spacecat-shared/issues/1615)) ([f2c6a0c](https://github.com/adobe/spacecat-shared/commit/f2c6a0c678f000da9900d135effa37ad17e08e8f))
+
 ## [@adobe/spacecat-shared-data-access-v3.66.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v3.65.0...@adobe/spacecat-shared-data-access-v3.66.0) (2026-05-21)
 
 ### Features

package/package.json

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

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

@@ -35,6 +35,7 @@ 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 BrandSemrushProjectCollection from '../brand-semrush-project/brand-semrush-project.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';
@@ -73,6 +74,7 @@ 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 BrandSemrushProjectSchema from '../brand-semrush-project/brand-semrush-project.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';
@@ -207,6 +209,7 @@ EntityRegistry.registerEntity(OrganizationSchema, OrganizationCollection);
 EntityRegistry.registerEntity(ProjectSchema, ProjectCollection);
 EntityRegistry.registerEntity(ScrapeJobSchema, ScrapeJobCollection);
 EntityRegistry.registerEntity(ScrapeUrlSchema, ScrapeUrlCollection);
+EntityRegistry.registerEntity(BrandSemrushProjectSchema, BrandSemrushProjectCollection);
 EntityRegistry.registerEntity(SiteSchema, SiteCollection);
 EntityRegistry.registerEntity(SiteCandidateSchema, SiteCandidateCollection);
 EntityRegistry.registerEntity(SiteEnrollmentSchema, SiteEnrollmentCollection);

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

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2026 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';
+
+/**
+ * BrandSemrushProjectCollection - collection of BrandSemrushProject rows.
+ *
+ * @class BrandSemrushProjectCollection
+ * @extends BaseCollection
+ */
+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.
+   *
+   * @param {string} brandId
+   * @param {number} semrushLocationId
+   * @param {string} language
+   * @returns {Promise<BrandSemrushProject|null>}
+   */
+  async findBySlice(brandId, semrushLocationId, language) {
+    return this.findByIndexKeys({ brandId, semrushLocationId, language });
+  }
+}
+
+export default BrandSemrushProjectCollection;

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

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2026 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';
+
+/**
+ * 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.
+ *
+ * @class BrandSemrushProject
+ * @extends BaseModel
+ */
+class BrandSemrushProject extends BaseModel {
+  static ENTITY_NAME = 'BrandSemrushProject';
+}
+
+export default BrandSemrushProject;

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

@@ -0,0 +1,49 @@
+/*
+ * Copyright 2026 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 { hasText } from '@adobe/spacecat-shared-utils';
+
+import SchemaBuilder from '../base/schema.builder.js';
+import BrandSemrushProject from './brand-semrush-project.model.js';
+import BrandSemrushProjectCollection from './brand-semrush-project.collection.js';
+
+// 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
+// (`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})?$/;
+
+const schema = new SchemaBuilder(BrandSemrushProject, BrandSemrushProjectCollection)
+  // Reference to Brand (many-to-one). The owning organization and Semrush
+  // workspace are reachable via Brand -> Organization.
+  .addReference('belongs_to', 'Brand')
+  .addAttribute('semrushProjectId', {
+    type: 'string',
+    required: true,
+    validate: (value) => hasText(value),
+  })
+  .addAttribute('semrushLocationId', {
+    type: 'number',
+    required: true,
+    validate: (value) => Number.isInteger(value) && value > 0,
+  })
+  .addAttribute('language', {
+    type: 'string',
+    required: true,
+    validate: (value) => hasText(value) && LANGUAGE_TAG_REGEX.test(value),
+  })
+  .addAllIndex(['semrushProjectId']);
+
+export default schema.build();

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

@@ -0,0 +1,43 @@
+/*
+ * Copyright 2026 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,
+} from '../index';
+
+// NOTE: `belongs_to Brand` on the schema generates `brandId` plus a
+// `getBrand()` runtime accessor, but Brand is not a registered entity in this
+// package (brand data lives in mysticat-data-service and is fetched over HTTP
+// via @adobe/spacecat-shared-brand-client). The accessor is intentionally not
+// exposed on the TypeScript surface — callers must hop to brand-client.
+export interface BrandSemrushProject extends BaseModel {
+  getBrandId(): string;
+  getSemrushProjectId(): string;
+  getSemrushLocationId(): number;
+  getLanguage(): string;
+  setSemrushProjectId(value: string): BrandSemrushProject;
+  setSemrushLocationId(value: number): BrandSemrushProject;
+  setLanguage(value: string): BrandSemrushProject;
+}
+
+export interface BrandSemrushProjectCollection extends
+    BaseCollection<BrandSemrushProject> {
+  allByBrandId(brandId: string): Promise<BrandSemrushProject[]>;
+  findByBrandId(brandId: string): Promise<BrandSemrushProject | null>;
+  allBySemrushProjectId(semrushProjectId: string): Promise<BrandSemrushProject[]>;
+  findBySemrushProjectId(semrushProjectId: string): Promise<BrandSemrushProject | null>;
+  findBySlice(
+    brandId: string,
+    semrushLocationId: number,
+    language: string,
+  ): Promise<BrandSemrushProject | null>;
+}

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

@@ -0,0 +1,15 @@
+/*
+ * Copyright 2026 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 BrandSemrushProject } from './brand-semrush-project.model.js';
+export { default as BrandSemrushProjectCollection } from './brand-semrush-project.collection.js';
+export { default as BrandSemrushProjectSchema } from './brand-semrush-project.schema.js';

package/src/models/index.d.ts

@@ -16,6 +16,7 @@ export type * from './async-job';
 export type * from './audit';
 export type * from './audit-url';
 export type * from './base';
+export type * from './brand-semrush-project';
 export type * from './configuration';
 export type * from './consumer';
 export type * from './entitlement';

package/src/models/index.js

@@ -17,6 +17,7 @@ export * from './contact-sales-lead/index.js';
 export * from './audit/index.js';
 export * from './audit-url/index.js';
 export * from './base/index.js';
+export * from './brand-semrush-project/index.js';
 export * from './configuration/index.js';
 export * from './consumer/index.js';
 export * from './entitlement/index.js';

package/src/models/plg-onboarding/plg-onboarding.model.js

@@ -44,6 +44,7 @@ class PlgOnboarding extends BaseModel {
     CLOSED: 'CLOSED',
     REOPENED: 'REOPENED',
     OFFBOARDED: 'OFFBOARDED',
+    PENDING: 'PENDING',
   };
 }
 

package/src/util/postgrest.utils.js

@@ -17,6 +17,10 @@ const DEFAULT_PAGE_SIZE = 1000;
 const ENTITY_TABLE_OVERRIDES = {
   LatestAudit: 'audits',
   SuggestionGrant: 'suggestion_grants',
+  // Entity renamed from BrandToSemrushProject -> BrandSemrushProject during
+  // PR review. The DB table name was kept as `brand_to_semrush_projects` to
+  // avoid a follow-up migration in mysticat-data-service.
+  BrandSemrushProject: 'brand_to_semrush_projects',
 };
 
 const camelToSnake = (value) => value.replace(/([a-z0-9])([A-Z])/g, '$1_$2').toLowerCase();