@potonz/shortlinks-manager-cf-d1 0.2.3 → 0.3.1

package/README.md

@@ -1,15 +1,136 @@
-# @potonz/shortlinks-manage-cf-d1
+# @potonz/shortlinks-manager-cf-d1
 
-Short links manager backend using Cloudflare D1 database.
+Cloudflare D1 backend for short links manager.
 
-## Setting up
+## Features
 
-You have to manually set up the DB for short links.
-A function is provided for this, this should only be called once.
+- Cloudflare D1 SQLite support for edge deployment
+- Automatic table creation and indexing
+- Perfect for Cloudflare Workers environment
+- Built-in cache integration for high performance
+- Lightweight and efficient SQLite operations
 
-```ts
+## Installation
+
+```bash
+bun add @potonz/shortlinks-manager-cf-d1
+```
+
+## Usage
+
+```typescript
+import { createManager } from "@potonz/shortlinks-manager";
+import { createD1Backend } from "@potonz/shortlinks-manager-cf-d1";
 import { env } from "cloudflare:workers";
 
+// Create backend with D1 binding
 const backend = createD1Backend(env.DB);
+
+// Initialize tables (run once during setup)
 await backend.setupTables();
+
+// Create manager
+const manager = await createManager({
+    backend,
+    shortIdLength: 6,
+    onShortIdLengthUpdated: (newLength) => {
+        console.log(`Short ID length updated to ${newLength}`);
+    },
+});
+
+// Create short link
+const shortId = await manager.createShortLink("https://example.com");
+console.log(`Created short link: ${shortId}`);
+
+// Resolve short link
+const targetUrl = await manager.getTargetUrl(shortId);
+console.log(`Target URL: ${targetUrl}`);
+```
+
+## Database Schema
+
+The backend automatically creates the following table:
+
+```sql
+CREATE TABLE IF NOT EXISTS sl_links_map (
+    short_id TEXT NOT NULL PRIMARY KEY,
+    target_url TEXT NOT NULL,
+    last_accessed_at INTEGER DEFAULT (strftime('%s', 'now')),
+    created_at INTEGER NOT NULL DEFAULT (strftime('%s', 'now'))
+);
+
+CREATE INDEX IF NOT EXISTS idx_sl_links_map_last_accessed_at 
+ON sl_links_map(last_accessed_at);
+```
+
+## API
+
+### `createD1Backend(db: D1Database)`
+
+Creates a Cloudflare D1 backend instance.
+
+**Parameters:**
+- `db` - Cloudflare D1 database binding (typically from `env.DB` in Workers)
+
+**Returns:** `IShortLinksManagerBackend`
+
+### `backend.setupTables()`
+
+Creates the required database tables and indexes. Should be called once during application initialization.
+
+### Backend Methods
+
+Implements all `IShortLinksManagerBackend` methods:
+
+- `getTargetUrl(shortId)` - Get target URL by short ID
+- `createShortLink(shortId, targetUrl)` - Create a new short link
+- `checkShortIdsExist(shortIds)` - Check which short IDs already exist
+- `updateShortLinkLastAccessTime(shortId, time)` - Update last accessed timestamp
+- `cleanUnusedLinks(maxAge)` - Remove links not accessed in `maxAge` days
+- `removeShortLink(shortId)` - Remove a short link by ID
+
+## Cloudflare Workers Setup
+
+1. Configure D1 binding in `wrangler.jsonc`:
+
+```jsonc
+{
+    "$schema": "node_modules/wrangler/config-schema.json",
+    "name": "your-worker-name",
+    "main": "src/index.ts",
+    "compatibility_date": "2025-12-25",
+    "d1_databases": [
+        {
+            "binding": "DB",
+            "database_id": "your-database-id",
+            "database_name": "shortlinks"
+        }
+    ]
+}
+```
+
+2. Create D1 database:
+
+```bash
+wrangler d1 create shortlinks
 ```
+
+3. Deploy with Wrangler:
+
+```bash
+wrangler deploy
+```
+
+## Testing
+
+Tests run against a local D1-compatible SQLite database.
+
+To run tests locally:
+
+```bash
+bun test packages/shortlinks-manager-cf-d1
+```
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -92,6 +92,12 @@ declare abstract class D1PreparedStatement {
 		columnNames?: false;
 	}): Promise<T[]>;
 }
+// Generated by dts-bundle-generator v9.5.1
+export interface IBaseUrlRecord {
+	id: number;
+	baseUrl: string;
+	isActive?: boolean;
+}
 export interface IShortLinksManagerBackend {
 	/**
 	 * Initialise any logic before the manager can do its thing. E.g. setting up tables.
@@ -99,39 +105,74 @@ 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>;
+	  * 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
-	 */
-	createShortLink(shortId: string, targetUrl: string): void | Promise<void>;
+	  * 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
-	 */
-	checkShortIdsExist(shortIds: string[]): string[] | Promise<string[]>;
+	  * 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 time Unix timestamp or a Date object
-	 */
-	updateShortLinkLastAccessTime(shortId: string, time?: number | Date): void | Promise<void>;
+	  * 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 short IDs that have been cleaned
-	 */
-	cleanUnusedLinks(maxAge: number): string[] | Promise<string[]>;
+	   * 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
-	 */
-	removeShortLink(shortId: string): void | 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
+	  */
+	removeShortLink(shortId: string, baseUrlId: number | null): void | Promise<void>;
+	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 IShortLinksManagerD1Backend extends IShortLinksManagerBackend {
 	setupTables: () => Promise<void>;

package/dist/index.js

@@ -33,15 +33,27 @@ WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
 MERCHANTABLITY OR NON-INFRINGEMENT.
 See the Apache Version 2.0 License for specific language governing permissions
 and limitations under the License.
-***************************************************************************** */function j($){let p=$.getFullYear(),y=String($.getMonth()+1).padStart(2,"0"),F=String($.getDate()).padStart(2,"0"),H=String($.getHours()).padStart(2,"0"),T=String($.getMinutes()).padStart(2,"0"),Y=String($.getSeconds()).padStart(2,"0");return`${p}-${y}-${F} ${H}:${T}:${Y}`}function w($){let p=null,y=null,F=null,H=null,T=null,Y=null;return{async setupTables(){await $.prepare(`
+***************************************************************************** */function N(f){let x=f.getFullYear(),F=String(f.getMonth()+1).padStart(2,"0"),H=String(f.getDate()).padStart(2,"0"),S=String(f.getHours()).padStart(2,"0"),T=String(f.getMinutes()).padStart(2,"0"),Y=String(f.getSeconds()).padStart(2,"0");return`${x}-${F}-${H} ${S}:${T}:${Y}`}function Q(f){let x=null,F=null,H=null,S=null,T=null,Y=null,j=null,w=null,z=null,C=null,E=null,G=null,J=null;return{async setupTables(){await f.prepare(`
+CREATE TABLE IF NOT EXISTS sl_base_urls (
+    id INTEGER PRIMARY KEY AUTOINCREMENT,
+    base_url TEXT NOT NULL UNIQUE,
+    is_active INTEGER DEFAULT 1,
+    created_at DATETIME DEFAULT CURRENT_TIMESTAMP
+);
+
 CREATE TABLE IF NOT EXISTS sl_links_map (
-    short_id VARCHAR(255) NOT NULL PRIMARY KEY,
+    id INTEGER PRIMARY KEY AUTOINCREMENT,
+    short_id VARCHAR(255) NOT NULL,
     target_url VARCHAR(65535) NOT NULL,
+    base_url_id INTEGER,
     last_accessed_at DATETIME DEFAULT CURRENT_TIMESTAMP,
-    created_at DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP
+    created_at DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    CONSTRAINT uk_short_id_base_url UNIQUE (short_id, base_url_id)
 );
 
 CREATE INDEX IF NOT EXISTS idx_sl_links_map_last_accessed_at ON sl_links_map(last_accessed_at);
+CREATE INDEX IF NOT EXISTS idx_sl_links_map_base_url_id ON sl_links_map(base_url_id);
+CREATE INDEX IF NOT EXISTS idx_sl_links_map_short_id_base_url ON sl_links_map(short_id, base_url_id);
 
 PRAGMA optimize;
-`).run()},async getTargetUrl(f){if(!p)p=$.prepare("SELECT target_url FROM sl_links_map WHERE short_id = ? LIMIT 1");return(await p.bind(f).first())?.target_url??null},async createShortLink(f,g){if(!F)F=$.prepare("INSERT INTO sl_links_map (short_id, target_url) VALUES (?, ?)");await F.bind(f,g).run()},async checkShortIdsExist(f){if(!y){let D=Array.from("?".repeat(f.length)).join(",");y=$.prepare(`SELECT short_id FROM sl_links_map WHERE short_id IN (${D})`)}let g=await y.bind(...f).all();if(!g.success)return[];return g.results.map((D)=>D.short_id)},async updateShortLinkLastAccessTime(f,g=new Date){if(!H)H=$.prepare("UPDATE sl_links_map SET last_accessed_at = ? WHERE short_id = ?");let D=g;if(typeof D==="number")D=new Date(D);await H.bind(j(D),f).run()},async cleanUnusedLinks(f){if(!T)T=$.prepare("DELETE FROM sl_links_map WHERE last_accessed_at < datetime(CURRENT_TIMESTAMP, ?) RETURNING short_id");return(await T.bind(`-${f} days`).all()).results.map((D)=>D.short_id)},async removeShortLink(f){if(!Y)Y=$.prepare("DELETE FROM sl_links_map WHERE short_id = ?");await Y.bind(f).run()}}}var C={};export{C as default,w as createD1Backend};
+`).run()},async getTargetUrl($,D){if(!G)G=f.prepare("SELECT target_url FROM sl_links_map WHERE short_id = ? AND base_url_id IS NULL LIMIT 1");if(!J)J=f.prepare("SELECT target_url FROM sl_links_map WHERE short_id = ? AND base_url_id = ? LIMIT 1");return(D===null?await G.bind($).first():await J.bind($,D).first())?.target_url??null},async createShortLink($,D,g){if(!x)x=f.prepare("INSERT INTO sl_links_map (short_id, target_url, base_url_id) VALUES (?, ?, ?)");await x.bind($,D,g).run()},async checkShortIdsExist($,D){let g=Array.from("?".repeat($.length)).join(","),p;if(D===null)p=await f.prepare(`SELECT short_id FROM sl_links_map WHERE short_id IN (${g}) AND base_url_id IS NULL`).bind(...$).all();else p=await f.prepare(`SELECT short_id FROM sl_links_map WHERE short_id IN (${g}) AND base_url_id = ?`).bind(...$,D).all();return p.results.map((K)=>K.short_id)},async updateShortLinkLastAccessTime($,D,g=new Date){if(!F)F=f.prepare("UPDATE sl_links_map SET last_accessed_at = ? WHERE short_id = ? AND base_url_id IS NULL");if(!H)H=f.prepare("UPDATE sl_links_map SET last_accessed_at = ? WHERE short_id = ? AND base_url_id = ?");let p=g;if(typeof p==="number")p=new Date(p);if(D===null)await F.bind(N(p),$).run();else await H.bind(N(p),$,D).run()},async cleanUnusedLinks($){if(!S)S=f.prepare("DELETE FROM sl_links_map WHERE last_accessed_at < datetime(CURRENT_TIMESTAMP, ?) RETURNING short_id, base_url_id");return(await S.bind(`-${$} days`).all()).results.map((g)=>({shortId:g.short_id,baseUrlId:g.base_url_id}))},async removeShortLink($,D){if(!T)T=f.prepare("DELETE FROM sl_links_map WHERE short_id = ? AND base_url_id IS NULL");if(!Y)Y=f.prepare("DELETE FROM sl_links_map WHERE short_id = ? AND base_url_id = ?");if(D===null)await T.bind($).run();else await Y.bind($,D).run()},baseUrl:{async add($){if(!j)j=f.prepare("INSERT OR IGNORE INTO sl_base_urls (base_url) VALUES (?)");await j.bind($).run()},async remove($){if(!w)w=f.prepare("UPDATE sl_base_urls SET is_active = 0 WHERE id = ?");await w.bind($).run()},async list($){if(!z)z=f.prepare("SELECT id, base_url, is_active FROM sl_base_urls WHERE is_active = 1");if(!C)C=f.prepare("SELECT id, base_url, is_active FROM sl_base_urls WHERE 1=1");let D;if($)D=await C.all();else D=await z.all();return D.results.map((g)=>({id:g.id,baseUrl:g.base_url,isActive:g.is_active===1}))},async getId($){if(!E)E=f.prepare("SELECT id FROM sl_base_urls WHERE base_url = ? LIMIT 1");let D=await E.bind($).first();if(!D)throw Error(`Base URL not found: ${$}`);return D.id}}}}var Z={};export{Z as default,Q as createD1Backend};

package/package.json

@@ -11,11 +11,11 @@
     "type": "git",
     "directory": "packages/shortlinks-manager-cf-d1"
   },
-  "version": "0.2.3",
+  "version": "0.3.1",
   "type": "module",
   "license": "MIT",
   "dependencies": {
-    "@potonz/shortlinks-manager": "0.1.1"
+    "@potonz/shortlinks-manager": "0.2.3"
   },
   "main": "./dist/index.js",
   "module": "./dist/index.js",