shelving 1.134.0 → 1.135.0

package/error/CodedError.d.ts

@@ -5,7 +5,9 @@
  * - Details are converted to string using `debug()`
  */
 export declare class CodedError extends Error {
+    /** Number in the range of 400-599, roughly corresponding to HTTP error codes. */
     readonly code: number;
+    /** Details about the error, which are appended to the message. */
     readonly details: unknown;
-    constructor(message: string, details?: unknown);
+    constructor(message?: string, details?: unknown);
 }

package/error/CodedError.js

@@ -6,9 +6,11 @@ import { debug } from "../util/debug.js";
  * - Details are converted to string using `debug()`
  */
 export class CodedError extends Error {
+    /** Number in the range of 400-599, roughly corresponding to HTTP error codes. */
     code = 500;
+    /** Details about the error, which are appended to the message. */
     details;
-    constructor(message, details) {
+    constructor(message = CodedError.prototype.message, details) {
         const debugged = details !== undefined ? debug(details, 2) : "";
         super(debugged.length ? `${message}: ${debugged}` : message);
         this.details = details;
@@ -16,3 +18,4 @@ export class CodedError extends Error {
     }
 }
 CodedError.prototype.name = "CodedError";
+CodedError.prototype.message = "Internal error";

package/error/ConflictError.js

@@ -2,9 +2,10 @@ import { CodedError } from "./CodedError.js";
 /** Thrown if the state of the program is not correct to execute a given operation. */
 export class ConflictError extends CodedError {
     code = 509;
-    constructor(message = "Conflict", context) {
+    constructor(message = ConflictError.prototype.message, context) {
         super(message, context);
         Error.captureStackTrace(this, ConflictError);
     }
 }
 ConflictError.prototype.name = "ConflictError";
+ConflictError.prototype.message = "Conflict";

package/error/ConnectionError.js

@@ -1,9 +1,10 @@
 import { CodedError } from "./CodedError.js";
 /** Thrown if e.g. a user's internet connection fails. */
 export class ConnectionError extends CodedError {
-    constructor(message = "Connection error", context) {
+    constructor(message = ConnectionError.prototype.message, context) {
         super(message, context);
         Error.captureStackTrace(this, ConnectionError);
     }
 }
 ConnectionError.prototype.name = "ConnectionError";
+ConnectionError.prototype.message = "Connection error";

package/error/ForbiddenError.js

@@ -2,9 +2,10 @@ import { CodedError } from "./CodedError.js";
 /** Thrown if an operation failed because the user is logged in but does not have sufficient privileges to access something. */
 export class ForbiddenError extends CodedError {
     code = 403;
-    constructor(message = "Forbidden", context) {
+    constructor(message = ForbiddenError.prototype.message, context) {
         super(message, context);
         Error.captureStackTrace(this, ForbiddenError);
     }
 }
 ForbiddenError.prototype.name = "ForbiddenError";
+ForbiddenError.prototype.message = "Forbidden";

package/error/NotFoundError.js

@@ -2,9 +2,10 @@ import { CodedError } from "./CodedError.js";
 /** Thrown if if a value is required but doesn't exist. */
 export class NotFoundError extends CodedError {
     code = 404;
-    constructor(message = "Not found", context) {
+    constructor(message = NotFoundError.prototype.message, context) {
         super(message, context);
         Error.captureStackTrace(this, NotFoundError);
     }
 }
 NotFoundError.prototype.name = "NotFoundError";
+NotFoundError.prototype.message = "Not found";

package/error/NotImplementedError.js

@@ -2,9 +2,10 @@ import { CodedError } from "./CodedError.js";
 /** Error thrown when functionality is called but is not implemented by an interface. */
 export class NotImplementedError extends CodedError {
     code = 501;
-    constructor(message = "Not implemented", value) {
+    constructor(message = NotImplementedError.prototype.message, value) {
         super(message, value);
         Error.captureStackTrace(this, NotImplementedError);
     }
 }
 NotImplementedError.prototype.name = "NotImplementedError";
+NotImplementedError.prototype.message = "Not implemented";

package/error/UnauthorizedError.js

@@ -2,9 +2,10 @@ import { CodedError } from "./CodedError.js";
 /** Thrown if an operation failed because the user is logged in but does not have sufficient privileges to access something. */
 export class UnauthorizedError extends CodedError {
     code = 401;
-    constructor(message = "Unauthorized", context) {
+    constructor(message = UnauthorizedError.prototype.message, context) {
         super(message, context);
         Error.captureStackTrace(this, UnauthorizedError);
     }
 }
 UnauthorizedError.prototype.name = "UnauthorizedError";
+UnauthorizedError.prototype.message = "Unauthorized";

package/error/ValidationError.js

@@ -2,9 +2,10 @@ import { CodedError } from "./CodedError.js";
 /** Error thrown when a value isn't valid. */
 export class ValidationError extends CodedError {
     code = 422;
-    constructor(message = "Invalid value", context) {
+    constructor(message = ValidationError.prototype.message, context) {
         super(message, context);
         Error.captureStackTrace(this, ValidationError);
     }
 }
 ValidationError.prototype.name = "ValidationError";
+ValidationError.prototype.message = "Invalid input";

package/package.json

@@ -11,7 +11,7 @@
 		"state-management",
 		"query-builder"
 	],
-	"version": "1.134.0",
+	"version": "1.135.0",
 	"repository": "https://github.com/dhoulb/shelving",
 	"author": "Dave Houlbrooke <dave@shax.com>",
 	"license": "0BSD",

package/util/base64.d.ts

@@ -0,0 +1,8 @@
+/** Encode a string to Base64 (with no `=` padding on the end). */
+export declare function base64Encode(str: string): string;
+/** Decode a string from Base64 (strips `=` padding on the end). */
+export declare function base64Decode(b64: string): string;
+/** Encode a string to URL-safe Base64 */
+export declare function base64UrlEncode(str: string): string;
+/** Decode a string from URL-safe Base64. */
+export declare function base64UrlDecode(b64: string): string;

package/util/base64.js

@@ -0,0 +1,16 @@
+/** Encode a string to Base64 (with no `=` padding on the end). */
+export function base64Encode(str) {
+    return btoa(str).replace(/=+$/, "");
+}
+/** Decode a string from Base64 (strips `=` padding on the end). */
+export function base64Decode(b64) {
+    return atob(b64.replace(/=+$/, ""));
+}
+/** Encode a string to URL-safe Base64 */
+export function base64UrlEncode(str) {
+    return base64Encode(str).replace(/\+/g, "-").replace(/\//g, "_");
+}
+/** Decode a string from URL-safe Base64. */
+export function base64UrlDecode(b64) {
+    return base64Decode(b64.replace(/-/g, "+").replace(/_/g, "/"));
+}

package/util/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./array.js";
 export * from "./assert.js";
 export * from "./async.js";
+export * from "./base64.js";
 export * from "./boolean.js";
 export * from "./callback.js";
 export * from "./class.js";

package/util/index.js

@@ -1,6 +1,7 @@
 export * from "./array.js";
 export * from "./assert.js";
 export * from "./async.js";
+export * from "./base64.js";
 export * from "./boolean.js";
 export * from "./callback.js";
 export * from "./class.js";