@hot-updater/storage-s3 0.0.0-stage → 1.1.4

package/LICENSE

@@ -0,0 +1,33 @@
+MIT License
+
+Copyright (c) 2023 Sungyu Kang 
+
+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.
+
+---
+
+ADDITIONAL DISCLAIMER
+
+The authors of this software shall not be held responsible for any legal issues,
+regulatory violations, policy violations, or disputes arising from the use,
+distribution, or integration of this software.
+
+Users are solely responsible for ensuring compliance with all applicable laws,
+regulations, and third-party policies (including but not limited to app store
+policies).

package/dist/index.cjs

@@ -0,0 +1,167 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+let _aws_sdk_client_s3 = require("@aws-sdk/client-s3");
+let _aws_sdk_lib_storage = require("@aws-sdk/lib-storage");
+let _aws_sdk_s3_request_presigner = require("@aws-sdk/s3-request-presigner");
+let _hot_updater_plugin_core = require("@hot-updater/plugin-core");
+//#region src/createS3Storage.ts
+/** Devices download right after the update check that returns the URL. */
+const DEFAULT_SIGNED_LIFETIME_SECONDS = 3600;
+/** SigV4's limit on a presigned URL. */
+const MAX_SIGNED_LIFETIME_SECONDS = 604800;
+/** DeleteObjects takes at most 1000 keys a request. */
+const DELETE_BATCH_SIZE = 1e3;
+const isObjectNotFoundError = (error) => {
+	if (error instanceof Error && (error.name === "NotFound" || error.name === "NoSuchKey")) return true;
+	return typeof error === "object" && error !== null && "$metadata" in error && error.$metadata?.httpStatusCode === 404;
+};
+const trimSlashes = (value) => value.replace(/^\/+|\/+$/g, "");
+/**
+* A storage adapter over a bucket's S3 API, which AWS S3, Cloudflare R2, and
+* Neon Object Storage all serve. Each provider package passes its own name,
+* URI protocol, and client defaults.
+*/
+const createS3Storage = ({ name, protocol }, config) => {
+	const { bucketName, basePath, getDownloadUrl, signedUrlExpiresIn = DEFAULT_SIGNED_LIFETIME_SECONDS, ...clientConfig } = config;
+	if (!Number.isFinite(signedUrlExpiresIn) || signedUrlExpiresIn <= 0 || signedUrlExpiresIn > MAX_SIGNED_LIFETIME_SECONDS) throw new Error(`${name} signedUrlExpiresIn must be between 1 and ${MAX_SIGNED_LIFETIME_SECONDS} seconds (seven days).`);
+	const client = new _aws_sdk_client_s3.S3Client(clientConfig);
+	const normalizedBasePath = trimSlashes(basePath ?? "");
+	const getStorageKey = (0, _hot_updater_plugin_core.createStorageKeyBuilder)(normalizedBasePath);
+	const getListPrefix = (prefix = "") => {
+		const value = [normalizedBasePath, trimSlashes(prefix)].filter(Boolean).join("/");
+		return value ? `${value}/` : "";
+	};
+	/**
+	* The URI `put` returns for the key, or null for a key no `put` writes,
+	* such as a folder marker that ends in "/".
+	*/
+	const getListedStorageUri = (key) => {
+		try {
+			return (0, _hot_updater_plugin_core.createStorageUri)({
+				bucket: bucketName,
+				key,
+				protocol
+			});
+		} catch {
+			return null;
+		}
+	};
+	const getRelativeKey = (key) => {
+		if (!normalizedBasePath) return key;
+		const basePrefix = `${normalizedBasePath}/`;
+		return key.startsWith(basePrefix) ? key.slice(basePrefix.length) : key;
+	};
+	const parseAndValidate = (storageUri) => {
+		const parsed = (0, _hot_updater_plugin_core.parseStorageUri)(storageUri, protocol);
+		if (parsed.bucket !== bucketName) throw new Error(`Bucket name mismatch: expected "${bucketName}", but found "${parsed.bucket}".`);
+		return parsed;
+	};
+	return (0, _hot_updater_plugin_core.createStorageAdapter)({
+		name,
+		protocol,
+		async put({ key, body, contentLength, contentType }) {
+			const storageKey = getStorageKey(key);
+			await new _aws_sdk_lib_storage.Upload({
+				client,
+				params: {
+					Body: body,
+					Bucket: bucketName,
+					CacheControl: "max-age=31536000",
+					...contentLength === void 0 ? {} : { ContentLength: contentLength },
+					ContentType: contentType,
+					Key: storageKey
+				}
+			}).done();
+			return { storageUri: (0, _hot_updater_plugin_core.createStorageUri)({
+				bucket: bucketName,
+				key: storageKey,
+				protocol
+			}) };
+		},
+		async get({ storageUri }) {
+			const { key } = parseAndValidate(storageUri);
+			try {
+				const response = await client.send(new _aws_sdk_client_s3.GetObjectCommand({
+					Bucket: bucketName,
+					Key: key
+				}));
+				if (!response.Body) return { response: null };
+				const headers = new Headers();
+				if (response.ContentType) headers.set("content-type", response.ContentType);
+				if (response.ContentLength !== void 0) headers.set("content-length", String(response.ContentLength));
+				return { response: new Response(response.Body.transformToWebStream(), { headers }) };
+			} catch (error) {
+				if (isObjectNotFoundError(error)) return { response: null };
+				throw error;
+			}
+		},
+		async getDownloadUrl({ storageUri }) {
+			const { key } = parseAndValidate(storageUri);
+			if (getDownloadUrl) return getDownloadUrl({ storageUri });
+			return { url: await (0, _aws_sdk_s3_request_presigner.getSignedUrl)(client, new _aws_sdk_client_s3.GetObjectCommand({
+				Bucket: bucketName,
+				Key: key
+			}), { expiresIn: signedUrlExpiresIn }) };
+		},
+		async exists({ storageUri }) {
+			const { key } = parseAndValidate(storageUri);
+			try {
+				await client.send(new _aws_sdk_client_s3.HeadObjectCommand({
+					Bucket: bucketName,
+					Key: key
+				}));
+				return { exists: true };
+			} catch (error) {
+				if (isObjectNotFoundError(error)) return { exists: false };
+				throw error;
+			}
+		},
+		async delete({ storageUri }) {
+			const { key } = parseAndValidate(storageUri);
+			await client.send(new _aws_sdk_client_s3.DeleteObjectCommand({
+				Bucket: bucketName,
+				Key: key
+			}));
+			return { deleted: true };
+		},
+		async listObjects(prefix) {
+			const objects = [];
+			let continuationToken;
+			do {
+				const response = await client.send(new _aws_sdk_client_s3.ListObjectsV2Command({
+					Bucket: bucketName,
+					ContinuationToken: continuationToken,
+					Prefix: getListPrefix(prefix)
+				}));
+				for (const object of response.Contents ?? []) {
+					if (!object.Key) continue;
+					const storageUri = getListedStorageUri(object.Key);
+					if (storageUri === null) continue;
+					objects.push({
+						key: getRelativeKey(object.Key),
+						lastModifiedAt: object.LastModified,
+						size: object.Size ?? 0,
+						storageUri
+					});
+				}
+				continuationToken = response.NextContinuationToken;
+			} while (continuationToken);
+			return objects;
+		},
+		async deleteObjects(relativeKeys) {
+			const keys = relativeKeys.map((key) => getStorageKey(key));
+			for (let offset = 0; offset < keys.length; offset += DELETE_BATCH_SIZE) {
+				const batch = keys.slice(offset, offset + DELETE_BATCH_SIZE);
+				const response = await client.send(new _aws_sdk_client_s3.DeleteObjectsCommand({
+					Bucket: bucketName,
+					Delete: {
+						Objects: batch.map((Key) => ({ Key })),
+						Quiet: true
+					}
+				}));
+				if (response.Errors && response.Errors.length > 0) throw new Error(`Failed to delete ${response.Errors.length} S3 object(s) from bucket "${bucketName}".`);
+			}
+		}
+	});
+};
+//#endregion
+exports.createS3Storage = createS3Storage;

package/dist/index.d.cts

@@ -0,0 +1,34 @@
+import { S3ClientConfig } from "@aws-sdk/client-s3";
+import { StorageAdapter, StorageAdapterWith } from "@hot-updater/plugin-core";
+//#region src/createS3Storage.d.ts
+/** Who the adapter is: its name and the scheme of the URIs it writes. */
+interface S3StorageIdentity {
+  /** The adapter's name, such as `s3Storage`. */
+  name: string;
+  /** The scheme of the storage URIs it writes, such as `s3`. */
+  protocol: string;
+}
+interface S3StorageConfig extends S3ClientConfig {
+  bucketName: string;
+  /** Base path where bundles will be stored in the bucket. */
+  basePath?: string;
+  /**
+   * The URL devices download an object from, such as a CDN's. Without it, a
+   * presigned URL that expires after `signedUrlExpiresIn`.
+   */
+  getDownloadUrl?: StorageAdapter["getDownloadUrl"];
+  /**
+   * Lifetime of the presigned download URLs in seconds, at most seven days,
+   * the SigV4 limit. @default 3600
+   */
+  signedUrlExpiresIn?: number;
+}
+type S3StorageOperations = "put" | "get" | "getDownloadUrl" | "exists" | "delete" | "listObjects" | "deleteObjects";
+/**
+ * A storage adapter over a bucket's S3 API, which AWS S3, Cloudflare R2, and
+ * Neon Object Storage all serve. Each provider package passes its own name,
+ * URI protocol, and client defaults.
+ */
+declare const createS3Storage: ({ name, protocol }: S3StorageIdentity, config: S3StorageConfig) => StorageAdapterWith<S3StorageOperations>;
+//#endregion
+export { type S3ClientConfig, S3StorageConfig, S3StorageIdentity, S3StorageOperations, createS3Storage };

package/dist/index.d.mts

@@ -0,0 +1,34 @@
+import { S3ClientConfig } from "@aws-sdk/client-s3";
+import { StorageAdapter, StorageAdapterWith } from "@hot-updater/plugin-core";
+//#region src/createS3Storage.d.ts
+/** Who the adapter is: its name and the scheme of the URIs it writes. */
+interface S3StorageIdentity {
+  /** The adapter's name, such as `s3Storage`. */
+  name: string;
+  /** The scheme of the storage URIs it writes, such as `s3`. */
+  protocol: string;
+}
+interface S3StorageConfig extends S3ClientConfig {
+  bucketName: string;
+  /** Base path where bundles will be stored in the bucket. */
+  basePath?: string;
+  /**
+   * The URL devices download an object from, such as a CDN's. Without it, a
+   * presigned URL that expires after `signedUrlExpiresIn`.
+   */
+  getDownloadUrl?: StorageAdapter["getDownloadUrl"];
+  /**
+   * Lifetime of the presigned download URLs in seconds, at most seven days,
+   * the SigV4 limit. @default 3600
+   */
+  signedUrlExpiresIn?: number;
+}
+type S3StorageOperations = "put" | "get" | "getDownloadUrl" | "exists" | "delete" | "listObjects" | "deleteObjects";
+/**
+ * A storage adapter over a bucket's S3 API, which AWS S3, Cloudflare R2, and
+ * Neon Object Storage all serve. Each provider package passes its own name,
+ * URI protocol, and client defaults.
+ */
+declare const createS3Storage: ({ name, protocol }: S3StorageIdentity, config: S3StorageConfig) => StorageAdapterWith<S3StorageOperations>;
+//#endregion
+export { type S3ClientConfig, S3StorageConfig, S3StorageIdentity, S3StorageOperations, createS3Storage };

package/dist/index.mjs

@@ -0,0 +1,166 @@
+import { DeleteObjectCommand, DeleteObjectsCommand, GetObjectCommand, HeadObjectCommand, ListObjectsV2Command, S3Client } from "@aws-sdk/client-s3";
+import { Upload } from "@aws-sdk/lib-storage";
+import { getSignedUrl } from "@aws-sdk/s3-request-presigner";
+import { createStorageAdapter, createStorageKeyBuilder, createStorageUri, parseStorageUri } from "@hot-updater/plugin-core";
+//#region src/createS3Storage.ts
+/** Devices download right after the update check that returns the URL. */
+const DEFAULT_SIGNED_LIFETIME_SECONDS = 3600;
+/** SigV4's limit on a presigned URL. */
+const MAX_SIGNED_LIFETIME_SECONDS = 604800;
+/** DeleteObjects takes at most 1000 keys a request. */
+const DELETE_BATCH_SIZE = 1e3;
+const isObjectNotFoundError = (error) => {
+	if (error instanceof Error && (error.name === "NotFound" || error.name === "NoSuchKey")) return true;
+	return typeof error === "object" && error !== null && "$metadata" in error && error.$metadata?.httpStatusCode === 404;
+};
+const trimSlashes = (value) => value.replace(/^\/+|\/+$/g, "");
+/**
+* A storage adapter over a bucket's S3 API, which AWS S3, Cloudflare R2, and
+* Neon Object Storage all serve. Each provider package passes its own name,
+* URI protocol, and client defaults.
+*/
+const createS3Storage = ({ name, protocol }, config) => {
+	const { bucketName, basePath, getDownloadUrl, signedUrlExpiresIn = DEFAULT_SIGNED_LIFETIME_SECONDS, ...clientConfig } = config;
+	if (!Number.isFinite(signedUrlExpiresIn) || signedUrlExpiresIn <= 0 || signedUrlExpiresIn > MAX_SIGNED_LIFETIME_SECONDS) throw new Error(`${name} signedUrlExpiresIn must be between 1 and ${MAX_SIGNED_LIFETIME_SECONDS} seconds (seven days).`);
+	const client = new S3Client(clientConfig);
+	const normalizedBasePath = trimSlashes(basePath ?? "");
+	const getStorageKey = createStorageKeyBuilder(normalizedBasePath);
+	const getListPrefix = (prefix = "") => {
+		const value = [normalizedBasePath, trimSlashes(prefix)].filter(Boolean).join("/");
+		return value ? `${value}/` : "";
+	};
+	/**
+	* The URI `put` returns for the key, or null for a key no `put` writes,
+	* such as a folder marker that ends in "/".
+	*/
+	const getListedStorageUri = (key) => {
+		try {
+			return createStorageUri({
+				bucket: bucketName,
+				key,
+				protocol
+			});
+		} catch {
+			return null;
+		}
+	};
+	const getRelativeKey = (key) => {
+		if (!normalizedBasePath) return key;
+		const basePrefix = `${normalizedBasePath}/`;
+		return key.startsWith(basePrefix) ? key.slice(basePrefix.length) : key;
+	};
+	const parseAndValidate = (storageUri) => {
+		const parsed = parseStorageUri(storageUri, protocol);
+		if (parsed.bucket !== bucketName) throw new Error(`Bucket name mismatch: expected "${bucketName}", but found "${parsed.bucket}".`);
+		return parsed;
+	};
+	return createStorageAdapter({
+		name,
+		protocol,
+		async put({ key, body, contentLength, contentType }) {
+			const storageKey = getStorageKey(key);
+			await new Upload({
+				client,
+				params: {
+					Body: body,
+					Bucket: bucketName,
+					CacheControl: "max-age=31536000",
+					...contentLength === void 0 ? {} : { ContentLength: contentLength },
+					ContentType: contentType,
+					Key: storageKey
+				}
+			}).done();
+			return { storageUri: createStorageUri({
+				bucket: bucketName,
+				key: storageKey,
+				protocol
+			}) };
+		},
+		async get({ storageUri }) {
+			const { key } = parseAndValidate(storageUri);
+			try {
+				const response = await client.send(new GetObjectCommand({
+					Bucket: bucketName,
+					Key: key
+				}));
+				if (!response.Body) return { response: null };
+				const headers = new Headers();
+				if (response.ContentType) headers.set("content-type", response.ContentType);
+				if (response.ContentLength !== void 0) headers.set("content-length", String(response.ContentLength));
+				return { response: new Response(response.Body.transformToWebStream(), { headers }) };
+			} catch (error) {
+				if (isObjectNotFoundError(error)) return { response: null };
+				throw error;
+			}
+		},
+		async getDownloadUrl({ storageUri }) {
+			const { key } = parseAndValidate(storageUri);
+			if (getDownloadUrl) return getDownloadUrl({ storageUri });
+			return { url: await getSignedUrl(client, new GetObjectCommand({
+				Bucket: bucketName,
+				Key: key
+			}), { expiresIn: signedUrlExpiresIn }) };
+		},
+		async exists({ storageUri }) {
+			const { key } = parseAndValidate(storageUri);
+			try {
+				await client.send(new HeadObjectCommand({
+					Bucket: bucketName,
+					Key: key
+				}));
+				return { exists: true };
+			} catch (error) {
+				if (isObjectNotFoundError(error)) return { exists: false };
+				throw error;
+			}
+		},
+		async delete({ storageUri }) {
+			const { key } = parseAndValidate(storageUri);
+			await client.send(new DeleteObjectCommand({
+				Bucket: bucketName,
+				Key: key
+			}));
+			return { deleted: true };
+		},
+		async listObjects(prefix) {
+			const objects = [];
+			let continuationToken;
+			do {
+				const response = await client.send(new ListObjectsV2Command({
+					Bucket: bucketName,
+					ContinuationToken: continuationToken,
+					Prefix: getListPrefix(prefix)
+				}));
+				for (const object of response.Contents ?? []) {
+					if (!object.Key) continue;
+					const storageUri = getListedStorageUri(object.Key);
+					if (storageUri === null) continue;
+					objects.push({
+						key: getRelativeKey(object.Key),
+						lastModifiedAt: object.LastModified,
+						size: object.Size ?? 0,
+						storageUri
+					});
+				}
+				continuationToken = response.NextContinuationToken;
+			} while (continuationToken);
+			return objects;
+		},
+		async deleteObjects(relativeKeys) {
+			const keys = relativeKeys.map((key) => getStorageKey(key));
+			for (let offset = 0; offset < keys.length; offset += DELETE_BATCH_SIZE) {
+				const batch = keys.slice(offset, offset + DELETE_BATCH_SIZE);
+				const response = await client.send(new DeleteObjectsCommand({
+					Bucket: bucketName,
+					Delete: {
+						Objects: batch.map((Key) => ({ Key })),
+						Quiet: true
+					}
+				}));
+				if (response.Errors && response.Errors.length > 0) throw new Error(`Failed to delete ${response.Errors.length} S3 object(s) from bucket "${bucketName}".`);
+			}
+		}
+	});
+};
+//#endregion
+export { createS3Storage };

package/package.json

@@ -1,6 +1,49 @@
 {
   "name": "@hot-updater/storage-s3",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "type": "module",
+  "version": "1.1.4",
+  "description": "React Native OTA solution for self-hosted",
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.cts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/gronxb/hot-updater"
+  },
+  "author": "gronxb <gron1gh1@gmail.com> (https://github.com/gronxb)",
+  "bugs": {
+    "url": "https://github.com/gronxb/hot-updater/issues"
+  },
+  "homepage": "https://github.com/gronxb/hot-updater#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "!**/*.spec.ts",
+    "package.json"
+  ],
+  "dependencies": {
+    "@aws-sdk/client-s3": "3.1066.0",
+    "@aws-sdk/lib-storage": "3.1066.0",
+    "@aws-sdk/s3-request-presigner": "3.1066.0",
+    "@hot-updater/plugin-core": "1.1.4"
+  },
+  "devDependencies": {
+    "@types/node": "^20",
+    "vitest": "4.1.4",
+    "@hot-updater/test-utils": "1.1.4"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "test:type": "tsc --noEmit"
+  }
 }

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.