@hot-updater/aws 0.31.4 → 0.33.0

package/dist/iac/index.cjs

@@ -6,7 +6,7 @@ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __commonJSMin = (cb, mod) => () => (mod || (cb((mod = { exports: {} }).exports, mod), cb = null), mod.exports);
+var __commonJSMin = (cb, mod) => () => (mod || cb((mod = { exports: {} }).exports, mod), mod.exports);
 var __copyProps = (to, from, except, desc) => {
 	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
 		key = keys[i];
@@ -29,13 +29,13 @@ let node_child_process = require("node:child_process");
 let node_string_decoder = require("node:string_decoder");
 let node_util = require("node:util");
 let node_process = require("node:process");
-node_process = __toESM(node_process, 1);
+node_process = __toESM(node_process);
 let node_tty = require("node:tty");
-node_tty = __toESM(node_tty, 1);
+node_tty = __toESM(node_tty);
 let node_path = require("node:path");
-node_path = __toESM(node_path, 1);
+node_path = __toESM(node_path);
 let path = require("path");
-path = __toESM(path, 1);
+path = __toESM(path);
 let node_timers_promises = require("node:timers/promises");
 let node_os = require("node:os");
 let node_events = require("node:events");
@@ -45,12 +45,12 @@ let node_stream_promises = require("node:stream/promises");
 let node_stream = require("node:stream");
 let node_buffer = require("node:buffer");
 let crypto = require("crypto");
-crypto = __toESM(crypto, 1);
+crypto = __toESM(crypto);
 let _aws_sdk_client_cloudfront = require("@aws-sdk/client-cloudfront");
 let _aws_sdk_client_iam = require("@aws-sdk/client-iam");
 let _aws_sdk_client_sts = require("@aws-sdk/client-sts");
 let fs_promises = require("fs/promises");
-fs_promises = __toESM(fs_promises, 1);
+fs_promises = __toESM(fs_promises);
 let _aws_sdk_client_lambda = require("@aws-sdk/client-lambda");
 let _aws_sdk_client_s3 = require("@aws-sdk/client-s3");
 let _aws_sdk_lib_storage = require("@aws-sdk/lib-storage");

package/dist/iac/index.mjs

@@ -33,7 +33,7 @@ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __commonJSMin = (cb, mod) => () => (mod || (cb((mod = { exports: {} }).exports, mod), cb = null), mod.exports);
+var __commonJSMin = (cb, mod) => () => (mod || cb((mod = { exports: {} }).exports, mod), mod.exports);
 var __copyProps = (to, from, except, desc) => {
 	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
 		key = keys[i];

package/dist/index.cjs

@@ -26,9 +26,9 @@ let _aws_sdk_client_s3 = require("@aws-sdk/client-s3");
 let _aws_sdk_lib_storage = require("@aws-sdk/lib-storage");
 let _hot_updater_plugin_core = require("@hot-updater/plugin-core");
 let fs_promises = require("fs/promises");
-fs_promises = __toESM(fs_promises, 1);
+fs_promises = __toESM(fs_promises);
 let path = require("path");
-path = __toESM(path, 1);
+path = __toESM(path);
 let _aws_sdk_s3_request_presigner = require("@aws-sdk/s3-request-presigner");
 let _aws_sdk_client_ssm = require("@aws-sdk/client-ssm");
 let _aws_sdk_cloudfront_signer = require("@aws-sdk/cloudfront-signer");
@@ -1412,6 +1412,37 @@ const streamToString = (stream) => {
 const DEFAULT_INVALIDATION_POLL_INTERVAL_MS = 2e3;
 const DEFAULT_INVALIDATION_TIMEOUT_MS = 300 * 1e3;
 const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+const getS3ErrorProperty = (error, key) => {
+	if (typeof error !== "object" || error === null) return;
+	const value = error[key];
+	return typeof value === "string" ? value : void 0;
+};
+const isArchivedS3ObjectError = (error) => {
+	if (!(error instanceof Error)) return false;
+	return error.name === "InvalidObjectState" || getS3ErrorProperty(error, "Code") === "InvalidObjectState";
+};
+const createArchivedS3ObjectError = ({ bucket, key, error }) => {
+	const storageClass = getS3ErrorProperty(error, "StorageClass") ?? "archived storage";
+	const nextError = new Error(`S3 object "${key}" in bucket "${bucket}" is archived (${storageClass}) and cannot be read. Restore the object in S3 or exclude Hot Updater metadata from lifecycle archival: "_index/**", "**/target-app-versions.json", and "**/update.json".`, { cause: error });
+	nextError.name = "S3ArchivedObjectError";
+	return nextError;
+};
+function normalizeBasePath(basePath) {
+	return basePath?.replace(/^\/+|\/+$/g, "") ?? "";
+}
+function createDatabaseKeyBuilder(basePath) {
+	const normalizedBasePath = normalizeBasePath(basePath);
+	const toStorageKey = (key) => [normalizedBasePath, key].filter(Boolean).join("/");
+	const fromStorageKey = (key) => {
+		if (!normalizedBasePath) return key;
+		const prefix = `${normalizedBasePath}/`;
+		return key.startsWith(prefix) ? key.slice(prefix.length) : key;
+	};
+	return {
+		fromStorageKey,
+		toStorageKey
+	};
+}
 /**
 * Loads JSON data from S3.
 * Returns null if NoSuchKey error occurs.
@@ -1427,6 +1458,11 @@ async function loadJsonFromS3(client, bucket, key) {
 		return JSON.parse(bodyContents);
 	} catch (e) {
 		if (e instanceof _aws_sdk_client_s3.NoSuchKey) return null;
+		if (isArchivedS3ObjectError(e)) throw createArchivedS3ObjectError({
+			bucket,
+			key,
+			error: e
+		});
 		throw e;
 	}
 }
@@ -1510,18 +1546,20 @@ async function invalidateCloudFront(client, distributionId, paths, options) {
 const s3Database = (0, _hot_updater_plugin_core.createBlobDatabasePlugin)({
 	name: "s3Database",
 	factory: (config) => {
-		const { bucketName, cloudfrontDistributionId, apiBasePath = "/api/check-update", shouldWaitForInvalidation = false, ...s3Config } = config;
+		const { basePath, bucketName, cloudfrontDistributionId, apiBasePath = "/api/check-update", shouldWaitForInvalidation = false, ...s3Config } = config;
 		const client = new _aws_sdk_client_s3.S3Client(applyS3RuntimeAwsConfig(s3Config));
+		const { fromStorageKey, toStorageKey } = createDatabaseKeyBuilder(basePath);
 		const cloudfrontClient = cloudfrontDistributionId ? new _aws_sdk_client_cloudfront.CloudFrontClient({
 			credentials: s3Config.credentials,
 			region: s3Config.region
 		}) : void 0;
 		return {
 			apiBasePath,
-			listObjects: (prefix) => listObjectsInS3(client, bucketName, prefix),
-			loadObject: (key) => loadJsonFromS3(client, bucketName, key),
-			uploadObject: (key, data) => uploadJsonToS3(client, bucketName, key, data),
-			deleteObject: (key) => deleteObjectInS3(client, bucketName, key),
+			listObjects: (prefix) => listObjectsInS3(client, bucketName, toStorageKey(prefix)).then((keys) => keys.map(fromStorageKey)),
+			loadObject: (key) => loadJsonFromS3(client, bucketName, toStorageKey(key)),
+			uploadObject: (key, data) => uploadJsonToS3(client, bucketName, toStorageKey(key), data),
+			deleteObject: (key) => deleteObjectInS3(client, bucketName, toStorageKey(key)),
+			shouldSkipLoadObjectError: (error) => error instanceof Error && error.name === "S3ArchivedObjectError",
 			invalidatePaths: (pathsToInvalidate) => {
 				if (cloudfrontClient && cloudfrontDistributionId && pathsToInvalidate.length > 0) return invalidateCloudFront(cloudfrontClient, cloudfrontDistributionId, pathsToInvalidate, { shouldWaitForInvalidation });
 				return Promise.resolve();
@@ -1578,6 +1616,20 @@ const s3Storage = (0, _hot_updater_plugin_core.createUniversalStoragePlugin)({
 					if (!response.Bucket || !response.Key) throw new Error("Upload Failed");
 					return { storageUri: `s3://${bucketName}/${Key}` };
 				},
+				async exists(storageUri) {
+					const { bucket, key } = (0, _hot_updater_plugin_core.parseStorageUri)(storageUri, "s3");
+					if (bucket !== bucketName) throw new Error(`Bucket name mismatch: expected "${bucketName}", but found "${bucket}".`);
+					try {
+						await client.send(new _aws_sdk_client_s3.HeadObjectCommand({
+							Bucket: bucketName,
+							Key: key
+						}));
+						return true;
+					} catch (error) {
+						if (error instanceof Error && (error.name === "NotFound" || error.name === "NoSuchKey")) return false;
+						throw error;
+					}
+				},
 				async downloadFile(storageUri, filePath) {
 					const { bucket, key } = (0, _hot_updater_plugin_core.parseStorageUri)(storageUri, "s3");
 					if (bucket !== bucketName) throw new Error(`Bucket name mismatch: expected "${bucketName}", but found "${bucket}".`);

package/dist/index.d.cts

@@ -1,9 +1,14 @@
-import { S3ClientConfig } from "@aws-sdk/client-s3";
+import * as _$_hot_updater_plugin_core0 from "@hot-updater/plugin-core";
 import { BlobDatabasePluginConfig, RuntimeStoragePlugin, StoragePluginHooks, StorageResolveContext } from "@hot-updater/plugin-core";
+import { S3ClientConfig } from "@aws-sdk/client-s3";
 
 //#region src/s3Database.d.ts
 interface S3DatabaseConfig extends S3ClientConfig, BlobDatabasePluginConfig {
   bucketName: string;
+  /**
+   * Base path where database objects will be stored in the bucket.
+   */
+  basePath?: string;
   /**
    * CloudFront distribution ID used for cache invalidation.
    *
@@ -21,7 +26,7 @@ interface S3DatabaseConfig extends S3ClientConfig, BlobDatabasePluginConfig {
   shouldWaitForInvalidation?: boolean;
   apiBasePath?: string;
 }
-declare const s3Database: (config: S3DatabaseConfig, hooks?: import("@hot-updater/plugin-core").DatabasePluginHooks) => () => import("@hot-updater/plugin-core").DatabasePlugin<unknown>;
+declare const s3Database: (config: S3DatabaseConfig, hooks?: _$_hot_updater_plugin_core0.DatabasePluginHooks) => () => _$_hot_updater_plugin_core0.DatabasePlugin<unknown>;
 //#endregion
 //#region src/s3Storage.d.ts
 interface S3StorageConfig extends S3ClientConfig {
@@ -31,7 +36,7 @@ interface S3StorageConfig extends S3ClientConfig {
    */
   basePath?: string;
 }
-declare const s3Storage: (config: S3StorageConfig, hooks?: import("@hot-updater/plugin-core").StoragePluginHooks) => () => import("@hot-updater/plugin-core").UniversalStoragePlugin<unknown>;
+declare const s3Storage: (config: S3StorageConfig, hooks?: _$_hot_updater_plugin_core0.StoragePluginHooks) => () => _$_hot_updater_plugin_core0.UniversalStoragePlugin<unknown>;
 //#endregion
 //#region src/withCloudFrontSignedUrl.d.ts
 interface CloudFrontPrivateKeyFromGetter {
@@ -55,7 +60,7 @@ declare const withCloudFrontSignedUrl: <TContext = unknown, TStorage extends Run
 //#endregion
 //#region src/s3LambdaEdgeStorage.d.ts
 type AwsLambdaEdgeStorageConfig = S3StorageConfig & WithCloudFrontSignedUrlOptions;
-declare const awsLambdaEdgeStorage: (config: AwsLambdaEdgeStorageConfig, hooks?: StoragePluginHooks) => () => import("@hot-updater/plugin-core").UniversalStoragePlugin<unknown>;
-declare const s3LambdaEdgeStorage: (config: AwsLambdaEdgeStorageConfig, hooks?: StoragePluginHooks) => () => import("@hot-updater/plugin-core").UniversalStoragePlugin<unknown>;
+declare const awsLambdaEdgeStorage: (config: AwsLambdaEdgeStorageConfig, hooks?: StoragePluginHooks) => () => _$_hot_updater_plugin_core0.UniversalStoragePlugin<unknown>;
+declare const s3LambdaEdgeStorage: (config: AwsLambdaEdgeStorageConfig, hooks?: StoragePluginHooks) => () => _$_hot_updater_plugin_core0.UniversalStoragePlugin<unknown>;
 //#endregion
 export { AwsLambdaEdgeStorageConfig, CloudFrontSignedUrlConfig, PublicBaseUrlResolver, S3DatabaseConfig, S3StorageConfig, WithCloudFrontSignedUrlOptions, awsLambdaEdgeStorage, s3Database, s3LambdaEdgeStorage, s3Storage, withCloudFrontSignedUrl };

package/dist/index.d.mts

@@ -1,9 +1,14 @@
 import { S3ClientConfig } from "@aws-sdk/client-s3";
+import * as _$_hot_updater_plugin_core0 from "@hot-updater/plugin-core";
 import { BlobDatabasePluginConfig, RuntimeStoragePlugin, StoragePluginHooks, StorageResolveContext } from "@hot-updater/plugin-core";
 
 //#region src/s3Database.d.ts
 interface S3DatabaseConfig extends S3ClientConfig, BlobDatabasePluginConfig {
   bucketName: string;
+  /**
+   * Base path where database objects will be stored in the bucket.
+   */
+  basePath?: string;
   /**
    * CloudFront distribution ID used for cache invalidation.
    *
@@ -21,7 +26,7 @@ interface S3DatabaseConfig extends S3ClientConfig, BlobDatabasePluginConfig {
   shouldWaitForInvalidation?: boolean;
   apiBasePath?: string;
 }
-declare const s3Database: (config: S3DatabaseConfig, hooks?: import("@hot-updater/plugin-core").DatabasePluginHooks) => () => import("@hot-updater/plugin-core").DatabasePlugin<unknown>;
+declare const s3Database: (config: S3DatabaseConfig, hooks?: _$_hot_updater_plugin_core0.DatabasePluginHooks) => () => _$_hot_updater_plugin_core0.DatabasePlugin<unknown>;
 //#endregion
 //#region src/s3Storage.d.ts
 interface S3StorageConfig extends S3ClientConfig {
@@ -31,7 +36,7 @@ interface S3StorageConfig extends S3ClientConfig {
    */
   basePath?: string;
 }
-declare const s3Storage: (config: S3StorageConfig, hooks?: import("@hot-updater/plugin-core").StoragePluginHooks) => () => import("@hot-updater/plugin-core").UniversalStoragePlugin<unknown>;
+declare const s3Storage: (config: S3StorageConfig, hooks?: _$_hot_updater_plugin_core0.StoragePluginHooks) => () => _$_hot_updater_plugin_core0.UniversalStoragePlugin<unknown>;
 //#endregion
 //#region src/withCloudFrontSignedUrl.d.ts
 interface CloudFrontPrivateKeyFromGetter {
@@ -55,7 +60,7 @@ declare const withCloudFrontSignedUrl: <TContext = unknown, TStorage extends Run
 //#endregion
 //#region src/s3LambdaEdgeStorage.d.ts
 type AwsLambdaEdgeStorageConfig = S3StorageConfig & WithCloudFrontSignedUrlOptions;
-declare const awsLambdaEdgeStorage: (config: AwsLambdaEdgeStorageConfig, hooks?: StoragePluginHooks) => () => import("@hot-updater/plugin-core").UniversalStoragePlugin<unknown>;
-declare const s3LambdaEdgeStorage: (config: AwsLambdaEdgeStorageConfig, hooks?: StoragePluginHooks) => () => import("@hot-updater/plugin-core").UniversalStoragePlugin<unknown>;
+declare const awsLambdaEdgeStorage: (config: AwsLambdaEdgeStorageConfig, hooks?: StoragePluginHooks) => () => _$_hot_updater_plugin_core0.UniversalStoragePlugin<unknown>;
+declare const s3LambdaEdgeStorage: (config: AwsLambdaEdgeStorageConfig, hooks?: StoragePluginHooks) => () => _$_hot_updater_plugin_core0.UniversalStoragePlugin<unknown>;
 //#endregion
 export { AwsLambdaEdgeStorageConfig, CloudFrontSignedUrlConfig, PublicBaseUrlResolver, S3DatabaseConfig, S3StorageConfig, WithCloudFrontSignedUrlOptions, awsLambdaEdgeStorage, s3Database, s3LambdaEdgeStorage, s3Storage, withCloudFrontSignedUrl };

package/dist/index.mjs

@@ -1,5 +1,5 @@
 import { CloudFrontClient, CreateInvalidationCommand, GetInvalidationCommand } from "@aws-sdk/client-cloudfront";
-import { DeleteObjectCommand, DeleteObjectsCommand, GetObjectCommand, ListObjectsV2Command, NoSuchKey, S3Client } from "@aws-sdk/client-s3";
+import { DeleteObjectCommand, DeleteObjectsCommand, GetObjectCommand, HeadObjectCommand, ListObjectsV2Command, NoSuchKey, S3Client } from "@aws-sdk/client-s3";
 import { Upload } from "@aws-sdk/lib-storage";
 import { createBlobDatabasePlugin, createStorageKeyBuilder, createUniversalStoragePlugin, getContentType, parseStorageUri } from "@hot-updater/plugin-core";
 import fs from "fs/promises";
@@ -1387,6 +1387,37 @@ const streamToString = (stream) => {
 const DEFAULT_INVALIDATION_POLL_INTERVAL_MS = 2e3;
 const DEFAULT_INVALIDATION_TIMEOUT_MS = 300 * 1e3;
 const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+const getS3ErrorProperty = (error, key) => {
+	if (typeof error !== "object" || error === null) return;
+	const value = error[key];
+	return typeof value === "string" ? value : void 0;
+};
+const isArchivedS3ObjectError = (error) => {
+	if (!(error instanceof Error)) return false;
+	return error.name === "InvalidObjectState" || getS3ErrorProperty(error, "Code") === "InvalidObjectState";
+};
+const createArchivedS3ObjectError = ({ bucket, key, error }) => {
+	const storageClass = getS3ErrorProperty(error, "StorageClass") ?? "archived storage";
+	const nextError = new Error(`S3 object "${key}" in bucket "${bucket}" is archived (${storageClass}) and cannot be read. Restore the object in S3 or exclude Hot Updater metadata from lifecycle archival: "_index/**", "**/target-app-versions.json", and "**/update.json".`, { cause: error });
+	nextError.name = "S3ArchivedObjectError";
+	return nextError;
+};
+function normalizeBasePath(basePath) {
+	return basePath?.replace(/^\/+|\/+$/g, "") ?? "";
+}
+function createDatabaseKeyBuilder(basePath) {
+	const normalizedBasePath = normalizeBasePath(basePath);
+	const toStorageKey = (key) => [normalizedBasePath, key].filter(Boolean).join("/");
+	const fromStorageKey = (key) => {
+		if (!normalizedBasePath) return key;
+		const prefix = `${normalizedBasePath}/`;
+		return key.startsWith(prefix) ? key.slice(prefix.length) : key;
+	};
+	return {
+		fromStorageKey,
+		toStorageKey
+	};
+}
 /**
 * Loads JSON data from S3.
 * Returns null if NoSuchKey error occurs.
@@ -1402,6 +1433,11 @@ async function loadJsonFromS3(client, bucket, key) {
 		return JSON.parse(bodyContents);
 	} catch (e) {
 		if (e instanceof NoSuchKey) return null;
+		if (isArchivedS3ObjectError(e)) throw createArchivedS3ObjectError({
+			bucket,
+			key,
+			error: e
+		});
 		throw e;
 	}
 }
@@ -1485,18 +1521,20 @@ async function invalidateCloudFront(client, distributionId, paths, options) {
 const s3Database = createBlobDatabasePlugin({
 	name: "s3Database",
 	factory: (config) => {
-		const { bucketName, cloudfrontDistributionId, apiBasePath = "/api/check-update", shouldWaitForInvalidation = false, ...s3Config } = config;
+		const { basePath, bucketName, cloudfrontDistributionId, apiBasePath = "/api/check-update", shouldWaitForInvalidation = false, ...s3Config } = config;
 		const client = new S3Client(applyS3RuntimeAwsConfig(s3Config));
+		const { fromStorageKey, toStorageKey } = createDatabaseKeyBuilder(basePath);
 		const cloudfrontClient = cloudfrontDistributionId ? new CloudFrontClient({
 			credentials: s3Config.credentials,
 			region: s3Config.region
 		}) : void 0;
 		return {
 			apiBasePath,
-			listObjects: (prefix) => listObjectsInS3(client, bucketName, prefix),
-			loadObject: (key) => loadJsonFromS3(client, bucketName, key),
-			uploadObject: (key, data) => uploadJsonToS3(client, bucketName, key, data),
-			deleteObject: (key) => deleteObjectInS3(client, bucketName, key),
+			listObjects: (prefix) => listObjectsInS3(client, bucketName, toStorageKey(prefix)).then((keys) => keys.map(fromStorageKey)),
+			loadObject: (key) => loadJsonFromS3(client, bucketName, toStorageKey(key)),
+			uploadObject: (key, data) => uploadJsonToS3(client, bucketName, toStorageKey(key), data),
+			deleteObject: (key) => deleteObjectInS3(client, bucketName, toStorageKey(key)),
+			shouldSkipLoadObjectError: (error) => error instanceof Error && error.name === "S3ArchivedObjectError",
 			invalidatePaths: (pathsToInvalidate) => {
 				if (cloudfrontClient && cloudfrontDistributionId && pathsToInvalidate.length > 0) return invalidateCloudFront(cloudfrontClient, cloudfrontDistributionId, pathsToInvalidate, { shouldWaitForInvalidation });
 				return Promise.resolve();
@@ -1553,6 +1591,20 @@ const s3Storage = createUniversalStoragePlugin({
 					if (!response.Bucket || !response.Key) throw new Error("Upload Failed");
 					return { storageUri: `s3://${bucketName}/${Key}` };
 				},
+				async exists(storageUri) {
+					const { bucket, key } = parseStorageUri(storageUri, "s3");
+					if (bucket !== bucketName) throw new Error(`Bucket name mismatch: expected "${bucketName}", but found "${bucket}".`);
+					try {
+						await client.send(new HeadObjectCommand({
+							Bucket: bucketName,
+							Key: key
+						}));
+						return true;
+					} catch (error) {
+						if (error instanceof Error && (error.name === "NotFound" || error.name === "NoSuchKey")) return false;
+						throw error;
+					}
+				},
 				async downloadFile(storageUri, filePath) {
 					const { bucket, key } = parseStorageUri(storageUri, "s3");
 					if (bucket !== bucketName) throw new Error(`Bucket name mismatch: expected "${bucketName}", but found "${bucket}".`);