@adobe/spacecat-shared-data-access 3.74.2 → 3.75.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [@adobe/spacecat-shared-data-access-v3.75.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v3.74.3...@adobe/spacecat-shared-data-access-v3.75.0) (2026-06-15)
+
+### Features
+
+* **data-access:** add minimal Brand entity for serenity sub-workspace ([#1679](https://github.com/adobe/spacecat-shared/issues/1679)) ([e68d257](https://github.com/adobe/spacecat-shared/commit/e68d2577d51b3a9110477ddcdc5a550f935b7b47))
+
+## [@adobe/spacecat-shared-data-access-v3.74.3](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v3.74.2...@adobe/spacecat-shared-data-access-v3.74.3) (2026-06-12)
+
+### Bug Fixes
+
+* **data-access:** remove stale stash conflict markers in CHANGELOG ([#1669](https://github.com/adobe/spacecat-shared/issues/1669)) ([12229c3](https://github.com/adobe/spacecat-shared/commit/12229c33e6b2ed9731d256d89b580a0ad64d96b3))
+
 ## [@adobe/spacecat-shared-data-access-v3.74.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v3.74.1...@adobe/spacecat-shared-data-access-v3.74.2) (2026-06-11)
 
 ### Bug Fixes
@@ -3732,18 +3744,14 @@ Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
 
 * github org ([02f86c3](https://github.com/adobe/spacecat-shared/commit/02f86c351b2b1ab99ce5aca7fd5e6af2246c0efd))
 
-<<<<<<< Updated upstream
-# [@adobe/spacecat-shared-data-access-v1.6.0](https://github.com/adobe-rnd/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.5.2...@adobe/spacecat-shared-data-access-v1.6.0) (2024-01-12)
+# [@adobe/spacecat-shared-data-access-v1.6.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.5.2...@adobe/spacecat-shared-data-access-v1.6.0) (2024-01-12)
 
 
 ### Features
 
-* site delivery type ([#77](https://github.com/adobe-rnd/spacecat-shared/issues/77)) ([005bc38](https://github.com/adobe-rnd/spacecat-shared/commit/005bc388ed6ab0f82c8b0f562d4c1f4c0d1e2894))
+* site delivery type ([#77](https://github.com/adobe/spacecat-shared/issues/77)) ([005bc38](https://github.com/adobe/spacecat-shared/commit/005bc388ed6ab0f82c8b0f562d4c1f4c0d1e2894))
 
-# [@adobe/spacecat-shared-data-access-v1.5.2](https://github.com/adobe-rnd/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.5.1...@adobe/spacecat-shared-data-access-v1.5.2) (2023-12-30)
-=======
 # [@adobe/spacecat-shared-data-access-v1.5.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.5.1...@adobe/spacecat-shared-data-access-v1.5.2) (2023-12-30)
->>>>>>> Stashed changes
 
 
 ### Bug Fixes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-data-access",
-  "version": "3.74.2",
+  "version": "3.75.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 BrandCollection from '../brand/brand.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';
@@ -75,6 +76,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 BrandSchema from '../brand/brand.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';
@@ -211,6 +213,7 @@ EntityRegistry.registerEntity(OrganizationSchema, OrganizationCollection);
 EntityRegistry.registerEntity(ProjectSchema, ProjectCollection);
 EntityRegistry.registerEntity(ScrapeJobSchema, ScrapeJobCollection);
 EntityRegistry.registerEntity(ScrapeUrlSchema, ScrapeUrlCollection);
+EntityRegistry.registerEntity(BrandSchema, BrandCollection);
 EntityRegistry.registerEntity(BrandSemrushProjectSchema, BrandSemrushProjectCollection);
 EntityRegistry.registerEntity(SiteSchema, SiteCollection);
 EntityRegistry.registerEntity(SiteCandidateSchema, SiteCandidateCollection);

package/src/models/brand/brand.collection.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 BaseCollection from '../base/base.collection.js';
+
+/**
+ * BrandCollection - collection of Brand rows. `findById` (the brand UUID) is
+ * the primary access path for serenity dual-mode resolution;
+ * `findBySemrushWorkspaceId` (from the addAllIndex below) is used to repair a
+ * pointer when a sub-workspace is found to have been deleted out-of-band.
+ *
+ * @class BrandCollection
+ * @extends BaseCollection
+ */
+class BrandCollection extends BaseCollection {
+  static COLLECTION_NAME = 'BrandCollection';
+}
+
+export default BrandCollection;

package/src/models/brand/brand.model.js

@@ -0,0 +1,44 @@
+/*
+ * 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';
+
+/**
+ * Brand - an Adobe brand, stored in the `brands` table in mysticat-data-service
+ * and served over PostgREST. Intentionally minimal: it surfaces only the fields
+ * the serenity sub-workspace provisioning flows read/write
+ * (`semrushWorkspaceId`, `status`, `name`). Brands are created and fully
+ * managed elsewhere (Brandalf sync, onboarding); this entity is a read +
+ * targeted-patch surface, not a create surface.
+ *
+ * `semrushWorkspaceId` is the dual-mode switch: NULL = the brand is not
+ * connected to a Semrush sub-workspace (resolves against the org parent
+ * workspace — "flat" mode); set = the brand has its own Semrush sub-workspace.
+ * Deactivation empties the sub-workspace and clears this pointer (the
+ * sub-workspace itself is never deleted). See serenity-docs
+ * brand-semrush-provisioning-v2-phase1-sync.md §6.
+ *
+ * @class Brand
+ * @extends BaseModel
+ */
+class Brand extends BaseModel {
+  static ENTITY_NAME = 'Brand';
+
+  /**
+   * Mirrors the `reference_status` enum on the brands table
+   * (mysticat-data-service). Activation writes `active`; deactivation writes
+   * `pending`; customer offboard writes `deleted`.
+   */
+  static STATUSES = Object.freeze(['pending', 'active', 'deleted', 'ignored']);
+}
+
+export default Brand;

package/src/models/brand/brand.schema.js

@@ -0,0 +1,54 @@
+/*
+ * 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 Brand from './brand.model.js';
+import BrandCollection from './brand.collection.js';
+
+// Minimal projection of the `brands` table (mysticat-data-service) — only the
+// fields the serenity sub-workspace provisioning flows read or patch. Brands
+// are created/owned elsewhere, so columns this entity does not declare
+// (organization_id, site_id, regions, …) are simply never touched by it; a
+// targeted PATCH only sends the attributes it changes.
+const schema = new SchemaBuilder(Brand, BrandCollection)
+  .addAttribute('name', {
+    type: 'string',
+    required: true,
+  })
+  // reference_status enum on the brands table. Not `required`: this entity
+  // never creates a brand, and a targeted PATCH (e.g. setting only
+  // semrushWorkspaceId) must not be forced to also send status. The validator
+  // still rejects an out-of-enum value when status IS written
+  // (activate → 'active', deactivate → 'pending').
+  .addAttribute('status', {
+    type: Brand.STATUSES,
+    validate: (value) => value == null || Brand.STATUSES.includes(value),
+  })
+  // Brand → Semrush sub-workspace. Nullable (NULL = no sub-workspace
+  // connected). Same minimum guard as organizations.semrushWorkspaceId: the
+  // shared `hasText` rejects the empty string (and non-strings) while letting
+  // null/undefined short-circuit. Note hasText does NOT trim, so a
+  // whitespace-only value would pass — acceptable here because this column is
+  // only ever written by the activate flow with a real Semrush workspace UUID,
+  // never user input.
+  .addAttribute('semrushWorkspaceId', {
+    type: 'string',
+    validate: (value) => value == null || hasText(value),
+  })
+  // Uniqueness is enforced at the DB level via the UNIQUE constraint on
+  // brands.semrush_workspace_id (mysticat-data-service migration
+  // 20260615102123), so findBySemrushWorkspaceId returns at most one row.
+  .addAllIndex(['semrushWorkspaceId']);
+
+export default schema.build();

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

@@ -0,0 +1,29 @@
+/*
+ * 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';
+
+export interface Brand extends BaseModel {
+  getName(): string;
+  getStatus(): string;
+  getSemrushWorkspaceId(): string | null;
+  setName(value: string): Brand;
+  setStatus(value: string): Brand;
+  setSemrushWorkspaceId(value: string | null): Brand;
+}
+
+export interface BrandCollection extends BaseCollection<Brand> {
+  allBySemrushWorkspaceId(semrushWorkspaceId: string): Promise<Brand[]>;
+  findBySemrushWorkspaceId(semrushWorkspaceId: string): Promise<Brand | null>;
+}

package/src/models/brand/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 Brand } from './brand.model.js';
+export { default as BrandCollection } from './brand.collection.js';
+export { default as BrandSchema } from './brand.schema.js';

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

@@ -15,10 +15,11 @@ import type {
 } 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.
+// `getBrand()` runtime accessor. Brand is now a registered (minimal) entity in
+// this package, so the accessor resolves locally; it is still intentionally
+// left off this TypeScript surface, which exposes only the fields callers here
+// need (`brandId`). Rich brand data continues to live in mysticat-data-service
+// and is fetched over HTTP via @adobe/spacecat-shared-brand-client.
 export interface BrandSemrushProject extends BaseModel {
   getBrandId(): string;
   getSemrushProjectId(): string;

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';
 export type * from './brand-semrush-project';
 export type * from './configuration';
 export type * from './consumer';

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/index.js';
 export * from './brand-semrush-project/index.js';
 export * from './configuration/index.js';
 export * from './consumer/index.js';