@attlaz/client 1.96.0 → 1.97.0

package/dist/Flow/Service/FlowEndpoint.js

@@ -1,3 +1,4 @@
+import { path } from '../../Http/Data/Path.js';
 import { QueryString } from '../../Http/Data/QueryString.js';
 import { HttpStatus } from '../../Http/HttpStatus.js';
 import { Flow } from '../Model/Flow.js';
@@ -7,7 +8,7 @@ import { Endpoint } from '../../Service/Endpoint.js';
 export class FlowEndpoint extends Endpoint {
     async getByProject(projectId, pagination) {
         try {
-            const queryString = new QueryString('/projects/' + projectId + '/flows');
+            const queryString = new QueryString(path('/projects/:projectId/flows', { projectId }));
             queryString.addPagination(pagination);
             const result = await this.requestCollection(queryString, Flow.parse);
             return result;
@@ -21,7 +22,7 @@ export class FlowEndpoint extends Endpoint {
     }
     async getById(flowId) {
         try {
-            const result = await this.requestObject('/flows/' + flowId, null, Flow.parse);
+            const result = await this.requestObject(path('/flows/:flowId', { flowId }), null, Flow.parse);
             return result.getData();
         }
         catch (error) {
@@ -39,7 +40,7 @@ export class FlowEndpoint extends Endpoint {
         if (!Utils.isNullOrUndefined(projectEnvironmentId)) {
             parameters = { environment: projectEnvironmentId };
         }
-        const queryString = new QueryString('projects/' + projectId + '/flowsummaries');
+        const queryString = new QueryString(path('projects/:projectId/flowsummaries', { projectId }));
         if (pagination !== null) {
             queryString.addPagination(pagination);
         }
@@ -51,7 +52,7 @@ export class FlowEndpoint extends Endpoint {
             parameters = { environment: projectEnvironmentId };
         }
         try {
-            const rawFlowSummaries = await this.requestObject('flows/' + flowId + '/summaries', parameters, FlowSummary.parse);
+            const rawFlowSummaries = await this.requestObject(path('flows/:flowId/summaries', { flowId }), parameters, FlowSummary.parse);
             if (rawFlowSummaries.getData() === null) {
                 return null;
             }
@@ -66,7 +67,7 @@ export class FlowEndpoint extends Endpoint {
     }
     async save(flow) {
         try {
-            const url = '/projects/' + flow.projectId + '/flows';
+            const url = path('/projects/:projectId/flows', { projectId: flow.projectId });
             const result = await this.requestObject(url, flow, Flow.parse, 'POST');
             const updatedFlow = result.getData();
             if (updatedFlow === null) {

package/dist/Flow/Service/FlowRunEndpoint.js

@@ -1,3 +1,4 @@
+import { path } from '../../Http/Data/Path.js';
 import { FlowRun } from '../Model/FlowRun.js';
 import { FlowRunSummary } from '../Model/FlowRunSummary.js';
 import { FlowRunHistory } from '../Model/FlowRunHistory.js';
@@ -6,12 +7,12 @@ import { QueryString } from '../../Http/Data/QueryString.js';
 import { Endpoint } from '../../Service/Endpoint.js';
 export class FlowRunEndpoint extends Endpoint {
     async getFlowRuns(flowId) {
-        const result = await this.requestCollection('/flows/' + flowId + '/runs', FlowRun.parse);
+        const result = await this.requestCollection(path('/flows/:flowId/runs', { flowId }), FlowRun.parse);
         return result;
     }
     async getFlowRunSummaries(flowId, flowRunStatuses = null, pagination = null, projectEnvironmentId = null) {
         try {
-            const queryString = new QueryString('/flows/' + flowId + '/runsummaries');
+            const queryString = new QueryString(path('/flows/:flowId/runsummaries', { flowId }));
             queryString.addPagination(pagination);
             // if (from !== null && from !== undefined) {
             //
@@ -49,7 +50,7 @@ export class FlowRunEndpoint extends Endpoint {
     }
     async getFlowRunSummary(flowRunId) {
         try {
-            const result = await this.requestObject('/flowruns/' + flowRunId + '/summaries', null, FlowRunSummary.parse);
+            const result = await this.requestObject(path('/flowruns/:flowRunId/summaries', { flowRunId }), null, FlowRunSummary.parse);
             return result.getData();
         }
         catch (error) {
@@ -67,7 +68,7 @@ export class FlowRunEndpoint extends Endpoint {
      */
     async getFlowRun(flowRunId) {
         try {
-            const result = await this.requestObject('/flowruns/' + flowRunId + '/summaries', null, FlowRun.parse);
+            const result = await this.requestObject(path('/flowruns/:flowRunId/summaries', { flowRunId }), null, FlowRun.parse);
             return result.getData();
         }
         catch (error) {
@@ -78,7 +79,7 @@ export class FlowRunEndpoint extends Endpoint {
         }
     }
     async getFlowRunHistory(flowRunId) {
-        const result = await this.requestCollection('/flowruns/' + flowRunId + '/history', FlowRunHistory.parse);
+        const result = await this.requestCollection(path('/flowruns/:flowRunId/history', { flowRunId }), FlowRunHistory.parse);
         return result;
     }
     /**
@@ -87,7 +88,7 @@ export class FlowRunEndpoint extends Endpoint {
      * reflects the eventually-consistent index projection which can lag the history.
      */
     async getFlowRunLifecycle(flowRunId) {
-        const result = await this.requestObject('/flowruns/' + flowRunId + '/lifecycle', null, FlowRunLifecycle.parse);
+        const result = await this.requestObject(path('/flowruns/:flowRunId/lifecycle', { flowRunId }), null, FlowRunLifecycle.parse);
         return result.getData();
     }
     async updateFlowRun(flowRunId, status, time = null) {
@@ -101,7 +102,7 @@ export class FlowRunEndpoint extends Endpoint {
         if (time !== null && time !== undefined) {
             params.time = time;
         }
-        const result = await this.requestObject('/flowruns/' + flowRunId + '', params, FlowRun.parse, 'POST');
+        const result = await this.requestObject(path('/flowruns/:flowRunId', { flowRunId }), params, FlowRun.parse, 'POST');
         const updatedFlowRun = result.getData();
         if (updatedFlowRun === null) {
             throw new Error('FlowRun not updated');

package/dist/Flow/Service/FlowRunRequestEndpoint.js

@@ -1,8 +1,9 @@
+import { path } from '../../Http/Data/Path.js';
 import { FlowRunResponse } from '../Model/FlowRunResponse.js';
 import { Endpoint } from '../../Service/Endpoint.js';
 export class FlowRunRequestEndpoint extends Endpoint {
     async requestFlowRun(flowId, params, wait = false) {
-        let url = '/flows/' + flowId + '/flowrunrequests';
+        let url = path('/flows/:flowId/flowrunrequests', { flowId });
         if (wait) {
             url += '?wait=true';
         }

package/dist/Flow/Service/FlowRunStatsEndpoint.js

@@ -1,8 +1,9 @@
+import { path } from '../../Http/Data/Path.js';
 import { FlowRunStats } from '../Model/FlowRunStats.js';
 import { Endpoint } from '../../Service/Endpoint.js';
 export class FlowRunStatsEndpoint extends Endpoint {
     async create(flowRunStats) {
-        const url = '/flowruns/' + flowRunStats.flowRunId + '/stats';
+        const url = path('/flowruns/:flowRunId/stats', { flowRunId: flowRunStats.flowRunId });
         try {
             const result = await this.requestObject(url, flowRunStats, FlowRunStats.parse, 'POST');
             const createdFlowRunStat = result.getData();

package/dist/Helper/LoadAllHelper.js

@@ -10,7 +10,13 @@ export class LoadAllHelper {
             firstPagination.startingAfter = lastRef;
             const data = await call(firstPagination);
             const records = data.getData();
-            // Spread is faster than a per-element loop but can exceed the call stack for very large collections (50k+)
+            // An empty page that still claims hasMore cannot be paged past: the cursor advances from
+            // the last record, so the next call would repeat this one forever. The server contradicted
+            // itself — say so rather than spin.
+            if (records.length === 0 && data.hasMore) {
+                throw new Error('loadAll stopped after ' + totalResult.length + ' records: the API reported more results but returned an empty page, so paging cannot continue.');
+            }
+            // Spread one page at a time (bounded by `limit`), so the argument count stays small.
             if (totalResult.length + records.length > 50_000) {
                 throw new Error('loadAll exceeded 50,000 records (' + (totalResult.length + records.length) + '). This method is not intended for large datasets.');
             }

package/dist/Http/Data/Path.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Build a request path from a template, encoding every value that goes into it.
+ *
+ *     path('/data-quality/datasets/:datasetId/scans', {datasetId})
+ *
+ * Ids are opaque strings supplied by the caller. Concatenating them straight into a URL means a
+ * value containing `/`, `?` or `#` silently changes which endpoint is called; an empty one produces
+ * a path that quietly addresses the collection instead of the item. Encoding here makes the request
+ * mean what it says, and an empty value an error rather than a surprise.
+ */
+export declare function path(template: string, parameters?: Record<string, string | number>): string;

package/dist/Http/Data/Path.js

@@ -0,0 +1,31 @@
+/**
+ * Build a request path from a template, encoding every value that goes into it.
+ *
+ *     path('/data-quality/datasets/:datasetId/scans', {datasetId})
+ *
+ * Ids are opaque strings supplied by the caller. Concatenating them straight into a URL means a
+ * value containing `/`, `?` or `#` silently changes which endpoint is called; an empty one produces
+ * a path that quietly addresses the collection instead of the item. Encoding here makes the request
+ * mean what it says, and an empty value an error rather than a surprise.
+ */
+export function path(template, parameters = {}) {
+    const used = new Set();
+    const built = template.replace(/:([A-Za-z][A-Za-z0-9_]*)/g, (_match, name) => {
+        if (!Object.prototype.hasOwnProperty.call(parameters, name)) {
+            throw new Error('Unable to build path "' + template + '": no value for ":' + name + '"');
+        }
+        used.add(name);
+        const value = String(parameters[name]);
+        if (value === '') {
+            throw new Error('Unable to build path "' + template + '": ":' + name + '" is empty');
+        }
+        return encodeURIComponent(value);
+    });
+    // A value with no matching placeholder is a typo that would otherwise vanish silently.
+    for (const name of Object.keys(parameters)) {
+        if (!used.has(name)) {
+            throw new Error('Unable to build path "' + template + '": no placeholder for "' + name + '"');
+        }
+    }
+    return built;
+}

package/dist/Http/HttpClient.d.ts

@@ -1,5 +1,12 @@
 import { HttpClientRequest } from './HttpClientRequest.js';
 import { HttpClientResponse } from './HttpClientResponse.js';
 export declare class HttpClient {
-    static request(request: HttpClientRequest): Promise<HttpClientResponse>;
+    /**
+     * Overall budget for one request, in milliseconds. Matches the Stripe SDKs (80s), which is
+     * generous enough for a large payload and bounded enough that an unresponsive API surfaces as an
+     * error instead of hanging the caller. `fetch` applies no timeout of its own in the browser, and
+     * only bounds response headers in Node.
+     */
+    static readonly DEFAULT_TIMEOUT_MS: number;
+    static request(request: HttpClientRequest, timeoutMs?: number): Promise<HttpClientResponse>;
 }

package/dist/Http/HttpClient.js

@@ -1,11 +1,21 @@
 import { HttpClientResponse } from './HttpClientResponse.js';
 import { ClientError } from './ClientError.js';
 export class HttpClient {
-    static async request(request) {
+    /**
+     * Overall budget for one request, in milliseconds. Matches the Stripe SDKs (80s), which is
+     * generous enough for a large payload and bounded enough that an unresponsive API surfaces as an
+     * error instead of hanging the caller. `fetch` applies no timeout of its own in the browser, and
+     * only bounds response headers in Node.
+     */
+    static DEFAULT_TIMEOUT_MS = 80_000;
+    static async request(request, timeoutMs = HttpClient.DEFAULT_TIMEOUT_MS) {
         const init = {
             method: request.method,
             headers: request.headers,
         };
+        if (timeoutMs > 0) {
+            init.signal = AbortSignal.timeout(timeoutMs);
+        }
         // Node's fetch (undici) throws TypeError when GET/HEAD carry a body. Axios used to silently drop it,
         // so callers may still set body on GET — skip it here instead of propagating a confusing network error.
         const method = request.method.toUpperCase();
@@ -48,6 +58,16 @@ export class HttpClient {
             if (error instanceof ClientError) {
                 throw error;
             }
+            // AbortSignal.timeout rejects with a TimeoutError DOMException, whose message ("The
+            // operation was aborted due to timeout") says nothing about what was being called. Name
+            // the url and the budget instead.
+            //
+            // Matched on `name` rather than `instanceof`: a DOMException raised in another realm — a
+            // test runner's VM context, an iframe — is not an instance of this realm's Error, so an
+            // instanceof check passes locally and quietly fails everywhere else.
+            if (typeof error === 'object' && error !== null && error.name === 'TimeoutError') {
+                throw new ClientError('Request to `' + request.getFullUrl() + '` timed out after ' + timeoutMs + 'ms');
+            }
             throw ClientError.fromError(error);
         }
     }

package/dist/Http/OAuthClientOptions.d.ts

@@ -7,5 +7,7 @@ export declare class OAuthClientOptions {
     redirectUri: string;
     scopes: string[];
     state: string;
+    /** Overall budget for one request, in milliseconds. Set 0 to disable (not recommended). */
+    timeoutMs: number;
     constructor(apiEndpoint: string, clientId?: string | null, clientSecret?: string | null);
 }

package/dist/Http/OAuthClientOptions.js

@@ -1,3 +1,4 @@
+import { HttpClient } from './HttpClient.js';
 export class OAuthClientOptions {
     apiEndpoint;
     clientId;
@@ -7,6 +8,8 @@ export class OAuthClientOptions {
     redirectUri = 'https://example.com/auth/github/callback';
     scopes = [];
     state = '';
+    /** Overall budget for one request, in milliseconds. Set 0 to disable (not recommended). */
+    timeoutMs = HttpClient.DEFAULT_TIMEOUT_MS;
     constructor(apiEndpoint, 
     // Mutable so client credentials can be updated in place (see OAuthClient.setClientCredentials)
     // without recreating the client and losing its token.

package/dist/Http/Transport/OAuthClient.d.ts

@@ -49,6 +49,13 @@ export declare class OAuthClient implements ITransport {
     setParseErrorHandler(handler: ParseErrorHandler | null): void;
     reportParseError(message: string, context: Record<string, unknown>): void;
     private defaultHeaders;
+    /**
+     * A copy, not the live object. Returning the internal map let callers mutate it by accident: a
+     * request assigned it and then set its own headers, so `Authorization` (and `Attlaz-API-Version`)
+     * were written into the shared defaults and sent on every later request — including the ones that
+     * deliberately pass `signWithOauthToken: false` (password reset, email confirmation, invite
+     * lookup, health). {@link addDefaultHeader} is the only way to add a real default.
+     */
     getDefaultHeaders(): Headers;
     private initDefaultHeaders;
     addDefaultHeader(header: string, value: string): void;

package/dist/Http/Transport/OAuthClient.js

@@ -156,11 +156,31 @@ export class OAuthClient {
      * server's HTTP status and, when the body is JSON, its structured error message.
      */
     async requestToken(params) {
-        const response = await fetch(this.getApiEndpointUrl(this.options.accessTokenUri), {
+        // The token endpoint bypasses HttpClient, so it does not inherit its timeout. Without one an
+        // unresponsive token endpoint hangs authenticate()/refreshToken() forever — and that is the
+        // one call every client makes before it can do anything else.
+        const timeoutMs = this.options.timeoutMs;
+        const init = {
             method: 'POST',
             headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
             body: new URLSearchParams(params).toString(),
-        });
+        };
+        if (timeoutMs > 0) {
+            init.signal = AbortSignal.timeout(timeoutMs);
+        }
+        const tokenUrl = this.getApiEndpointUrl(this.options.accessTokenUri);
+        let response;
+        try {
+            response = await fetch(tokenUrl, init);
+        }
+        catch (error) {
+            // Matched on `name`, not instanceof: a DOMException from another realm (a test runner's VM
+            // context, an iframe) is not an instance of this realm's Error. Same reasoning as HttpClient.
+            if (typeof error === 'object' && error !== null && error.name === 'TimeoutError') {
+                throw new ClientError('Token request to `' + tokenUrl + '` timed out after ' + timeoutMs + 'ms');
+            }
+            throw ClientError.fromError(error);
+        }
         if (!response.ok) {
             const clientError = new ClientError(response.statusText || 'Token request failed', response.status);
             // The token endpoint bypasses HttpClient (and authenticate() bypasses Endpoint.toApiError),
@@ -208,7 +228,7 @@ export class OAuthClient {
             console.debug('[OAuthClient] Request: ' + requestData.method.toUpperCase() + ' ' + requestData.getFullUrl(), { headers: requestData.headers });
         }
         try {
-            const response = await HttpClient.request(requestData);
+            const response = await HttpClient.request(requestData, this.options.timeoutMs);
             return response.body;
         }
         catch (error) {
@@ -258,8 +278,15 @@ export class OAuthClient {
         console.error(message, context);
     }
     defaultHeaders = {};
+    /**
+     * A copy, not the live object. Returning the internal map let callers mutate it by accident: a
+     * request assigned it and then set its own headers, so `Authorization` (and `Attlaz-API-Version`)
+     * were written into the shared defaults and sent on every later request — including the ones that
+     * deliberately pass `signWithOauthToken: false` (password reset, email confirmation, invite
+     * lookup, health). {@link addDefaultHeader} is the only way to add a real default.
+     */
     getDefaultHeaders() {
-        return this.defaultHeaders;
+        return { ...this.defaultHeaders };
     }
     initDefaultHeaders() {
         const userAgentInfo = {

package/dist/Logging/Service/LogEndpoint.d.ts

@@ -11,7 +11,11 @@ export declare class LogEndpoint extends Endpoint {
     getLogs(logQuery: LogQuery): Promise<CollectionResult<Log>>;
     getCursoredLogEntries(logStreamId: LogStreamId, pagination: CursorPagination | null, filter: FilterNode | null): Promise<CollectionResult<Log>>;
     save(log: Log): Promise<Log>;
-    delete(logId: string): Promise<boolean>;
+    /**
+     * The stream id was missing here: the path was built with the literal text `:streamId`, so every
+     * call requested `/logstreams/:streamId/logs/<id>` and could never have matched the route.
+     */
+    delete(logStreamId: string, logId: string): Promise<boolean>;
     clear(logStreamId: LogStreamId): Promise<boolean>;
     getInformation(logStreamId: LogStreamId): Promise<LogStreamInformation | null>;
     getByProject(projectId: string, pagination?: CursorPagination | null): Promise<CollectionResult<LogStream>>;

package/dist/Logging/Service/LogEndpoint.js

@@ -1,3 +1,4 @@
+import { path } from '../../Http/Data/Path.js';
 import { QueryString } from '../../Http/Data/QueryString.js';
 import { Log } from '../Model/Log.js';
 import { LogStream } from '../Model/LogStream.js';
@@ -36,12 +37,13 @@ export class LogEndpoint extends Endpoint {
             const strTags = arrTags.join(',');
             arrQuery.push('tags=' + strTags);
         }
-        const cmd = '/logstreams/' + logQuery.logStreamId.toString() + '/logs/?' + arrQuery.join('&');
+        const cmd = path('/logstreams/:logStreamId/logs/', { logStreamId: logQuery.logStreamId.toString() })
+            + '?' + arrQuery.join('&');
         const result = await this.requestCollection(cmd, Log.parse);
         return result;
     }
     async getCursoredLogEntries(logStreamId, pagination, filter) {
-        const queryString = new QueryString('/logstreams/' + logStreamId.toString() + '/logs');
+        const queryString = new QueryString(path('/logstreams/:logStreamId/logs', { logStreamId: logStreamId.toString() }));
         queryString.addPagination(pagination);
         if (filter !== null && filter !== undefined) {
             queryString.set('filter', JSON.stringify(filter));
@@ -51,7 +53,7 @@ export class LogEndpoint extends Endpoint {
     }
     async save(log) {
         try {
-            const cmd = '/logstreams/' + log.logStream.toString() + '/logs';
+            const cmd = path('/logstreams/:logStream/logs', { logStream: log.logStream.toString() });
             const result = await this.requestObject(cmd, log, Log.parse, 'POST');
             const updatedLogEntry = result.getData();
             if (updatedLogEntry === null) {
@@ -66,8 +68,12 @@ export class LogEndpoint extends Endpoint {
             throw error;
         }
     }
-    async delete(logId) {
-        const cmd = '/logstreams/:streamId/logs/' + logId;
+    /**
+     * The stream id was missing here: the path was built with the literal text `:streamId`, so every
+     * call requested `/logstreams/:streamId/logs/<id>` and could never have matched the route.
+     */
+    async delete(logStreamId, logId) {
+        const cmd = path('/logstreams/:logStreamId/logs/:logId', { logStreamId, logId });
         try {
             const parser = (raw) => ({ deleted: raw.deleted });
             const result = await this.requestObject(cmd, null, parser, 'DELETE');
@@ -86,7 +92,7 @@ export class LogEndpoint extends Endpoint {
         }
     }
     async clear(logStreamId) {
-        const cmd = '/logstreams/' + logStreamId.toString() + '/clear';
+        const cmd = path('/logstreams/:logStreamId/clear', { logStreamId: logStreamId.toString() });
         try {
             const parser = (raw) => ({ cleared: raw.cleared });
             const result = await this.requestObject(cmd, null, parser, 'POST');
@@ -106,7 +112,7 @@ export class LogEndpoint extends Endpoint {
     }
     async getInformation(logStreamId) {
         try {
-            const url = '/logstreams/' + logStreamId.toString() + '/info';
+            const url = path('/logstreams/:logStreamId/info', { logStreamId: logStreamId.toString() });
             const result = await this.requestObject(url, null, LogStreamInformation.parse);
             return result.getData();
         }
@@ -118,7 +124,7 @@ export class LogEndpoint extends Endpoint {
         }
     }
     async getByProject(projectId, pagination = null) {
-        const queryString = new QueryString('projects/' + projectId + '/logstreams');
+        const queryString = new QueryString(path('projects/:projectId/logstreams', { projectId }));
         queryString.addPagination(pagination);
         const parser = (raw) => new LogStream(new LogStreamId(raw.id), raw.name);
         const result = await this.requestCollection(queryString, parser);

package/dist/{Pulse → MarketPulse}/Service/CompetitorEndpoint.js

@@ -1,3 +1,4 @@
+import { path } from '../../Http/Data/Path.js';
 import { QueryString } from '../../Http/Data/QueryString.js';
 import { Endpoint } from '../../Service/Endpoint.js';
 import { Competitor } from '../Model/Competitor.js';
@@ -7,17 +8,17 @@ import { Competitor } from '../Model/Competitor.js';
  */
 export class CompetitorEndpoint extends Endpoint {
     async getByCatalog(catalogId, pagination = null) {
-        const queryString = new QueryString('/pulse/catalogs/' + catalogId.toString() + '/competing-vendors');
+        const queryString = new QueryString(path('/pulse/catalogs/:catalogId/competing-vendors', { catalogId: catalogId.toString() }));
         queryString.addPagination(pagination);
         return await this.requestCollection(queryString, Competitor.parse);
     }
     async getById(competitorId) {
-        const result = await this.requestObject('/pulse/competing-vendors/' + competitorId, null, Competitor.parse, 'GET');
+        const result = await this.requestObject(path('/pulse/competing-vendors/:competitorId', { competitorId }), null, Competitor.parse, 'GET');
         return result.getData();
     }
     /** Start watching a vendor as a competitor of this catalog. */
     async add(catalogId, vendorId) {
-        const result = await this.requestObject('/pulse/catalogs/' + catalogId.toString() + '/competing-vendors', { vendor: vendorId }, Competitor.parse, 'POST');
+        const result = await this.requestObject(path('/pulse/catalogs/:catalogId/competing-vendors', { catalogId: catalogId.toString() }), { vendor: vendorId }, Competitor.parse, 'POST');
         return result.getData();
     }
 }

package/dist/{Pulse → MarketPulse}/Service/CrawlJobEndpoint.d.ts

@@ -32,5 +32,6 @@ export declare class CrawlJobEndpoint extends Endpoint {
     markPagesParsed(crawlJobId: string, urls: string[]): Promise<void>;
     /** Mark pages as failed (terminal, e.g. blocked/unfetchable). */
     markPagesFailed(crawlJobId: string, urls: string[]): Promise<void>;
+    /** @param suffix a literal trailing segment, e.g. `/pages/crawled` — not caller data. */
     private postUrls;
 }

package/dist/{Pulse → MarketPulse}/Service/CrawlJobEndpoint.js

@@ -1,3 +1,4 @@
+import { path } from '../../Http/Data/Path.js';
 import { QueryString } from '../../Http/Data/QueryString.js';
 import { CrawlJob } from '../Model/CrawlJob.js';
 import { Endpoint } from '../../Service/Endpoint.js';
@@ -18,7 +19,7 @@ export class CrawlJobEndpoint extends Endpoint {
     }
     /** Update a crawl job's status ('started', 'finished', 'cancelled'). */
     async updateStatus(crawlJobId, status) {
-        const result = await this.requestObject('/pulse/crawl-jobs/' + crawlJobId, { status }, CrawlJob.parse, 'PATCH');
+        const result = await this.requestObject(path('/pulse/crawl-jobs/:crawlJobId', { crawlJobId }), { status }, CrawlJob.parse, 'PATCH');
         const job = result.getData();
         if (job === null) {
             throw new Error('Unable to update crawl job: empty response');
@@ -27,7 +28,7 @@ export class CrawlJobEndpoint extends Endpoint {
     }
     /** A vendor's crawl jobs (newest first), each with progress (`total` / `processed`). */
     async getByVendor(vendorId, pagination = null) {
-        const queryString = new QueryString('/pulse/vendors/' + vendorId + '/crawl-jobs');
+        const queryString = new QueryString(path('/pulse/vendors/:vendorId/crawl-jobs', { vendorId }));
         queryString.addPagination(pagination);
         return await this.requestCollection(queryString, CrawlJob.parse);
     }
@@ -38,13 +39,13 @@ export class CrawlJobEndpoint extends Endpoint {
      * and returns the jobs of their vendors.
      */
     async getByCatalog(catalogId, pagination = null) {
-        const queryString = new QueryString('/pulse/catalogs/' + catalogId.toString() + '/crawl-jobs');
+        const queryString = new QueryString(path('/pulse/catalogs/:catalogId/crawl-jobs', { catalogId: catalogId.toString() }));
         queryString.addPagination(pagination);
         return await this.requestCollection(queryString, CrawlJob.parse);
     }
     /** The crawl job with this id, or null. */
     async getById(crawlJobId) {
-        const result = await this.requestObject('/pulse/crawl-jobs/' + crawlJobId, null, CrawlJob.parse, 'GET');
+        const result = await this.requestObject(path('/pulse/crawl-jobs/:crawlJobId', { crawlJobId }), null, CrawlJob.parse, 'GET');
         return result.getData();
     }
     /** Register the pages this crawl will process (idempotent server-side). */
@@ -63,10 +64,11 @@ export class CrawlJobEndpoint extends Endpoint {
     async markPagesFailed(crawlJobId, urls) {
         await this.postUrls(crawlJobId, '/pages/failed', urls);
     }
-    async postUrls(crawlJobId, path, urls) {
+    /** @param suffix a literal trailing segment, e.g. `/pages/crawled` — not caller data. */
+    async postUrls(crawlJobId, suffix, urls) {
         if (urls.length === 0) {
             return;
         }
-        await this.requestObject('/pulse/crawl-jobs/' + crawlJobId + path, { urls }, (raw) => raw, 'POST');
+        await this.requestObject(path('/pulse/crawl-jobs/:crawlJobId', { crawlJobId }) + suffix, { urls }, (raw) => raw, 'POST');
     }
 }

package/dist/{Pulse → MarketPulse}/Service/IndexJobEndpoint.js

@@ -1,3 +1,4 @@
+import { path } from '../../Http/Data/Path.js';
 import { QueryString } from '../../Http/Data/QueryString.js';
 import { Endpoint } from '../../Service/Endpoint.js';
 import { IndexJob } from '../Model/IndexJob.js';
@@ -9,23 +10,23 @@ import { VendorStatus } from '../Model/VendorStatus.js';
 export class IndexJobEndpoint extends Endpoint {
     /** Index jobs across every competitor of a catalog, newest first. */
     async getByCatalog(catalogId, pagination = null) {
-        const queryString = new QueryString('/pulse/catalogs/' + catalogId.toString() + '/index-jobs');
+        const queryString = new QueryString(path('/pulse/catalogs/:catalogId/index-jobs', { catalogId: catalogId.toString() }));
         queryString.addPagination(pagination);
         return await this.requestCollection(queryString, IndexJob.parse);
     }
     /** Index jobs of one competitor. */
     async getByVendor(catalogId, vendorId, pagination = null) {
-        const queryString = new QueryString('/pulse/catalogs/' + catalogId.toString() + '/vendors/' + vendorId + '/index-jobs');
+        const queryString = new QueryString(path('/pulse/catalogs/:catalogId/vendors/:vendorId/index-jobs', { catalogId: catalogId.toString(), vendorId }));
         queryString.addPagination(pagination);
         return await this.requestCollection(queryString, IndexJob.parse);
     }
     /** Queue a re-index of a competitor's products, so later matching sees current data. */
     async requestReindex(catalogId, vendorId) {
-        await this.requestObject('/pulse/catalogs/' + catalogId.toString() + '/vendors/' + vendorId + '/reindex', {}, (raw) => raw, 'POST');
+        await this.requestObject(path('/pulse/catalogs/:catalogId/vendors/:vendorId/reindex', { catalogId: catalogId.toString(), vendorId }), {}, (raw) => raw, 'POST');
     }
     /** How fresh a competitor's index and matches are, plus any match job running right now. */
     async getVendorStatus(catalogId, vendorId) {
-        const result = await this.requestObject('/pulse/catalogs/' + catalogId.toString() + '/vendors/' + vendorId + '/status', null, VendorStatus.parse, 'GET');
+        const result = await this.requestObject(path('/pulse/catalogs/:catalogId/vendors/:vendorId/status', { catalogId: catalogId.toString(), vendorId }), null, VendorStatus.parse, 'GET');
         return result.getData();
     }
 }

package/dist/{Pulse → MarketPulse}/Service/PriceAlertEndpoint.js

@@ -1,3 +1,4 @@
+import { path } from '../../Http/Data/Path.js';
 import { QueryString } from '../../Http/Data/QueryString.js';
 import { Endpoint } from '../../Service/Endpoint.js';
 import { PriceAlertConfig } from '../Model/PriceAlertConfig.js';
@@ -7,27 +8,27 @@ import { PriceAlertEvent } from '../Model/PriceAlertEvent.js';
  */
 export class PriceAlertEndpoint extends Endpoint {
     async getConfigs(catalogId, pagination = null) {
-        const queryString = new QueryString('/pulse/catalogs/' + catalogId.toString() + '/price-alert-configs');
+        const queryString = new QueryString(path('/pulse/catalogs/:catalogId/price-alert-configs', { catalogId: catalogId.toString() }));
         queryString.addPagination(pagination);
         return await this.requestCollection(queryString, PriceAlertConfig.parse);
     }
     async getConfig(alertConfigId) {
-        const result = await this.requestObject('/pulse/price-alert-configs/' + alertConfigId, null, PriceAlertConfig.parse, 'GET');
+        const result = await this.requestObject(path('/pulse/price-alert-configs/:alertConfigId', { alertConfigId }), null, PriceAlertConfig.parse, 'GET');
         return result.getData();
     }
     async createConfig(catalogId, data) {
-        const result = await this.requestObject('/pulse/catalogs/' + catalogId.toString() + '/price-alert-configs', data, PriceAlertConfig.parse, 'POST');
+        const result = await this.requestObject(path('/pulse/catalogs/:catalogId/price-alert-configs', { catalogId: catalogId.toString() }), data, PriceAlertConfig.parse, 'POST');
         return result.getData();
     }
     async updateConfig(alertConfigId, data) {
-        const result = await this.requestObject('/pulse/price-alert-configs/' + alertConfigId, data, PriceAlertConfig.parse, 'PATCH');
+        const result = await this.requestObject(path('/pulse/price-alert-configs/:alertConfigId', { alertConfigId }), data, PriceAlertConfig.parse, 'PATCH');
         return result.getData();
     }
     async deleteConfig(alertConfigId) {
-        await this.requestObject('/pulse/price-alert-configs/' + alertConfigId, null, (raw) => raw, 'DELETE');
+        await this.requestObject(path('/pulse/price-alert-configs/:alertConfigId', { alertConfigId }), null, (raw) => raw, 'DELETE');
     }
     async getEvents(alertConfigId, pagination = null) {
-        const queryString = new QueryString('/pulse/price-alert-configs/' + alertConfigId + '/events');
+        const queryString = new QueryString(path('/pulse/price-alert-configs/:alertConfigId/events', { alertConfigId }));
         queryString.addPagination(pagination);
         return await this.requestCollection(queryString, PriceAlertEvent.parse);
     }
@@ -36,7 +37,7 @@ export class PriceAlertEndpoint extends Endpoint {
      * when from the session, so the request carries no body.
      */
     async acknowledgeEvent(alertEventId) {
-        const result = await this.requestObject('/pulse/price-alert-events/' + alertEventId, {}, PriceAlertEvent.parse, 'PATCH');
+        const result = await this.requestObject(path('/pulse/price-alert-events/:alertEventId', { alertEventId }), {}, PriceAlertEvent.parse, 'PATCH');
         return result.getData();
     }
 }