@oliversalzburg/js-utils 0.0.8 → 0.0.9

package/lib/errors/AbstractError.js

@@ -1,29 +1,18 @@
 /**
  * Base class for all errors.
+ * @group Errors
  */
 export class AbstractError extends Error {
     /**
      * The HTTP status code to associate with this error.
-     * @deprecated We no longer respond to HTTP requests with error-specifc
-     * status codes.
      */
     status;
-    /**
-     * Another error that should be transported with this error.
-     * @deprecated We don't make use of this or interpret nested errors at all.
-     */
-    inner;
-    /**
-     * A user-friendly error message that may be transported to the client.
-     * @deprecated User-friendly errors should be read from `extensions`.
-     */
-    info;
     /**
      * An application-unique, readable error code.
      */
     code;
     /**
-     * Constructs a new {@link AbstractError}.
+     * Constructs a new {@linkcode AbstractError}.
      * @param code The main identification code for the error.
      * @param message The main error message.
      * @param status The HTTP status code to return.
@@ -33,18 +22,17 @@ export class AbstractError extends Error {
         this.code = code;
         this.name = "AbstractError";
         this.status = status;
-        this.inner = null;
         // Capture a new stacktrace, otherwise it will include our base-class constructor instead of the code
         // location we're actually interested in.
         Error.captureStackTrace(this, AbstractError);
     }
     /**
-     * Checks if an object is an instance of {@link AbstractError}, or one of its subclasses.
+     * Checks if an object is an instance of {@linkcode AbstractError}, or one of its subclasses.
      * @param error The object to check.
      * @param allowForeignModule Only check for similar looking error codes.
      * You're going to want to use this if you're dealing with a setup where
      * multiple versions of js-utils are loaded.
-     * @returns `true` if the object is an {@link AbstractError}, `false` otherwise.
+     * @returns `true` if the object is an {@linkcode AbstractError}, `false` otherwise.
      */
     static isAbstractError(error, allowForeignModule = true) {
         if (error instanceof AbstractError) {

package/lib/errors/AbstractError.js.map

@@ -1 +1 @@
-{"version":3,"file":"AbstractError.js","sourceRoot":"","sources":["../../source/errors/AbstractError.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,KAAK;IACtC;;;;OAIG;IACH,MAAM,CAAS;IAEf;;;OAGG;IACH,KAAK,CAAe;IAEpB;;;OAGG;IACH,IAAI,CAAgB;IAEpB;;OAEG;IACH,IAAI,CAAS;IAEb;;;;;OAKG;IACH,YAAY,IAAY,EAAE,OAAe,EAAE,MAAc;QACvD,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAElB,qGAAqG;QACrG,yCAAyC;QACzC,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,eAAe,CAAC,KAAc,EAAE,kBAAkB,GAAG,IAAI;QAC9D,IAAI,KAAK,YAAY,aAAa,EAAE;YAClC,OAAO,IAAI,CAAC;SACb;QAED,gEAAgE;QAChE,sEAAsE;QACtE,cAAc;QACd,IAAI,kBAAkB,EAAE;YACtB,MAAM,WAAW,GAAG,KAAgC,CAAC;YACrD,IACE,MAAM,CAAC,KAAK,CAAC,KAAK,KAAK;gBACvB,MAAM,IAAI,WAAW;gBACrB,OAAO,WAAW,CAAC,IAAI,KAAK,QAAQ,EACpC;gBACA,MAAM,UAAU,GAAG,KAAyB,CAAC;gBAC7C,IAAI,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE;oBACrC,OAAO,IAAI,CAAC;iBACb;aACF;SACF;QAED,OAAO,KAAK,CAAC;IACf,CAAC;CACF"}
+{"version":3,"file":"AbstractError.js","sourceRoot":"","sources":["../../source/errors/AbstractError.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,OAAO,aAAc,SAAQ,KAAK;IACtC;;OAEG;IACH,MAAM,CAAS;IAEf;;OAEG;IACH,IAAI,CAAS;IAEb;;;;;OAKG;IACH,YAAY,IAAY,EAAE,OAAe,EAAE,MAAc;QACvD,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,qGAAqG;QACrG,yCAAyC;QACzC,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,eAAe,CAAC,KAAc,EAAE,kBAAkB,GAAG,IAAI;QAC9D,IAAI,KAAK,YAAY,aAAa,EAAE;YAClC,OAAO,IAAI,CAAC;SACb;QAED,gEAAgE;QAChE,sEAAsE;QACtE,cAAc;QACd,IAAI,kBAAkB,EAAE;YACtB,MAAM,WAAW,GAAG,KAAgC,CAAC;YACrD,IACE,MAAM,CAAC,KAAK,CAAC,KAAK,KAAK;gBACvB,MAAM,IAAI,WAAW;gBACrB,OAAO,WAAW,CAAC,IAAI,KAAK,QAAQ,EACpC;gBACA,MAAM,UAAU,GAAG,KAAyB,CAAC;gBAC7C,IAAI,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE;oBACrC,OAAO,IAAI,CAAC;iBACb;aACF;SACF;QAED,OAAO,KAAK,CAAC;IACf,CAAC;CACF"}

package/lib/errors/InternalError.d.ts

@@ -1,19 +1,20 @@
 import { AbstractError } from "./AbstractError.js";
 /**
- * Used when an `Error`-like object was caught and converted into an
- * implementation of `AbstractError` for further processing.
+ * Used when an {@linkcode !Error}-like object was caught and converted into an
+ * implementation of {@linkcode AbstractError} for further processing.
+ * @group Errors
  */
 export declare class InternalError extends AbstractError {
     /**
-     * Constructs a new {@link InternalError}.
+     * Constructs a new {@linkcode InternalError}.
      * @param message The main error message.
      * @param status The HTTP status code to return.
      */
     constructor(message: string, status?: number);
     /**
-     * Converts an error into an {@link InternalError}.
+     * Converts an error into an {@linkcode InternalError}.
      * @param error The error to convert.
-     * @returns An {@link InternalError} that represents the given error.
+     * @returns An {@linkcode InternalError} that represents the given error.
      */
     static fromError(error: Error): InternalError;
 }

package/lib/errors/InternalError.js

@@ -1,11 +1,12 @@
 import { AbstractError } from "./AbstractError.js";
 /**
- * Used when an `Error`-like object was caught and converted into an
- * implementation of `AbstractError` for further processing.
+ * Used when an {@linkcode !Error}-like object was caught and converted into an
+ * implementation of {@linkcode AbstractError} for further processing.
+ * @group Errors
  */
 export class InternalError extends AbstractError {
     /**
-     * Constructs a new {@link InternalError}.
+     * Constructs a new {@linkcode InternalError}.
      * @param message The main error message.
      * @param status The HTTP status code to return.
      */
@@ -17,9 +18,9 @@ export class InternalError extends AbstractError {
         Error.captureStackTrace(this, InternalError);
     }
     /**
-     * Converts an error into an {@link InternalError}.
+     * Converts an error into an {@linkcode InternalError}.
      * @param error The error to convert.
-     * @returns An {@link InternalError} that represents the given error.
+     * @returns An {@linkcode InternalError} that represents the given error.
      */
     static fromError(error) {
         // Create a _real_ `InternalError` instance, which we will return later.
@@ -28,8 +29,6 @@ export class InternalError extends AbstractError {
         // Then assign another `InternalError` to replace key fields, like:
         // name, code, status, ...
         Object.assign(internalError, error, new InternalError(error.message));
-        // Set the inner error.
-        internalError.inner = error;
         // Inherit the original error stack again.
         internalError.stack = error.stack;
         return internalError;

package/lib/errors/InternalError.js.map

@@ -1 +1 @@
-{"version":3,"file":"InternalError.js","sourceRoot":"","sources":["../../source/errors/InternalError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;GAGG;AACH,MAAM,OAAO,aAAc,SAAQ,aAAa;IAC9C;;;;OAIG;IACH,YAAY,OAAe,EAAE,MAAM,GAAG,GAAG;QACvC,KAAK,CAAC,iBAAiB,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAE1C,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAE5B,qEAAqE;QACrE,yEAAyE;QACzE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,SAAS,CAAC,KAAY;QAC3B,wEAAwE;QACxE,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACvD,kEAAkE;QAClE,mEAAmE;QACnE,0BAA0B;QAC1B,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE,KAAK,EAAE,IAAI,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QACtE,uBAAuB;QACvB,aAAa,CAAC,KAAK,GAAG,KAAK,CAAC;QAC5B,0CAA0C;QAC1C,aAAa,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;QAElC,OAAO,aAAa,CAAC;IACvB,CAAC;CACF"}
+{"version":3,"file":"InternalError.js","sourceRoot":"","sources":["../../source/errors/InternalError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;;GAIG;AACH,MAAM,OAAO,aAAc,SAAQ,aAAa;IAC9C;;;;OAIG;IACH,YAAY,OAAe,EAAE,MAAM,GAAG,GAAG;QACvC,KAAK,CAAC,iBAAiB,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAE1C,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAE5B,qEAAqE;QACrE,yEAAyE;QACzE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,SAAS,CAAC,KAAY;QAC3B,wEAAwE;QACxE,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACvD,kEAAkE;QAClE,mEAAmE;QACnE,0BAA0B;QAC1B,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE,KAAK,EAAE,IAAI,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QACtE,0CAA0C;QAC1C,aAAa,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;QAElC,OAAO,aAAa,CAAC;IACvB,CAAC;CACF"}

package/lib/errors/InvalidArgumentError.d.ts

@@ -2,10 +2,11 @@ import { AbstractError } from "./AbstractError.js";
 /**
  * Used when the user supplied an argument that is not valid in the current
  * context.
+ * @group Errors
  */
 export declare class InvalidArgumentError extends AbstractError {
     /**
-     * Constructs a new {@link InvalidArgumentError}.
+     * Constructs a new {@linkcode InvalidArgumentError}.
      * @param message The main error message.
      * @param status The HTTP status code to return.
      */

package/lib/errors/InvalidArgumentError.js

@@ -2,10 +2,11 @@ import { AbstractError } from "./AbstractError.js";
 /**
  * Used when the user supplied an argument that is not valid in the current
  * context.
+ * @group Errors
  */
 export class InvalidArgumentError extends AbstractError {
     /**
-     * Constructs a new {@link InvalidArgumentError}.
+     * Constructs a new {@linkcode InvalidArgumentError}.
      * @param message The main error message.
      * @param status The HTTP status code to return.
      */

package/lib/errors/InvalidArgumentError.js.map

@@ -1 +1 @@
-{"version":3,"file":"InvalidArgumentError.js","sourceRoot":"","sources":["../../source/errors/InvalidArgumentError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;GAGG;AACH,MAAM,OAAO,oBAAqB,SAAQ,aAAa;IACrD;;;;OAIG;IACH,YAAY,OAAe,EAAE,MAAM,GAAG,GAAG;QACvC,KAAK,CAAC,yBAAyB,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAElD,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;QAEnC,qEAAqE;QACrE,yEAAyE;QACzE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,oBAAoB,CAAC,CAAC;IACtD,CAAC;CACF"}
+{"version":3,"file":"InvalidArgumentError.js","sourceRoot":"","sources":["../../source/errors/InvalidArgumentError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;;GAIG;AACH,MAAM,OAAO,oBAAqB,SAAQ,aAAa;IACrD;;;;OAIG;IACH,YAAY,OAAe,EAAE,MAAM,GAAG,GAAG;QACvC,KAAK,CAAC,yBAAyB,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAElD,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;QAEnC,qEAAqE;QACrE,yEAAyE;QACzE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,oBAAoB,CAAC,CAAC;IACtD,CAAC;CACF"}

package/lib/errors/InvalidOperationError.d.ts

@@ -2,10 +2,11 @@ import { AbstractError } from "./AbstractError.js";
 /**
  * Used when an operation was attempted that can not be completed in the current
  * context.
+ * @group Errors
  */
 export declare class InvalidOperationError extends AbstractError {
     /**
-     * Constructs a new {@link InvalidOperationError}.
+     * Constructs a new {@linkcode InvalidOperationError}.
      * @param message The main error message.
      * @param status The HTTP status code to return.
      */

package/lib/errors/InvalidOperationError.js

@@ -2,10 +2,11 @@ import { AbstractError } from "./AbstractError.js";
 /**
  * Used when an operation was attempted that can not be completed in the current
  * context.
+ * @group Errors
  */
 export class InvalidOperationError extends AbstractError {
     /**
-     * Constructs a new {@link InvalidOperationError}.
+     * Constructs a new {@linkcode InvalidOperationError}.
      * @param message The main error message.
      * @param status The HTTP status code to return.
      */

package/lib/errors/InvalidOperationError.js.map

@@ -1 +1 @@
-{"version":3,"file":"InvalidOperationError.js","sourceRoot":"","sources":["../../source/errors/InvalidOperationError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;GAGG;AACH,MAAM,OAAO,qBAAsB,SAAQ,aAAa;IACtD;;;;OAIG;IACH,YAAY,OAAe,EAAE,MAAM,GAAG,GAAG;QACvC,KAAK,CAAC,0BAA0B,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAEnD,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;QAEpC,qEAAqE;QACrE,yEAAyE;QACzE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,qBAAqB,CAAC,CAAC;IACvD,CAAC;CACF"}
+{"version":3,"file":"InvalidOperationError.js","sourceRoot":"","sources":["../../source/errors/InvalidOperationError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;;GAIG;AACH,MAAM,OAAO,qBAAsB,SAAQ,aAAa;IACtD;;;;OAIG;IACH,YAAY,OAAe,EAAE,MAAM,GAAG,GAAG;QACvC,KAAK,CAAC,0BAA0B,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAEnD,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;QAEpC,qEAAqE;QACrE,yEAAyE;QACzE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,qBAAqB,CAAC,CAAC;IACvD,CAAC;CACF"}

package/lib/errors/NotImplementedError.d.ts

@@ -1,10 +1,11 @@
 import { AbstractError } from "./AbstractError.js";
 /**
  * Used when a called method actually hasn't been implemented yet (whoops).
+ * @group Errors
  */
 export declare class NotImplementedError extends AbstractError {
     /**
-     * Constructs a new {@link NotImplementedError}.
+     * Constructs a new {@linkcode NotImplementedError}.
      * @param message The main error message.
      * @param status The HTTP status code to return.
      */

package/lib/errors/NotImplementedError.js

@@ -1,10 +1,11 @@
 import { AbstractError } from "./AbstractError.js";
 /**
  * Used when a called method actually hasn't been implemented yet (whoops).
+ * @group Errors
  */
 export class NotImplementedError extends AbstractError {
     /**
-     * Constructs a new {@link NotImplementedError}.
+     * Constructs a new {@linkcode NotImplementedError}.
      * @param message The main error message.
      * @param status The HTTP status code to return.
      */

package/lib/errors/NotImplementedError.js.map

@@ -1 +1 @@
-{"version":3,"file":"NotImplementedError.js","sourceRoot":"","sources":["../../source/errors/NotImplementedError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;GAEG;AACH,MAAM,OAAO,mBAAoB,SAAQ,aAAa;IACpD;;;;OAIG;IACH,YAAY,OAAe,EAAE,MAAM,GAAG,GAAG;QACvC,KAAK,CAAC,wBAAwB,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAEjD,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;QAElC,qEAAqE;QACrE,yEAAyE;QACzE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC;IACrD,CAAC;CACF"}
+{"version":3,"file":"NotImplementedError.js","sourceRoot":"","sources":["../../source/errors/NotImplementedError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;GAGG;AACH,MAAM,OAAO,mBAAoB,SAAQ,aAAa;IACpD;;;;OAIG;IACH,YAAY,OAAe,EAAE,MAAM,GAAG,GAAG;QACvC,KAAK,CAAC,wBAAwB,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAEjD,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;QAElC,qEAAqE;QACrE,yEAAyE;QACzE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC;IACrD,CAAC;CACF"}

package/lib/errors/PermissionViolationError.d.ts

@@ -2,10 +2,11 @@ import { AbstractError } from "./AbstractError.js";
 /**
  * An error used when access to a resource was requested, but the required
  * permissions were not available.
+ * @group Errors
  */
 export declare class PermissionViolationError extends AbstractError {
     /**
-     * Constructs a new {@link PermissionViolationError}.
+     * Constructs a new {@linkcode PermissionViolationError}.
      * @param message The main error message.
      * @param status The HTTP status code to return.
      */

package/lib/errors/PermissionViolationError.js

@@ -2,10 +2,11 @@ import { AbstractError } from "./AbstractError.js";
 /**
  * An error used when access to a resource was requested, but the required
  * permissions were not available.
+ * @group Errors
  */
 export class PermissionViolationError extends AbstractError {
     /**
-     * Constructs a new {@link PermissionViolationError}.
+     * Constructs a new {@linkcode PermissionViolationError}.
      * @param message The main error message.
      * @param status The HTTP status code to return.
      */

package/lib/errors/PermissionViolationError.js.map

@@ -1 +1 @@
-{"version":3,"file":"PermissionViolationError.js","sourceRoot":"","sources":["../../source/errors/PermissionViolationError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;GAGG;AACH,MAAM,OAAO,wBAAyB,SAAQ,aAAa;IACzD;;;;OAIG;IACH,YAAY,OAAe,EAAE,MAAM,GAAG,GAAG;QACvC,KAAK,CAAC,6BAA6B,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAEtD,IAAI,CAAC,IAAI,GAAG,0BAA0B,CAAC;QAEvC,qEAAqE;QACrE,yEAAyE;QACzE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,wBAAwB,CAAC,CAAC;IAC1D,CAAC;CACF"}
+{"version":3,"file":"PermissionViolationError.js","sourceRoot":"","sources":["../../source/errors/PermissionViolationError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;;GAIG;AACH,MAAM,OAAO,wBAAyB,SAAQ,aAAa;IACzD;;;;OAIG;IACH,YAAY,OAAe,EAAE,MAAM,GAAG,GAAG;QACvC,KAAK,CAAC,6BAA6B,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAEtD,IAAI,CAAC,IAAI,GAAG,0BAA0B,CAAC;QAEvC,qEAAqE;QACrE,yEAAyE;QACzE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,wBAAwB,CAAC,CAAC;IAC1D,CAAC;CACF"}

package/lib/errors/ResourceConflictError.d.ts

@@ -1,10 +1,11 @@
 import { AbstractError } from "./AbstractError.js";
 /**
  * Used when a resource conflict was detected.
+ * @group Errors
  */
 export declare class ResourceConflictError extends AbstractError {
     /**
-     * Constructs a new {@link ResourceConflictError}.
+     * Constructs a new {@linkcode ResourceConflictError}.
      * @param message The main error message.
      * @param status The HTTP status code to return.
      */

package/lib/errors/ResourceConflictError.js

@@ -1,10 +1,11 @@
 import { AbstractError } from "./AbstractError.js";
 /**
  * Used when a resource conflict was detected.
+ * @group Errors
  */
 export class ResourceConflictError extends AbstractError {
     /**
-     * Constructs a new {@link ResourceConflictError}.
+     * Constructs a new {@linkcode ResourceConflictError}.
      * @param message The main error message.
      * @param status The HTTP status code to return.
      */

package/lib/errors/ResourceConflictError.js.map

@@ -1 +1 @@
-{"version":3,"file":"ResourceConflictError.js","sourceRoot":"","sources":["../../source/errors/ResourceConflictError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;GAEG;AACH,MAAM,OAAO,qBAAsB,SAAQ,aAAa;IACtD;;;;OAIG;IACH,YAAY,OAAe,EAAE,MAAM,GAAG,GAAG;QACvC,KAAK,CAAC,0BAA0B,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAEnD,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;QAEpC,qEAAqE;QACrE,yEAAyE;QACzE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,qBAAqB,CAAC,CAAC;IACvD,CAAC;CACF"}
+{"version":3,"file":"ResourceConflictError.js","sourceRoot":"","sources":["../../source/errors/ResourceConflictError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;GAGG;AACH,MAAM,OAAO,qBAAsB,SAAQ,aAAa;IACtD;;;;OAIG;IACH,YAAY,OAAe,EAAE,MAAM,GAAG,GAAG;QACvC,KAAK,CAAC,0BAA0B,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAEnD,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;QAEpC,qEAAqE;QACrE,yEAAyE;QACzE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,qBAAqB,CAAC,CAAC;IACvD,CAAC;CACF"}

package/lib/errors/UnknownError.d.ts

@@ -1,14 +1,15 @@
 import { AbstractError } from "./AbstractError.js";
 /**
- * Used when an unknown, non-`Error`-like object was caught and converted into a
- * real `Error` instance.
+ * Used when an unknown, non-{@linkcode !Error}-like object was caught and converted into a
+ * real {@linkcode !Error} instance.
  * Like when you catch a `throw "boom"`, we will convert the caught `"boom"`
- * into an `UnknownError`.
- * To enrich an `Error`-like object that was caught, use the {@link InternalError}.
+ * into an {@linkcode UnknownError}.
+ * To enrich an {@linkcode !Error}-like object that was caught, use the {@linkcode InternalError}.
+ * @group Errors
  */
 export declare class UnknownError extends AbstractError {
     /**
-     * Constructs a new {@link UnknownError}.
+     * Constructs a new {@linkcode UnknownError}.
      * @param message The main error message.
      * @param status The HTTP status code to return.
      */

package/lib/errors/UnknownError.js

@@ -1,14 +1,15 @@
 import { AbstractError } from "./AbstractError.js";
 /**
- * Used when an unknown, non-`Error`-like object was caught and converted into a
- * real `Error` instance.
+ * Used when an unknown, non-{@linkcode !Error}-like object was caught and converted into a
+ * real {@linkcode !Error} instance.
  * Like when you catch a `throw "boom"`, we will convert the caught `"boom"`
- * into an `UnknownError`.
- * To enrich an `Error`-like object that was caught, use the {@link InternalError}.
+ * into an {@linkcode UnknownError}.
+ * To enrich an {@linkcode !Error}-like object that was caught, use the {@linkcode InternalError}.
+ * @group Errors
  */
 export class UnknownError extends AbstractError {
     /**
-     * Constructs a new {@link UnknownError}.
+     * Constructs a new {@linkcode UnknownError}.
      * @param message The main error message.
      * @param status The HTTP status code to return.
      */

package/lib/errors/UnknownError.js.map

@@ -1 +1 @@
-{"version":3,"file":"UnknownError.js","sourceRoot":"","sources":["../../source/errors/UnknownError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;;;;GAMG;AACH,MAAM,OAAO,YAAa,SAAQ,aAAa;IAC7C;;;;OAIG;IACH,YAAY,OAAe,EAAE,MAAM,GAAG,GAAG;QACvC,KAAK,CAAC,gBAAgB,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAEzC,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC;QAE3B,qEAAqE;QACrE,yEAAyE;QACzE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IAC9C,CAAC;CACF"}
+{"version":3,"file":"UnknownError.js","sourceRoot":"","sources":["../../source/errors/UnknownError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;;;;;GAOG;AACH,MAAM,OAAO,YAAa,SAAQ,aAAa;IAC7C;;;;OAIG;IACH,YAAY,OAAe,EAAE,MAAM,GAAG,GAAG;QACvC,KAAK,CAAC,gBAAgB,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAEzC,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC;QAE3B,qEAAqE;QACrE,yEAAyE;QACzE,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IAC9C,CAAC;CACF"}

package/lib/graphics/canvas.d.ts

@@ -1,12 +1,12 @@
 /// <reference types="@types/web" />
 /**
- * A wrapper around {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement HTMLCanvasElement}
+ * A wrapper around {@linkcode !HTMLCanvasElement}
  * to provide some convience for double-buffered drawing.
+ * @group Graphics
  */
 export declare class Canvas {
     /**
-     * The {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement HTMLCanvasElement}
-     * we're interacting with.
+     * The {@linkcode !HTMLCanvasElement} we're interacting with.
      */
     readonly canvas: HTMLCanvasElement;
     /**
@@ -18,84 +18,99 @@ export declare class Canvas {
      */
     readonly height: number;
     /**
-     * The {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2 CanvasRenderingContext2D}
-     * we're using to draw to the canvas.
+     * The {@linkcode !CanvasRenderingContext2D} we're using to draw to the canvas.
      */
     readonly context: CanvasRenderingContext2D;
     /**
-     * The {@linkcode https://developer.mozilla.org/en-US/docs/Web/API/ImageData ImageData} object
+     * The {@linkcode !ImageData} object
      * that represents our frontbuffer, which is the canvas itself.
      */
-    readonly pixMap: ImageData;
+    pixMap: ImageData;
     /**
-     * Our backbuffer.
+     * Our back buffer.
      */
-    readonly buffer: Uint8ClampedArray;
+    buffer: Uint8ClampedArray;
     /**
-     * Constructs a new {@link Canvas}.
+     * Was this {@linkcode Canvas} created with the ability to copy the front buffer back into
+     * the back buffer?
+     */
+    readonly supportReadBack: boolean;
+    /**
+     * Constructs a new {@linkcode Canvas}.
      * @param canvas The canvas to wrap.
      * @param width The width of the canvas.
      * @param height The height of the canvas.
+     * @param supportReadBack Should this canvas support reading back from the front buffer?
+     * You will need this, if you plan to use regular canvas drawing on the front buffer, and
+     * read the results back into the back buffer.
      */
-    constructor(canvas: HTMLCanvasElement, width: number, height: number);
+    constructor(canvas: HTMLCanvasElement, width: number, height: number, supportReadBack?: boolean);
     /**
-     * Draws the backbuffer onto the canvas.
+     * Draws the back buffer onto the canvas.
      */
     update(): void;
     /**
-     * Returns the color of a pixel in the backbuffer.
+     * Reads the front buffer back into the back buffer.
+     */
+    bufferReadBack(): void;
+    /**
+     * Returns the color of a pixel in the back buffer.
      * @param x The X coordinate to retrieve.
      * @param y The X coordinate to retrieve.
      * @returns The color of the pixel at the given local.
      */
     getPixel32(x: number, y: number): number;
     /**
-     * Colors a pixel in the backbuffer.
+     * Colors a pixel in the back buffer.
      * @param x The X coordinate to color.
      * @param y The Y coordinate to color.
      * @param color The color to place at the coordinate.
      */
     setPixel32(x: number, y: number, color: number): void;
     /**
-     * Fills the entire backbuffer with the given color.
-     * @param color The color to fill the backbuffer with.
+     * Fills the entire back buffer with the given color.
+     * @param color The color to fill the back buffer with.
      */
     clearWith(color: number): void;
 }
 /**
- * Linearly blends a new pixel with an existing color value in a {@link Canvas}.
- * @param canvas The {@link Canvas} to interact with.
+ * Linearly blends a new pixel with an existing color value in a {@linkcode Canvas}.
+ * @param canvas The {@linkcode Canvas} to interact with.
  * @param x The X coordinate at which to place the pixel.
  * @param y The Y coordinate at which to place the pixel.
  * @param color The color of the pixel.
  * @param alpha The alpha value to use to blend the pixel with existing color at the location.
+ * @group Graphics
  */
 export declare const putPixel32: (canvas: Canvas, x: number, y: number, color: number, alpha: number) => void;
 /**
- * Additively blends a new pixel with an existing color value in a {@link Canvas}.
- * @param canvas The {@link Canvas} to interact with.
+ * Additively blends a new pixel with an existing color value in a {@linkcode Canvas}.
+ * @param canvas The {@linkcode Canvas} to interact with.
  * @param x The X coordinate at which to place the pixel.
  * @param y The Y coordinate at which to place the pixel.
  * @param color The color of the pixel.
  * @param alpha The alpha value to use to blend the pixel with existing color at the location.
+ * @group Graphics
  */
 export declare const putPixel32Add: (canvas: Canvas, x: number, y: number, color: number, alpha: number) => void;
 /**
- * Subtractively blends a new pixel with an existing color value in a {@link Canvas}.
- * @param canvas The {@link Canvas} to interact with.
+ * Subtractively blends a new pixel with an existing color value in a {@linkcode Canvas}.
+ * @param canvas The {@linkcode Canvas} to interact with.
  * @param x The X coordinate at which to place the pixel.
  * @param y The Y coordinate at which to place the pixel.
  * @param color The color of the pixel.
  * @param alpha The alpha value to use to blend the pixel with existing color at the location.
+ * @group Graphics
  */
 export declare const putPixel32Sub: (canvas: Canvas, x: number, y: number, color: number, alpha: number) => void;
 /**
- * Linearly blends a new pixel with an existing color value in a {@link Canvas}.
- * Compared to {@link putPixel32}, this function supports sub-pixel placement, but is dramatically slower.
- * @param canvas The {@link Canvas} to interact with.
+ * Linearly blends a new pixel with an existing color value in a {@linkcode Canvas}.
+ * Compared to {@linkcode putPixel32}, this function supports sub-pixel placement, but is dramatically slower.
+ * @param canvas The {@linkcode Canvas} to interact with.
  * @param x The X coordinate at which to place the pixel.
  * @param y The Y coordinate at which to place the pixel.
  * @param color The color of the pixel.
  * @param alpha The alpha value to use to blend the pixel with existing color at the location.
+ * @group Graphics
  */
 export declare const putSubPixel32: (canvas: Canvas, x: number, y: number, color: number, alpha: number) => void;