@ambitiondev/dynamic-url 0.0.0

package/README.md

@@ -0,0 +1,33 @@
+# @ambitiondev/dynamic-url
+
+A lightweight JavaScript library for generating dynamic URLs based on templates and parameters.
+
+## Installation
+
+You can install the library using npm:
+
+```bash
+npm install @ambitiondev/dynamic-url
+```
+
+## Usage
+
+Here's a simple example of how to use the library:
+
+```typescript
+import { DynamicURL } from "@ambitiondev/dynamic-url";
+
+// Init the url with your template
+const url = new DynamicURL("https://example.com/{user}/{id}");
+// Set route and query parameters
+url.setRouteParams({ user: "john_doe", id: 123 });
+url.setQueryParams({ ref: "newsletter", campaign: "spring_sale" });
+
+// Resolve the final URL
+console.log(url.resolve());
+// Output: https://example.com/john_doe/123?ref=newsletter&campaign=spring_sale
+```
+
+## More docs
+
+- [API](./docs/api.md)

package/dist/src/url.d.ts

@@ -0,0 +1,51 @@
+import type { TParamsObject } from "../types";
+export declare class DynamicURL {
+    private url;
+    constructor(url: string);
+    /**
+     * Takes a query object and appends it to the URL as a query string.
+     *
+     * @param query - An object representing the query parameters.
+     * @returns {DynamicURL}
+     *
+     * @example
+     * ```ts
+     * const url = new DynamicURL("https://example.com");
+     * url.setQueryParams({ citizen: "robespierre", hero: "ironman" });
+     * console.log(url.resolve()); // "https://example.com?citizen=robespierre&hero=ironman"
+     * ```
+     */
+    setQueryParams(query: Record<string, any>): this;
+    /**
+     * Replaces route parameters in the URL with the provided values.
+     *
+     * @param {TParamsObject | string} replaceValue - An object or string to replace the route parameters.
+     *
+     * @see {@link TParamsObject}
+     * @returns {DynamicURL}
+     *
+     * @example
+     * ```ts
+     * const url = new DynamicURL("https://example.com/{citizen}/{hero}");
+     * url.setRouteParams({ citizen: "robespierre", hero: "ironman" });
+     * console.log(url.resolve()); // "https://example.com/robespierre/ironman"
+     * ```
+     */
+    setRouteParams(replaceValue: TParamsObject | string): this;
+    /**
+     * Resolves and returns the final URL as a string.
+     *
+     * @example
+     * ```ts
+     * const url = new DynamicURL("https://example.com/{citizen}/{hero}");
+     * url.setRouteParams({ citizen: "robespierre", hero: "ironman" });
+     *
+     * // Resolve the final URL
+     * console.log(url.resolve()); // "https://example.com/robespierre/ironman"
+     * ```
+     *
+     * @returns {string}
+     */
+    resolve(): string;
+}
+//# sourceMappingURL=url.d.ts.map

package/dist/src/url.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"url.d.ts","sourceRoot":"","sources":["../../src/url.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAE9C,qBAAa,UAAU;IACrB,OAAO,CAAC,GAAG,CAAS;gBAER,GAAG,EAAE,MAAM;IAIvB;;;;;;;;;;;;OAYG;IAEH,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAazC;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAC,YAAY,EAAE,aAAa,GAAG,MAAM;IAiBnD;;;;;;;;;;;;;OAaG;IACH,OAAO;CAGR"}

package/dist/src/url.js

@@ -0,0 +1,77 @@
+// Vendor
+import qs from "qs";
+export class DynamicURL {
+    constructor(url) {
+        this.url = url;
+    }
+    /**
+     * Takes a query object and appends it to the URL as a query string.
+     *
+     * @param query - An object representing the query parameters.
+     * @returns {DynamicURL}
+     *
+     * @example
+     * ```ts
+     * const url = new DynamicURL("https://example.com");
+     * url.setQueryParams({ citizen: "robespierre", hero: "ironman" });
+     * console.log(url.resolve()); // "https://example.com?citizen=robespierre&hero=ironman"
+     * ```
+     */
+    /* eslint-disable-next-line @typescript-eslint/no-explicit-any */
+    setQueryParams(query) {
+        const queryString = qs.stringify(query, {
+            skipNulls: true,
+            encode: true,
+        });
+        if (queryString) {
+            this.url = `${this.url}?${queryString}`;
+        }
+        return this;
+    }
+    /**
+     * Replaces route parameters in the URL with the provided values.
+     *
+     * @param {TParamsObject | string} replaceValue - An object or string to replace the route parameters.
+     *
+     * @see {@link TParamsObject}
+     * @returns {DynamicURL}
+     *
+     * @example
+     * ```ts
+     * const url = new DynamicURL("https://example.com/{citizen}/{hero}");
+     * url.setRouteParams({ citizen: "robespierre", hero: "ironman" });
+     * console.log(url.resolve()); // "https://example.com/robespierre/ironman"
+     * ```
+     */
+    setRouteParams(replaceValue) {
+        if (typeof replaceValue === "string") {
+            this.url = this.url.replace(/ *\{[^)]*\} */g, replaceValue);
+            return this;
+        }
+        this.url = this.url.replace(/\{([^}]+)\}/g, (match, key) => {
+            if (Object.prototype.hasOwnProperty.call(replaceValue, key)) {
+                const value = replaceValue[key];
+                return String(value);
+            }
+            return match;
+        });
+        return this;
+    }
+    /**
+     * Resolves and returns the final URL as a string.
+     *
+     * @example
+     * ```ts
+     * const url = new DynamicURL("https://example.com/{citizen}/{hero}");
+     * url.setRouteParams({ citizen: "robespierre", hero: "ironman" });
+     *
+     * // Resolve the final URL
+     * console.log(url.resolve()); // "https://example.com/robespierre/ironman"
+     * ```
+     *
+     * @returns {string}
+     */
+    resolve() {
+        return this.url;
+    }
+}

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export type TParamsObject = Record<string, string | number | boolean>;
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../types/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC"}

package/dist/types/index.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@ambitiondev/dynamic-url",
+  "description": "lightweight util for creating dynamic endpoint strings",
+  "version": "0.0.0",
+  "main": "./dist/src/url.js",
+  "types": "./dist/src/url.d.ts",
+  "files": [
+    "dist"
+  ],
+  "authors": [
+    {
+      "name": "Berrie Nachtweh - Ambition Concepts",
+      "email": "info@ambitiondev.io",
+      "url": "https://ambitiondev.io"
+    }
+  ],
+  "devDependencies": {
+    "@commitlint/config-conventional": "^20.3.1",
+    "@eslint/js": "^9.39.2",
+    "@types/qs": "^6.14.0",
+    "@vitest/coverage-v8": "^4.0.17",
+    "commitizen": "^4.3.1",
+    "eslint": "^9.39.2",
+    "husky": "^9.1.7",
+    "typedoc": "^0.28.16",
+    "typedoc-plugin-markdown": "^4.9.0",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.53.0",
+    "vitest": "^4.0.17"
+  },
+  "dependencies": {
+    "qs": "^6.14.1"
+  },
+  "scripts": {
+    "--- 🎣 Hooks ---": "",
+    "prepare": "husky",
+    "--- 🧪 Testing ---": "",
+    "test": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "--- 🎗️ Lint ---": "",
+    "lint": "eslint src/*.ts",
+    "--- 📚 Documentation ---": "",
+    "docs:generate": "./.scripts/generate-docs.sh",
+    "--- 🤓 Developer Tools ---": "",
+    "commit": "git-cz",
+    "build": "tsc"
+  },
+  "packageManager": "pnpm@10.7.0+sha512.6b865ad4b62a1d9842b61d674a393903b871d9244954f652b8842c2b553c72176b278f64c463e52d40fff8aba385c235c8c9ecf5cc7de4fd78b8bb6d49633ab6"
+}