@adviser/cement 0.4.2 → 0.4.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adviser/cement",
-  "version": "0.4.2",
+  "version": "0.4.4",
   "description": "better try/catch/finally handling",
   "main": "index.js",
   "type": "module",
@@ -48,7 +48,7 @@
     "yaml": "^2.5.1"
   },
   "devDependencies": {
-    "@cloudflare/vitest-pool-workers": "^0.7.1",
+    "@cloudflare/vitest-pool-workers": "^0.8.0",
     "@eslint/js": "^9.20.0",
     "@types/node": "^22.10.2",
     "@typescript-eslint/eslint-plugin": "^8.7.0",
@@ -57,14 +57,15 @@
     "esbuild-plugin-replace": "^1.4.0",
     "esbuild-plugin-resolve": "^2.0.0",
     "eslint": "9.22.0",
+    "playwright": "^1.51.0",
+    "playwright-chromium": "^1.51.0",
     "prettier": "^3.3.3",
     "tsup": "^8.3.0",
     "tsx": "^4.19.1",
     "typescript": "^5.8.0",
     "typescript-eslint": "^8.24.0",
     "vite-tsconfig-paths": "^5.0.1",
-    "vitest": "^3.0.7",
-    "webdriverio": "^9.9.0"
+    "vitest": "^3.0.8"
   },
   "engines": {
     "node": ">=20"

package/src/is-promise.ts

@@ -1,5 +1,7 @@
 export type UnPromisify<T> = T extends Promise<infer U> ? U : T;
 
+export type Promisable<T> = T | Promise<T>;
+
 export function isPromise<T>(a: T): a is T extends Promise<unknown> ? T : never {
   const mayBe = a as unknown as { then: () => void; catch: () => void; finally: () => void };
   return (

package/src/jsr.json

@@ -1,6 +1,6 @@
 {
   "name": "@adviser/cement",
-  "version": "0.4.2",
+  "version": "0.4.4",
   "exports": {
     ".": "./index.ts",
     "./web": "./web/index.ts",

package/src/uri.ts

@@ -119,6 +119,16 @@ function coerceKey(key: string | OneKey<string>, def?: string): { key: string; d
   return { key, def: def };
 }
 
+function resolveHash(hash: string): { getParam: (k: string) => string | undefined } {
+  const searchParams = new URLSearchParams(hash.replace(/^#/, ""));
+  return {
+    getParam: (k): string | undefined => {
+      const ret = searchParams.get(k);
+      return ret === null ? undefined : ret;
+    },
+  };
+}
+
 export interface URIObject {
   readonly style: "host" | "path";
   readonly protocol: string;
@@ -168,6 +178,7 @@ export function isURL(value: unknown): value is URL {
 
 // due to that the System URL class is has a strange behavior
 // on different platforms, we need to implement our own URL class
+const customInspectSymbol = Symbol.for("nodejs.util.inspect.custom");
 export class MutableURL extends URL {
   private readonly _sysURL: URL;
   // private readonly _urlStr: string;
@@ -176,7 +187,7 @@ export class MutableURL extends URL {
   private _pathname: string;
   private _hasHostpart: boolean;
 
-  override readonly hash: string;
+  // override readonly hash: string;
 
   constructor(urlStr: string) {
     super("defect://does.not.exist");
@@ -200,7 +211,12 @@ export class MutableURL extends URL {
     } else {
       this._pathname = urlStr.replace(new RegExp(`^${this._protocol}//`), "").replace(/[#?].*$/, "");
     }
-    this.hash = this._sysURL.hash;
+    // this.hash = this._sysURL.hash;
+  }
+
+  [customInspectSymbol](): string {
+    // make node inspect to show the URL and not crash if URI is not http/https/file
+    return this.toString();
   }
 
   clone(): MutableURL {
@@ -263,17 +279,30 @@ export class MutableURL extends URL {
     this._protocol = p;
   }
 
+  override get hash(): string {
+    return this._sysURL.hash;
+  }
+
+  override set hash(h: string) {
+    this._sysURL.hash = h;
+  }
+
   override get searchParams(): URLSearchParams {
     return this._sysURL.searchParams;
   }
 
-  override toString(): string {
+  override get search(): string {
     let search = "";
     if (this._sysURL.searchParams.size) {
       for (const [key, value] of Array.from(this._sysURL.searchParams.entries()).sort((a, b) => a[0].localeCompare(b[0]))) {
         search += `${!search.length ? "?" : "&"}${key}=${encodeURIComponent(value)}`;
       }
     }
+    return search;
+  }
+
+  override toString(): string {
+    const search = this.search;
     let hostpart = "";
     if (this._hasHostpart) {
       hostpart = this._sysURL.hostname;
@@ -284,7 +313,7 @@ export class MutableURL extends URL {
         hostpart += "/";
       }
     }
-    return `${this._protocol}//${hostpart}${this._pathname}${search}`;
+    return `${this._protocol}//${hostpart}${this._pathname}${search}${this.hash}`;
   }
 }
 
@@ -364,6 +393,11 @@ export class BuildURI implements URIInterface<BuildURI> {
     return this;
   }
 
+  hash(h: string): BuildURI {
+    this._url.hash = h;
+    return this;
+  }
+
   // could pass a relative path or a full URL
   // if relative path, it will be appended to the current path
   resolve(p: CoerceURI): BuildURI {
@@ -413,10 +447,54 @@ export class BuildURI implements URIInterface<BuildURI> {
     return this;
   }
 
-  cleanParams(): BuildURI {
+  cleanParams(...remove: (string | string[])[]): BuildURI {
+    const keys = new Set(remove.flat());
     for (const key of Array.from(this._url.searchParams.keys())) {
-      this._url.searchParams.delete(key);
+      if (keys.size === 0 || keys.has(key)) {
+        this._url.searchParams.delete(key);
+      }
+    }
+    return this;
+  }
+
+  hashParams(
+    val: Record<string, string | number | boolean | Date | null | undefined>,
+    mode: "reset" | "merge" = "reset",
+  ): BuildURI {
+    let preset: Record<string, string>;
+    switch (mode) {
+      case "reset":
+        this._url.hash = "";
+        preset = {};
+        break;
+      case "merge":
+      default:
+        preset = Object.fromEntries(new URLSearchParams(this._url.hash.replace(/^#/, "")).entries());
+        break;
+    }
+    const out = new URLSearchParams("");
+    for (const [key, value] of Object.entries({ ...preset, ...val }).sort((a, b) => a[0].localeCompare(b[0]))) {
+      switch (typeof value) {
+        case "string":
+          out.set(key, value);
+          break;
+        case "number":
+          out.set(key, value.toString());
+          break;
+        case "boolean":
+          out.set(key, value ? "true" : "false");
+          break;
+        default:
+          if (value instanceof Date) {
+            out.set(key, value.toISOString());
+          } else {
+            // eslint-disable-next-line no-console
+            console.error(`unsupported type: ${typeof value} ignore key: ${key}`);
+          }
+          break;
+      }
     }
+    this._url.hash = out.toString();
     return this;
   }
 
@@ -462,6 +540,10 @@ export class BuildURI implements URIInterface<BuildURI> {
     return getParamsResult(keys, this);
   }
 
+  getHashParams(...keys: KeysParam): Result<Record<string, string>> {
+    return getParamsResult(keys, resolveHash(this._url.hash));
+  }
+
   toString(): string {
     this._url.searchParams.sort();
     return this._url.toString();
@@ -573,6 +655,10 @@ export class URI implements URIInterface<URI> {
     return this._url.hostname;
   }
 
+  get local(): string {
+    return this._url.pathname + this._url.search;
+  }
+
   // get password(): string {
   //   return this._url.password;
   // }
@@ -605,9 +691,9 @@ export class URI implements URIInterface<URI> {
     //   .replace(/\?.*$/, "");
   }
 
-  // get hash(): string {
-  //   return this._url.hash;
-  // }
+  get hash(): string {
+    return this._url.hash;
+  }
 
   // get host(): string {
   //   return this._url.host;
@@ -638,6 +724,10 @@ export class URI implements URIInterface<URI> {
     return getParamsResult(keys, this);
   }
 
+  getHashParams(...keys: KeysParam): Result<Record<string, string>> {
+    return getParamsResult(keys, resolveHash(this._url.hash));
+  }
+
   clone(): URI {
     return new URI(this._url);
   }

package/test/index.cjs

@@ -1211,6 +1211,15 @@ function coerceKey(key, def) {
   }
   return { key, def };
 }
+function resolveHash(hash) {
+  const searchParams = new URLSearchParams(hash.replace(/^#/, ""));
+  return {
+    getParam: (k) => {
+      const ret = searchParams.get(k);
+      return ret === null ? void 0 : ret;
+    }
+  };
+}
 function falsy2undef(value) {
   return value === void 0 || value === null ? void 0 : value;
 }
@@ -1231,7 +1240,9 @@ function ensureURLWithDefaultProto(url, defaultProtocol) {
 function isURL(value) {
   return value instanceof URL || !!value && typeof value.searchParams === "object" && typeof value.searchParams.sort === "function" && typeof value.hash === "string";
 }
+var customInspectSymbol = Symbol.for("nodejs.util.inspect.custom");
 var MutableURL = class _MutableURL extends URL {
+  // override readonly hash: string;
   constructor(urlStr) {
     super("defect://does.not.exist");
     const partedURL = urlStr.split(":");
@@ -1254,7 +1265,9 @@ var MutableURL = class _MutableURL extends URL {
     } else {
       this._pathname = urlStr.replace(new RegExp(`^${this._protocol}//`), "").replace(/[#?].*$/, "");
     }
-    this.hash = this._sysURL.hash;
+  }
+  [customInspectSymbol]() {
+    return this.toString();
   }
   clone() {
     return new _MutableURL(this.toString());
@@ -1306,16 +1319,26 @@ var MutableURL = class _MutableURL extends URL {
     }
     this._protocol = p;
   }
+  get hash() {
+    return this._sysURL.hash;
+  }
+  set hash(h) {
+    this._sysURL.hash = h;
+  }
   get searchParams() {
     return this._sysURL.searchParams;
   }
-  toString() {
+  get search() {
     let search = "";
     if (this._sysURL.searchParams.size) {
       for (const [key, value] of Array.from(this._sysURL.searchParams.entries()).sort((a, b) => a[0].localeCompare(b[0]))) {
         search += `${!search.length ? "?" : "&"}${key}=${encodeURIComponent(value)}`;
       }
     }
+    return search;
+  }
+  toString() {
+    const search = this.search;
     let hostpart = "";
     if (this._hasHostpart) {
       hostpart = this._sysURL.hostname;
@@ -1326,7 +1349,7 @@ var MutableURL = class _MutableURL extends URL {
         hostpart += "/";
       }
     }
-    return `${this._protocol}//${hostpart}${this._pathname}${search}`;
+    return `${this._protocol}//${hostpart}${this._pathname}${search}${this.hash}`;
   }
 };
 function from(fac, strURLUri, defaultProtocol) {
@@ -1389,6 +1412,10 @@ var BuildURI = class _BuildURI {
     this._url.pathname = p;
     return this;
   }
+  hash(h) {
+    this._url.hash = h;
+    return this;
+  }
   // could pass a relative path or a full URL
   // if relative path, it will be appended to the current path
   resolve(p) {
@@ -1417,12 +1444,51 @@ var BuildURI = class _BuildURI {
     }
     return this;
   }
-  cleanParams() {
+  cleanParams(...remove) {
+    const keys = new Set(remove.flat());
     for (const key of Array.from(this._url.searchParams.keys())) {
-      this._url.searchParams.delete(key);
+      if (keys.size === 0 || keys.has(key)) {
+        this._url.searchParams.delete(key);
+      }
     }
     return this;
   }
+  hashParams(val, mode = "reset") {
+    let preset;
+    switch (mode) {
+      case "reset":
+        this._url.hash = "";
+        preset = {};
+        break;
+      case "merge":
+      default:
+        preset = Object.fromEntries(new URLSearchParams(this._url.hash.replace(/^#/, "")).entries());
+        break;
+    }
+    const out = new URLSearchParams("");
+    for (const [key, value] of Object.entries({ ...preset, ...val }).sort((a, b) => a[0].localeCompare(b[0]))) {
+      switch (typeof value) {
+        case "string":
+          out.set(key, value);
+          break;
+        case "number":
+          out.set(key, value.toString());
+          break;
+        case "boolean":
+          out.set(key, value ? "true" : "false");
+          break;
+        default:
+          if (value instanceof Date) {
+            out.set(key, value.toISOString());
+          } else {
+            console.error(`unsupported type: ${typeof value} ignore key: ${key}`);
+          }
+          break;
+      }
+    }
+    this._url.hash = out.toString();
+    return this;
+  }
   delParam(key) {
     this._url.searchParams.delete(key);
     return this;
@@ -1457,6 +1523,9 @@ var BuildURI = class _BuildURI {
   getParamsResult(...keys) {
     return getParamsResult(keys, this);
   }
+  getHashParams(...keys) {
+    return getParamsResult(keys, resolveHash(this._url.hash));
+  }
   toString() {
     this._url.searchParams.sort();
     return this._url.toString();
@@ -1522,6 +1591,9 @@ var URI = class _URI {
   get hostname() {
     return this._url.hostname;
   }
+  get local() {
+    return this._url.pathname + this._url.search;
+  }
   // get password(): string {
   //   return this._url.password;
   // }
@@ -1543,9 +1615,9 @@ var URI = class _URI {
   get pathname() {
     return this._url.pathname;
   }
-  // get hash(): string {
-  //   return this._url.hash;
-  // }
+  get hash() {
+    return this._url.hash;
+  }
   // get host(): string {
   //   return this._url.host;
   // }
@@ -1569,6 +1641,9 @@ var URI = class _URI {
   getParamsResult(...keys) {
     return getParamsResult(keys, this);
   }
+  getHashParams(...keys) {
+    return getParamsResult(keys, resolveHash(this._url.hash));
+  }
   clone() {
     return new _URI(this._url);
   }