add a set of new utilities

Author: piotrkulpinski

src/helpers/helpers.test.ts

@@ -7,6 +7,7 @@ import {
   getShortcutLabel,
   isCuid,
   isTruthy,
+  joinAsSentence,
   range,
   slugify,
   splitArrayChunks,
@@ -154,3 +155,21 @@ describe("splitArrayChunks", () => {
     expect(splitArrayChunks([], 3)).toEqual([])
   })
 })
+
+describe("joinAsSentence", () => {
+  it("joins an array of strings into a sentence", () => {
+    expect(joinAsSentence(["apple"])).toEqual("apple")
+    expect(joinAsSentence(["apple", "banana"])).toEqual("apple and banana")
+    expect(joinAsSentence(["apple", "banana", "cherry"])).toEqual("apple, banana and cherry")
+  })
+
+  it("joins an array of strings into a sentence with a custom last item", () => {
+    expect(joinAsSentence(["apple", "banana", "cherry"], undefined, "or")).toEqual(
+      "apple, banana or cherry",
+    )
+  })
+
+  it("joins an array with custom max items", () => {
+    expect(joinAsSentence(["apple", "banana", "cherry"], 2)).toEqual("apple and banana")
+  })
+})

src/helpers/helpers.ts

@@ -183,3 +183,17 @@ export const setInputValue = (
   // Trigger a change event if the value was changed
   triggerChange && input?.dispatchEvent(new Event("input", { bubbles: true }))
 }
+
+/**
+ * Joins an array of strings into a sentence, with a maximum of 3 items.
+ *
+ * @param items The array of strings to be joined.
+ * @param maxItems The maximum number of items to include in the sentence.
+ * @returns The joined sentence.
+ */
+export const joinAsSentence = (items: string[], maxItems = 3, lastItem = "and") => {
+  return items
+    .slice(0, maxItems)
+    .join(", ")
+    .replace(/, ([^,]*)$/, ` ${lastItem} $1`)
+}

src/http/http.test.ts

@@ -1,6 +1,14 @@
 import { describe, expect, it } from "bun:test"
 
-import { addHttp, isExternalLink, removeHttp, removeTrailingSlash } from "./http"
+import {
+  addHttp,
+  getUrlHostname,
+  isExternalLink,
+  isValidUrl,
+  removeHttp,
+  removeTrailingSlash,
+  stripURLSubpath,
+} from "./http"
 
 describe("addHttp", () => {
   it("adds https protocol to url", () => {
@@ -77,3 +85,48 @@ describe("isExternalLink", () => {
     expect(isExternalLink()).toBe(false)
   })
 })
+
+describe("stripURLSubpath", () => {
+  it("returns the original URL if it's not a valid URL", () => {
+    const url = "not a URL"
+    expect(stripURLSubpath(url)).toBe(url)
+  })
+
+  it("returns stripped URL", () => {
+    const url = "https://example.com/path/to/resource"
+    expect(stripURLSubpath(url)).toBe("https://example.com")
+  })
+})
+
+describe("getUrlHostname", () => {
+  it("returns the hostname for a valid URL", () => {
+    const url = "https://example.com"
+    expect(getUrlHostname(url)).toBe("example.com")
+  })
+
+  it("returns the original URL if it's not a valid URL", () => {
+    const url = "not a URL"
+    expect(getUrlHostname(url)).toBe(url)
+  })
+
+  it("returns the original URL if it's not a valid URL", () => {
+    const url = "not a URL"
+    expect(getUrlHostname(url)).toBe(url)
+  })
+})
+
+describe("isValidUrl", () => {
+  it("returns true for valid URL", () => {
+    const url = "https://example.com"
+    expect(isValidUrl(url)).toBe(true)
+  })
+
+  it("returns false for invalid URL", () => {
+    const url = "not a URL"
+    expect(isValidUrl(url)).toBe(false)
+  })
+
+  it("returns false for empty input", () => {
+    expect(isValidUrl()).toBe(false)
+  })
+})

src/http/http.ts

@@ -5,36 +5,83 @@
 /**
  * Adds the appropriate protocol (http or https) to the given URL
  * based on whether the URL contains the string 'localhost'.
- * @param {string} url - The URL to modify.
- * @returns {string} A new URL string with the appropriate protocol added.
+ * @param url - The URL to modify.
+ * @returns A new URL string with the appropriate protocol added.
  */
 export const addHttp = (url?: string): string => {
   return url ? `${url.includes("localhost") ? "http" : "https"}://${url}` : ""
 }
 
 /**
  * Removes the protocol from the given URL string.
- * @param {string} url - The URL string to modify.
- * @returns {string} A new URL string with the protocol removed.
+ * @param url - The URL string to modify.
+ * @returns A new URL string with the protocol removed.
  */
 export const removeHttp = (url?: string): string => {
   return url ? url.replace(/^https?:\/\//, "") : ""
 }
 
 /**
  * Removes the trailing slash from the given URL string.
- * @param {string} url - The URL string to modify.
- * @returns {string} A new URL string with the trailing slash removed.
+ * @param url - The URL string to modify.
+ * @returns A new URL string with the trailing slash removed.
  */
 export const removeTrailingSlash = (url?: string): string => {
   return url ? url.replace(/\/$/, "") : ""
 }
 
 /**
  * Checks if the given URL is an external link.
- * @param {string} url - The URL to check.
- * @returns {boolean} A boolean indicating whether the URL is an external link.
+ * @param url - The URL to check.
+ * @returns A boolean indicating whether the URL is an external link.
  */
 export const isExternalLink = (url?: string): boolean => {
   return url ? url.includes("http") : false
 }
+
+/**
+ * Strips the subpath from a URL, returning only the protocol and host.
+ *
+ * @param url The URL to be stripped.
+ * @returns The URL with the subpath removed.
+ */
+export const stripURLSubpath = (url?: string) => {
+  if (!url) return url
+
+  try {
+    const parsedUrl = new URL(url)
+    return `${parsedUrl.protocol}//${parsedUrl.host}`
+  } catch (error) {
+    // If the URL is invalid, return the original string
+    return url
+  }
+}
+
+/**
+ * Returns the hostname of the given URL.
+ * @param url - The URL to get the hostname from.
+ * @returns The hostname of the URL.
+ */
+export const getUrlHostname = (url: string) => {
+  if (isValidUrl(url)) {
+    return new URL(url).hostname
+  }
+
+  return url
+}
+
+/**
+ * Checks if the given URL is valid.
+ * @param url - The URL to check.
+ * @returns A boolean indicating whether the URL is valid.
+ */
+export const isValidUrl = (url?: string) => {
+  if (!url) return false
+
+  try {
+    new URL(url)
+    return true
+  } catch (e) {
+    return false
+  }
+}

src/params/params.ts

@@ -13,11 +13,11 @@ export type GetPageParams<T> = T & {
 
 /**
  * Returns an object containing the search parameters from a request URL.
- * @param request - The request object.
+ * @param url - The request url.
  * @returns An object containing the search parameters.
  */
-export const getSearchParams = (request: Request) => {
-  return Object.fromEntries(new URL(request.url).searchParams)
+export const getSearchParams = (url: string) => {
+  return Object.fromEntries(new URL(url).searchParams)
 }
 
 /**
@@ -32,12 +32,12 @@ export const getCurrentPage = (page?: string | null) => {
 /**
  * Returns an object containing the parameters for a paginated query.
  * @template T - The type of the query parameters.
- * @param request - The request object.
+ * @param url - The URL to get the page parameters from.
  * @param take - The number of items to take per page.
  * @returns An object containing the parameters for a paginated query.
  */
-export const getPageParams = <T extends object>(request: Request, take: number) => {
-  const { page, ...params } = getSearchParams(request)
+export const getPageParams = <T extends object>(url: string, take: number) => {
+  const { page, ...params } = getSearchParams(url)
 
   const currentPage = getCurrentPage(page)
   const skip = (currentPage - 1) * take