@potonz/shortlinks-manager-cf-d1 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,15 @@
+# @potonz/shortlinks-manage-cf-d1
+
+Short links manager backend using Cloudflare D1 database.
+
+## Setting up
+
+You have to manually set up the DB for short links.
+A function is provided for this, this should only be called once.
+
+```ts
+import { env } from "cloudflare:workers";
+
+const backend = createD1Backend(env.DB);
+await backend.setupTables();
+```

package/dist/index.d.ts

@@ -0,0 +1,140 @@
+// Generated by dts-bundle-generator v9.5.1
+
+export interface D1Meta {
+	duration: number;
+	size_after: number;
+	rows_read: number;
+	rows_written: number;
+	last_row_id: number;
+	changed_db: boolean;
+	changes: number;
+	/**
+	 * The region of the database instance that executed the query.
+	 */
+	served_by_region?: string;
+	/**
+	 * True if-and-only-if the database instance that executed the query was the primary.
+	 */
+	served_by_primary?: boolean;
+	timings?: {
+		/**
+		 * The duration of the SQL query execution by the database instance. It doesn't include any network time.
+		 */
+		sql_duration_ms: number;
+	};
+	/**
+	 * Number of total attempts to execute the query, due to automatic retries.
+	 * Note: All other fields in the response like `timings` only apply to the last attempt.
+	 */
+	total_attempts?: number;
+}
+export interface D1Response {
+	success: true;
+	meta: D1Meta & Record<string, unknown>;
+	error?: never;
+}
+export type D1Result<T = unknown> = D1Response & {
+	results: T[];
+};
+export interface D1ExecResult {
+	count: number;
+	duration: number;
+}
+export type D1SessionConstraint = 
+// Indicates that the first query should go to the primary, and the rest queries
+// using the same D1DatabaseSession will go to any replica that is consistent with
+// the bookmark maintained by the session (returned by the first query).
+"first-primary"
+// Indicates that the first query can go anywhere (primary or replica), and the rest queries
+// using the same D1DatabaseSession will go to any replica that is consistent with
+// the bookmark maintained by the session (returned by the first query).
+ | "first-unconstrained";
+export type D1SessionBookmark = string;
+declare abstract class D1Database {
+	prepare(query: string): D1PreparedStatement;
+	batch<T = unknown>(statements: D1PreparedStatement[]): Promise<D1Result<T>[]>;
+	exec(query: string): Promise<D1ExecResult>;
+	/**
+	 * Creates a new D1 Session anchored at the given constraint or the bookmark.
+	 * All queries executed using the created session will have sequential consistency,
+	 * meaning that all writes done through the session will be visible in subsequent reads.
+	 *
+	 * @param constraintOrBookmark Either the session constraint or the explicit bookmark to anchor the created session.
+	 */
+	withSession(constraintOrBookmark?: D1SessionBookmark | D1SessionConstraint): D1DatabaseSession;
+	/**
+	 * @deprecated dump() will be removed soon, only applies to deprecated alpha v1 databases.
+	 */
+	dump(): Promise<ArrayBuffer>;
+}
+declare abstract class D1DatabaseSession {
+	prepare(query: string): D1PreparedStatement;
+	batch<T = unknown>(statements: D1PreparedStatement[]): Promise<D1Result<T>[]>;
+	/**
+	 * @returns The latest session bookmark across all executed queries on the session.
+	 *          If no query has been executed yet, `null` is returned.
+	 */
+	getBookmark(): D1SessionBookmark | null;
+}
+declare abstract class D1PreparedStatement {
+	bind(...values: unknown[]): D1PreparedStatement;
+	first<T = unknown>(colName: string): Promise<T | null>;
+	first<T = Record<string, unknown>>(): Promise<T | null>;
+	run<T = Record<string, unknown>>(): Promise<D1Result<T>>;
+	all<T = Record<string, unknown>>(): Promise<D1Result<T>>;
+	raw<T = unknown[]>(options: {
+		columnNames: true;
+	}): Promise<[
+		string[],
+		...T[]
+	]>;
+	raw<T = unknown[]>(options?: {
+		columnNames?: false;
+	}): Promise<T[]>;
+}
+// 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 IShortLinksManagerD1Backend extends IShortLinksManagerBackend {
+	setupTables: () => Promise<void>;
+}
+export declare function createD1Backend(db: D1Database): IShortLinksManagerD1Backend;
+declare const _default: {};
+
+export {
+	_default as default,
+};
+
+export {};

package/dist/index.js

@@ -0,0 +1,47 @@
+/* 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.
+ */
+/*! *****************************************************************************
+Copyright (c) Cloudflare. All rights reserved.
+Copyright (c) Microsoft Corporation. All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+this file except in compliance with the License. You may obtain a copy of the
+License at http://www.apache.org/licenses/LICENSE-2.0
+THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
+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 F(j){let w=null,y=null,z=null,B=null,C=null;return{async setupTables(){await j.prepare(`
+CREATE TABLE IF NOT EXISTS sl_links_map (
+    short_id VARCHAR(255) NOT NULL PRIMARY KEY,
+    target_url VARCHAR(65535) NOT NULL,
+    last_accessed_at DATETIME DEFAULT CURRENT_TIMESTAMP,
+    created_at DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP
+);
+
+CREATE INDEX IF NOT EXISTS idx_sl_links_map_last_accessed_at ON sl_links_map(last_accessed_at);
+
+PRAGMA optimize;
+`).run()},async getTargetUrl(f){if(!w)w=j.prepare("SELECT target_url FROM sl_links_map WHERE short_id = ? LIMIT 1");return(await w.bind(f).first())?.target_url??null},async createShortLink(f,q){if(!z)z=j.prepare("INSERT INTO sl_links_map (short_id, target_url) VALUES (?, ?)");await z.bind(f,q).run()},async checkShortIdsExist(f){if(!y){let D=Array.from("?".repeat(f.length)).join(",");y=j.prepare(`SELECT short_id FROM sl_links_map WHERE short_id IN (${D})`)}let q=await y.bind(...f).all();if(!q.success)return[];return q.results.map((D)=>D.short_id)},async updateShortLinkLastAccessTime(f){if(!B)B=j.prepare("UPDATE sl_links_map SET last_accessed_at = CURRENT_TIMESTAMP WHERE short_id = ?");await B.bind(f).run()},async cleanUnusedLinks(f){if(!C)C=j.prepare("DELETE FROM sl_links_map WHERE last_accessed_at < datetime(CURRENT_TIMESTAMP, ?)");await C.bind(`-${f} days`).run()}}}var J={};export{J as default,F as createD1Backend};

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@potonz/shortlinks-manager-cf-d1",
+  "description": "Short links manager extension for Cloudflare D1",
+  "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",
+  "dependencies": {
+    "@potonz/shortlinks-manager": "0.1.0"
+  },
+  "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"
+  }
+}