@stryke/http 0.3.1 → 0.5.0

package/README.md

@@ -3,7 +3,7 @@
 <!-- markdownlint-disable -->
 
 
-<div align="center"><img src="https://pub-761b436209f44a4d886487c917806c08.r2.dev/storm-banner.gif" width="100%" alt="Storm Software" /></div>
+<div align="center"><img src="https://public.storm-cdn.com/storm-banner.gif" width="100%" alt="Storm Software" /></div>
 <br />
 
 <div align="center">
@@ -22,7 +22,7 @@ This package is part of Storm Software's **🌩️ Stryke** monorepo. Stryke pac
 
 <h3 align="center">💻 Visit <a href="https://stormsoftware.com" target="_blank">stormsoftware.com</a> to stay up to date with this developer</h3><br />
 
-[![Version](https://img.shields.io/badge/version-0.1.4-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/stryke/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
+[![Version](https://img.shields.io/badge/version-0.4.0-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/stryke/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
 
 > [!IMPORTANT] This repository, and the apps, libraries, and tools contained
 > within, is still in it's initial development phase. As a result, bugs and
@@ -51,7 +51,6 @@ between processes easier in other packages/applications.
 
 <!-- START doctoc -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-
 ## Table of Contents
 
 - [Installing](#installing)
@@ -247,7 +246,7 @@ specification. Contributions of any kind welcome!
 <br />
 
 <div align="center">
-<img src="https://pub-761b436209f44a4d886487c917806c08.r2.dev/logo-banner.png" width="100%" alt="Storm Software" />
+<img src="https://public.storm-cdn.com/logo-banner.png" width="100%" alt="Storm Software" />
 </div>
 <br />
 
@@ -278,9 +277,9 @@ generation of development tools, please reach out on our
 
 <br />
 
-<div align="center"><a href="https://stormsoftware.com" target="_blank"><img src="https://pub-761b436209f44a4d886487c917806c08.r2.dev/icon-fill.png" alt="Storm Software" width="200px"/></a></div>
+<div align="center"><a href="https://stormsoftware.com" target="_blank"><img src="https://public.storm-cdn.com/icon-fill.png" alt="Storm Software" width="200px"/></a></div>
 <br />
-<div align="center"><a href="https://stormsoftware.com" target="_blank"><img src="https://pub-761b436209f44a4d886487c917806c08.r2.dev/visit-us-text.svg" alt="Visit us at stormsoftware.com" height="90px"/></a></div>
+<div align="center"><a href="https://stormsoftware.com" target="_blank"><img src="https://public.storm-cdn.com/visit-us-text.svg" alt="Visit us at stormsoftware.com" height="90px"/></a></div>
 
 <br />
 

package/dist/index.cjs

@@ -25,6 +25,17 @@ Object.keys(_formatDataUri).forEach(function (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];
+    }
+  });
+});
 var _urlBuilder = require("./url-builder.cjs");
 Object.keys(_urlBuilder).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./cookie";
 export * from "./format-data-uri";
+export * from "./types";
 export * from "./url-builder";

package/dist/index.mjs

@@ -1 +1 @@
-export*from"./cookie";export*from"./format-data-uri";export*from"./url-builder";
+export*from"./cookie";export*from"./format-data-uri";export*from"./types";export*from"./url-builder";

package/dist/types.d.ts

@@ -1,7 +1,8 @@
 import type { ParsedURL } from "ufo";
 export type StormURL = ParsedURL & {
     __typename: "StormURL";
-    query: Record<string, any>;
+    queryParams: Record<string, any>;
+    paths: string[];
     username?: string;
     password?: string;
     hostname?: string;
@@ -27,13 +28,13 @@ export interface CookieSerializeOptions {
      * encode a JavaScript string into UTF-8 byte sequences and then URL-encode
      * any that fall outside of the cookie range.
      */
-    encode?(value: string): string;
+    encode?: (value: string) => string;
     /**
      * Specifies the `Date` object to be the value for the {@link https://tools.ietf.org/html/rfc6265#section-5.2.1 | `Expires` `Set-Cookie` attribute}. By default,
      * no expiration is set, and most clients will consider this a "non-persistent cookie" and will delete
      * it on a condition like exiting a web browser application.
      *
-     * *Note* the {@link https://tools.ietf.org/html/rfc6265#section-5.3 | cookie storage model specification}
+     * Note* the {@link https://tools.ietf.org/html/rfc6265#section-5.3 | cookie storage model specification}
      * states that if both `expires` and `maxAge` are set, then `maxAge` takes precedence, but it is
      * possible not all clients by obey this, so if both are set, they should
      * point to the same date and time.
@@ -44,7 +45,7 @@ export interface CookieSerializeOptions {
      * When truthy, the `HttpOnly` attribute is set, otherwise it is not. By
      * default, the `HttpOnly` attribute is not set.
      *
-     * *Note* be careful when setting this to true, as compliant clients will
+     * Note* be careful when setting this to true, as compliant clients will
      * not allow client-side JavaScript to see the cookie in `document.cookie`.
      */
     httpOnly?: boolean | undefined;
@@ -53,7 +54,7 @@ export interface CookieSerializeOptions {
      * `Set-Cookie` attribute. The given number will be converted to an integer
      * by rounding down. By default, no maximum age is set.
      *
-     * *Note* the {@link https://tools.ietf.org/html/rfc6265#section-5.3 | cookie storage model specification}
+     * Note* the {@link https://tools.ietf.org/html/rfc6265#section-5.3 | cookie storage model specification}
      * states that if both `expires` and `maxAge` are set, then `maxAge` takes precedence, but it is
      * possible not all clients by obey this, so if both are set, they should
      * point to the same date and time.
@@ -93,14 +94,14 @@ export interface CookieSerializeOptions {
      *
      * More information about the different enforcement levels can be found in {@link https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-03#section-4.1.2.7|the specification}.
      *
-     * *note* This is an attribute that has not yet been fully standardized, and may change in the future. This also means many clients may ignore this attribute until they understand it.
+     * note* This is an attribute that has not yet been fully standardized, and may change in the future. This also means many clients may ignore this attribute until they understand it.
      */
     sameSite?: true | false | "lax" | "strict" | "none" | undefined;
     /**
      * Specifies the boolean value for the {@link https://tools.ietf.org/html/rfc6265#section-5.2.5 | `Secure` `Set-Cookie` attribute}. When truthy, the
      * `Secure` attribute is set, otherwise it is not. By default, the `Secure` attribute is not set.
      *
-     * *Note* be careful when setting this to `true`, as compliant clients will
+     * Note* be careful when setting this to `true`, as compliant clients will
      * not send the cookie back to the server in the future if the browser does
      * not have an HTTPS connection.
      */
@@ -130,14 +131,14 @@ export interface CookieParseOptions {
      * The default function is the global `decodeURIComponent`, which will decode
      * any URL-encoded sequences into their byte representations.
      *
-     * *Note* if an error is thrown from this function, the original, non-decoded
+     * Note* if an error is thrown from this function, the original, non-decoded
      * cookie value will be returned as the cookie's value.
      */
-    decode?(value: string): string;
+    decode?: (value: string) => string;
     /**
      * Custom function to filter parsing specific keys.
      */
-    filter?(key: string): boolean;
+    filter?: (key: string) => boolean;
 }
 export interface SetCookieParseOptions {
     /**

package/dist/url-builder.cjs

@@ -8,89 +8,91 @@ var _stormJson = require("@stryke/json/storm-json");
 var _isString = require("@stryke/type-checks/is-string");
 var _ufo = require("ufo");
 class StormURLBuilder {
-  #r;
-  static create(r, t) {
-    return new StormURLBuilder(r, t);
-  }
-  constructor(r, t) {
-    const s = t?.decode ?? !0,
-      n = (0, _isString.isString)(r) ? s ? (0, _ufo.parseURL)((0, _ufo.decode)(r)) : (0, _ufo.parseURL)(r) : r;
-    this.#r = {
+  #t;
+  static create(t, r) {
+    return new StormURLBuilder(t, r);
+  }
+  constructor(t, r) {
+    const s = r?.decode ?? !0,
+      i = (0, _isString.isString)(t) ? s ? (0, _ufo.parseURL)((0, _ufo.decode)(t)) : (0, _ufo.parseURL)(t) : t;
+    this.#t = {
       __typename: "StormURL",
-      query: {},
-      ...n
-    }, this.#r.host && this.withHost(this.#r.host), this.#r.auth && this.withAuth(this.#r.auth);
+      queryParams: {},
+      ...i,
+      paths: i.pathname ? i.pathname.split("/").filter(Boolean) : []
+    }, this.#t.host && this.withHost(this.#t.host), this.#t.auth && this.withAuth(this.#t.auth);
   }
   get _url() {
-    return this.#r;
+    return this.#t;
   }
-  withProtocol(r) {
-    return this.#r.protocol = r, this;
+  withProtocol(t) {
+    return this.#t.protocol = t, this;
   }
-  withHostname(r) {
-    return this.#r.hostname = r, this;
+  withHostname(t) {
+    return this.#t.hostname = t, this;
   }
-  withPort(r) {
-    return this.#r.port = String(r), this;
+  withPort(t) {
+    return this.#t.port = String(t), this;
   }
-  withUsername(r) {
-    return this.#r.username = r, this;
+  withUsername(t) {
+    return this.#t.username = t, this;
   }
-  withPassword(r) {
-    return this.#r.password = r, this;
+  withPassword(t) {
+    return this.#t.password = t, this;
   }
-  withHost(r) {
-    if ((0, _isString.isString)(r)) {
-      this.#r.host = r;
-      const t = (0, _ufo.parseAuth)(r);
-      this.#r.username = t.username, this.#r.password = t.password;
-    } else this.#r.hostname = r.hostname, this.#r.port = r.port, this.#r.auth = `${r.hostname}${r.port ? `:${r.port}` : ""}`;
+  withHost(t) {
+    if ((0, _isString.isString)(t)) {
+      this.#t.host = t;
+      const r = (0, _ufo.parseAuth)(t);
+      this.#t.username = r.username, this.#t.password = r.password;
+    } else this.#t.hostname = t.hostname, this.#t.port = t.port, this.#t.auth = `${t.hostname}${t.port ? `:${t.port}` : ""}`;
     return this;
   }
-  withPath(r) {
-    const t = (0, _ufo.parsePath)(r);
-    return this.#r = {
-      ...this.#r,
-      ...t
+  withPath(t) {
+    const r = (0, _ufo.parsePath)(t);
+    return this.#t = {
+      ...this.#t,
+      ...r,
+      paths: r.pathname.split("/").filter(Boolean)
     }, this;
   }
-  withHash(r) {
-    return this.#r.hash = r, this;
+  withHash(t) {
+    return this.#t.hash = t, this;
   }
-  withAuth(r) {
-    if ((0, _isString.isString)(r)) {
-      this.#r.auth = r;
-      const t = (0, _ufo.parseAuth)(r);
-      this.#r.username = t.username, this.#r.password = t.password;
-    } else this.#r.username = r.username, this.#r.password = r.password, this.#r.auth = `${r.username}:${r.password}`;
+  withAuth(t) {
+    if ((0, _isString.isString)(t)) {
+      this.#t.auth = t;
+      const r = (0, _ufo.parseAuth)(t);
+      this.#t.username = r.username, this.#t.password = r.password;
+    } else this.#t.username = t.username, this.#t.password = t.password, this.#t.auth = `${t.username}:${t.password}`;
     return this;
   }
-  withQuery(r) {
-    return this.#r.query = {}, this.addQueryParam(r), this;
+  withQuery(t) {
+    return this.#t.queryParams = {}, this.addQueryParam(t), this;
   }
-  addQueryParam(r) {
-    if ((0, _isString.isString)(r)) {
-      const t = (0, _ufo.parseQuery)(r);
-      for (const s in Object.entries(t)) s[0] && (this.#r.query[s[0]] = this.parseQueryParamValue(s[1]));
-    } else if (Array.isArray(r) && r.length === 2) this.#r.query[r[0]] = this.parseQueryParamValue(r[1]);else for (const t in Object.entries(r)) t[0] && (this.#r.query[t[0]] = this.parseQueryParamValue(t[1]));
+  addQueryParam(t) {
+    if ((0, _isString.isString)(t)) {
+      const r = (0, _ufo.parseQuery)(t);
+      for (const s of Object.entries(r)) s[0] && (this.#t.queryParams[s[0]] = this.parseQueryParamValue(s[1]));
+    } else if (Array.isArray(t) && t.length === 2) this.#t.queryParams[t[0]] = this.parseQueryParamValue(t[1]);else for (const r of Object.entries(t)) r[0] && (this.#t.queryParams[r[0]] = this.parseQueryParamValue(r[1]));
     return this;
   }
   build() {
-    return this.#r;
+    return this.#t;
   }
   toString() {
-    return (0, _ufo.cleanDoubleSlashes)((0, _ufo.stringifyParsedURL)(this.#r));
+    return (0, _ufo.cleanDoubleSlashes)((0, _ufo.stringifyParsedURL)(this.#t));
   }
   toEncoded() {
     return (0, _ufo.encode)(this.toString());
   }
-  parseQueryParamValue(r) {
-    if (Array.isArray(r)) {
-      const t = [];
-      for (const s in r) t.push(this.parseQueryParamValue(s));
-      return t;
+  parseQueryParamValue(t) {
+    if (Array.isArray(t)) {
+      const r = [];
+      for (const s of t) r.push(this.parseQueryParamValue(s));
+      return r;
     }
-    return _stormJson.StormJSON.parse(r);
+    return _stormJson.StormJSON.parse(t);
   }
 }
 exports.StormURLBuilder = StormURLBuilder;

package/dist/url-builder.d.ts

@@ -106,10 +106,10 @@ export declare class StormURLBuilder {
     /**
      * Add a query parameter to the URL
      *
-     * @param query - The query parameter to add
+     * @param queryParam - The query parameter to add
      * @returns The URL builder
      */
-    addQueryParam(query: string | [string, any] | Record<string, any>): StormURLBuilder;
+    addQueryParam(queryParam: string | [string, any] | Record<string, any>): StormURLBuilder;
     /**
      * Returns the built URL
      *

package/dist/url-builder.mjs

@@ -1 +1 @@
-import{StormJSON as a}from"@stryke/json/storm-json";import{isString as i}from"@stryke/type-checks/is-string";import{cleanDoubleSlashes as u,decode as h,encode as p,parseAuth as e,parsePath as d,parseQuery as m,parseURL as o,stringifyParsedURL as c}from"ufo";export class StormURLBuilder{#r;static create(r,t){return new StormURLBuilder(r,t)}constructor(r,t){const s=t?.decode??!0,n=i(r)?s?o(h(r)):o(r):r;this.#r={__typename:"StormURL",query:{},...n},this.#r.host&&this.withHost(this.#r.host),this.#r.auth&&this.withAuth(this.#r.auth)}get _url(){return this.#r}withProtocol(r){return this.#r.protocol=r,this}withHostname(r){return this.#r.hostname=r,this}withPort(r){return this.#r.port=String(r),this}withUsername(r){return this.#r.username=r,this}withPassword(r){return this.#r.password=r,this}withHost(r){if(i(r)){this.#r.host=r;const t=e(r);this.#r.username=t.username,this.#r.password=t.password}else this.#r.hostname=r.hostname,this.#r.port=r.port,this.#r.auth=`${r.hostname}${r.port?`:${r.port}`:""}`;return this}withPath(r){const t=d(r);return this.#r={...this.#r,...t},this}withHash(r){return this.#r.hash=r,this}withAuth(r){if(i(r)){this.#r.auth=r;const t=e(r);this.#r.username=t.username,this.#r.password=t.password}else this.#r.username=r.username,this.#r.password=r.password,this.#r.auth=`${r.username}:${r.password}`;return this}withQuery(r){return this.#r.query={},this.addQueryParam(r),this}addQueryParam(r){if(i(r)){const t=m(r);for(const s in Object.entries(t))s[0]&&(this.#r.query[s[0]]=this.parseQueryParamValue(s[1]))}else if(Array.isArray(r)&&r.length===2)this.#r.query[r[0]]=this.parseQueryParamValue(r[1]);else for(const t in Object.entries(r))t[0]&&(this.#r.query[t[0]]=this.parseQueryParamValue(t[1]));return this}build(){return this.#r}toString(){return u(c(this.#r))}toEncoded(){return p(this.toString())}parseQueryParamValue(r){if(Array.isArray(r)){const t=[];for(const s in r)t.push(this.parseQueryParamValue(s));return t}return a.parse(r)}}
+import{StormJSON as a}from"@stryke/json/storm-json";import{isString as e}from"@stryke/type-checks/is-string";import{cleanDoubleSlashes as h,decode as u,encode as p,parseAuth as o,parsePath as m,parseQuery as d,parseURL as n,stringifyParsedURL as l}from"ufo";export class StormURLBuilder{#t;static create(t,r){return new StormURLBuilder(t,r)}constructor(t,r){const s=r?.decode??!0,i=e(t)?s?n(u(t)):n(t):t;this.#t={__typename:"StormURL",queryParams:{},...i,paths:i.pathname?i.pathname.split("/").filter(Boolean):[]},this.#t.host&&this.withHost(this.#t.host),this.#t.auth&&this.withAuth(this.#t.auth)}get _url(){return this.#t}withProtocol(t){return this.#t.protocol=t,this}withHostname(t){return this.#t.hostname=t,this}withPort(t){return this.#t.port=String(t),this}withUsername(t){return this.#t.username=t,this}withPassword(t){return this.#t.password=t,this}withHost(t){if(e(t)){this.#t.host=t;const r=o(t);this.#t.username=r.username,this.#t.password=r.password}else this.#t.hostname=t.hostname,this.#t.port=t.port,this.#t.auth=`${t.hostname}${t.port?`:${t.port}`:""}`;return this}withPath(t){const r=m(t);return this.#t={...this.#t,...r,paths:r.pathname.split("/").filter(Boolean)},this}withHash(t){return this.#t.hash=t,this}withAuth(t){if(e(t)){this.#t.auth=t;const r=o(t);this.#t.username=r.username,this.#t.password=r.password}else this.#t.username=t.username,this.#t.password=t.password,this.#t.auth=`${t.username}:${t.password}`;return this}withQuery(t){return this.#t.queryParams={},this.addQueryParam(t),this}addQueryParam(t){if(e(t)){const r=d(t);for(const s of Object.entries(r))s[0]&&(this.#t.queryParams[s[0]]=this.parseQueryParamValue(s[1]))}else if(Array.isArray(t)&&t.length===2)this.#t.queryParams[t[0]]=this.parseQueryParamValue(t[1]);else for(const r of Object.entries(t))r[0]&&(this.#t.queryParams[r[0]]=this.parseQueryParamValue(r[1]));return this}build(){return this.#t}toString(){return h(l(this.#t))}toEncoded(){return p(this.toString())}parseQueryParamValue(t){if(Array.isArray(t)){const r=[];for(const s of t)r.push(this.parseQueryParamValue(s));return r}return a.parse(t)}}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stryke/http",
-  "version": "0.3.1",
+  "version": "0.5.0",
   "type": "module",
   "description": "A package containing HTTP communication utilities used by Storm Software.",
   "repository": {
@@ -11,8 +11,8 @@
   "private": false,
   "dependencies": {
     "ufo": "1.5.4",
-    "@stryke/json": ">=0.5.1",
-    "@stryke/type-checks": ">=0.1.1"
+    "@stryke/json": ">=0.5.2",
+    "@stryke/type-checks": ">=0.1.2"
   },
   "devDependencies": { "@types/node": "^22.13.1" },
   "publishConfig": { "access": "public" },