@potonz/shortlinks-manager 0.1.0 → 0.2.0

package/dist/index.d.ts

@@ -1,5 +1,20 @@
 // Generated by dts-bundle-generator v9.5.1
 
+export interface ICache {
+	init?: () => unknown | Promise<unknown>;
+	/**
+	 * Get the target URL using the provided shortId
+	 * @param shortId
+	 * @returns string if a target URL is found, null otherwise
+	 */
+	get: (shortId: string) => string | null | Promise<string | null>;
+	/**
+	 * Cache the target URL
+	 * @param shortId
+	 * @param targetUrl
+	 */
+	set: (shortId: string, targetUrl: string) => void | Promise<void>;
+}
 export interface IShortLinksManagerBackend {
 	/**
 	 * Initialise any logic before the manager can do its thing. E.g. setting up tables.
@@ -36,6 +51,12 @@ export interface IShortLinksManagerBackend {
 }
 export interface IManagerProps {
 	backend: IShortLinksManagerBackend;
+	/**
+	 * A list of cache to use before invoking the backend.
+	 * If multiple cache are provided, the manager will try from first to last.
+	 * Default to no cache
+	 */
+	caches?: ICache[];
 	shortIdLength: number;
 	onShortIdLengthUpdated: (newLength: number) => unknown;
 }
@@ -51,15 +72,23 @@ export interface IShortLinksManager {
 	 * 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
+	 * @throws Error if backend failed
 	 */
 	getTargetUrl(shortId: string): Promise<string | null>;
+	/**
+	 * Update last accessed time to avoid link being cleaned
+	 * @param shortId
+	 * @param time last accessed time. Defaults to current time
+	 * @throws Error if backend failed
+	 */
+	updateShortLinkLastAccessTime(shortId: string, time: Date): Promise<void>;
 	/**
 	 * Clean up unused links that are older than the given maxAge
 	 * @param maxAge number of days the record should be kept
+	 * @throws Error if backend failed
 	 */
 	cleanUnusedLinks(maxAge: number): Promise<void>;
 }
-export declare function createManager({ backend, shortIdLength, onShortIdLengthUpdated }: IManagerProps): Promise<IShortLinksManager>;
+export declare function createManager({ backend, caches, shortIdLength, onShortIdLengthUpdated }: IManagerProps): Promise<IShortLinksManager>;
 
 export {};

package/dist/index.js

@@ -20,4 +20,4 @@ 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};
+function C(f=4){let E="";for(let m=0;m<f;m++)E+="0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ".charAt(Math.floor(Math.random()*62));return E}function p(f,E){let m=new Set,O=0;while(m.size<f&&O<f*100)m.add(C(E)),O++;return Array.from(m)}async function y({backend:f,caches:E=[],shortIdLength:m,onShortIdLengthUpdated:O}){return await f.init?.(),{async createShortLink(D){let A="";for(let H=0;H<3;H++){let R=p(50,m),w=await f.checkShortIdsExist(R),W=R.find((x)=>!w.includes(x));if(!W)++m,await O(m);else{A=W;break}}if(!A)throw Error("Unable to create a shortlink, potentially ran out");return await f.createShortLink(A,D),A},async getTargetUrl(D){let A=null;for(let H of E)if(await H.init?.(),!A)A=await H.get(D);if(!A)A=await f.getTargetUrl(D);if(A){await f.updateShortLinkLastAccessTime(D);for(let H of E)await H.set(D,A)}return A},async updateShortLinkLastAccessTime(D){return await f.updateShortLinkLastAccessTime(D)},async cleanUnusedLinks(D){await f.cleanUnusedLinks(D)}}}export{y as createManager};

package/package.json

@@ -8,9 +8,10 @@
   "homepage": "https://github.com/potonz/shortlinks-manager",
   "repository": {
     "url": "git+https://github.com/potonz/shortlinks-manager.git",
-    "type": "git"
+    "type": "git",
+    "directory": "packages/shortlinks-manager"
   },
-  "version": "0.1.0",
+  "version": "0.2.0",
   "type": "module",
   "license": "MIT",
   "main": "./dist/index.js",