shelving 1.138.0 → 1.139.1

package/util/url.d.ts

@@ -1,13 +1,12 @@
+import type { AnyCaller } from "../error/BaseError.js";
 import { type Optional } from "./optional.js";
-/** Things that can be converted to a URL instance. */
+/** Values that can be converted to a URL instance. */
 export type PossibleURL = string | URL;
 /** Is an unknown value a URL object? */
 export declare function isURL(value: unknown): value is URL;
 /** Assert that an unknown value is a URL object. */
-export declare function assertURL(value: unknown): asserts value is URL;
+export declare function assertURL(value: unknown, caller?: AnyCaller): asserts value is URL;
 /** Convert a possible URL to a URL, or return `undefined` if conversion fails. */
-export declare function getOptionalURL(possible: Optional<PossibleURL>, base?: PossibleURL | undefined): URL | undefined;
-/** Convert a possible URL to a URL, or throw `AssertionError` if conversion fails. */
-export declare function requireURL(possible: PossibleURL, base?: PossibleURL): URL;
-/** Just get the important part of a URL, e.g. `http://shax.com/test?uid=129483` → `shax.com/test` */
-export declare function formatURL(possible: PossibleURL, base?: PossibleURL): string;
+export declare function getURL(possible: Optional<PossibleURL>, base?: PossibleURL | undefined): URL | undefined;
+/** Convert a possible URL to a URL, or throw `RequiredError` if conversion fails. */
+export declare function requireURL(possible: PossibleURL, base?: PossibleURL, caller?: AnyCaller): URL;

package/util/url.js

@@ -1,4 +1,3 @@
-import { AssertionError } from "../error/AssertionError.js";
 import { RequiredError } from "../error/RequiredError.js";
 import { notOptional } from "./optional.js";
 /** Is an unknown value a URL object? */
@@ -6,12 +5,12 @@ export function isURL(value) {
     return value instanceof URL;
 }
 /** Assert that an unknown value is a URL object. */
-export function assertURL(value) {
+export function assertURL(value, caller = assertURL) {
     if (!isURL(value))
-        throw new AssertionError("Invalid URL", { received: value, caller: assertURL });
+        throw new RequiredError("Invalid URL", { received: value, caller });
 }
 /** Convert a possible URL to a URL, or return `undefined` if conversion fails. */
-export function getOptionalURL(possible, base = _BASE) {
+export function getURL(possible, base = _BASE) {
     if (notOptional(possible)) {
         try {
             return isURL(possible) ? possible : new URL(possible, base);
@@ -22,18 +21,9 @@ export function getOptionalURL(possible, base = _BASE) {
     }
 }
 const _BASE = typeof document === "object" ? document.baseURI : undefined;
-/** Convert a possible URL to a URL, or throw `AssertionError` if conversion fails. */
-export function requireURL(possible, base) {
-    return _url(requireURL, possible, base);
-}
-function _url(caller, possible, base) {
-    const url = getOptionalURL(possible, base);
-    if (!url)
-        throw new RequiredError("Invalid URL", { received: possible, caller: requireURL });
+/** Convert a possible URL to a URL, or throw `RequiredError` if conversion fails. */
+export function requireURL(possible, base, caller = requireURL) {
+    const url = getURL(possible, base);
+    assertURL(url, caller);
     return url;
 }
-/** Just get the important part of a URL, e.g. `http://shax.com/test?uid=129483` → `shax.com/test` */
-export function formatURL(possible, base) {
-    const { host, pathname } = _url(formatURL, possible, base);
-    return `${host}${pathname.length > 1 ? pathname : ""}`;
-}

package/util/validate.d.ts

@@ -2,7 +2,7 @@ import type { BaseError, BaseErrorOptions } from "../error/BaseError.js";
 import type { ImmutableArray, PossibleArray } from "./array.js";
 import type { Constructor } from "./class.js";
 import type { Data } from "./data.js";
-import type { ImmutableDictionary, PossibleDictionary } from "./dictionary.js";
+import type { ImmutableDictionary } from "./dictionary.js";
 import type { DeepPartial } from "./object.js";
 /** Object that can validate an unknown value with its `validate()` method. */
 export interface Validator<T> {
@@ -52,7 +52,7 @@ export declare function validateArray<T>(unsafeArray: PossibleArray<unknown>, va
  * @throw Feedback if one or more entry values did not validate.
  * - `feedback.details` will contain an entry for each invalid item (keyed by their count in the input iterable).
  */
-export declare function validateDictionary<T>(unsafeDictionary: PossibleDictionary<unknown>, validator: Validator<T>): ImmutableDictionary<T>;
+export declare function validateDictionary<T>(unsafeDictionary: ImmutableDictionary<unknown>, validator: Validator<T>): ImmutableDictionary<T>;
 /**
  * Validate a data object with a set of validators.
  * - Defined props in the object will be validated against the corresponding validator.

package/error/AssertionError.d.ts

@@ -1,8 +0,0 @@
-import { BaseError, type BaseErrorOptions } from "./BaseError.js";
-/**
- * Thrown when a value is we're asserting something to be true, but it isn't.
- * - Usually thrown from `assertX()` functions, e.g. `assertString()` and `assertNumber()`
- */
-export declare class AssertionError extends BaseError {
-    constructor(message?: string, options?: BaseErrorOptions);
-}

package/error/AssertionError.js

@@ -1,12 +0,0 @@
-import { BaseError } from "./BaseError.js";
-/**
- * Thrown when a value is we're asserting something to be true, but it isn't.
- * - Usually thrown from `assertX()` functions, e.g. `assertString()` and `assertNumber()`
- */
-export class AssertionError extends BaseError {
-    constructor(message, options) {
-        super(message, { caller: AssertionError, ...options });
-    }
-}
-AssertionError.prototype.name = "AssertionError";
-AssertionError.prototype.message = "Assertion failed";