@potonz/shortlinks-manager 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Thomas Nguyen
+
+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,7 @@
+# @potonz/shortlinks-manager
+
+A manager to manage short links. Requires a backend to work.
+
+Package | Backend
+------- | -------
+[@potonz/shortlinks-manager-cloudflare-d1](../shortlinks-manager-cloudflare-d1/) | Cloudflare D1

package/dist/index.d.ts

@@ -0,0 +1,65 @@
+// Generated by dts-bundle-generator v9.5.1
+
+export interface IShortLinksManagerBackend {
+	/**
+	 * Initialise any logic before the manager can do its thing. E.g. setting up tables.
+	 * Run once when {@link createManager} is called
+	 */
+	init?: () => unknown;
+	/**
+	 * Get target URL for the given short ID
+	 * @param {string} shortId
+	 * @returns the short ID or null if not found
+	 */
+	getTargetUrl: (shortId: string) => string | null | Promise<string | null>;
+	/**
+	 * Create a short link map with the given short ID and target URL
+	 * @param {string} shortId
+	 * @param {string} targetUrl
+	 */
+	createShortLink: (shortId: string, targetUrl: string) => void | Promise<void>;
+	/**
+	 * Check the provided list of short IDs and return the ones that already exist.
+	 * @param {string[]} shortIds
+	 */
+	checkShortIdsExist: (shortIds: string[]) => string[] | Promise<string[]>;
+	/**
+	 * Update last accessed time to current timestamp
+	 * @param shortId
+	 */
+	updateShortLinkLastAccessTime(shortId: string): void | Promise<void>;
+	/**
+	 * Remove unused links that are older than the given maxAge
+	 * @param maxAge number of days the record should be kept
+	 */
+	cleanUnusedLinks(maxAge: number): void | Promise<void>;
+}
+export interface IManagerProps {
+	backend: IShortLinksManagerBackend;
+	shortIdLength: number;
+	onShortIdLengthUpdated: (newLength: number) => unknown;
+}
+export interface IShortLinksManager {
+	/**
+	 * Generate a short ID linking to the target URL
+	 * @param {string} targetUrl targetUrl
+	 * @returns {Promise<string>} short ID
+	 * @throws Error if failed
+	 */
+	createShortLink(targetUrl: string): Promise<string>;
+	/**
+	 * Get a target URL from the given short ID
+	 * @param shortId
+	 * @returns the target URL as string or null if not found
+	 * @throws Error if failed
+	 */
+	getTargetUrl(shortId: string): Promise<string | null>;
+	/**
+	 * Clean up unused links that are older than the given maxAge
+	 * @param maxAge number of days the record should be kept
+	 */
+	cleanUnusedLinks(maxAge: number): Promise<void>;
+}
+export declare function createManager({ backend, shortIdLength, onShortIdLengthUpdated }: IManagerProps): Promise<IShortLinksManager>;
+
+export {};

package/dist/index.js

@@ -0,0 +1,23 @@
+/* MIT License
+
+Copyright (c) 2025 Thomas Nguyen
+
+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.
+ */
+function W(A=4){let m="";for(let R=0;R<A;R++)m+="0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ".charAt(Math.floor(Math.random()*62));return m}function E(A,m){let R=new Set,f=0;while(R.size<A&&f<A*100)R.add(W(m)),f++;return Array.from(R)}async function _({backend:A,shortIdLength:m,onShortIdLengthUpdated:R}){return await A.init?.(),{async createShortLink(f){let l="";for(let p=0;p<3;p++){let C=E(50,m),H=await A.checkShortIdsExist(C),D=C.find((O)=>!H.includes(O));if(!D)++m,await R(m);else{l=D;break}}if(!l)throw Error("Unable to create a shortlink, potentially ran out");return await A.createShortLink(l,f),l},async getTargetUrl(f){return await A.updateShortLinkLastAccessTime(f),await A.getTargetUrl(f)},async cleanUnusedLinks(f){await A.cleanUnusedLinks(f)}}}export{_ as createManager};

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@potonz/shortlinks-manager",
+  "description": "Short links manager",
+  "author": {
+    "name": "Thomas Nguyen",
+    "email": "tom@tomng.dev"
+  },
+  "homepage": "https://github.com/potonz/shortlinks-manager",
+  "repository": {
+    "url": "git+https://github.com/potonz/shortlinks-manager.git",
+    "type": "git"
+  },
+  "version": "0.1.0",
+  "type": "module",
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}