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

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

@@ -15,97 +15,31 @@ import type {
 } from '../index';
 
 export interface Configuration extends BaseModel {
-  /**
-   * Retrieves the configuration version.
-   * @returns {number} The configuration version.
-   */
-  getVersion: () => number;
-
-  /**
-   * Retrieves the queues configuration.
-   * @returns {object} The queues configuration.
-   */
-  getQueues: () => object;
-
-  /**
-   * Retrieves the jobs configuration.
-   * @returns {Array} The jobs configurations.
-   */
-  getJobs: () => Array<object>;
-
-  /**
-   * Retrieves the handlers configuration.
-   * @returns {object} The handlers configuration.
-   */
-  getHandlers: () => object;
-
-  /**
-   * Retrieves the handler configuration for handler type.
-   * @param type The handler type.
-   * @returns {object} The handler type configuration.
-   */
-  getHandler: (type) => object;
-
-  /**
-   * Retrieves the slack roles configuration.
-   * @returns {object} The slack roles configuration.
-   */
-  getSlackRoles: () => object;
-
-  /**
-   * Return true if a handler type is enabled for an organization.
-   * @param type handler type
-   * @param org organization
-   */
-  isHandlerEnabledForOrg: (type: string, org: Organization) => boolean;
-
-  /**
-   * Return true if a handler type is enabled for a site.
-   * @param type handler type
-   * @param site site
-   */
-  isHandlerEnabledForSite: (type: string, site: Site) => boolean;
-
-  /**
-   * Enables a handler type for an site.
-   * @param type handler type
-   * @param site site
-   */
-  enableHandlerForSite: (type: string, site: Site) => void;
-
-  /**
-   * Enables a handler type for an organization.
-   * @param type handler type
-   * @param org organization
-   */
-  enableHandlerForOrg: (type: string, org: Organization) => void;
-
-  /**
-   * Disables a handler type for an site.
-   * @param type handler type
-   * @param site site
-   */
-  disableHandlerForSite: (type: string, site: Site) => void;
-
-  /**
-   * Disables a handler type for an organization.
-   * @param type handler type
-   * @param org organization
-   */
-  disableHandlerForOrg: (type:string, org: Organization) => void;
+  addHandler(type: string, handler: object): void;
+  disableHandlerForOrganization(type: string, organization: Organization): void;
+  disableHandlerForSite(type: string, site: Site): void;
+  enableHandlerForOrganization(type: string, organization: Organization): void;
+  enableHandlerForSite(type: string, site: Site): void;
+  getConfigurationId(): string;
+  getEnabledSiteIdsForHandler(type: string): string[];
+  getHandler(type: string): object | undefined;
+  getHandlers(): object;
+  getJobs(): object;
+  getQueues(): object;
+  getSlackRoleMembersByRole(role: string): string[];
+  getSlackRoles(): object;
+  getVersion(): number;
+  isHandlerEnabledForOrg(type: string, organization: Organization): boolean;
+  isHandlerEnabledForSite(type: string, site: Site): boolean;
+  setHandlers(handlers: object): void;
+  setJobs(jobs: object): void;
+  setQueues(queues: object): void;
+  setSlackRoles(slackRoles: object): void;
+  updateHandlerOrgs(type: string, orgId: string, enabled: boolean): void;
+  updateHandlerSites(type: string, siteId: string, enabled: boolean): void;
 }
 
 export interface ConfigurationCollection extends BaseCollection<Configuration> {
-  /**
-   * Retrieves the latest configuration by version.
-   * @returns {Configuration} The configuration.
-   */
-  findLatest: () => Configuration;
-
-  /**
-   * Retrieves the configuration by version.
-   * @param version The configuration version.
-   * @returns {Configuration} The configuration.
-   */
-  findByVersion: (version: number) => Configuration;
+  findByVersion(version: number): Promise<Configuration | null>;
+  findLatest(): Promise<Configuration | null>;
 }

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

@@ -30,20 +30,28 @@ export interface Experiment extends BaseModel {
   setEndDate(endDate: number): Experiment;
   setExpId(expId: string): Experiment;
   setName(name: string): Experiment;
+  setSiteId(siteId: string): Experiment;
   setStartDate(startDate: number): Experiment;
   setStatus(status: string): Experiment;
   setType(type: string): Experiment;
   setUrl(url: string): Experiment;
+  setUpdatedBy(updatedBy: string): Experiment;
   setVariants(variants: object): Experiment;
 }
 
 export interface ExperimentCollection extends BaseCollection<Experiment> {
   allBySiteId(siteId: string): Promise<Experiment[]>;
   allBySiteIdAndExpId(siteId: string, expId: string): Promise<Experiment[]>;
+  allBySiteIdAndExpIdAndUrl(siteId: string, expId: string, url: string): Promise<Experiment[]>;
+  allBySiteIdAndExpIdAndUrlAndUpdatedAt(
+    siteId: string, expId: string, url: string, updatedAt: string
+  ): Promise<Experiment[]>;
+  findBySiteId(siteId: string): Promise<Experiment | null>;
   findBySiteIdAndExpId(siteId: string, expId: string): Promise<Experiment | null>;
   findBySiteIdAndExpIdAndUrl(
-    siteId: string,
-    expId: string,
-    url: string,
+    siteId: string, expId: string, url: string
+  ): Promise<Experiment | null>;
+  findBySiteIdAndExpIdAndUrlAndUpdatedAt(
+    siteId: string, expId: string, url: string, updatedAt: string
   ): Promise<Experiment | null>;
 }

package/src/v2/models/import-job/index.d.ts

@@ -11,6 +11,7 @@
  */
 
 import type { BaseCollection, BaseModel } from '../base';
+import type { ImportUrl } from '../import-url';
 
 export interface ImportJob extends BaseModel {
   getBaseURL(): string,
@@ -21,11 +22,13 @@ export interface ImportJob extends BaseModel {
   getHasCustomImportJs(): boolean,
   getHashedApiKey(): string,
   getImportQueueId(): string,
+  getImportUrls(): Promise<ImportUrl[]>,
+  getImportUrlsByStatus(status: string): Promise<ImportUrl[]>,
   getInitiatedBy(): string,
   getOptions(): string,
   getRedirectCount(): number,
-  getStatus(): string,
   getStartedAt(): number,
+  getStatus(): string,
   getSuccessCount(): number,
   getUrlCount(): number,
   setBaseURL(baseURL: string): void,
@@ -40,12 +43,16 @@ export interface ImportJob extends BaseModel {
   setOptions(options: string): void,
   setRedirectCount(redirectCount: number): void,
   setStatus(status: string): void,
-  setStartedAt(startTime: number): void,
   setSuccessCount(successCount: number): void,
   setUrlCount(urlCount: number): void,
 }
 
 export interface ImportJobCollection extends BaseCollection<ImportJob> {
-  allByDateRange(startDate: number, endDate: number): Promise<ImportJob[]>;
+  allByDateRange(startDate: string, endDate: string): Promise<ImportJob[]>;
+  allByStartedAt(startDate: string): Promise<ImportJob[]>;
   allByStatus(status: string): Promise<ImportJob[]>;
+  allByStatusAndUpdatedAt(status: string, updatedAt: string): Promise<ImportJob[]>;
+  findByStartedAt(startDate: string): Promise<ImportJob | null>;
+  findByStatus(status: string): Promise<ImportJob | null>;
+  findByStatusAndUpdatedAt(status: string, updatedAt: string): Promise<ImportJob | null>;
 }

package/src/v2/models/import-url/index.d.ts

@@ -10,17 +10,18 @@
  * governing permissions and limitations under the License.
  */
 
-import type { BaseCollection, BaseModel } from '../base';
+import type { BaseCollection, BaseModel, ImportJob } from '../index';
 
 export interface ImportUrl extends BaseModel {
-  getExpiresAt(): number,
+  getExpiresAt(): string,
   getFile(): string,
+  getImportJob(): Promise<ImportJob>,
   getImportJobId(): string,
   getPath(): string,
   getReason(): string,
   getStatus(): string,
   getUrl(): string,
-  setExpiresAt(expiresAt: number): void,
+  setExpiresAt(expiresAt: string): void,
   setFile(file: string): void,
   setImportJobId(importJobId: string): void,
   setPath(path: string): void,
@@ -32,4 +33,6 @@ export interface ImportUrl extends BaseModel {
 export interface ImportUrlCollection extends BaseCollection<ImportUrl> {
   allByImportJobId(importJobId: string): Promise<ImportUrl[]>;
   allByImportUrlsByJobIdAndStatus(importJobId: string, status: string): Promise<ImportUrl[]>;
+  findByImportJobId(importJobId: string): Promise<ImportUrl | null>;
+  findByImportJobIdAndUrl(importJobId: string, url: string): Promise<ImportUrl | null>;
 }

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

@@ -14,7 +14,10 @@ export type * from './audit/index.d.ts';
 export type * from './configuration/index.d.ts';
 export type * from './base/index.d.ts';
 export type * from './experiment/index.d.ts';
+export type * from './import-job/index.d.ts';
+export type * from './import-url/index.d.ts';
 export type * from './key-event/index.d.ts';
+export type * from './latest-audit/index.d.ts';
 export type * from './opportunity/index.d.ts';
 export type * from './organization/index.d.ts';
 export type * from './site/index.d.ts';

package/src/v2/models/index.js

@@ -18,6 +18,7 @@ export * from './experiment/index.js';
 export * from './import-job/index.js';
 export * from './import-url/index.js';
 export * from './key-event/index.js';
+export * from './latest-audit/index.js';
 export * from './opportunity/index.js';
 export * from './organization/index.js';
 export * from './site-candidate/index.js';

package/src/v2/models/key-event/index.d.ts

@@ -10,10 +10,11 @@
  * governing permissions and limitations under the License.
  */
 
-import type { BaseCollection, BaseModel } from '../index';
+import type { BaseCollection, BaseModel, Site } from '../index';
 
 export interface KeyEvent extends BaseModel {
   getName(): string;
+  getSite(): Promise<Site>;
   getSiteId(): string;
   getTime(): number;
   getType(): string;
@@ -25,4 +26,7 @@ export interface KeyEvent extends BaseModel {
 
 export interface KeyEventCollection extends BaseCollection<KeyEvent> {
   allBySiteId(siteId: string): Promise<KeyEvent[]>;
+  allBySiteIdAndTime(siteId: string, time: string): Promise<KeyEvent[]>;
+  findBySiteId(siteId: string): Promise<KeyEvent | null>;
+  findBySiteIdAndTime(siteId: string, time: string): Promise<KeyEvent | null>;
 }

package/src/v2/models/latest-audit/index.d.ts

@@ -0,0 +1,43 @@
+/*
+ * Copyright 2024 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 {
+  Audit, BaseCollection, BaseModel, Opportunity, Site,
+} from '../index';
+
+export interface LatestAudit extends BaseModel {
+  getAudit(): Promise<Audit>
+  getAuditedAt(): number;
+  getAuditId(): object;
+  getAuditResult(): object;
+  getAuditType(): string;
+  getFullAuditRef(): string;
+  getIsError(): boolean;
+  getIsLive(): boolean;
+  getOpportunities(): Promise<Opportunity[]>;
+  getOpportunitiesByUpdatedAt(): Promise<Opportunity[]>;
+  getSite(): Promise<Site>;
+  getSiteId(): string;
+}
+
+export interface LatestAuditCollection extends BaseCollection<LatestAudit> {
+  allByAuditId(auditId: string): Promise<LatestAudit[]>;
+  allByAuditIdAndAuditType(auditId: string, auditType: string): Promise<LatestAudit[]>;
+  allByAuditType(auditType: string): Promise<LatestAudit[]>;
+  allBySiteId(siteId: string): Promise<LatestAudit[]>;
+  allBySiteIdAndAuditType(siteId: string, auditType: string): Promise<LatestAudit[]>;
+  findByAuditId(auditId: string): Promise<LatestAudit | null>;
+  findByAuditIdAndAuditType(auditId: string, auditType: string): Promise<LatestAudit | null>;
+  findByAuditType(auditType: string): Promise<LatestAudit | null>;
+  findBySiteId(siteId: string): Promise<LatestAudit | null>;
+  findBySiteIdAndAuditType(siteId: string, auditType: string): Promise<LatestAudit | null>;
+}

package/src/v2/models/latest-audit/index.js

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2024 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 LatestAudit from './latest-audit.model.js';
+import LatestAuditCollection from './latest-audit.collection.js';
+
+export {
+  LatestAudit,
+  LatestAuditCollection,
+};

package/src/v2/models/latest-audit/latest-audit.collection.js

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2024 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';
+import { guardId, guardString } from '../../util/index.js';
+
+/**
+ * LatestAuditCollection - A collection class responsible for managing LatestAudit entities.
+ * Extends the AuditCollection to provide specific methods for interacting with LatestAudit records.
+ *
+ * @class LatestAuditCollection
+ * @extends AuditCollection
+ */
+class LatestAuditCollection extends BaseCollection {
+  async findById(siteId, auditType) {
+    guardId('siteId', siteId, this.entityName);
+    guardString('auditType', auditType, this.entityName);
+
+    return this.findByIndexKeys({ siteId, auditType });
+  }
+}
+
+export default LatestAuditCollection;

package/src/v2/models/latest-audit/latest-audit.model.js

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2024 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 Audit from '../audit/audit.model.js';
+
+/**
+ * LatestAudit - A class representing an LatestAudit entity.
+ * Provides methods to access and manipulate Audit-specific data.
+ *
+ * @class LatestAudit
+ * @extends Audit
+ */
+class LatestAudit extends Audit {
+  // add your custom methods or overrides here
+}
+
+export default LatestAudit;

package/src/v2/models/latest-audit/latest-audit.schema.js

@@ -0,0 +1,72 @@
+/*
+ * Copyright 2024 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.
+ */
+
+/* c8 ignore start */
+
+import { isIsoDate, isNonEmptyObject } from '@adobe/spacecat-shared-utils';
+
+import { validateAuditResult } from '../audit/audit.model.js';
+import SchemaBuilder from '../base/schema.builder.js';
+import LatestAudit from './latest-audit.model.js';
+import LatestAuditCollection from './latest-audit.collection.js';
+
+/*
+Schema Doc: https://electrodb.dev/en/modeling/schema/
+Attribute Doc: https://electrodb.dev/en/modeling/attributes/
+Indexes Doc: https://electrodb.dev/en/modeling/indexes/
+ */
+
+const schema = new SchemaBuilder(LatestAudit, LatestAuditCollection)
+  .withPrimaryPartitionKeys(['siteId'])
+  .withPrimarySortKeys(['auditType'])
+  .addReference('belongs_to', 'Site', ['auditType'])
+  .addReference('belongs_to', 'Audit', ['auditType'])
+  .addReference('has_many', 'Opportunities')
+  .addAllIndex(['auditType'])
+  .allowUpdates(false)
+  .allowRemove(false)
+  .addAttribute('auditResult', {
+    type: 'any',
+    required: true,
+    validate: (value) => isNonEmptyObject(value),
+    set: (value, attributes) => {
+      // as the electroDb validate function does not provide access to the model instance
+      // we need to call the validate function from the model on setting the value
+      validateAuditResult(value, attributes.auditType);
+      return value;
+    },
+  })
+  .addAttribute('auditType', {
+    type: 'string',
+    required: true,
+  })
+  .addAttribute('fullAuditRef', {
+    type: 'string',
+    required: true,
+  })
+  .addAttribute('isLive', {
+    type: 'boolean',
+    required: true,
+    default: false,
+  })
+  .addAttribute('isError', {
+    type: 'boolean',
+    required: true,
+    default: false,
+  })
+  .addAttribute('auditedAt', {
+    type: 'string',
+    required: true,
+    validate: (value) => isIsoDate(value),
+  });
+
+export default schema.build();

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

@@ -11,20 +11,24 @@
  */
 
 import type {
-  BaseCollection, BaseModel, MultiStatusCreateResult, Suggestion,
+  Audit, BaseCollection, BaseModel, MultiStatusCreateResult, Site, Suggestion,
 } from '../index';
 
 export interface Opportunity extends BaseModel {
   addSuggestions(suggestions: object[]): Promise<MultiStatusCreateResult<Suggestion>>;
+  getAudit(): Promise<Audit>;
   getAuditId(): string;
   getData(): object;
   getDescription(): string;
   getGuidance(): string;
   getOrigin(): string;
   getRunbook(): string;
+  getSite(): Promise<Site>;
   getSiteId(): string;
   getStatus(): string;
   getSuggestions(): Promise<Suggestion[]>;
+  getSuggestionsByStatus(status: string): Promise<Suggestion[]>;
+  getSuggestionsByStatusAndRank(status: string, rank: string): Promise<Suggestion[]>;
   getTags(): string[];
   getTitle(): string;
   getType(): string;
@@ -41,6 +45,18 @@ export interface Opportunity extends BaseModel {
 }
 
 export interface OpportunityCollection extends BaseCollection<Opportunity> {
+  allByAuditId(auditId: string): Promise<Opportunity[]>;
+  allByAuditIdAndUpdatedAt(auditId: string, updatedAt: string): Promise<Opportunity[]>;
   allBySiteId(siteId: string): Promise<Opportunity[]>;
   allBySiteIdAndStatus(siteId: string, status: string): Promise<Opportunity[]>;
+  allBySiteIdAndStatusAndUpdatedAt(
+    siteId: string, status: string, updatedAt: string
+  ): Promise<Opportunity[]>;
+  findByAuditId(auditId: string): Promise<Opportunity | null>;
+  findByAuditIdAndUpdatedAt(auditId: string, updatedAt: string): Promise<Opportunity | null>;
+  findBySiteId(siteId: string): Promise<Opportunity | null>;
+  findBySiteIdAndStatus(siteId: string, status: string): Promise<Opportunity | null>;
+  findBySiteIdAndStatusAndUpdatedAt(
+    siteId: string, status: string, updatedAt: string
+  ): Promise<Opportunity | null>;
 }

package/src/v2/models/opportunity/opportunity.schema.js

@@ -27,6 +27,7 @@ Indexes Doc: https://electrodb.dev/en/modeling/indexes/
 const schema = new SchemaBuilder(Opportunity, OpportunityCollection)
   .addReference('belongs_to', 'Site', ['status', 'updatedAt'])
   .addReference('belongs_to', 'Audit', ['updatedAt'], { required: false })
+  .addReference('belongs_to', 'LatestAudit', ['updatedAt'], { required: false })
   .addReference('has_many', 'Suggestions', ['updatedAt'], { removeDependents: true })
   .addAttribute('runbook', {
     type: 'string',

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

@@ -10,13 +10,14 @@
  * governing permissions and limitations under the License.
  */
 
-import type { BaseCollection, BaseModel } from '../index';
+import type { BaseCollection, BaseModel, Site } from '../index';
 
 export interface Organization extends BaseModel {
   getConfig(): object;
   getFulfillableItems(): object;
   getImsOrgId(): string;
   getName(): string;
+  getSites(): Promise<Site[]>;
   setConfig(config: object): Organization;
   setFulfillableItems(fulfillableItems: object): Organization;
   setImsOrgId(imsOrgId: string): Organization;
@@ -25,4 +26,5 @@ export interface Organization extends BaseModel {
 
 export interface OrganizationCollection extends BaseCollection<Organization> {
   allByImsOrgId(imsOrgId: string): Promise<Organization[]>;
+  findByImsOrgId(imsOrgId: string): Promise<Organization | null>;
 }

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

@@ -11,33 +11,70 @@
  */
 
 import type {
-  Audit, BaseCollection, BaseModel, Organization,
+  Audit,
+  BaseCollection,
+  BaseModel,
+  Experiment,
+  KeyEvent,
+  LatestAudit,
+  Opportunity,
+  Organization,
+  SiteCandidate,
+  SiteTopPage,
 } from '../index';
 
 export interface Site extends BaseModel {
   getAudits(): Promise<Audit>;
+  getAuditsByAuditType(auditType: string): Promise<Audit>;
+  getAuditsByAuditTypeAndAuditedAt(auditType: string, auditedAt: string): Promise<Audit>;
   getBaseURL(): string;
   getConfig(): object;
   getDeliveryType(): string;
-  getFulfillableItems(): object;
+  getExperiments(): Promise<Experiment[]>;
+  getExperimentsByExpId(expId: string): Promise<Experiment[]>;
+  getExperimentsByExpIdAndUrl(expId: string, url: string): Promise<Experiment[]>;
+  getExperimentsByExpIdAndUrlAndUpdatedAt(
+    expId: string, url: string, updatedAt: string
+  ): Promise<Experiment[]>;
   getGitHubURL(): string;
   getHlxConfig(): object;
   getIsLive(): boolean;
   getIsLiveToggledAt(): string;
+  getKeyEvents(): Promise<KeyEvent[]>
+  getKeyEventsByTimestamp(timestamp: string): Promise<KeyEvent[]>
+  getLatestAudit(): Promise<LatestAudit>;
+  getLatestAuditByAuditType(auditType: string): Promise<LatestAudit>;
+  getLatestAudits(): Promise<LatestAudit>;
+  getLatestAuditByAuditType(auditType: string): Promise<LatestAudit>;
+  getOpportunities(): Promise<Opportunity[]>;
+  getOpportunitiesByStatus(status: string): Promise<Opportunity[]>;
+  getOpportunitiesByStatusAndUpdatedAt(status: string, updatedAt: string): Promise<Opportunity[]>;
   getOrganization(): Promise<Organization>;
   getOrganizationId(): string;
+  getSiteCandidates(): Promise<SiteCandidate[]>;
+  getSiteTopPages(): Promise<SiteTopPage[]>;
+  getSiteTopPagesBySource(source: string): Promise<SiteTopPage[]>;
+  getSiteTopPagesBySourceAndGeo(source: string, geo: string): Promise<SiteTopPage[]>;
+  getSiteTopPagesBySourceAndGeoAndTraffic(
+    source: string, geo: string, traffic: string
+  ): Promise<SiteTopPage[]>;
+  setBaseURL(baseURL: string): Site;
   setConfig(config: object): Site;
   setDeliveryType(deliveryType: string): Site;
-  setFulfillableItems(fulfillableItems: object): Site;
   setGitHubURL(gitHubURL: string): Site;
   setHlxConfig(hlxConfig: object): Site;
   setIsLive(isLive: boolean): Site;
+  setIsLiveToggledAt(isLiveToggledAt: string): Site;
   setOrganizationId(organizationId: string): Site;
   toggleLive(): Site;
 }
 
 export interface SiteCollection extends BaseCollection<Organization> {
-  findByBaseURL(siteId: string): Promise<Site>;
-  allByDeliveryType(siteId: string): Promise<Site[]>;
-  allByOrganizationId(siteId: string): Promise<Site[]>;
+  allByBaseURL(baseURL: string): Promise<Site[]>;
+  allByDeliveryType(deliveryType: string): Promise<Site[]>;
+  allByOrganizationId(organizationId: string): Promise<Site[]>;
+  allSitesToAudit(): Promise<string[]>;
+  findByBaseURL(baseURL: string): Promise<Site | null>;
+  findByDeliveryType(deliveryType: string): Promise<Site | null>;
+  findByOrganizationId(organizationId: string): Promise<Site | null>;
 }

package/src/v2/models/site/site.model.js

@@ -31,12 +31,6 @@ class Site extends BaseModel {
     return Config(this.record.config);
   }
 
-  async getLatestAuditByType(auditType) {
-    const collection = this.entityRegistry.getCollection('AuditCollection');
-
-    return collection.findByIndexKeys({ siteId: this.getId(), auditType });
-  }
-
   async toggleLive() {
     const newIsLive = !this.getIsLive();
     this.setIsLive(newIsLive);

package/src/v2/models/site/site.schema.js

@@ -41,6 +41,8 @@ const schema = new SchemaBuilder(Site, SiteCollection)
   .addReference('has_many', 'Audits')
   .addReference('has_many', 'Experiments')
   .addReference('has_many', 'KeyEvents')
+  .addReference('has_many', 'LatestAudits', ['auditType'])
+  .addReference('has_one', 'LatestAudit', ['auditType'], { required: false })
   .addReference('has_many', 'Opportunities')
   .addReference('has_many', 'SiteCandidates')
   .addReference('has_many', 'SiteTopPages')