@unparallel/url-manager 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 UNPARALLEL Innovation, Lda
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,26 @@
+# URL Manager
+
+Element used to store an retrieved query parameters from the URL encoded in JSON
+
+## Constructor
+
+```typescript
+const urlManager = new URLManager({ id: "page" })
+```
+
+**id:** each instance have an id, this allows to have in the same URL several jsons, this could be useful to store the data of different elements in the ame url
+
+## Methods
+
+```typescript
+urlManager.updateKey<T=any>(key: string, value: T, addToHistoric?: boolean)
+```
+Updates a JSON entry, by providing a key/value pair
+
+ ```typescript
+urlManager.getKeyFromComponent<T = any>(key: string): T | undefined
+```
+Obtains the JSON associated with a key
+
+## Example
+A React Component with an example is available in "/src/App.tsx" on this repository

package/dist/URLManager/index.d.ts

@@ -0,0 +1,20 @@
+import { EventEmitter } from 'events';
+import { URLManagerTools, StringHM } from '../URLManagerTools';
+export interface URLManagerProps {
+    id: string;
+    hashChain?: StringHM;
+    urlManagerComponentId?: string;
+}
+export declare class URLManager extends URLManagerTools {
+    id: string;
+    disableUrlManager: boolean;
+    hashLength: number;
+    hash: string;
+    events: EventEmitter;
+    urlManagerComponentId: string | undefined;
+    constructor(props: URLManagerProps, disableUrlManager?: boolean);
+    setNewHashChain(hashChain: StringHM): void;
+    updateKey<T = any>(key: string, value: T, addToHistoric?: boolean): void;
+    getKeyFromComponent<T = any>(key: string): T | undefined;
+    getJSONFromComponent(hash: string): any;
+}

package/dist/URLManager/index.js

@@ -0,0 +1,45 @@
+var l = Object.defineProperty;
+var c = (h, e, t) => e in h ? l(h, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : h[e] = t;
+var o = (h, e, t) => c(h, typeof e != "symbol" ? e + "" : e, t);
+import m from "query-string";
+import { EventEmitter as u } from "events";
+import { URLManagerTools as w } from "../URLManagerTools/index.js";
+class n extends w {
+  constructor(t, s) {
+    super();
+    o(this, "id");
+    o(this, "disableUrlManager");
+    o(this, "hashLength");
+    o(this, "hash");
+    o(this, "events");
+    o(this, "urlManagerComponentId");
+    this.id = t.id, this.disableUrlManager = !!s, this.hashLength = 6, this.hash = n.generateHash(this.id, t.hashChain), this.events = new u(), this.urlManagerComponentId = t.urlManagerComponentId;
+  }
+  setNewHashChain(t) {
+    const s = this.hash;
+    this.hash = n.generateHash(this.id, t), s != this.hash && this.events.emit("hashChange", this.hash);
+  }
+  updateKey(t, s, i) {
+    if (this.disableUrlManager)
+      return;
+    const d = { [t]: s };
+    let r = this.getJSONFromComponent(this.hash);
+    r = { ...r, ...d }, console.log(r);
+    const a = new URL(window.location.href);
+    a.searchParams.set(this.hash, n.getEncodedStrFromJSON(r)), i ? window.history.pushState({}, "", a) : window.history.pushState({}, "", a);
+  }
+  getKeyFromComponent(t) {
+    if (window.location) {
+      const i = m.parse(window.location.search)[this.hash];
+      if (typeof i == "string")
+        return n.getJSONFromEncodedStr(i)[t];
+    }
+  }
+  getJSONFromComponent(t) {
+    if (window.location)
+      return n.getJSONFromHash(t, window.location.search);
+  }
+}
+export {
+  n as URLManager
+};

package/dist/URLManagerTools/index.d.ts

@@ -0,0 +1,18 @@
+export interface StringHM {
+    [k: string]: any;
+}
+export interface URLManagerRequest<T = StringHM> {
+    id: string;
+    json: T;
+    hashChain?: StringHM;
+}
+export declare class URLManagerTools {
+    static getJSONFromHash(hash: string, parameters: string): any;
+    static getJSONFromId(id: string, parameters: string, hashChain?: StringHM): any;
+    static getJSONFromEncodedStr(encodedStr: string): any;
+    static getUrlParameterForId(id: string, json: StringHM, hashChain?: StringHM): string;
+    static getUrlParameterForHash(hash: string, json: StringHM): string;
+    static generateURLParameters(requests: URLManagerRequest[]): string | undefined;
+    static getEncodedStrFromJSON(json: StringHM): string;
+    static generateHash(id: string, hashChain?: StringHM): string;
+}

package/dist/URLManagerTools/index.js

@@ -0,0 +1,47 @@
+import c from "query-string";
+import h from "object-hash";
+class d {
+  static getJSONFromHash(t, r) {
+    const e = c.parse(r)[t];
+    if (typeof e == "string")
+      return this.getJSONFromEncodedStr(e);
+  }
+  static getJSONFromId(t, r, s) {
+    const e = this.generateHash(t, s);
+    return this.getJSONFromHash(e, r);
+  }
+  static getJSONFromEncodedStr(t) {
+    const r = decodeURIComponent(t);
+    return JSON.parse(r);
+  }
+  static getUrlParameterForId(t, r, s) {
+    const e = this.generateHash(t, s);
+    return this.getUrlParameterForHash(e, r);
+  }
+  static getUrlParameterForHash(t, r) {
+    const s = this.getEncodedStrFromJSON(r);
+    return t + "=" + s;
+  }
+  static generateURLParameters(t) {
+    if (Array.isArray(t)) {
+      const r = [];
+      return t.forEach((s) => {
+        const { id: e, json: a, hashChain: o } = s, n = this.getUrlParameterForId(e, a, o);
+        r.push(n);
+      }), r.join("&");
+    }
+  }
+  //static generateJSONFromUrlParamet
+  static getEncodedStrFromJSON(t) {
+    const r = JSON.stringify(t);
+    return encodeURIComponent(r);
+  }
+  static generateHash(t, r) {
+    const e = { id: t, ...r };
+    let a = h(e);
+    return a = a.substring(0, 6), a;
+  }
+}
+export {
+  d as URLManagerTools
+};

package/dist/main.d.ts

@@ -0,0 +1,4 @@
+export { URLManager } from './URLManager';
+export type { URLManagerProps } from './URLManager';
+export { URLManagerTools } from './URLManagerTools';
+export type { URLManagerRequest, StringHM } from './URLManagerTools';

package/dist/main.js

@@ -0,0 +1,6 @@
+import { URLManager as a } from "./URLManager/index.js";
+import { URLManagerTools as f } from "./URLManagerTools/index.js";
+export {
+  a as URLManager,
+  f as URLManagerTools
+};

package/dist/method.d.ts

@@ -0,0 +1,2 @@
+import { CSSProperties } from 'react';
+export declare function getBorderStyle(): CSSProperties;

package/dist/method.js

@@ -0,0 +1,6 @@
+function r() {
+  return { border: "1px solid red" };
+}
+export {
+  r as getBorderStyle
+};

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@unparallel/url-manager",
+  "private": false,
+  "version": "0.0.1",
+  "type": "module",
+  "main": "dist/main.js",
+  "types": "dist/main.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc --p ./tsconfig.build.json  && vite build",
+    "prepublishOnly": "npm run build",
+    "lint": "eslint .",
+    "preview": "vite preview"
+  },
+  "sideEffects": [
+    "**/*.css"
+  ],
+  "dependencies": {
+    "events": "^3.3.0",
+    "object-hash": "^3.0.0",
+    "query-string": "^9.3.1"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.17.0",
+    "@release-it/keep-a-changelog": "^7.0.1",
+    "@types/events": "^3.0.3",
+    "@types/object-hash": "^3.0.6",
+    "@types/react": "^18.3.18",
+    "@types/react-dom": "^18.3.5",
+    "@vitejs/plugin-react": "^4.3.4",
+    "eslint": "^9.17.0",
+    "eslint-plugin-react-hooks": "^5.0.0",
+    "eslint-plugin-react-refresh": "^0.4.16",
+    "glob": "^11.0.1",
+    "globals": "^15.14.0",
+    "react": "^19.2.4",
+    "react-dom": "^19.2.4",
+    "release-it": "^19.2.4",
+    "typescript": "~5.6.2",
+    "typescript-eslint": "^8.18.2",
+    "vite": "^6.0.5",
+    "vite-plugin-dts": "^4.5.0",
+    "vite-plugin-lib-inject-css": "^2.2.1"
+  }
+}