/*
 * 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 { BaseCollection, BaseModel, Site } from '../index';

/**
 * AuditUrl entity representing a URL to be audited for a site.
 * Composite primary key: siteId (PK) + url (SK)
 * Similar pattern to LatestAudit (siteId + auditType)
 */
export interface AuditUrl extends BaseModel {
  getAudits(): string[];
  getCreatedAt(): string;
  getCreatedBy(): string;
  getUpdatedAt(): string;
  getUpdatedBy(): string;
  getSite(): Promise<Site>;
  getSiteId(): string;
  getByCustomer(): boolean;
  getUrl(): string;
  setAudits(audits: string[]): AuditUrl;
  setSiteId(siteId: string): AuditUrl;
  setByCustomer(byCustomer: boolean): AuditUrl;
  setUrl(url: string): AuditUrl;
  setUpdatedBy(updatedBy: string): AuditUrl;
  isAuditEnabled(auditType: string): boolean;
  enableAudit(auditType: string): AuditUrl;
  disableAudit(auditType: string): AuditUrl;
  isCustomerUrl(): boolean;
}

export interface AuditUrlCollection extends BaseCollection<AuditUrl> {
  findById(siteId: string, url: string): Promise<AuditUrl | null>;
  findBySiteIdAndUrl(siteId: string, url: string): Promise<AuditUrl | null>;
  allBySiteId(siteId: string): Promise<AuditUrl[]>;
  allBySiteIdAndByCustomer(siteId: string, byCustomer: boolean): Promise<AuditUrl[]>;
  allBySiteIdAndUrl(siteId: string, url: string): Promise<AuditUrl[]>;
  allBySiteIdSorted(siteId: string, options?: { limit?: number; cursor?: string; sortBy?: string; sortOrder?: string }): Promise<{ data: AuditUrl[]; cursor: string | null }>;
  allBySiteIdByCustomerSorted(siteId: string, byCustomer: boolean, options?: { limit?: number; cursor?: string; sortBy?: string; sortOrder?: string }): Promise<{ data: AuditUrl[]; cursor: string | null }>;
  allBySiteIdAndAuditType(siteId: string, auditType: string, options?: { limit?: number; cursor?: string; sortBy?: string; sortOrder?: string }): Promise<{ data: AuditUrl[]; cursor: string | null }>;
  removeForSiteId(siteId: string): Promise<void>;
  removeForSiteIdByCustomer(siteId: string, byCustomer: boolean): Promise<void>;
}