@configura/web-api 1.6.1-alpha.5 → 1.6.1-alpha.7

package/dist/productLoader.js

@@ -1,49 +1,49 @@
-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());
-    });
-};
-import { PromiseCache } from "@configura/web-utilities";
-import { makeProductKey, makeSelOptionsKey, } from "./utilitiesCatalogueData.js";
-/**
- * Wraps a getProduct function so that it caches for the time it lives.
- *
- * It has no cache invalidation or timeouts, so whatever ends up in the cache stays there
- * indefinitely. For this reason we recommend using this with caution.
- *
- * In our Example App we use it to cache the internal calls in additional products as in such a
- * product you tend to frequently get calls to same sub-product. Such as loading the same table leg
- * four times.
- */
-export function wrapWithGetProductCache(getProduct) {
-    const cache = new PromiseCache();
-    return (params) => __awaiter(this, void 0, void 0, function* () { return cache.get(makeProductKey(params, params.partNumber), () => getProduct(params)); });
-}
-/**
- * Wraps a postValidate function so that it caches for the time it lives.
- *
- * It has no cache invalidation or timeouts, so whatever ends up in the cache stays there
- * indefinitely. We recommend you do not use this unless you are really, really sure what you are
- * doing.
- *
- * The SDK uses it for additional products to avoid validating for example the same table legs four
- * times at the same time. There we make sure the this cache only stays in scope for one user
- * interaction. No longer than the actions caused by a user clicking an option.
- */
-export function wrapWithPostValidateCache(postValidate) {
-    const cache = new PromiseCache();
-    return (params, body) => __awaiter(this, void 0, void 0, function* () {
-        return cache.get(`${makeProductKey(params, params.partNumber)}-${makeSelOptionsKey(body.selOptions)}`, () => postValidate(params, body));
-    });
-}
-/** Does both wrapWithGetProductCache and wrapWithPostValidateCache. */
-export function wrapWithCache(loader) {
-    return {
-        getProduct: wrapWithGetProductCache(loader.getProduct.bind(loader)),
-        postValidate: wrapWithPostValidateCache(loader.postValidate.bind(loader)),
-    };
-}
+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());
+    });
+};
+import { PromiseCache } from "@configura/web-utilities";
+import { makeProductKey, makeSelOptionsKey, } from "./utilitiesCatalogueData.js";
+/**
+ * Wraps a getProduct function so that it caches for the time it lives.
+ *
+ * It has no cache invalidation or timeouts, so whatever ends up in the cache stays there
+ * indefinitely. For this reason we recommend using this with caution.
+ *
+ * In our Example App we use it to cache the internal calls in additional products as in such a
+ * product you tend to frequently get calls to same sub-product. Such as loading the same table leg
+ * four times.
+ */
+export function wrapWithGetProductCache(getProduct) {
+    const cache = new PromiseCache();
+    return (params) => __awaiter(this, void 0, void 0, function* () { return cache.get(makeProductKey(params, params.partNumber), () => getProduct(params)); });
+}
+/**
+ * Wraps a postValidate function so that it caches for the time it lives.
+ *
+ * It has no cache invalidation or timeouts, so whatever ends up in the cache stays there
+ * indefinitely. We recommend you do not use this unless you are really, really sure what you are
+ * doing.
+ *
+ * The SDK uses it for additional products to avoid validating for example the same table legs four
+ * times at the same time. There we make sure the this cache only stays in scope for one user
+ * interaction. No longer than the actions caused by a user clicking an option.
+ */
+export function wrapWithPostValidateCache(postValidate) {
+    const cache = new PromiseCache();
+    return (params, body) => __awaiter(this, void 0, void 0, function* () {
+        return cache.get(`${makeProductKey(params, params.partNumber)}-${makeSelOptionsKey(body.selOptions)}`, () => postValidate(params, body));
+    });
+}
+/** Does both wrapWithGetProductCache and wrapWithPostValidateCache. */
+export function wrapWithCache(loader) {
+    return {
+        getProduct: wrapWithGetProductCache(loader.getProduct.bind(loader)),
+        postValidate: wrapWithPostValidateCache(loader.postValidate.bind(loader)),
+    };
+}

package/dist/tasks/TaskHandler.d.ts

@@ -1,79 +1,79 @@
-import { Observable, SingleArgCallback } from "@configura/web-utilities";
-import { AdditionalProductConfiguration, CatalogueAPI, ExportStatus, ExportStatusStatus, PostExportParams, PostRenderParams, RenderStatus, RenderStatusStatus, TargetCameraArgs } from "../CatalogueAPI.js";
-import { CfgProduct } from "../CfgProduct.js";
-import { RenderOrExportFormat } from "./formats.js";
-export declare type TasksChangeNotification = {
-    freshRef: TaskHandler;
-};
-export declare type RenderTaskParams = {
-    targetCameraArgs?: TargetCameraArgs;
-    width: number;
-    height: number;
-};
-export declare type ProductParams = PostRenderParams | PostExportParams;
-export declare class _TaskHandlerInternal {
-    api: CatalogueAPI;
-    readonly changeObservable: Observable<TasksChangeNotification>;
-    readonly tasks: Task<RenderOrExportFormat>[];
-    constructor(api: CatalogueAPI);
-    _notifyAllOfChange: () => Promise<void>;
-    destroy: () => void;
-    get hasExport(): boolean;
-    get hasRender(): boolean;
-    get availableFormats(): RenderOrExportFormat[];
-    start: (format: RenderOrExportFormat, product: CfgProduct, renderParams: RenderTaskParams | undefined, getPreviewUrl: (() => Promise<string>) | undefined) => Promise<void>;
-    addTask(task: Task<RenderOrExportFormat>): void;
-    removeTask(task: Task<RenderOrExportFormat>): void;
-}
-export declare class TaskHandler {
-    private readonly _internal;
-    static make(api: CatalogueAPI): TaskHandler;
-    /**
-     * Makes an object wrapping the passed object. This is not a clone method,
-     * it is a method to make a new outer reference. Like a shallow copy.
-     * We use this to help frameworks that are build around using equals to detect change.
-     */
-    static _makeNewRefFrom(internal: _TaskHandlerInternal): TaskHandler;
-    private constructor();
-    destroy: () => void;
-    get tasks(): Task<RenderOrExportFormat>[];
-    get hasExport(): boolean;
-    get hasRender(): boolean;
-    get availableFormats(): RenderOrExportFormat[];
-    start: (format: RenderOrExportFormat, product: CfgProduct, renderParams?: RenderTaskParams | undefined, getPreviewUrl?: (() => Promise<string>) | undefined) => Promise<void>;
-    listenForChange: (l: SingleArgCallback<TasksChangeNotification>) => void;
-    stopListenForChange: (l: SingleArgCallback<TasksChangeNotification>) => void;
-}
-declare type TaskStatus = RenderStatusStatus | ExportStatusStatus | "abandoned";
-export declare abstract class Task<F extends RenderOrExportFormat> {
-    protected readonly taskHandler: _TaskHandlerInternal;
-    readonly format: F;
-    private _timerId;
-    protected constructor(taskHandler: _TaskHandlerInternal, format: F, product: CfgProduct, getPreviewUrl: (() => Promise<string>) | undefined);
-    protected abstract postInit(): Promise<RenderStatus | ExportStatus>;
-    protected abstract pollStatus(): Promise<RenderStatus | ExportStatus>;
-    protected _productParams: ProductParams;
-    protected _apiSelection: AdditionalProductConfiguration;
-    private _status;
-    private _uuid;
-    private _created;
-    private _modified;
-    private _url;
-    private _previewUrl;
-    private setStatus;
-    get status(): TaskStatus;
-    get uuid(): string;
-    get created(): string;
-    get modified(): string;
-    get url(): string | undefined;
-    get previewUrl(): string | undefined;
-    private _start;
-    protected startAndRegister: () => Promise<void>;
-    restart: () => Promise<void>;
-    private scheduleRefresh;
-    private refresh;
-    private stop;
-    abort: () => void;
-}
-export {};
+import { Observable, SingleArgCallback } from "@configura/web-utilities";
+import { AdditionalProductConfiguration, CatalogueAPI, ExportStatus, ExportStatusStatus, PostExportParams, PostRenderParams, RenderStatus, RenderStatusStatus, TargetCameraArgs } from "../CatalogueAPI.js";
+import { CfgProduct } from "../CfgProduct.js";
+import { RenderOrExportFormat } from "./formats.js";
+export declare type TasksChangeNotification = {
+    freshRef: TaskHandler;
+};
+export declare type RenderTaskParams = {
+    targetCameraArgs?: TargetCameraArgs;
+    width: number;
+    height: number;
+};
+export declare type ProductParams = PostRenderParams | PostExportParams;
+export declare class _TaskHandlerInternal {
+    api: CatalogueAPI;
+    readonly changeObservable: Observable<TasksChangeNotification>;
+    readonly tasks: Task<RenderOrExportFormat>[];
+    constructor(api: CatalogueAPI);
+    _notifyAllOfChange: () => Promise<void>;
+    destroy: () => void;
+    get hasExport(): boolean;
+    get hasRender(): boolean;
+    get availableFormats(): RenderOrExportFormat[];
+    start: (format: RenderOrExportFormat, product: CfgProduct, renderParams: RenderTaskParams | undefined, getPreviewUrl: (() => Promise<string>) | undefined) => Promise<void>;
+    addTask(task: Task<RenderOrExportFormat>): void;
+    removeTask(task: Task<RenderOrExportFormat>): void;
+}
+export declare class TaskHandler {
+    private readonly _internal;
+    static make(api: CatalogueAPI): TaskHandler;
+    /**
+     * Makes an object wrapping the passed object. This is not a clone method,
+     * it is a method to make a new outer reference. Like a shallow copy.
+     * We use this to help frameworks that are build around using equals to detect change.
+     */
+    static _makeNewRefFrom(internal: _TaskHandlerInternal): TaskHandler;
+    private constructor();
+    destroy: () => void;
+    get tasks(): Task<RenderOrExportFormat>[];
+    get hasExport(): boolean;
+    get hasRender(): boolean;
+    get availableFormats(): RenderOrExportFormat[];
+    start: (format: RenderOrExportFormat, product: CfgProduct, renderParams?: RenderTaskParams | undefined, getPreviewUrl?: (() => Promise<string>) | undefined) => Promise<void>;
+    listenForChange: (l: SingleArgCallback<TasksChangeNotification>) => void;
+    stopListenForChange: (l: SingleArgCallback<TasksChangeNotification>) => void;
+}
+declare type TaskStatus = RenderStatusStatus | ExportStatusStatus | "abandoned";
+export declare abstract class Task<F extends RenderOrExportFormat> {
+    protected readonly taskHandler: _TaskHandlerInternal;
+    readonly format: F;
+    private _timerId;
+    protected constructor(taskHandler: _TaskHandlerInternal, format: F, product: CfgProduct, getPreviewUrl: (() => Promise<string>) | undefined);
+    protected abstract postInit(): Promise<RenderStatus | ExportStatus>;
+    protected abstract pollStatus(): Promise<RenderStatus | ExportStatus>;
+    protected _productParams: ProductParams;
+    protected _apiSelection: AdditionalProductConfiguration;
+    private _status;
+    private _uuid;
+    private _created;
+    private _modified;
+    private _url;
+    private _previewUrl;
+    private setStatus;
+    get status(): TaskStatus;
+    get uuid(): string;
+    get created(): string;
+    get modified(): string;
+    get url(): string | undefined;
+    get previewUrl(): string | undefined;
+    private _start;
+    protected startAndRegister: () => Promise<void>;
+    restart: () => Promise<void>;
+    private scheduleRefresh;
+    private refresh;
+    private stop;
+    abort: () => void;
+}
+export {};
 //# sourceMappingURL=TaskHandler.d.ts.map