@potonz/shortlinks-manager 0.2.2 → 0.2.3

package/dist/index.d.ts

@@ -2,19 +2,24 @@
 
 export interface ICache {
 	initialised?: boolean;
-	init?: () => unknown | Promise<unknown>;
+	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>;
+	get: (shortId: string) => (string | null | Promise<string | null>);
 	/**
 	 * Cache the target URL
 	 * @param shortId
 	 * @param targetUrl
 	 */
-	set: (shortId: string, targetUrl: string) => void | Promise<void>;
+	set: (shortId: string, targetUrl: string) => (void | Promise<void>);
+	/**
+	 * Delete the short ID in the cache
+	 * @param shortId
+	 */
+	delete?: (shortId: string) => (void | Promise<void>);
 }
 export interface IShortLinksManagerBackend {
 	/**
@@ -27,28 +32,35 @@ export interface IShortLinksManagerBackend {
 	 * @param {string} shortId
 	 * @returns the short ID or null if not found
 	 */
-	getTargetUrl: (shortId: string) => string | null | Promise<string | null>;
+	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>;
+	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[]>;
+	checkShortIdsExist(shortIds: string[]): string[] | Promise<string[]>;
 	/**
 	 * Update last accessed time to current timestamp
 	 * @param shortId
+	 * @param time Unix timestamp or a Date object
 	 */
-	updateShortLinkLastAccessTime(shortId: string): void | Promise<void>;
+	updateShortLinkLastAccessTime(shortId: string, time?: number | Date): void | Promise<void>;
 	/**
 	 * Remove unused links that are older than the given maxAge
 	 * @param maxAge number of days the record should be kept
+	 * @returns an array of short IDs that have been cleaned
+	 */
+	cleanUnusedLinks(maxAge: number): string[] | Promise<string[]>;
+	/**
+	 * Remove a short link by its ID
+	 * @param shortId the short ID to remove
 	 */
-	cleanUnusedLinks(maxAge: number): void | Promise<void>;
+	removeShortLink(shortId: string): void | Promise<void>;
 }
 export interface IManagerProps {
 	backend: IShortLinksManagerBackend;
@@ -103,13 +115,19 @@ export interface IShortLinksManager {
 	 * @param time last accessed time. Defaults to current time
 	 * @throws Error if backend failed
 	 */
-	updateShortLinkLastAccessTime(shortId: string, time: Date): Promise<void>;
+	updateShortLinkLastAccessTime(shortId: string, time?: number | 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>;
+	/**
+	 * Remove a short link by its ID
+	 * @param shortId the short ID to remove
+	 * @throws Error if backend failed
+	 */
+	removeShortLink(shortId: string): Promise<void>;
 }
 export declare function createManager({ backend, caches, shortIdLength, onShortIdLengthUpdated, waitUntil, options }: IManagerProps): Promise<IShortLinksManager>;
 

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 C(m=4){let f="";for(let O=0;O<m;O++)f+="0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ".charAt(Math.floor(Math.random()*62));return f}function j(m,f){let O=new Set,S=0;while(O.size<m&&S<m*100)O.add(C(f)),S++;return Array.from(O)}async function H({backend:m,caches:f=[],shortIdLength:O,onShortIdLengthUpdated:S,waitUntil:M,options:B}){return await m.init?.(),{async createShortLink(W){let D="";for(let _=0;_<3;_++){let A=j(50,O),E=await m.checkShortIdsExist(A),y=A.find((z)=>!E.includes(z));if(!y){++O;let z=S(O);if(M&&z instanceof Promise)M(z);else await z}else{D=y;break}}if(!D)throw Error("Unable to create a shortlink, potentially ran out");return await m.createShortLink(D,W),D},async getTargetUrl(W){let D=null,_=-1;for(let A=0;A<f.length;A++){if(!f[A].initialised)await f[A].init?.(),f[A].initialised=!0;if(D=await f[A].get(W),D){_=A;break}}if(!D)D=await m.getTargetUrl(W);if(D){if(B?.shouldUpdateLastAccessOnGet??!0){let E=m.updateShortLinkLastAccessTime(W);if(M&&E instanceof Promise)M(E);else await E}let A=f.length;if(_>=0)A=_;for(let E=0;E<A;E++){let y=async function(){if(!f[E].initialised)await f[E].init?.(),f[E].initialised=!0;await f[E].set(W,D)}();if(M)M(y);else await y}}return D},async updateShortLinkLastAccessTime(W){return await m.updateShortLinkLastAccessTime(W)},async cleanUnusedLinks(W){await m.cleanUnusedLinks(W)}}}export{H as createManager};
+function F(M=4){let f="";for(let y=0;y<M;y++)f+="0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ".charAt(Math.floor(Math.random()*62));return f}function j(M,f){let y=new Set,S=0;while(y.size<M&&S<M*100)y.add(F(f)),S++;return Array.from(y)}async function J({backend:M,caches:f=[],shortIdLength:y,onShortIdLengthUpdated:S,waitUntil:z,options:B}){return await M.init?.(),{async createShortLink(W){let A="";for(let O=0;O<3;O++){let E=j(50,y),_=await M.checkShortIdsExist(E),C=E.find((D)=>!_.includes(D));if(!C){++y;let D=S(y);if(z&&D instanceof Promise)z(D);else await D}else{A=C;break}}if(!A)throw Error("Unable to create a shortlink, potentially ran out");if(await M.createShortLink(A,W),f.length>0){let O=(async()=>{for(let E=0;E<f.length;E++){if(!f[E].initialised)await f[E].init?.(),f[E].initialised=!0;await f[E].set(A,W)}})();if(z)z(O);else await O}return A},async getTargetUrl(W){let A=null,O=-1;for(let E=0;E<f.length;E++){if(!f[E].initialised)await f[E].init?.(),f[E].initialised=!0;if(A=await f[E].get(W),A){O=E;break}}if(!A)A=await M.getTargetUrl(W);if(A){if(B?.shouldUpdateLastAccessOnGet??!0){let _=M.updateShortLinkLastAccessTime(W);if(z&&_ instanceof Promise)z(_);else await _}let E=f.length;if(O>=0)E=O;for(let _=0;_<E;_++){let C=async function(){if(!f[_].initialised)await f[_].init?.(),f[_].initialised=!0;await f[_].set(W,A)}();if(z)z(C);else await C}}return A},async updateShortLinkLastAccessTime(W,A){return await M.updateShortLinkLastAccessTime(W,A)},async cleanUnusedLinks(W){let A=await M.cleanUnusedLinks(W);for(let O of f)if(O.delete){if(!O.initialised)await O.init?.(),O.initialised=!0;for(let E of A)await O.delete(E)}},async removeShortLink(W){await M.removeShortLink(W);for(let A of f)if(A.delete){if(!A.initialised)await A.init?.(),A.initialised=!0;await A.delete(W)}}}}export{J as createManager};

package/package.json

@@ -11,7 +11,7 @@
     "type": "git",
     "directory": "packages/shortlinks-manager"
   },
-  "version": "0.2.2",
+  "version": "0.2.3",
   "type": "module",
   "license": "MIT",
   "main": "./dist/index.js",