@adobe/spacecat-shared-data-access 2.36.1 → 2.38.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-data-access-v2.38.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.37.0...@adobe/spacecat-shared-data-access-v2.38.0) (2025-07-21)
+
+
+### Features
+
+* add pageTypes to store pattern matching for pageTypes ([#857](https://github.com/adobe/spacecat-shared/issues/857)) ([4081e8c](https://github.com/adobe/spacecat-shared/commit/4081e8cfd8571d43b9720c07caeb22ced77281d0))
+
+# [@adobe/spacecat-shared-data-access-v2.37.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.36.1...@adobe/spacecat-shared-data-access-v2.37.0) (2025-07-21)
+
+
+### Features
+
+* added `Report` model, schema and collection implementation ([#855](https://github.com/adobe/spacecat-shared/issues/855)) ([4100a0e](https://github.com/adobe/spacecat-shared/commit/4100a0e557709d29dd590ff87c987d70b005f734))
+
 # [@adobe/spacecat-shared-data-access-v2.36.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.36.0...@adobe/spacecat-shared-data-access-v2.36.1) (2025-07-19)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-data-access",
-  "version": "2.36.1",
+  "version": "2.38.0",
   "description": "Shared modules of the Spacecat Services - Data Access",
   "type": "module",
   "engines": {

package/src/models/base/entity.registry.js

@@ -32,6 +32,7 @@ import SiteCollection from '../site/site.collection.js';
 import SiteTopPageCollection from '../site-top-page/site-top-page.collection.js';
 import SuggestionCollection from '../suggestion/suggestion.collection.js';
 import PageIntentCollection from '../page-intent/page-intent.collection.js';
+import ReportCollection from '../report/report.collection.js';
 
 import ApiKeySchema from '../api-key/api-key.schema.js';
 import AsyncJobSchema from '../async-job/async-job.schema.js';
@@ -52,6 +53,7 @@ import SiteCandidateSchema from '../site-candidate/site-candidate.schema.js';
 import SiteTopPageSchema from '../site-top-page/site-top-page.schema.js';
 import SuggestionSchema from '../suggestion/suggestion.schema.js';
 import PageIntentSchema from '../page-intent/page-intent.schema.js';
+import ReportSchema from '../report/report.schema.js';
 
 /**
  * EntityRegistry - A registry class responsible for managing entities, their schema and collection.
@@ -153,5 +155,6 @@ EntityRegistry.registerEntity(SiteCandidateSchema, SiteCandidateCollection);
 EntityRegistry.registerEntity(SiteTopPageSchema, SiteTopPageCollection);
 EntityRegistry.registerEntity(SuggestionSchema, SuggestionCollection);
 EntityRegistry.registerEntity(PageIntentSchema, PageIntentCollection);
+EntityRegistry.registerEntity(ReportSchema, ReportCollection);
 
 export default EntityRegistry;

package/src/models/index.d.ts

@@ -28,3 +28,4 @@ export type * from './site';
 export type * from './site-candidate';
 export type * from './site-top-page';
 export type * from './suggestion';
+export type * from './report';

package/src/models/index.js

@@ -30,3 +30,4 @@ export * from './site-top-page/index.js';
 export * from './site/index.js';
 export * from './suggestion/index.js';
 export * from './page-intent/index.js';
+export * from './report/index.js';

package/src/models/page-intent/index.d.ts

@@ -28,7 +28,6 @@ export interface PageIntent extends BaseModel {
 export interface PageIntentCollection extends BaseCollection<PageIntent> {
     allBySiteId(siteId: string): Promise<PageIntent[]>;
     findBySiteId(siteId: string): Promise<PageIntent | null>;
-
     allByUrl(url: string): Promise<PageIntent[]>;
     findByUrl(url: string): Promise<PageIntent | null>;
 }

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

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2025 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 { BaseModel, BaseCollection, Site } from '../index';
+
+export interface Report extends BaseModel {
+  getReportType(): string;
+  getReportPeriod(): { startDate: string; endDate: string };
+  getComparisonPeriod(): { startDate: string; endDate: string };
+  getStoragePath(): string;
+  getSite(): Promise<Site>;
+  setReportType(reportType: string): Report;
+  setReportPeriod(period: { startDate: string; endDate: string }): Report;
+  setComparisonPeriod(period: { startDate: string; endDate: string }): Report;
+  setStoragePath(path: string): Report;
+}
+
+export interface ReportCollection extends BaseCollection<Report> {
+  // Add collection-specific methods here if needed
+  allBySiteId(siteId: string): Promise<Report[]>;
+  findBySiteId(siteId: string): Promise<Report | null>;
+  allByReportType(reportType: string): Promise<Report[]>;
+  findByReportType(reportType: string): Promise<Report | null>;
+}

package/src/models/report/index.js

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2025 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 Report from './report.model.js';
+import ReportCollection from './report.collection.js';
+
+export {
+  Report,
+  ReportCollection,
+};

package/src/models/report/report.collection.js

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2025 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';
+
+/**
+ * ReportCollection — A collection class responsible for managing Report entities.
+ * Extends the ReportCollection to provide specific methods for interacting with Report records.
+ *
+ * @class ReportCollection
+ * @extends BaseCollection
+ */
+class ReportCollection extends BaseCollection {
+  async create(item) {
+    const report = await super.create(item, { upsert: true });
+
+    // If storagePath is empty string (default value), compute it automatically
+    if (report.getStoragePath() === '') {
+      const storagePath = `/reports/${item.siteId}/${item.reportType}/${report.getId()}/`;
+      report.setStoragePath(storagePath);
+      await report.save();
+    }
+
+    return report;
+  }
+}
+
+export default ReportCollection;

package/src/models/report/report.model.js

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2025 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';
+
+class Report extends BaseModel {
+
+}
+
+export default Report;

package/src/models/report/report.schema.js

@@ -0,0 +1,53 @@
+/*
+ * Copyright 2025 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, isString } from '@adobe/spacecat-shared-utils';
+import SchemaBuilder from '../base/schema.builder.js';
+import Report from './report.model.js';
+import ReportCollection from './report.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(Report, ReportCollection)
+  .addReference('belongs_to', 'Site')
+  .addAllIndex(['reportType'])
+  .addAttribute('reportType', {
+    type: 'string',
+    required: true,
+    validate: (value) => isString(value) && value.length > 0,
+  })
+  .addAttribute('reportPeriod', {
+    type: 'any',
+    required: true,
+    validate: (value) => isNonEmptyObject(value)
+    && isString(value.startDate) && isString(value.endDate),
+  })
+  .addAttribute('comparisonPeriod', {
+    type: 'any',
+    required: true,
+    validate: (value) => isNonEmptyObject(value)
+    && isString(value.startDate) && isString(value.endDate),
+  })
+  .addAttribute('storagePath', {
+    type: 'string',
+    required: false,
+    default: () => '',
+    validate: (value) => !value || (isString(value) && value.length >= 0),
+  });
+
+export default schema.build();

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

@@ -117,6 +117,21 @@ const schema = new SchemaBuilder(Site, SiteCollection)
     watch: ['authoringType', 'hlxConfig', 'deliveryConfig'],
     set: (_, attrs) => computeExternalIds(attrs, Site.AUTHORING_TYPES).externalSiteId,
   })
+  .addAttribute('pageTypes', {
+    type: 'list',
+    required: false,
+    items: {
+      type: 'map',
+      required: true,
+      properties: {
+        name: { type: 'string', required: true },
+        pattern: {
+          type: 'string',
+          required: true,
+        },
+      },
+    },
+  })
   .addAllIndex(['baseURL'])
   .addIndex(
     { composite: ['deliveryType'] },