@adobe/spacecat-shared-data-access 3.61.0 → 3.63.0

package/CHANGELOG.md

@@ -1,3 +1,21 @@
+## [@adobe/spacecat-shared-data-access-v3.63.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v3.62.0...@adobe/spacecat-shared-data-access-v3.63.0) (2026-05-14)
+
+### Features
+
+* add rumConfig to Site config for deterministic RUM availability signal ([#1596](https://github.com/adobe/spacecat-shared/issues/1596)) ([3b16cdf](https://github.com/adobe/spacecat-shared/commit/3b16cdf7d66ddddc4b4b62aae4428feba3ef7f04))
+* **data-access:** add preOnboarded flag to PLG onboarding steps schema ([#1601](https://github.com/adobe/spacecat-shared/issues/1601)) ([6f18f71](https://github.com/adobe/spacecat-shared/commit/6f18f71d112d5f409a545a3720ca8b7d9e3a13d7))
+
+### Bug Fixes
+
+* adds a function to get latest token by createdAt ([#1597](https://github.com/adobe/spacecat-shared/issues/1597)) ([fb4d5f9](https://github.com/adobe/spacecat-shared/commit/fb4d5f91dc7bf674cff4f9855d3f630aa4807b5a))
+* **deps:** update external fixes ([#1533](https://github.com/adobe/spacecat-shared/issues/1533)) ([0a3e2ab](https://github.com/adobe/spacecat-shared/commit/0a3e2abbbc5f58b5320518f7d596d4cef6271fa0))
+
+## [@adobe/spacecat-shared-data-access-v3.62.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v3.61.0...@adobe/spacecat-shared-data-access-v3.62.0) (2026-05-12)
+
+### Features
+
+* **data-access:** add semrushWorkspaceId attribute to Organization ([#1602](https://github.com/adobe/spacecat-shared/issues/1602)) ([79a5d82](https://github.com/adobe/spacecat-shared/commit/79a5d825c2a3cb436d894f5bea90a0a4e230167b))
+
 ## [@adobe/spacecat-shared-data-access-v3.61.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v3.60.0...@adobe/spacecat-shared-data-access-v3.61.0) (2026-05-12)
 
 ### Features

package/README.md

@@ -172,6 +172,25 @@ The `deliveryConfig` object on a Site stores delivery infrastructure details. It
 | `preferContentApi` | boolean | Whether to prefer the Content API for content retrieval |
 | `contentSourcePath` | string | AEM content root path for a site. Used to disambiguate multiple sites that share the same Cloud Manager program and environment. Corresponds to `/content/<site-name>` in the AEM repository. |
 
+## Site rumConfig
+
+The `rumConfig` object on a Site tracks Real User Monitoring (RUM) domain key availability. It is set automatically on site creation and refreshed weekly by the `rum-config-refresh` audit handler.
+
+| Property | Type | Description |
+|----------|------|-------------|
+| `hasDomainKey` | boolean | Whether the site's domain has an active RUM domain key registered |
+| `lastCheckedAt` | string (ISO 8601) | Timestamp of the most recent RUM domain key check |
+
+### Config model methods
+
+| Method | Returns | Description |
+|--------|---------|-------------|
+| `getRumConfig()` | `{ hasDomainKey, lastCheckedAt } \| undefined` | Returns the current rumConfig, or `undefined` if not yet set |
+| `hasRumDomainKey()` | `boolean` | Returns `true` if a RUM domain key is active, `false` otherwise |
+| `updateRumConfig(hasDomainKey)` | `void` | Sets `hasDomainKey` and updates `lastCheckedAt` to the current time |
+
+Sites created before the `rum-config-refresh` handler ran will have no `rumConfig` key — callers must treat `undefined` as "unknown" rather than "not set up".
+
 ## Architecture
 
 ```

package/docker-compose.test.yml

@@ -22,7 +22,7 @@ services:
       retries: 10
 
   postgrest:
-    image: postgrest/postgrest:v14.8
+    image: postgrest/postgrest:v14.11
     container_name: spacecat-test-postgrest
     depends_on:
       db:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-data-access",
-  "version": "3.61.0",
+  "version": "3.63.0",
   "description": "Shared modules of the Spacecat Services - Data Access",
   "type": "module",
   "engines": {
@@ -42,18 +42,18 @@
   "dependencies": {
     "@adobe/fetch": "^4.2.3",
     "@adobe/spacecat-shared-utils": "1.105.0",
-    "@supabase/postgrest-js": "2.101.1",
+    "@supabase/postgrest-js": "2.105.4",
     "@aws-sdk/client-s3": "^3.940.0",
     "@types/joi": "17.2.3",
     "aws-xray-sdk": "3.12.0",
-    "joi": "18.1.2",
+    "joi": "18.2.1",
     "pluralize": "8.0.0"
   },
   "devDependencies": {
     "chai": "6.2.2",
     "chai-as-promised": "8.0.2",
-    "nock": "14.0.11",
-    "sinon": "21.0.3",
+    "nock": "14.0.15",
+    "sinon": "21.1.2",
     "sinon-chai": "4.0.1"
   }
 }

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

@@ -19,6 +19,7 @@ export interface Organization extends BaseModel {
   getFulfillableItems(): object;
   getImsOrgId(): string;
   getName(): string;
+  getSemrushWorkspaceId(): string;
   getSites(): Promise<Site[]>;
   getProjects(): Promise<Project[]>;
   getEntitlements(): Promise<Entitlement[]>;
@@ -28,9 +29,12 @@ export interface Organization extends BaseModel {
   setFulfillableItems(fulfillableItems: object): Organization;
   setImsOrgId(imsOrgId: string): Organization;
   setName(name: string): Organization;
+  setSemrushWorkspaceId(semrushWorkspaceId: string): Organization;
 }
 
 export interface OrganizationCollection extends BaseCollection<Organization> {
   allByImsOrgId(imsOrgId: string): Promise<Organization[]>;
+  allBySemrushWorkspaceId(semrushWorkspaceId: string): Promise<Organization[]>;
   findByImsOrgId(imsOrgId: string): Promise<Organization | null>;
+  findBySemrushWorkspaceId(semrushWorkspaceId: string): Promise<Organization | null>;
 }

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

@@ -12,7 +12,7 @@
 
 /* c8 ignore start */
 
-import { isNonEmptyObject } from '@adobe/spacecat-shared-utils';
+import { hasText, isNonEmptyObject } from '@adobe/spacecat-shared-utils';
 
 import { Config, DEFAULT_CONFIG, validateConfiguration } from '../site/config.js';
 import SchemaBuilder from '../base/schema.builder.js';
@@ -48,6 +48,19 @@ const schema = new SchemaBuilder(Organization, OrganizationCollection)
     type: 'any',
     validate: (value) => !value || isNonEmptyObject(value),
   })
-  .addAllIndex(['imsOrgId']);
+  .addAttribute('semrushWorkspaceId', {
+    type: 'string',
+    // Minimum guard: reject empty / whitespace-only strings. Full format
+    // validation deferred until Semrush confirms the workspace-ID format.
+    // Use value == null (loose) so undefined and null short-circuit, but
+    // empty string ('') falls through to hasText() which rejects it.
+    validate: (value) => value == null || hasText(value),
+  })
+  .addAllIndex(['imsOrgId'])
+  // Uniqueness is enforced at the DB level via the UNIQUE constraint on
+  // organizations.semrush_workspace_id (mysticat-data-service migration
+  // 20260525000000), so findBySemrushWorkspaceId is semantically guaranteed
+  // to return at most one row.
+  .addAllIndex(['semrushWorkspaceId']);
 
 export default schema.build();

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

@@ -68,6 +68,7 @@ const schema = new SchemaBuilder(PlgOnboarding, PlgOnboardingCollection)
       entitlementCreated: { type: 'boolean' },
       entitlementFailed: { type: 'boolean' },
       orgResolutionFailed: { type: 'boolean' },
+      preOnboarded: { type: 'boolean' },
     },
   })
   .addAttribute('error', {

package/src/models/site/config.js

@@ -407,6 +407,10 @@ export const configSchema = Joi.object({
       startTime: Joi.number().optional(),
     })).optional(),
   }).optional(),
+  rumConfig: Joi.object({
+    hasDomainKey: Joi.boolean().required(),
+    lastCheckedAt: Joi.string().isoDate().required(),
+  }).optional(),
   commerceLlmoConfig: Joi.object().pattern(
     Joi.string(),
     Joi.object({
@@ -542,6 +546,18 @@ export const Config = (data = {}) => {
   self.getEdgeOptimizeConfig = () => state?.edgeOptimizeConfig;
   self.getOnboardConfig = () => state?.onboardConfig;
   self.getCommerceLlmoConfig = () => state?.commerceLlmoConfig;
+  /**
+   * Returns the RUM configuration for the site, or undefined if not set.
+   * Returns a shallow copy to prevent callers from mutating internal state.
+   * @returns {{ hasDomainKey: boolean, lastCheckedAt: string } | undefined}
+   */
+  self.getRumConfig = () => (state?.rumConfig ? { ...state.rumConfig } : undefined);
+
+  /**
+   * Returns true if RUM data collection is confirmed active for this site.
+   * @returns {boolean}
+   */
+  self.hasRumDomainKey = () => state?.rumConfig?.hasDomainKey === true;
   const AUDIT_TARGET_SOURCES = ['manual', 'moneyPages'];
   const auditTargetEntrySchema = Joi.object({
     url: Joi.string().uri().required(),
@@ -955,6 +971,22 @@ export const Config = (data = {}) => {
     state.commerceLlmoConfig = commerceLlmoConfig;
   };
 
+  /**
+   * Records the outcome of a RUM domain-key check and updates the timestamp.
+   * @param {boolean} hasDomainKey - Whether the site has an active RUM domain key.
+   * @param {Date} [now=new Date()] - Timestamp for lastCheckedAt; injectable for tests.
+   * @throws {Error} if hasDomainKey is not a boolean.
+   */
+  self.updateRumConfig = (hasDomainKey, now = new Date()) => {
+    if (typeof hasDomainKey !== 'boolean') {
+      throw new TypeError(`updateRumConfig: hasDomainKey must be a boolean, got ${typeof hasDomainKey}`);
+    }
+    state.rumConfig = {
+      hasDomainKey,
+      lastCheckedAt: now.toISOString(),
+    };
+  };
+
   return Object.freeze(self);
 };
 
@@ -974,6 +1006,7 @@ Config.toDynamoItem = (config) => ({
   edgeOptimizeConfig: config.getEdgeOptimizeConfig(),
   onboardConfig: config.getOnboardConfig?.(),
   commerceLlmoConfig: config.getCommerceLlmoConfig?.(),
+  rumConfig: config.getRumConfig?.(),
   enableMoneyPageUrls: config.isMoneyPageUrlsEnabled?.() === false ? false : undefined,
   auditTargetURLs: config.getAuditTargetURLsConfig?.(),
 });

package/src/models/token/token.collection.js

@@ -42,6 +42,21 @@ class TokenCollection extends BaseCollection {
    * @returns {Promise<import('./token.model.js').default|null>} Token instance
    *   (existing or newly created), or null when none exists and createIfNotFound is false.
    */
+  /**
+   * Finds the most recently created Token for a given siteId and tokenType,
+   * regardless of cycle. Returns null if no token exists.
+   *
+   * @param {string} siteId - Site ID (UUID).
+   * @param {string} tokenType - Token type (e.g. grant_cwv, grant_broken_backlinks).
+   * @returns {Promise<import('./token.model.js').default|null>} The last created Token, or null.
+   */
+  async findLastCreatedBySiteIdAndTokenType(siteId, tokenType) {
+    if (!hasText(siteId) || !hasText(tokenType)) {
+      throw new DataAccessError('TokenCollection.findLastCreatedBySiteIdAndTokenType: siteId and tokenType are required');
+    }
+    return this.findByIndexKeys({ siteId, tokenType }, { order: 'desc' });
+  }
+
   async findBySiteIdAndTokenType(siteId, tokenType, options = {}) {
     if (!hasText(siteId) || !hasText(tokenType)) {
       throw new DataAccessError('TokenCollection.findBySiteIdAndTokenType: siteId and tokenType are required');