feat(data-access): add scopeType and scopeId to Opportunity model

packages/spacecat-shared-data-access/src/models/opportunity/index.d.ts

@@ -35,6 +35,10 @@ export interface Opportunity extends BaseModel {
   getTags(): string[];
   getTitle(): string;
   getType(): string;
+  getScopeId(): string | null;
+  getScopeType(): string | null;
+  setScopeId(scopeId: string): Opportunity;
+  setScopeType(scopeType: string): Opportunity;
   setAuditId(auditId: string): Opportunity;
   setData(data: object): Opportunity;
   setDescription(description: string): Opportunity;
@@ -49,6 +53,7 @@ export interface Opportunity extends BaseModel {
 }
 
 export interface OpportunityCollection extends BaseCollection<Opportunity> {
+  allByScopeId(scopeType: string, scopeId: string): Promise<Opportunity[]>;
   allByAuditId(auditId: string): Promise<Opportunity[]>;
   allByAuditIdAndUpdatedAt(auditId: string, updatedAt: string): Promise<Opportunity[]>;
   allBySiteId(siteId: string): Promise<Opportunity[]>;

packages/spacecat-shared-data-access/src/models/opportunity/opportunity.collection.js

@@ -10,6 +10,8 @@
  * governing permissions and limitations under the License.
  */
 
+import { hasText } from '@adobe/spacecat-shared-utils';
+
 import BaseCollection from '../base/base.collection.js';
 
 /**
@@ -22,7 +24,24 @@ import BaseCollection from '../base/base.collection.js';
 class OpportunityCollection extends BaseCollection {
   static COLLECTION_NAME = 'OpportunityCollection';
 
-  // add custom methods here
+  /**
+   * Returns all opportunities with a given scope type and scope ID.
+   * Used to fetch brand-scoped opportunities directly by brandId
+   * without going through site association.
+   *
+   * @param {string} scopeType - The scope type (e.g. 'brand', 'site').
+   * @param {string} scopeId - The scope entity UUID (e.g. brand UUID).
+   * @returns {Promise<Opportunity[]>} The matching opportunities.
+   */
+  async allByScopeId(scopeType, scopeId) {
+    if (!hasText(scopeType)) {
+      throw new Error('scopeType is required');
+    }
+    if (!hasText(scopeId)) {
+      throw new Error('scopeId is required');
+    }
+    return this.allByIndexKeys({ scopeType, scopeId });
+  }
 }
 
 export default OpportunityCollection;

packages/spacecat-shared-data-access/src/models/opportunity/opportunity.model.js

@@ -37,6 +37,11 @@ class Opportunity extends BaseModel {
     RESOLVED: 'RESOLVED',
   };
 
+  static SCOPE_TYPES = {
+    SITE: 'site',
+    BRAND: 'brand',
+  };
+
   /**
    * Adds the given suggestions to this Opportunity. Sets this opportunity as the parent
    * of each suggestion, as such the opportunity ID does not need to be provided.

packages/spacecat-shared-data-access/src/models/opportunity/opportunity.schema.js

@@ -64,6 +64,12 @@ const schema = new SchemaBuilder(Opportunity, OpportunityCollection)
   .addAttribute('lastAuditedAt', {
     type: 'string',
     validate: (value) => !value || isIsoDate(value),
+  })
+  .addAttribute('scopeType', {
+    type: Object.values(Opportunity.SCOPE_TYPES),
+  })
+  .addAttribute('scopeId', {
+    type: 'string',
   });
 
 export default schema.build();

packages/spacecat-shared-data-access/test/it/postgrest/docker-compose.yml

@@ -17,7 +17,7 @@ services:
 
   data-service:
     platform: ${MYSTICAT_DATA_SERVICE_PLATFORM:-linux/amd64}
-    image: ${MYSTICAT_DATA_SERVICE_REPOSITORY:-682033462621.dkr.ecr.us-east-1.amazonaws.com/mysticat-data-service}:${MYSTICAT_DATA_SERVICE_TAG:-v1.67.8}
+    image: ${MYSTICAT_DATA_SERVICE_REPOSITORY:-682033462621.dkr.ecr.us-east-1.amazonaws.com/mysticat-data-service}:${MYSTICAT_DATA_SERVICE_TAG:-v5.1.1}
     depends_on:
       db:
         condition: service_healthy

packages/spacecat-shared-data-access/test/unit/models/opportunity/opportunity.collection.test.js

@@ -12,6 +12,7 @@
 
 import { expect, use as chaiUse } from 'chai';
 import chaiAsPromised from 'chai-as-promised';
+import { stub } from 'sinon';
 import sinonChai from 'sinon-chai';
 
 import Opportunity from '../../../../src/models/opportunity/opportunity.model.js';
@@ -70,4 +71,35 @@ describe('OpportunityCollection', () => {
       expect(model).to.be.an('object');
     });
   });
+
+  describe('allByScopeId', () => {
+    it('throws an error if scopeType is not provided', async () => {
+      await expect(instance.allByScopeId()).to.be.rejectedWith('scopeType is required');
+    });
+
+    it('throws an error if scopeId is not provided', async () => {
+      await expect(instance.allByScopeId('brand')).to.be.rejectedWith('scopeId is required');
+    });
+
+    it('delegates to allByIndexKeys with the correct arguments', async () => {
+      const mockOpportunity = { getOpportunityId: () => 'op-111' };
+      instance.allByIndexKeys = stub().resolves([mockOpportunity]);
+
+      const result = await instance.allByScopeId('brand', 'brand-uuid-123');
+
+      expect(instance.allByIndexKeys).to.have.been.calledOnceWith({
+        scopeType: 'brand',
+        scopeId: 'brand-uuid-123',
+      });
+      expect(result).to.deep.equal([mockOpportunity]);
+    });
+
+    it('returns an empty array when no opportunities match the scope', async () => {
+      instance.allByIndexKeys = stub().resolves([]);
+
+      const result = await instance.allByScopeId('brand', 'brand-uuid-no-results');
+
+      expect(result).to.be.an('array').with.lengthOf(0);
+    });
+  });
 });

packages/spacecat-shared-data-access/test/unit/models/opportunity/opportunity.model.test.js

@@ -384,4 +384,43 @@ describe('OpportunityModel', () => {
       expect(instance.record.data).to.deep.equal({ newInfo: 'updatedInfo' });
     });
   });
+
+  describe('getScopeType and setScopeType', () => {
+    it('returns undefined when scopeType is not set', () => {
+      expect(instance.getScopeType()).to.be.undefined;
+    });
+
+    it('returns the scopeType value', () => {
+      mockRecord.scopeType = 'brand';
+      expect(instance.getScopeType()).to.equal('brand');
+    });
+
+    it('sets the scopeType value', () => {
+      instance.setScopeType('brand');
+      expect(instance.record.scopeType).to.equal('brand');
+    });
+  });
+
+  describe('getScopeId and setScopeId', () => {
+    it('returns undefined when scopeId is not set', () => {
+      expect(instance.getScopeId()).to.be.undefined;
+    });
+
+    it('returns the scopeId value', () => {
+      mockRecord.scopeId = 'brand-uuid-123';
+      expect(instance.getScopeId()).to.equal('brand-uuid-123');
+    });
+
+    it('sets the scopeId value', () => {
+      instance.setScopeId('brand-uuid-456');
+      expect(instance.record.scopeId).to.equal('brand-uuid-456');
+    });
+  });
+
+  describe('SCOPE_TYPES', () => {
+    it('defines expected scope type constants', () => {
+      expect(Opportunity.SCOPE_TYPES.SITE).to.equal('site');
+      expect(Opportunity.SCOPE_TYPES.BRAND).to.equal('brand');
+    });
+  });
 });