shelving 1.254.0 → 1.255.0

package/README.md

@@ -6,7 +6,7 @@ TypeScript data toolkit — schema validation, database and API providers, obser
 
 ## Documentation
 
-Full documentation is published at **<https://dhoulb.github.io/shelving/>**.
+Full documentation is published at **<https://shelving.cc/>**.
 
 ```sh
 npm install shelving

package/api/cache/APICache.d.ts

@@ -11,14 +11,14 @@ import { EndpointCache } from "./EndpointCache.js";
  * const cache = new APICache(provider);
  * const user = await cache.call(getUser, { id: "abc" });
  *
- * @see https://dhoulb.github.io/shelving/api/cache/APICache/APICache
+ * @see https://shelving.cc/api/APICache
  */
 export declare class APICache<P, R> implements AsyncDisposable {
     private readonly _endpoints;
     /**
      * The underlying `APIProvider` that backs every cached endpoint.
      *
-     * @see https://dhoulb.github.io/shelving/api/cache/APICache/APICache/provider
+     * @see https://shelving.cc/api/APICache/provider
      */
     readonly provider: APIProvider<P, R>;
     /**
@@ -26,7 +26,7 @@ export declare class APICache<P, R> implements AsyncDisposable {
      *
      * @param provider The `APIProvider` used to fetch results for every cached endpoint.
      * @example new APICache(provider)
-     * @see https://dhoulb.github.io/shelving/api/cache/APICache/APICache
+     * @see https://shelving.cc/api/APICache
      */
     constructor(provider: APIProvider<P, R>);
     private _get;
@@ -36,7 +36,7 @@ export declare class APICache<P, R> implements AsyncDisposable {
      * @param endpoint The endpoint whose `EndpointCache` should be returned.
      * @returns The existing `EndpointCache` for `endpoint`, or a newly created one.
      * @example cache.get(getUser).get({ id: "abc" })
-     * @see https://dhoulb.github.io/shelving/api/cache/APICache/APICache/get
+     * @see https://shelving.cc/api/APICache/get
      */
     get<PP extends P, RR extends R>(endpoint: Endpoint<PP, RR>): EndpointCache<PP, RR>;
     /**
@@ -52,7 +52,7 @@ export declare class APICache<P, R> implements AsyncDisposable {
      * @returns The cached or freshly fetched result.
      * @throws Whatever `APIProvider.call` throws if the fetch fails.
      * @example await cache.call(getUser, { id: "abc" })
-     * @see https://dhoulb.github.io/shelving/api/cache/APICache/APICache/call
+     * @see https://shelving.cc/api/APICache/call
      */
     call<PP extends P, RR extends R>(endpoint: Endpoint<PP, RR>, payload: PP, maxAge?: number, caller?: AnyCaller): Promise<RR>;
     /**
@@ -61,7 +61,7 @@ export declare class APICache<P, R> implements AsyncDisposable {
      * @param endpoint The endpoint whose cached payload should be invalidated.
      * @param payload The payload identifying the specific store to invalidate.
      * @example cache.invalidate(getUser, { id: "abc" })
-     * @see https://dhoulb.github.io/shelving/api/cache/APICache/APICache/invalidate
+     * @see https://shelving.cc/api/APICache/invalidate
      */
     invalidate<PP extends P, RR extends R>(endpoint: Endpoint<PP, RR>, payload: PP): void;
     /**
@@ -69,7 +69,7 @@ export declare class APICache<P, R> implements AsyncDisposable {
      *
      * @param endpoint The endpoint whose stores should all be invalidated.
      * @example cache.invalidateAll(getUser)
-     * @see https://dhoulb.github.io/shelving/api/cache/APICache/APICache/invalidateAll
+     * @see https://shelving.cc/api/APICache/invalidateAll
      */
     invalidateAll<PP extends P, RR extends R>(endpoint: Endpoint<PP, RR>): void;
     /**
@@ -79,7 +79,7 @@ export declare class APICache<P, R> implements AsyncDisposable {
      * @param payload The payload identifying the specific store to refresh.
      * @param maxAge The maximum age in milliseconds before a refetch is triggered.
      * @example cache.refresh(getUser, { id: "abc" })
-     * @see https://dhoulb.github.io/shelving/api/cache/APICache/APICache/refresh
+     * @see https://shelving.cc/api/APICache/refresh
      */
     refresh<PP extends P, RR extends R>(endpoint: Endpoint<PP, RR>, payload: PP, maxAge?: number): void;
     /**
@@ -88,7 +88,7 @@ export declare class APICache<P, R> implements AsyncDisposable {
      * @param endpoint The endpoint whose stores should all be refreshed.
      * @param maxAge The maximum age in milliseconds before a refetch is triggered.
      * @example cache.refreshAll(getUser)
-     * @see https://dhoulb.github.io/shelving/api/cache/APICache/APICache/refreshAll
+     * @see https://shelving.cc/api/APICache/refreshAll
      */
     refreshAll<PP extends P, RR extends R>(endpoint: Endpoint<PP, RR>, maxAge?: number): void;
     [Symbol.asyncDispose](): Promise<void>;

package/api/cache/APICache.js

@@ -11,14 +11,14 @@ import { EndpointCache } from "./EndpointCache.js";
  * const cache = new APICache(provider);
  * const user = await cache.call(getUser, { id: "abc" });
  *
- * @see https://dhoulb.github.io/shelving/api/cache/APICache/APICache
+ * @see https://shelving.cc/api/APICache
  */
 export class APICache {
     _endpoints = new Map();
     /**
      * The underlying `APIProvider` that backs every cached endpoint.
      *
-     * @see https://dhoulb.github.io/shelving/api/cache/APICache/APICache/provider
+     * @see https://shelving.cc/api/APICache/provider
      */
     provider;
     /**
@@ -26,7 +26,7 @@ export class APICache {
      *
      * @param provider The `APIProvider` used to fetch results for every cached endpoint.
      * @example new APICache(provider)
-     * @see https://dhoulb.github.io/shelving/api/cache/APICache/APICache
+     * @see https://shelving.cc/api/APICache
      */
     constructor(provider) {
         this.provider = provider;
@@ -50,7 +50,7 @@ export class APICache {
      * @returns The cached or freshly fetched result.
      * @throws Whatever `APIProvider.call` throws if the fetch fails.
      * @example await cache.call(getUser, { id: "abc" })
-     * @see https://dhoulb.github.io/shelving/api/cache/APICache/APICache/call
+     * @see https://shelving.cc/api/APICache/call
      */
     async call(endpoint, payload, maxAge = AVOID_REFRESH, caller = this.call) {
         return this.get(endpoint).call(payload, maxAge, caller);
@@ -61,7 +61,7 @@ export class APICache {
      * @param endpoint The endpoint whose cached payload should be invalidated.
      * @param payload The payload identifying the specific store to invalidate.
      * @example cache.invalidate(getUser, { id: "abc" })
-     * @see https://dhoulb.github.io/shelving/api/cache/APICache/APICache/invalidate
+     * @see https://shelving.cc/api/APICache/invalidate
      */
     invalidate(endpoint, payload) {
         this._get(endpoint)?.invalidate(payload);
@@ -71,7 +71,7 @@ export class APICache {
      *
      * @param endpoint The endpoint whose stores should all be invalidated.
      * @example cache.invalidateAll(getUser)
-     * @see https://dhoulb.github.io/shelving/api/cache/APICache/APICache/invalidateAll
+     * @see https://shelving.cc/api/APICache/invalidateAll
      */
     invalidateAll(endpoint) {
         this._get(endpoint)?.invalidateAll();
@@ -83,7 +83,7 @@ export class APICache {
      * @param payload The payload identifying the specific store to refresh.
      * @param maxAge The maximum age in milliseconds before a refetch is triggered.
      * @example cache.refresh(getUser, { id: "abc" })
-     * @see https://dhoulb.github.io/shelving/api/cache/APICache/APICache/refresh
+     * @see https://shelving.cc/api/APICache/refresh
      */
     refresh(endpoint, payload, maxAge) {
         this._get(endpoint)?.refresh(payload, maxAge);
@@ -94,7 +94,7 @@ export class APICache {
      * @param endpoint The endpoint whose stores should all be refreshed.
      * @param maxAge The maximum age in milliseconds before a refetch is triggered.
      * @example cache.refreshAll(getUser)
-     * @see https://dhoulb.github.io/shelving/api/cache/APICache/APICache/refreshAll
+     * @see https://shelving.cc/api/APICache/refreshAll
      */
     refreshAll(endpoint, maxAge) {
         this._get(endpoint)?.refreshAll(maxAge);

package/api/cache/EndpointCache.d.ts

@@ -11,20 +11,20 @@ import { EndpointStore } from "../store/EndpointStore.js";
  * const cache = new EndpointCache(getUser, provider);
  * const user = await cache.call({ id: "abc" });
  *
- * @see https://dhoulb.github.io/shelving/api/cache/EndpointCache/EndpointCache
+ * @see https://shelving.cc/api/EndpointCache
  */
 export declare class EndpointCache<P = unknown, R = unknown> implements AsyncDisposable {
     private readonly _endpoints;
     /**
      * The endpoint that every store in this cache fetches from.
      *
-     * @see https://dhoulb.github.io/shelving/api/cache/EndpointCache/EndpointCache/endpoint
+     * @see https://shelving.cc/api/EndpointCache/endpoint
      */
     readonly endpoint: Endpoint<P, R>;
     /**
      * The `APIProvider` used to render URLs and fetch results for this endpoint.
      *
-     * @see https://dhoulb.github.io/shelving/api/cache/EndpointCache/EndpointCache/provider
+     * @see https://shelving.cc/api/EndpointCache/provider
      */
     readonly provider: APIProvider<P, R>;
     /**
@@ -33,7 +33,7 @@ export declare class EndpointCache<P = unknown, R = unknown> implements AsyncDis
      * @param endpoint The endpoint that every cached store fetches from.
      * @param provider The `APIProvider` used to render URLs and fetch results.
      * @example new EndpointCache(getUser, provider)
-     * @see https://dhoulb.github.io/shelving/api/cache/EndpointCache/EndpointCache
+     * @see https://shelving.cc/api/EndpointCache
      */
     constructor(endpoint: Endpoint<P, R>, provider: APIProvider<P, R>);
     /**
@@ -44,7 +44,7 @@ export declare class EndpointCache<P = unknown, R = unknown> implements AsyncDis
      * @param caller The function to attribute thrown errors to (defaults to this method).
      * @returns The existing `EndpointStore` for `payload`, or a newly created one.
      * @example cache.get({ id: "abc" })
-     * @see https://dhoulb.github.io/shelving/api/cache/EndpointCache/EndpointCache/get
+     * @see https://shelving.cc/api/EndpointCache/get
      */
     get(payload: P, caller?: AnyCaller): EndpointStore<P, R>;
     /**
@@ -59,7 +59,7 @@ export declare class EndpointCache<P = unknown, R = unknown> implements AsyncDis
      * @returns The cached or freshly fetched result.
      * @throws Whatever `APIProvider.call` throws if the fetch fails.
      * @example await cache.call({ id: "abc" })
-     * @see https://dhoulb.github.io/shelving/api/cache/EndpointCache/EndpointCache/call
+     * @see https://shelving.cc/api/EndpointCache/call
      */
     call(payload: P, maxAge?: number, caller?: AnyCaller): Promise<R>;
     /**
@@ -68,14 +68,14 @@ export declare class EndpointCache<P = unknown, R = unknown> implements AsyncDis
      * @param payload The payload identifying the store to invalidate.
      * @param caller The function to attribute thrown errors to (defaults to this method).
      * @example cache.invalidate({ id: "abc" })
-     * @see https://dhoulb.github.io/shelving/api/cache/EndpointCache/EndpointCache/invalidate
+     * @see https://shelving.cc/api/EndpointCache/invalidate
      */
     invalidate(payload: P, caller?: AnyCaller): void;
     /**
      * Invalidate all stores so the next read of any payload refetches.
      *
      * @example cache.invalidateAll()
-     * @see https://dhoulb.github.io/shelving/api/cache/EndpointCache/EndpointCache/invalidateAll
+     * @see https://shelving.cc/api/EndpointCache/invalidateAll
      */
     invalidateAll(): void;
     /**
@@ -86,7 +86,7 @@ export declare class EndpointCache<P = unknown, R = unknown> implements AsyncDis
      * @param caller The function to attribute thrown errors to (defaults to this method).
      * @returns A promise that resolves when the refetch settles.
      * @example await cache.refresh({ id: "abc" })
-     * @see https://dhoulb.github.io/shelving/api/cache/EndpointCache/EndpointCache/refresh
+     * @see https://shelving.cc/api/EndpointCache/refresh
      */
     refresh(payload: P, maxAge?: number, caller?: AnyCaller): Promise<void>;
     /**
@@ -95,7 +95,7 @@ export declare class EndpointCache<P = unknown, R = unknown> implements AsyncDis
      * @param maxAge The maximum age in milliseconds before a refetch is triggered.
      * @returns A promise that resolves when every refetch settles.
      * @example await cache.refreshAll()
-     * @see https://dhoulb.github.io/shelving/api/cache/EndpointCache/EndpointCache/refreshAll
+     * @see https://shelving.cc/api/EndpointCache/refreshAll
      */
     refreshAll(maxAge?: number): Promise<void>;
     [Symbol.asyncDispose](): Promise<void>;

package/api/cache/EndpointCache.js

@@ -12,20 +12,20 @@ import { EndpointStore } from "../store/EndpointStore.js";
  * const cache = new EndpointCache(getUser, provider);
  * const user = await cache.call({ id: "abc" });
  *
- * @see https://dhoulb.github.io/shelving/api/cache/EndpointCache/EndpointCache
+ * @see https://shelving.cc/api/EndpointCache
  */
 export class EndpointCache {
     _endpoints = new Map();
     /**
      * The endpoint that every store in this cache fetches from.
      *
-     * @see https://dhoulb.github.io/shelving/api/cache/EndpointCache/EndpointCache/endpoint
+     * @see https://shelving.cc/api/EndpointCache/endpoint
      */
     endpoint;
     /**
      * The `APIProvider` used to render URLs and fetch results for this endpoint.
      *
-     * @see https://dhoulb.github.io/shelving/api/cache/EndpointCache/EndpointCache/provider
+     * @see https://shelving.cc/api/EndpointCache/provider
      */
     provider;
     /**
@@ -34,7 +34,7 @@ export class EndpointCache {
      * @param endpoint The endpoint that every cached store fetches from.
      * @param provider The `APIProvider` used to render URLs and fetch results.
      * @example new EndpointCache(getUser, provider)
-     * @see https://dhoulb.github.io/shelving/api/cache/EndpointCache/EndpointCache
+     * @see https://shelving.cc/api/EndpointCache
      */
     constructor(endpoint, provider) {
         this.endpoint = endpoint;
@@ -48,7 +48,7 @@ export class EndpointCache {
      * @param caller The function to attribute thrown errors to (defaults to this method).
      * @returns The existing `EndpointStore` for `payload`, or a newly created one.
      * @example cache.get({ id: "abc" })
-     * @see https://dhoulb.github.io/shelving/api/cache/EndpointCache/EndpointCache/get
+     * @see https://shelving.cc/api/EndpointCache/get
      */
     get(payload, caller = this.get) {
         const url = this.provider.renderURL(this.endpoint, payload, caller).href;
@@ -66,7 +66,7 @@ export class EndpointCache {
      * @returns The cached or freshly fetched result.
      * @throws Whatever `APIProvider.call` throws if the fetch fails.
      * @example await cache.call({ id: "abc" })
-     * @see https://dhoulb.github.io/shelving/api/cache/EndpointCache/EndpointCache/call
+     * @see https://shelving.cc/api/EndpointCache/call
      */
     async call(payload, maxAge = AVOID_REFRESH, caller = this.call) {
         const store = this.get(payload, caller);
@@ -79,7 +79,7 @@ export class EndpointCache {
      * @param payload The payload identifying the store to invalidate.
      * @param caller The function to attribute thrown errors to (defaults to this method).
      * @example cache.invalidate({ id: "abc" })
-     * @see https://dhoulb.github.io/shelving/api/cache/EndpointCache/EndpointCache/invalidate
+     * @see https://shelving.cc/api/EndpointCache/invalidate
      */
     invalidate(payload, caller = this.invalidate) {
         this.get(payload, caller)?.invalidate();
@@ -88,7 +88,7 @@ export class EndpointCache {
      * Invalidate all stores so the next read of any payload refetches.
      *
      * @example cache.invalidateAll()
-     * @see https://dhoulb.github.io/shelving/api/cache/EndpointCache/EndpointCache/invalidateAll
+     * @see https://shelving.cc/api/EndpointCache/invalidateAll
      */
     invalidateAll() {
         for (const store of this._endpoints.values())
@@ -102,7 +102,7 @@ export class EndpointCache {
      * @param caller The function to attribute thrown errors to (defaults to this method).
      * @returns A promise that resolves when the refetch settles.
      * @example await cache.refresh({ id: "abc" })
-     * @see https://dhoulb.github.io/shelving/api/cache/EndpointCache/EndpointCache/refresh
+     * @see https://shelving.cc/api/EndpointCache/refresh
      */
     async refresh(payload, maxAge, caller = this.invalidate) {
         await this.get(payload, caller)?.refresh(maxAge);
@@ -113,7 +113,7 @@ export class EndpointCache {
      * @param maxAge The maximum age in milliseconds before a refetch is triggered.
      * @returns A promise that resolves when every refetch settles.
      * @example await cache.refreshAll()
-     * @see https://dhoulb.github.io/shelving/api/cache/EndpointCache/EndpointCache/refreshAll
+     * @see https://shelving.cc/api/EndpointCache/refreshAll
      */
     async refreshAll(maxAge) {
         await awaitValues(...this._endpoints.values().map(store => store.refresh(maxAge)));

package/api/endpoint/Endpoint.d.ts

@@ -19,37 +19,37 @@ import type { EndpointCallback, EndpointHandler } from "./util.js";
  * @example
  * const getUser = new Endpoint("GET", "/users/{id}", USER_PAYLOAD, USER_RESULT);
  *
- * @see https://dhoulb.github.io/shelving/api/endpoint/Endpoint/Endpoint
+ * @see https://shelving.cc/api/Endpoint
  */
 export declare class Endpoint<P = unknown, R = unknown> {
     /**
      * The HTTP method this endpoint responds to, e.g. `GET`
      *
-     * @see https://dhoulb.github.io/shelving/api/endpoint/Endpoint/Endpoint/method
+     * @see https://shelving.cc/api/Endpoint/method
      */
     readonly method: RequestMethod;
     /**
      * Endpoint path, possibly including placeholders e.g. `/users/{id}`
      *
-     * @see https://dhoulb.github.io/shelving/api/endpoint/Endpoint/Endpoint/path
+     * @see https://shelving.cc/api/Endpoint/path
      */
     readonly path: AbsolutePath;
     /**
      * The `{placeholder}` segments extracted from `path`, used to render and match URLs.
      *
-     * @see https://dhoulb.github.io/shelving/api/endpoint/Endpoint/Endpoint/placeholders
+     * @see https://shelving.cc/api/Endpoint/placeholders
      */
     readonly placeholders: TemplatePlaceholders;
     /**
      * The `Schema` that request payloads are validated against.
      *
-     * @see https://dhoulb.github.io/shelving/api/endpoint/Endpoint/Endpoint/payload
+     * @see https://shelving.cc/api/Endpoint/payload
      */
     readonly payload: Schema<P>;
     /**
      * The `Schema` that response results are validated against.
      *
-     * @see https://dhoulb.github.io/shelving/api/endpoint/Endpoint/Endpoint/result
+     * @see https://shelving.cc/api/Endpoint/result
      */
     readonly result: Schema<R>;
     constructor(method: RequestMethod, path: AbsolutePath, payload: Schema<P>, result: Schema<R>);
@@ -62,7 +62,7 @@ export declare class Endpoint<P = unknown, R = unknown> {
      * @returns The rendered absolute path, with any `{placeholders}` filled from `payload`.
      * @throws {RequiredError} if this endpoint's path has `{placeholders}` but `payload` is not a data object.
      * @example endpoint.renderPath({ id: "abc" }) // "/users/abc"
-     * @see https://dhoulb.github.io/shelving/api/endpoint/Endpoint/Endpoint/renderPath
+     * @see https://shelving.cc/api/Endpoint/renderPath
      */
     renderPath(payload: P, caller?: AnyCaller): AbsolutePath;
     /**
@@ -73,7 +73,7 @@ export declare class Endpoint<P = unknown, R = unknown> {
      * @param caller The function to attribute thrown errors to (defaults to this method).
      * @returns A dictionary of matched `{placeholder}` params, or `undefined` if the method or path doesn't match.
      * @example endpoint.match("GET", "/users/abc") // { id: "abc" }
-     * @see https://dhoulb.github.io/shelving/api/endpoint/Endpoint/Endpoint/match
+     * @see https://shelving.cc/api/Endpoint/match
      */
     match(method: RequestMethod, path: AbsolutePath, caller?: AnyCaller): RequestParams | undefined;
     /**
@@ -82,7 +82,7 @@ export declare class Endpoint<P = unknown, R = unknown> {
      * @param callback The callback function that implements the logic for this endpoint by receiving the payload and returning the response.
      * @returns An `EndpointHandler` object combining this endpoint and the callback into a single typed object.
      * @example endpoint.handler((payload, request) => ({ ...payload }))
-     * @see https://dhoulb.github.io/shelving/api/endpoint/Endpoint/Endpoint/handler
+     * @see https://shelving.cc/api/Endpoint/handler
      */
     handler<C>(callback: EndpointCallback<P, R, C>): EndpointHandler<P, R, C>;
     /**
@@ -90,32 +90,32 @@ export declare class Endpoint<P = unknown, R = unknown> {
      *
      * @returns The method and path joined with a space, e.g. `GET /user/{id}`
      * @example endpoint.toString() // "GET /users/{id}"
-     * @see https://dhoulb.github.io/shelving/api/endpoint/Endpoint/Endpoint/toString
+     * @see https://shelving.cc/api/Endpoint/toString
      */
     toString(): string;
 }
 /**
  * An `Endpoint` with any payload and result type, for use where the specific types don't matter.
  *
- * @see https://dhoulb.github.io/shelving/api/endpoint/Endpoint/AnyEndpoint
+ * @see https://shelving.cc/api/AnyEndpoint
  */
 export type AnyEndpoint = Endpoint<any, any>;
 /**
  * An immutable list of endpoints.
  *
- * @see https://dhoulb.github.io/shelving/api/endpoint/Endpoint/Endpoints
+ * @see https://shelving.cc/api/Endpoints
  */
 export type Endpoints = ImmutableArray<AnyEndpoint>;
 /**
  * Extract the payload type from an `Endpoint`.
  *
- * @see https://dhoulb.github.io/shelving/api/endpoint/Endpoint/PayloadType
+ * @see https://shelving.cc/api/PayloadType
  */
 export type PayloadType<X extends Endpoint<unknown, unknown>> = X extends Endpoint<infer Y, unknown> ? Y : never;
 /**
  * Extract the result type from an `Endpoint`.
  *
- * @see https://dhoulb.github.io/shelving/api/endpoint/Endpoint/EndpointType
+ * @see https://shelving.cc/api/EndpointType
  */
 export type EndpointType<X extends Endpoint<unknown, unknown>> = X extends Endpoint<unknown, infer Y> ? Y : never;
 /**
@@ -129,7 +129,7 @@ export type EndpointType<X extends Endpoint<unknown, unknown>> = X extends Endpo
  * @param result An optional `Schema` validating the response result.
  * @returns An `Endpoint` configured for the `HEAD` method.
  * @example HEAD("/users/{id}")
- * @see https://dhoulb.github.io/shelving/api/endpoint/Endpoint/HEAD
+ * @see https://shelving.cc/api/HEAD
  */
 export declare function HEAD<P extends Data, R>(path: AbsolutePath, payload?: Schema<P>, result?: Schema<R>): Endpoint<P, R>;
 export declare function HEAD<P extends Data>(path: AbsolutePath, payload: Schema<P>): Endpoint<P, undefined>;
@@ -145,7 +145,7 @@ export declare function HEAD<R>(path: AbsolutePath, payload: undefined, result:
  * @param result An optional `Schema` validating the response result.
  * @returns An `Endpoint` configured for the `GET` method.
  * @example GET("/users/{id}", undefined, USER)
- * @see https://dhoulb.github.io/shelving/api/endpoint/Endpoint/GET
+ * @see https://shelving.cc/api/GET
  */
 export declare function GET<P extends Data, R>(path: AbsolutePath, payload?: Schema<P>, result?: Schema<R>): Endpoint<P, R>;
 export declare function GET<P extends Data>(path: AbsolutePath, payload: Schema<P>): Endpoint<P, undefined>;
@@ -161,7 +161,7 @@ export declare function GET<R>(path: AbsolutePath, payload: undefined, result: S
  * @param result An optional `Schema` validating the response result.
  * @returns An `Endpoint` configured for the `POST` method.
  * @example POST("/users", USER, USER_RESULT)
- * @see https://dhoulb.github.io/shelving/api/endpoint/Endpoint/POST
+ * @see https://shelving.cc/api/POST
  */
 export declare function POST<P, R>(path: AbsolutePath, payload?: Schema<P>, result?: Schema<R>): Endpoint<P, R>;
 export declare function POST<P>(path: AbsolutePath, payload: Schema<P>): Endpoint<P, undefined>;
@@ -177,7 +177,7 @@ export declare function POST<R>(path: AbsolutePath, payload: undefined, result:
  * @param result An optional `Schema` validating the response result.
  * @returns An `Endpoint` configured for the `PUT` method.
  * @example PUT("/users/{id}", USER)
- * @see https://dhoulb.github.io/shelving/api/endpoint/Endpoint/PUT
+ * @see https://shelving.cc/api/PUT
  */
 export declare function PUT<P, R>(path: AbsolutePath, payload?: Schema<P>, result?: Schema<R>): Endpoint<P, R>;
 export declare function PUT<P>(path: AbsolutePath, payload: Schema<P>): Endpoint<P, undefined>;
@@ -193,7 +193,7 @@ export declare function PUT<R>(path: AbsolutePath, payload: undefined, result: S
  * @param result An optional `Schema` validating the response result.
  * @returns An `Endpoint` configured for the `PATCH` method.
  * @example PATCH("/users/{id}", PARTIAL_USER)
- * @see https://dhoulb.github.io/shelving/api/endpoint/Endpoint/PATCH
+ * @see https://shelving.cc/api/PATCH
  */
 export declare function PATCH<P, R>(path: AbsolutePath, payload?: Schema<P>, result?: Schema<R>): Endpoint<P, R>;
 export declare function PATCH<P>(path: AbsolutePath, payload: Schema<P>): Endpoint<P, undefined>;
@@ -209,7 +209,7 @@ export declare function PATCH<R>(path: AbsolutePath, payload: undefined, result:
  * @param result An optional `Schema` validating the response result.
  * @returns An `Endpoint` configured for the `DELETE` method.
  * @example DELETE("/users/{id}")
- * @see https://dhoulb.github.io/shelving/api/endpoint/Endpoint/DELETE
+ * @see https://shelving.cc/api/DELETE
  */
 export declare function DELETE<P, R>(path: AbsolutePath, payload?: Schema<P>, result?: Schema<R>): Endpoint<P, R>;
 export declare function DELETE<P>(path: AbsolutePath, payload: Schema<P>): Endpoint<P, undefined>;

package/api/endpoint/Endpoint.js

@@ -15,37 +15,37 @@ import { getPlaceholders, matchPathTemplate, renderPathTemplate } from "../../ut
  * @example
  * const getUser = new Endpoint("GET", "/users/{id}", USER_PAYLOAD, USER_RESULT);
  *
- * @see https://dhoulb.github.io/shelving/api/endpoint/Endpoint/Endpoint
+ * @see https://shelving.cc/api/Endpoint
  */
 export class Endpoint {
     /**
      * The HTTP method this endpoint responds to, e.g. `GET`
      *
-     * @see https://dhoulb.github.io/shelving/api/endpoint/Endpoint/Endpoint/method
+     * @see https://shelving.cc/api/Endpoint/method
      */
     method;
     /**
      * Endpoint path, possibly including placeholders e.g. `/users/{id}`
      *
-     * @see https://dhoulb.github.io/shelving/api/endpoint/Endpoint/Endpoint/path
+     * @see https://shelving.cc/api/Endpoint/path
      */
     path;
     /**
      * The `{placeholder}` segments extracted from `path`, used to render and match URLs.
      *
-     * @see https://dhoulb.github.io/shelving/api/endpoint/Endpoint/Endpoint/placeholders
+     * @see https://shelving.cc/api/Endpoint/placeholders
      */
     placeholders;
     /**
      * The `Schema` that request payloads are validated against.
      *
-     * @see https://dhoulb.github.io/shelving/api/endpoint/Endpoint/Endpoint/payload
+     * @see https://shelving.cc/api/Endpoint/payload
      */
     payload;
     /**
      * The `Schema` that response results are validated against.
      *
-     * @see https://dhoulb.github.io/shelving/api/endpoint/Endpoint/Endpoint/result
+     * @see https://shelving.cc/api/Endpoint/result
      */
     result;
     constructor(method, path, payload, result) {
@@ -64,7 +64,7 @@ export class Endpoint {
      * @returns The rendered absolute path, with any `{placeholders}` filled from `payload`.
      * @throws {RequiredError} if this endpoint's path has `{placeholders}` but `payload` is not a data object.
      * @example endpoint.renderPath({ id: "abc" }) // "/users/abc"
-     * @see https://dhoulb.github.io/shelving/api/endpoint/Endpoint/Endpoint/renderPath
+     * @see https://shelving.cc/api/Endpoint/renderPath
      */
     renderPath(payload, caller = this.renderPath) {
         // Placeholders.
@@ -83,7 +83,7 @@ export class Endpoint {
      * @param caller The function to attribute thrown errors to (defaults to this method).
      * @returns A dictionary of matched `{placeholder}` params, or `undefined` if the method or path doesn't match.
      * @example endpoint.match("GET", "/users/abc") // { id: "abc" }
-     * @see https://dhoulb.github.io/shelving/api/endpoint/Endpoint/Endpoint/match
+     * @see https://shelving.cc/api/Endpoint/match
      */
     match(method, path, caller = this.match) {
         if (method !== this.method)
@@ -96,7 +96,7 @@ export class Endpoint {
      * @param callback The callback function that implements the logic for this endpoint by receiving the payload and returning the response.
      * @returns An `EndpointHandler` object combining this endpoint and the callback into a single typed object.
      * @example endpoint.handler((payload, request) => ({ ...payload }))
-     * @see https://dhoulb.github.io/shelving/api/endpoint/Endpoint/Endpoint/handler
+     * @see https://shelving.cc/api/Endpoint/handler
      */
     handler(callback) {
         return { endpoint: this, callback };
@@ -106,7 +106,7 @@ export class Endpoint {
      *
      * @returns The method and path joined with a space, e.g. `GET /user/{id}`
      * @example endpoint.toString() // "GET /users/{id}"
-     * @see https://dhoulb.github.io/shelving/api/endpoint/Endpoint/Endpoint/toString
+     * @see https://shelving.cc/api/Endpoint/toString
      */
     toString() {
         return `${this.method} ${this.path}`;

package/api/endpoint/util.d.ts

@@ -11,14 +11,14 @@ import type { Endpoint } from "./Endpoint.js";
  * @returns {Response} Returning a `Response` object (this will pass back to the client without validation).
  * @returns {R} Returning the return type of the handler (this will be validated against the Endpoint's result schema).
  *
- * @see https://dhoulb.github.io/shelving/api/endpoint/util/EndpointCallback
+ * @see https://shelving.cc/api/EndpointCallback
  */
 export type EndpointCallback<P, R, C = void> = (payload: P, request: Request, context: C) => R | Response | Promise<R | Response>;
 /**
  * A typed endpoint definition paired with its implementation callback.
  * - Created with `Endpoint.handler()`; matched and invoked by `handleEndpoints()`.
  *
- * @see https://dhoulb.github.io/shelving/api/endpoint/util/EndpointHandler
+ * @see https://shelving.cc/api/EndpointHandler
  */
 export interface EndpointHandler<P, R, C = void> {
     readonly endpoint: Endpoint<P, R>;
@@ -27,13 +27,13 @@ export interface EndpointHandler<P, R, C = void> {
 /**
  * An `EndpointHandler` with any payload and result type, for use where the specific types don't matter.
  *
- * @see https://dhoulb.github.io/shelving/api/endpoint/util/AnyEndpointHandler
+ * @see https://shelving.cc/api/AnyEndpointHandler
  */
 export type AnyEndpointHandler<C = any> = EndpointHandler<any, any, C>;
 /**
  * A collection of endpoint handlers that can be matched and invoked by `handleEndpoints()`.
  *
- * @see https://dhoulb.github.io/shelving/api/endpoint/util/EndpointHandlers
+ * @see https://shelving.cc/api/EndpointHandlers
  */
 export type EndpointHandlers<C = void> = Iterable<AnyEndpointHandler<C>>;
 /**
@@ -51,7 +51,7 @@ export type EndpointHandlers<C = void> = Iterable<AnyEndpointHandler<C>>;
  * @throws {MethodNotAllowedError} if the request method is not a supported HTTP method.
  * @throws {NotFoundError} if no base path matches, or no endpoint matches the target path.
  * @example await handleEndpoints("https://myapi.com", [getUser.handler(loadUser)], request, undefined)
- * @see https://dhoulb.github.io/shelving/api/endpoint/util/handleEndpoints
+ * @see https://shelving.cc/api/handleEndpoints
  */
 export declare function handleEndpoints<C>(base: PossibleURL, handlers: EndpointHandlers<C>, request: Request, context: C, caller?: AnyCaller): Promise<Response>;
 export declare function handleEndpoints(base: PossibleURL, handlers: EndpointHandlers<void>, request: Request, context?: undefined, caller?: AnyCaller): Promise<Response>;