@hot-updater/vercel 0.0.0-stage → 1.0.2

package/dist/index.cjs

@@ -0,0 +1,208 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+let _hot_updater_plugin_core = require("@hot-updater/plugin-core");
+let _vercel_blob = require("@vercel/blob");
+//#region src/vercelBlobStorage.ts
+const PROTOCOL = "vercel-blob";
+const ONE_YEAR_IN_SECONDS = 31536e3;
+/** Above this, `put` uploads in parts. */
+const MULTIPART_THRESHOLD_BYTES = 104857600;
+/** One delegation presigns every private download URL for a day. */
+const DELEGATION_LIFETIME_MS = 864e5;
+/** Vercel's limit on a delegation, and so on a presigned URL. */
+const MAX_SIGNED_LIFETIME_SECONDS = 604800;
+const DELETE_BATCH_SIZE = 100;
+/**
+* A character @vercel/blob drops from a pathname's URL, such as `#`, or
+* reads as an escape, such as `%`, so `get` and presigned URLs miss the
+* object; control characters; and the escape character `!`.
+*/
+const ESCAPED_CHARACTER = /[#?%\\!\p{Cc}]/gu;
+const ESCAPE_SEQUENCE = /!([0-9A-F]{2})/gu;
+const utf8 = new TextEncoder();
+const utf8Decoder = new TextDecoder("utf-8", { fatal: true });
+/**
+* The pathname Blob keeps a key under: each escaped character as `!` and
+* the two hex digits of each of its UTF-8 bytes, such as `#` as `!23`.
+* Distinct keys keep distinct pathnames, and deploy's keys, such as
+* `<bundleId>/manifest.json`, are stored as they are.
+*/
+const toPathname = (key) => key.replace(ESCAPED_CHARACTER, (character) => Array.from(utf8.encode(character), (byte) => `!${byte.toString(16).toUpperCase().padStart(2, "0")}`).join(""));
+/** The key `toPathname` stored under `pathname`, or null for a pathname it never makes. */
+const fromPathname = (pathname) => {
+	const bytes = [];
+	const flush = (parts) => {
+		if (bytes.length === 0) return true;
+		try {
+			parts.push(utf8Decoder.decode(new Uint8Array(bytes)));
+		} catch {
+			return false;
+		}
+		bytes.length = 0;
+		return true;
+	};
+	const parts = [];
+	let index = 0;
+	for (const match of pathname.matchAll(ESCAPE_SEQUENCE)) {
+		if (match.index !== index) {
+			if (!flush(parts)) return null;
+			parts.push(pathname.slice(index, match.index));
+		}
+		bytes.push(Number.parseInt(match[1], 16));
+		index = match.index + match[0].length;
+	}
+	if (!flush(parts)) return null;
+	parts.push(pathname.slice(index));
+	const key = parts.join("");
+	return toPathname(key) === pathname ? key : null;
+};
+/** The store ID a read-write token belongs to, as Vercel's CLI reads it. */
+const storeIdOf = (token) => {
+	const [prefix, kind, rw, id] = token.split("_");
+	if (prefix !== "vercel" || kind !== "blob" || rw !== "rw" || !id) throw new Error("vercelBlobStorage needs the store's read-write token (vercel_blob_rw_...).");
+	return `store_${id}`;
+};
+/**
+* Bundles in a Vercel Blob store. A public store's objects download from
+* their Blob URL; a private store's from a presigned URL that expires.
+*/
+const vercelBlobStorage = (config) => {
+	const { token, access } = config;
+	const storeId = storeIdOf(token);
+	const host = `${storeId.slice(6).toLowerCase()}.${access}.blob.vercel-storage.com`;
+	const normalizedBasePath = config.basePath?.replace(/^\/+|\/+$/g, "") ?? "";
+	const getStorageKey = (0, _hot_updater_plugin_core.createStorageKeyBuilder)(normalizedBasePath);
+	const expiresIn = config.signedUrlExpiresIn ?? 3600;
+	if (!Number.isFinite(expiresIn) || expiresIn <= 0 || expiresIn > MAX_SIGNED_LIFETIME_SECONDS) throw new Error(`vercelBlobStorage signedUrlExpiresIn must be between 1 and ${MAX_SIGNED_LIFETIME_SECONDS} seconds (seven days).`);
+	const expiresInMs = expiresIn * 1e3;
+	let delegation;
+	/** A read delegation that outlives `validUntil`, shared by every URL it presigns. */
+	const delegationUntil = async (validUntil) => {
+		const current = await delegation?.catch(() => void 0);
+		if (current !== void 0 && current.validUntil >= validUntil) return current;
+		const issued = (0, _vercel_blob.issueSignedToken)({
+			token,
+			operations: ["get"],
+			validUntil: Date.now() + Math.min(MAX_SIGNED_LIFETIME_SECONDS * 1e3, Math.max(DELEGATION_LIFETIME_MS, expiresInMs * 2))
+		});
+		delegation = issued;
+		return issued;
+	};
+	const parseAndValidate = (storageUri) => {
+		const parsed = (0, _hot_updater_plugin_core.parseStorageUri)(storageUri, PROTOCOL);
+		if (parsed.bucket !== storeId) throw new Error(`Blob store mismatch: expected "${storeId}", but found "${parsed.bucket}".`);
+		return parsed;
+	};
+	const getListPrefix = (prefix = "") => {
+		const value = [normalizedBasePath, prefix.replace(/^\/+|\/+$/g, "")].filter(Boolean).join("/");
+		return value ? `${toPathname(value)}/` : "";
+	};
+	const getRelativeKey = (key) => {
+		if (!normalizedBasePath) return key;
+		const basePrefix = `${normalizedBasePath}/`;
+		return key.startsWith(basePrefix) ? key.slice(basePrefix.length) : key;
+	};
+	return (0, _hot_updater_plugin_core.createStorageAdapter)({
+		name: "vercelBlobStorage",
+		protocol: PROTOCOL,
+		async put({ key, body, contentLength, contentType }) {
+			const storageKey = getStorageKey(key);
+			const storageUri = (0, _hot_updater_plugin_core.createStorageUri)({
+				protocol: PROTOCOL,
+				bucket: storeId,
+				key: storageKey
+			});
+			await (0, _vercel_blob.put)(toPathname(storageKey), body, {
+				access,
+				token,
+				addRandomSuffix: false,
+				allowOverwrite: true,
+				cacheControlMaxAge: ONE_YEAR_IN_SECONDS,
+				contentType,
+				multipart: contentLength === void 0 || contentLength > MULTIPART_THRESHOLD_BYTES
+			});
+			return { storageUri };
+		},
+		async get({ storageUri }) {
+			const { key } = parseAndValidate(storageUri);
+			const result = await (0, _vercel_blob.get)(toPathname(key), {
+				access,
+				token,
+				useCache: false
+			});
+			if (result?.statusCode !== 200) return { response: null };
+			const contentLength = result.headers.get("content-length");
+			return { response: new Response(result.stream, { headers: {
+				"content-type": result.blob.contentType,
+				...contentLength && !result.headers.has("content-encoding") ? { "content-length": contentLength } : {}
+			} }) };
+		},
+		async getDownloadUrl({ storageUri }) {
+			const { key } = parseAndValidate(storageUri);
+			const pathname = toPathname(key);
+			if (access === "public") return { url: `https://${host}/${pathname.split("/").map(encodeURIComponent).join("/")}` };
+			const validUntil = Date.now() + expiresInMs;
+			const { presignedUrl } = await (0, _vercel_blob.presignUrl)(await delegationUntil(validUntil), {
+				access,
+				operation: "get",
+				pathname,
+				validUntil
+			});
+			return { url: presignedUrl };
+		},
+		async exists({ storageUri }) {
+			const { key } = parseAndValidate(storageUri);
+			try {
+				await (0, _vercel_blob.head)(toPathname(key), { token });
+				return { exists: true };
+			} catch (error) {
+				if (error instanceof _vercel_blob.BlobNotFoundError) return { exists: false };
+				throw error;
+			}
+		},
+		async delete({ storageUri }) {
+			const { key } = parseAndValidate(storageUri);
+			await (0, _vercel_blob.del)(toPathname(key), { token });
+			return { deleted: true };
+		},
+		async listObjects(prefix) {
+			const objects = [];
+			let cursor;
+			do {
+				const page = await (0, _vercel_blob.list)({
+					token,
+					prefix: getListPrefix(prefix),
+					limit: 1e3,
+					...cursor === void 0 ? {} : { cursor }
+				});
+				for (const blob of page.blobs) {
+					const key = fromPathname(blob.pathname);
+					if (key === null) continue;
+					let storageUri;
+					try {
+						storageUri = (0, _hot_updater_plugin_core.createStorageUri)({
+							protocol: PROTOCOL,
+							bucket: storeId,
+							key
+						});
+					} catch {
+						continue;
+					}
+					objects.push({
+						key: getRelativeKey(key),
+						lastModifiedAt: blob.uploadedAt,
+						size: blob.size,
+						storageUri
+					});
+				}
+				cursor = page.hasMore ? page.cursor : void 0;
+			} while (cursor !== void 0);
+			return objects;
+		},
+		async deleteObjects(relativeKeys) {
+			const pathnames = relativeKeys.map((key) => toPathname(getStorageKey(key)));
+			for (let offset = 0; offset < pathnames.length; offset += DELETE_BATCH_SIZE) await (0, _vercel_blob.del)(pathnames.slice(offset, offset + DELETE_BATCH_SIZE), { token });
+		}
+	});
+};
+//#endregion
+exports.vercelBlobStorage = vercelBlobStorage;

package/dist/index.d.cts

@@ -0,0 +1,26 @@
+import { StorageAdapterWith } from "@hot-updater/plugin-core";
+//#region src/vercelBlobStorage.d.ts
+interface VercelBlobStorageConfig {
+  /**
+   * The Blob store's read-write token, `vercel_blob_rw_<storeId>_<secret>`:
+   * the `BLOB_READ_WRITE_TOKEN` Vercel adds to a project the store connects to.
+   */
+  token: string;
+  /** The store's access, which Vercel fixes when it creates the store. */
+  access: "public" | "private";
+  /** Base path where bundles will be stored in the store. */
+  basePath?: string;
+  /**
+   * Lifetime of a private store's download URLs in seconds, at most seven
+   * days, Vercel's limit. @default 3600
+   */
+  signedUrlExpiresIn?: number;
+}
+type VercelBlobStorageOperations = "put" | "get" | "getDownloadUrl" | "exists" | "delete" | "listObjects" | "deleteObjects";
+/**
+ * Bundles in a Vercel Blob store. A public store's objects download from
+ * their Blob URL; a private store's from a presigned URL that expires.
+ */
+declare const vercelBlobStorage: (config: VercelBlobStorageConfig) => StorageAdapterWith<VercelBlobStorageOperations>;
+//#endregion
+export { VercelBlobStorageConfig, vercelBlobStorage };

package/dist/index.d.mts

@@ -0,0 +1,26 @@
+import { StorageAdapterWith } from "@hot-updater/plugin-core";
+//#region src/vercelBlobStorage.d.ts
+interface VercelBlobStorageConfig {
+  /**
+   * The Blob store's read-write token, `vercel_blob_rw_<storeId>_<secret>`:
+   * the `BLOB_READ_WRITE_TOKEN` Vercel adds to a project the store connects to.
+   */
+  token: string;
+  /** The store's access, which Vercel fixes when it creates the store. */
+  access: "public" | "private";
+  /** Base path where bundles will be stored in the store. */
+  basePath?: string;
+  /**
+   * Lifetime of a private store's download URLs in seconds, at most seven
+   * days, Vercel's limit. @default 3600
+   */
+  signedUrlExpiresIn?: number;
+}
+type VercelBlobStorageOperations = "put" | "get" | "getDownloadUrl" | "exists" | "delete" | "listObjects" | "deleteObjects";
+/**
+ * Bundles in a Vercel Blob store. A public store's objects download from
+ * their Blob URL; a private store's from a presigned URL that expires.
+ */
+declare const vercelBlobStorage: (config: VercelBlobStorageConfig) => StorageAdapterWith<VercelBlobStorageOperations>;
+//#endregion
+export { VercelBlobStorageConfig, vercelBlobStorage };

package/dist/index.mjs

@@ -0,0 +1,207 @@
+import { createStorageAdapter, createStorageKeyBuilder, createStorageUri, parseStorageUri } from "@hot-updater/plugin-core";
+import { BlobNotFoundError, del, get, head, issueSignedToken, list, presignUrl, put } from "@vercel/blob";
+//#region src/vercelBlobStorage.ts
+const PROTOCOL = "vercel-blob";
+const ONE_YEAR_IN_SECONDS = 31536e3;
+/** Above this, `put` uploads in parts. */
+const MULTIPART_THRESHOLD_BYTES = 104857600;
+/** One delegation presigns every private download URL for a day. */
+const DELEGATION_LIFETIME_MS = 864e5;
+/** Vercel's limit on a delegation, and so on a presigned URL. */
+const MAX_SIGNED_LIFETIME_SECONDS = 604800;
+const DELETE_BATCH_SIZE = 100;
+/**
+* A character @vercel/blob drops from a pathname's URL, such as `#`, or
+* reads as an escape, such as `%`, so `get` and presigned URLs miss the
+* object; control characters; and the escape character `!`.
+*/
+const ESCAPED_CHARACTER = /[#?%\\!\p{Cc}]/gu;
+const ESCAPE_SEQUENCE = /!([0-9A-F]{2})/gu;
+const utf8 = new TextEncoder();
+const utf8Decoder = new TextDecoder("utf-8", { fatal: true });
+/**
+* The pathname Blob keeps a key under: each escaped character as `!` and
+* the two hex digits of each of its UTF-8 bytes, such as `#` as `!23`.
+* Distinct keys keep distinct pathnames, and deploy's keys, such as
+* `<bundleId>/manifest.json`, are stored as they are.
+*/
+const toPathname = (key) => key.replace(ESCAPED_CHARACTER, (character) => Array.from(utf8.encode(character), (byte) => `!${byte.toString(16).toUpperCase().padStart(2, "0")}`).join(""));
+/** The key `toPathname` stored under `pathname`, or null for a pathname it never makes. */
+const fromPathname = (pathname) => {
+	const bytes = [];
+	const flush = (parts) => {
+		if (bytes.length === 0) return true;
+		try {
+			parts.push(utf8Decoder.decode(new Uint8Array(bytes)));
+		} catch {
+			return false;
+		}
+		bytes.length = 0;
+		return true;
+	};
+	const parts = [];
+	let index = 0;
+	for (const match of pathname.matchAll(ESCAPE_SEQUENCE)) {
+		if (match.index !== index) {
+			if (!flush(parts)) return null;
+			parts.push(pathname.slice(index, match.index));
+		}
+		bytes.push(Number.parseInt(match[1], 16));
+		index = match.index + match[0].length;
+	}
+	if (!flush(parts)) return null;
+	parts.push(pathname.slice(index));
+	const key = parts.join("");
+	return toPathname(key) === pathname ? key : null;
+};
+/** The store ID a read-write token belongs to, as Vercel's CLI reads it. */
+const storeIdOf = (token) => {
+	const [prefix, kind, rw, id] = token.split("_");
+	if (prefix !== "vercel" || kind !== "blob" || rw !== "rw" || !id) throw new Error("vercelBlobStorage needs the store's read-write token (vercel_blob_rw_...).");
+	return `store_${id}`;
+};
+/**
+* Bundles in a Vercel Blob store. A public store's objects download from
+* their Blob URL; a private store's from a presigned URL that expires.
+*/
+const vercelBlobStorage = (config) => {
+	const { token, access } = config;
+	const storeId = storeIdOf(token);
+	const host = `${storeId.slice(6).toLowerCase()}.${access}.blob.vercel-storage.com`;
+	const normalizedBasePath = config.basePath?.replace(/^\/+|\/+$/g, "") ?? "";
+	const getStorageKey = createStorageKeyBuilder(normalizedBasePath);
+	const expiresIn = config.signedUrlExpiresIn ?? 3600;
+	if (!Number.isFinite(expiresIn) || expiresIn <= 0 || expiresIn > MAX_SIGNED_LIFETIME_SECONDS) throw new Error(`vercelBlobStorage signedUrlExpiresIn must be between 1 and ${MAX_SIGNED_LIFETIME_SECONDS} seconds (seven days).`);
+	const expiresInMs = expiresIn * 1e3;
+	let delegation;
+	/** A read delegation that outlives `validUntil`, shared by every URL it presigns. */
+	const delegationUntil = async (validUntil) => {
+		const current = await delegation?.catch(() => void 0);
+		if (current !== void 0 && current.validUntil >= validUntil) return current;
+		const issued = issueSignedToken({
+			token,
+			operations: ["get"],
+			validUntil: Date.now() + Math.min(MAX_SIGNED_LIFETIME_SECONDS * 1e3, Math.max(DELEGATION_LIFETIME_MS, expiresInMs * 2))
+		});
+		delegation = issued;
+		return issued;
+	};
+	const parseAndValidate = (storageUri) => {
+		const parsed = parseStorageUri(storageUri, PROTOCOL);
+		if (parsed.bucket !== storeId) throw new Error(`Blob store mismatch: expected "${storeId}", but found "${parsed.bucket}".`);
+		return parsed;
+	};
+	const getListPrefix = (prefix = "") => {
+		const value = [normalizedBasePath, prefix.replace(/^\/+|\/+$/g, "")].filter(Boolean).join("/");
+		return value ? `${toPathname(value)}/` : "";
+	};
+	const getRelativeKey = (key) => {
+		if (!normalizedBasePath) return key;
+		const basePrefix = `${normalizedBasePath}/`;
+		return key.startsWith(basePrefix) ? key.slice(basePrefix.length) : key;
+	};
+	return createStorageAdapter({
+		name: "vercelBlobStorage",
+		protocol: PROTOCOL,
+		async put({ key, body, contentLength, contentType }) {
+			const storageKey = getStorageKey(key);
+			const storageUri = createStorageUri({
+				protocol: PROTOCOL,
+				bucket: storeId,
+				key: storageKey
+			});
+			await put(toPathname(storageKey), body, {
+				access,
+				token,
+				addRandomSuffix: false,
+				allowOverwrite: true,
+				cacheControlMaxAge: ONE_YEAR_IN_SECONDS,
+				contentType,
+				multipart: contentLength === void 0 || contentLength > MULTIPART_THRESHOLD_BYTES
+			});
+			return { storageUri };
+		},
+		async get({ storageUri }) {
+			const { key } = parseAndValidate(storageUri);
+			const result = await get(toPathname(key), {
+				access,
+				token,
+				useCache: false
+			});
+			if (result?.statusCode !== 200) return { response: null };
+			const contentLength = result.headers.get("content-length");
+			return { response: new Response(result.stream, { headers: {
+				"content-type": result.blob.contentType,
+				...contentLength && !result.headers.has("content-encoding") ? { "content-length": contentLength } : {}
+			} }) };
+		},
+		async getDownloadUrl({ storageUri }) {
+			const { key } = parseAndValidate(storageUri);
+			const pathname = toPathname(key);
+			if (access === "public") return { url: `https://${host}/${pathname.split("/").map(encodeURIComponent).join("/")}` };
+			const validUntil = Date.now() + expiresInMs;
+			const { presignedUrl } = await presignUrl(await delegationUntil(validUntil), {
+				access,
+				operation: "get",
+				pathname,
+				validUntil
+			});
+			return { url: presignedUrl };
+		},
+		async exists({ storageUri }) {
+			const { key } = parseAndValidate(storageUri);
+			try {
+				await head(toPathname(key), { token });
+				return { exists: true };
+			} catch (error) {
+				if (error instanceof BlobNotFoundError) return { exists: false };
+				throw error;
+			}
+		},
+		async delete({ storageUri }) {
+			const { key } = parseAndValidate(storageUri);
+			await del(toPathname(key), { token });
+			return { deleted: true };
+		},
+		async listObjects(prefix) {
+			const objects = [];
+			let cursor;
+			do {
+				const page = await list({
+					token,
+					prefix: getListPrefix(prefix),
+					limit: 1e3,
+					...cursor === void 0 ? {} : { cursor }
+				});
+				for (const blob of page.blobs) {
+					const key = fromPathname(blob.pathname);
+					if (key === null) continue;
+					let storageUri;
+					try {
+						storageUri = createStorageUri({
+							protocol: PROTOCOL,
+							bucket: storeId,
+							key
+						});
+					} catch {
+						continue;
+					}
+					objects.push({
+						key: getRelativeKey(key),
+						lastModifiedAt: blob.uploadedAt,
+						size: blob.size,
+						storageUri
+					});
+				}
+				cursor = page.hasMore ? page.cursor : void 0;
+			} while (cursor !== void 0);
+			return objects;
+		},
+		async deleteObjects(relativeKeys) {
+			const pathnames = relativeKeys.map((key) => toPathname(getStorageKey(key)));
+			for (let offset = 0; offset < pathnames.length; offset += DELETE_BATCH_SIZE) await del(pathnames.slice(offset, offset + DELETE_BATCH_SIZE), { token });
+		}
+	});
+};
+//#endregion
+export { vercelBlobStorage };