@helpers4/url 2.0.0-alpha.1 → 2.0.0-alpha.2

package/README.md

@@ -12,13 +12,13 @@ A set of helpers for working with URLs.
 [https://helpers4.js.org/url](https://helpers4.js.org/url)
 
 <!-- AUTOMATIC-METHODS -->
-- withoutLeadingSlash
 - withTrailingSlash
-- onlyPath
+- withoutLeadingSlash
 - cleanPath
-- withLeadingSlash
 - relativeURLToAbsolute
+- withLeadingSlash
 - extractPureURI
+- onlyPath
 - withoutTrailingSlash
 <!-- /AUTOMATIC-METHODS -->
 

package/lib/index.d.ts

@@ -1,8 +1,8 @@
-export * from './withoutLeadingSlash';
-export * from './withTrailingSlash';
-export * from './onlyPath';
-export * from './cleanPath';
-export * from './withLeadingSlash';
-export * from './relativeURLToAbsolute';
-export * from './extractPureURI';
-export * from './withoutTrailingSlash';
+export declare function withTrailingSlash(url: string): string  /** * Adds a trailing slash `/` to the given URL if it is not already present. * * This function is useful for ensuring that URLs are properly formatted * with a trailing slash, which is often required in web development for * consistency and to avoid issues with relative paths. * * @param url - The URL string to be processed. Can be `string`, `undefined`, or `null`. * @returns The URL string with a trailing slash, or `undefined` if the input is `undefined`, or `null` if the input is `null`. * * @see https://radashi.js.org/reference/url/withTrailingSlash * * @example * ```ts * withTrailingSlash('') // => '/' * withTrailingSlash('no/slash') // => 'no/slash/' * withTrailingSlash('already/has/slash/') // => 'already/has/slash/' * withTrailingSlash(undefined) // => undefined * withTrailingSlash(null) // => null * ``` */ export function withTrailingSlash(url: undefined): undefined  /** * Adds a trailing slash `/` to the given URL if it is not already present. * * This function is useful for ensuring that URLs are properly formatted * with a trailing slash, which is often required in web development for * consistency and to avoid issues with relative paths. * * @param url - The URL string to be processed. Can be `string`, `undefined`, or `null`. * @returns The URL string with a trailing slash, or `undefined` if the input is `undefined`, or `null` if the input is `null`. * * @see https://radashi.js.org/reference/url/withTrailingSlash * * @example * ```ts * withTrailingSlash('') // => '/' * withTrailingSlash('no/slash') // => 'no/slash/' * withTrailingSlash('already/has/slash/') // => 'already/has/slash/' * withTrailingSlash(undefined) // => undefined * withTrailingSlash(null) // => null * ``` */ export function withTrailingSlash(url: null): null  /** * Adds a trailing slash `/` to the given URL if it is not already present. * * This function is useful for ensuring that URLs are properly formatted * with a trailing slash, which is often required in web development for * consistency and to avoid issues with relative paths. * * @param url - The URL string to be processed. Can be `string`, `undefined`, or `null`. * @returns The URL string with a trailing slash, or `undefined` if the input is `undefined`, or `null` if the input is `null`. * * @see https://radashi.js.org/reference/url/withTrailingSlash * * @example * ```ts * withTrailingSlash('') // => '/' * withTrailingSlash('no/slash') // => 'no/slash/' * withTrailingSlash('already/has/slash/') // => 'already/has/slash/' * withTrailingSlash(undefined) // => undefined * withTrailingSlash(null) // => null * ``` */ export function withTrailingSlash( url: string | undefined | null, ): string | undefined | null;
+export declare function withoutLeadingSlash(url: string): string  /** * Removes the leading slash `/` from the given URL if it is present. * * This function is useful for ensuring that URLs are properly formatted * without a leading slash, which is often required in web development for * consistency and to avoid issues with relative paths. * * @param url - The URL string to be processed. Can be `string`, `undefined`, or `null`. * @returns The URL string without a leading slash, or `undefined` if the input is `undefined`, or `null` if the input is `null`. * * @see https://radashi.js.org/reference/url/withoutLeadingSlash * * @example * ```ts * withoutLeadingSlash('') // => '' * withoutLeadingSlash('/') // => '' * withoutLeadingSlash('/no/slash') // => 'no/slash' * withoutLeadingSlash('already/has/slash') // => 'already/has/slash' * withoutLeadingSlash(undefined) // => undefined * withoutLeadingSlash(null) // => null * ``` */ export function withoutLeadingSlash(url: undefined): undefined  /** * Removes the leading slash `/` from the given URL if it is present. * * This function is useful for ensuring that URLs are properly formatted * without a leading slash, which is often required in web development for * consistency and to avoid issues with relative paths. * * @param url - The URL string to be processed. Can be `string`, `undefined`, or `null`. * @returns The URL string without a leading slash, or `undefined` if the input is `undefined`, or `null` if the input is `null`. * * @see https://radashi.js.org/reference/url/withoutLeadingSlash * * @example * ```ts * withoutLeadingSlash('') // => '' * withoutLeadingSlash('/') // => '' * withoutLeadingSlash('/no/slash') // => 'no/slash' * withoutLeadingSlash('already/has/slash') // => 'already/has/slash' * withoutLeadingSlash(undefined) // => undefined * withoutLeadingSlash(null) // => null * ``` */ export function withoutLeadingSlash(url: null): null  /** * Removes the leading slash `/` from the given URL if it is present. * * This function is useful for ensuring that URLs are properly formatted * without a leading slash, which is often required in web development for * consistency and to avoid issues with relative paths. * * @param url - The URL string to be processed. Can be `string`, `undefined`, or `null`. * @returns The URL string without a leading slash, or `undefined` if the input is `undefined`, or `null` if the input is `null`. * * @see https://radashi.js.org/reference/url/withoutLeadingSlash * * @example * ```ts * withoutLeadingSlash('') // => '' * withoutLeadingSlash('/') // => '' * withoutLeadingSlash('/no/slash') // => 'no/slash' * withoutLeadingSlash('already/has/slash') // => 'already/has/slash' * withoutLeadingSlash(undefined) // => undefined * withoutLeadingSlash(null) // => null * ``` */ export function withoutLeadingSlash( url: string | undefined | null, ): string | undefined | null;
+export declare function cleanPath(url: string | undefined | null,): string | undefined | null;
+export declare function relativeURLToAbsolute(relativeUrl: string): string;
+export declare function withLeadingSlash(url: string): string  /** * Adds a leading slash `/` to the given URL if it is not already present. * * This function is useful for ensuring that URLs are properly formatted * with a leading slash, which is often required in web development for * consistency and to avoid issues with relative paths. * * @param url - The URL string to be processed. Can be `string`, `undefined`, or `null`. * @returns The URL string with a leading slash, or `undefined` if the input is `undefined`, or `null` if the input is `null`. * * @see https://radashi.js.org/reference/url/withLeadingSlash * * @example * ```ts * withLeadingSlash('') // => '/' * withLeadingSlash('no/slash') // => '/no/slash' * withLeadingSlash('/already/has/slash') // => '/already/has/slash' * withLeadingSlash(undefined) // => undefined * withLeadingSlash(null) // => null * ``` */ export function withLeadingSlash(url: undefined): undefined  /** * Adds a leading slash `/` to the given URL if it is not already present. * * This function is useful for ensuring that URLs are properly formatted * with a leading slash, which is often required in web development for * consistency and to avoid issues with relative paths. * * @param url - The URL string to be processed. Can be `string`, `undefined`, or `null`. * @returns The URL string with a leading slash, or `undefined` if the input is `undefined`, or `null` if the input is `null`. * * @see https://radashi.js.org/reference/url/withLeadingSlash * * @example * ```ts * withLeadingSlash('') // => '/' * withLeadingSlash('no/slash') // => '/no/slash' * withLeadingSlash('/already/has/slash') // => '/already/has/slash' * withLeadingSlash(undefined) // => undefined * withLeadingSlash(null) // => null * ``` */ export function withLeadingSlash(url: null): null  /** * Adds a leading slash `/` to the given URL if it is not already present. * * This function is useful for ensuring that URLs are properly formatted * with a leading slash, which is often required in web development for * consistency and to avoid issues with relative paths. * * @param url - The URL string to be processed. Can be `string`, `undefined`, or `null`. * @returns The URL string with a leading slash, or `undefined` if the input is `undefined`, or `null` if the input is `null`. * * @see https://radashi.js.org/reference/url/withLeadingSlash * * @example * ```ts * withLeadingSlash('') // => '/' * withLeadingSlash('no/slash') // => '/no/slash' * withLeadingSlash('/already/has/slash') // => '/already/has/slash' * withLeadingSlash(undefined) // => undefined * withLeadingSlash(null) // => null * ``` */ export function withLeadingSlash( url: string | undefined | null, ): string | undefined | null;
+export declare function extractPureURI(url: string): string; export function extractPureURI(url: undefined): undefined; export function extractPureURI(url: null): null; export function extractPureURI(url: string | undefined | null): string | undefined | null;
+export declare function onlyPath(url: string): string  /** * Extract only the path from an URI with optional query and fragments. * * For example, all these parameters will return `/path`: *  - `/path` *  - `/path?query=thing` *  - `/path#fragment` *  - `/path?query=thing#fragment` * * @param url - The URL string to be processed. Can be `string`, `undefined`, or `null`. * @returns The URL string without query and fragment, or `undefined` if the input is `undefined`, or `null` if the input is `null`. * * @example * ```ts * onlyPath('/path') // => '/path' * onlyPath('/path?query=thing') // => '/path' * onlyPath('/path#fragment') // => '/path' * onlyPath('/path?query=thing#fragment') // => '/path' * onlyPath(undefined) // => undefined * onlyPath(null) // => null * ``` */ export function onlyPath(url: null): null  /** * Extract only the path from an URI with optional query and fragments. * * For example, all these parameters will return `/path`: *  - `/path` *  - `/path?query=thing` *  - `/path#fragment` *  - `/path?query=thing#fragment` * * @param url - The URL string to be processed. Can be `string`, `undefined`, or `null`. * @returns The URL string without query and fragment, or `undefined` if the input is `undefined`, or `null` if the input is `null`. * * @example * ```ts * onlyPath('/path') // => '/path' * onlyPath('/path?query=thing') // => '/path' * onlyPath('/path#fragment') // => '/path' * onlyPath('/path?query=thing#fragment') // => '/path' * onlyPath(undefined) // => undefined * onlyPath(null) // => null * ``` */ export function onlyPath(url: undefined): undefined  /** * Extract only the path from an URI with optional query and fragments. * * For example, all these parameters will return `/path`: *  - `/path` *  - `/path?query=thing` *  - `/path#fragment` *  - `/path?query=thing#fragment` * * @param url - The URL string to be processed. Can be `string`, `undefined`, or `null`. * @returns The URL string without query and fragment, or `undefined` if the input is `undefined`, or `null` if the input is `null`. * * @example * ```ts * onlyPath('/path') // => '/path' * onlyPath('/path?query=thing') // => '/path' * onlyPath('/path#fragment') // => '/path' * onlyPath('/path?query=thing#fragment') // => '/path' * onlyPath(undefined) // => undefined * onlyPath(null) // => null * ``` */ export function onlyPath( url: string | undefined | null, ): string | undefined | null;
+export declare function withoutTrailingSlash(url: string): string  /** * Removes the trailing slash `/` from the given URL if it is present. * * This function is useful for ensuring that URLs are properly formatted * without a trailing slash, which is often required in web development for * consistency and to avoid issues with relative paths. * * @param url - The URL string to be processed. Can be `string`, `undefined`, or `null`. * @returns The URL string without a trailing slash, or `undefined` if the input is `undefined`, or `null` if the input is `null`. * * @see https://radashi.js.org/reference/url/withoutTrailingSlash * * @example * ```ts * withoutTrailingSlash('') // => '' * withoutTrailingSlash('/') // => '' * withoutTrailingSlash('no/slash/') // => 'no/slash' * withoutTrailingSlash('already/has/slash') // => 'already/has/slash' * withoutTrailingSlash(undefined) // => undefined * withoutTrailingSlash(null) // => null * ``` */ export function withoutTrailingSlash(url: undefined): undefined  /** * Removes the trailing slash `/` from the given URL if it is present. * * This function is useful for ensuring that URLs are properly formatted * without a trailing slash, which is often required in web development for * consistency and to avoid issues with relative paths. * * @param url - The URL string to be processed. Can be `string`, `undefined`, or `null`. * @returns The URL string without a trailing slash, or `undefined` if the input is `undefined`, or `null` if the input is `null`. * * @see https://radashi.js.org/reference/url/withoutTrailingSlash * * @example * ```ts * withoutTrailingSlash('') // => '' * withoutTrailingSlash('/') // => '' * withoutTrailingSlash('no/slash/') // => 'no/slash' * withoutTrailingSlash('already/has/slash') // => 'already/has/slash' * withoutTrailingSlash(undefined) // => undefined * withoutTrailingSlash(null) // => null * ``` */ export function withoutTrailingSlash(url: null): null  /** * Removes the trailing slash `/` from the given URL if it is present. * * This function is useful for ensuring that URLs are properly formatted * without a trailing slash, which is often required in web development for * consistency and to avoid issues with relative paths. * * @param url - The URL string to be processed. Can be `string`, `undefined`, or `null`. * @returns The URL string without a trailing slash, or `undefined` if the input is `undefined`, or `null` if the input is `null`. * * @see https://radashi.js.org/reference/url/withoutTrailingSlash * * @example * ```ts * withoutTrailingSlash('') // => '' * withoutTrailingSlash('/') // => '' * withoutTrailingSlash('no/slash/') // => 'no/slash' * withoutTrailingSlash('already/has/slash') // => 'already/has/slash' * withoutTrailingSlash(undefined) // => undefined * withoutTrailingSlash(null) // => null * ``` */ export function withoutTrailingSlash( url: string | undefined | null, ): string | undefined | null;

package/lib/index.js

@@ -1,9 +1,79 @@
-// helpers/url/index.ts
-export * from "./withoutLeadingSlash";
-export * from "./withTrailingSlash";
-export * from "./onlyPath";
-export * from "./cleanPath";
-export * from "./withLeadingSlash";
-export * from "./relativeURLToAbsolute";
-export * from "./extractPureURI";
-export * from "./withoutTrailingSlash";
+// helpers/url/withTrailingSlash.ts
+function withTrailingSlash(url) {
+  if (url === undefined || url === null) {
+    return url;
+  }
+  return url[url.length - 1] === "/" ? url : url + "/";
+}
+// helpers/url/withoutLeadingSlash.ts
+function withoutLeadingSlash(url) {
+  if (url === undefined || url === null) {
+    return url;
+  }
+  return url[0] === "/" ? url.slice(1) : url;
+}
+// helpers/url/cleanPath.ts
+function cleanPath(url) {
+  if (url === undefined || url === null) {
+    return url;
+  }
+  return url.replace(/([^:]\/)\/+/g, "$1");
+}
+// helpers/url/withoutTrailingSlash.ts
+function withoutTrailingSlash(url) {
+  if (url === undefined || url === null) {
+    return url;
+  }
+  return url[url.length - 1] === "/" ? url.slice(0, -1) : url;
+}
+
+// helpers/url/withLeadingSlash.ts
+function withLeadingSlash(url) {
+  if (url === undefined || url === null) {
+    return url;
+  }
+  return url[0] === "/" ? url : "/" + url;
+}
+
+// helpers/url/relativeURLToAbsolute.ts
+function relativeURLToAbsolute(relativeUrl) {
+  return withoutTrailingSlash(document.baseURI ?? window.location.origin) + cleanPath(withLeadingSlash(relativeUrl));
+}
+// helpers/url/extractPureURI.ts
+function extractPureURI(url) {
+  if (url === undefined || url === null) {
+    return url;
+  }
+  const queryIndex = url.indexOf("?");
+  const fragmentIndex = url.indexOf("#");
+  let cutIndex = -1;
+  if (queryIndex !== -1 && fragmentIndex !== -1) {
+    cutIndex = Math.min(queryIndex, fragmentIndex);
+  } else if (queryIndex !== -1) {
+    cutIndex = queryIndex;
+  } else if (fragmentIndex !== -1) {
+    cutIndex = fragmentIndex;
+  }
+  if (cutIndex === -1) {
+    return url;
+  }
+  return url.substring(0, cutIndex);
+}
+// helpers/url/onlyPath.ts
+function onlyPath(url) {
+  if (url === undefined || url === null) {
+    return url;
+  }
+  const [path] = url.split(/[?#]/);
+  return path;
+}
+export {
+  withoutTrailingSlash,
+  withoutLeadingSlash,
+  withTrailingSlash,
+  withLeadingSlash,
+  relativeURLToAbsolute,
+  onlyPath,
+  extractPureURI,
+  cleanPath
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helpers4/url",
-  "version": "2.0.0-alpha.1",
+  "version": "2.0.0-alpha.2",
   "description": "A set of helpers in TS/JS, compatible with tree-shaking, for url.",
   "author": "baxyz <baxy@etik.com>",
   "license": "AGPL-3.0",
@@ -20,13 +20,13 @@
   "keywords": [
     "helpers",
     "url",
-    "withoutLeadingSlash",
     "withTrailingSlash",
-    "onlyPath",
+    "withoutLeadingSlash",
     "cleanPath",
-    "withLeadingSlash",
     "relativeURLToAbsolute",
+    "withLeadingSlash",
     "extractPureURI",
+    "onlyPath",
     "withoutTrailingSlash"
   ],
   "files": [