@configura/web-api 2.0.0-alpha.0 → 2.0.0-alpha.1

package/dist/tasks/TaskHandler.js

@@ -1,275 +1,275 @@
-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 { augmentErrorMessage, Observable } from "@configura/web-utilities";
-import { dtoExportFormatNames, dtoRenderFormatNames, } from "../CatalogueAPI.js";
-import { isExportFormat, isRenderFormat } from "./formats.js";
-export class _TaskHandlerInternal {
-    constructor(api) {
-        this.api = api;
-        this.changeObservable = new Observable();
-        this.tasks = [];
-        this._notifyAllOfChange = () => {
-            const freshRef = TaskHandler._makeNewRefFrom(this);
-            this.changeObservable.notifyAll({ freshRef });
-        };
-        this.destroy = () => {
-            this.changeObservable.stopAllListen();
-            for (const task of this.tasks) {
-                task.abort();
-            }
-        };
-        this.start = (format, product, renderParams, getPreviewUrl) => __awaiter(this, void 0, void 0, function* () {
-            if (isRenderFormat(format)) {
-                if (!this.hasRender) {
-                    throw new Error("Render has not been activated for this Catalogue");
-                }
-                if (renderParams === undefined) {
-                    throw new Error("renderParams must be set for render");
-                }
-                yield TaskRender.make(this, format, product, renderParams, getPreviewUrl);
-                return;
-            }
-            if (isExportFormat(format)) {
-                if (!this.hasExport) {
-                    throw new Error("Export has not been activated for this Catalogue");
-                }
-                yield TaskExport.make(this, format, product, getPreviewUrl);
-                return;
-            }
-            throw new Error("Unknown export format");
-        });
-    }
-    get hasExport() {
-        return this.api.hasFeature("export");
-    }
-    get hasRender() {
-        return this.api.hasFeature("render");
-    }
-    get availableFormats() {
-        const result = [];
-        if (this.hasExport) {
-            result.push(...dtoExportFormatNames);
-        }
-        if (this.hasRender) {
-            result.push(...dtoRenderFormatNames);
-        }
-        return result;
-    }
-    addTask(task) {
-        this.tasks.push(task);
-        this._notifyAllOfChange();
-    }
-    removeTask(task) {
-        const i = this.tasks.indexOf(task);
-        this.tasks.splice(i, 1);
-        this._notifyAllOfChange();
-    }
-}
-export class TaskHandler {
-    constructor(_internal) {
-        this._internal = _internal;
-        this.destroy = () => this._internal.destroy();
-        this.start = (format, product, renderParams, getPreviewUrl) => __awaiter(this, void 0, void 0, function* () { return this._internal.start(format, product, renderParams, getPreviewUrl); });
-        this.listenForChange = (l) => this._internal.changeObservable.listen(l);
-        this.stopListenForChange = (l) => this._internal.changeObservable.stopListen(l);
-    }
-    static make(api) {
-        return new this(new _TaskHandlerInternal(api));
-    }
-    /**
-     * 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) {
-        return new this(internal);
-    }
-    get tasks() {
-        return this._internal.tasks;
-    }
-    get hasExport() {
-        return this._internal.hasExport;
-    }
-    get hasRender() {
-        return this._internal.hasRender;
-    }
-    get availableFormats() {
-        return this._internal.availableFormats;
-    }
-}
-export class Task {
-    constructor(taskHandler, format, product, getPreviewUrl) {
-        this.taskHandler = taskHandler;
-        this.format = format;
-        this._status = "pending";
-        this._start = () => __awaiter(this, void 0, void 0, function* () {
-            const result = yield this.postInit();
-            this._uuid = result.uuid;
-            this._created = result.created;
-            this._modified = result.modified;
-            this.setStatus(result.status);
-            this.scheduleRefresh();
-        });
-        this.startAndRegister = () => __awaiter(this, void 0, void 0, function* () {
-            try {
-                yield this._start();
-                this.taskHandler.addTask(this);
-            }
-            catch (e) {
-                this.setStatus("failed");
-                throw e;
-            }
-        });
-        this.restart = () => __awaiter(this, void 0, void 0, function* () {
-            try {
-                this.stop();
-                this.setStatus("pending");
-                yield this._start();
-            }
-            catch (e) {
-                this.setStatus("failed");
-                throw e;
-            }
-        });
-        this.scheduleRefresh = () => {
-            this._timerId = setTimeout(this.refresh, 1000);
-        };
-        this.refresh = () => __awaiter(this, void 0, void 0, function* () {
-            try {
-                const result = yield this.pollStatus();
-                this._modified = result.modified;
-                const status = result.status;
-                switch (status) {
-                    case "finished": {
-                        const url = result.url;
-                        if (!url) {
-                            throw new Error("No URL from finished task");
-                        }
-                        this._url = url;
-                        break;
-                    }
-                    case "failed":
-                        break;
-                    case "running":
-                    case "pending":
-                        this.scheduleRefresh();
-                        break;
-                }
-                this.setStatus(status);
-            }
-            catch (e) {
-                this.setStatus("failed");
-                console.error(e);
-            }
-        });
-        this.abort = () => {
-            this._status = "abandoned";
-            this.stop();
-            this.taskHandler.removeTask(this);
-        };
-        this._productParams = product.prodParams;
-        this._apiSelection = product.getApiSelection();
-        if (getPreviewUrl !== undefined) {
-            void getPreviewUrl().then((dataUrl) => {
-                this._previewUrl = dataUrl;
-                this.taskHandler._notifyAllOfChange();
-            });
-        }
-    }
-    setStatus(status) {
-        const isChange = this._status !== status;
-        this._status = status;
-        if (isChange) {
-            this.taskHandler._notifyAllOfChange();
-        }
-    }
-    get status() {
-        return this._status;
-    }
-    get uuid() {
-        if (this._uuid === undefined) {
-            throw new Error("Should not happen");
-        }
-        return this._uuid;
-    }
-    get created() {
-        if (this._created === undefined) {
-            throw new Error("Should not happen");
-        }
-        return this._created;
-    }
-    get modified() {
-        if (this._modified === undefined) {
-            throw new Error("Should not happen");
-        }
-        return this._modified;
-    }
-    get url() {
-        return this._url;
-    }
-    get previewUrl() {
-        return this._previewUrl;
-    }
-    stop() {
-        clearInterval(this._timerId);
-    }
-}
-class TaskRender extends Task {
-    constructor(taskHandler, format, product, taskParams, getPreviewUrl) {
-        super(taskHandler, format, product, getPreviewUrl);
-        this.taskParams = taskParams;
-    }
-    static make(taskHandler, format, product, taskParams, getPreviewUrl) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const t = new TaskRender(taskHandler, format, product, taskParams, getPreviewUrl);
-            yield t.startAndRegister();
-            return t;
-        });
-    }
-    postInit() {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                return (yield this.taskHandler.api.postRender(this._productParams, Object.assign(Object.assign(Object.assign({}, this._apiSelection), this.taskParams), { format: this.format, width: Math.floor(this.taskParams.width), height: Math.floor(this.taskParams.height) }))).renderStatus;
-            }
-            catch (e) {
-                throw augmentErrorMessage(e, "Start render request failure");
-            }
-        });
-    }
-    pollStatus() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return (yield this.taskHandler.api.getRenderById({ uuid: this.uuid })).renderStatus;
-        });
-    }
-}
-class TaskExport extends Task {
-    static make(taskHandler, format, product, getPreviewUrl) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const t = new TaskExport(taskHandler, format, product, getPreviewUrl);
-            yield t.startAndRegister();
-            return t;
-        });
-    }
-    postInit() {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                return (yield this.taskHandler.api.postExport(this._productParams, Object.assign(Object.assign({}, this._apiSelection), { format: this.format, preferUnzipped: true }))).exportStatus;
-            }
-            catch (e) {
-                throw augmentErrorMessage(e, "Start export request failure");
-            }
-        });
-    }
-    pollStatus() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return (yield this.taskHandler.api.getExportById({ uuid: this.uuid })).exportStatus;
-        });
-    }
-}
+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 { augmentErrorMessage, Observable } from "@configura/web-utilities";
+import { dtoExportFormatNames, dtoRenderFormatNames, } from "../CatalogueAPI.js";
+import { isExportFormat, isRenderFormat } from "./formats.js";
+export class _TaskHandlerInternal {
+    constructor(api) {
+        this.api = api;
+        this.changeObservable = new Observable();
+        this.tasks = [];
+        this._notifyAllOfChange = () => {
+            const freshRef = TaskHandler._makeNewRefFrom(this);
+            this.changeObservable.notifyAll({ freshRef });
+        };
+        this.destroy = () => {
+            this.changeObservable.stopAllListen();
+            for (const task of this.tasks) {
+                task.abort();
+            }
+        };
+        this.start = (format, product, renderParams, getPreviewUrl) => __awaiter(this, void 0, void 0, function* () {
+            if (isRenderFormat(format)) {
+                if (!this.hasRender) {
+                    throw new Error("Render has not been activated for this Catalogue");
+                }
+                if (renderParams === undefined) {
+                    throw new Error("renderParams must be set for render");
+                }
+                yield TaskRender.make(this, format, product, renderParams, getPreviewUrl);
+                return;
+            }
+            if (isExportFormat(format)) {
+                if (!this.hasExport) {
+                    throw new Error("Export has not been activated for this Catalogue");
+                }
+                yield TaskExport.make(this, format, product, getPreviewUrl);
+                return;
+            }
+            throw new Error("Unknown export format");
+        });
+    }
+    get hasExport() {
+        return this.api.hasFeature("export");
+    }
+    get hasRender() {
+        return this.api.hasFeature("render");
+    }
+    get availableFormats() {
+        const result = [];
+        if (this.hasExport) {
+            result.push(...dtoExportFormatNames);
+        }
+        if (this.hasRender) {
+            result.push(...dtoRenderFormatNames);
+        }
+        return result;
+    }
+    addTask(task) {
+        this.tasks.push(task);
+        this._notifyAllOfChange();
+    }
+    removeTask(task) {
+        const i = this.tasks.indexOf(task);
+        this.tasks.splice(i, 1);
+        this._notifyAllOfChange();
+    }
+}
+export class TaskHandler {
+    constructor(_internal) {
+        this._internal = _internal;
+        this.destroy = () => this._internal.destroy();
+        this.start = (format, product, renderParams, getPreviewUrl) => __awaiter(this, void 0, void 0, function* () { return this._internal.start(format, product, renderParams, getPreviewUrl); });
+        this.listenForChange = (l) => this._internal.changeObservable.listen(l);
+        this.stopListenForChange = (l) => this._internal.changeObservable.stopListen(l);
+    }
+    static make(api) {
+        return new this(new _TaskHandlerInternal(api));
+    }
+    /**
+     * 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) {
+        return new this(internal);
+    }
+    get tasks() {
+        return this._internal.tasks;
+    }
+    get hasExport() {
+        return this._internal.hasExport;
+    }
+    get hasRender() {
+        return this._internal.hasRender;
+    }
+    get availableFormats() {
+        return this._internal.availableFormats;
+    }
+}
+export class Task {
+    constructor(taskHandler, format, product, getPreviewUrl) {
+        this.taskHandler = taskHandler;
+        this.format = format;
+        this._status = "pending";
+        this._start = () => __awaiter(this, void 0, void 0, function* () {
+            const result = yield this.postInit();
+            this._uuid = result.uuid;
+            this._created = result.created;
+            this._modified = result.modified;
+            this.setStatus(result.status);
+            this.scheduleRefresh();
+        });
+        this.startAndRegister = () => __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield this._start();
+                this.taskHandler.addTask(this);
+            }
+            catch (e) {
+                this.setStatus("failed");
+                throw e;
+            }
+        });
+        this.restart = () => __awaiter(this, void 0, void 0, function* () {
+            try {
+                this.stop();
+                this.setStatus("pending");
+                yield this._start();
+            }
+            catch (e) {
+                this.setStatus("failed");
+                throw e;
+            }
+        });
+        this.scheduleRefresh = () => {
+            this._timerId = setTimeout(this.refresh, 1000);
+        };
+        this.refresh = () => __awaiter(this, void 0, void 0, function* () {
+            try {
+                const result = yield this.pollStatus();
+                this._modified = result.modified;
+                const status = result.status;
+                switch (status) {
+                    case "finished": {
+                        const url = result.url;
+                        if (!url) {
+                            throw new Error("No URL from finished task");
+                        }
+                        this._url = url;
+                        break;
+                    }
+                    case "failed":
+                        break;
+                    case "running":
+                    case "pending":
+                        this.scheduleRefresh();
+                        break;
+                }
+                this.setStatus(status);
+            }
+            catch (e) {
+                this.setStatus("failed");
+                console.error(e);
+            }
+        });
+        this.abort = () => {
+            this._status = "abandoned";
+            this.stop();
+            this.taskHandler.removeTask(this);
+        };
+        this._productParams = product.prodParams;
+        this._apiSelection = product.getApiSelection();
+        if (getPreviewUrl !== undefined) {
+            void getPreviewUrl().then((dataUrl) => {
+                this._previewUrl = dataUrl;
+                this.taskHandler._notifyAllOfChange();
+            });
+        }
+    }
+    setStatus(status) {
+        const isChange = this._status !== status;
+        this._status = status;
+        if (isChange) {
+            this.taskHandler._notifyAllOfChange();
+        }
+    }
+    get status() {
+        return this._status;
+    }
+    get uuid() {
+        if (this._uuid === undefined) {
+            throw new Error("Should not happen");
+        }
+        return this._uuid;
+    }
+    get created() {
+        if (this._created === undefined) {
+            throw new Error("Should not happen");
+        }
+        return this._created;
+    }
+    get modified() {
+        if (this._modified === undefined) {
+            throw new Error("Should not happen");
+        }
+        return this._modified;
+    }
+    get url() {
+        return this._url;
+    }
+    get previewUrl() {
+        return this._previewUrl;
+    }
+    stop() {
+        clearInterval(this._timerId);
+    }
+}
+class TaskRender extends Task {
+    constructor(taskHandler, format, product, taskParams, getPreviewUrl) {
+        super(taskHandler, format, product, getPreviewUrl);
+        this.taskParams = taskParams;
+    }
+    static make(taskHandler, format, product, taskParams, getPreviewUrl) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const t = new TaskRender(taskHandler, format, product, taskParams, getPreviewUrl);
+            yield t.startAndRegister();
+            return t;
+        });
+    }
+    postInit() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                return (yield this.taskHandler.api.postRender(this._productParams, Object.assign(Object.assign(Object.assign({}, this._apiSelection), this.taskParams), { format: this.format, width: Math.floor(this.taskParams.width), height: Math.floor(this.taskParams.height) }))).renderStatus;
+            }
+            catch (e) {
+                throw augmentErrorMessage(e, "Start render request failure");
+            }
+        });
+    }
+    pollStatus() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (yield this.taskHandler.api.getRenderById({ uuid: this.uuid })).renderStatus;
+        });
+    }
+}
+class TaskExport extends Task {
+    static make(taskHandler, format, product, getPreviewUrl) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const t = new TaskExport(taskHandler, format, product, getPreviewUrl);
+            yield t.startAndRegister();
+            return t;
+        });
+    }
+    postInit() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                return (yield this.taskHandler.api.postExport(this._productParams, Object.assign(Object.assign({}, this._apiSelection), { format: this.format, preferUnzipped: true }))).exportStatus;
+            }
+            catch (e) {
+                throw augmentErrorMessage(e, "Start export request failure");
+            }
+        });
+    }
+    pollStatus() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (yield this.taskHandler.api.getExportById({ uuid: this.uuid })).exportStatus;
+        });
+    }
+}

package/dist/tasks/formats.d.ts

@@ -1,5 +1,5 @@
-import { DtoExportFormat, DtoRenderFormat } from "../CatalogueAPI.js";
-export declare type RenderOrExportFormat = DtoRenderFormat | DtoExportFormat;
-export declare function isRenderFormat(type: unknown): type is DtoRenderFormat;
-export declare function isExportFormat(type: unknown): type is DtoExportFormat;
+import { DtoExportFormat, DtoRenderFormat } from "../CatalogueAPI.js";
+export declare type RenderOrExportFormat = DtoRenderFormat | DtoExportFormat;
+export declare function isRenderFormat(type: unknown): type is DtoRenderFormat;
+export declare function isExportFormat(type: unknown): type is DtoExportFormat;
 //# sourceMappingURL=formats.d.ts.map

package/dist/tasks/formats.js

@@ -1,7 +1,7 @@
-import { dtoExportFormatNames, dtoRenderFormatNames, } from "../CatalogueAPI.js";
-export function isRenderFormat(type) {
-    return dtoRenderFormatNames.some((f) => type === f);
-}
-export function isExportFormat(type) {
-    return dtoExportFormatNames.some((f) => type === f);
-}
+import { dtoExportFormatNames, dtoRenderFormatNames, } from "../CatalogueAPI.js";
+export function isRenderFormat(type) {
+    return dtoRenderFormatNames.some((f) => type === f);
+}
+export function isExportFormat(type) {
+    return dtoExportFormatNames.some((f) => type === f);
+}