shelving 1.113.0 → 1.115.0

package/package.json

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

package/store/PathStore.d.ts

@@ -0,0 +1,14 @@
+import type { AbsolutePath } from "../util/path.js";
+import type { PossibleStarter } from "../util/start.js";
+import { Store } from "./Store.js";
+/** Store an absolute path, e.g. `/a/b/c` */
+export declare class PathStore extends Store<AbsolutePath> {
+    constructor(path?: AbsolutePath, time?: number, start?: PossibleStarter<[Store<AbsolutePath>]>);
+    /** Based on the current store path, is a path active? */
+    isActive(path: AbsolutePath): boolean;
+    /** Based on the current store path, is a path proud (i.e. a child of the current store path)? */
+    isProud(path: AbsolutePath): boolean;
+    /** Get an absolute path from a path relative to the current navigation path. */
+    getAbsolute(path: string): AbsolutePath;
+    set(path: string): void;
+}

package/store/PathStore.js

@@ -0,0 +1,24 @@
+import { getPath, isPathActive, isPathProud } from "../util/path.js";
+import { Store } from "./Store.js";
+/** Store an absolute path, e.g. `/a/b/c` */
+export class PathStore extends Store {
+    constructor(path = window.location.pathname, time, start) {
+        super(path, time, start);
+    }
+    /** Based on the current store path, is a path active? */
+    isActive(path) {
+        return isPathActive(path, this.value);
+    }
+    /** Based on the current store path, is a path proud (i.e. a child of the current store path)? */
+    isProud(path) {
+        return isPathProud(path, this.value);
+    }
+    /** Get an absolute path from a path relative to the current navigation path. */
+    getAbsolute(path) {
+        return getPath(path, this.value);
+    }
+    // Override to clean the path.
+    set(path) {
+        super.set(getPath(path, this.value));
+    }
+}

package/store/index.d.ts

@@ -2,4 +2,5 @@ export * from "./Store.js";
 export * from "./ArrayStore.js";
 export * from "./BooleanStore.js";
 export * from "./DataStore.js";
+export * from "./PathStore.js";
 export * from "./DictionaryStore.js";

package/store/index.js

@@ -2,4 +2,5 @@ export * from "./Store.js";
 export * from "./ArrayStore.js";
 export * from "./BooleanStore.js";
 export * from "./DataStore.js";
+export * from "./PathStore.js";
 export * from "./DictionaryStore.js";

package/util/index.d.ts

@@ -18,7 +18,6 @@ export * from "./equal.js";
 export * from "./error.js";
 export * from "./focus.js";
 export * from "./function.js";
-export * from "./start.js";
 export * from "./hash.js";
 export * from "./hydrate.js";
 export * from "./item.js";
@@ -32,6 +31,7 @@ export * from "./null.js";
 export * from "./number.js";
 export * from "./object.js";
 export * from "./optional.js";
+export * from "./path.js";
 export * from "./query.js";
 export * from "./random.js";
 export * from "./regexp.js";
@@ -39,6 +39,7 @@ export * from "./sequence.js";
 export * from "./serialise.js";
 export * from "./sort.js";
 export * from "./source.js";
+export * from "./start.js";
 export * from "./string.js";
 export * from "./template.js";
 export * from "./time.js";

package/util/index.js

@@ -18,7 +18,6 @@ export * from "./equal.js";
 export * from "./error.js";
 export * from "./focus.js";
 export * from "./function.js";
-export * from "./start.js";
 export * from "./hash.js";
 export * from "./hydrate.js";
 export * from "./item.js";
@@ -32,6 +31,7 @@ export * from "./null.js";
 export * from "./number.js";
 export * from "./object.js";
 export * from "./optional.js";
+export * from "./path.js";
 export * from "./query.js";
 export * from "./random.js";
 export * from "./regexp.js";
@@ -39,6 +39,7 @@ export * from "./sequence.js";
 export * from "./serialise.js";
 export * from "./sort.js";
 export * from "./source.js";
+export * from "./start.js";
 export * from "./string.js";
 export * from "./template.js";
 export * from "./time.js";

package/util/path.d.ts

@@ -0,0 +1,30 @@
+/** Absolute path starts with `/` slash. */
+export type AbsolutePath = `/` | `/${string}`;
+/** Relative path starts with `./` or `../` */
+export type RelativePath = `.` | `./${string}` | `..` | `../${string}`;
+/** Is a string path an absolute path? */
+export declare const isAbsolutePath: (path: string) => path is `/${string}`;
+/** Is a string path an absolute path? */
+export declare const isRelativePath: (path: string) => path is RelativePath;
+/**
+ * Clean a path.
+ * - Runs of `//` two or more slashes are normalised to `/` single slash, e.g. `/a//b` becomes `/a/b`
+ * - `\` Windows slashes are nromalised to `/` UNIX slashes.
+ * - Trailing slashes are removed, e.g. `/a/b/` becomes `/a/b`
+ */
+export declare function cleanPath(path: AbsolutePath): AbsolutePath;
+export declare function cleanPath(path: string): string;
+/**
+ * Resolve an absolute path.
+ * - Uses `new URL` to do path processing, so URL strings e.g.
+ * - Returned paths are cleaned with `cleanPath()` so runs of slashes and trailing slashes are removed.
+ *
+ * @param path Absolute path e.g. `/a/b/c`, relative path e.g. `./a` or `b` or `../c`, URL string e.g. `http://shax.com/a/b/c`, or `URL` instance.
+ * @param base Absolute path or `URL` instance used for resolving relative paths in `path`
+ * @return Absolute path with a leading trailing slash, e.g. `/a/c/b`
+ */
+export declare function getPath(path: string | URL, base?: AbsolutePath | URL): AbsolutePath;
+/** Is a target path active? */
+export declare function isPathActive(target: AbsolutePath, current: AbsolutePath): boolean;
+/** Is a target path proud (i.e. is the current path, or is a child of the current path)? */
+export declare function isPathProud(target: AbsolutePath, current: AbsolutePath): boolean;

package/util/path.js

@@ -0,0 +1,35 @@
+import { AssertionError } from "../error/AssertionError.js";
+/** Is a string path an absolute path? */
+export const isAbsolutePath = (path) => path.startsWith("/");
+/** Is a string path an absolute path? */
+export const isRelativePath = (path) => path.startsWith("./") || path.startsWith("../");
+export function cleanPath(path) {
+    return path
+        .replace(/[/\\]+/g, "/") // Normalise slashes.
+        .replace(/(?!^)\/$/g, ""); // Trailing slashes.
+}
+/**
+ * Resolve an absolute path.
+ * - Uses `new URL` to do path processing, so URL strings e.g.
+ * - Returned paths are cleaned with `cleanPath()` so runs of slashes and trailing slashes are removed.
+ *
+ * @param path Absolute path e.g. `/a/b/c`, relative path e.g. `./a` or `b` or `../c`, URL string e.g. `http://shax.com/a/b/c`, or `URL` instance.
+ * @param base Absolute path or `URL` instance used for resolving relative paths in `path`
+ * @return Absolute path with a leading trailing slash, e.g. `/a/c/b`
+ */
+export function getPath(path, base = "/") {
+    try {
+        return cleanPath(new URL(path, `http://j.com${base instanceof URL ? base.pathname : base}/`).pathname);
+    }
+    catch {
+        throw new AssertionError("Invalid path", path);
+    }
+}
+/** Is a target path active? */
+export function isPathActive(target, current) {
+    return target === current;
+}
+/** Is a target path proud (i.e. is the current path, or is a child of the current path)? */
+export function isPathProud(target, current) {
+    return target === current || (target !== "/" && target.startsWith(`${current}/`));
+}

package/util/string.d.ts

@@ -62,7 +62,7 @@ export declare const sanitizeLines: (str: string) => string;
  * Simplify a string by removing anything that isn't a number, letter, or space.
  * - Used when you're running a query against a string entered by a user.
  *
- * @example normalizeString("Däve-is\nREALLY    éxcitable—apparęntly!!!    😂"); // Returns "dave is really excitable apparently"
+ * @example simplifyString("Däve-is\nREALLY    éxcitable—apparęntly!!!    😂"); // Returns "dave is really excitable apparently"
  *
  * @todo Convert letter-like characters (e.g. `ℝ`) to their ASCII equivalent (e.g. `R`).
  */

package/util/string.js

@@ -98,7 +98,7 @@ export const sanitizeLines = (str) => str
  * Simplify a string by removing anything that isn't a number, letter, or space.
  * - Used when you're running a query against a string entered by a user.
  *
- * @example normalizeString("Däve-is\nREALLY    éxcitable—apparęntly!!!    😂"); // Returns "dave is really excitable apparently"
+ * @example simplifyString("Däve-is\nREALLY    éxcitable—apparęntly!!!    😂"); // Returns "dave is really excitable apparently"
  *
  * @todo Convert letter-like characters (e.g. `ℝ`) to their ASCII equivalent (e.g. `R`).
  */