@push.rocks/smarturl
Advanced tools
Comparing version 3.0.8 to 3.1.0
@@ -6,5 +6,5 @@ /** | ||
name: '@push.rocks/smarturl', | ||
version: '3.0.8', | ||
version: '3.1.0', | ||
description: 'A library for parsing URLs in a detailed and flexible way.' | ||
}; | ||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSxzQkFBc0I7SUFDNUIsT0FBTyxFQUFFLE9BQU87SUFDaEIsV0FBVyxFQUFFLDREQUE0RDtDQUMxRSxDQUFBIn0= |
@@ -39,3 +39,10 @@ export interface IUrlObject { | ||
clone(): Smarturl; | ||
/** | ||
* Typed method to set a property and return the instance for chaining. | ||
* @param prop - The property name to set (must be a key of Smarturl) | ||
* @param value - The value to assign to the property | ||
* @returns The Smarturl instance for method chaining | ||
*/ | ||
set<K extends keyof this>(prop: K, value: this[K]): this; | ||
toString(): string; | ||
} |
@@ -0,13 +1,19 @@ | ||
// Import necessary plugins (if any are used in the module) | ||
import './smarturl.plugins.js'; | ||
// Main Smarturl class implementing the IUrlObject interface | ||
export class Smarturl { | ||
// Static method to create a Smarturl instance from a URL string | ||
static createFromUrl(urlArg, optionsArg) { | ||
// Parse the URL string using the built-in URL class | ||
const parsedUrlInstance = new URL(urlArg); | ||
const searchParams = {}; | ||
// enrichment | ||
// Array to hold key-value pairs of search parameters | ||
const searchParamPairs = []; | ||
// If the URL has search parameters, parse them into key-value pairs | ||
if (parsedUrlInstance.search) { | ||
parsedUrlInstance.search | ||
.replace('?', '') | ||
.split('&') | ||
.replace('?', '') // Remove the '?' at the beginning | ||
.split('&') // Split the query string into individual parameters | ||
.map((searchParamPair) => { | ||
// Split each parameter into key and value and add to the array | ||
searchParamPairs.push({ | ||
@@ -19,5 +25,7 @@ key: searchParamPair.split('=')[0], | ||
} | ||
// Convert the array of key-value pairs into an object | ||
for (const searchParamPair of searchParamPairs) { | ||
searchParams[searchParamPair.key] = searchParamPair.value; | ||
} | ||
// Merge any additional search parameters provided in optionsArg | ||
if (optionsArg?.searchParams) { | ||
@@ -28,2 +36,3 @@ for (const key of Object.keys(optionsArg.searchParams)) { | ||
} | ||
// Reconstruct the path with updated search parameters | ||
let path = parsedUrlInstance.pathname || ''; | ||
@@ -43,2 +52,3 @@ if (Object.keys(searchParams).length > 0) { | ||
} | ||
// Create an IUrlObject containing all parts of the URL | ||
const parsedUrl = { | ||
@@ -60,30 +70,45 @@ ...parsedUrlInstance, | ||
}; | ||
// Infer default ports if none are specified based on the protocol | ||
if (!parsedUrl.port && parsedUrl.protocol === 'https:') { | ||
// console.log(`inferring port 443 for "https:"`); | ||
parsedUrl.port = '443'; | ||
} | ||
if (!parsedUrl.port && parsedUrl.protocol === 'http:') { | ||
// console.log(`inferring port 80 for "http:"`); | ||
parsedUrl.port = '80'; | ||
} | ||
// Create a new Smarturl instance and assign the parsed URL properties | ||
const returnSmarturl = new Smarturl(); | ||
Object.assign(returnSmarturl, parsedUrl); | ||
Object.assign(returnSmarturl, parsedUrl); // Copy all properties from parsedUrl to returnSmarturl | ||
return returnSmarturl; | ||
} | ||
// Static method to create a Smarturl instance from an existing IUrlObject | ||
static createFromParsedUrl(parsedUrlArg) { | ||
const returnSmarturl = new Smarturl(); | ||
Object.assign(returnSmarturl, parsedUrlArg); | ||
Object.assign(returnSmarturl, parsedUrlArg); // Copy all properties from parsedUrlArg to returnSmarturl | ||
return returnSmarturl; | ||
} | ||
// Constructor initializes searchParams as an empty object | ||
constructor() { | ||
this.searchParams = {}; | ||
} | ||
// Method to create an independent clone of the current Smarturl instance | ||
clone() { | ||
const clonedInstance = new Smarturl(); | ||
Object.assign(clonedInstance, this); | ||
clonedInstance.searchParams = { ...this.searchParams }; | ||
Object.assign(clonedInstance, this); // Copy all properties to the new instance | ||
clonedInstance.searchParams = { ...this.searchParams }; // Shallow copy of searchParams to prevent shared references | ||
return clonedInstance; | ||
} | ||
/** | ||
* Typed method to set a property and return the instance for chaining. | ||
* @param prop - The property name to set (must be a key of Smarturl) | ||
* @param value - The value to assign to the property | ||
* @returns The Smarturl instance for method chaining | ||
*/ | ||
set(prop, value) { | ||
this[prop] = value; // Set the property to the new value | ||
return this; // Return the instance for chaining | ||
} | ||
// Method to convert the Smarturl instance back into a URL string | ||
toString() { | ||
let userpart = ``; | ||
let userpart = ``; // Initialize the user part of the URL (username and password) | ||
// Construct the user part based on the presence of username and password | ||
if (this.username && !this.password) { | ||
@@ -95,5 +120,6 @@ userpart = `${this.username}@`; | ||
} | ||
// Construct and return the full URL string | ||
return `${this.protocol}//${userpart}${this.hostname}:${this.port}${this.path}`; | ||
} | ||
} | ||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnR1cmwuY2xhc3Nlcy5zbWFydHVybC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0dXJsLmNsYXNzZXMuc21hcnR1cmwudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBeUIsdUJBQXVCLENBQUM7QUFzQmpELE1BQU0sT0FBTyxRQUFRO0lBQ1osTUFBTSxDQUFDLGFBQWEsQ0FDekIsTUFBYyxFQUNkLFVBRUM7UUFFRCxNQUFNLGlCQUFpQixHQUFHLElBQUksR0FBRyxDQUFDLE1BQU0sQ0FBQyxDQUFDO1FBQzFDLE1BQU0sWUFBWSxHQUFrQixFQUFFLENBQUM7UUFFdkMsYUFBYTtRQUNiLE1BQU0sZ0JBQWdCLEdBR2hCLEVBQUUsQ0FBQztRQUVULElBQUksaUJBQWlCLENBQUMsTUFBTSxFQUFFO1lBQzVCLGlCQUFpQixDQUFDLE1BQU07aUJBQ3JCLE9BQU8sQ0FBQyxHQUFHLEVBQUUsRUFBRSxDQUFDO2lCQUNoQixLQUFLLENBQUMsR0FBRyxDQUFDO2lCQUNWLEdBQUcsQ0FBQyxDQUFDLGVBQWUsRUFBRSxFQUFFO2dCQUN2QixnQkFBZ0IsQ0FBQyxJQUFJLENBQUM7b0JBQ3BCLEdBQUcsRUFBRSxlQUFlLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsQ0FBQztvQkFDbEMsS0FBSyxFQUFFLGVBQWUsQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxDQUFDO2lCQUNyQyxDQUFDLENBQUM7WUFDTCxDQUFDLENBQUMsQ0FBQztTQUNOO1FBRUQsS0FBSyxNQUFNLGVBQWUsSUFBSSxnQkFBZ0IsRUFBRTtZQUM5QyxZQUFZLENBQUMsZUFBZSxDQUFDLEdBQUcsQ0FBQyxHQUFHLGVBQWUsQ0FBQyxLQUFLLENBQUM7U0FDM0Q7UUFDRCxJQUFJLFVBQVUsRUFBRSxZQUFZLEVBQUU7WUFDNUIsS0FBSyxNQUFNLEdBQUcsSUFBSSxNQUFNLENBQUMsSUFBSSxDQUFDLFVBQVUsQ0FBQyxZQUFZLENBQUMsRUFBRTtnQkFDdEQsWUFBWSxDQUFDLEdBQUcsQ0FBQyxHQUFHLFVBQVUsQ0FBQyxZQUFZLENBQUMsR0FBRyxDQUFDLENBQUM7YUFDbEQ7U0FDRjtRQUVELElBQUksSUFBSSxHQUFHLGlCQUFpQixDQUFDLFFBQVEsSUFBSSxFQUFFLENBQUM7UUFDNUMsSUFBSSxNQUFNLENBQUMsSUFBSSxDQUFDLFlBQVksQ0FBQyxDQUFDLE1BQU0sR0FBRyxDQUFDLEVBQUU7WUFDeEMsSUFBSSxJQUFJLEdBQUcsQ0FBQztZQUNaLElBQUksS0FBSyxHQUFHLElBQUksQ0FBQztZQUNqQixLQUFLLE1BQU0sR0FBRyxJQUFJLE1BQU0sQ0FBQyxJQUFJLENBQUMsWUFBWSxDQUFDLEVBQUU7Z0JBQzNDLElBQUksS0FBSyxFQUFFO29CQUNULEtBQUssR0FBRyxLQUFLLENBQUM7aUJBQ2Y7cUJBQU07b0JBQ0wsSUFBSSxJQUFJLEdBQUcsQ0FBQztpQkFDYjtnQkFDRCxJQUFJLElBQUksR0FBRyxHQUFHLElBQUksWUFBWSxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUM7YUFDdkM7U0FDRjtRQUVELE1BQU0sU0FBUyxHQUFlO1lBQzVCLEdBQUcsaUJBQWlCO1lBQ3BCLElBQUksRUFBRSxpQkFBaUIsQ0FBQyxJQUFJO1lBQzVCLE1BQU0sRUFBRSxpQkFBaUIsQ0FBQyxNQUFNO1lBQ2hDLFFBQVEsRUFBRSxpQkFBaUIsQ0FBQyxRQUFRO1lBQ3BDLFFBQVEsRUFBRSxpQkFBaUIsQ0FBQyxRQUFRO1lBQ3BDLFFBQVEsRUFBRSxpQkFBaUIsQ0FBQyxRQUFRO1lBQ3BDLElBQUksRUFBRSxpQkFBaUIsQ0FBQyxJQUFJO1lBQzVCLFFBQVEsRUFBRSxpQkFBaUIsQ0FBQyxRQUFRO1lBQ3BDLElBQUksRUFBRSxpQkFBaUIsQ0FBQyxJQUFJO1lBQzVCLElBQUk7WUFDSixRQUFRLEVBQUUsaUJBQWlCLENBQUMsUUFBUTtZQUNwQyxNQUFNLEVBQUUsaUJBQWlCLENBQUMsTUFBTTtZQUNoQyxZQUFZO1lBQ1osSUFBSSxFQUFFLGlCQUFpQixDQUFDLElBQUk7U0FDN0IsQ0FBQztRQUVGLElBQUksQ0FBQyxTQUFTLENBQUMsSUFBSSxJQUFJLFNBQVMsQ0FBQyxRQUFRLEtBQUssUUFBUSxFQUFFO1lBQ3RELGtEQUFrRDtZQUNsRCxTQUFTLENBQUMsSUFBSSxHQUFHLEtBQUssQ0FBQztTQUN4QjtRQUNELElBQUksQ0FBQyxTQUFTLENBQUMsSUFBSSxJQUFJLFNBQVMsQ0FBQyxRQUFRLEtBQUssT0FBTyxFQUFFO1lBQ3JELGdEQUFnRDtZQUNoRCxTQUFTLENBQUMsSUFBSSxHQUFHLElBQUksQ0FBQztTQUN2QjtRQUNELE1BQU0sY0FBYyxHQUFHLElBQUksUUFBUSxFQUFFLENBQUM7UUFDdEMsTUFBTSxDQUFDLE1BQU0sQ0FBQyxjQUFjLEVBQUUsU0FBUyxDQUFDLENBQUM7UUFDekMsT0FBTyxjQUFjLENBQUM7SUFDeEIsQ0FBQztJQUVNLE1BQU0sQ0FBQyxtQkFBbUIsQ0FBQyxZQUF3QjtRQUN4RCxNQUFNLGNBQWMsR0FBRyxJQUFJLFFBQVEsRUFBRSxDQUFDO1FBQ3RDLE1BQU0sQ0FBQyxNQUFNLENBQUMsY0FBYyxFQUFFLFlBQVksQ0FBQyxDQUFDO1FBQzVDLE9BQU8sY0FBYyxDQUFDO0lBQ3hCLENBQUM7SUFpQkQ7UUFDRSxJQUFJLENBQUMsWUFBWSxHQUFHLEVBQUUsQ0FBQztJQUN6QixDQUFDO0lBRUQsS0FBSztRQUNILE1BQU0sY0FBYyxHQUFHLElBQUksUUFBUSxFQUFFLENBQUM7UUFDdEMsTUFBTSxDQUFDLE1BQU0sQ0FBQyxjQUFjLEVBQUUsSUFBSSxDQUFDLENBQUM7UUFDcEMsY0FBYyxDQUFDLFlBQVksR0FBRyxFQUFFLEdBQUcsSUFBSSxDQUFDLFlBQVksRUFBRSxDQUFDO1FBQ3ZELE9BQU8sY0FBYyxDQUFDO0lBQ3hCLENBQUM7SUFFRCxRQUFRO1FBQ04sSUFBSSxRQUFRLEdBQUcsRUFBRSxDQUFDO1FBQ2xCLElBQUksSUFBSSxDQUFDLFFBQVEsSUFBSSxDQUFDLElBQUksQ0FBQyxRQUFRLEVBQUU7WUFDbkMsUUFBUSxHQUFHLEdBQUcsSUFBSSxDQUFDLFFBQVEsR0FBRyxDQUFDO1NBQ2hDO1FBQ0QsSUFBSSxJQUFJLENBQUMsUUFBUSxJQUFJLElBQUksQ0FBQyxRQUFRLEVBQUU7WUFDbEMsUUFBUSxHQUFHLEdBQUcsSUFBSSxDQUFDLFFBQVEsSUFBSSxJQUFJLENBQUMsUUFBUSxHQUFHLENBQUM7U0FDakQ7UUFFRCxPQUFPLEdBQUcsSUFBSSxDQUFDLFFBQVEsS0FBSyxRQUFRLEdBQUcsSUFBSSxDQUFDLFFBQVEsSUFBSSxJQUFJLENBQUMsSUFBSSxHQUFHLElBQUksQ0FBQyxJQUFJLEVBQUUsQ0FBQztJQUNsRixDQUFDO0NBQ0YifQ== | ||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnR1cmwuY2xhc3Nlcy5zbWFydHVybC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0dXJsLmNsYXNzZXMuc21hcnR1cmwudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsMkRBQTJEO0FBQzNELE9BQXlCLHVCQUF1QixDQUFDO0FBd0JqRCw0REFBNEQ7QUFDNUQsTUFBTSxPQUFPLFFBQVE7SUFDbkIsZ0VBQWdFO0lBQ3pELE1BQU0sQ0FBQyxhQUFhLENBQ3pCLE1BQWMsRUFDZCxVQUVDO1FBRUQsb0RBQW9EO1FBQ3BELE1BQU0saUJBQWlCLEdBQUcsSUFBSSxHQUFHLENBQUMsTUFBTSxDQUFDLENBQUM7UUFDMUMsTUFBTSxZQUFZLEdBQWtCLEVBQUUsQ0FBQztRQUV2QyxxREFBcUQ7UUFDckQsTUFBTSxnQkFBZ0IsR0FHaEIsRUFBRSxDQUFDO1FBRVQsb0VBQW9FO1FBQ3BFLElBQUksaUJBQWlCLENBQUMsTUFBTSxFQUFFO1lBQzVCLGlCQUFpQixDQUFDLE1BQU07aUJBQ3JCLE9BQU8sQ0FBQyxHQUFHLEVBQUUsRUFBRSxDQUFDLENBQUMsa0NBQWtDO2lCQUNuRCxLQUFLLENBQUMsR0FBRyxDQUFDLENBQUMsb0RBQW9EO2lCQUMvRCxHQUFHLENBQUMsQ0FBQyxlQUFlLEVBQUUsRUFBRTtnQkFDdkIsK0RBQStEO2dCQUMvRCxnQkFBZ0IsQ0FBQyxJQUFJLENBQUM7b0JBQ3BCLEdBQUcsRUFBRSxlQUFlLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsQ0FBQztvQkFDbEMsS0FBSyxFQUFFLGVBQWUsQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxDQUFDO2lCQUNyQyxDQUFDLENBQUM7WUFDTCxDQUFDLENBQUMsQ0FBQztTQUNOO1FBRUQsc0RBQXNEO1FBQ3RELEtBQUssTUFBTSxlQUFlLElBQUksZ0JBQWdCLEVBQUU7WUFDOUMsWUFBWSxDQUFDLGVBQWUsQ0FBQyxHQUFHLENBQUMsR0FBRyxlQUFlLENBQUMsS0FBSyxDQUFDO1NBQzNEO1FBRUQsZ0VBQWdFO1FBQ2hFLElBQUksVUFBVSxFQUFFLFlBQVksRUFBRTtZQUM1QixLQUFLLE1BQU0sR0FBRyxJQUFJLE1BQU0sQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLFlBQVksQ0FBQyxFQUFFO2dCQUN0RCxZQUFZLENBQUMsR0FBRyxDQUFDLEdBQUcsVUFBVSxDQUFDLFlBQVksQ0FBQyxHQUFHLENBQUMsQ0FBQzthQUNsRDtTQUNGO1FBRUQsc0RBQXNEO1FBQ3RELElBQUksSUFBSSxHQUFHLGlCQUFpQixDQUFDLFFBQVEsSUFBSSxFQUFFLENBQUM7UUFDNUMsSUFBSSxNQUFNLENBQUMsSUFBSSxDQUFDLFlBQVksQ0FBQyxDQUFDLE1BQU0sR0FBRyxDQUFDLEVBQUU7WUFDeEMsSUFBSSxJQUFJLEdBQUcsQ0FBQztZQUNaLElBQUksS0FBSyxHQUFHLElBQUksQ0FBQztZQUNqQixLQUFLLE1BQU0sR0FBRyxJQUFJLE1BQU0sQ0FBQyxJQUFJLENBQUMsWUFBWSxDQUFDLEVBQUU7Z0JBQzNDLElBQUksS0FBSyxFQUFFO29CQUNULEtBQUssR0FBRyxLQUFLLENBQUM7aUJBQ2Y7cUJBQU07b0JBQ0wsSUFBSSxJQUFJLEdBQUcsQ0FBQztpQkFDYjtnQkFDRCxJQUFJLElBQUksR0FBRyxHQUFHLElBQUksWUFBWSxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUM7YUFDdkM7U0FDRjtRQUVELHVEQUF1RDtRQUN2RCxNQUFNLFNBQVMsR0FBZTtZQUM1QixHQUFHLGlCQUFpQjtZQUNwQixJQUFJLEVBQUUsaUJBQWlCLENBQUMsSUFBSTtZQUM1QixNQUFNLEVBQUUsaUJBQWlCLENBQUMsTUFBTTtZQUNoQyxRQUFRLEVBQUUsaUJBQWlCLENBQUMsUUFBUTtZQUNwQyxRQUFRLEVBQUUsaUJBQWlCLENBQUMsUUFBUTtZQUNwQyxRQUFRLEVBQUUsaUJBQWlCLENBQUMsUUFBUTtZQUNwQyxJQUFJLEVBQUUsaUJBQWlCLENBQUMsSUFBSTtZQUM1QixRQUFRLEVBQUUsaUJBQWlCLENBQUMsUUFBUTtZQUNwQyxJQUFJLEVBQUUsaUJBQWlCLENBQUMsSUFBSTtZQUM1QixJQUFJO1lBQ0osUUFBUSxFQUFFLGlCQUFpQixDQUFDLFFBQVE7WUFDcEMsTUFBTSxFQUFFLGlCQUFpQixDQUFDLE1BQU07WUFDaEMsWUFBWTtZQUNaLElBQUksRUFBRSxpQkFBaUIsQ0FBQyxJQUFJO1NBQzdCLENBQUM7UUFFRixrRUFBa0U7UUFDbEUsSUFBSSxDQUFDLFNBQVMsQ0FBQyxJQUFJLElBQUksU0FBUyxDQUFDLFFBQVEsS0FBSyxRQUFRLEVBQUU7WUFDdEQsU0FBUyxDQUFDLElBQUksR0FBRyxLQUFLLENBQUM7U0FDeEI7UUFDRCxJQUFJLENBQUMsU0FBUyxDQUFDLElBQUksSUFBSSxTQUFTLENBQUMsUUFBUSxLQUFLLE9BQU8sRUFBRTtZQUNyRCxTQUFTLENBQUMsSUFBSSxHQUFHLElBQUksQ0FBQztTQUN2QjtRQUVELHNFQUFzRTtRQUN0RSxNQUFNLGNBQWMsR0FBRyxJQUFJLFFBQVEsRUFBRSxDQUFDO1FBQ3RDLE1BQU0sQ0FBQyxNQUFNLENBQUMsY0FBYyxFQUFFLFNBQVMsQ0FBQyxDQUFDLENBQUMsdURBQXVEO1FBQ2pHLE9BQU8sY0FBYyxDQUFDO0lBQ3hCLENBQUM7SUFFRCwwRUFBMEU7SUFDbkUsTUFBTSxDQUFDLG1CQUFtQixDQUFDLFlBQXdCO1FBQ3hELE1BQU0sY0FBYyxHQUFHLElBQUksUUFBUSxFQUFFLENBQUM7UUFDdEMsTUFBTSxDQUFDLE1BQU0sQ0FBQyxjQUFjLEVBQUUsWUFBWSxDQUFDLENBQUMsQ0FBQywwREFBMEQ7UUFDdkcsT0FBTyxjQUFjLENBQUM7SUFDeEIsQ0FBQztJQWlCRCwwREFBMEQ7SUFDMUQ7UUFDRSxJQUFJLENBQUMsWUFBWSxHQUFHLEVBQUUsQ0FBQztJQUN6QixDQUFDO0lBRUQseUVBQXlFO0lBQ3pFLEtBQUs7UUFDSCxNQUFNLGNBQWMsR0FBRyxJQUFJLFFBQVEsRUFBRSxDQUFDO1FBQ3RDLE1BQU0sQ0FBQyxNQUFNLENBQUMsY0FBYyxFQUFFLElBQUksQ0FBQyxDQUFDLENBQUMsMENBQTBDO1FBQy9FLGNBQWMsQ0FBQyxZQUFZLEdBQUcsRUFBRSxHQUFHLElBQUksQ0FBQyxZQUFZLEVBQUUsQ0FBQyxDQUFDLDREQUE0RDtRQUNwSCxPQUFPLGNBQWMsQ0FBQztJQUN4QixDQUFDO0lBRUQ7Ozs7O09BS0c7SUFDSCxHQUFHLENBQXVCLElBQU8sRUFBRSxLQUFjO1FBQy9DLElBQUksQ0FBQyxJQUFJLENBQUMsR0FBRyxLQUFLLENBQUMsQ0FBQyxvQ0FBb0M7UUFDeEQsT0FBTyxJQUFJLENBQUMsQ0FBQyxtQ0FBbUM7SUFDbEQsQ0FBQztJQUVELGlFQUFpRTtJQUNqRSxRQUFRO1FBQ04sSUFBSSxRQUFRLEdBQUcsRUFBRSxDQUFDLENBQUMsOERBQThEO1FBRWpGLHlFQUF5RTtRQUN6RSxJQUFJLElBQUksQ0FBQyxRQUFRLElBQUksQ0FBQyxJQUFJLENBQUMsUUFBUSxFQUFFO1lBQ25DLFFBQVEsR0FBRyxHQUFHLElBQUksQ0FBQyxRQUFRLEdBQUcsQ0FBQztTQUNoQztRQUNELElBQUksSUFBSSxDQUFDLFFBQVEsSUFBSSxJQUFJLENBQUMsUUFBUSxFQUFFO1lBQ2xDLFFBQVEsR0FBRyxHQUFHLElBQUksQ0FBQyxRQUFRLElBQUksSUFBSSxDQUFDLFFBQVEsR0FBRyxDQUFDO1NBQ2pEO1FBRUQsMkNBQTJDO1FBQzNDLE9BQU8sR0FBRyxJQUFJLENBQUMsUUFBUSxLQUFLLFFBQVEsR0FBRyxJQUFJLENBQUMsUUFBUSxJQUFJLElBQUksQ0FBQyxJQUFJLEdBQUcsSUFBSSxDQUFDLElBQUksRUFBRSxDQUFDO0lBQ2xGLENBQUM7Q0FDRiJ9 |
{ | ||
"name": "@push.rocks/smarturl", | ||
"version": "3.0.8", | ||
"version": "3.1.0", | ||
"private": false, | ||
@@ -5,0 +5,0 @@ "description": "A library for parsing URLs in a detailed and flexible way.", |
@@ -6,4 +6,4 @@ /** | ||
name: '@push.rocks/smarturl', | ||
version: '3.0.8', | ||
version: '3.1.0', | ||
description: 'A library for parsing URLs in a detailed and flexible way.' | ||
} |
@@ -0,3 +1,5 @@ | ||
// Import necessary plugins (if any are used in the module) | ||
import * as plugins from './smarturl.plugins.js'; | ||
// Interface representing the structure of a URL object | ||
export interface IUrlObject { | ||
@@ -19,2 +21,3 @@ href: string; | ||
// Interface representing the search parameters as a key-value pair object | ||
export interface ISearchParams { | ||
@@ -24,3 +27,5 @@ [key: string]: string; | ||
// Main Smarturl class implementing the IUrlObject interface | ||
export class Smarturl implements IUrlObject { | ||
// Static method to create a Smarturl instance from a URL string | ||
public static createFromUrl( | ||
@@ -32,6 +37,7 @@ urlArg: string, | ||
): Smarturl { | ||
// Parse the URL string using the built-in URL class | ||
const parsedUrlInstance = new URL(urlArg); | ||
const searchParams: ISearchParams = {}; | ||
// enrichment | ||
// Array to hold key-value pairs of search parameters | ||
const searchParamPairs: { | ||
@@ -42,7 +48,9 @@ key: string; | ||
// If the URL has search parameters, parse them into key-value pairs | ||
if (parsedUrlInstance.search) { | ||
parsedUrlInstance.search | ||
.replace('?', '') | ||
.split('&') | ||
.replace('?', '') // Remove the '?' at the beginning | ||
.split('&') // Split the query string into individual parameters | ||
.map((searchParamPair) => { | ||
// Split each parameter into key and value and add to the array | ||
searchParamPairs.push({ | ||
@@ -55,5 +63,8 @@ key: searchParamPair.split('=')[0], | ||
// Convert the array of key-value pairs into an object | ||
for (const searchParamPair of searchParamPairs) { | ||
searchParams[searchParamPair.key] = searchParamPair.value; | ||
} | ||
// Merge any additional search parameters provided in optionsArg | ||
if (optionsArg?.searchParams) { | ||
@@ -65,2 +76,3 @@ for (const key of Object.keys(optionsArg.searchParams)) { | ||
// Reconstruct the path with updated search parameters | ||
let path = parsedUrlInstance.pathname || ''; | ||
@@ -80,4 +92,5 @@ if (Object.keys(searchParams).length > 0) { | ||
// Create an IUrlObject containing all parts of the URL | ||
const parsedUrl: IUrlObject = { | ||
...parsedUrlInstance, | ||
...parsedUrlInstance, // Spread operator to include all properties from parsedUrlInstance | ||
href: parsedUrlInstance.href, | ||
@@ -91,29 +104,31 @@ origin: parsedUrlInstance.origin, | ||
port: parsedUrlInstance.port, | ||
path, | ||
path, // Updated path with new search parameters | ||
pathname: parsedUrlInstance.pathname, | ||
search: parsedUrlInstance.search, | ||
searchParams, | ||
searchParams, // The searchParams object we constructed | ||
hash: parsedUrlInstance.hash, | ||
}; | ||
// Infer default ports if none are specified based on the protocol | ||
if (!parsedUrl.port && parsedUrl.protocol === 'https:') { | ||
// console.log(`inferring port 443 for "https:"`); | ||
parsedUrl.port = '443'; | ||
} | ||
if (!parsedUrl.port && parsedUrl.protocol === 'http:') { | ||
// console.log(`inferring port 80 for "http:"`); | ||
parsedUrl.port = '80'; | ||
} | ||
// Create a new Smarturl instance and assign the parsed URL properties | ||
const returnSmarturl = new Smarturl(); | ||
Object.assign(returnSmarturl, parsedUrl); | ||
Object.assign(returnSmarturl, parsedUrl); // Copy all properties from parsedUrl to returnSmarturl | ||
return returnSmarturl; | ||
} | ||
public static createFromParsedUrl(parsedUrlArg: IUrlObject) { | ||
// Static method to create a Smarturl instance from an existing IUrlObject | ||
public static createFromParsedUrl(parsedUrlArg: IUrlObject): Smarturl { | ||
const returnSmarturl = new Smarturl(); | ||
Object.assign(returnSmarturl, parsedUrlArg); | ||
Object.assign(returnSmarturl, parsedUrlArg); // Copy all properties from parsedUrlArg to returnSmarturl | ||
return returnSmarturl; | ||
} | ||
// INSTANCE | ||
// INSTANCE PROPERTIES (matching IUrlObject interface) | ||
href: string; | ||
@@ -133,2 +148,3 @@ origin: string; | ||
// Constructor initializes searchParams as an empty object | ||
constructor() { | ||
@@ -138,11 +154,26 @@ this.searchParams = {}; | ||
// Method to create an independent clone of the current Smarturl instance | ||
clone(): Smarturl { | ||
const clonedInstance = new Smarturl(); | ||
Object.assign(clonedInstance, this); | ||
clonedInstance.searchParams = { ...this.searchParams }; | ||
Object.assign(clonedInstance, this); // Copy all properties to the new instance | ||
clonedInstance.searchParams = { ...this.searchParams }; // Shallow copy of searchParams to prevent shared references | ||
return clonedInstance; | ||
} | ||
toString() { | ||
let userpart = ``; | ||
/** | ||
* Typed method to set a property and return the instance for chaining. | ||
* @param prop - The property name to set (must be a key of Smarturl) | ||
* @param value - The value to assign to the property | ||
* @returns The Smarturl instance for method chaining | ||
*/ | ||
set<K extends keyof this>(prop: K, value: this[K]): this { | ||
this[prop] = value; // Set the property to the new value | ||
return this; // Return the instance for chaining | ||
} | ||
// Method to convert the Smarturl instance back into a URL string | ||
toString(): string { | ||
let userpart = ``; // Initialize the user part of the URL (username and password) | ||
// Construct the user part based on the presence of username and password | ||
if (this.username && !this.password) { | ||
@@ -155,4 +186,5 @@ userpart = `${this.username}@`; | ||
// Construct and return the full URL string | ||
return `${this.protocol}//${userpart}${this.hostname}:${this.port}${this.path}`; | ||
} | ||
} |
28185
388