@adobe/spacecat-shared-data-access 1.60.2 → 1.61.0

package/src/v2/models/site-candidate/index.d.ts

@@ -10,12 +10,12 @@
  * governing permissions and limitations under the License.
  */
 
-import type { BaseCollection, BaseModel } from '../index';
+import type { BaseCollection, BaseModel, Site } from '../index';
 
 export interface SiteCandidate extends BaseModel {
   getBaseURL(): string;
   getHlxConfig(): object;
-  getSite(): object;
+  getSite(): Promise<Site>;
   getSiteId(): string;
   getSource(): string;
   getStatus(): string;
@@ -29,10 +29,8 @@ export interface SiteCandidate extends BaseModel {
 }
 
 export interface SiteCandidateCollection extends BaseCollection<SiteCandidate> {
+  allByBaseURL(baseURL: string): Promise<SiteCandidate[]>;
   allBySiteId(siteId: string): Promise<SiteCandidate[]>;
-  allBySiteIdAndSiteCandidateIdAndUrl(
-    siteId: string,
-    siteCandidateId: string,
-    url: string,
-  ): Promise<SiteCandidate[]>;
+  findByBaseURL(baseURL: string): Promise<SiteCandidate | null>;
+  findBySiteId(siteId: string): Promise<SiteCandidate | null>;
 }

package/src/v2/models/site-top-page/index.d.ts

@@ -10,11 +10,12 @@
  * governing permissions and limitations under the License.
  */
 
-import type { BaseCollection, BaseModel } from '../index';
+import type { BaseCollection, BaseModel, Site } from '../index';
 
 export interface SiteTopPage extends BaseModel {
   getGeo(): string;
-  getImportedAt(): number;
+  getImportedAt(): string;
+  getSite(): Promise<Site>;
   getSiteId(): string;
   getSource(): string;
   getTopKeyword(): string;
@@ -31,5 +32,18 @@ export interface SiteTopPage extends BaseModel {
 
 export interface SiteTopPageCollection extends BaseCollection<SiteTopPage> {
   allBySiteId(siteId: string): Promise<SiteTopPage[]>;
+  allBySiteIdAndSource(siteId: string, source: string): Promise<SiteTopPage[]>;
   allBySiteIdAndSourceAndGeo(siteId: string, source: string, geo: string): Promise<SiteTopPage[]>;
+  allBySiteIdAndSourceAndGeoAndTraffic(
+    siteId: string, source: string, geo: string, traffic: number
+  ): Promise<SiteTopPage[]>;
+  findBySiteId(siteId: string): Promise<SiteTopPage | null>;
+  findBySiteIdAndSource(siteId: string, source: string): Promise<SiteTopPage | null>;
+  findBySiteIdAndSourceAndGeo(
+    siteId: string, source: string, geo: string
+  ): Promise<SiteTopPage | null>;
+  findBySiteIdAndSourceAndGeoAndTraffic(
+    siteId: string, source: string, geo: string, traffic: number
+  ): Promise<SiteTopPage | null>;
+  removeForSiteId(siteId: string, source: string, geo: string): Promise<void>;
 }

package/src/v2/models/suggestion/index.d.ts

@@ -31,4 +31,6 @@ export interface SuggestionCollection extends BaseCollection<Suggestion> {
   allByOpportunityId(opportunityId: string): Promise<Suggestion[]>;
   allByOpportunityIdAndStatus(opportunityId: string, status: string): Promise<Suggestion[]>;
   bulkUpdateStatus(suggestions: Suggestion[], status: string): Promise<Suggestion[]>;
+  findByOpportunityId(opportunityId: string): Promise<Suggestion | null>;
+  findByOpportunityIdAndStatus(opportunityId: string, status: string): Promise<Suggestion | null>;
 }

package/src/v2/util/patcher.js

@@ -40,6 +40,12 @@ const checkReadOnly = (propertyName, attribute) => {
   }
 };
 
+const checkUpdatesAllowed = (schema) => {
+  if (!schema.allowsUpdates()) {
+    throw new ValidationError(`Updates prohibited by schema for ${schema.getModelName()}.`);
+  }
+};
+
 class Patcher {
   /**
    * Creates a new Patcher instance for an entity.
@@ -49,6 +55,7 @@ class Patcher {
    */
   constructor(entity, schema, record) {
     this.entity = entity;
+    this.schema = schema;
     this.record = record;
 
     this.entityName = schema.getEntityName();
@@ -151,6 +158,8 @@ class Patcher {
    * @param {boolean} [isReference=false] - Whether the value is a reference to another entity.
    */
   patchValue(propertyName, value, isReference = false) {
+    checkUpdatesAllowed(this.schema);
+
     const attribute = this.model.schema?.attributes[propertyName];
     if (!isObject(attribute)) {
       throw new ValidationError(`Property ${propertyName} does not exist on entity ${this.entityName}.`);
@@ -202,6 +211,8 @@ class Patcher {
    * @throws {Error} - Throws an error if the save operation fails.
    */
   async save() {
+    checkUpdatesAllowed(this.schema);
+
     if (!this.hasUpdates()) {
       return;
     }