@hot-updater/plugin-core 0.20.14 → 0.21.0

package/dist/index.d.cts

@@ -170,11 +170,17 @@ interface NativeBuildArgs {
   };
 }
 interface StoragePlugin {
-  uploadBundle: (bundleId: string, bundlePath: string) => Promise<{
+  /**
+   * Protocol this storage plugin can resolve.
+   * @example "s3", "r2", "supabase-storage".
+   */
+  supportedProtocol: string;
+  upload: (key: string, filePath: string) => Promise<{
     storageUri: string;
   }>;
-  deleteBundle: (bundleId: string) => Promise<{
-    storageUri: string;
+  delete: (storageUri: string) => Promise<void>;
+  getDownloadUrl: (storageUri: string) => Promise<{
+    fileUrl: string;
   }>;
   name: string;
 }
@@ -200,6 +206,18 @@ type ConfigInput = {
    * @default "appVersion"
    */
   updateStrategy: "fingerprint" | "appVersion";
+  /**
+   * The compression strategy used for bundle deployment.
+   *
+   * - `zip`: Standard ZIP compression (default). Fast and widely supported.
+   * - `tar.br`: TAR archive with Brotli compression. Highest compression ratio, smaller bundle size.
+   * - `tar.gz`: TAR archive with Gzip compression. Balanced speed and compression ratio.
+   *
+   * The compression format is determined by the storage plugin used for bundle upload.
+   *
+   * @default "zip"
+   */
+  compressStrategy?: "zip" | "tar.br" | "tar.gz";
   /**
    * The fingerprint configuration.
    */
@@ -251,6 +269,38 @@ interface PaginatedResult {
  */
 declare function calculatePagination(total: number, options: PaginationOptions): PaginationInfo;
 //#endregion
+//#region src/compressionFormat.d.ts
+/**
+ * Compression format type definition
+ */
+type CompressionFormat = "zip" | "tar.br" | "tar.gz";
+/**
+ * Compression format metadata
+ */
+interface CompressionFormatInfo {
+  format: CompressionFormat;
+  fileExtension: string;
+  mimeType?: string;
+}
+/**
+ * Detects compression format from filename
+ * @param filename The filename to detect format from
+ * @returns Compression format information
+ */
+declare function detectCompressionFormat(filename: string): CompressionFormatInfo;
+/**
+ * Gets MIME type for a filename
+ * @param filename The filename to get MIME type for
+ * @returns MIME type string
+ */
+declare function getCompressionMimeType(filename: string): string | undefined;
+/**
+ * Gets Content-Type for a bundle file with 3-tier fallback
+ * @param bundlePath The bundle file path
+ * @returns Content-Type string (never undefined, falls back to application/octet-stream)
+ */
+declare function getContentType(bundlePath: string): string;
+//#endregion
 //#region src/copyDirToTmp.d.ts
 declare const copyDirToTmp: (dir: string, childDirname?: string) => Promise<{
   tmpDir: string;
@@ -358,6 +408,48 @@ declare function createDatabasePlugin<TContext = object>(name: string, abstractP
 //#region src/createStorageKeyBuilder.d.ts
 declare const createStorageKeyBuilder: (basePath: string | undefined) => (...args: string[]) => string;
 //#endregion
+//#region src/createTarBr.d.ts
+declare const createTarBrTargetFiles: ({
+  outfile,
+  targetFiles
+}: {
+  targetFiles: {
+    path: string;
+    name: string;
+  }[];
+  outfile: string;
+}) => Promise<string>;
+declare const createTarBr: ({
+  outfile,
+  targetDir,
+  excludeExts
+}: {
+  targetDir: string;
+  outfile: string;
+  excludeExts?: string[];
+}) => Promise<string>;
+//#endregion
+//#region src/createTarGz.d.ts
+declare const createTarGzTargetFiles: ({
+  outfile,
+  targetFiles
+}: {
+  targetFiles: {
+    path: string;
+    name: string;
+  }[];
+  outfile: string;
+}) => Promise<string>;
+declare const createTarGz: ({
+  outfile,
+  targetDir,
+  excludeExts
+}: {
+  targetDir: string;
+  outfile: string;
+  excludeExts?: string[];
+}) => Promise<string>;
+//#endregion
 //#region src/createZip.d.ts
 declare const createZipTargetFiles: ({
   outfile,
@@ -382,6 +474,17 @@ declare const createZip: ({
 //#region src/cwd.d.ts
 declare const getCwd: () => string;
 //#endregion
+//#region src/filterCompatibleAppVersions.d.ts
+/**
+ * Filters target app versions that are compatible with the current app version.
+ * Returns only versions that are compatible with the current version according to semver rules.
+ *
+ * @param targetAppVersionList - List of target app versions to filter
+ * @param currentVersion - Current app version
+ * @returns Array of target app versions compatible with the current version
+ */
+declare const filterCompatibleAppVersions: (targetAppVersionList: string[], currentVersion: string) => string[];
+//#endregion
 //#region src/generateMinBundleId.d.ts
 declare const generateMinBundleId: () => string;
 //#endregion
@@ -411,6 +514,32 @@ type EnvVarValue = string | {
 };
 declare const makeEnv: (newEnvVars: Record<string, EnvVarValue>, filePath?: string) => Promise<string>;
 //#endregion
+//#region src/parseStorageUri.d.ts
+interface ParsedStorageUri {
+  protocol: string;
+  bucket: string;
+  key: string;
+}
+/**
+ * Parses a storage URI and validates the protocol.
+ *
+ * @param storageUri - The storage URI to parse (e.g., "s3://bucket/path/to/file")
+ * @param expectedProtocol - The expected protocol without colon (e.g., "s3", "r2", "gs")
+ * @returns Parsed storage URI components
+ * @throws Error if the URI is invalid or protocol doesn't match
+ *
+ * @example
+ * ```typescript
+ * const { bucket, key } = parseStorageUri("s3://my-bucket/path/to/file.zip", "s3");
+ * // bucket: "my-bucket"
+ * // key: "path/to/file.zip"
+ * ```
+ */
+declare function parseStorageUri(storageUri: string, expectedProtocol: string): ParsedStorageUri;
+//#endregion
+//#region src/semverSatisfies.d.ts
+declare const semverSatisfies: (targetAppVersion: string, currentVersion: string) => boolean;
+//#endregion
 //#region src/transformEnv.d.ts
 declare const transformEnv: <T extends Record<string, string>>(filename: string, env: T) => string;
 //#endregion
@@ -428,4 +557,4 @@ type TransformTemplateArgs<T extends string> = { [Key in ExtractPlaceholders<T>]
  */
 declare function transformTemplate<T extends string>(templateString: T, values: TransformTemplateArgs<T>): string;
 //#endregion
-export { AbstractDatabasePlugin, BaseDatabaseUtils, BasePluginArgs, BuildPlugin, BuildPluginConfig, BuildType, BuiltIns, type Bundle, ConfigBuilder, ConfigInput, ConfigResponse, DatabasePlugin, DatabasePluginHooks, HasMultipleCallSignatures, HotUpdaterConfigOptions, IConfigBuilder, ImportInfo, NativeBuildArgs, PaginatedResult, PaginationInfo, PaginationOptions, type Platform, PlatformConfig, Primitive, ProviderConfig, RequiredDeep, StoragePlugin, StoragePluginHooks, banner, calculatePagination, copyDirToTmp, createBlobDatabasePlugin, createDatabasePlugin, createStorageKeyBuilder, createZip, createZipTargetFiles, generateMinBundleId, getCwd, link, loadConfig, loadConfigSync, log, makeEnv, printBanner, transformEnv, transformTemplate };
+export { AbstractDatabasePlugin, BaseDatabaseUtils, BasePluginArgs, BuildPlugin, BuildPluginConfig, BuildType, BuiltIns, type Bundle, CompressionFormat, CompressionFormatInfo, ConfigBuilder, ConfigInput, ConfigResponse, DatabasePlugin, DatabasePluginHooks, HasMultipleCallSignatures, HotUpdaterConfigOptions, IConfigBuilder, ImportInfo, NativeBuildArgs, PaginatedResult, PaginationInfo, PaginationOptions, ParsedStorageUri, type Platform, PlatformConfig, Primitive, ProviderConfig, RequiredDeep, StoragePlugin, StoragePluginHooks, banner, calculatePagination, copyDirToTmp, createBlobDatabasePlugin, createDatabasePlugin, createStorageKeyBuilder, createTarBr, createTarBrTargetFiles, createTarGz, createTarGzTargetFiles, createZip, createZipTargetFiles, detectCompressionFormat, filterCompatibleAppVersions, generateMinBundleId, getCompressionMimeType, getContentType, getCwd, link, loadConfig, loadConfigSync, log, makeEnv, parseStorageUri, printBanner, semverSatisfies, transformEnv, transformTemplate };

package/dist/index.d.ts

@@ -170,11 +170,17 @@ interface NativeBuildArgs {
   };
 }
 interface StoragePlugin {
-  uploadBundle: (bundleId: string, bundlePath: string) => Promise<{
+  /**
+   * Protocol this storage plugin can resolve.
+   * @example "s3", "r2", "supabase-storage".
+   */
+  supportedProtocol: string;
+  upload: (key: string, filePath: string) => Promise<{
     storageUri: string;
   }>;
-  deleteBundle: (bundleId: string) => Promise<{
-    storageUri: string;
+  delete: (storageUri: string) => Promise<void>;
+  getDownloadUrl: (storageUri: string) => Promise<{
+    fileUrl: string;
   }>;
   name: string;
 }
@@ -200,6 +206,18 @@ type ConfigInput = {
    * @default "appVersion"
    */
   updateStrategy: "fingerprint" | "appVersion";
+  /**
+   * The compression strategy used for bundle deployment.
+   *
+   * - `zip`: Standard ZIP compression (default). Fast and widely supported.
+   * - `tar.br`: TAR archive with Brotli compression. Highest compression ratio, smaller bundle size.
+   * - `tar.gz`: TAR archive with Gzip compression. Balanced speed and compression ratio.
+   *
+   * The compression format is determined by the storage plugin used for bundle upload.
+   *
+   * @default "zip"
+   */
+  compressStrategy?: "zip" | "tar.br" | "tar.gz";
   /**
    * The fingerprint configuration.
    */
@@ -251,6 +269,38 @@ interface PaginatedResult {
  */
 declare function calculatePagination(total: number, options: PaginationOptions): PaginationInfo;
 //#endregion
+//#region src/compressionFormat.d.ts
+/**
+ * Compression format type definition
+ */
+type CompressionFormat = "zip" | "tar.br" | "tar.gz";
+/**
+ * Compression format metadata
+ */
+interface CompressionFormatInfo {
+  format: CompressionFormat;
+  fileExtension: string;
+  mimeType?: string;
+}
+/**
+ * Detects compression format from filename
+ * @param filename The filename to detect format from
+ * @returns Compression format information
+ */
+declare function detectCompressionFormat(filename: string): CompressionFormatInfo;
+/**
+ * Gets MIME type for a filename
+ * @param filename The filename to get MIME type for
+ * @returns MIME type string
+ */
+declare function getCompressionMimeType(filename: string): string | undefined;
+/**
+ * Gets Content-Type for a bundle file with 3-tier fallback
+ * @param bundlePath The bundle file path
+ * @returns Content-Type string (never undefined, falls back to application/octet-stream)
+ */
+declare function getContentType(bundlePath: string): string;
+//#endregion
 //#region src/copyDirToTmp.d.ts
 declare const copyDirToTmp: (dir: string, childDirname?: string) => Promise<{
   tmpDir: string;
@@ -358,6 +408,48 @@ declare function createDatabasePlugin<TContext = object>(name: string, abstractP
 //#region src/createStorageKeyBuilder.d.ts
 declare const createStorageKeyBuilder: (basePath: string | undefined) => (...args: string[]) => string;
 //#endregion
+//#region src/createTarBr.d.ts
+declare const createTarBrTargetFiles: ({
+  outfile,
+  targetFiles
+}: {
+  targetFiles: {
+    path: string;
+    name: string;
+  }[];
+  outfile: string;
+}) => Promise<string>;
+declare const createTarBr: ({
+  outfile,
+  targetDir,
+  excludeExts
+}: {
+  targetDir: string;
+  outfile: string;
+  excludeExts?: string[];
+}) => Promise<string>;
+//#endregion
+//#region src/createTarGz.d.ts
+declare const createTarGzTargetFiles: ({
+  outfile,
+  targetFiles
+}: {
+  targetFiles: {
+    path: string;
+    name: string;
+  }[];
+  outfile: string;
+}) => Promise<string>;
+declare const createTarGz: ({
+  outfile,
+  targetDir,
+  excludeExts
+}: {
+  targetDir: string;
+  outfile: string;
+  excludeExts?: string[];
+}) => Promise<string>;
+//#endregion
 //#region src/createZip.d.ts
 declare const createZipTargetFiles: ({
   outfile,
@@ -382,6 +474,17 @@ declare const createZip: ({
 //#region src/cwd.d.ts
 declare const getCwd: () => string;
 //#endregion
+//#region src/filterCompatibleAppVersions.d.ts
+/**
+ * Filters target app versions that are compatible with the current app version.
+ * Returns only versions that are compatible with the current version according to semver rules.
+ *
+ * @param targetAppVersionList - List of target app versions to filter
+ * @param currentVersion - Current app version
+ * @returns Array of target app versions compatible with the current version
+ */
+declare const filterCompatibleAppVersions: (targetAppVersionList: string[], currentVersion: string) => string[];
+//#endregion
 //#region src/generateMinBundleId.d.ts
 declare const generateMinBundleId: () => string;
 //#endregion
@@ -411,6 +514,32 @@ type EnvVarValue = string | {
 };
 declare const makeEnv: (newEnvVars: Record<string, EnvVarValue>, filePath?: string) => Promise<string>;
 //#endregion
+//#region src/parseStorageUri.d.ts
+interface ParsedStorageUri {
+  protocol: string;
+  bucket: string;
+  key: string;
+}
+/**
+ * Parses a storage URI and validates the protocol.
+ *
+ * @param storageUri - The storage URI to parse (e.g., "s3://bucket/path/to/file")
+ * @param expectedProtocol - The expected protocol without colon (e.g., "s3", "r2", "gs")
+ * @returns Parsed storage URI components
+ * @throws Error if the URI is invalid or protocol doesn't match
+ *
+ * @example
+ * ```typescript
+ * const { bucket, key } = parseStorageUri("s3://my-bucket/path/to/file.zip", "s3");
+ * // bucket: "my-bucket"
+ * // key: "path/to/file.zip"
+ * ```
+ */
+declare function parseStorageUri(storageUri: string, expectedProtocol: string): ParsedStorageUri;
+//#endregion
+//#region src/semverSatisfies.d.ts
+declare const semverSatisfies: (targetAppVersion: string, currentVersion: string) => boolean;
+//#endregion
 //#region src/transformEnv.d.ts
 declare const transformEnv: <T extends Record<string, string>>(filename: string, env: T) => string;
 //#endregion
@@ -428,4 +557,4 @@ type TransformTemplateArgs<T extends string> = { [Key in ExtractPlaceholders<T>]
  */
 declare function transformTemplate<T extends string>(templateString: T, values: TransformTemplateArgs<T>): string;
 //#endregion
-export { AbstractDatabasePlugin, BaseDatabaseUtils, BasePluginArgs, BuildPlugin, BuildPluginConfig, BuildType, BuiltIns, type Bundle, ConfigBuilder, ConfigInput, ConfigResponse, DatabasePlugin, DatabasePluginHooks, HasMultipleCallSignatures, HotUpdaterConfigOptions, IConfigBuilder, ImportInfo, NativeBuildArgs, PaginatedResult, PaginationInfo, PaginationOptions, type Platform, PlatformConfig, Primitive, ProviderConfig, RequiredDeep, StoragePlugin, StoragePluginHooks, banner, calculatePagination, copyDirToTmp, createBlobDatabasePlugin, createDatabasePlugin, createStorageKeyBuilder, createZip, createZipTargetFiles, generateMinBundleId, getCwd, link, loadConfig, loadConfigSync, log, makeEnv, printBanner, transformEnv, transformTemplate };
+export { AbstractDatabasePlugin, BaseDatabaseUtils, BasePluginArgs, BuildPlugin, BuildPluginConfig, BuildType, BuiltIns, type Bundle, CompressionFormat, CompressionFormatInfo, ConfigBuilder, ConfigInput, ConfigResponse, DatabasePlugin, DatabasePluginHooks, HasMultipleCallSignatures, HotUpdaterConfigOptions, IConfigBuilder, ImportInfo, NativeBuildArgs, PaginatedResult, PaginationInfo, PaginationOptions, ParsedStorageUri, type Platform, PlatformConfig, Primitive, ProviderConfig, RequiredDeep, StoragePlugin, StoragePluginHooks, banner, calculatePagination, copyDirToTmp, createBlobDatabasePlugin, createDatabasePlugin, createStorageKeyBuilder, createTarBr, createTarBrTargetFiles, createTarGz, createTarGzTargetFiles, createZip, createZipTargetFiles, detectCompressionFormat, filterCompatibleAppVersions, generateMinBundleId, getCompressionMimeType, getContentType, getCwd, link, loadConfig, loadConfigSync, log, makeEnv, parseStorageUri, printBanner, semverSatisfies, transformEnv, transformTemplate };