@adobe/spacecat-shared-data-access 2.8.4 → 2.9.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-data-access-v2.9.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.9.0...@adobe/spacecat-shared-data-access-v2.9.1) (2025-02-26)
+
+
+### Bug Fixes
+
+* import-schema backwards compatibility ([#630](https://github.com/adobe/spacecat-shared/issues/630)) ([9ef74bf](https://github.com/adobe/spacecat-shared/commit/9ef74bfc89b0ccb9d27d34e5a10eef182b9ee527)), closes [#626](https://github.com/adobe/spacecat-shared/issues/626)
+
+# [@adobe/spacecat-shared-data-access-v2.9.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.8.4...@adobe/spacecat-shared-data-access-v2.9.0) (2025-02-25)
+
+
+### Features
+
+* import config schema ([#626](https://github.com/adobe/spacecat-shared/issues/626)) ([df147d8](https://github.com/adobe/spacecat-shared/commit/df147d8c8f83cc45f373b1d89823229afe035129))
+
 # [@adobe/spacecat-shared-data-access-v2.8.4](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.8.3...@adobe/spacecat-shared-data-access-v2.8.4) (2025-02-25)
 
 

package/package.json

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

package/src/models/site/config.js

@@ -12,13 +12,76 @@
 
 import Joi from 'joi';
 
+export const IMPORT_TYPES = {
+  ORGANIC_KEYWORDS: 'organic-keywords',
+  ORGANIC_TRAFFIC: 'organic-traffic',
+  TOP_PAGES: 'top-pages',
+};
+
+export const IMPORT_DESTINATIONS = {
+  DEFAULT: 'default',
+};
+
+export const IMPORT_SOURCES = {
+  AHREFS: 'ahrefs',
+  GSC: 'google',
+};
+
+const IMPORT_BASE_KEYS = {
+  destinations: Joi.array().items(Joi.string().valid(IMPORT_DESTINATIONS.DEFAULT)).required(),
+  sources: Joi.array().items(Joi.string().valid(...Object.values(IMPORT_SOURCES))).required(),
+  // not required for now due backward compatibility
+  enabled: Joi.boolean().default(true),
+};
+
+export const IMPORT_TYPE_SCHEMAS = {
+  [IMPORT_TYPES.ORGANIC_KEYWORDS]: Joi.object({
+    type: Joi.string().valid(IMPORT_TYPES.ORGANIC_KEYWORDS).required(),
+    ...IMPORT_BASE_KEYS,
+    pageUrl: Joi.string().uri(),
+  }),
+  [IMPORT_TYPES.ORGANIC_TRAFFIC]: Joi.object({
+    type: Joi.string().valid(IMPORT_TYPES.ORGANIC_TRAFFIC).required(),
+    ...IMPORT_BASE_KEYS,
+  }),
+  [IMPORT_TYPES.TOP_PAGES]: Joi.object({
+    type: Joi.string().valid(IMPORT_TYPES.TOP_PAGES).required(),
+    ...IMPORT_BASE_KEYS,
+    geo: Joi.string(),
+  }),
+};
+
+export const DEFAULT_IMPORT_CONFIGS = {
+  'organic-keywords': {
+    type: 'organic-keywords',
+    destinations: ['default'],
+    sources: ['ahrefs'],
+    enabled: true,
+  },
+  'organic-traffic': {
+    type: 'organic-traffic',
+    destinations: ['default'],
+    sources: ['ahrefs'],
+    enabled: true,
+  },
+  'top-pages': {
+    type: 'top-pages',
+    destinations: ['default'],
+    sources: ['ahrefs'],
+    enabled: true,
+    geo: 'global',
+  },
+};
+
 export const configSchema = Joi.object({
   slack: Joi.object({
     workspace: Joi.string(),
     channel: Joi.string(),
     invitedUserCount: Joi.number().integer().min(0),
   }),
-  imports: Joi.array().items(Joi.object({ type: Joi.string() }).unknown(true)),
+  imports: Joi.array().items(
+    Joi.alternatives().try(...Object.values(IMPORT_TYPE_SCHEMAS)),
+  ),
   fetchConfig: Joi.object({
     headers: Joi.object().pattern(Joi.string(), Joi.string()),
   }).optional(),
@@ -56,7 +119,7 @@ export function validateConfiguration(config) {
   const { error, value } = configSchema.validate(config);
 
   if (error) {
-    throw new Error(`Configuration validation error: ${error.message}`);
+    throw new Error(`Configuration validation error: ${error.message}`, { cause: error });
   }
 
   return value; // Validated and sanitized configuration
@@ -136,6 +199,47 @@ export const Config = (data = {}) => {
     state.fetchConfig = fetchConfig;
   };
 
+  self.enableImport = (type, config = {}) => {
+    if (!IMPORT_TYPE_SCHEMAS[type]) {
+      throw new Error(`Unknown import type: ${type}`);
+    }
+
+    const defaultConfig = DEFAULT_IMPORT_CONFIGS[type];
+    const newConfig = {
+      ...defaultConfig, ...config, type, enabled: true,
+    };
+
+    // Validate the new config against its schema
+    const { error } = IMPORT_TYPE_SCHEMAS[type].validate(newConfig);
+    if (error) {
+      throw new Error(`Invalid import config: ${error.message}`);
+    }
+
+    state.imports = state.imports || [];
+    // Remove existing import of same type if present
+    state.imports = state.imports.filter((imp) => imp.type !== type);
+    state.imports.push(newConfig);
+
+    validateConfiguration(state);
+  };
+
+  self.disableImport = (type) => {
+    if (!state.imports) return;
+
+    state.imports = state.imports.map(
+      (imp) => (imp.type === type ? { ...imp, enabled: false } : imp),
+    );
+
+    validateConfiguration(state);
+  };
+
+  self.getImportConfig = (type) => state.imports?.find((imp) => imp.type === type);
+
+  self.isImportEnabled = (type) => {
+    const config = self.getImportConfig(type);
+    return config?.enabled ?? false;
+  };
+
   return Object.freeze(self);
 };
 

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

@@ -23,13 +23,95 @@ import type {
   SiteTopPage,
 } from '../index';
 
+export type IMPORT_TYPES = {
+  readonly ORGANIC_KEYWORDS: 'organic-keywords';
+  readonly ORGANIC_TRAFFIC: 'organic-traffic';
+  readonly TOP_PAGES: 'top-pages';
+};
+
+export type IMPORT_DESTINATIONS = {
+  readonly DEFAULT: 'default';
+};
+
+export type IMPORT_SOURCES = {
+  readonly AHREFS: 'ahrefs';
+  readonly GSC: 'google';
+};
+
+export type ImportType = 'organic-keywords' | 'organic-traffic' | 'top-pages';
+export type ImportDestination = 'default';
+export type ImportSource = 'ahrefs' | 'google';
+
+export interface ImportConfig {
+  type: ImportType;
+  destinations: ImportDestination[];
+  sources: ImportSource[];
+  enabled: boolean;
+  pageUrl?: string;
+  geo?: string;
+}
+
+export interface SiteConfig {
+  state: {
+    slack?: {
+      workspace?: string;
+      channel?: string;
+      invitedUserCount?: number;
+    };
+    imports?: ImportConfig[];
+    handlers?: Record<string, {
+      mentions?: Record<string, string[]>;
+      excludedURLs?: string[];
+      manualOverwrites?: Array<{
+        brokenTargetURL?: string;
+        targetURL?: string;
+      }>;
+      fixedURLs?: Array<{
+        brokenTargetURL?: string;
+        targetURL?: string;
+      }>;
+      includedURLs?: string[];
+      groupedURLs?: Array<{
+        name: string;
+        pattern: string;
+      }>;
+      latestMetrics?: {
+        pageViewsChange: number;
+        ctrChange: number;
+        projectedTrafficValue: number;
+      };
+    }>;
+    fetchConfig?: {
+      headers?: Record<string, string>;
+    };
+  };
+  getSlackConfig(): { workspace?: string; channel?: string; invitedUserCount?: number };
+  getImports(): ImportConfig[];
+  getImportConfig(type: ImportType): ImportConfig | undefined;
+  isImportEnabled(type: ImportType): boolean;
+  enableImport(type: ImportType, config?: Partial<ImportConfig>): void;
+  disableImport(type: ImportType): void;
+  getHandlers(): Record<string, object>;
+  getHandlerConfig(type: string): object;
+  getSlackMentions(type: string): string[] | undefined;
+  getExcludedURLs(type: string): string[] | undefined;
+  getManualOverwrites(type: string):
+    Array<{ brokenTargetURL?: string; targetURL?: string }> | undefined;
+  getFixedURLs(type: string): Array<{ brokenTargetURL?: string; targetURL?: string }> | undefined;
+  getIncludedURLs(type: string): string[] | undefined;
+  getGroupedURLs(type: string): Array<{ name: string; pattern: string }> | undefined;
+  getLatestMetrics(type: string):
+    { pageViewsChange: number; ctrChange: number; projectedTrafficValue: number } | undefined;
+  getFetchConfig(): { headers?: Record<string, string> } | undefined;
+}
+
 export interface Site extends BaseModel {
   getAudits(): Promise<Audit>;
   getAuditsByAuditType(auditType: string): Promise<Audit>;
   getAuditsByAuditTypeAndAuditedAt(auditType: string, auditedAt: string): Promise<Audit>;
   getBaseURL(): string;
   getName(): string;
-  getConfig(): object;
+  getConfig(): SiteConfig;
   getDeliveryType(): string;
   getExperiments(): Promise<Experiment[]>;
   getExperimentsByExpId(expId: string): Promise<Experiment[]>;