typedrest 0.4.1 → 0.6.0

package/endpoints/generic/{ElementEndpoint.ts → ElementEndpoint.d.ts}

@@ -1,31 +1,20 @@
 import { ETagEndpointBase } from "./ETagEndpointBase";
 import { Endpoint } from "../Endpoint";
-import { HttpMethod, HttpHeader, HttpStatusCode } from "../../http";
-import { ConcurrencyError } from "../../errors";
-
 /**
  * Endpoint for an individual resource.
  * @typeParam TEntity The type of entity the endpoint represents.
  */
-export class ElementEndpoint<TEntity> extends ETagEndpointBase {
+export declare class ElementEndpoint<TEntity> extends ETagEndpointBase {
     /**
      * Creates a new element endpoint.
      * @param referrer The endpoint used to navigate to this one.
      * @param relativeUri The URI of this endpoint relative to the `referrer`'s. Add a `./` prefix here to imply a trailing slash in the `referrer`'s URI.
      */
-    constructor(referrer: Endpoint, relativeUri: URL | string) {
-        super(referrer, relativeUri);
-    }
-
+    constructor(referrer: Endpoint, relativeUri: URL | string);
     /**
      * A cached copy of the entity as received from the server.
      */
-    public get response(): TEntity | undefined {
-        return this.responseCache
-            ? this.serializer.deserialize<TEntity>(this.responseCache.content)
-            : undefined;
-    }
-
+    get response(): TEntity | undefined;
     /**
      * Returns the `TEntity`.
      * @param signal Used to cancel the request.
@@ -34,10 +23,7 @@ export class ElementEndpoint<TEntity> extends ETagEndpointBase {
      * @throws {@link errors!NotFoundError}: {@link http!HttpStatusCode.NotFound} or {@link http!HttpStatusCode.Gone}
      * @throws {@link errors!HttpError}: Other non-success status code
      */
-    async read(signal?: AbortSignal) {
-        return this.serializer.deserialize<TEntity>(await this.getContent(signal));
-    }
-
+    read(signal?: AbortSignal): Promise<TEntity>;
     /**
      * Determines whether the element currently exists.
      * @param signal Used to cancel the request.
@@ -45,22 +31,13 @@ export class ElementEndpoint<TEntity> extends ETagEndpointBase {
      * @throws {@link errors!AuthorizationError}: {@link http!HttpStatusCode.Forbidden}
      * @throws {@link errors!HttpError}: Other non-success status code
      */
-    async exists(signal?: AbortSignal) {
-        const response = await this.httpClient.send(this.uri, HttpMethod.Head, signal);
-        if (response.ok) return true;
-        if (response.status === HttpStatusCode.NotFound || response.status === HttpStatusCode.Gone) return false;
-
-        await this.errorHandler.handle(response);
-        return false;
-    }
-
+    exists(signal?: AbortSignal): Promise<boolean>;
     /**
      * Shows whether the server has indicated that {@link set} is currently allowed.
      * Uses cached data from last response.
      * @returns `true` if the method is allowed, `false` if the method is not allowed, `undefined` if no request has been sent yet or the server did not specify allowed methods.
      */
-    get setAllowed() { return this.isMethodAllowed(HttpMethod.Put); }
-
+    get setAllowed(): boolean | undefined;
     /**
      * Sets/replaces the `TEntity`.
      * @param entity The new `TEntity`.
@@ -73,21 +50,13 @@ export class ElementEndpoint<TEntity> extends ETagEndpointBase {
      * @throws {@link errors!NotFoundError}: {@link http!HttpStatusCode.NotFound} or {@link http!HttpStatusCode.Gone}
      * @throws {@link errors!HttpError}: Other non-success status code
      */
-    async set(entity: TEntity, signal?: AbortSignal): Promise<(TEntity | undefined)> {
-        const response = await this.putContent(entity, signal);
-        const text = await response.text();
-        if (text) {
-            return this.serializer.deserialize<TEntity>(text);
-        }
-    }
-
+    set(entity: TEntity, signal?: AbortSignal): Promise<(TEntity | undefined)>;
     /**
      * Shows whether the server has indicated that {@link merge} is currently allowed.
      * Uses cached data from last response.
      * @returns `true` if the method is allowed, `false` if the method is not allowed, `undefined` if no request has been sent yet or the server did not specify allowed methods.
      */
-    get mergeAllowed() { return this.isMethodAllowed(HttpMethod.Patch); }
-
+    get mergeAllowed(): boolean | undefined;
     /**
      * Modifies an existing `TEntity` by merging changes on the server-side.
      * @param entity The `TEntity` data to merge with the existing element.
@@ -100,18 +69,7 @@ export class ElementEndpoint<TEntity> extends ETagEndpointBase {
      * @throws {@link errors!NotFoundError}: {@link http!HttpStatusCode.NotFound} or {@link http!HttpStatusCode.Gone}
      * @throws {@link errors!HttpError}: Other non-success status code
      */
-    async merge(entity: TEntity, signal?: AbortSignal): Promise<(TEntity | undefined)> {
-        this.responseCache = undefined;
-        const response = await this.send(HttpMethod.Patch, signal, {
-            [HttpHeader.ContentType]: this.serializer.supportedMediaTypes[0]
-        }, this.serializer.serialize(entity));
-
-        const text = await response.text();
-        if (text) {
-            return this.serializer.deserialize<TEntity>(text);
-        }
-    }
-
+    merge(entity: TEntity, signal?: AbortSignal): Promise<(TEntity | undefined)>;
     /**
      * Reads the current state of the entity, applies a change to it and stores the result. Applies optimistic concurrency using automatic retries.
      * @param updateAction A callback that takes the current state of the entity and applies the desired modifications.
@@ -125,27 +83,13 @@ export class ElementEndpoint<TEntity> extends ETagEndpointBase {
      * @throws {@link errors!NotFoundError}: {@link http!HttpStatusCode.NotFound} or {@link http!HttpStatusCode.Gone}
      * @throws {@link errors!HttpError}: Other non-success status code
      */
-    async update(updateAction: (entity: TEntity) => void, maxRetries: number = 3, signal?: AbortSignal): Promise<(TEntity | undefined)> {
-        let retryCounter = 0;
-        while (true) {
-            const entity = await this.read(signal);
-            updateAction(entity);
-            try {
-                return await this.set(entity, signal);
-            } catch (err) {
-                if (retryCounter++ >= maxRetries || !(err instanceof ConcurrencyError))
-                    throw err;
-            }
-        }
-    }
-
+    update(updateAction: (entity: TEntity) => void, maxRetries?: number, signal?: AbortSignal): Promise<(TEntity | undefined)>;
     /**
      * Shows whether the server has indicated that {@link delete} is currently allowed.
      * Uses cached data from last response.
      * @returns `true` if the method is allowed, `false` if the method is not allowed, `undefined` if no request has been sent yet or the server did not specify allowed methods.
      */
-    get deleteAllowed() { return this.isMethodAllowed(HttpMethod.Delete); }
-
+    get deleteAllowed(): boolean | undefined;
     /**
      * Deletes the element.
      * @param signal Used to cancel the request.
@@ -155,7 +99,5 @@ export class ElementEndpoint<TEntity> extends ETagEndpointBase {
      * @throws {@link errors!NotFoundError}: {@link http!HttpStatusCode.NotFound} or {@link http!HttpStatusCode.Gone}
      * @throws {@link errors!HttpError}: Other non-success status code
      */
-    async delete(signal?: AbortSignal) {
-        await this.deleteContent(signal);
-    }
+    delete(signal?: AbortSignal): Promise<void>;
 }

package/endpoints/generic/ElementEndpoint.js

@@ -1,13 +1,4 @@
 "use strict";
-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());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ElementEndpoint = void 0;
 const ETagEndpointBase_1 = require("./ETagEndpointBase");
@@ -42,10 +33,8 @@ class ElementEndpoint extends ETagEndpointBase_1.ETagEndpointBase {
      * @throws {@link errors!NotFoundError}: {@link http!HttpStatusCode.NotFound} or {@link http!HttpStatusCode.Gone}
      * @throws {@link errors!HttpError}: Other non-success status code
      */
-    read(signal) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.serializer.deserialize(yield this.getContent(signal));
-        });
+    async read(signal) {
+        return this.serializer.deserialize(await this.getContent(signal));
     }
     /**
      * Determines whether the element currently exists.
@@ -54,16 +43,14 @@ class ElementEndpoint extends ETagEndpointBase_1.ETagEndpointBase {
      * @throws {@link errors!AuthorizationError}: {@link http!HttpStatusCode.Forbidden}
      * @throws {@link errors!HttpError}: Other non-success status code
      */
-    exists(signal) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.httpClient.send(this.uri, http_1.HttpMethod.Head, signal);
-            if (response.ok)
-                return true;
-            if (response.status === http_1.HttpStatusCode.NotFound || response.status === http_1.HttpStatusCode.Gone)
-                return false;
-            yield this.errorHandler.handle(response);
+    async exists(signal) {
+        const response = await this.httpClient.send(this.uri, http_1.HttpMethod.Head, signal);
+        if (response.ok)
+            return true;
+        if (response.status === http_1.HttpStatusCode.NotFound || response.status === http_1.HttpStatusCode.Gone)
             return false;
-        });
+        await this.errorHandler.handle(response);
+        return false;
     }
     /**
      * Shows whether the server has indicated that {@link set} is currently allowed.
@@ -83,14 +70,12 @@ class ElementEndpoint extends ETagEndpointBase_1.ETagEndpointBase {
      * @throws {@link errors!NotFoundError}: {@link http!HttpStatusCode.NotFound} or {@link http!HttpStatusCode.Gone}
      * @throws {@link errors!HttpError}: Other non-success status code
      */
-    set(entity, signal) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.putContent(entity, signal);
-            const text = yield response.text();
-            if (text) {
-                return this.serializer.deserialize(text);
-            }
-        });
+    async set(entity, signal) {
+        const response = await this.putContent(entity, signal);
+        const text = await response.text();
+        if (text) {
+            return this.serializer.deserialize(text);
+        }
     }
     /**
      * Shows whether the server has indicated that {@link merge} is currently allowed.
@@ -110,17 +95,15 @@ class ElementEndpoint extends ETagEndpointBase_1.ETagEndpointBase {
      * @throws {@link errors!NotFoundError}: {@link http!HttpStatusCode.NotFound} or {@link http!HttpStatusCode.Gone}
      * @throws {@link errors!HttpError}: Other non-success status code
      */
-    merge(entity, signal) {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.responseCache = undefined;
-            const response = yield this.send(http_1.HttpMethod.Patch, signal, {
-                [http_1.HttpHeader.ContentType]: this.serializer.supportedMediaTypes[0]
-            }, this.serializer.serialize(entity));
-            const text = yield response.text();
-            if (text) {
-                return this.serializer.deserialize(text);
-            }
-        });
+    async merge(entity, signal) {
+        this.responseCache = undefined;
+        const response = await this.send(http_1.HttpMethod.Patch, signal, {
+            [http_1.HttpHeader.ContentType]: this.serializer.supportedMediaTypes[0]
+        }, this.serializer.serialize(entity));
+        const text = await response.text();
+        if (text) {
+            return this.serializer.deserialize(text);
+        }
     }
     /**
      * Reads the current state of the entity, applies a change to it and stores the result. Applies optimistic concurrency using automatic retries.
@@ -135,21 +118,19 @@ class ElementEndpoint extends ETagEndpointBase_1.ETagEndpointBase {
      * @throws {@link errors!NotFoundError}: {@link http!HttpStatusCode.NotFound} or {@link http!HttpStatusCode.Gone}
      * @throws {@link errors!HttpError}: Other non-success status code
      */
-    update(updateAction_1) {
-        return __awaiter(this, arguments, void 0, function* (updateAction, maxRetries = 3, signal) {
-            let retryCounter = 0;
-            while (true) {
-                const entity = yield this.read(signal);
-                updateAction(entity);
-                try {
-                    return yield this.set(entity, signal);
-                }
-                catch (err) {
-                    if (retryCounter++ >= maxRetries || !(err instanceof errors_1.ConcurrencyError))
-                        throw err;
-                }
+    async update(updateAction, maxRetries = 3, signal) {
+        let retryCounter = 0;
+        while (true) {
+            const entity = await this.read(signal);
+            updateAction(entity);
+            try {
+                return await this.set(entity, signal);
+            }
+            catch (err) {
+                if (retryCounter++ >= maxRetries || !(err instanceof errors_1.ConcurrencyError))
+                    throw err;
             }
-        });
+        }
     }
     /**
      * Shows whether the server has indicated that {@link delete} is currently allowed.
@@ -166,11 +147,9 @@ class ElementEndpoint extends ETagEndpointBase_1.ETagEndpointBase {
      * @throws {@link errors!NotFoundError}: {@link http!HttpStatusCode.NotFound} or {@link http!HttpStatusCode.Gone}
      * @throws {@link errors!HttpError}: Other non-success status code
      */
-    delete(signal) {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.deleteContent(signal);
-        });
+    async delete(signal) {
+        await this.deleteContent(signal);
     }
 }
 exports.ElementEndpoint = ElementEndpoint;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRWxlbWVudEVuZHBvaW50LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiRWxlbWVudEVuZHBvaW50LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7OztBQUFBLHlEQUFzRDtBQUV0RCxxQ0FBb0U7QUFDcEUseUNBQWdEO0FBRWhEOzs7R0FHRztBQUNILE1BQWEsZUFBeUIsU0FBUSxtQ0FBZ0I7SUFDMUQ7Ozs7T0FJRztJQUNILFlBQVksUUFBa0IsRUFBRSxXQUF5QjtRQUNyRCxLQUFLLENBQUMsUUFBUSxFQUFFLFdBQVcsQ0FBQyxDQUFDO0lBQ2pDLENBQUM7SUFFRDs7T0FFRztJQUNILElBQVcsUUFBUTtRQUNmLE9BQU8sSUFBSSxDQUFDLGFBQWE7WUFDckIsQ0FBQyxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsV0FBVyxDQUFVLElBQUksQ0FBQyxhQUFhLENBQUMsT0FBTyxDQUFDO1lBQ2xFLENBQUMsQ0FBQyxTQUFTLENBQUM7SUFDcEIsQ0FBQztJQUVEOzs7Ozs7O09BT0c7SUFDRyxJQUFJLENBQUMsTUFBb0I7O1lBQzNCLE9BQU8sSUFBSSxDQUFDLFVBQVUsQ0FBQyxXQUFXLENBQVUsTUFBTSxJQUFJLENBQUMsVUFBVSxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUM7UUFDL0UsQ0FBQztLQUFBO0lBRUQ7Ozs7OztPQU1HO0lBQ0csTUFBTSxDQUFDLE1BQW9COztZQUM3QixNQUFNLFFBQVEsR0FBRyxNQUFNLElBQUksQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxHQUFHLEVBQUUsaUJBQVUsQ0FBQyxJQUFJLEVBQUUsTUFBTSxDQUFDLENBQUM7WUFDL0UsSUFBSSxRQUFRLENBQUMsRUFBRTtnQkFBRSxPQUFPLElBQUksQ0FBQztZQUM3QixJQUFJLFFBQVEsQ0FBQyxNQUFNLEtBQUsscUJBQWMsQ0FBQyxRQUFRLElBQUksUUFBUSxDQUFDLE1BQU0sS0FBSyxxQkFBYyxDQUFDLElBQUk7Z0JBQUUsT0FBTyxLQUFLLENBQUM7WUFFekcsTUFBTSxJQUFJLENBQUMsWUFBWSxDQUFDLE1BQU0sQ0FBQyxRQUFRLENBQUMsQ0FBQztZQUN6QyxPQUFPLEtBQUssQ0FBQztRQUNqQixDQUFDO0tBQUE7SUFFRDs7OztPQUlHO0lBQ0gsSUFBSSxVQUFVLEtBQUssT0FBTyxJQUFJLENBQUMsZUFBZSxDQUFDLGlCQUFVLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBRWpFOzs7Ozs7Ozs7OztPQVdHO0lBQ0csR0FBRyxDQUFDLE1BQWUsRUFBRSxNQUFvQjs7WUFDM0MsTUFBTSxRQUFRLEdBQUcsTUFBTSxJQUFJLENBQUMsVUFBVSxDQUFDLE1BQU0sRUFBRSxNQUFNLENBQUMsQ0FBQztZQUN2RCxNQUFNLElBQUksR0FBRyxNQUFNLFFBQVEsQ0FBQyxJQUFJLEVBQUUsQ0FBQztZQUNuQyxJQUFJLElBQUksRUFBRSxDQUFDO2dCQUNQLE9BQU8sSUFBSSxDQUFDLFVBQVUsQ0FBQyxXQUFXLENBQVUsSUFBSSxDQUFDLENBQUM7WUFDdEQsQ0FBQztRQUNMLENBQUM7S0FBQTtJQUVEOzs7O09BSUc7SUFDSCxJQUFJLFlBQVksS0FBSyxPQUFPLElBQUksQ0FBQyxlQUFlLENBQUMsaUJBQVUsQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFFckU7Ozs7Ozs7Ozs7O09BV0c7SUFDRyxLQUFLLENBQUMsTUFBZSxFQUFFLE1BQW9COztZQUM3QyxJQUFJLENBQUMsYUFBYSxHQUFHLFNBQVMsQ0FBQztZQUMvQixNQUFNLFFBQVEsR0FBRyxNQUFNLElBQUksQ0FBQyxJQUFJLENBQUMsaUJBQVUsQ0FBQyxLQUFLLEVBQUUsTUFBTSxFQUFFO2dCQUN2RCxDQUFDLGlCQUFVLENBQUMsV0FBVyxDQUFDLEVBQUUsSUFBSSxDQUFDLFVBQVUsQ0FBQyxtQkFBbUIsQ0FBQyxDQUFDLENBQUM7YUFDbkUsRUFBRSxJQUFJLENBQUMsVUFBVSxDQUFDLFNBQVMsQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDO1lBRXRDLE1BQU0sSUFBSSxHQUFHLE1BQU0sUUFBUSxDQUFDLElBQUksRUFBRSxDQUFDO1lBQ25DLElBQUksSUFBSSxFQUFFLENBQUM7Z0JBQ1AsT0FBTyxJQUFJLENBQUMsVUFBVSxDQUFDLFdBQVcsQ0FBVSxJQUFJLENBQUMsQ0FBQztZQUN0RCxDQUFDO1FBQ0wsQ0FBQztLQUFBO0lBRUQ7Ozs7Ozs7Ozs7OztPQVlHO0lBQ0csTUFBTTs2REFBQyxZQUF1QyxFQUFFLGFBQXFCLENBQUMsRUFBRSxNQUFvQjtZQUM5RixJQUFJLFlBQVksR0FBRyxDQUFDLENBQUM7WUFDckIsT0FBTyxJQUFJLEVBQUUsQ0FBQztnQkFDVixNQUFNLE1BQU0sR0FBRyxNQUFNLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLENBQUM7Z0JBQ3ZDLFlBQVksQ0FBQyxNQUFNLENBQUMsQ0FBQztnQkFDckIsSUFBSSxDQUFDO29CQUNELE9BQU8sTUFBTSxJQUFJLENBQUMsR0FBRyxDQUFDLE1BQU0sRUFBRSxNQUFNLENBQUMsQ0FBQztnQkFDMUMsQ0FBQztnQkFBQyxPQUFPLEdBQUcsRUFBRSxDQUFDO29CQUNYLElBQUksWUFBWSxFQUFFLElBQUksVUFBVSxJQUFJLENBQUMsQ0FBQyxHQUFHLFlBQVkseUJBQWdCLENBQUM7d0JBQ2xFLE1BQU0sR0FBRyxDQUFDO2dCQUNsQixDQUFDO1lBQ0wsQ0FBQztRQUNMLENBQUM7S0FBQTtJQUVEOzs7O09BSUc7SUFDSCxJQUFJLGFBQWEsS0FBSyxPQUFPLElBQUksQ0FBQyxlQUFlLENBQUMsaUJBQVUsQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFFdkU7Ozs7Ozs7O09BUUc7SUFDRyxNQUFNLENBQUMsTUFBb0I7O1lBQzdCLE1BQU0sSUFBSSxDQUFDLGFBQWEsQ0FBQyxNQUFNLENBQUMsQ0FBQztRQUNyQyxDQUFDO0tBQUE7Q0FDSjtBQXZKRCwwQ0F1SkMifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRWxlbWVudEVuZHBvaW50LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiRWxlbWVudEVuZHBvaW50LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBLHlEQUFzRDtBQUV0RCxxQ0FBb0U7QUFDcEUseUNBQWdEO0FBRWhEOzs7R0FHRztBQUNILE1BQWEsZUFBeUIsU0FBUSxtQ0FBZ0I7SUFDMUQ7Ozs7T0FJRztJQUNILFlBQVksUUFBa0IsRUFBRSxXQUF5QjtRQUNyRCxLQUFLLENBQUMsUUFBUSxFQUFFLFdBQVcsQ0FBQyxDQUFDO0lBQ2pDLENBQUM7SUFFRDs7T0FFRztJQUNILElBQVcsUUFBUTtRQUNmLE9BQU8sSUFBSSxDQUFDLGFBQWE7WUFDckIsQ0FBQyxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsV0FBVyxDQUFVLElBQUksQ0FBQyxhQUFhLENBQUMsT0FBTyxDQUFDO1lBQ2xFLENBQUMsQ0FBQyxTQUFTLENBQUM7SUFDcEIsQ0FBQztJQUVEOzs7Ozs7O09BT0c7SUFDSCxLQUFLLENBQUMsSUFBSSxDQUFDLE1BQW9CO1FBQzNCLE9BQU8sSUFBSSxDQUFDLFVBQVUsQ0FBQyxXQUFXLENBQVUsTUFBTSxJQUFJLENBQUMsVUFBVSxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUM7SUFDL0UsQ0FBQztJQUVEOzs7Ozs7T0FNRztJQUNILEtBQUssQ0FBQyxNQUFNLENBQUMsTUFBb0I7UUFDN0IsTUFBTSxRQUFRLEdBQUcsTUFBTSxJQUFJLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsR0FBRyxFQUFFLGlCQUFVLENBQUMsSUFBSSxFQUFFLE1BQU0sQ0FBQyxDQUFDO1FBQy9FLElBQUksUUFBUSxDQUFDLEVBQUU7WUFBRSxPQUFPLElBQUksQ0FBQztRQUM3QixJQUFJLFFBQVEsQ0FBQyxNQUFNLEtBQUsscUJBQWMsQ0FBQyxRQUFRLElBQUksUUFBUSxDQUFDLE1BQU0sS0FBSyxxQkFBYyxDQUFDLElBQUk7WUFBRSxPQUFPLEtBQUssQ0FBQztRQUV6RyxNQUFNLElBQUksQ0FBQyxZQUFZLENBQUMsTUFBTSxDQUFDLFFBQVEsQ0FBQyxDQUFDO1FBQ3pDLE9BQU8sS0FBSyxDQUFDO0lBQ2pCLENBQUM7SUFFRDs7OztPQUlHO0lBQ0gsSUFBSSxVQUFVLEtBQUssT0FBTyxJQUFJLENBQUMsZUFBZSxDQUFDLGlCQUFVLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBRWpFOzs7Ozs7Ozs7OztPQVdHO0lBQ0gsS0FBSyxDQUFDLEdBQUcsQ0FBQyxNQUFlLEVBQUUsTUFBb0I7UUFDM0MsTUFBTSxRQUFRLEdBQUcsTUFBTSxJQUFJLENBQUMsVUFBVSxDQUFDLE1BQU0sRUFBRSxNQUFNLENBQUMsQ0FBQztRQUN2RCxNQUFNLElBQUksR0FBRyxNQUFNLFFBQVEsQ0FBQyxJQUFJLEVBQUUsQ0FBQztRQUNuQyxJQUFJLElBQUksRUFBRSxDQUFDO1lBQ1AsT0FBTyxJQUFJLENBQUMsVUFBVSxDQUFDLFdBQVcsQ0FBVSxJQUFJLENBQUMsQ0FBQztRQUN0RCxDQUFDO0lBQ0wsQ0FBQztJQUVEOzs7O09BSUc7SUFDSCxJQUFJLFlBQVksS0FBSyxPQUFPLElBQUksQ0FBQyxlQUFlLENBQUMsaUJBQVUsQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFFckU7Ozs7Ozs7Ozs7O09BV0c7SUFDSCxLQUFLLENBQUMsS0FBSyxDQUFDLE1BQWUsRUFBRSxNQUFvQjtRQUM3QyxJQUFJLENBQUMsYUFBYSxHQUFHLFNBQVMsQ0FBQztRQUMvQixNQUFNLFFBQVEsR0FBRyxNQUFNLElBQUksQ0FBQyxJQUFJLENBQUMsaUJBQVUsQ0FBQyxLQUFLLEVBQUUsTUFBTSxFQUFFO1lBQ3ZELENBQUMsaUJBQVUsQ0FBQyxXQUFXLENBQUMsRUFBRSxJQUFJLENBQUMsVUFBVSxDQUFDLG1CQUFtQixDQUFDLENBQUMsQ0FBQztTQUNuRSxFQUFFLElBQUksQ0FBQyxVQUFVLENBQUMsU0FBUyxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUM7UUFFdEMsTUFBTSxJQUFJLEdBQUcsTUFBTSxRQUFRLENBQUMsSUFBSSxFQUFFLENBQUM7UUFDbkMsSUFBSSxJQUFJLEVBQUUsQ0FBQztZQUNQLE9BQU8sSUFBSSxDQUFDLFVBQVUsQ0FBQyxXQUFXLENBQVUsSUFBSSxDQUFDLENBQUM7UUFDdEQsQ0FBQztJQUNMLENBQUM7SUFFRDs7Ozs7Ozs7Ozs7O09BWUc7SUFDSCxLQUFLLENBQUMsTUFBTSxDQUFDLFlBQXVDLEVBQUUsYUFBcUIsQ0FBQyxFQUFFLE1BQW9CO1FBQzlGLElBQUksWUFBWSxHQUFHLENBQUMsQ0FBQztRQUNyQixPQUFPLElBQUksRUFBRSxDQUFDO1lBQ1YsTUFBTSxNQUFNLEdBQUcsTUFBTSxJQUFJLENBQUMsSUFBSSxDQUFDLE1BQU0sQ0FBQyxDQUFDO1lBQ3ZDLFlBQVksQ0FBQyxNQUFNLENBQUMsQ0FBQztZQUNyQixJQUFJLENBQUM7Z0JBQ0QsT0FBTyxNQUFNLElBQUksQ0FBQyxHQUFHLENBQUMsTUFBTSxFQUFFLE1BQU0sQ0FBQyxDQUFDO1lBQzFDLENBQUM7WUFBQyxPQUFPLEdBQUcsRUFBRSxDQUFDO2dCQUNYLElBQUksWUFBWSxFQUFFLElBQUksVUFBVSxJQUFJLENBQUMsQ0FBQyxHQUFHLFlBQVkseUJBQWdCLENBQUM7b0JBQ2xFLE1BQU0sR0FBRyxDQUFDO1lBQ2xCLENBQUM7UUFDTCxDQUFDO0lBQ0wsQ0FBQztJQUVEOzs7O09BSUc7SUFDSCxJQUFJLGFBQWEsS0FBSyxPQUFPLElBQUksQ0FBQyxlQUFlLENBQUMsaUJBQVUsQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFFdkU7Ozs7Ozs7O09BUUc7SUFDSCxLQUFLLENBQUMsTUFBTSxDQUFDLE1BQW9CO1FBQzdCLE1BQU0sSUFBSSxDQUFDLGFBQWEsQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUNyQyxDQUFDO0NBQ0o7QUF2SkQsMENBdUpDIn0=

package/endpoints/generic/{GenericCollectionEndpoint.ts → GenericCollectionEndpoint.d.ts}

@@ -1,53 +1,33 @@
 import { ETagEndpointBase } from "./ETagEndpointBase";
 import { ElementEndpoint } from "./ElementEndpoint";
+import { PartialResponse } from "./PartialResponse";
 import { Endpoint } from "../Endpoint";
-import { CachingEndpoint } from "../CachingEndpoint";
-import { HttpMethod, HttpHeader, ResponseCache } from "../../http";
-
 /**
  * Endpoint for a collection of `TEntity`s addressable as `TElementEndpoint`s.<br>
  * Use {@link CollectionEndpoint} instead if you wish to use the default {@link ElementEndpoint} type.
  * @typeParam TEntity The type of individual elements in the collection.
  * @typeParam TElementEndpoint The type of {@link ElementEndpoint} to provide for individual `TEntity`s.
  */
-export class GenericCollectionEndpoint<TEntity, TElementEndpoint extends ElementEndpoint<TEntity>> extends ETagEndpointBase {
+export declare class GenericCollectionEndpoint<TEntity, TElementEndpoint extends ElementEndpoint<TEntity>> extends ETagEndpointBase {
+    private readonly elementEndpoint;
     /**
      * Creates a new collection endpoint.
      * @param referrer The endpoint used to navigate to this one.
      * @param relativeUri The URI of this endpoint relative to the `referrer`'s. Add a `./` prefix here to imply a trailing slash in the `referrer`'s URI.
      * @param elementEndpoint A factory method for creating instances of `TElementEndpoint`.
      */
-    constructor(referrer: Endpoint, relativeUri: URL | string, private readonly elementEndpoint: new (referrer: Endpoint, uri: URL) => TElementEndpoint) {
-        super(referrer, relativeUri);
-        this.setDefaultLinkTemplate("child", "./{id}");
-    }
-
+    constructor(referrer: Endpoint, relativeUri: URL | string, elementEndpoint: new (referrer: Endpoint, uri: URL) => TElementEndpoint);
     /**
      * Returns an `TElementEndpoint` for a specific child element.
      * @param element The ID identifying the entity or an entity to extract the ID from.
      */
-    get(element: (TEntity | string)): TElementEndpoint {
-        if (element == null) throw new Error("element must not be null or unspecified.");
-
-        let id: string;
-        if (typeof element === "string") {
-            id = element;
-        } else {
-            id = (element as any).id;
-            if (id === undefined) throw new Error(`Element ${element} does not have an id property.`);
-        }
-        if (id == null || id === "") throw new Error("id must not be null or empty.");
-
-        return new this.elementEndpoint(this, this.linkTemplate("child", { id }));
-    }
-
+    get(element: (TEntity | string)): TElementEndpoint;
     /**
      * Shows whether the server has indicated that {@link readAll} is currently allowed.
      * Uses cached data from last response.
      * @returns `true` if the method is allowed, `false` if the method is not allowed, `undefined` if no request has been sent yet or the server did not specify allowed methods.
      */
-    get readAllAllowed() { return this.isMethodAllowed(HttpMethod.Get); }
-
+    get readAllAllowed(): boolean | undefined;
     /**
      * Returns all `TEntity`s in the collection.
      * @param signal Used to cancel the request.
@@ -56,17 +36,39 @@ export class GenericCollectionEndpoint<TEntity, TElementEndpoint extends Element
      * @throws {@link errors!ConflictError}: {@link http!HttpStatusCode.Conflict}
      * @throws {@link errors!HttpError}: Other non-success status code
      */
-    async readAll(signal?: AbortSignal) {
-        return this.serializer.deserialize<TEntity[]>(await this.getContent(signal));
-    }
-
+    readAll(signal?: AbortSignal): Promise<TEntity[]>;
+    /**
+     * The unit used when requesting ranges of elements. Sent in the {@link http!HttpHeader.Range} header.
+     */
+    rangeUnit: string;
+    private acceptedRangeUnits;
+    /**
+     * @inheritDoc
+     */
+    protected handleCapabilities(response: Response): void;
+    /**
+     * Shows whether the server has indicated that {@link readRange} is currently allowed.
+     * Uses cached data from last response.
+     * @returns `true` if the method is allowed, `false` if the method is not allowed, `undefined` if no request has been sent yet or the server did not specify accepted range units.
+     */
+    get readRangeAllowed(): boolean | undefined;
+    /**
+     * Returns a subset of the `TEntity`s in the collection.
+     * @param from The index of the first element to return. Leave unspecified to return the last `to` elements ("tail").
+     * @param to The index of the last element to return. Leave unspecified to return all elements starting at `from`.
+     * @param signal Used to cancel the request.
+     * @throws {@link errors!AuthenticationError}: {@link http!HttpStatusCode.Unauthorized}
+     * @throws {@link errors!AuthorizationError}: {@link http!HttpStatusCode.Forbidden}
+     * @throws {@link errors!RangeNotSatisfiableError}: {@link http!HttpStatusCode.RangeNotSatisfiable}, i.e. the requested range lies outside of the elements currently available
+     * @throws {@link errors!HttpError}: Other non-success status code
+     */
+    readRange(from?: number, to?: number, signal?: AbortSignal): Promise<PartialResponse<TEntity>>;
     /**
      * Shows whether the server has indicated that {@link create} is currently allowed.
      * Uses cached data from last response.
      * @returns `true` if the method is allowed, `false` if the method is not allowed, `undefined` if no request has been sent yet or the server did not specify allowed methods.
      */
-    get createAllowed() { return this.isMethodAllowed(HttpMethod.Post); }
-
+    get createAllowed(): boolean | undefined;
     /**
      * Adds a `TEntity` as a new element to the collection.
      * @param entity The new `TEntity`.
@@ -78,37 +80,13 @@ export class GenericCollectionEndpoint<TEntity, TElementEndpoint extends Element
      * @throws {@link errors!ConflictError}: {@link http!HttpStatusCode.Conflict}
      * @throws {@link errors!HttpError}: Other non-success status code
      */
-    async create(entity: TEntity, signal?: AbortSignal): Promise<TElementEndpoint | undefined> {
-        const response = await this.send(HttpMethod.Post, signal, {
-            [HttpHeader.ContentType]: this.serializer.supportedMediaTypes[0]
-        }, this.serializer.serialize(entity));
-        const location = response.headers.get(HttpHeader.Location);
-
-        let elementEndpoint: TElementEndpoint;
-        if (location) {
-            // Explicit element endpoint URL from "Location" header
-            elementEndpoint = new this.elementEndpoint(this, this.join(location));
-        } else {
-            try {
-                // Infer URL from entity ID in response body
-                elementEndpoint = this.get(this.serializer.deserialize(await response.clone().text()));
-            } catch {
-                // No element endpoint
-                return undefined;
-            }
-        }
-
-        (elementEndpoint as CachingEndpoint).responseCache = await ResponseCache.from(response);
-        return elementEndpoint;
-    }
-
+    create(entity: TEntity, signal?: AbortSignal): Promise<TElementEndpoint | undefined>;
     /**
      * Shows whether the server has indicated that {@link createAll} is currently allowed.
      * Uses cached data from last response.
      * @returns `true` if the method is allowed, `false` if the method is not allowed, `undefined` if no request has been sent yet or the server did not specify allowed methods.
      */
-    get createAllAllowed() { return this.isMethodAllowed(HttpMethod.Patch); }
-
+    get createAllAllowed(): boolean | undefined;
     /**
      * Adds (or updates) multiple `TEntity`s as elements in the collection.
      * @param entities The `TEntity`s to create or modify.
@@ -119,19 +97,13 @@ export class GenericCollectionEndpoint<TEntity, TElementEndpoint extends Element
      * @throws {@link errors!ConflictError}: {@link http!HttpStatusCode.Conflict}
      * @throws {@link errors!HttpError}: Other non-success status code
      */
-    async createAll(entities: TEntity[], signal?: AbortSignal) {
-        await this.send(HttpMethod.Patch, signal, {
-            [HttpHeader.ContentType]: this.serializer.supportedMediaTypes[0]
-        }, this.serializer.serialize(entities));
-    }
-
+    createAll(entities: TEntity[], signal?: AbortSignal): Promise<void>;
     /**
      * Shows whether the server has indicated that {@link setAll} is currently allowed.
      * Uses cached data from last response.
      * @returns `true` if the method is allowed, `false` if the method is not allowed, `undefined` if no request has been sent yet or the server did not specify allowed methods.
      */
-    get setAllAllowed() { return this.isMethodAllowed(HttpMethod.Put); }
-
+    get setAllAllowed(): boolean | undefined;
     /**
      *  Replaces the entire content of the collection with new `TEntity`s.
      * @param entities The `TEntity`s to create or modify.
@@ -141,8 +113,7 @@ export class GenericCollectionEndpoint<TEntity, TElementEndpoint extends Element
      * @throws {@link errors!ConflictError}: {@link http!HttpStatusCode.Conflict}
      * @throws {@link errors!HttpError}: Other non-success status code
      */
-    async setAll(entities: TEntity[]) { await this.putContent(entities); }
-
+    setAll(entities: TEntity[]): Promise<void>;
     /**
      * Determines whether the collection contains a specific element.
      * @param element The ID identifying the entity or an entity to extract the ID from.
@@ -150,8 +121,7 @@ export class GenericCollectionEndpoint<TEntity, TElementEndpoint extends Element
      * @throws {@link errors!AuthorizationError}: {@link http!HttpStatusCode.Forbidden}
      * @throws {@link errors!HttpError}: Other non-success status code
      */
-    contains(element: (TEntity | string)) { return this.get(element).exists(); }
-
+    contains(element: (TEntity | string)): Promise<boolean>;
     /**
      * Sets/replaces an existing element in the collection.
      * @param element The new state of the element.
@@ -162,8 +132,7 @@ export class GenericCollectionEndpoint<TEntity, TElementEndpoint extends Element
      * @throws {@link errors!NotFoundError}: {@link http!HttpStatusCode.NotFound} or {@link http!HttpStatusCode.Gone}
      * @throws {@link errors!HttpError}: Other non-success status code
      */
-    set(element: TEntity) { return this.get(element).set(element); }
-
+    set(element: TEntity): Promise<TEntity | undefined>;
     /**
      * Modifies an existing element in the collection by merging changes on the server-side.
      * @param element The `TEntity` data to merge with the existing element.
@@ -174,8 +143,7 @@ export class GenericCollectionEndpoint<TEntity, TElementEndpoint extends Element
      * @throws {@link errors!NotFoundError}: {@link http!HttpStatusCode.NotFound} or {@link http!HttpStatusCode.Gone}
      * @throws {@link errors!HttpError}: Other non-success status code
      */
-    merge(element: TEntity) { return this.get(element).merge(element); }
-
+    merge(element: TEntity): Promise<TEntity | undefined>;
     /**
      * Deletes an existing element from the collection.
      * @param element The ID identifying the entity or an entity to extract the ID from.
@@ -184,5 +152,5 @@ export class GenericCollectionEndpoint<TEntity, TElementEndpoint extends Element
      * @throws {@link errors!NotFoundError}: {@link http!HttpStatusCode.NotFound} or {@link http!HttpStatusCode.Gone}
      * @throws {@link errors!HttpError}: Other non-success status code
      */
-    delete(element: (TEntity | string)) { return this.get(element).delete(); }
+    delete(element: (TEntity | string)): Promise<void>;
 }