@stryke/url 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+   Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+   stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+   that You distribute, all copyright, patent, trademark, and
+   attribution notices from the Source form of the Work,
+   excluding those notices that do not pertain to any part of
+   the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+   distribution, then any Derivative Works that You distribute must
+   include a readable copy of the attribution notices contained
+   within such NOTICE file, excluding those notices that do not
+   pertain to any part of the Derivative Works, in at least one
+   of the following places: within a NOTICE text file distributed
+   as part of the Derivative Works; within the Source form or
+   documentation, if provided along with the Derivative Works; or,
+   within a display generated by the Derivative Works, if and
+   wherever such third-party notices normally appear. The contents
+   of the NOTICE file are for informational purposes only and
+   do not modify the License. You may add Your own attribution
+   notices within Derivative Works that You distribute, alongside
+   or as an addendum to the NOTICE text from the Work, provided
+   that such additional attribution notices cannot be construed
+   as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,63 @@
+<!-- START header -->
+<!-- END header -->
+
+# Stryke - URL Helpers
+
+A package containing the `StormURL` wrapper class and various URL helper
+utilities.
+
+<!-- START doctoc -->
+<!-- END doctoc -->
+
+## Installing
+
+Using [pnpm](http://pnpm.io):
+
+```bash
+pnpm add -D @stryke/url
+```
+
+<details>
+  <summary>Using npm</summary>
+
+```bash
+npm install -D @stryke/url
+```
+
+</details>
+
+<details>
+  <summary>Using yarn</summary>
+
+```bash
+yarn add -D @stryke/url
+```
+
+</details>
+
+## Reduced Package Size
+
+This project uses [tsup](https://tsup.egoist.dev/) to package the source code
+due to its ability to remove unused code and ship smaller javascript files
+thanks to code splitting. This helps to greatly reduce the size of the package
+and to make it easier to use in other projects.
+
+## Development
+
+This project is built using [Nx](https://nx.dev). As a result, many of the usual
+commands are available to assist in development.
+
+### Building
+
+Run `nx build url` to build the library.
+
+### Running unit tests
+
+Run `nx test url` to execute the unit tests via [Jest](https://jestjs.io).
+
+### Linting
+
+Run `nx lint url` to run [ESLint](https://eslint.org/) on the package.
+
+<!-- START footer -->
+<!-- END footer -->

package/dist/helpers.cjs

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.formatLocalePath = formatLocalePath;
+function formatLocalePath(o) {
+  let t = o;
+  if (t.includes("_") && (t = t.replace(/_/g, "-")), t.includes("-")) {
+    const e = t.split("-");
+    if (e.length > 1) {
+      const n = e[0],
+        i = e[1];
+      n && i && (t = `${n}-${i}`);
+    }
+  }
+  return t.toLowerCase();
+}

package/dist/helpers.d.ts

@@ -0,0 +1 @@
+export declare function formatLocalePath(locale: string): string;

package/dist/helpers.mjs

@@ -0,0 +1 @@
+export function formatLocalePath(o){let t=o;if(t.includes("_")&&(t=t.replace(/_/g,"-")),t.includes("-")){const e=t.split("-");if(e.length>1){const n=e[0],i=e[1];n&&i&&(t=`${n}-${i}`)}}return t.toLowerCase()}

package/dist/index.cjs

@@ -0,0 +1,27 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _stormUrl = require("./storm-url.cjs");
+Object.keys(_stormUrl).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _stormUrl[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _stormUrl[key];
+    }
+  });
+});
+var _types = require("./types.cjs");
+Object.keys(_types).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _types[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _types[key];
+    }
+  });
+});

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./storm-url";
+export * from "./types";

package/dist/index.mjs

@@ -0,0 +1 @@
+export*from"./storm-url";export*from"./types";

package/dist/storm-url.cjs

@@ -0,0 +1,183 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.StormURL = void 0;
+var _stormJson = require("@stryke/json/storm-json");
+var _joinPaths = require("@stryke/path/join-paths");
+var _isInteger = require("@stryke/type-checks/is-integer");
+var _isSetString = require("@stryke/type-checks/is-set-string");
+var _isUndefined = require("@stryke/type-checks/is-undefined");
+var _ufo = require("ufo");
+var _helpers = require("./helpers.cjs");
+class StormURL {
+  #a;
+  #t;
+  #s;
+  #i;
+  #r;
+  #o;
+  #e = [];
+  #h;
+  #n;
+  constructor(t, s = {
+    decode: !0
+  }) {
+    this.#a = s;
+    const i = (0, _ufo.parseURL)(this.#a.decode ? (0, _ufo.decode)(t) : t),
+      a = (0, _ufo.parseAuth)(i.auth);
+    this.#t = a.username, this.#s = a.password;
+    const o = (0, _ufo.parseHost)(i.host);
+    this.#i = o.hostname, this.#r = o.port, this.#o = i.protocol, this.#h = i.hash || "", this.#n = (0, _ufo.parseQuery)(i.search), this.#e = i.pathname ? i.pathname.split("/").filter(Boolean) : [], s.locale && this.#e.unshift((0, _helpers.formatLocalePath)(((0, _isSetString.isSetString)(s.locale) ? s.locale : process.env.DEFAULT_LOCALE) || "en-us"));
+  }
+  set params(t) {
+    this.#n = t;
+  }
+  get params() {
+    return this.#n;
+  }
+  get searchParams() {
+    const t = new URLSearchParams();
+    for (const [s, i] of Object.entries(this.params)) t.append(s, i);
+    return t;
+  }
+  set searchParams(t) {
+    this.params = Object.fromEntries(t.entries());
+  }
+  set search(t) {
+    this.params = (0, _ufo.parseQuery)(t);
+  }
+  get search() {
+    const t = (0, _ufo.stringifyQuery)(this.params);
+    return t ? t.startsWith("?") ? t : `?${t}` : "";
+  }
+  set hash(t) {
+    this.#h = t.startsWith("#") ? t : `#${t}`;
+  }
+  get hash() {
+    return this.#h;
+  }
+  set port(t) {
+    this.#r = !(0, _isUndefined.isUndefined)(t) && (0, _isInteger.isInteger)(t) ? `${t}` : "";
+  }
+  get port() {
+    return this.#r || "";
+  }
+  set username(t) {
+    this.auth = `${t}:${this.#s}`;
+  }
+  get username() {
+    return this.#t || "";
+  }
+  set password(t) {
+    this.auth = `${this.#t}:${t}`;
+  }
+  get password() {
+    return this.#s || "";
+  }
+  set auth(t) {
+    const s = (0, _ufo.parseAuth)(t);
+    this.#t = s.username, this.#s = s.password;
+  }
+  get auth() {
+    return this.#t && this.#s ? `${this.#t}:${this.#s}` : this.#t ? this.#t : this.#s ? this.#s : "";
+  }
+  set protocol(t) {
+    this.#o = t.endsWith(":") ? t : t.endsWith("://") ? t.slice(0, -2) : `${t}:`;
+  }
+  get protocol() {
+    return this.#o || this.#a.defaultProtocol || "https:";
+  }
+  set hostname(t) {
+    this.#i = t;
+  }
+  get hostname() {
+    return this.#i;
+  }
+  set host(t) {
+    const s = (0, _ufo.parseHost)(t);
+    this.#i = s.hostname, this.#r = s.port;
+  }
+  get host() {
+    return this.#i && this.#r ? `${this.#i}:${this.#r}` : this.#i ? this.#i : this.#r ? this.#r : "";
+  }
+  set paths(t) {
+    this.#e = t.filter(Boolean);
+  }
+  get paths() {
+    return this.#e;
+  }
+  set pathname(t) {
+    this.paths = (0, _ufo.cleanDoubleSlashes)(t).split("/");
+  }
+  get pathname() {
+    return `/${this.paths ? (0, _joinPaths.joinPaths)(...this.paths.map(t => _stormJson.StormJSON.stringify(t))) : ""}`;
+  }
+  set path(t) {
+    const s = (0, _ufo.parsePath)(t);
+    this.pathname = s.pathname, this.search = s.search, this.#h = s.hash;
+  }
+  get path() {
+    return (0, _ufo.stringifyParsedURL)({
+      pathname: this.pathname,
+      search: this.search,
+      hash: this.hash
+    });
+  }
+  get href() {
+    return this.toString();
+  }
+  set href(t) {
+    const s = (0, _ufo.parseURL)(t);
+    this.protocol = s.protocol || this.protocol, this.auth = s.auth || this.auth, this.host = s.host || this.host, this.pathname = s.pathname || this.pathname, this.search = s.search || this.search, this.hash = s.hash || this.hash;
+  }
+  get origin() {
+    return `${this.protocol}//${this.host}`;
+  }
+  get isScriptProtocol() {
+    return (0, _ufo.isScriptProtocol)(this.protocol);
+  }
+  get isRelative() {
+    return (0, _ufo.isRelative)(this.toString());
+  }
+  get isNonEmptyURL() {
+    return (0, _ufo.isNonEmptyURL)(this.toString());
+  }
+  get __typename() {
+    return "StormURL";
+  }
+  isSamePath(t) {
+    return (0, _ufo.isSamePath)(this.path, t);
+  }
+  isEqual(t) {
+    return (0, _ufo.isEqual)(this.toString(), typeof t == "string" ? t : t instanceof StormURL ? t.toString() : (0, _ufo.stringifyParsedURL)(t));
+  }
+  toParsed() {
+    return {
+      protocol: this.protocol,
+      auth: this.auth,
+      host: this.host,
+      pathname: this.pathname,
+      search: this.search,
+      hash: this.hash
+    };
+  }
+  toString() {
+    return (0, _ufo.stringifyParsedURL)(this.toParsed());
+  }
+  toEncoded() {
+    return (0, _ufo.normalizeURL)(this.toString());
+  }
+  toJSON() {
+    return _stormJson.StormJSON.stringify(this.toParsed());
+  }
+}
+exports.StormURL = StormURL;
+_stormJson.StormJSON.instance.registerCustom({
+  isApplicable: r => r.__typename === "StormURL",
+  serialize: r => r.toEncoded(),
+  deserialize: r => new StormURL(r, {
+    decode: !0
+  })
+}, "StormURL");

package/dist/storm-url.d.ts

@@ -0,0 +1,55 @@
+import type { ParsedURL } from "ufo";
+import type { IStormURL, StormURLOptions } from "./types";
+/**
+ * A class used to build URLs
+ *
+ * @remarks
+ * This class is used to build URLs with a fluent API.
+ *
+ * The [UFO](https://github.com/unjs/ufo) library is used under the hood to parse and stringify URLs.
+ */
+export declare class StormURL implements IStormURL, URL {
+    #private;
+    constructor(initialURL: string, options?: StormURLOptions);
+    set params(value: Record<string, any>);
+    get params(): Record<string, any>;
+    get searchParams(): URLSearchParams;
+    set searchParams(value: URLSearchParams);
+    set search(value: string);
+    get search(): string;
+    set hash(value: string);
+    get hash(): string;
+    set port(value: string | number);
+    get port(): string;
+    set username(value: string);
+    get username(): string;
+    set password(value: string);
+    get password(): string;
+    set auth(value: string | undefined);
+    get auth(): string;
+    set protocol(value: string);
+    get protocol(): string;
+    set hostname(value: string);
+    get hostname(): string;
+    set host(value: string | undefined);
+    get host(): string;
+    set paths(value: any[]);
+    get paths(): any[];
+    set pathname(value: string);
+    get pathname(): string;
+    set path(value: string);
+    get path(): string;
+    get href(): string;
+    set href(value: string);
+    get origin(): string;
+    get isScriptProtocol(): boolean;
+    get isRelative(): boolean;
+    get isNonEmptyURL(): boolean;
+    get __typename(): string;
+    isSamePath(path: string): boolean;
+    isEqual(url: string | ParsedURL | StormURL): boolean;
+    toParsed(): ParsedURL;
+    toString(): string;
+    toEncoded(): string;
+    toJSON(): string;
+}

package/dist/storm-url.mjs

@@ -0,0 +1 @@
+import{StormJSON as e}from"@stryke/json/storm-json";import{joinPaths as m}from"@stryke/path/join-paths";import{isInteger as g}from"@stryke/type-checks/is-integer";import{isSetString as l}from"@stryke/type-checks/is-set-string";import{isUndefined as b}from"@stryke/type-checks/is-undefined";import{cleanDoubleSlashes as d,decode as S,isEqual as f,isNonEmptyURL as R,isRelative as L,isSamePath as U,isScriptProtocol as P,normalizeURL as y,parseAuth as n,parseHost as p,parsePath as $,parseQuery as c,parseURL as u,stringifyParsedURL as h,stringifyQuery as E}from"ufo";import{formatLocalePath as O}from"./helpers";export class StormURL{#a;#t;#s;#i;#r;#o;#e=[];#h;#n;constructor(t,s={decode:!0}){this.#a=s;const i=u(this.#a.decode?S(t):t),a=n(i.auth);this.#t=a.username,this.#s=a.password;const o=p(i.host);this.#i=o.hostname,this.#r=o.port,this.#o=i.protocol,this.#h=i.hash||"",this.#n=c(i.search),this.#e=i.pathname?i.pathname.split("/").filter(Boolean):[],s.locale&&this.#e.unshift(O((l(s.locale)?s.locale:process.env.DEFAULT_LOCALE)||"en-us"))}set params(t){this.#n=t}get params(){return this.#n}get searchParams(){const t=new URLSearchParams;for(const[s,i]of Object.entries(this.params))t.append(s,i);return t}set searchParams(t){this.params=Object.fromEntries(t.entries())}set search(t){this.params=c(t)}get search(){const t=E(this.params);return t?t.startsWith("?")?t:`?${t}`:""}set hash(t){this.#h=t.startsWith("#")?t:`#${t}`}get hash(){return this.#h}set port(t){this.#r=!b(t)&&g(t)?`${t}`:""}get port(){return this.#r||""}set username(t){this.auth=`${t}:${this.#s}`}get username(){return this.#t||""}set password(t){this.auth=`${this.#t}:${t}`}get password(){return this.#s||""}set auth(t){const s=n(t);this.#t=s.username,this.#s=s.password}get auth(){return this.#t&&this.#s?`${this.#t}:${this.#s}`:this.#t?this.#t:this.#s?this.#s:""}set protocol(t){this.#o=t.endsWith(":")?t:t.endsWith("://")?t.slice(0,-2):`${t}:`}get protocol(){return this.#o||this.#a.defaultProtocol||"https:"}set hostname(t){this.#i=t}get hostname(){return this.#i}set host(t){const s=p(t);this.#i=s.hostname,this.#r=s.port}get host(){return this.#i&&this.#r?`${this.#i}:${this.#r}`:this.#i?this.#i:this.#r?this.#r:""}set paths(t){this.#e=t.filter(Boolean)}get paths(){return this.#e}set pathname(t){this.paths=d(t).split("/")}get pathname(){return`/${this.paths?m(...this.paths.map(t=>e.stringify(t))):""}`}set path(t){const s=$(t);this.pathname=s.pathname,this.search=s.search,this.#h=s.hash}get path(){return h({pathname:this.pathname,search:this.search,hash:this.hash})}get href(){return this.toString()}set href(t){const s=u(t);this.protocol=s.protocol||this.protocol,this.auth=s.auth||this.auth,this.host=s.host||this.host,this.pathname=s.pathname||this.pathname,this.search=s.search||this.search,this.hash=s.hash||this.hash}get origin(){return`${this.protocol}//${this.host}`}get isScriptProtocol(){return P(this.protocol)}get isRelative(){return L(this.toString())}get isNonEmptyURL(){return R(this.toString())}get __typename(){return"StormURL"}isSamePath(t){return U(this.path,t)}isEqual(t){return f(this.toString(),typeof t=="string"?t:t instanceof StormURL?t.toString():h(t))}toParsed(){return{protocol:this.protocol,auth:this.auth,host:this.host,pathname:this.pathname,search:this.search,hash:this.hash}}toString(){return h(this.toParsed())}toEncoded(){return y(this.toString())}toJSON(){return e.stringify(this.toParsed())}}e.instance.registerCustom({isApplicable:r=>r.__typename==="StormURL",serialize:r=>r.toEncoded(),deserialize:r=>new StormURL(r,{decode:!0})},"StormURL");

package/dist/types.cjs

@@ -0,0 +1,7 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.PROTOCOL_RELATIVE_SYMBOL = void 0;
+const PROTOCOL_RELATIVE_SYMBOL = exports.PROTOCOL_RELATIVE_SYMBOL = Symbol("protocol-relative");

package/dist/types.d.ts

@@ -0,0 +1,90 @@
+export interface StormURLOptions {
+    /**
+     * Should the URL be decoded
+     *
+     * @defaultValue `true`
+     */
+    decode?: boolean;
+    /**
+     * Should the URL include a locale path segment
+     */
+    locale?: string | true;
+    /**
+     * The default protocol to use
+     *
+     * @defaultValue "https"
+     */
+    defaultProtocol?: string;
+}
+export declare const PROTOCOL_RELATIVE_SYMBOL: unique symbol;
+export interface IStormURL extends URL {
+    /**
+     * A string containing the username and password specified before the domain name.
+     */
+    auth: string;
+    /**
+     * A string containing the username specified before the domain name.
+     */
+    username: string;
+    /**
+     * A string containing the password specified before the domain name.
+     */
+    password: string;
+    /**
+     * A string containing the domain (that is the hostname) followed by (if a port was specified) a `:` and the port of the URL.
+     */
+    host: string;
+    /**
+     * A string containing the domain of the URL.
+     */
+    hostname: string;
+    /**
+     * A string containing the port number of the URL.
+     */
+    port: string;
+    /**
+     * A string containing the protocol scheme of the URL, including the final `:`.
+     */
+    protocol: string;
+    /**
+     * A stringified value that returns the whole URL.
+     */
+    href: string;
+    /**
+     * A string containing an initial `/` followed by the path of the URL, not including the query string or fragment.
+     */
+    pathname: string;
+    /**
+     * The paths of the URL
+     */
+    paths: any[];
+    /**
+     * A string containing a `#` followed by the fragment identifier of the URL.
+     */
+    hash: string;
+    /**
+     * A string indicating the URL's parameter string; if any parameters are provided, this string includes all of them, beginning with the leading `?` character.
+     */
+    search: string;
+    /**
+     * The search parameters of the URL
+     *
+     * @remarks
+     * This is a `URLSearchParams` object that contains the search parameters of the URL.
+     */
+    searchParams: URLSearchParams;
+    /**
+     * The search parameters of the URL
+     *
+     * @remarks
+     * This is a Record\<string, any\> object that contains the search parameters of the URL.
+     */
+    params: Record<string, any>;
+    /**
+     * An optional symbol to indicate that the URL is protocol-relative
+     *
+     * @remarks
+     * This is used when the URL is protocol-relative (e.g. //example.com)
+     */
+    [PROTOCOL_RELATIVE_SYMBOL]?: boolean;
+}

package/dist/types.mjs

@@ -0,0 +1 @@
+export const PROTOCOL_RELATIVE_SYMBOL=Symbol("protocol-relative");

package/package.json

@@ -0,0 +1,120 @@
+{
+  "name": "@stryke/url",
+  "version": "0.1.0",
+  "type": "module",
+  "description": "A package containing the `StormURL` class, which is used to parse and manipulate URLs.",
+  "repository": {
+    "type": "github",
+    "url": "https://github.com/storm-software/stryke.git",
+    "directory": "packages/url"
+  },
+  "private": false,
+  "dependencies": {
+    "ufo": "1.5.4",
+    "@stryke/json": "^0.7.3",
+    "@stryke/path": "^0.4.11",
+    "@stryke/type-checks": "^0.3.2"
+  },
+  "devDependencies": { "@types/node": "^22.13.1" },
+  "publishConfig": { "access": "public" },
+  "sideEffects": false,
+  "files": ["dist/**/*"],
+  "homepage": "https://stormsoftware.com",
+  "bugs": {
+    "url": "https://stormsoftware.com/support",
+    "email": "support@stormsoftware.com"
+  },
+  "license": "Apache-2.0",
+  "keywords": [
+    "stryke",
+    "typescript",
+    "utilities",
+    "storm-software",
+    "storm",
+    "storm-ops",
+    "cyclone-ui",
+    "sullivanpj",
+    "monorepo"
+  ],
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/storm-software"
+  },
+  "author": {
+    "name": "Storm Software",
+    "email": "contact@stormsoftware.com",
+    "url": "https://stormsoftware.com"
+  },
+  "maintainers": [
+    {
+      "name": "Storm Software",
+      "email": "contact@stormsoftware.com",
+      "url": "https://stormsoftware.com"
+    }
+  ],
+  "contributors": [
+    {
+      "name": "Storm Software",
+      "email": "contact@stormsoftware.com",
+      "url": "https://stormsoftware.com"
+    }
+  ],
+  "exports": {
+    "./types": {
+      "import": { "types": "./dist/types.d.ts", "default": "./dist/types.mjs" },
+      "require": {
+        "types": "./dist/types.d.ts",
+        "default": "./dist/types.cjs"
+      },
+      "default": { "types": "./dist/types.d.ts", "default": "./dist/types.mjs" }
+    },
+    "./storm-url": {
+      "import": {
+        "types": "./dist/storm-url.d.ts",
+        "default": "./dist/storm-url.mjs"
+      },
+      "require": {
+        "types": "./dist/storm-url.d.ts",
+        "default": "./dist/storm-url.cjs"
+      },
+      "default": {
+        "types": "./dist/storm-url.d.ts",
+        "default": "./dist/storm-url.mjs"
+      }
+    },
+    "./index": {
+      "import": { "types": "./dist/index.d.ts", "default": "./dist/index.mjs" },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.cjs"
+      },
+      "default": { "types": "./dist/index.d.ts", "default": "./dist/index.mjs" }
+    },
+    "./helpers": {
+      "import": {
+        "types": "./dist/helpers.d.ts",
+        "default": "./dist/helpers.mjs"
+      },
+      "require": {
+        "types": "./dist/helpers.d.ts",
+        "default": "./dist/helpers.cjs"
+      },
+      "default": {
+        "types": "./dist/helpers.d.ts",
+        "default": "./dist/helpers.mjs"
+      }
+    },
+    ".": {
+      "import": { "types": "./dist/index.d.ts", "default": "./dist/index.mjs" },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.cjs"
+      },
+      "default": { "types": "./dist/index.d.ts", "default": "./dist/index.mjs" }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts"
+}