@potonz/shortlinks-manager 0.2.4 → 0.3.2

package/dist/index.d.ts

@@ -1,25 +1,9 @@
 // Generated by dts-bundle-generator v9.5.1
 
-export interface ICache {
-	initialised?: boolean;
-	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>);
-	/**
-	 * Delete the short ID in the cache
-	 * @param shortId
-	 */
-	delete?: (shortId: string) => (void | Promise<void>);
+export interface IBaseUrlRecord {
+	id: number;
+	baseUrl: string;
+	isActive?: boolean;
 }
 export interface IShortLinksManagerBackend {
 	/**
@@ -28,39 +12,110 @@ export interface IShortLinksManagerBackend {
 	 */
 	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[]>;
+	  * Get target URL for the given short ID
+	  * @param {string} shortId
+	  * @param {number} baseUrlId optional base URL ID to filter by
+	  * @returns the target URL or null if not found
+	  */
+	getTargetUrl(shortId: string, baseUrlId: number | null): string | null | Promise<string | null>;
+	/**
+	  * Create a short link map with the given short ID and target URL
+	  * @param {string} shortId
+	  * @param {string} targetUrl
+	  * @param {number} baseUrlId optional base URL ID
+	  */
+	createShortLink(shortId: string, targetUrl: string, baseUrlId: number | null): void | Promise<void>;
+	/**
+	  * Check the provided list of short IDs and return the ones that already exist.
+	  * @param {string[]} shortIds
+	  * @param {number} baseUrlId optional base URL ID to check within
+	  */
+	checkShortIdsExist(shortIds: string[], baseUrlId: number | null): string[] | Promise<string[]>;
+	/**
+	  * Update last accessed time to current timestamp
+	  * @param shortId
+	  * @param baseUrlId optional base URL ID to filter by
+	  * @param time Unix timestamp or a Date object
+	  */
+	updateShortLinkLastAccessTime(shortId: string, baseUrlId: number | null, 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 objects with shortId and baseUrlId that have been cleaned
+	   */
+	cleanUnusedLinks(maxAge: number): Array<{
+		shortId: string;
+		baseUrlId: number | null;
+	}> | Promise<Array<{
+		shortId: string;
+		baseUrlId: number | null;
+	}>>;
+	/**
+	  * Remove a short link by its ID
+	  * @param shortId the short ID to remove
+	  * @param baseUrlId optional base URL ID to filter by
+	  */
+	removeShortLink(shortId: string, baseUrlId: number | null): void | Promise<void>;
+	/**
+	  * Update the target URL for an existing short link
+	  * @param shortId the short ID to update
+	  * @param targetUrl the new target URL
+	  * @param baseUrlId optional base URL ID to filter by
+	  * @returns true if the link was updated, false if not found
+	  */
+	updateShortLink(shortId: string, targetUrl: string, baseUrlId: number | null): boolean | Promise<boolean>;
+	baseUrl: {
+		/**
+		 * Add a new base URL
+		 * @param baseUrl the base URL to add
+		 */
+		add(baseUrl: string): void | Promise<void>;
+		/**
+		 * Remove a base URL by its ID
+		 * @param id the ID of the base URL to remove
+		 */
+		remove(id: number): void | Promise<void>;
+		/**
+		 * List all base URLs
+		 * @param includeInactive whether to include inactive base URLs (default: false)
+		 * @returns array of base URL records
+		 */
+		list(includeInactive?: boolean): IBaseUrlRecord[] | Promise<IBaseUrlRecord[]>;
+		/**
+		 * Get the ID for a base URL
+		 * @param baseUrl the base URL to get the ID for
+		 * @returns the base URL ID or null if not found
+		 */
+		getId(baseUrl: string): number | Promise<number>;
+	};
+}
+export interface IBaseUrlManager {
+	add(baseUrl: string): Promise<void>;
+	remove(baseUrl: number): Promise<void>;
+	list(includeInactive?: boolean): Promise<IBaseUrlRecord[]>;
+	getBaseUrlId(baseUrl: string): Promise<number>;
+}
+export declare function createBaseUrlManager(backend: IShortLinksManagerBackend): IBaseUrlManager;
+export interface ICache {
+	initialised?: boolean;
+	init?: () => (unknown | Promise<unknown>);
 	/**
-	 * Update last accessed time to current timestamp
-	 * @param shortId
-	 * @param time Unix timestamp or a Date object
+	 * Get the target URL using the provided shortId
+	 * @param key
+	 * @returns string if a target URL is found, null otherwise
 	 */
-	updateShortLinkLastAccessTime(shortId: string, time?: number | Date): void | Promise<void>;
+	get: (key: string) => (string | null | Promise<string | null>);
 	/**
-	 * 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
+	 * Cache the target URL
+	 * @param key
+	 * @param targetUrl
 	 */
-	cleanUnusedLinks(maxAge: number): string[] | Promise<string[]>;
+	set: (key: string, targetUrl: string) => (void | Promise<void>);
 	/**
-	 * Remove a short link by its ID
-	 * @param shortId the short ID to remove
+	 * Delete the short ID in the cache
+	 * @param key
 	 */
-	removeShortLink(shortId: string): void | Promise<void>;
+	delete: (key: string) => (void | Promise<void>);
 }
 export interface IManagerProps {
 	backend: IShortLinksManagerBackend;
@@ -73,7 +128,7 @@ export interface IManagerProps {
 	shortIdLength: number;
 	onShortIdLengthUpdated: (newLength: number) => unknown;
 	/**
-	 * A special function to queue the {@link promise}.
+	 * A special function to queue the promise.
 	 *
 	 * Useful when running in Cloudflare Worker to
 	 * run the promise after the responding to the client.
@@ -96,39 +151,57 @@ export interface IManagerProps {
 }
 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 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?: 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
-	 */
+	 * Base URL manager for managing base URLs
+	 */
+	baseUrl: IBaseUrlManager;
+	/**
+	  * Generate a short ID linking to the target URL
+	  * @param {string} targetUrl targetUrl
+	  * @param {number | null} baseUrlId optional base URL ID
+	  * @returns {Promise<string>} short ID
+	  * @throws Error if failed
+	  */
+	createShortLink(targetUrl: string, baseUrlId: number | null): Promise<string>;
+	/**
+	  * Get a target URL from the given short ID
+	  * @param shortId
+	  * @param baseUrlId optional base URL ID to filter by
+	  * @returns {Promise<IShortLinkInfo | null>} the target URL info or null if not found
+	  * @throws Error if backend failed
+	  */
+	getTargetUrl(shortId: string, baseUrlId: number | null): Promise<string | null>;
+	/**
+	  * Update last accessed time to avoid link being cleaned
+	  * @param shortId
+	  * @param baseUrlId optional base URL ID to filter by
+	  * @param time last accessed time. Defaults to current time
+	  * @throws Error if backend failed
+	  */
+	updateShortLinkLastAccessTime(shortId: string, baseUrlId: number | null, 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>;
+	  * Remove a short link by its ID
+	  * @param shortId the short ID to remove
+	  * @param baseUrlId optional base URL ID to filter by
+	  * @throws Error if backend failed
+	  */
+	removeShortLink(shortId: string, baseUrlId: number | null): Promise<void>;
+	/**
+	  * Update the target URL for an existing short link
+	  * @param shortId the short ID to update
+	  * @param targetUrl the new target URL
+	  * @param baseUrlId optional base URL ID to filter by
+	  * @returns {Promise<boolean>} true if the link was updated, false if not found
+	  * @throws Error if backend failed
+	  */
+	updateShortLink(shortId: string, targetUrl: string, baseUrlId: number | null): Promise<boolean>;
 }
+export declare function normalizeCacheKey(baseUrlId: number | null, shortId: string): string;
 export declare function createManager({ backend, caches, shortIdLength, onShortIdLengthUpdated, waitUntil, options }: 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 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};
+function F(f){return{async add(m){return f.baseUrl.add(m)},async remove(m){return f.baseUrl.remove(m)},async list(m){return f.baseUrl.list(m)},async getBaseUrlId(m){return f.baseUrl.getId(m)}}}function N(f=4){let m="";for(let O=0;O<f;O++)m+="0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ".charAt(Math.floor(Math.random()*62));return m}function H(f,m){let O=new Set,j=0;while(O.size<f&&j<f*100)O.add(N(m)),j++;return Array.from(O)}function _(f,m){return`${f??"any"}__${m}`}async function Z({backend:f,caches:m=[],shortIdLength:O,onShortIdLengthUpdated:j,waitUntil:S,options:J}){return await f.init?.(),{baseUrl:F(f),async createShortLink(A,M){let B="";for(let P=0;P<3;P++){let x=H(50,O),v=await f.checkShortIdsExist(x,M),E=x.find((W)=>!v.includes(W));if(!E){++O;let W=j(O);if(S&&W instanceof Promise)S(W);else await W}else{B=E;break}}if(!B)throw Error("Unable to create a shortlink, potentially ran out");if(await f.createShortLink(B,A,M),m.length>0){let P=_(M,B),x=(async()=>{for(let v=0;v<m.length;v++){if(!m[v].initialised)await m[v].init?.(),m[v].initialised=!0;await m[v].set(P,A)}})();if(S)S(x);else await x}return B},async getTargetUrl(A,M){let B=null,P=-1,x=_(M,A);for(let v=0;v<m.length;v++){if(!m[v].initialised)await m[v].init?.(),m[v].initialised=!0;if(B=await m[v].get(x),B){P=v;break}}if(!B)B=await f.getTargetUrl(A,M);if(B){if(J?.shouldUpdateLastAccessOnGet??!0){let E=f.updateShortLinkLastAccessTime(A,M);if(S&&E instanceof Promise)S(E);else await E}let v=m.length;if(P>=0)v=P;for(let E=0;E<v;E++){let W=async function(){if(!m[E].initialised)await m[E].init?.(),m[E].initialised=!0;await m[E].set(x,B)}();if(S)S(W);else await W}}return B},async updateShortLinkLastAccessTime(A,M,B){return await f.updateShortLinkLastAccessTime(A,M,B)},async cleanUnusedLinks(A){let M=await f.cleanUnusedLinks(A);for(let B of m){if(!B.initialised)await B.init?.(),B.initialised=!0;for(let{shortId:P,baseUrlId:x}of M){let v=_(x,P);await B.delete(v)}}},async removeShortLink(A,M){await f.removeShortLink(A,M);for(let B of m){if(!B.initialised)await B.init?.(),B.initialised=!0;let P=_(M,A);await B.delete(P)}},async updateShortLink(A,M,B){let P=await f.updateShortLink(A,M,B);if(P)for(let x of m){if(!x.initialised)await x.init?.(),x.initialised=!0;let v=_(B,A);await x.delete(v)}return P}}}export{_ as normalizeCacheKey,Z as createManager,F as createBaseUrlManager};

package/package.json

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