@taurgis/bonsai 1.0.5 → 3.0.0

package/dist/sites/salesforce/coveo.d.ts

@@ -1,23 +0,0 @@
-import type { SiteSearchResult } from '../types.js';
-import { type TokenInfo } from './token.js';
-export declare const ALLOWED_DOC_HOSTS: Set<string>;
-export declare const SEARCH_PAGE_URL = "https://help.salesforce.com/s/search-result";
-export declare const COVEO_SEARCH_PATH = "/services/apexrest/coveo/analytics/rest/search/v2";
-export declare const DEFAULT_LANGUAGE = "en_US";
-export declare const AURA_PATH = "/s/sfsites/aura";
-export declare function isAllowedDocHost(hostname: string): boolean;
-/** The search page reads its query from the URL hash, so this URL is browser-only (never normalized). */
-export declare function buildSearchPageUrl(query: string, language?: string): string;
-/**
- * Coveo indexes Help articles under an internal `/help_doccontent` URL; rewrite it to the
- * canonical `/s/articleView` page a human (or our fetcher) can actually open.
- */
-export declare function normalizeHelpDocContentUrl(rawUrl: string): string;
-/** Maps a raw Coveo response into deduped, host-validated search results. */
-export declare function extractCoveoResults(data: unknown, limit: number): SiteSearchResult[];
-/**
- * Direct Coveo Search API call using a cached token — the no-browser fast path.
- * Tries a bearer header first, then falls back to a query-string token on auth rejection.
- * Returns the parsed response body (with a `results` array) or null on failure.
- */
-export declare function searchCoveoDirect(tokenInfo: TokenInfo, query: string, limit: number, language?: string, timeoutMs?: number): Promise<unknown | null>;

package/dist/sites/salesforce/coveo.js

@@ -1,161 +0,0 @@
-import { COVEO_DEFAULTS } from './token.js';
-export const ALLOWED_DOC_HOSTS = new Set(['help.salesforce.com', 'developer.salesforce.com']);
-export const SEARCH_PAGE_URL = 'https://help.salesforce.com/s/search-result';
-// Path of the XHR the search page fires; we intercept its response as a fallback.
-export const COVEO_SEARCH_PATH = '/services/apexrest/coveo/analytics/rest/search/v2';
-export const DEFAULT_LANGUAGE = 'en_US';
-// The page mints its Coveo token via an Aura action on this path; we intercept the response
-// (identified by whether its body parses to a token) to cache it for the no-browser fast path.
-export const AURA_PATH = '/s/sfsites/aura';
-export function isAllowedDocHost(hostname) {
-    return ALLOWED_DOC_HOSTS.has(hostname.toLowerCase());
-}
-/** The search page reads its query from the URL hash, so this URL is browser-only (never normalized). */
-export function buildSearchPageUrl(query, language = DEFAULT_LANGUAGE) {
-    const url = new URL(SEARCH_PAGE_URL);
-    if (language)
-        url.searchParams.set('language', language);
-    if (query) {
-        url.hash = new URLSearchParams({ q: query, t: 'allResultsTab', sort: 'relevancy' }).toString();
-    }
-    return url.toString();
-}
-/**
- * Coveo indexes Help articles under an internal `/help_doccontent` URL; rewrite it to the
- * canonical `/s/articleView` page a human (or our fetcher) can actually open.
- */
-export function normalizeHelpDocContentUrl(rawUrl) {
-    let url;
-    try {
-        url = new URL(rawUrl);
-    }
-    catch {
-        return rawUrl;
-    }
-    if (url.hostname.toLowerCase() !== 'help.salesforce.com')
-        return rawUrl;
-    if (!url.pathname.toLowerCase().startsWith('/help_doccontent'))
-        return rawUrl;
-    const id = url.searchParams.get('id');
-    if (!id)
-        return rawUrl;
-    const articleUrl = new URL('https://help.salesforce.com/s/articleView');
-    articleUrl.searchParams.set('id', id.endsWith('.htm') ? id : `${id}.htm`);
-    articleUrl.searchParams.set('type', '5');
-    for (const key of ['release', 'language']) {
-        const value = url.searchParams.get(key);
-        if (value)
-            articleUrl.searchParams.set(key, value);
-    }
-    return articleUrl.toString();
-}
-const SKIP_URLS = new Set([
-    'https://help.salesforce.com/',
-    'https://help.salesforce.com/s',
-    'https://help.salesforce.com/s/',
-    'https://help.salesforce.com/s/login',
-]);
-function resultUrl(result) {
-    const raw = result.raw || {};
-    return (result.clickUri ||
-        result.uri ||
-        raw.clickuri ||
-        raw.uri ||
-        raw.sourceurl ||
-        raw.document_uri ||
-        raw.sfurl ||
-        raw.sfdcurl ||
-        null);
-}
-/** Maps a raw Coveo response into deduped, host-validated search results. */
-export function extractCoveoResults(data, limit) {
-    const results = Array.isArray(data?.results)
-        ? data.results
-        : [];
-    const items = [];
-    const seen = new Set();
-    for (const result of results) {
-        const candidate = resultUrl(result);
-        if (!candidate)
-            continue;
-        const url = normalizeHelpDocContentUrl(candidate);
-        let hostname;
-        try {
-            hostname = new URL(url).hostname;
-        }
-        catch {
-            continue;
-        }
-        if (!isAllowedDocHost(hostname) || SKIP_URLS.has(url) || seen.has(url))
-            continue;
-        seen.add(url);
-        items.push({
-            url,
-            title: result.title || result.raw?.title || url,
-            ...(result.excerpt ? { snippet: result.excerpt } : {}),
-        });
-        if (items.length >= limit)
-            break;
-    }
-    return items;
-}
-function buildCoveoPayload(tokenInfo, query, language, limit) {
-    const payload = {
-        q: query,
-        numberOfResults: limit,
-        firstResult: 0,
-        searchHub: tokenInfo.searchHub,
-        locale: language,
-        tab: 'allResultsTab',
-        sortCriteria: 'relevancy',
-    };
-    if (tokenInfo.filterer)
-        payload.aq = tokenInfo.filterer;
-    return payload;
-}
-/**
- * Direct Coveo Search API call using a cached token — the no-browser fast path.
- * Tries a bearer header first, then falls back to a query-string token on auth rejection.
- * Returns the parsed response body (with a `results` array) or null on failure.
- */
-export async function searchCoveoDirect(tokenInfo, query, limit, language = DEFAULT_LANGUAGE, timeoutMs = 15_000) {
-    const clientBase = (tokenInfo.clientUri || COVEO_DEFAULTS.clientUri).replace(/\/$/, '');
-    const payload = JSON.stringify(buildCoveoPayload(tokenInfo, query, language, limit));
-    const attempt = async (mode) => {
-        const url = new URL(`${clientBase}/rest/search/v2`);
-        // ponytail: query-string token is a documented Coveo fallback for clients that strip the
-        // Authorization header. It can land in proxy logs, but this is an anonymous public search
-        // token (no user identity), so the exposure is acceptable; revisit if the token ever binds a user.
-        if (mode === 'query')
-            url.searchParams.set('access_token', tokenInfo.accessToken);
-        const headers = { 'content-type': 'application/json' };
-        if (mode === 'header')
-            headers.authorization = `Bearer ${tokenInfo.accessToken}`;
-        const controller = new AbortController();
-        const timer = setTimeout(() => controller.abort(), timeoutMs);
-        try {
-            const response = await fetch(url, {
-                method: 'POST',
-                headers,
-                body: payload,
-                signal: controller.signal,
-            });
-            const data = response.ok ? await response.json().catch(() => null) : null;
-            return { status: response.status, data };
-        }
-        finally {
-            clearTimeout(timer);
-        }
-    };
-    try {
-        const primary = await attempt('header');
-        if (primary.data)
-            return primary.data;
-        if (![400, 401, 403].includes(primary.status))
-            return null;
-        return (await attempt('query')).data;
-    }
-    catch {
-        return null;
-    }
-}

package/dist/sites/salesforce/token.d.ts

@@ -1,26 +0,0 @@
-export declare const COVEO_DEFAULTS: {
-    readonly organizationId: "org62salesforce";
-    readonly searchHub: "HTCommunity";
-    readonly endpointBase: "https://help.salesforce.com/services/apexrest/coveo";
-    readonly clientUri: "https://platform.cloud.coveo.com";
-};
-export interface TokenInfo {
-    accessToken: string;
-    organizationId: string;
-    searchHub: string;
-    endpointBase: string;
-    clientUri: string;
-    filterer: string | null;
-    expiresAtMs: number;
-}
-export declare function isTokenValid(expiresAtMs: number | null | undefined): boolean;
-export declare function decodeJwtPayload(token: string): Record<string, unknown> | null;
-export declare function getTokenExpiryMs(accessToken: string): number | null;
-export declare function applyTokenExpiry(tokenInfo: TokenInfo): TokenInfo;
-/**
- * Parses the access token out of a Salesforce Aura `getToken` response body.
- * Returns null when the payload is missing, errored, or lacks a token.
- */
-export declare function parseAuraToken(rawResponseBody: string): TokenInfo | null;
-export declare function loadToken(): TokenInfo | null;
-export declare function storeToken(tokenInfo: TokenInfo): void;

package/dist/sites/salesforce/token.js

@@ -1,154 +0,0 @@
-import { readFileSync, writeFileSync, mkdirSync } from 'node:fs';
-import { homedir } from 'node:os';
-import { dirname, join } from 'node:path';
-// Salesforce Help routes anonymous doc search through a public Coveo org. These are
-// the published defaults for that org; they are not user credentials.
-export const COVEO_DEFAULTS = {
-    organizationId: 'org62salesforce',
-    searchHub: 'HTCommunity',
-    endpointBase: 'https://help.salesforce.com/services/apexrest/coveo',
-    clientUri: 'https://platform.cloud.coveo.com',
-};
-const DEFAULT_TOKEN_TTL_MS = 24 * 60 * 60 * 1000;
-const TOKEN_EXPIRY_SKEW_MS = 2 * 60 * 1000;
-export function isTokenValid(expiresAtMs) {
-    if (!Number.isFinite(expiresAtMs))
-        return false;
-    return Date.now() + TOKEN_EXPIRY_SKEW_MS < expiresAtMs;
-}
-export function decodeJwtPayload(token) {
-    const parts = token.split('.');
-    if (parts.length < 2 || !parts[1])
-        return null;
-    try {
-        return JSON.parse(Buffer.from(parts[1], 'base64url').toString('utf8'));
-    }
-    catch {
-        return null;
-    }
-}
-export function getTokenExpiryMs(accessToken) {
-    const payload = decodeJwtPayload(accessToken);
-    const rawExp = payload?.exp ?? payload?.expires_at ?? payload?.expiresAt;
-    const expNumber = Number(rawExp);
-    if (rawExp === undefined || rawExp === null || !Number.isFinite(expNumber))
-        return null;
-    // JWT `exp` is seconds; values past year ~33658 are already milliseconds.
-    return expNumber > 1_000_000_000_000 ? expNumber : expNumber * 1000;
-}
-export function applyTokenExpiry(tokenInfo) {
-    if (!tokenInfo?.accessToken)
-        return tokenInfo;
-    const expiresAtMs = tokenInfo.expiresAtMs ||
-        getTokenExpiryMs(tokenInfo.accessToken) ||
-        Date.now() + DEFAULT_TOKEN_TTL_MS;
-    return { ...tokenInfo, expiresAtMs };
-}
-function stripAuraResponsePrefix(text) {
-    return text
-        .trim()
-        .replace(/^for\(;;\);/, '')
-        .replace(/^\)\]\}',?/, '')
-        .trim();
-}
-/**
- * Parses the access token out of a Salesforce Aura `getToken` response body.
- * Returns null when the payload is missing, errored, or lacks a token.
- */
-export function parseAuraToken(rawResponseBody) {
-    let payload;
-    try {
-        payload = JSON.parse(stripAuraResponsePrefix(rawResponseBody));
-    }
-    catch {
-        return null;
-    }
-    const action = Array.isArray(payload?.actions) ? payload.actions[0] : null;
-    if (!action || (action.state && action.state !== 'SUCCESS'))
-        return null;
-    let returnValue = action.returnValue ?? null;
-    if (typeof returnValue?.returnValue === 'string')
-        returnValue = returnValue.returnValue;
-    const fields = readTokenFields(returnValue);
-    const accessToken = fields.accessToken;
-    if (!accessToken)
-        return null;
-    let filterer = fields.filterer;
-    const jwtFilterer = decodeJwtPayload(accessToken)?.filterer;
-    if (!filterer && typeof jwtFilterer === 'string')
-        filterer = jwtFilterer;
-    return applyTokenExpiry({
-        accessToken,
-        organizationId: fields.organizationId || COVEO_DEFAULTS.organizationId,
-        searchHub: fields.searchHub || COVEO_DEFAULTS.searchHub,
-        endpointBase: fields.endpointBase || COVEO_DEFAULTS.endpointBase,
-        clientUri: fields.clientUri || COVEO_DEFAULTS.clientUri,
-        filterer,
-        expiresAtMs: 0,
-    });
-}
-function readTokenFields(returnValue) {
-    if (typeof returnValue === 'string') {
-        const trimmed = returnValue.trim();
-        if (/^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+$/.test(trimmed)) {
-            return { accessToken: trimmed, filterer: null };
-        }
-        if (trimmed.startsWith('{')) {
-            try {
-                return readTokenFields(JSON.parse(trimmed));
-            }
-            catch {
-                return { accessToken: null, filterer: null };
-            }
-        }
-        return { accessToken: null, filterer: null };
-    }
-    if (returnValue && typeof returnValue === 'object') {
-        const v = returnValue;
-        return {
-            accessToken: v.accessToken || v.token || v.authToken || v.access_token || null,
-            organizationId: v.organizationId || v.organization || v.sfOrganizationId,
-            searchHub: v.searchHub,
-            endpointBase: v.platformUri || v.clientUri,
-            clientUri: v.clientUri,
-            filterer: v.filterer || v.filter || null,
-        };
-    }
-    return { accessToken: null, filterer: null };
-}
-function tokenCachePath() {
-    const base = process.env.XDG_CACHE_HOME || join(homedir(), '.cache');
-    return join(base, 'bonsai', 'salesforce-coveo-token.json');
-}
-export function loadToken() {
-    try {
-        const parsed = JSON.parse(readFileSync(tokenCachePath(), 'utf8'));
-        if (!parsed.accessToken)
-            return null;
-        return applyTokenExpiry({
-            ...COVEO_DEFAULTS,
-            filterer: null,
-            expiresAtMs: 0,
-            ...parsed,
-        });
-    }
-    catch {
-        return null;
-    }
-}
-// ponytail: token persisted as plaintext on disk. It is a public anonymous Coveo
-// search token (no user data, ~24h TTL), so the OS keychain isn't warranted. Move to
-// keytar here if these modules ever hold a privileged token.
-export function storeToken(tokenInfo) {
-    try {
-        const path = tokenCachePath();
-        mkdirSync(dirname(path), { recursive: true });
-        writeFileSync(path, JSON.stringify(applyTokenExpiry(tokenInfo)), {
-            encoding: 'utf8',
-            mode: 0o600,
-        });
-    }
-    catch {
-        // A non-writable cache dir just means we re-mint via the browser next time.
-    }
-}