@attlaz/client 1.109.0 → 1.111.0

package/dist/MarketPulse/Model/ProductOpportunity.d.ts

@@ -33,7 +33,14 @@ export declare class ProductOpportunity {
     productName: string;
     productImage: string | null;
     productBrand: string | null;
+    productSku: string | null;
     ownPrice: number;
+    /**
+     * What the product costs you. **Null means unknown, not free** — the API resolves a stored zero
+     * to null where the catalog's source uses zero for "never entered". The same unknown is why
+     * `marginPct` can be null.
+     */
+    costPrice: number | null;
     /** The product's own currency. Never assume one — see DECISIONS.md (2026-08-08). */
     currency: string | null;
     constructor(id: string, catalogProductId: string, type: OpportunityType);

package/dist/MarketPulse/Model/ProductOpportunity.js

@@ -26,7 +26,14 @@ export class ProductOpportunity {
     productName = '';
     productImage = null;
     productBrand = null;
+    productSku = null;
     ownPrice = 0;
+    /**
+     * What the product costs you. **Null means unknown, not free** — the API resolves a stored zero
+     * to null where the catalog's source uses zero for "never entered". The same unknown is why
+     * `marginPct` can be null.
+     */
+    costPrice = null;
     /** The product's own currency. Never assume one — see DECISIONS.md (2026-08-08). */
     currency = null;
     constructor(id, catalogProductId, type) {
@@ -44,6 +51,8 @@ export class ProductOpportunity {
         opportunity.computedAt = raw.computed_at ? new Date(raw.computed_at) : null;
         opportunity.configVersion = Number(raw.config_version ?? 0);
         opportunity.productName = raw.product_name ?? '';
+        opportunity.productSku = raw.product_sku ?? null;
+        opportunity.costPrice = raw.cost_price === null || raw.cost_price === undefined ? null : Number(raw.cost_price);
         opportunity.productImage = raw.product_image ?? null;
         opportunity.productBrand = raw.product_brand ?? null;
         opportunity.ownPrice = Number(raw.own_price ?? 0);

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

@@ -20,15 +20,22 @@ export declare class CrawlJobEndpoint extends Endpoint {
     create(vendorId: string, isPartial?: boolean): 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`). */
+    /**
+     * A single vendor's crawl jobs, newest first.
+     *
+     * Kept alongside the catalog list because `crawl_job` records no catalog: the scraping flow asks
+     * "is this vendor already being crawled?" knowing only a vendor. Prefer {@link getByCatalog} for
+     * anything user-facing — it is scoped to a catalog the caller can see.
+     */
     getByVendor(vendorId: string, pagination?: CursorPagination | null): Promise<CollectionResult<CrawlJob>>;
     /**
-     * Crawl jobs across every competitor of a catalog (newest first).
+     * Crawl jobs across every competitor of a catalog (newest first), each with progress
+     * (`total` / `processed`). Pass `vendorIds` to narrow to one or more competitors.
      *
      * A crawl job belongs to a vendor, not to a catalog — the API resolves the catalog's competitors
-     * and returns the jobs of their vendors.
+     * and returns the jobs of their vendors. A vendor outside this catalog is rejected.
      */
-    getByCatalog(catalogId: CatalogId | string, pagination?: CursorPagination | null): Promise<CollectionResult<CrawlJob>>;
+    getByCatalog(catalogId: CatalogId | string, pagination?: CursorPagination | null, vendorIds?: string[] | null): Promise<CollectionResult<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). */

package/dist/MarketPulse/Service/CrawlJobEndpoint.js

@@ -33,21 +33,33 @@ export class CrawlJobEndpoint extends Endpoint {
         }
         return job;
     }
-    /** A vendor's crawl jobs (newest first), each with progress (`total` / `processed`). */
+    /**
+     * A single vendor's crawl jobs, newest first.
+     *
+     * Kept alongside the catalog list because `crawl_job` records no catalog: the scraping flow asks
+     * "is this vendor already being crawled?" knowing only a vendor. Prefer {@link getByCatalog} for
+     * anything user-facing — it is scoped to a catalog the caller can see.
+     */
     async getByVendor(vendorId, pagination = null) {
         const queryString = new QueryString(path('/pulse/vendors/:vendorId/crawl-jobs', { vendorId }));
         queryString.addPagination(pagination);
         return await this.requestCollection(queryString, CrawlJob.parse);
     }
     /**
-     * Crawl jobs across every competitor of a catalog (newest first).
+     * Crawl jobs across every competitor of a catalog (newest first), each with progress
+     * (`total` / `processed`). Pass `vendorIds` to narrow to one or more competitors.
      *
      * A crawl job belongs to a vendor, not to a catalog — the API resolves the catalog's competitors
-     * and returns the jobs of their vendors.
+     * and returns the jobs of their vendors. A vendor outside this catalog is rejected.
      */
-    async getByCatalog(catalogId, pagination = null) {
+    async getByCatalog(catalogId, pagination = null, vendorIds = null) {
         const queryString = new QueryString(path('/pulse/catalogs/:catalogId/crawl-jobs', { catalogId: catalogId.toString() }));
         queryString.addPagination(pagination);
+        if (vendorIds !== null && vendorIds.length > 0) {
+            // Repeated param (`vendor=a&vendor=b`) — QueryString expands arrays, and the API reads it
+            // with getOptionalCollection.
+            queryString.set('vendor', vendorIds);
+        }
         return await this.requestCollection(queryString, CrawlJob.parse);
     }
     /** The crawl job with this id, or null. */

package/dist/MarketPulse/Service/IndexJobEndpoint.d.ts

@@ -9,10 +9,11 @@ import { VendorStatus } from '../Model/VendorStatus.js';
  * can be matched — and the resulting per-vendor freshness status.
  */
 export declare class IndexJobEndpoint extends Endpoint {
-    /** Index jobs across every competitor of a catalog, newest first. */
-    getByCatalog(catalogId: CatalogId | string, pagination?: CursorPagination | null): Promise<CollectionResult<IndexJob>>;
-    /** Index jobs of one competitor. */
-    getByVendor(catalogId: CatalogId | string, vendorId: string, pagination?: CursorPagination | null): Promise<CollectionResult<IndexJob>>;
+    /**
+     * Index jobs across every competitor of a catalog, newest first. Pass `vendorIds` to narrow to one or more
+     * competitors; a vendor outside this catalog is rejected.
+     */
+    getByCatalog(catalogId: CatalogId | string, pagination?: CursorPagination | null, vendorIds?: string[] | null): Promise<CollectionResult<IndexJob>>;
     /** Queue a re-index of a competitor's products, so later matching sees current data. */
     requestReindex(catalogId: CatalogId | string, vendorId: string): Promise<void>;
     /** How fresh a competitor's index and matches are, plus any match job running right now. */

package/dist/MarketPulse/Service/IndexJobEndpoint.js

@@ -8,16 +8,18 @@ import { VendorStatus } from '../Model/VendorStatus.js';
  * can be matched — and the resulting per-vendor freshness status.
  */
 export class IndexJobEndpoint extends Endpoint {
-    /** Index jobs across every competitor of a catalog, newest first. */
-    async getByCatalog(catalogId, pagination = null) {
+    /**
+     * Index jobs across every competitor of a catalog, newest first. Pass `vendorIds` to narrow to one or more
+     * competitors; a vendor outside this catalog is rejected.
+     */
+    async getByCatalog(catalogId, pagination = null, vendorIds = null) {
         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(path('/pulse/catalogs/:catalogId/vendors/:vendorId/index-jobs', { catalogId: catalogId.toString(), vendorId }));
-        queryString.addPagination(pagination);
+        if (vendorIds !== null && vendorIds.length > 0) {
+            // Repeated param (`vendor=a&vendor=b`) — QueryString expands arrays, and the API reads it
+            // with getOptionalCollection.
+            queryString.set('vendor', vendorIds);
+        }
         return await this.requestCollection(queryString, IndexJob.parse);
     }
     /** Queue a re-index of a competitor's products, so later matching sees current data. */

package/dist/MarketPulse/Service/OpportunityEndpoint.d.ts

@@ -3,6 +3,11 @@ import { CursorPagination } from '../../Model/Pagination/CursorPagination.js';
 import { CollectionResult } from '../../Model/Result/CollectionResult.js';
 import { Endpoint } from '../../Service/Endpoint.js';
 import { OpportunityType, ProductOpportunity } from '../Model/ProductOpportunity.js';
+/** Narrowing of the worklist. `brand` is an exact match; `sku` matches a fragment. */
+export type OpportunityFilters = {
+    brand?: string;
+    sku?: string;
+};
 /**
  * The pricing opportunity worklist — `/pulse/catalogs/:catalogId/opportunities`.
  */
@@ -13,5 +18,5 @@ export declare class OpportunityEndpoint extends Endpoint {
      * Pass a `type`: the score means something different per type, so an unfiltered read interleaves
      * four scales into one order. Unfiltered is an overview of what exists, not a ranked worklist.
      */
-    getOpportunities(catalogId: CatalogId | string, pagination?: CursorPagination | null, type?: OpportunityType | null): Promise<CollectionResult<ProductOpportunity>>;
+    getOpportunities(catalogId: CatalogId | string, pagination?: CursorPagination | null, type?: OpportunityType | null, filters?: OpportunityFilters | null): Promise<CollectionResult<ProductOpportunity>>;
 }

package/dist/MarketPulse/Service/OpportunityEndpoint.js

@@ -12,11 +12,17 @@ export class OpportunityEndpoint extends Endpoint {
      * Pass a `type`: the score means something different per type, so an unfiltered read interleaves
      * four scales into one order. Unfiltered is an overview of what exists, not a ranked worklist.
      */
-    async getOpportunities(catalogId, pagination = null, type = null) {
+    async getOpportunities(catalogId, pagination = null, type = null, filters = null) {
         const queryString = new QueryString(path('/pulse/catalogs/:catalogId/opportunities', { catalogId: catalogId.toString() }));
         if (type !== null) {
             queryString.set('type', type);
         }
+        if (filters?.brand !== undefined) {
+            queryString.set('brand', filters.brand);
+        }
+        if (filters?.sku !== undefined) {
+            queryString.set('sku', filters.sku);
+        }
         queryString.addPagination(pagination);
         return await this.requestCollection(queryString, ProductOpportunity.parse);
     }

package/dist/MarketPulse/Service/ProductMatchJobEndpoint.d.ts

@@ -8,10 +8,11 @@ import { Endpoint } from '../../Service/Endpoint.js';
  * so they share {@link ProductMatchJob}.
  */
 export declare class ProductMatchJobEndpoint extends Endpoint {
-    /** Every match job of a catalog, newest first. */
-    getByCatalog(catalogId: CatalogId | string, pagination?: CursorPagination | null): Promise<CollectionResult<ProductMatchJob>>;
-    /** The match jobs of one of the catalog's competitors. */
-    getByVendor(catalogId: CatalogId | string, vendorId: string, pagination?: CursorPagination | null): Promise<CollectionResult<ProductMatchJob>>;
+    /**
+     * Every match job of a catalog, newest first. Pass `vendorIds` to narrow to one or more of
+     * its competitors; a vendor outside this catalog is rejected.
+     */
+    getByCatalog(catalogId: CatalogId | string, pagination?: CursorPagination | null, vendorIds?: string[] | null): Promise<CollectionResult<ProductMatchJob>>;
     /** Queue a matching run of the catalog against one competitor. */
     requestMatching(catalogId: CatalogId | string, vendorId: string): Promise<void>;
     /** The match job with this id, or null. */

package/dist/MarketPulse/Service/ProductMatchJobEndpoint.js

@@ -7,16 +7,18 @@ import { Endpoint } from '../../Service/Endpoint.js';
  * so they share {@link ProductMatchJob}.
  */
 export class ProductMatchJobEndpoint extends Endpoint {
-    /** Every match job of a catalog, newest first. */
-    async getByCatalog(catalogId, pagination = null) {
+    /**
+     * Every match job of a catalog, newest first. Pass `vendorIds` to narrow to one or more of
+     * its competitors; a vendor outside this catalog is rejected.
+     */
+    async getByCatalog(catalogId, pagination = null, vendorIds = null) {
         const queryString = new QueryString(path('/pulse/catalogs/:catalogId/match-jobs', { catalogId: catalogId.toString() }));
         queryString.addPagination(pagination);
-        return await this.requestCollection(queryString, ProductMatchJob.parse);
-    }
-    /** The match jobs of one of the catalog's competitors. */
-    async getByVendor(catalogId, vendorId, pagination = null) {
-        const queryString = new QueryString(path('/pulse/catalogs/:catalogId/vendors/:vendorId/match-jobs', { catalogId: catalogId.toString(), vendorId }));
-        queryString.addPagination(pagination);
+        if (vendorIds !== null && vendorIds.length > 0) {
+            // Repeated param (`vendor=a&vendor=b`) — QueryString expands arrays, and the API reads it
+            // with getOptionalCollection.
+            queryString.set('vendor', vendorIds);
+        }
         return await this.requestCollection(queryString, ProductMatchJob.parse);
     }
     /** Queue a matching run of the catalog against one competitor. */

package/dist/index.d.ts

@@ -123,7 +123,7 @@ export { PriceSuggestion, PriceSuggestionStatus } from './MarketPulse/Model/Pric
 export { PricingRuleData } from './MarketPulse/Model/PricingRuleData.js';
 export { PricingEndpoint } from './MarketPulse/Service/PricingEndpoint.js';
 export { ProductOpportunity, OpportunityType } from './MarketPulse/Model/ProductOpportunity.js';
-export { OpportunityEndpoint } from './MarketPulse/Service/OpportunityEndpoint.js';
+export { OpportunityEndpoint, OpportunityFilters } from './MarketPulse/Service/OpportunityEndpoint.js';
 export { ProductGroup, ProductGroupType } from './MarketPulse/Model/ProductGroup.js';
 export { ProductGroupData } from './MarketPulse/Model/ProductGroupData.js';
 export { ProductGroupEndpoint } from './MarketPulse/Service/ProductGroupEndpoint.js';

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "1.108.0";
+export declare const VERSION = "1.110.0";

package/dist/version.js

@@ -1 +1 @@
-export const VERSION = "1.108.0";
+export const VERSION = "1.110.0";

package/package.json

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