@adobe/spacecat-shared-data-access 2.86.0 → 2.87.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-data-access-v2.87.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.87.0...@adobe/spacecat-shared-data-access-v2.87.1) (2025-11-21)
+
+
+### Bug Fixes
+
+* edge preview feature for Tokowaka ([#1124](https://github.com/adobe/spacecat-shared/issues/1124)) ([cd2a06f](https://github.com/adobe/spacecat-shared/commit/cd2a06f62e3ca9e8c2b87e1810d420a06a002526))
+
+# [@adobe/spacecat-shared-data-access-v2.87.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.86.0...@adobe/spacecat-shared-data-access-v2.87.0) (2025-11-19)
+
+
+### Features
+
+* add page citability ([#1140](https://github.com/adobe/spacecat-shared/issues/1140)) ([e4dfcdc](https://github.com/adobe/spacecat-shared/commit/e4dfcdccf44ad4a303c3b68b0655e00b25f3da3c))
+
 # [@adobe/spacecat-shared-data-access-v2.86.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.85.1...@adobe/spacecat-shared-data-access-v2.86.0) (2025-11-19)
 
 

package/package.json

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

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

@@ -40,6 +40,7 @@ import PageIntentCollection from '../page-intent/page-intent.collection.js';
 import ReportCollection from '../report/report.collection.js';
 import TrialUserCollection from '../trial-user/trial-user.collection.js';
 import TrialUserActivityCollection from '../trial-user-activity/trial-user-activity.collection.js';
+import PageCitabilityCollection from '../page-citability/page-citability.collection.js';
 
 import ApiKeySchema from '../api-key/api-key.schema.js';
 import AsyncJobSchema from '../async-job/async-job.schema.js';
@@ -68,6 +69,7 @@ import PageIntentSchema from '../page-intent/page-intent.schema.js';
 import ReportSchema from '../report/report.schema.js';
 import TrialUserSchema from '../trial-user/trial-user.schema.js';
 import TrialUserActivitySchema from '../trial-user-activity/trial-user-activity.schema.js';
+import PageCitabilitySchema from '../page-citability/page-citability.schema.js';
 
 /**
  * EntityRegistry - A registry class responsible for managing entities, their schema and collection.
@@ -165,5 +167,6 @@ EntityRegistry.registerEntity(PageIntentSchema, PageIntentCollection);
 EntityRegistry.registerEntity(ReportSchema, ReportCollection);
 EntityRegistry.registerEntity(TrialUserSchema, TrialUserCollection);
 EntityRegistry.registerEntity(TrialUserActivitySchema, TrialUserActivityCollection);
+EntityRegistry.registerEntity(PageCitabilitySchema, PageCitabilityCollection);
 
 export default EntityRegistry;

package/src/models/index.js

@@ -38,3 +38,4 @@ export * from './page-intent/index.js';
 export * from './report/index.js';
 export * from './trial-user/index.js';
 export * from './trial-user-activity/index.js';
+export * from './page-citability/index.js';

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

@@ -0,0 +1,39 @@
+/*
+ * 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 { BaseCollection, BaseModel, Site } from '../index.js';
+
+export interface PageCitability extends BaseModel {
+    getSiteId(): string;
+    getSite(): Promise<Site>;
+    getUrl(): string;
+    getCitabilityScore(): number | undefined;
+    getContentRatio(): number | undefined;
+    getWordDifference(): number | undefined;
+    getBotWords(): number | undefined;
+    getNormalWords(): number | undefined;
+
+    setSiteId(siteId: string): PageCitability;
+    setUrl(url: string): PageCitability;
+    setCitabilityScore(citabilityScore?: number): PageCitability;
+    setContentRatio(contentRatio?: number): PageCitability;
+    setWordDifference(wordDifference?: number): PageCitability;
+    setBotWords(botWords?: number): PageCitability;
+    setNormalWords(normalWords?: number): PageCitability;
+}
+
+export interface PageCitabilityCollection extends BaseCollection<PageCitability> {
+    allBySiteId(siteId: string): Promise<PageCitability[]>;
+    findBySiteId(siteId: string): Promise<PageCitability | null>;
+    allByUrl(url: string): Promise<PageCitability[]>;
+    findByUrl(url: string): Promise<PageCitability | null>;
+}

package/src/models/page-citability/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 PageCitability from './page-citability.model.js';
+import PageCitabilityCollection from './page-citability.collection.js';
+
+export {
+  PageCitability,
+  PageCitabilityCollection,
+};

package/src/models/page-citability/page-citability.collection.js

@@ -0,0 +1,25 @@
+/*
+ * 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';
+
+/**
+ * PageCitabilityCollection - Manages PageCitability entities.
+ *
+ * @class PageCitabilityCollection
+ * @extends BaseCollection
+ */
+class PageCitabilityCollection extends BaseCollection {
+  // add custom collection-level methods here, if needed
+}
+
+export default PageCitabilityCollection;

package/src/models/page-citability/page-citability.model.js

@@ -0,0 +1,27 @@
+/*
+ * 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';
+
+/**
+ * PageCitability - Represents a page's citability metrics within a site.
+ *
+ * @class PageCitability
+ * @extends BaseModel
+ */
+class PageCitability extends BaseModel {
+  static DEFAULT_UPDATED_BY = 'spacecat';
+
+  // add any custom methods or overrides here
+}
+
+export default PageCitability;

package/src/models/page-citability/page-citability.schema.js

@@ -0,0 +1,83 @@
+/*
+ * 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 { isValidUrl } from '@adobe/spacecat-shared-utils';
+
+import SchemaBuilder from '../base/schema.builder.js';
+import PageCitability from './page-citability.model.js';
+import PageCitabilityCollection from './page-citability.collection.js';
+
+/*
+  Schema: https://electrodb.dev/en/modeling/schema/
+  Attributes: https://electrodb.dev/en/modeling/attributes/
+  Indexes: https://electrodb.dev/en/modeling/indexes/
+*/
+
+const schema = new SchemaBuilder(PageCitability, PageCitabilityCollection)
+  // link back to Site entity
+  .addReference('belongs_to', 'Site')
+
+  // page's full URL (must be unique)
+  .addAttribute('url', {
+    type: 'string',
+    required: true,
+    validate: (value) => isValidUrl(value),
+  })
+
+  // citation readability score
+  .addAttribute('citabilityScore', {
+    type: 'number',
+    required: false,
+    validate: (value) => !value || (typeof value === 'number' && !Number.isNaN(value)),
+  })
+
+  // content increase ratio
+  .addAttribute('contentRatio', {
+    type: 'number',
+    required: false,
+    validate: (value) => !value || (typeof value === 'number' && !Number.isNaN(value)),
+  })
+
+  // word difference between before and after
+  .addAttribute('wordDifference', {
+    type: 'number',
+    required: false,
+    validate: (value) => !value || (typeof value === 'number' && !Number.isNaN(value)),
+  })
+
+  // word count before processing (bot words)
+  .addAttribute('botWords', {
+    type: 'number',
+    required: false,
+    validate: (value) => !value || (typeof value === 'number' && !Number.isNaN(value)),
+  })
+
+  // word count after processing (normal words)
+  .addAttribute('normalWords', {
+    type: 'number',
+    required: false,
+    validate: (value) => !value || (typeof value === 'number' && !Number.isNaN(value)),
+  })
+
+  // optionally track who last updated
+  .addAttribute('updatedBy', {
+    type: 'string',
+    default: PageCitability.DEFAULT_UPDATED_BY,
+  })
+
+  // allow fetching the single record by its URL
+  .addIndex(
+    { composite: ['url'] },
+    { composite: ['updatedAt'] },
+  );
+
+export default schema.build();

package/src/models/site/config.js

@@ -339,6 +339,7 @@ export const configSchema = Joi.object({
   }).optional(),
   tokowakaConfig: Joi.object({
     apiKey: Joi.string().required(),
+    forwardedHost: Joi.string().optional(),
   }).optional(),
   contentAiConfig: Joi.object({
     index: Joi.string().optional(),

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

@@ -47,6 +47,7 @@ const schema = new SchemaBuilder(Site, SiteCollection)
   .addReference('has_many', 'SiteTopPages')
   .addReference('has_many', 'TrialUserActivities')
   .addReference('has_many', 'PageIntents')
+  .addReference('has_many', 'PageCitabilities')
   .addAttribute('baseURL', {
     type: 'string',
     required: true,