@attlaz/client 1.86.0 → 1.88.0

package/dist/Model/Pulse/CrawlJob.d.ts

@@ -12,6 +12,9 @@ export declare class CrawlJob {
     requestedAt: Date | null;
     startedAt: Date | null;
     finishedAt: Date | null;
+    /** Progress (populated by list endpoints): total pages and how many have been processed. */
+    total: number;
+    processed: number;
     constructor(id: string, vendorId: string);
     static parse(raw: ApiRecord): CrawlJob;
 }

package/dist/Model/Pulse/CrawlJob.js

@@ -10,6 +10,9 @@ export class CrawlJob {
     requestedAt;
     startedAt;
     finishedAt;
+    /** Progress (populated by list endpoints): total pages and how many have been processed. */
+    total = 0;
+    processed = 0;
     constructor(id, vendorId) {
         this.id = id;
         this.vendorId = vendorId;
@@ -24,6 +27,8 @@ export class CrawlJob {
         job.requestedAt = raw.requested_at ? new Date(raw.requested_at) : null;
         job.startedAt = raw.started_at ? new Date(raw.started_at) : null;
         job.finishedAt = raw.finished_at ? new Date(raw.finished_at) : null;
+        job.total = Number(raw.total ?? 0);
+        job.processed = Number(raw.processed ?? 0);
         return job;
     }
 }

package/dist/Service/Pulse/CrawlJobEndpoint.d.ts

@@ -10,6 +10,17 @@ export declare class CrawlJobEndpoint extends Endpoint {
     create(vendorId: string): Promise<CrawlJob>;
     /** Update a crawl job's status ('started', 'finished', 'cancelled'). */
     updateStatus(crawlJobId: string, status: CrawlJobStatus): Promise<CrawlJob>;
+    /** A vendor's crawl jobs (newest first), each with progress (`total` / `processed`). */
+    getByVendor(vendorId: string): Promise<CrawlJob[]>;
     /** The crawl job with this id, or null. */
     getById(crawlJobId: string): Promise<CrawlJob | null>;
+    /** Register the pages this crawl will process (idempotent server-side). */
+    registerPages(crawlJobId: string, urls: string[]): Promise<void>;
+    /** Mark pages as crawled (fetched). */
+    markPagesCrawled(crawlJobId: string, urls: string[]): Promise<void>;
+    /** Mark pages as parsed (terminal). The crawl auto-finishes once every page is terminal. */
+    markPagesParsed(crawlJobId: string, urls: string[]): Promise<void>;
+    /** Mark pages as failed (terminal, e.g. blocked/unfetchable). */
+    markPagesFailed(crawlJobId: string, urls: string[]): Promise<void>;
+    private postUrls;
 }

package/dist/Service/Pulse/CrawlJobEndpoint.js

@@ -24,9 +24,36 @@ export class CrawlJobEndpoint extends Endpoint {
         }
         return job;
     }
+    /** A vendor's crawl jobs (newest first), each with progress (`total` / `processed`). */
+    async getByVendor(vendorId) {
+        const result = await this.requestCollection('/pulse/vendors/' + vendorId + '/crawl-jobs', CrawlJob.parse);
+        return result.getData();
+    }
     /** The crawl job with this id, or null. */
     async getById(crawlJobId) {
         const result = await this.requestObject('/pulse/crawl-jobs/' + crawlJobId, null, CrawlJob.parse, 'GET');
         return result.getData();
     }
+    /** Register the pages this crawl will process (idempotent server-side). */
+    async registerPages(crawlJobId, urls) {
+        await this.postUrls(crawlJobId, '/pages', urls);
+    }
+    /** Mark pages as crawled (fetched). */
+    async markPagesCrawled(crawlJobId, urls) {
+        await this.postUrls(crawlJobId, '/pages/crawled', urls);
+    }
+    /** Mark pages as parsed (terminal). The crawl auto-finishes once every page is terminal. */
+    async markPagesParsed(crawlJobId, urls) {
+        await this.postUrls(crawlJobId, '/pages/parsed', urls);
+    }
+    /** Mark pages as failed (terminal, e.g. blocked/unfetchable). */
+    async markPagesFailed(crawlJobId, urls) {
+        await this.postUrls(crawlJobId, '/pages/failed', urls);
+    }
+    async postUrls(crawlJobId, path, urls) {
+        if (urls.length === 0) {
+            return;
+        }
+        await this.requestObject('/pulse/crawl-jobs/' + crawlJobId + path, { urls }, (raw) => raw, 'POST');
+    }
 }

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "1.85.0";
+export declare const VERSION = "1.87.0";

package/dist/version.js

@@ -1 +1 @@
-export const VERSION = "1.85.0";
+export const VERSION = "1.87.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@attlaz/client",
-  "version": "1.86.0",
+  "version": "1.88.0",
   "description": "Javascript Client to access Attlaz API",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",