Skip to content

feat(audit-url): add moneyPages source to auditTargetURLs config #1496

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nitinja wants to merge 6 commits into
base: main
Choose a base branch
from
Open

feat(audit-url): add moneyPages source to auditTargetURLs config #1496

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
22893d3
Manage a custom list of audit target URLs
slitviachenko Mar 31, 2026
49be2f9
Delete 'money-pages'
slitviachenko Mar 31, 2026
9e60ebe
Merge remote-tracking branch 'origin/main' into SITES-42547-Manage-a-…
slitviachenko Mar 31, 2026
82e91cd
Some improvements
slitviachenko Mar 31, 2026
e11a14d
Merge remote-tracking branch 'origin/main' into SITES-42547-Manage-a-…
slitviachenko Apr 1, 2026
ec5cf7c
feat(audit-url): add moneyPages source to auditTargetURLs config
nitinja Apr 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions packages/spacecat-shared-data-access/src/models/site/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,6 +407,14 @@ export const configSchema = Joi.object({
contentAiConfig: Joi.object({
index: Joi.string().optional(),
}).optional(),
auditTargetURLs: Joi.object({
manual: Joi.array().items(Joi.object({
url: Joi.string().uri().required(),
})).optional().default([]),
moneyPages: Joi.array().items(Joi.object({
Copy link
Copy Markdown
Contributor

@slitviachenko slitviachenko Apr 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nitinja , Let's make sure we can update individual auditTargetURLs keys separately without affecting each other, for example:

% curl -X PATCH \
-d '{
  "config": {
    "auditTargetURLs": {
      "manual": [
        {
          "url": "https://example.com/path1"
        },
        {
          "url": "https://example.com/path2"
        }
      ]
    }
  }
}' \
"https://SPACECAT_API/sites/SITE_ID"

% curl -X PATCH \
-d '{
  "config": {
    "auditTargetURLs": {
      "moneyPages": [
        {
          "url": "https://example.com/money-page1"
        },
        {
          "url": "https://example.com/money-page2"
        }
      ]
    }
  }
}' \
"https://SPACECAT_API/sites/SITE_ID"

In the database, we should have both manual and moneyPages.

Copy link
Copy Markdown
Contributor

@slitviachenko slitviachenko Apr 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^^^ That way, the API will be more resilient, and we will have less payload input data. Otherwise, to update any individual key, you would need to include all keys to preserve them.

url: Joi.string().uri().required(),
})).optional().default([]),
}).options({ stripUnknown: true }).optional(),
handlers: Joi.object().pattern(Joi.string(), Joi.object({
mentions: Joi.object().pattern(Joi.string(), Joi.array().items(Joi.string())),
excludedURLs: Joi.array().items(Joi.string()),
Expand Down Expand Up @@ -517,6 +525,60 @@ export const Config = (data = {}) => {
self.getEdgeOptimizeConfig = () => state?.edgeOptimizeConfig;
self.getOnboardConfig = () => state?.onboardConfig;
self.getCommerceLlmoConfig = () => state?.commerceLlmoConfig;
const AUDIT_TARGET_SOURCES = ['manual', 'moneyPages'];
const auditTargetEntrySchema = Joi.object({
url: Joi.string().uri().required(),
});

const validateAuditTargetSource = (source) => {
if (!AUDIT_TARGET_SOURCES.includes(source)) {
throw new Error(`Invalid audit target source: "${source}". Must be one of: ${AUDIT_TARGET_SOURCES.join(', ')}`);
}
};

self.getAuditTargetURLsConfig = () => state?.auditTargetURLs;

self.getAuditTargetURLs = () => {
const targets = state?.auditTargetURLs;
if (!targets) return [];
return AUDIT_TARGET_SOURCES.flatMap(
(source) => (targets[source] || []).map((entry) => ({ ...entry, source })),
);
};

self.getAuditTargetURLsBySource = (source) => {
validateAuditTargetSource(source);
return state?.auditTargetURLs?.[source] || [];
};

self.updateAuditTargetURLs = (source, urls) => {
validateAuditTargetSource(source);
Joi.assert(urls, Joi.array().items(auditTargetEntrySchema), 'Invalid audit target URLs');
state.auditTargetURLs = state.auditTargetURLs || {};
state.auditTargetURLs[source] = urls;
};

self.addAuditTargetURL = (source, urlObj) => {
validateAuditTargetSource(source);
Joi.assert(urlObj, auditTargetEntrySchema, 'Invalid audit target URL');

state.auditTargetURLs = state.auditTargetURLs || {};
state.auditTargetURLs[source] = state.auditTargetURLs[source] || [];
const allUrls = AUDIT_TARGET_SOURCES.flatMap(
(s) => (state.auditTargetURLs[s] || []).map((e) => e.url),
);
if (!allUrls.includes(urlObj.url)) {
state.auditTargetURLs[source].push(urlObj);
}
};

self.removeAuditTargetURL = (source, url) => {
validateAuditTargetSource(source);
if (!state.auditTargetURLs?.[source]) return;
state.auditTargetURLs[source] = state.auditTargetURLs[source]
.filter((t) => t.url !== url);
};

self.updateSlackConfig = (channel, workspace, invitedUserCount) => {
state.slack = {
channel,
Expand Down Expand Up @@ -871,4 +933,5 @@ Config.toDynamoItem = (config) => ({
edgeOptimizeConfig: config.getEdgeOptimizeConfig(),
onboardConfig: config.getOnboardConfig?.(),
commerceLlmoConfig: config.getCommerceLlmoConfig?.(),
auditTargetURLs: config.getAuditTargetURLsConfig?.(),
});
21 changes: 21 additions & 0 deletions packages/spacecat-shared-data-access/src/models/site/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,21 @@ export interface LlmoCustomerIntent {
value: string;
}

export type AuditTargetSource = 'manual' | 'moneyPages';

export interface AuditTargetEntry {
url: string;
}

export interface AuditTargetEntryWithSource extends AuditTargetEntry {
source: AuditTargetSource;
}

export interface AuditTargetURLs {
manual?: AuditTargetEntry[];
moneyPages?: AuditTargetEntry[];
}

export interface SiteConfig {
state: {
slack?: {
Expand All @@ -107,6 +122,7 @@ export interface SiteConfig {
invitedUserCount?: number;
};
imports?: ImportConfig[];
auditTargetURLs?: AuditTargetURLs;
handlers?: Record<string, {
mentions?: Record<string, string[]>;
excludedURLs?: string[];
Expand Down Expand Up @@ -205,6 +221,11 @@ export interface SiteConfig {
removeLlmoTag(tag: string): void;
getOnboardConfig(): { lastProfile?: string; lastStartTime?: number; forcedOverride?: boolean; history?: Array<{ profile?: string; startTime?: number }> } | undefined;
updateOnboardConfig(onboardConfig: { lastProfile?: string; lastStartTime?: number; forcedOverride?: boolean }, options?: { maxHistory?: number }): void;
getAuditTargetURLs(): AuditTargetEntryWithSource[];
getAuditTargetURLsBySource(source: AuditTargetSource): AuditTargetEntry[];
updateAuditTargetURLs(source: AuditTargetSource, urls: AuditTargetEntry[]): void;
addAuditTargetURL(source: AuditTargetSource, urlObj: AuditTargetEntry): void;
removeAuditTargetURL(source: AuditTargetSource, url: string): void;
}

export interface Site extends BaseModel {
Expand Down
Loading
Loading