chore(many): initial commit

Author: bnachtweh

.czrc

@@ -0,0 +1,4 @@
+{
+  "path": "cz-conventional-changelog",
+  "skipScope": false
+}

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+

.gitignore

@@ -0,0 +1,20 @@
+# Node.js generated files
+node_modules/
+
+# Build output
+coverage/
+dist/
+
+# macOS 🍏 generated files
+.DS_Store
+
+# Local env files
+.env
+.env.*
+!.env.example
+
+# ide specific files
+.idea
+
+# Kilocode specific files
+.kilocode

.husky/pre-commit

@@ -0,0 +1,2 @@
+pnpm lint
+pnpm test:coverage

.scripts/generate-docs.sh

@@ -0,0 +1,28 @@
+#!/bin/bash
+# Generate TypeDoc documentation and organize output
+
+pnpm typedoc
+
+if [ -d "docs" ]; then
+  # Rename the main class documentation file
+  if [ -f "docs/Class.DynamicURL.md" ]; then
+    mv docs/Class.DynamicURL.md docs/api.md
+  fi
+  
+  # Remove duplicate README
+  if [ -f "docs/README.md" ]; then
+    rm docs/README.md
+  fi
+  
+  # Remove "Defined in:" lines from api.md (must come after rename)
+  if [ -f "docs/api.md" ]; then
+    sed -i '' '/^Defined in:/d' docs/api.md
+    echo "✅ API documentation generated at docs/api.md"
+  else
+    echo "❌ api.md not found"
+    exit 1
+  fi
+else
+  echo "❌ Failed to generate documentation"
+  exit 1
+fi

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)

commitlint.config.cjs

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["@commitlint/config-conventional"],
+};

docs/api.md

@@ -0,0 +1,103 @@
+# Class: DynamicURL
+
+## Constructors
+
+### Constructor
+
+> **new DynamicURL**(`url`): `DynamicURL`
+
+
+#### Parameters
+
+##### url
+
+`string`
+
+#### Returns
+
+`DynamicURL`
+
+## Methods
+
+### resolve()
+
+> **resolve**(): `string`
+
+
+Resolves and returns the final URL as a string.
+
+#### Returns
+
+`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"
+```
+
+---
+
+### setQueryParams()
+
+> **setQueryParams**(`query`): `DynamicURL`
+
+
+Takes a query object and appends it to the URL as a query string.
+
+#### Parameters
+
+##### query
+
+`Record`\<`string`, `any`\>
+
+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"
+```
+
+---
+
+### setRouteParams()
+
+> **setRouteParams**(`replaceValue`): `DynamicURL`
+
+
+Replaces route parameters in the URL with the provided values.
+
+#### Parameters
+
+##### replaceValue
+
+An object or string to replace the route parameters.
+
+`string` | `TParamsObject`
+
+#### Returns
+
+`DynamicURL`
+
+#### See
+
+TParamsObject
+
+#### 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"
+```

eslint.config.mjs

@@ -0,0 +1,9 @@
+// @ts-check
+
+import { defineConfig } from "eslint/config";
+import tseslint from "typescript-eslint";
+
+export default defineConfig(
+  tseslint.configs.strict,
+  tseslint.configs.stylistic
+);

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"
+}