shelving 1.124.2 → 1.124.3

package/markup/options.d.ts

@@ -1,5 +1,5 @@
 import type { MarkupRules } from "./rule.js";
-import type { Link, LinkHosts, LinkSchemes } from "../util/link.js";
+import type { AbsoluteLink, LinkHosts, LinkSchemes } from "../util/link.js";
 /** The current parsing options (represents the current state of the parsing). */
 export type MarkupOptions = {
     /** The active list of parsing rules. */
@@ -9,7 +9,7 @@ export type MarkupOptions = {
     /** Set the `rel=""` property used for any links (e.g. `rel="nofollow ugc"`). */
     readonly rel: string | undefined;
     /** Set the base URL that any relative links will be relative to (defaults to `window.location.href`, if undefined then relative links won't work). */
-    readonly base: Link | undefined;
+    readonly base: AbsoluteLink | undefined;
     /** Valid URL schemes/protocols for links (including trailing commas), defaults to `[`http:`, `https:`]` */
     readonly schemes: LinkSchemes | undefined;
     /** Valid URL hosts for links (including trailing commas) */

package/package.json

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

package/schema/LinkSchema.d.ts

@@ -1,10 +1,10 @@
 import type { StringSchemaOptions } from "./StringSchema.js";
 import type { ImmutableArray } from "../util/array.js";
-import { type Link } from "../util/link.js";
+import { type AbsoluteLink } from "../util/link.js";
 import { StringSchema } from "./StringSchema.js";
 /** Allowed options for `LinkSchema` */
 export interface LinkSchemaOptions extends Omit<StringSchemaOptions, "type" | "min" | "max" | "multiline"> {
-    readonly base?: Link | undefined;
+    readonly base?: AbsoluteLink | undefined;
     readonly schemes?: ImmutableArray<string> | undefined;
     readonly hosts?: ImmutableArray<string> | undefined;
 }
@@ -15,11 +15,11 @@ export interface LinkSchemaOptions extends Omit<StringSchemaOptions, "type" | "m
  * - Falsy values are converted to `""` empty string.
  */
 export declare class LinkSchema extends StringSchema {
-    readonly base: Link | undefined;
+    readonly base: AbsoluteLink | undefined;
     readonly schemes: ImmutableArray<string> | undefined;
     readonly hosts: ImmutableArray<string> | undefined;
     constructor({ base, schemes, hosts, title, ...options }: LinkSchemaOptions);
-    validate(unsafeValue: unknown): Link;
+    validate(unsafeValue: unknown): AbsoluteLink;
 }
 /** Valid link, e.g. `https://www.google.com` */
 export declare const LINK: LinkSchema;

package/util/link.d.ts

@@ -1,35 +1,38 @@
 import type { ImmutableArray } from "./array.js";
 import type { Optional } from "./optional.js";
-import { type AbsolutePath } from "./path.js";
+import { type Path } from "./path.js";
 import { type PossibleURL } from "./url.js";
-/** List of allowed schemes for a link. */
-export type LinkSchemes = ImmutableArray<string>;
-/** List of allowed hosts for a link. */
-export type LinkHosts = ImmutableArray<string>;
 /**
  * URL string with a `scheme:` at the start and a path component, e.g. `https://` or `file://`
  * - The `//` in a URI indicates that type of URI has a path heirarchy indicated by the first `/` after the `://`
  * - If the URI has no explicit `/path` component it will always be assumed to be `/`
  * - Some URIs are non-heirarchical, e.g. `mailto:me@gmail.com`
  */
-export type Link = `${string}:${string}`;
+export type AbsoluteLink = `${string}:${string}`;
+/** Relative link starts with `./` or `../` or `/` */
+export type RelativeLink = Path;
+/** Either an absolute URL string or a relative URL string. */
+export type Link = AbsoluteLink | RelativeLink;
+/** List of allowed schemes for a link. */
+export type LinkSchemes = ImmutableArray<string>;
+/** List of allowed hosts for a link. */
+export type LinkHosts = ImmutableArray<string>;
 /**
- * Link URL is a URL that has an `href` that is a `Link` element and a `pathname` that is an `AbsolutePath` property.
+ * Absolute URL is a URL that has an `href` that is a `Link` element and a `pathname` that is an `AbsolutePath` property.
  * - e.g. `http://x.com/a/b` is a link URL because `.pathname` will be `/a/b`
  * - e.g. `http://x.com` is a link URL because `.pathname` will be `/`
  * - e.g. `mailto:me@gmail.com` is _not_ an absolute URL because `.pathname` will be `"me@gmail.com"` which does not start with `/` slash.
  */
-export type LinkURL = URL & {
-    href: Link;
-    pathname: AbsolutePath;
+export type AbsoluteLinkURL = URL & {
+    href: AbsoluteLink;
 };
 /** Is an unknown value a URL object with an absolute path component? */
-export declare function isLinkURL(value: unknown): value is LinkURL;
+export declare function isLinkURL(value: unknown): value is AbsoluteLinkURL;
 /** Convert a possible URL to a URL or return `undefined` if conversion fails. */
-export declare function getOptionalLinkURL(possible: Optional<PossibleURL>, base?: LinkURL | Link, schemes?: LinkSchemes, hosts?: LinkHosts): LinkURL | undefined;
+export declare function getOptionalLinkURL(possible: Optional<PossibleURL>, base?: AbsoluteLinkURL | AbsoluteLink, schemes?: LinkSchemes, hosts?: LinkHosts): AbsoluteLinkURL | undefined;
 /** Convert a possible URL to a URL or return `undefined` if conversion fails. */
-export declare function getLinkURL(possible: PossibleURL, base?: LinkURL | Link, schemes?: LinkSchemes, hosts?: LinkHosts): LinkURL;
+export declare function getLinkURL(possible: PossibleURL, base?: AbsoluteLinkURL | AbsoluteLink, schemes?: LinkSchemes, hosts?: LinkHosts): AbsoluteLinkURL;
 /** Convert a possible URL to a absolute URL string or return `undefined` if conversion fails. */
-export declare function getOptionalLink(possible: Optional<PossibleURL>, base?: LinkURL | Link, schemes?: LinkSchemes, hosts?: LinkHosts): Link | undefined;
+export declare function getOptionalLink(possible: Optional<PossibleURL>, base?: AbsoluteLinkURL | AbsoluteLink, schemes?: LinkSchemes, hosts?: LinkHosts): AbsoluteLink | undefined;
 /** Convert a possible URL to an absolute URL string. */
-export declare function getLink(possible: PossibleURL, base?: LinkURL | Link, schemes?: LinkSchemes, hosts?: LinkHosts): Link;
+export declare function getLink(possible: PossibleURL, base?: AbsoluteLinkURL | AbsoluteLink, schemes?: LinkSchemes, hosts?: LinkHosts): AbsoluteLink;