@attlaz/client 1.83.0 → 1.85.0

package/dist/Client.d.ts

@@ -24,6 +24,8 @@ import { PlatformLanguageEndpoint } from './Service/PlatformLanguageEndpoint.js'
 import { ProjectEndpoint } from './Service/ProjectEndpoint.js';
 import { ProjectEnvironmentEndpoint } from './Service/ProjectEnvironmentEndpoint.js';
 import { ProviderTokenEndpoint } from './Service/ProviderTokenEndpoint.js';
+import { VendorProductEndpoint } from './Service/Pulse/VendorProductEndpoint.js';
+import { CrawlJobEndpoint } from './Service/Pulse/CrawlJobEndpoint.js';
 import { RunnerEndpoint } from './Service/RunnerEndpoint.js';
 import { RunnerPoolEndpoint } from './Service/RunnerPoolEndpoint.js';
 import { SearchEndpoint } from './Service/SearchEndpoint.js';
@@ -109,6 +111,8 @@ export declare class Client {
     getRunnerPoolEndpoint(): RunnerPoolEndpoint;
     getProviderTokenEndpoint(): ProviderTokenEndpoint;
     getFirewallEndpoint(): FirewallEndpoint;
+    getVendorProductEndpoint(): VendorProductEndpoint;
+    getCrawlJobEndpoint(): CrawlJobEndpoint;
     private getEndpoint;
     getVersion(): string;
 }

package/dist/Client.js

@@ -24,6 +24,8 @@ import { PlatformLanguageEndpoint } from './Service/PlatformLanguageEndpoint.js'
 import { ProjectEndpoint } from './Service/ProjectEndpoint.js';
 import { ProjectEnvironmentEndpoint } from './Service/ProjectEnvironmentEndpoint.js';
 import { ProviderTokenEndpoint } from './Service/ProviderTokenEndpoint.js';
+import { VendorProductEndpoint } from './Service/Pulse/VendorProductEndpoint.js';
+import { CrawlJobEndpoint } from './Service/Pulse/CrawlJobEndpoint.js';
 import { RunnerEndpoint } from './Service/RunnerEndpoint.js';
 import { RunnerPoolEndpoint } from './Service/RunnerPoolEndpoint.js';
 import { SearchEndpoint } from './Service/SearchEndpoint.js';
@@ -75,6 +77,8 @@ export class Client {
         CollectionsEndpoint,
         RunnerPoolEndpoint,
         ProviderTokenEndpoint,
+        VendorProductEndpoint,
+        CrawlJobEndpoint,
     };
     apiEndpoint = 'https://api.attlaz.com';
     constructor(token = null, config = {}) {
@@ -256,6 +260,12 @@ export class Client {
     getFirewallEndpoint() {
         return this.getEndpoint('firewall', this.Store.FirewallEndpoint);
     }
+    getVendorProductEndpoint() {
+        return this.getEndpoint('vendor-product', this.Store.VendorProductEndpoint);
+    }
+    getCrawlJobEndpoint() {
+        return this.getEndpoint('crawl-job', this.Store.CrawlJobEndpoint);
+    }
     getEndpoint(key, ClassName) {
         if (!this.endpoints.has(key)) {
             try {

package/dist/Http/Transport/OAuthClient.js

@@ -311,7 +311,7 @@ export class OAuthClient {
         if (this.version !== null) {
             requestData.setHeader('Attlaz-API-Version', this.version);
         }
-        if ((method === 'POST' || method === 'DELETE' || method === 'PUT') && parameters !== null && parameters !== undefined) {
+        if ((method === 'POST' || method === 'DELETE' || method === 'PUT' || method === 'PATCH') && parameters !== null && parameters !== undefined) {
             if (typeof parameters === 'object') {
                 requestData.body = JsonSerializable.stringify(parameters);
             }

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

@@ -0,0 +1,17 @@
+import { ApiRecord } from '../ApiRecord.js';
+export type CrawlJobStatus = 'pending' | 'started' | 'cancelled' | 'finished';
+/**
+ * A Market Pulse crawl job: one run of scraping a vendor. Its lifecycle (pending → started →
+ * finished) drives the vendor's "last scraped" timestamp (`finishedAt`) and, on finish, triggers
+ * post-crawl processing (price history, product matching, …).
+ */
+export declare class CrawlJob {
+    id: string;
+    vendorId: string;
+    status: CrawlJobStatus;
+    requestedAt: Date | null;
+    startedAt: Date | null;
+    finishedAt: Date | null;
+    constructor(id: string, vendorId: string);
+    static parse(raw: ApiRecord): CrawlJob;
+}

package/dist/Model/Pulse/CrawlJob.js

@@ -0,0 +1,29 @@
+/**
+ * A Market Pulse crawl job: one run of scraping a vendor. Its lifecycle (pending → started →
+ * finished) drives the vendor's "last scraped" timestamp (`finishedAt`) and, on finish, triggers
+ * post-crawl processing (price history, product matching, …).
+ */
+export class CrawlJob {
+    id;
+    vendorId;
+    status;
+    requestedAt;
+    startedAt;
+    finishedAt;
+    constructor(id, vendorId) {
+        this.id = id;
+        this.vendorId = vendorId;
+        this.status = 'pending';
+        this.requestedAt = null;
+        this.startedAt = null;
+        this.finishedAt = null;
+    }
+    static parse(raw) {
+        const job = new CrawlJob(raw.id, (raw.vendor ?? raw.vendor_id));
+        job.status = raw.status ?? 'pending';
+        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;
+        return job;
+    }
+}

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

@@ -0,0 +1,26 @@
+import { ApiRecord } from '../ApiRecord.js';
+/**
+ * A competitor's product as tracked by Market Pulse — the `/pulse/vendors/:vendorId/products`
+ * resource. `identifier` is the product's stable id on the competitor's site (the upsert key).
+ */
+export declare class VendorProduct {
+    id: string | null;
+    vendorId: string;
+    identifier: string;
+    name: string | null;
+    image: string | null;
+    gtin: string | null;
+    brand: string | null;
+    url: string | null;
+    sku: string | null;
+    currency: string | null;
+    price: number | null;
+    originalPrice: number | null;
+    shippingCost: number | null;
+    isInStock: boolean | null;
+    properties: Record<string, unknown> | null;
+    createdAt: Date | null;
+    updatedAt: Date | null;
+    constructor(vendorId: string, identifier: string);
+    static parse(raw: ApiRecord): VendorProduct;
+}

package/dist/Model/Pulse/VendorProduct.js

@@ -0,0 +1,53 @@
+/**
+ * A competitor's product as tracked by Market Pulse — the `/pulse/vendors/:vendorId/products`
+ * resource. `identifier` is the product's stable id on the competitor's site (the upsert key).
+ */
+export class VendorProduct {
+    id = null;
+    vendorId;
+    identifier;
+    name = null;
+    image = null;
+    gtin = null;
+    brand = null;
+    url = null;
+    sku = null;
+    currency = null;
+    price = null;
+    originalPrice = null;
+    shippingCost = null;
+    isInStock = null;
+    properties = null;
+    createdAt = null;
+    updatedAt = null;
+    constructor(vendorId, identifier) {
+        this.vendorId = vendorId;
+        this.identifier = identifier;
+    }
+    static parse(raw) {
+        const product = new VendorProduct(raw.vendor, raw.identifier);
+        product.id = raw.id ?? null;
+        product.name = raw.name ?? null;
+        product.image = raw.image ?? null;
+        product.gtin = raw.gtin ?? null;
+        product.brand = raw.brand ?? null;
+        product.url = raw.url ?? null;
+        product.sku = raw.sku ?? null;
+        product.currency = raw.currency ?? null;
+        product.price = toNumber(raw.price);
+        product.originalPrice = toNumber(raw.original_price);
+        product.shippingCost = toNumber(raw.shipping_cost);
+        product.isInStock = typeof raw.is_in_stock === 'boolean' ? raw.is_in_stock : null;
+        product.properties = raw.properties ?? null;
+        product.createdAt = raw.created_at ? new Date(raw.created_at) : null;
+        product.updatedAt = raw.updated_at ? new Date(raw.updated_at) : null;
+        return product;
+    }
+}
+function toNumber(value) {
+    if (value === null || value === undefined || value === '') {
+        return null;
+    }
+    const n = Number(value);
+    return Number.isFinite(n) ? n : null;
+}

package/dist/Service/Endpoint.d.ts

@@ -6,6 +6,13 @@ import { ObjectResult } from '../Model/Result/ObjectResult.js';
 export declare abstract class Endpoint {
     protected httpClient: ITransport;
     constructor(httpClient: ITransport);
+    /**
+     * Prepare a request body for sending. Normally the keys are rewritten to the API's snake_case /
+     * id-stripped convention (see {@link formatParameters}). A caller that has already shaped the
+     * body — or that carries an opaque payload whose keys must NOT be rewritten, such as a flow
+     * run's `arguments` — sets `_formatted: true`; then the body is sent verbatim (minus the marker).
+     */
+    private prepareParameters;
     private formatParameters;
     private formatKey;
     requestCollection<T>(action: string | QueryString, parser: (input: any) => T, parameters?: Parameters, method?: string, signWithOauthToken?: boolean): Promise<CollectionResult<T>>;

package/dist/Service/Endpoint.js

@@ -13,6 +13,19 @@ export class Endpoint {
     constructor(httpClient) {
         this.httpClient = httpClient;
     }
+    /**
+     * Prepare a request body for sending. Normally the keys are rewritten to the API's snake_case /
+     * id-stripped convention (see {@link formatParameters}). A caller that has already shaped the
+     * body — or that carries an opaque payload whose keys must NOT be rewritten, such as a flow
+     * run's `arguments` — sets `_formatted: true`; then the body is sent verbatim (minus the marker).
+     */
+    prepareParameters(parameters) {
+        if (parameters !== null && typeof parameters === 'object' && parameters._formatted === true) {
+            const { _formatted, ...rest } = parameters;
+            return rest;
+        }
+        return this.formatParameters(parameters);
+    }
     formatParameters(data = null) {
         if (data === null || data === undefined) {
             return null;
@@ -65,7 +78,7 @@ export class Endpoint {
         return formattedKey;
     }
     async requestCollection(action, parser, parameters = null, method = 'GET', signWithOauthToken = true) {
-        parameters = this.formatParameters(parameters);
+        parameters = this.prepareParameters(parameters);
         if (action instanceof QueryString) {
             action = action.build();
         }
@@ -94,7 +107,7 @@ export class Endpoint {
         return result;
     }
     async requestObject(action, parameters = null, parser, method = 'GET', signWithOauthToken = true) {
-        parameters = this.formatParameters(parameters);
+        parameters = this.prepareParameters(parameters);
         if (action instanceof QueryString) {
             action = action.build();
         }

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

@@ -0,0 +1,15 @@
+import { CrawlJob, CrawlJobStatus } from '../../Model/Pulse/CrawlJob.js';
+import { Endpoint } from '../Endpoint.js';
+/**
+ * Market Pulse crawl jobs — `/pulse/crawl-jobs`. Mirrors the PHP client's MarketPulse\CrawlJobEndpoint.
+ * A crawl job's lifecycle drives the vendor's "last scraped" timestamp and, on `finished`, triggers
+ * post-crawl processing (price history, product matching, price-index snapshots).
+ */
+export declare class CrawlJobEndpoint extends Endpoint {
+    /** Create a new (pending) crawl job for a vendor. */
+    create(vendorId: string): Promise<CrawlJob>;
+    /** Update a crawl job's status ('started', 'finished', 'cancelled'). */
+    updateStatus(crawlJobId: string, status: CrawlJobStatus): Promise<CrawlJob>;
+    /** The crawl job with this id, or null. */
+    getById(crawlJobId: string): Promise<CrawlJob | null>;
+}

package/dist/Service/Pulse/CrawlJobEndpoint.js

@@ -0,0 +1,32 @@
+import { CrawlJob } from '../../Model/Pulse/CrawlJob.js';
+import { Endpoint } from '../Endpoint.js';
+/**
+ * Market Pulse crawl jobs — `/pulse/crawl-jobs`. Mirrors the PHP client's MarketPulse\CrawlJobEndpoint.
+ * A crawl job's lifecycle drives the vendor's "last scraped" timestamp and, on `finished`, triggers
+ * post-crawl processing (price history, product matching, price-index snapshots).
+ */
+export class CrawlJobEndpoint extends Endpoint {
+    /** Create a new (pending) crawl job for a vendor. */
+    async create(vendorId) {
+        const result = await this.requestObject('/pulse/crawl-jobs', { vendor: vendorId }, CrawlJob.parse, 'POST');
+        const job = result.getData();
+        if (job === null) {
+            throw new Error('Unable to create crawl job: empty response');
+        }
+        return job;
+    }
+    /** 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 job = result.getData();
+        if (job === null) {
+            throw new Error('Unable to update crawl job: empty response');
+        }
+        return job;
+    }
+    /** 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();
+    }
+}

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

@@ -0,0 +1,14 @@
+import { VendorProduct } from '../../Model/Pulse/VendorProduct.js';
+import { Endpoint } from '../Endpoint.js';
+/**
+ * Market Pulse competitor products — `/pulse/vendors/:vendorId/products`. Mirrors the PHP client's
+ * MarketPulse\VendorProductEndpoint so the (Node) scraper can upsert competitor products.
+ */
+export declare class VendorProductEndpoint extends Endpoint {
+    /** The product with this identifier for the vendor, or null. */
+    getByIdentifier(vendorId: string, identifier: string): Promise<VendorProduct | null>;
+    /** Create a new vendor product. */
+    save(product: VendorProduct): Promise<VendorProduct>;
+    /** Update the mutable fields of an existing vendor product (JSON-patch style, per the API). */
+    update(product: VendorProduct): Promise<void>;
+}

package/dist/Service/Pulse/VendorProductEndpoint.js

@@ -0,0 +1,49 @@
+import { VendorProduct } from '../../Model/Pulse/VendorProduct.js';
+import { Endpoint } from '../Endpoint.js';
+/**
+ * Market Pulse competitor products — `/pulse/vendors/:vendorId/products`. Mirrors the PHP client's
+ * MarketPulse\VendorProductEndpoint so the (Node) scraper can upsert competitor products.
+ */
+export class VendorProductEndpoint extends Endpoint {
+    /** The product with this identifier for the vendor, or null. */
+    async getByIdentifier(vendorId, identifier) {
+        const result = await this.requestCollection('/pulse/vendors/' + vendorId + '/products?identifier=' + encodeURIComponent(identifier), VendorProduct.parse);
+        const products = result.getData();
+        return products.length > 0 ? products[0] : null;
+    }
+    /** Create a new vendor product. */
+    async save(product) {
+        // camelCase keys are snake_cased by the base Endpoint (originalPrice -> original_price, ...).
+        const body = {
+            name: product.name,
+            image: product.image,
+            identifier: product.identifier,
+            gtin: product.gtin,
+            brand: product.brand,
+            url: product.url,
+            currency: product.currency,
+            price: product.price,
+            originalPrice: product.originalPrice,
+            shippingCost: product.shippingCost,
+            isInStock: product.isInStock,
+            properties: product.properties,
+        };
+        const result = await this.requestObject('/pulse/vendors/' + product.vendorId + '/products', body, VendorProduct.parse, 'POST');
+        return result.getData() ?? product;
+    }
+    /** Update the mutable fields of an existing vendor product (JSON-patch style, per the API). */
+    async update(product) {
+        const operations = [
+            { op: 'add', path: 'price', value: product.price },
+            { op: 'add', path: 'original_price', value: product.originalPrice },
+            { op: 'add', path: 'brand', value: product.brand },
+            { op: 'add', path: 'shipping_cost', value: product.shippingCost },
+            { op: 'add', path: 'is_in_stock', value: product.isInStock },
+            { op: 'add', path: 'url', value: product.url },
+            { op: 'add', path: 'gtin', value: product.gtin },
+            { op: 'add', path: 'image', value: product.image },
+            { op: 'add', path: 'properties', value: product.properties },
+        ];
+        await this.requestObject('/pulse/vendors/' + product.vendorId + '/products/' + product.id, operations, (raw) => raw, 'PATCH');
+    }
+}

package/dist/Service/RunnerPoolEndpoint.d.ts

@@ -4,6 +4,10 @@ import { CollectionResult } from '../Model/Result/CollectionResult.js';
 import { Endpoint } from './Endpoint.js';
 export declare class RunnerPoolEndpoint extends Endpoint {
     getByProjectEnvironment(projectEnvironmentId: string, pagination?: CursorPagination | null): Promise<CollectionResult<RunnerPool>>;
+    create(projectEnvironmentId: string, pool: RunnerPoolCreate): Promise<RunnerPool | null>;
     getById(queueSpecificationId: string): Promise<RunnerPool | null>;
     redeploy(runnerPoolId: string): Promise<void>;
 }
+export interface RunnerPoolCreate {
+    name: string;
+}

package/dist/Service/RunnerPoolEndpoint.js

@@ -8,6 +8,14 @@ export class RunnerPoolEndpoint extends Endpoint {
         const result = await this.requestCollection(queryString, RunnerPool.parse);
         return result;
     }
+    async create(projectEnvironmentId, pool) {
+        const queryString = new QueryString('/runner-pools/project-environments/' + projectEnvironmentId + '');
+        const body = {
+            name: pool.name,
+        };
+        const result = await this.requestObject(queryString, body, RunnerPool.parse, 'POST');
+        return result.getData();
+    }
     async getById(queueSpecificationId) {
         const queryString = new QueryString('/runner-pools/' + queueSpecificationId);
         const result = await this.requestObject(queryString, null, RunnerPool.parse);

package/dist/index.d.ts

@@ -79,6 +79,10 @@ export { ObjectResult } from './Model/Result/ObjectResult.js';
 export { ResultError } from './Model/Result/ResultError.js';
 export { StorageInformation } from './Model/Storage/StorageInformation.js';
 export { StorageType } from './Model/Storage/StorageType.js';
+export { VendorProduct } from './Model/Pulse/VendorProduct.js';
+export { VendorProductEndpoint } from './Service/Pulse/VendorProductEndpoint.js';
+export { CrawlJob, CrawlJobStatus } from './Model/Pulse/CrawlJob.js';
+export { CrawlJobEndpoint } from './Service/Pulse/CrawlJobEndpoint.js';
 export { StorageItem } from './Model/Storage/StorageItem.js';
 export { StorageItemInformation } from './Model/Storage/StorageItemInformation.js';
 /** Queue * */

package/dist/index.js

@@ -67,6 +67,10 @@ export { ObjectResult } from './Model/Result/ObjectResult.js';
 export { ResultError } from './Model/Result/ResultError.js';
 export { StorageInformation } from './Model/Storage/StorageInformation.js';
 export { StorageType } from './Model/Storage/StorageType.js';
+export { VendorProduct } from './Model/Pulse/VendorProduct.js';
+export { VendorProductEndpoint } from './Service/Pulse/VendorProductEndpoint.js';
+export { CrawlJob } from './Model/Pulse/CrawlJob.js';
+export { CrawlJobEndpoint } from './Service/Pulse/CrawlJobEndpoint.js';
 export { StorageItem } from './Model/Storage/StorageItem.js';
 export { StorageItemInformation } from './Model/Storage/StorageItemInformation.js';
 /** Queue * */

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "1.82.0";
+export declare const VERSION = "1.84.0";

package/dist/version.js

@@ -1 +1 @@
-export const VERSION = "1.82.0";
+export const VERSION = "1.84.0";

package/package.json

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