@react-foundry/uri 0.1.0

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (C) 2019-2025 Crown Copyright
+Copyright (C) 2019-2026 Daniel A.C. Martin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,49 @@
+React Foundry - URI
+===================
+
+A more forgiving alternative to JavaScript's standard URL class.
+Supports nested structures in the query-strings.
+
+
+Using this package
+------------------
+
+First install the package into your project:
+
+```shell
+npm install -S @react-foundry/uri
+```
+
+Then use it in your code as follows:
+
+```js
+import { URI } from '@react-foundry/uri';
+
+// WRITEME
+
+```
+
+
+Working on this package
+-----------------------
+
+Before working on this package you must install its dependencies using
+the following command:
+
+```shell
+pnpm install
+```
+
+
+### Building
+
+```shell
+npm run build
+```
+
+
+### Clean-up
+
+```shell
+npm run clean
+```

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './query-string';
+export * from './uri';

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./query-string"), exports);
+__exportStar(require("./uri"), exports);

package/dist/index.mjs

@@ -0,0 +1,2 @@
+export * from './query-string';
+export * from './uri';

package/dist/query-string.d.ts

@@ -0,0 +1,4 @@
+import { ParsedQs as Query } from 'qs';
+export declare const qsParse: (s: string) => Query;
+export declare const queryString: (obj: object) => string;
+export type { Query };

package/dist/query-string.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.queryString = exports.qsParse = void 0;
+const qs_1 = require("qs");
+const qsParse = (s) => (0, qs_1.parse)(s && s[0] === '?'
+    ? s?.substring(1)
+    : s);
+exports.qsParse = qsParse;
+const queryString = (obj) => '?' + (0, qs_1.stringify)(obj);
+exports.queryString = queryString;

package/dist/query-string.mjs

@@ -0,0 +1,5 @@
+import { parse, stringify } from 'qs';
+export const qsParse = (s) => parse(s && s[0] === '?'
+    ? s?.substring(1)
+    : s);
+export const queryString = (obj) => '?' + stringify(obj);

package/dist/uri.d.ts

@@ -0,0 +1,27 @@
+import { Query } from './query-string';
+export declare class URI extends Object {
+    #private;
+    constructor(uri: string, base?: string);
+    get href(): string;
+    get protocol(): string;
+    set protocol(v: string);
+    get username(): string;
+    set username(v: string);
+    get password(): string;
+    set password(v: string);
+    get hostname(): string;
+    set hostname(v: string);
+    get port(): string;
+    set port(v: string);
+    get pathname(): string;
+    set pathname(v: string);
+    get search(): string;
+    set search(v: string);
+    get hash(): string;
+    set hash(v: string);
+    get query(): Query;
+    set query(v: Query);
+    toString(): string;
+    valueOf(): object;
+    static parse(s: string, base?: string): URI;
+}

package/dist/uri.js

@@ -0,0 +1,136 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.URI = void 0;
+const query_string_1 = require("./query-string");
+class URI extends Object {
+    #url;
+    #noHostname = false;
+    #noPathname = false;
+    #query;
+    constructor(uri, base) {
+        super();
+        try {
+            this.#url = new URL(uri, base);
+        }
+        catch (_e) {
+            const dummyOrigin = 'http://a';
+            this.#noHostname = true;
+            try {
+                const newBase = (base
+                    ? (base[0] === '/'
+                        ? dummyOrigin + base
+                        : dummyOrigin + '/' + base)
+                    : dummyOrigin);
+                this.#url = new URL(uri, newBase);
+                this.#noPathname = this.#url.pathname === '/' && uri[0] !== '/';
+            }
+            catch (_e) {
+                this.#url = new URL('', dummyOrigin);
+                this.#noPathname = true;
+            }
+        }
+        this.#query = (0, query_string_1.qsParse)(this.#url.search);
+    }
+    get href() {
+        const targetHref = this.#url.href;
+        const hash = (targetHref[targetHref.length - 1] === '#'
+            ? '#'
+            : this.#url.hash);
+        return (this.#noHostname
+            ? this.pathname + this.#url.search + hash
+            : targetHref);
+    }
+    get protocol() {
+        return (this.#noHostname
+            ? ''
+            : this.#url.protocol);
+    }
+    set protocol(v) {
+        this.#url.protocol = v;
+    }
+    get username() {
+        return (this.#noHostname
+            ? ''
+            : this.#url.username);
+    }
+    set username(v) {
+        this.#url.username = v;
+    }
+    get password() {
+        return (this.#noHostname
+            ? ''
+            : this.#url.password);
+    }
+    set password(v) {
+        this.#url.password = v;
+    }
+    get hostname() {
+        return (this.#noHostname
+            ? ''
+            : this.#url.hostname);
+    }
+    set hostname(v) {
+        this.#noHostname = !v;
+        this.#url.hostname = v;
+    }
+    get port() {
+        return (this.#noHostname
+            ? ''
+            : this.#url.port);
+    }
+    set port(v) {
+        this.#url.port = v;
+    }
+    get pathname() {
+        return (this.#noPathname
+            ? ''
+            : this.#url.pathname);
+    }
+    set pathname(v) {
+        this.#noPathname = !v;
+        this.#url.pathname = v;
+    }
+    get search() {
+        return this.#url.search;
+    }
+    set search(v) {
+        this.#query = (0, query_string_1.qsParse)(v);
+        this.#url.search = v;
+    }
+    get hash() {
+        return this.#url.hash;
+    }
+    set hash(v) {
+        this.#url.hash = v;
+    }
+    get query() {
+        return this.#query;
+    }
+    set query(v) {
+        this.#query = v;
+        this.#url.search = (0, query_string_1.queryString)(v);
+    }
+    toString() {
+        return (this.#noHostname
+            ? this.href
+            : this.#url.toString());
+    }
+    valueOf() {
+        return ({
+            href: this.href,
+            protocol: this.protocol,
+            username: this.username,
+            password: this.password,
+            hostname: this.hostname,
+            port: this.port,
+            pathname: this.pathname,
+            search: this.search,
+            query: this.query,
+            hash: this.hash
+        }).valueOf();
+    }
+    static parse(s, base) {
+        return new URI(s, base);
+    }
+}
+exports.URI = URI;

package/dist/uri.mjs

@@ -0,0 +1,132 @@
+import { qsParse, queryString } from './query-string';
+export class URI extends Object {
+    #url;
+    #noHostname = false;
+    #noPathname = false;
+    #query;
+    constructor(uri, base) {
+        super();
+        try {
+            this.#url = new URL(uri, base);
+        }
+        catch (_e) {
+            const dummyOrigin = 'http://a';
+            this.#noHostname = true;
+            try {
+                const newBase = (base
+                    ? (base[0] === '/'
+                        ? dummyOrigin + base
+                        : dummyOrigin + '/' + base)
+                    : dummyOrigin);
+                this.#url = new URL(uri, newBase);
+                this.#noPathname = this.#url.pathname === '/' && uri[0] !== '/';
+            }
+            catch (_e) {
+                this.#url = new URL('', dummyOrigin);
+                this.#noPathname = true;
+            }
+        }
+        this.#query = qsParse(this.#url.search);
+    }
+    get href() {
+        const targetHref = this.#url.href;
+        const hash = (targetHref[targetHref.length - 1] === '#'
+            ? '#'
+            : this.#url.hash);
+        return (this.#noHostname
+            ? this.pathname + this.#url.search + hash
+            : targetHref);
+    }
+    get protocol() {
+        return (this.#noHostname
+            ? ''
+            : this.#url.protocol);
+    }
+    set protocol(v) {
+        this.#url.protocol = v;
+    }
+    get username() {
+        return (this.#noHostname
+            ? ''
+            : this.#url.username);
+    }
+    set username(v) {
+        this.#url.username = v;
+    }
+    get password() {
+        return (this.#noHostname
+            ? ''
+            : this.#url.password);
+    }
+    set password(v) {
+        this.#url.password = v;
+    }
+    get hostname() {
+        return (this.#noHostname
+            ? ''
+            : this.#url.hostname);
+    }
+    set hostname(v) {
+        this.#noHostname = !v;
+        this.#url.hostname = v;
+    }
+    get port() {
+        return (this.#noHostname
+            ? ''
+            : this.#url.port);
+    }
+    set port(v) {
+        this.#url.port = v;
+    }
+    get pathname() {
+        return (this.#noPathname
+            ? ''
+            : this.#url.pathname);
+    }
+    set pathname(v) {
+        this.#noPathname = !v;
+        this.#url.pathname = v;
+    }
+    get search() {
+        return this.#url.search;
+    }
+    set search(v) {
+        this.#query = qsParse(v);
+        this.#url.search = v;
+    }
+    get hash() {
+        return this.#url.hash;
+    }
+    set hash(v) {
+        this.#url.hash = v;
+    }
+    get query() {
+        return this.#query;
+    }
+    set query(v) {
+        this.#query = v;
+        this.#url.search = queryString(v);
+    }
+    toString() {
+        return (this.#noHostname
+            ? this.href
+            : this.#url.toString());
+    }
+    valueOf() {
+        return ({
+            href: this.href,
+            protocol: this.protocol,
+            username: this.username,
+            password: this.password,
+            hostname: this.hostname,
+            port: this.port,
+            pathname: this.pathname,
+            search: this.search,
+            query: this.query,
+            hash: this.hash
+        }).valueOf();
+    }
+    static parse(s, base) {
+        return new URI(s, base);
+    }
+}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@react-foundry/uri",
+  "version": "0.1.0",
+  "description": "A more forgiving alternative to JavaScript's standard URL class.",
+  "main": "dist/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "default": "./dist/index.mjs"
+    }
+  },
+  "files": [
+    "/dist"
+  ],
+  "author": "Daniel A.C. Martin <npm@daniel-martin.co.uk> (http://daniel-martin.co.uk/)",
+  "license": "MIT",
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "dependencies": {
+    "qs": "^6.14.1"
+  },
+  "devDependencies": {
+    "@types/qs": "6.14.0",
+    "jest": "30.2.0",
+    "jest-environment-jsdom": "30.2.0",
+    "ts-jest": "29.4.6",
+    "typescript": "5.9.3"
+  },
+  "scripts": {
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest",
+    "build": "npm run build:esm && npm run build:cjs",
+    "build:esm": "tsc -m es2022 && find dist -name '*.js' -exec sh -c 'mv \"$0\" \"${0%.js}.mjs\"' {} \\;",
+    "build:cjs": "tsc",
+    "clean": "rm -rf dist tsconfig.tsbuildinfo"
+  },
+  "module": "dist/index.mjs",
+  "typings": "dist/index.d.ts"
+}