@configura/web-api 1.3.0-alpha.3 → 1.3.0

package/dist/CatalogueAPI.js

@@ -1,206 +1,206 @@
-// WARNING: This file was auto generated by the code in web-rnd/tygen.
-// Do not commit manual changes to this file.
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-export class APIError extends Error {
-}
-export class CatalogueAPI {
-    hasFeature(feature) {
-        return this.auth !== undefined && this.auth.apiSession.features !== undefined && this.auth.apiSession.features.indexOf(feature) > -1;
-    }
-    fetch(url, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let response;
-            let body;
-            let err;
-            if (options.method === "POST" && options.body) {
-                options.headers["Content-Type"] = "application/json;charset=utf-8";
-            }
-            try {
-                response = yield fetch(url, options);
-                body = yield response.text();
-                const parsed = JSON.parse(body);
-                if ("error" in parsed) {
-                    err = new APIError(parsed.error);
-                    err.body = body;
-                    err.status = response.status;
-                    err.parsed = parsed;
-                }
-                else {
-                    return parsed;
-                }
-            }
-            catch (e) {
-                const msg = e instanceof Error ? e.message : `${e}`;
-                err = new APIError(msg);
-                err.body = body;
-                err.status = response && response.status;
-                err.error = e instanceof Error ? e : Error(e);
-            }
-            throw err;
-        });
-    }
-    postPublicAccessTokenAuthorize(params, endpoint) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const url = `/v1/access-token/public/${encodeURIComponent(params.accessTokenId)}/authorize`;
-            const options = {
-                method: "POST",
-                headers: {},
-            };
-            return this.fetch(endpoint + url, options);
-        });
-    }
-    getApplicationAreas(params) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.auth === undefined) {
-                throw new Error("missing auth");
-            }
-            const url = `/v1/catalogue/${encodeURIComponent(params.lang)}/${encodeURIComponent(params.enterprise)}/${encodeURIComponent(params.prdCat)}/${encodeURIComponent(params.prdCatVersion)}/${encodeURIComponent(params.vendor)}/${encodeURIComponent(params.priceList)}/application-areas`;
-            const options = {
-                method: "GET",
-                headers: { "X-API-Key": this.auth.secretToken || "" },
-            };
-            return this.fetch(this.auth.endpoint + url, options);
-        });
-    }
-    postExport(params, body) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.auth === undefined) {
-                throw new Error("missing auth");
-            }
-            const url = `/v1/catalogue/${encodeURIComponent(params.lang)}/${encodeURIComponent(params.enterprise)}/${encodeURIComponent(params.prdCat)}/${encodeURIComponent(params.prdCatVersion)}/${encodeURIComponent(params.vendor)}/${encodeURIComponent(params.priceList)}/export/${encodeURIComponent(params.partNumber)}`;
-            const options = {
-                method: "POST",
-                headers: { "X-API-Key": this.auth.secretToken || "" },
-                body: JSON.stringify(body),
-            };
-            return this.fetch(this.auth.endpoint + url, options);
-        });
-    }
-    getPriceLists(params) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.auth === undefined) {
-                throw new Error("missing auth");
-            }
-            const url = `/v1/catalogue/${encodeURIComponent(params.lang)}/${encodeURIComponent(params.enterprise)}/${encodeURIComponent(params.prdCat)}/${encodeURIComponent(params.prdCatVersion)}/${encodeURIComponent(params.vendor)}/${encodeURIComponent(params.priceList)}/price-lists`;
-            const options = {
-                method: "GET",
-                headers: { "X-API-Key": this.auth.secretToken || "" },
-            };
-            return this.fetch(this.auth.endpoint + url, options);
-        });
-    }
-    getProduct(params) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.auth === undefined) {
-                throw new Error("missing auth");
-            }
-            const url = `/v1/catalogue/${encodeURIComponent(params.lang)}/${encodeURIComponent(params.enterprise)}/${encodeURIComponent(params.prdCat)}/${encodeURIComponent(params.prdCatVersion)}/${encodeURIComponent(params.vendor)}/${encodeURIComponent(params.priceList)}/product-v2/${encodeURIComponent(params.partNumber)}`;
-            const options = {
-                method: "GET",
-                headers: { "X-API-Key": this.auth.secretToken || "" },
-            };
-            return this.fetch(this.auth.endpoint + url, options);
-        });
-    }
-    postRender(params, body) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.auth === undefined) {
-                throw new Error("missing auth");
-            }
-            const url = `/v1/catalogue/${encodeURIComponent(params.lang)}/${encodeURIComponent(params.enterprise)}/${encodeURIComponent(params.prdCat)}/${encodeURIComponent(params.prdCatVersion)}/${encodeURIComponent(params.vendor)}/${encodeURIComponent(params.priceList)}/product/${encodeURIComponent(params.partNumber)}/render`;
-            const options = {
-                method: "POST",
-                headers: { "X-API-Key": this.auth.secretToken || "" },
-                body: JSON.stringify(body),
-            };
-            return this.fetch(this.auth.endpoint + url, options);
-        });
-    }
-    postValidate(params, body) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.auth === undefined) {
-                throw new Error("missing auth");
-            }
-            const url = `/v1/catalogue/${encodeURIComponent(params.lang)}/${encodeURIComponent(params.enterprise)}/${encodeURIComponent(params.prdCat)}/${encodeURIComponent(params.prdCatVersion)}/${encodeURIComponent(params.vendor)}/${encodeURIComponent(params.priceList)}/product/${encodeURIComponent(params.partNumber)}/validate`;
-            const options = {
-                method: "POST",
-                headers: { "X-API-Key": this.auth.secretToken || "" },
-                body: JSON.stringify(body),
-            };
-            return this.fetch(this.auth.endpoint + url, options);
-        });
-    }
-    getTocTree(params) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.auth === undefined) {
-                throw new Error("missing auth");
-            }
-            const url = `/v1/catalogue/${encodeURIComponent(params.lang)}/${encodeURIComponent(params.enterprise)}/${encodeURIComponent(params.prdCat)}/${encodeURIComponent(params.prdCatVersion)}/${encodeURIComponent(params.vendor)}/${encodeURIComponent(params.priceList)}/toc`;
-            const options = {
-                method: "GET",
-                headers: { "X-API-Key": this.auth.secretToken || "" },
-            };
-            return this.fetch(this.auth.endpoint + url, options);
-        });
-    }
-    getTocFlat(params) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.auth === undefined) {
-                throw new Error("missing auth");
-            }
-            const url = `/v1/catalogue/${encodeURIComponent(params.lang)}/${encodeURIComponent(params.enterprise)}/${encodeURIComponent(params.prdCat)}/${encodeURIComponent(params.prdCatVersion)}/${encodeURIComponent(params.vendor)}/${encodeURIComponent(params.priceList)}/toc/flat`;
-            const options = {
-                method: "GET",
-                headers: { "X-API-Key": this.auth.secretToken || "" },
-            };
-            return this.fetch(this.auth.endpoint + url, options);
-        });
-    }
-    getExportById(params) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.auth === undefined) {
-                throw new Error("missing auth");
-            }
-            const url = `/v1/export/${encodeURIComponent(params.uuid)}`;
-            const options = {
-                method: "GET",
-                headers: { "X-API-Key": this.auth.secretToken || "" },
-            };
-            return this.fetch(this.auth.endpoint + url, options);
-        });
-    }
-    getRenderById(params) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.auth === undefined) {
-                throw new Error("missing auth");
-            }
-            const url = `/v1/render/${encodeURIComponent(params.uuid)}`;
-            const options = {
-                method: "GET",
-                headers: { "X-API-Key": this.auth.secretToken || "" },
-            };
-            return this.fetch(this.auth.endpoint + url, options);
-        });
-    }
-    postSessionTokenRefresh() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.auth === undefined) {
-                throw new Error("missing auth");
-            }
-            const url = `/v1/session-token/refresh`;
-            const options = {
-                method: "POST",
-                headers: { "X-API-Key": this.auth.secretToken || "" },
-            };
-            return this.fetch(this.auth.endpoint + url, options);
-        });
-    }
-}
+// WARNING: This file was auto generated by the code in web-rnd/tygen.
+// Do not commit manual changes to this file.
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+export class APIError extends Error {
+}
+export class CatalogueAPI {
+    hasFeature(feature) {
+        return this.auth !== undefined && this.auth.apiSession.features !== undefined && this.auth.apiSession.features.indexOf(feature) > -1;
+    }
+    fetch(url, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let response;
+            let body;
+            let err;
+            if (options.method === "POST" && options.body) {
+                options.headers["Content-Type"] = "application/json;charset=utf-8";
+            }
+            try {
+                response = yield fetch(url, options);
+                body = yield response.text();
+                const parsed = JSON.parse(body);
+                if ("error" in parsed) {
+                    err = new APIError(parsed.error);
+                    err.body = body;
+                    err.status = response.status;
+                    err.parsed = parsed;
+                }
+                else {
+                    return parsed;
+                }
+            }
+            catch (e) {
+                const msg = e instanceof Error ? e.message : `${e}`;
+                err = new APIError(msg);
+                err.body = body;
+                err.status = response && response.status;
+                err.error = e instanceof Error ? e : Error(e);
+            }
+            throw err;
+        });
+    }
+    postPublicAccessTokenAuthorize(params, endpoint) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const url = `/v1/access-token/public/${encodeURIComponent(params.accessTokenId)}/authorize`;
+            const options = {
+                method: "POST",
+                headers: {},
+            };
+            return this.fetch(endpoint + url, options);
+        });
+    }
+    getApplicationAreas(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.auth === undefined) {
+                throw new Error("missing auth");
+            }
+            const url = `/v1/catalogue/${encodeURIComponent(params.lang)}/${encodeURIComponent(params.enterprise)}/${encodeURIComponent(params.prdCat)}/${encodeURIComponent(params.prdCatVersion)}/${encodeURIComponent(params.vendor)}/${encodeURIComponent(params.priceList)}/application-areas`;
+            const options = {
+                method: "GET",
+                headers: { "X-API-Key": this.auth.secretToken || "" },
+            };
+            return this.fetch(this.auth.endpoint + url, options);
+        });
+    }
+    postExport(params, body) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.auth === undefined) {
+                throw new Error("missing auth");
+            }
+            const url = `/v1/catalogue/${encodeURIComponent(params.lang)}/${encodeURIComponent(params.enterprise)}/${encodeURIComponent(params.prdCat)}/${encodeURIComponent(params.prdCatVersion)}/${encodeURIComponent(params.vendor)}/${encodeURIComponent(params.priceList)}/export/${encodeURIComponent(params.partNumber)}`;
+            const options = {
+                method: "POST",
+                headers: { "X-API-Key": this.auth.secretToken || "" },
+                body: JSON.stringify(body),
+            };
+            return this.fetch(this.auth.endpoint + url, options);
+        });
+    }
+    getPriceLists(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.auth === undefined) {
+                throw new Error("missing auth");
+            }
+            const url = `/v1/catalogue/${encodeURIComponent(params.lang)}/${encodeURIComponent(params.enterprise)}/${encodeURIComponent(params.prdCat)}/${encodeURIComponent(params.prdCatVersion)}/${encodeURIComponent(params.vendor)}/${encodeURIComponent(params.priceList)}/price-lists`;
+            const options = {
+                method: "GET",
+                headers: { "X-API-Key": this.auth.secretToken || "" },
+            };
+            return this.fetch(this.auth.endpoint + url, options);
+        });
+    }
+    getProduct(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.auth === undefined) {
+                throw new Error("missing auth");
+            }
+            const url = `/v1/catalogue/${encodeURIComponent(params.lang)}/${encodeURIComponent(params.enterprise)}/${encodeURIComponent(params.prdCat)}/${encodeURIComponent(params.prdCatVersion)}/${encodeURIComponent(params.vendor)}/${encodeURIComponent(params.priceList)}/product-v2/${encodeURIComponent(params.partNumber)}`;
+            const options = {
+                method: "GET",
+                headers: { "X-API-Key": this.auth.secretToken || "" },
+            };
+            return this.fetch(this.auth.endpoint + url, options);
+        });
+    }
+    postRender(params, body) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.auth === undefined) {
+                throw new Error("missing auth");
+            }
+            const url = `/v1/catalogue/${encodeURIComponent(params.lang)}/${encodeURIComponent(params.enterprise)}/${encodeURIComponent(params.prdCat)}/${encodeURIComponent(params.prdCatVersion)}/${encodeURIComponent(params.vendor)}/${encodeURIComponent(params.priceList)}/product/${encodeURIComponent(params.partNumber)}/render`;
+            const options = {
+                method: "POST",
+                headers: { "X-API-Key": this.auth.secretToken || "" },
+                body: JSON.stringify(body),
+            };
+            return this.fetch(this.auth.endpoint + url, options);
+        });
+    }
+    postValidate(params, body) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.auth === undefined) {
+                throw new Error("missing auth");
+            }
+            const url = `/v1/catalogue/${encodeURIComponent(params.lang)}/${encodeURIComponent(params.enterprise)}/${encodeURIComponent(params.prdCat)}/${encodeURIComponent(params.prdCatVersion)}/${encodeURIComponent(params.vendor)}/${encodeURIComponent(params.priceList)}/product/${encodeURIComponent(params.partNumber)}/validate`;
+            const options = {
+                method: "POST",
+                headers: { "X-API-Key": this.auth.secretToken || "" },
+                body: JSON.stringify(body),
+            };
+            return this.fetch(this.auth.endpoint + url, options);
+        });
+    }
+    getTocTree(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.auth === undefined) {
+                throw new Error("missing auth");
+            }
+            const url = `/v1/catalogue/${encodeURIComponent(params.lang)}/${encodeURIComponent(params.enterprise)}/${encodeURIComponent(params.prdCat)}/${encodeURIComponent(params.prdCatVersion)}/${encodeURIComponent(params.vendor)}/${encodeURIComponent(params.priceList)}/toc`;
+            const options = {
+                method: "GET",
+                headers: { "X-API-Key": this.auth.secretToken || "" },
+            };
+            return this.fetch(this.auth.endpoint + url, options);
+        });
+    }
+    getTocFlat(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.auth === undefined) {
+                throw new Error("missing auth");
+            }
+            const url = `/v1/catalogue/${encodeURIComponent(params.lang)}/${encodeURIComponent(params.enterprise)}/${encodeURIComponent(params.prdCat)}/${encodeURIComponent(params.prdCatVersion)}/${encodeURIComponent(params.vendor)}/${encodeURIComponent(params.priceList)}/toc/flat`;
+            const options = {
+                method: "GET",
+                headers: { "X-API-Key": this.auth.secretToken || "" },
+            };
+            return this.fetch(this.auth.endpoint + url, options);
+        });
+    }
+    getExportById(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.auth === undefined) {
+                throw new Error("missing auth");
+            }
+            const url = `/v1/export/${encodeURIComponent(params.uuid)}`;
+            const options = {
+                method: "GET",
+                headers: { "X-API-Key": this.auth.secretToken || "" },
+            };
+            return this.fetch(this.auth.endpoint + url, options);
+        });
+    }
+    getRenderById(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.auth === undefined) {
+                throw new Error("missing auth");
+            }
+            const url = `/v1/render/${encodeURIComponent(params.uuid)}`;
+            const options = {
+                method: "GET",
+                headers: { "X-API-Key": this.auth.secretToken || "" },
+            };
+            return this.fetch(this.auth.endpoint + url, options);
+        });
+    }
+    postSessionTokenRefresh() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.auth === undefined) {
+                throw new Error("missing auth");
+            }
+            const url = `/v1/session-token/refresh`;
+            const options = {
+                method: "POST",
+                headers: { "X-API-Key": this.auth.secretToken || "" },
+            };
+            return this.fetch(this.auth.endpoint + url, options);
+        });
+    }
+}

package/dist/CfgMeasure.d.ts

@@ -0,0 +1,33 @@
+import { Measurement, ValueWithUnit } from "./CatalogueAPI";
+/**
+ * Measures can be used to Anchor items (Models or Additional Products).
+ *
+ * Measures originates in Models, and can then be used in Products. There is nothing stopping
+ * having multiple Models in the same Product that use the same Measure name. If so it is ambiguous
+ * which of the Models in the Product to anchor to.
+ *
+ * Measure Priority tries to solve this by allowing MeasureParams to contain an ordered list
+ * containing which Model should have highest priority (i.e. gets "first dibs") when Anchoring.
+ *
+ * Unfortunately the solution is currently a bit limited - we can not differentiate between Models
+ * pointing to the same URL in a Product. However, we consistently pick the first one.
+ * Lower index = higher priority
+ */
+export declare type CfgMeasurePriority = {
+    index: number;
+    modelLocalFilePath: string;
+};
+/**
+ * This class strips the Measurement of things that are not actually used or relevant
+ * to Stage, specifically anchoring and stretching. Measurments can also contain
+ * volume and area, but these are ignored. Here Measures are used to define defaults
+ * such as its preferences when dealing with ambiguity or its default value.
+ */
+export declare class CfgMeasureDefinition {
+    readonly measureParamCode: string;
+    readonly numericValue: ValueWithUnit | undefined;
+    readonly measurePriorities: CfgMeasurePriority[];
+    static make(measurement: Measurement): CfgMeasureDefinition | undefined;
+    private constructor();
+}
+//# sourceMappingURL=CfgMeasure.d.ts.map

package/dist/CfgMeasure.js

@@ -0,0 +1,30 @@
+/**
+ * This class strips the Measurement of things that are not actually used or relevant
+ * to Stage, specifically anchoring and stretching. Measurments can also contain
+ * volume and area, but these are ignored. Here Measures are used to define defaults
+ * such as its preferences when dealing with ambiguity or its default value.
+ */
+export class CfgMeasureDefinition {
+    constructor(measureParamCode, numericValue, measurePriorities) {
+        this.measureParamCode = measureParamCode;
+        this.numericValue = numericValue;
+        this.measurePriorities = measurePriorities;
+    }
+    static make(measurement) {
+        // The measurement.code seems to be used in CET to connect the value to
+        // pre-existing fields in the product, such as width, height and depth.
+        // We however only use this for anchoring and stretching and so it is the
+        // code of the measureParam that is relevant. Hence Measurements with no
+        // measureParam are ignored.
+        var _a;
+        const measureParam = measurement.measureParam;
+        if (measureParam === undefined) {
+            return undefined;
+        }
+        const code = measureParam.code;
+        return new this(code, measurement.numericValue, ((_a = measureParam.measurePriority) !== null && _a !== void 0 ? _a : []).map((p, index) => ({
+            modelLocalFilePath: p.url,
+            index,
+        })));
+    }
+}