Skip to content

armgit / plane

Public Imported from GitHub
0

πŸ”₯πŸ”₯πŸ”₯ Open-source Jira, Linear, Monday, and ClickUp alternative. Plane is a modern project management platform to manage tasks, sprints, docs, and triage.

[WEB-4705] chore: url utilities (#7589)

Jayash Tripathycd61e8dd4430
diff --git a/packages/utils/src/index.ts b/packages/utils/src/index.ts
index 1e6eb687e4..760f823338 100644
--- a/packages/utils/src/index.ts
+++ b/packages/utils/src/index.ts
@@ -26,5 +26,6 @@ export * from "./string";
export * from "./subscription";
export * from "./tab-indices";
export * from "./theme";
+export * from "./url";
export * from "./work-item";
export * from "./workspace";
diff --git a/packages/utils/src/url.ts b/packages/utils/src/url.ts
new file mode 100644
index 0000000000..5c6351f736
--- /dev/null
+++ b/packages/utils/src/url.ts
@@ -0,0 +1,96 @@
+/**
+ * Interface representing the components of a URL.
+ * @interface IURLComponents
+ * @property {string} protocol - The URL protocol (e.g., 'http', 'https')
+ * @property {string} subdomain - The subdomain part of the URL (e.g., 'blog' in 'blog.example.com')
+ * @property {string} rootDomain - The root domain name (e.g., 'example' in 'blog.example.com')
+ * @property {string} tld - The top-level domain (e.g., 'com', 'org')
+ * @property {string} path - The URL path including search params and hash
+ * @property {URL} full - The original URL object with all native URL properties
+ */
+export interface IURLComponents {
+ protocol: string;
+ subdomain: string;
+ rootDomain: string;
+ tld: string;
+ path: string;
+ full: URL;
+}
+
+/**
+ * Extracts components from a URL object.
+ *
+ * @param {URL} url - The URL object to extract components from
+ * @returns {IURLComponents | undefined} URL components or undefined if invalid
+ *
+ * @example
+ * const url = new URL('https://blog.example.com/posts');
+ * extractURLComponents(url);
+ * // {
+ * // protocol: 'https',
+ * // subdomain: 'blog',
+ * // rootDomain: 'example',
+ * // tld: 'com',
+ * // path: 'posts',
+ * // full: URL {} // The original URL object
+ * // }
+ */
+
+export function extractURLComponents(url: URL): IURLComponents | undefined {
+ try {
+ const protocol = url.protocol.slice(0, -1);
+ const pathname = url.pathname.replace(/^\/+/, "").replace(/\/{2,}/g, "/");
+ const path = pathname + url.search + url.hash;
+ const hostnameParts = url.hostname.split(".");
+
+ let subdomain = "";
+ let rootDomain = "";
+ let tld = "";
+
+ if (hostnameParts.length >= 2) {
+ tld = hostnameParts[hostnameParts.length - 1];
+ rootDomain = hostnameParts[hostnameParts.length - 2];
+
+ if (hostnameParts.length > 2) {
+ subdomain = hostnameParts.slice(0, -2).join(".");
+ }
+ }
+
+ return {
+ protocol,
+ subdomain,
+ rootDomain,
+ tld,
+ path,
+ full: url,
+ };
+ } catch (error) {
+ console.error(`Error extracting URL components: ${url.href}`, error);
+ return undefined;
+ }
+}
+
+/**
+ * Checks if a string is a valid URL.
+ *
+ * @param {string} urlString - The string to validate as URL
+ * @returns {URL | undefined} URL object if valid, undefined if invalid
+ *
+ * @example
+ * // Valid URLs
+ * getValidURL('https://example.com') // returns URL object
+ * getValidURL('http://example.com') // returns URL object
+ * getValidURL('https://sub.example.com') // returns URL object
+ *
+ * // Invalid URLs
+ * getValidURL('not-a-url') // returns undefined
+ * getValidURL('example.com') // returns undefined (no protocol)
+ * getValidURL('https://invalid.') // returns undefined
+ */
+export function getValidURL(urlString: string): URL | undefined {
+ try {
+ return new URL(urlString);
+ } catch {
+ return undefined;
+ }
+}