@adobe/spacecat-shared-data-access 3.6.2 → 3.8.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [@adobe/spacecat-shared-data-access-v3.8.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v3.7.0...@adobe/spacecat-shared-data-access-v3.8.0) (2026-03-05)
+
+### Features
+
+* **data-access:** add bulk entitlement query with organization embedding ([#1402](https://github.com/adobe/spacecat-shared/issues/1402)) ([588cfce](https://github.com/adobe/spacecat-shared/commit/588cfce8e1b4e81a55c3fbca4c7491368196b558))
+
+## [@adobe/spacecat-shared-data-access-v3.7.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v3.6.2...@adobe/spacecat-shared-data-access-v3.7.0) (2026-03-04)
+
+### Features
+
+* **data-access:** add timesCited attribute to SentimentTopic schema ([#1399](https://github.com/adobe/spacecat-shared/issues/1399)) ([03cae03](https://github.com/adobe/spacecat-shared/commit/03cae0375a1c44e23d33b65f28002b5b22b975c1))
+
 ## [@adobe/spacecat-shared-data-access-v3.6.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v3.6.1...@adobe/spacecat-shared-data-access-v3.6.2) (2026-03-04)
 
 ### Bug Fixes

package/package.json

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

package/src/models/entitlement/entitlement.collection.js

@@ -11,6 +11,8 @@
  */
 
 import BaseCollection from '../base/base.collection.js';
+import DataAccessError from '../../errors/data-access.error.js';
+import { DEFAULT_PAGE_SIZE } from '../../util/postgrest.utils.js';
 
 /**
  * EntitlementCollection - A collection class responsible for managing Entitlement entities.
@@ -22,7 +24,67 @@ import BaseCollection from '../base/base.collection.js';
 class EntitlementCollection extends BaseCollection {
   static COLLECTION_NAME = 'EntitlementCollection';
 
-  // add custom methods here
+  /**
+   * Finds all entitlements for a given product code with their parent organization
+   * data embedded via PostgREST resource embedding (INNER JOIN). This avoids N+1
+   * queries when you need both entitlement and organization data.
+   *
+   * Returns plain objects, not model instances, since the result combines fields
+   * from two entities. Callers should access properties directly
+   * (e.g., `result.entitlement.tier`), not via getter methods.
+   *
+   * @param {string} productCode - Product code to filter by (e.g., 'LLMO').
+   * @returns {Promise<Array<{entitlement: {id: string, productCode: string, tier: string},
+   *   organization: {id: string, name: string, imsOrgId: string}}>>}
+   */
+  async allByProductCodeWithOrganization(productCode) {
+    if (!productCode) {
+      throw new DataAccessError('productCode is required', { entityName: 'Entitlement', tableName: 'entitlements' });
+    }
+
+    const allResults = [];
+    let offset = 0;
+    let keepGoing = true;
+
+    while (keepGoing) {
+      // eslint-disable-next-line no-await-in-loop
+      const { data, error } = await this.postgrestService
+        .from('entitlements')
+        .select('id, product_code, tier, organizations!inner(id, name, ims_org_id)')
+        .eq('product_code', productCode)
+        .range(offset, offset + DEFAULT_PAGE_SIZE - 1);
+
+      if (error) {
+        this.log.error(`[Entitlement] Failed to query entitlements with organizations - ${error.message}`, error);
+        throw new DataAccessError(
+          'Failed to query entitlements with organizations',
+          { entityName: 'Entitlement', tableName: 'entitlements' },
+          error,
+        );
+      }
+
+      if (!data || data.length === 0) {
+        keepGoing = false;
+      } else {
+        allResults.push(...data);
+        keepGoing = data.length >= DEFAULT_PAGE_SIZE;
+        offset += DEFAULT_PAGE_SIZE;
+      }
+    }
+
+    return allResults.map((row) => ({
+      entitlement: {
+        id: row.id,
+        productCode: row.product_code,
+        tier: row.tier,
+      },
+      organization: {
+        id: row.organizations.id,
+        name: row.organizations.name,
+        imsOrgId: row.organizations.ims_org_id,
+      },
+    }));
+  }
 }
 
 export default EntitlementCollection;

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

@@ -31,6 +31,19 @@ export interface Entitlement extends BaseModel {
   setQuotas(quotas: object): Entitlement;
 }
 
+export interface EntitlementWithOrganization {
+  entitlement: {
+    id: string;
+    productCode: EntitlementProductCode;
+    tier: EntitlementTier;
+  };
+  organization: {
+    id: string;
+    name: string;
+    imsOrgId: string;
+  } | null;
+}
+
 export interface EntitlementCollection extends
     BaseCollection<Entitlement> {
   allByOrganizationId(organizationId: string): Promise<Entitlement[]>;
@@ -44,4 +57,8 @@ export interface EntitlementCollection extends
     organizationId: string,
     productCode: EntitlementProductCode,
   ): Promise<Entitlement | null>;
+
+  allByProductCodeWithOrganization(
+    productCode: EntitlementProductCode,
+  ): Promise<EntitlementWithOrganization[]>;
 }

package/src/models/sentiment-topic/sentiment-topic.schema.js

@@ -61,6 +61,20 @@ const schema = new SchemaBuilder(SentimentTopic, SentimentTopicCollection)
     required: true,
     default: [],
   })
+  .addAttribute('citations', {
+    type: 'list',
+    required: false,
+    default: [],
+    postgrestIgnore: true,
+    items: {
+      type: 'map',
+      properties: {
+        url: { type: 'string', required: true },
+        timesCited: { type: 'number', required: true },
+        category: { type: 'string', required: false },
+      },
+    },
+  })
   .addAttribute('enabled', {
     type: 'boolean',
     required: true,