shelving 1.136.0 → 1.137.0

package/package.json

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

package/util/base64.d.ts

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

package/util/base64.js

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

package/util/buffer.d.ts

@@ -0,0 +1,8 @@
+/** Detect if an unknown value is an `ArrayBuffer` (not a view like `Uint8Array` or `Float32Array` etc). */
+export declare function isBuffer(value: unknown): value is ArrayBuffer;
+/** Detect if an unknown value is an `ArrayBuffer` view like `Uint8Array` or `Float32Array` etc. */
+export declare function isBufferView(value: unknown): value is ArrayBufferView;
+/** Encode a string as a `Uint8Array` */
+export declare function encodeBufferView(str: string): Uint8Array;
+/** Encode `Uint8Array` to a string. */
+export declare function decodeBufferView(buffer: ArrayBuffer | ArrayBufferView): string;

package/util/buffer.js

@@ -0,0 +1,24 @@
+import { ValueError } from "../error/ValueError.js";
+/** Detect if an unknown value is an `ArrayBuffer` (not a view like `Uint8Array` or `Float32Array` etc). */
+export function isBuffer(value) {
+    return value instanceof ArrayBuffer;
+}
+/** Detect if an unknown value is an `ArrayBuffer` view like `Uint8Array` or `Float32Array` etc. */
+export function isBufferView(value) {
+    return ArrayBuffer.isView(value);
+}
+/** Encode a string as a `Uint8Array` */
+export function encodeBufferView(str) {
+    return new TextEncoder().encode(str);
+}
+/** Encode `Uint8Array` to a string. */
+export function decodeBufferView(buffer) {
+    try {
+        return new TextDecoder("utf-8", { fatal: true }).decode(buffer);
+    }
+    catch (thrown) {
+        if (thrown instanceof TypeError)
+            throw new ValueError(thrown.message, { received: buffer, caller: decodeBufferView });
+        throw thrown;
+    }
+}

package/util/index.d.ts

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

package/util/index.js

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

package/util/validate.d.ts

@@ -29,7 +29,7 @@ export type ValidatorsType<T> = {
     readonly [K in keyof T]: ValidatorType<T[K]>;
 };
 /** Get value that validates against a given `Validator`, or throw `ValueError` */
-export declare function getValid<T>(unsafeValue: unknown, validator: Validator<T>, ErrorConstructor?: Constructor<BaseError, [string, BaseErrorOptions]>): T;
+export declare function getValid<T>(value: unknown, validator: Validator<T>, ErrorConstructor?: Constructor<BaseError, [string, BaseErrorOptions]>): T;
 /**
  * Validate an iterable set of items with a validator.
  *

package/util/validate.js

@@ -9,13 +9,13 @@ import { isIterable } from "./iterate.js";
 import { getNull } from "./null.js";
 import { getUndefined } from "./undefined.js";
 /** Get value that validates against a given `Validator`, or throw `ValueError` */
-export function getValid(unsafeValue, validator, ErrorConstructor = ValueError) {
+export function getValid(value, validator, ErrorConstructor = ValueError) {
     try {
-        return validator.validate(unsafeValue);
+        return validator.validate(value);
     }
     catch (thrown) {
         if (thrown instanceof Feedback)
-            throw new ErrorConstructor("Invalid value", { cause: thrown, caller: getValid });
+            throw new ErrorConstructor(thrown.message, { received: value, cause: thrown, caller: getValid });
         throw thrown;
     }
 }