@attlaz/client 1.103.0 → 1.105.0

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

@@ -0,0 +1,19 @@
+/**
+ * Whether a vendor product is purchasable. Three states rather than a nullable boolean, because
+ * "we don't know" is a different fact from "it is out of stock" — most crawlers never report stock.
+ *
+ * Duplicated from apps-lib rather than imported, per the client's enum-duplication convention: the
+ * client must not depend on a server package.
+ */
+export type StockStatus = 'in_stock' | 'out_of_stock' | 'unknown';
+/**
+ * Read `stock_status` from an API record. An unrecognised or absent value is `unknown`, never
+ * `out_of_stock` — guessing the latter would make a consumer hide a product that is probably on sale.
+ */
+export declare const parseStockStatus: (status: unknown) => StockStatus;
+/**
+ * Convert a scraper's own boolean reading of stock into a status. Separate from parseStockStatus:
+ * that one reads the wire, this one is for callers holding a `boolean | null` of their own, where
+ * null genuinely means the source did not say.
+ */
+export declare const stockStatusFromBoolean: (inStock: boolean | null) => StockStatus;

package/dist/MarketPulse/Model/StockStatus.js

@@ -0,0 +1,21 @@
+/**
+ * Read `stock_status` from an API record. An unrecognised or absent value is `unknown`, never
+ * `out_of_stock` — guessing the latter would make a consumer hide a product that is probably on sale.
+ */
+export const parseStockStatus = (status) => {
+    if (status === 'in_stock' || status === 'out_of_stock' || status === 'unknown') {
+        return status;
+    }
+    return 'unknown';
+};
+/**
+ * Convert a scraper's own boolean reading of stock into a status. Separate from parseStockStatus:
+ * that one reads the wire, this one is for callers holding a `boolean | null` of their own, where
+ * null genuinely means the source did not say.
+ */
+export const stockStatusFromBoolean = (inStock) => {
+    if (inStock === null) {
+        return 'unknown';
+    }
+    return inStock ? 'in_stock' : 'out_of_stock';
+};

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

@@ -1,3 +1,4 @@
+import { StockStatus } from './StockStatus.js';
 import { ApiRecord } from '../../Model/ApiRecord.js';
 /**
  * A competitor's product as tracked by Market Pulse — the `/pulse/vendors/:vendorId/products`
@@ -17,7 +18,7 @@ export declare class VendorProduct {
     price: number | null;
     originalPrice: number | null;
     shippingCost: number | null;
-    isInStock: boolean | null;
+    stockStatus: StockStatus;
     properties: Record<string, unknown> | null;
     createdAt: Date | null;
     updatedAt: Date | null;

package/dist/MarketPulse/Model/VendorProduct.js

@@ -1,3 +1,4 @@
+import { parseStockStatus } from './StockStatus.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).
@@ -16,7 +17,7 @@ export class VendorProduct {
     price = null;
     originalPrice = null;
     shippingCost = null;
-    isInStock = null;
+    stockStatus = 'unknown';
     properties = null;
     createdAt = null;
     updatedAt = null;
@@ -46,7 +47,7 @@ export class VendorProduct {
         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.stockStatus = parseStockStatus(raw.stock_status);
         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;

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

@@ -1,3 +1,4 @@
+import { StockStatus } from './StockStatus.js';
 import { ApiRecord } from '../../Model/ApiRecord.js';
 /**
  * One recorded price point of a competitor product — the `/pulse/vendor-products/:id/price-history`
@@ -10,7 +11,7 @@ export declare class VendorProductPriceHistoryEntry {
     price: number | null;
     originalPrice: number | null;
     shippingCost: number | null;
-    isInStock: boolean | null;
+    stockStatus: StockStatus;
     isPromotion: boolean | null;
     recordedAt: Date | null;
     constructor(id: string, vendorProductId: string);

package/dist/MarketPulse/Model/VendorProductPriceHistoryEntry.js

@@ -1,3 +1,4 @@
+import { parseStockStatus } from './StockStatus.js';
 /**
  * One recorded price point of a competitor product — the `/pulse/vendor-products/:id/price-history`
  * resource. Written when a crawl finds a price that differs from the last recorded one, so the
@@ -9,7 +10,7 @@ export class VendorProductPriceHistoryEntry {
     price = null;
     originalPrice = null;
     shippingCost = null;
-    isInStock = null;
+    stockStatus = 'unknown';
     isPromotion = null;
     recordedAt = null;
     constructor(id, vendorProductId) {
@@ -21,7 +22,7 @@ export class VendorProductPriceHistoryEntry {
         entry.price = toNumber(raw.price);
         entry.originalPrice = toNumber(raw.original_price);
         entry.shippingCost = toNumber(raw.shipping_cost);
-        entry.isInStock = typeof raw.is_in_stock === 'boolean' ? raw.is_in_stock : null;
+        entry.stockStatus = parseStockStatus(raw.stock_status);
         entry.isPromotion = typeof raw.is_promotion === 'boolean' ? raw.is_promotion : null;
         entry.recordedAt = raw.recorded_at ? new Date(raw.recorded_at) : null;
         return entry;

package/dist/MarketPulse/Service/VendorProductEndpoint.js

@@ -62,7 +62,7 @@ export class VendorProductEndpoint extends Endpoint {
             price: product.price,
             originalPrice: product.originalPrice,
             shippingCost: product.shippingCost,
-            isInStock: product.isInStock,
+            stockStatus: product.stockStatus,
             properties: product.properties,
         };
         const result = await this.requestObject(path('/pulse/vendors/:vendorId/products', { vendorId: product.vendorId }), body, VendorProduct.parse, 'POST');
@@ -76,7 +76,7 @@ export class VendorProductEndpoint extends Endpoint {
             { 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: 'stock_status', value: product.stockStatus },
             { op: 'add', path: 'url', value: product.url },
             { op: 'add', path: 'gtin', value: product.gtin },
             { op: 'add', path: 'image', value: product.image },

package/dist/Service/AdapterConnectionEndpoint.d.ts

@@ -11,6 +11,14 @@ export declare class AdapterConnectionEndpoint extends Endpoint {
     getConnectionByKey(projectId: string, connectionKey: string): Promise<AdapterConnection | null>;
     getConnectionConfiguration(connectionId: string): Promise<CollectionResult<AdapterConnectionConfigurationValue>>;
     saveConnection(projectId: string, connection: AdapterConnection): Promise<AdapterConnection>;
+    /**
+     * Writes the supplied configurations and leaves the rest of the connection alone — PATCH, since
+     * it is a partial update. A configuration the API does not let a client set (a provider token)
+     * is untouched rather than cleared.
+     *
+     * Needs an API that serves the PATCH route; it is also still registered as POST for clients
+     * released before the verb changed.
+     */
     saveConnectionConfiguration(connectionId: string, configuration: AdapterConnectionConfigurationValue[]): Promise<boolean>;
     getConnectionEvents(connectionId: string, pagination: CursorPagination): Promise<CollectionResult<AdapterConnectionEvent>>;
     /**

package/dist/Service/AdapterConnectionEndpoint.js

@@ -79,11 +79,19 @@ export class AdapterConnectionEndpoint extends Endpoint {
             throw error;
         }
     }
+    /**
+     * Writes the supplied configurations and leaves the rest of the connection alone — PATCH, since
+     * it is a partial update. A configuration the API does not let a client set (a provider token)
+     * is untouched rather than cleared.
+     *
+     * Needs an API that serves the PATCH route; it is also still registered as POST for clients
+     * released before the verb changed.
+     */
     async saveConnectionConfiguration(connectionId, configuration) {
         try {
             const url = path('/connections/:connectionId/configuration', { connectionId });
             const parser = (raw) => ({ saved: raw.saved });
-            const result = await this.requestObject(url, { configuration: configuration }, parser, 'POST');
+            const result = await this.requestObject(url, { configuration: configuration }, parser, 'PATCH');
             const res = result.getData();
             if (res === null) {
                 throw new Error('Unable to save connection configuration: wrong response from API');

package/dist/index.d.ts

@@ -82,6 +82,7 @@ export { ResultError } from './Model/Result/ResultError.js';
 export { StorageInformation } from './Model/Storage/StorageInformation.js';
 export { StorageType } from './Model/Storage/StorageType.js';
 export { VendorProduct } from './MarketPulse/Model/VendorProduct.js';
+export { StockStatus, parseStockStatus, stockStatusFromBoolean } from './MarketPulse/Model/StockStatus.js';
 export { VendorProductEndpoint } from './MarketPulse/Service/VendorProductEndpoint.js';
 export { CrawlJob, CrawlJobStatus } from './MarketPulse/Model/CrawlJob.js';
 export { CrawlJobEndpoint } from './MarketPulse/Service/CrawlJobEndpoint.js';

package/dist/index.js

@@ -68,6 +68,7 @@ export { ResultError } from './Model/Result/ResultError.js';
 export { StorageInformation } from './Model/Storage/StorageInformation.js';
 export { StorageType } from './Model/Storage/StorageType.js';
 export { VendorProduct } from './MarketPulse/Model/VendorProduct.js';
+export { parseStockStatus, stockStatusFromBoolean } from './MarketPulse/Model/StockStatus.js';
 export { VendorProductEndpoint } from './MarketPulse/Service/VendorProductEndpoint.js';
 export { CrawlJob } from './MarketPulse/Model/CrawlJob.js';
 export { CrawlJobEndpoint } from './MarketPulse/Service/CrawlJobEndpoint.js';

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "1.103.0";
+export declare const VERSION = "1.104.0";

package/dist/version.js

@@ -1 +1 @@
-export const VERSION = "1.103.0";
+export const VERSION = "1.104.0";

package/package.json

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