@adobe/spacecat-shared-data-access 1.59.2 → 1.60.0

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

@@ -0,0 +1,51 @@
+/*
+ * 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 { isNonEmptyObject } from '@adobe/spacecat-shared-utils';
+
+import { DEFAULT_CONFIG, validateConfiguration } from '../../../models/site/config.js';
+import SchemaBuilder from '../base/schema.builder.js';
+import Organization from './organization.model.js';
+import OrganizationCollection from './organization.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(Organization, OrganizationCollection)
+  // this will add an attribute 'organizationId' as well as an index 'byOrganizationId'
+  .addReference('has_many', 'Sites')
+  .addAttribute('config', {
+    type: 'any',
+    required: true,
+    default: DEFAULT_CONFIG,
+    validate: (value) => isNonEmptyObject(validateConfiguration(value)),
+  })
+  .addAttribute('name', {
+    type: 'string',
+    required: true,
+  })
+  .addAttribute('imsOrgId', {
+    type: 'string',
+    default: 'default',
+  })
+  .addAttribute('fulfillableItems', {
+    type: 'any',
+    validate: (value) => !value || isNonEmptyObject(value),
+  })
+  .addAllIndexWithComposite('imsOrgId');
+
+export default schema.build();

package/src/v2/models/site/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, Organization,
+} from '../index';
+
+export interface Site extends BaseModel {
+  getAudits(): Promise<Audit>;
+  getBaseURL(): string;
+  getConfig(): object;
+  getDeliveryType(): string;
+  getFulfillableItems(): object;
+  getGitHubURL(): string;
+  getHlxConfig(): object;
+  getIsLive(): boolean;
+  getIsLiveToggledAt(): string;
+  getOrganization(): Promise<Organization>;
+  getOrganizationId(): string;
+  setConfig(config: object): Site;
+  setDeliveryType(deliveryType: string): Site;
+  setFulfillableItems(fulfillableItems: object): Site;
+  setGitHubURL(gitHubURL: string): Site;
+  setHlxConfig(hlxConfig: object): Site;
+  setIsLive(isLive: boolean): 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[]>;
+}

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

@@ -0,0 +1,20 @@
+/*
+ * 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.
+ */
+
+// eslint-disable-next-line import/no-cycle
+import Site from './site.model.js';
+import SiteCollection from './site.collection.js';
+
+export {
+  Site,
+  SiteCollection,
+};

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

@@ -0,0 +1,28 @@
+/*
+ * 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';
+
+/**
+ * SiteCollection - A collection class responsible for managing Site entities.
+ * Extends the BaseCollection to provide specific methods for interacting with Site records.
+ *
+ * @class SiteCollection
+ * @extends BaseCollection
+ */
+class SiteCollection extends BaseCollection {
+  async allSitesToAudit() {
+    return (await this.all({ attributes: ['siteId'] })).map((site) => site.getId());
+  }
+}
+
+export default SiteCollection;

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

@@ -0,0 +1,47 @@
+/*
+ * 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 { Config } from '../../../models/site/config.js';
+import BaseModel from '../base/base.model.js';
+
+export const DELIVERY_TYPES = {
+  AEM_CS: 'aem_cs',
+  AEM_EDGE: 'aem_edge',
+  OTHER: 'other',
+};
+
+export const DEFAULT_DELIVERY_TYPE = DELIVERY_TYPES.AEM_EDGE;
+
+/**
+ * A class representing a Site entity. Provides methods to access and manipulate Site-specific data.
+ * @class Site
+ * @extends BaseModel
+ */
+class Site extends BaseModel {
+  getConfig() {
+    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);
+    return this;
+  }
+}
+
+export default Site;

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

@@ -0,0 +1,91 @@
+/*
+ * 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,
+  isObject,
+  isValidUrl,
+} from '@adobe/spacecat-shared-utils';
+
+import { Config, DEFAULT_CONFIG, validateConfiguration } from '../../../models/site/config.js';
+import SchemaBuilder from '../base/schema.builder.js';
+
+import Site, {
+  DEFAULT_DELIVERY_TYPE,
+  DELIVERY_TYPES,
+} from './site.model.js';
+import SiteCollection from './site.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(Site, SiteCollection)
+  // this will add an attribute 'organizationId' as well as an index 'byOrganizationId'
+  .addReference('belongs_to', 'Organization')
+  // has_many references do not add attributes or indexes
+  .addReference('has_many', 'Audits')
+  .addReference('has_many', 'Experiments')
+  .addReference('has_many', 'KeyEvents')
+  .addReference('has_many', 'Opportunities')
+  .addReference('has_many', 'SiteCandidates')
+  .addReference('has_many', 'SiteTopPages')
+  .addAttribute('baseURL', {
+    type: 'string',
+    required: true,
+    validate: (value) => isValidUrl(value),
+  })
+  .addAttribute('config', {
+    type: 'any',
+    required: true,
+    default: DEFAULT_CONFIG,
+    validate: (value) => isNonEmptyObject(validateConfiguration(value)),
+    get: (value) => Config(value),
+  })
+  .addAttribute('deliveryType', {
+    type: Object.values(DELIVERY_TYPES),
+    default: DEFAULT_DELIVERY_TYPE,
+    required: true,
+  })
+  .addAttribute('gitHubURL', {
+    type: 'string',
+    validate: (value) => !value || isValidUrl(value),
+  })
+  .addAttribute('hlxConfig', {
+    type: 'any',
+    default: {},
+    validate: (value) => isObject(value),
+  })
+  .addAttribute('isLive', {
+    type: 'boolean',
+    required: true,
+    default: false,
+  })
+  .addAttribute('isLiveToggledAt', {
+    type: 'string',
+    watch: ['isLive'],
+    set: () => new Date().toISOString(),
+    validate: (value) => !value || isIsoDate(value),
+  })
+  .addAllIndexWithComposite('baseURL')
+  .addIndex(
+    'byDeliveryType',
+    { composite: ['deliveryType'] },
+    { composite: ['updatedAt'] },
+  );
+
+export default schema.build();

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

@@ -0,0 +1,38 @@
+/*
+ * 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 } from '../index';
+
+export interface SiteCandidate extends BaseModel {
+  getBaseURL(): string;
+  getHlxConfig(): object;
+  getSite(): object;
+  getSiteId(): string;
+  getSource(): string;
+  getStatus(): string;
+  getUpdatedBy(): string;
+  setBaseURL(baseURL: string): SiteCandidate;
+  setHlxConfig(hlxConfig: object): SiteCandidate;
+  setSiteId(siteId: string): SiteCandidate;
+  setSource(source: string): SiteCandidate;
+  setStatus(status: string): SiteCandidate;
+  setUpdatedBy(updatedBy: string): SiteCandidate;
+}
+
+export interface SiteCandidateCollection extends BaseCollection<SiteCandidate> {
+  allBySiteId(siteId: string): Promise<SiteCandidate[]>;
+  allBySiteIdAndSiteCandidateIdAndUrl(
+    siteId: string,
+    siteCandidateId: string,
+    url: string,
+  ): Promise<SiteCandidate[]>;
+}

package/src/v2/models/site-candidate/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 SiteCandidate from './site-candidate.model.js';
+import SiteCandidateCollection from './site-candidate.collection.js';
+
+export {
+  SiteCandidate,
+  SiteCandidateCollection,
+};

package/src/v2/models/site-candidate/site-candidate.collection.js

@@ -0,0 +1,27 @@
+/*
+ * 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';
+
+/**
+ * SiteCandidateCollection - A collection class responsible for managing SiteCandidate entities.
+ * Extends the BaseCollection to provide specific methods for interacting with
+ * SiteCandidate records.
+ *
+ * @class SiteCandidateCollection
+ * @extends BaseCollection
+ */
+class SiteCandidateCollection extends BaseCollection {
+  // add custom methods here
+}
+
+export default SiteCandidateCollection;

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

@@ -0,0 +1,41 @@
+/*
+ * 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 BaseModel from '../base/base.model.js';
+
+export const DEFAULT_UPDATED_BY = 'spacecat';
+
+export const SITE_CANDIDATE_SOURCES = {
+  SPACECAT_SLACK_BOT: 'SPACECAT_SLACK_BOT',
+  RUM: 'RUM',
+  CDN: 'CDN',
+};
+
+export const SITE_CANDIDATE_STATUS = {
+  PENDING: 'PENDING', // site candidate notification sent and waiting for human input
+  IGNORED: 'IGNORED', // site candidate discarded: not to be added to star catalogue
+  APPROVED: 'APPROVED', // site candidate is added to star catalogue
+  ERROR: 'ERROR', // site candidate is discovered
+};
+
+/**
+ * SiteCandidate - A class representing an SiteCandidate entity.
+ * Provides methods to access and manipulate SiteCandidate-specific data.
+ *
+ * @class SiteCandidate
+ * @extends BaseModel
+ */
+class SiteCandidate extends BaseModel {
+  // add your custom methods or overrides here
+}
+
+export default SiteCandidate;

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

@@ -0,0 +1,59 @@
+/*
+ * 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 { isObject, isValidUrl } from '@adobe/spacecat-shared-utils';
+
+import { validate as uuidValidate } from 'uuid';
+
+import SchemaBuilder from '../base/schema.builder.js';
+import SiteCandidate, { SITE_CANDIDATE_SOURCES, SITE_CANDIDATE_STATUS } from './site-candidate.model.js';
+import SiteCandidateCollection from './site-candidate.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(SiteCandidate, SiteCandidateCollection)
+  .addReference('belongs_to', 'Site')
+  .addAttribute('siteId', {
+    type: 'string',
+    validate: (value) => !value || uuidValidate(value),
+  })
+  .addAttribute('baseURL', {
+    type: 'string',
+    required: true,
+    validate: (value) => isValidUrl(value),
+  })
+  .addAttribute('hlxConfig', {
+    type: 'any',
+    required: true,
+    default: {},
+    validate: (value) => isObject(value),
+  })
+  .addAttribute('source', {
+    type: Object.values(SITE_CANDIDATE_SOURCES),
+    required: true,
+  })
+  .addAttribute('status', {
+    type: Object.values(SITE_CANDIDATE_STATUS),
+    required: true,
+  })
+  .addAttribute('updatedBy', {
+    type: 'string',
+  })
+  .addAllIndexWithComposite('baseURL');
+
+export default schema.build();

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

@@ -0,0 +1,35 @@
+/*
+ * 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 } from '../index';
+
+export interface SiteTopPage extends BaseModel {
+  getGeo(): string;
+  getImportedAt(): number;
+  getSiteId(): string;
+  getSource(): string;
+  getTopKeyword(): string;
+  getTraffic(): number;
+  getUrl(): string;
+  setGeo(geo: string): SiteTopPage;
+  setImportedAt(importedAt: number): SiteTopPage;
+  setSiteId(siteId: string): SiteTopPage;
+  setSource(source: string): SiteTopPage;
+  setTopKeyword(topKeyword: string): SiteTopPage;
+  setTraffic(traffic: number): SiteTopPage;
+  setUrl(url: string): SiteTopPage;
+}
+
+export interface SiteTopPageCollection extends BaseCollection<SiteTopPage> {
+  allBySiteId(siteId: string): Promise<SiteTopPage[]>;
+  allBySiteIdAndSourceAndGeo(siteId: string, source: string, geo: string): Promise<SiteTopPage[]>;
+}

package/src/v2/models/site-top-page/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 SiteTopPage from './site-top-page.model.js';
+import SiteTopPageCollection from './site-top-page.collection.js';
+
+export {
+  SiteTopPage,
+  SiteTopPageCollection,
+};

package/src/v2/models/site-top-page/site-top-page.collection.js

@@ -0,0 +1,44 @@
+/*
+ * 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 { hasText } from '@adobe/spacecat-shared-utils';
+
+import BaseCollection from '../base/base.collection.js';
+
+/**
+ * SiteTopPageCollection - A collection class responsible for managing SiteTopPage entities.
+ * Extends the BaseCollection to provide specific methods for interacting with SiteTopPage records.
+ *
+ * @class SiteTopPageCollection
+ * @extends BaseCollection
+ */
+class SiteTopPageCollection extends BaseCollection {
+  async removeForSiteId(siteId, source, geo) {
+    if (!hasText(siteId)) {
+      throw new Error('SiteId is required');
+    }
+
+    let topPagesToRemove;
+
+    if (hasText(source) && hasText(geo)) {
+      topPagesToRemove = await this.allBySiteIdAndSourceAndGeo(siteId, source, geo);
+    } else {
+      topPagesToRemove = await this.allBySiteId(siteId);
+    }
+
+    const topPageIdsToRemove = topPagesToRemove.map((topPage) => topPage.getId());
+
+    await this.removeByIds(topPageIdsToRemove);
+  }
+}
+
+export default SiteTopPageCollection;

package/src/v2/models/site-top-page/site-top-page.model.js

@@ -0,0 +1,28 @@
+/*
+ * 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 BaseModel from '../base/base.model.js';
+
+export const DEFAULT_GEO = 'global';
+
+/**
+ * SiteTopPage - A class representing an SiteTopPage entity.
+ * Provides methods to access and manipulate SiteTopPage-specific data.
+ *
+ * @class SiteTopPage
+ * @extends BaseModel
+ */
+class SiteTopPage extends BaseModel {
+  // add your custom methods or overrides here
+}
+
+export default SiteTopPage;

package/src/v2/models/site-top-page/site-top-page.schema.js

@@ -0,0 +1,65 @@
+/*
+ * 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 { isInteger, isIsoDate, isValidUrl } from '@adobe/spacecat-shared-utils';
+
+import { validate as uuidValidate } from 'uuid';
+
+import SchemaBuilder from '../base/schema.builder.js';
+import SiteTopPage, { DEFAULT_GEO } from './site-top-page.model.js';
+import SiteTopPageCollection from './site-top-page.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(SiteTopPage, SiteTopPageCollection)
+  .addReference('belongs_to', 'Site', ['source', 'geo', 'traffic'])
+  .addAttribute('siteId', {
+    type: 'string',
+    required: true,
+    validate: (value) => uuidValidate(value),
+  })
+  .addAttribute('url', {
+    type: 'string',
+    required: true,
+    validate: (value) => isValidUrl(value),
+  })
+  .addAttribute('traffic', {
+    type: 'number',
+    required: true,
+    validate: (value) => isInteger(value),
+  })
+  .addAttribute('source', {
+    type: 'string',
+    required: true,
+  })
+  .addAttribute('topKeyword', {
+    type: 'string',
+  })
+  .addAttribute('geo', {
+    type: 'string',
+    required: false,
+    default: DEFAULT_GEO,
+  })
+  .addAttribute('importedAt', {
+    type: 'string',
+    required: true,
+    default: () => new Date().toISOString(),
+    validate: (value) => isIsoDate(value),
+  });
+
+export default schema.build();