@hot-updater/plugin-core 0.36.7 → 1.0.0-rc.0

package/dist/types/index.d.cts

@@ -1,5 +1,8 @@
+import { ApiKeyRow, BundleEventRow, BundleEventRowBase, BundlePatchRow, BundleRow, ChannelRow, DatabaseBundleMetadata, DatabaseJsonObject, DatabaseJsonValue, ReleaseCatalogRow, ReleaseRow } from "./databaseRows.cjs";
+import { AnalyticsModel, AnalyticsScanCursor, AnalyticsScanInput, ApiKeyModel, BundleModel, BundleModelQuery, BundlePatchModel, BundleRepository, BundleRepositoryChange, BundleRepositoryCommit, ChannelDeleteInput, ChannelDeleteResult, ChannelInsertInput, ChannelInsertResult, ChannelModel, DatabaseChange, DatabaseCommit, DatabaseCommitExpectation, DatabaseCommitResult, DatabaseModels, DatabasePlugin, ReleaseCatalogModel, ReleaseModel } from "./databasePlugin.cjs";
+import { BundleRowUpdate, ReleaseCatalogRowUpdate, ReleaseRowUpdate } from "./databaseOperations.cjs";
 import { BuiltIns, HasMultipleCallSignatures, Primitive, RequiredDeep } from "./utils.cjs";
-import { AppVersionGetBundlesArgs, Bundle, Bundle as Bundle$1, FingerprintGetBundlesArgs, GetBundlesArgs, GetBundlesArgs as GetBundlesArgs$1, Platform, Platform as Platform$1, UpdateInfo, UpdateInfo as UpdateInfo$1 } from "@hot-updater/core";
+import { Bundle, Bundle as Bundle$1, Platform, Platform as Platform$1 } from "@hot-updater/core";
 
 //#region src/types/index.d.ts
 interface BasePluginArgs {
@@ -28,65 +31,53 @@ interface DatabaseBundleIdFilter {
   in?: string[];
 }
 interface DatabaseBundleQueryWhere {
-  channel?: string;
   platform?: Platform;
-  enabled?: boolean;
   id?: DatabaseBundleIdFilter;
-  targetAppVersion?: string | null;
-  targetAppVersionIn?: string[];
-  targetAppVersionNotNull?: boolean;
-  fingerprintHash?: string | null;
 }
 interface DatabaseBundleQueryOrder {
   field: "id";
   direction: "asc" | "desc";
 }
-interface DatabaseBundleCursor {
+type DatabaseBundleCursor = {
   /**
    * Fetch the next window after this bundle ID.
    *
    * This is the preferred pagination mode for bundle-management queries.
    */
-  after?: string;
+  after: string;
+  before?: never;
+} | {
+  after?: never;
   /**
    * Fetch the previous window before this bundle ID.
    *
    * This is the preferred pagination mode for bundle-management queries.
    */
-  before?: string;
-}
-interface DatabaseBundleQueryOptions {
-  where?: DatabaseBundleQueryWhere;
-  limit: number;
+  before: string;
+};
+type DatabaseBundlePaginationOptions = {
   /**
-   * Optional page number used by management UIs to keep page boundaries stable
-   * even when new bundles are inserted ahead of the current cursor window.
+   * Optional page number used by management UIs to keep page boundaries
+   * stable even when new bundles are inserted ahead of the current cursor
+   * window.
    */
   page?: number;
+  cursor?: never;
+} | {
+  page?: never;
   /**
    * Preferred cursor-based pagination for bundle-management queries.
    */
   cursor?: DatabaseBundleCursor;
+};
+type DatabaseBundleQueryOptions = {
+  where?: DatabaseBundleQueryWhere;
+  limit: number;
   orderBy?: DatabaseBundleQueryOrder;
-}
+} & DatabaseBundlePaginationOptions;
 interface BuildPluginConfig {
   outDir?: string;
 }
-interface DatabasePlugin<TContext = unknown> {
-  getChannels: (context?: HotUpdaterContext<TContext>) => Promise<string[]>;
-  getBundleById: (bundleId: string, context?: HotUpdaterContext<TContext>) => Promise<Bundle | null>;
-  getUpdateInfo?: (args: GetBundlesArgs, context?: HotUpdaterContext<TContext>) => Promise<UpdateInfo | null>;
-  getBundles: (options: DatabaseBundleQueryOptions, context?: HotUpdaterContext<TContext>) => Promise<Paginated<Bundle[]>>;
-  updateBundle: (targetBundleId: string, newBundle: Partial<Bundle>, context?: HotUpdaterContext<TContext>) => Promise<void>;
-  appendBundle: (insertBundle: Bundle, context?: HotUpdaterContext<TContext>) => Promise<void>;
-  commitBundle: (context?: HotUpdaterContext<TContext>) => Promise<void>;
-  onUnmount?: () => Promise<void>;
-  name: string;
-  deleteBundle: (deleteBundle: Bundle, context?: HotUpdaterContext<TContext>) => Promise<void>;
-}
-interface DatabasePluginHooks {
-  onDatabaseUpdated?: () => Promise<void>;
-}
 interface BuildPlugin {
   nativeBuild?: {
     prebuild?: (args: {
@@ -239,16 +230,6 @@ interface PlatformConfig {
      * @example ["android/app/src/main/AndroidManifest.xml"]
      */
     androidManifestPaths?: string[];
-    /**
-     * Android string resource paths.
-     *
-     * @deprecated Android Hot Updater config is stored in AndroidManifest.xml.
-     * This remains supported as a legacy read fallback.
-     *
-     * @default all strings.xml files in the android directory
-     * @example ["android/app/src/main/res/values/strings.xml"]
-     */
-    stringResourcePaths?: string[];
   };
   /**
    * iOS platform configuration.
@@ -273,125 +254,115 @@ interface NativeBuildArgs {
    */
   ios?: Record<string, NativeBuildIosScheme>;
 }
-interface RequestEnvContext<TEnv = unknown> {
-  request?: Request;
-  env?: TEnv;
+interface StoragePutInput {
+  /** Complete object key below the provider's configured base path. */
+  readonly key: string;
+  readonly body: ReadableStream<Uint8Array>;
+  readonly contentLength?: number;
+  readonly contentType: string;
 }
-type HotUpdaterContext<TContext = unknown> = TContext;
-type StorageResolveContext<TContext = unknown> = HotUpdaterContext<TContext>;
-interface StorageObject {
-  /** Object key relative to the storage plugin's configured base path. */
-  key: string;
-  storageUri: string;
-  size: number;
-  lastModifiedAt?: Date;
+interface StoragePutResult {
+  readonly storageUri: string;
 }
-interface NodeStorageProfile {
-  upload: (key: string, filePath: string) => Promise<{
-    storageUri: string;
-  }>;
-  /**
-   * Returns true when the object can be safely reused by deploy without
-   * uploading it again. Providers may validate more than physical existence
-   * when runtime access needs an additional readiness check.
-   */
-  exists: (storageUri: string) => Promise<boolean>;
-  delete: (storageUri: string) => Promise<void>;
-  downloadFile: (storageUri: string, filePath: string) => Promise<void>;
-  /**
-   * Optional management capabilities used by storage garbage collection.
-   * Object keys are relative to the configured storage base path.
-   * `deleteObjects` must delete only the exact keys it receives.
-   */
-  listObjects?: (prefix?: string) => Promise<StorageObject[]>;
-  deleteObjects?: (keys: readonly string[]) => Promise<void>;
+interface StorageGetInput {
+  readonly storageUri: string;
 }
-interface RuntimeStorageProfile<TContext = unknown> {
-  getDownloadUrl: (storageUri: string, context?: StorageResolveContext<TContext>) => Promise<{
-    fileUrl: string;
-  }>;
-  readText: (storageUri: string, context?: StorageResolveContext<TContext>) => Promise<string | null>;
+interface StorageGetResult {
+  readonly response: Response | null;
 }
-interface StoragePluginProfiles<TContext = unknown> {
-  /**
-   * Node/deploy/console profile.
-   *
-   * Use this profile when the caller can materialize storage objects to the
-   * local filesystem.
-   */
-  node?: NodeStorageProfile;
-  /**
-   * Runtime update-check profile.
-   *
-   * Use this profile when the caller needs signed/public client URLs and direct
-   * server-side reads for small control-plane text objects such as manifests.
-   */
-  runtime?: RuntimeStorageProfile<TContext>;
+interface StorageExistsInput {
+  readonly storageUri: string;
 }
-interface StoragePlugin<TContext = unknown> {
-  /**
-   * Protocol this storage plugin can resolve.
-   * @example "s3", "r2", "supabase-storage".
-   */
-  supportedProtocol: string;
-  name: string;
-  profiles: StoragePluginProfiles<TContext>;
+interface StorageExistsResult {
+  readonly exists: boolean;
 }
-interface NodeStoragePlugin<TContext = unknown> extends StoragePlugin<TContext> {
-  profiles: {
-    node: NodeStorageProfile;
-    runtime?: RuntimeStorageProfile<TContext>;
-  };
+interface StorageDeleteInput {
+  readonly storageUri: string;
 }
-interface RuntimeStoragePlugin<TContext = unknown> extends StoragePlugin<TContext> {
-  profiles: {
-    node?: NodeStorageProfile;
-    runtime: RuntimeStorageProfile<TContext>;
-  };
+interface StorageDeleteResult {
+  readonly deleted: true;
 }
-interface UniversalStoragePlugin<TContext = unknown> extends StoragePlugin<TContext> {
-  profiles: {
-    node: NodeStorageProfile;
-    runtime: RuntimeStorageProfile<TContext>;
-  };
+interface StorageObject {
+  /** Object key relative to the storage plugin's configured base path. */
+  readonly key: string;
+  readonly storageUri: string;
+  readonly size: number;
+  readonly lastModifiedAt?: Date;
 }
-interface StoragePluginHooks {
-  onStorageUploaded?: () => Promise<void>;
+interface StorageGetDownloadUrlInput {
+  readonly storageUri: string;
+}
+interface StorageGetDownloadUrlResult {
+  readonly url: string;
 }
 /**
- * Signing configuration type with conditional required fields.
- * When enabled is true, privateKeyPath is required.
- * When enabled is false, privateKeyPath is optional.
+ * Runtime-independent object storage contract.
+ *
+ * `storageUri` values are hierarchical identifiers in the form
+ * `protocol://bucket/slash-separated-encoded-key`.
+ *
+ * SDK clients, platform bindings, credentials, and local file I/O belong to
+ * provider implementations and consumers, never to this interface.
  */
-type SigningConfig = {
-  /**
-   * Enable bundle signing during deployment.
-   * When false, signing is disabled and privateKeyPath is optional.
-   */
-  enabled: false;
-  /**
-   * Path to RSA private key file in PEM format (PKCS#8).
-   * Optional when signing is disabled.
-   */
-  privateKeyPath?: string;
-} | {
+interface StoragePlugin {
+  readonly name: string;
   /**
-   * Enable bundle signing during deployment.
-   * When true, bundles will be signed with privateKeyPath.
+   * Protocol this plugin resolves and stores in database storage URIs.
+   * @example "s3", "r2", "supabase-storage".
    */
-  enabled: true;
+  readonly protocol: string;
+  readonly put?: (input: StoragePutInput) => Promise<StoragePutResult>;
+  readonly get?: (input: StorageGetInput) => Promise<StorageGetResult>;
+  /** Resolves the URL an update client uses to download the object. */
+  readonly getDownloadUrl?: (input: StorageGetDownloadUrlInput) => Promise<StorageGetDownloadUrlResult>;
+  /**
+   * Returns true when an object can be safely reused by deploy. Providers may
+   * validate more than physical existence when download readiness is required.
+   */
+  readonly exists?: (input: StorageExistsInput) => Promise<StorageExistsResult>;
+  /** Deletes exactly the object referenced by `storageUri`. */
+  readonly delete?: (input: StorageDeleteInput) => Promise<StorageDeleteResult>;
+  /** Lists objects below the optional base-path-relative prefix. */
+  readonly listObjects?: (prefix?: string) => Promise<StorageObject[]>;
+  /** Deletes only the exact base-path-relative keys supplied by the caller. */
+  readonly deleteObjects?: (keys: readonly string[]) => Promise<void>;
+}
+interface BundleSigningPlugin {
+  readonly name: string;
+  /** Path to the pinned RSA public key embedded in native builds. */
+  readonly publicKeyPath: string;
+  /** Returns the RSA public key used by this provider in SPKI PEM format. */
+  readonly getPublicKey: (input?: {
+    readonly cwd?: string;
+  }) => Promise<{
+    readonly publicKey: string;
+  }>;
   /**
-   * Path to RSA private key file in PEM format (PKCS#8).
-   * Generate with: npx hot-updater keys:generate
+   * Signs `message` with RSA PKCS#1 v1.5 SHA-256.
    *
-   * Security: Never commit this key to version control!
-   * Use secure storage (AWS Secrets Manager, etc.) for CI/CD.
-   *
-   * @example "./keys/private-key.pem"
-   * @example "/secure/path/to/private-key.pem"
+   * Hot Updater passes the 32 raw bytes decoded from a SHA-256 file hash.
+   * Remote signing services must treat this value as the raw message, not as
+   * an already-computed digest.
    */
-  privateKeyPath: string;
-};
+  readonly sign: (input: {
+    readonly message: Uint8Array;
+    readonly cwd?: string;
+  }) => Promise<{
+    readonly signature: Uint8Array;
+  }>;
+}
+/** Built-in local PEM signing, compatible with the v0 configuration. */
+type LocalSigningConfig = {
+  /** Optional pinned RSA SPKI public key. Also enables public-key-only builds. */readonly publicKeyPath?: string;
+} & ({
+  readonly enabled: true; /** Path to an RSA private key in PEM format. */
+  readonly privateKeyPath: string;
+} | {
+  readonly enabled: false;
+  readonly privateKeyPath?: string;
+});
+/** Local config or signing plugin. Signing is disabled when omitted. */
+type SigningConfig = BundleSigningPlugin | LocalSigningConfig;
 /**
  * Extra fingerprint sources.
  *
@@ -411,13 +382,6 @@ type ConfigInput = {
    * @default "node_modules/.hot-updater"
    */
   cacheDir?: string | null;
-  /**
-   * The channel used when building the native app.
-   * Used to replace __HOT_UPDATER_CHANNEL at build time.
-   *
-   * @deprecated Use the `hot-updater channel create` command to create a channel.
-   */
-  releaseChannel?: string;
   /**
    * The strategy used to update the app.
    *
@@ -507,26 +471,20 @@ type ConfigInput = {
    * Code signing configuration for bundle verification.
    * Enables RSA-SHA256 cryptographic signatures for bundle integrity.
    *
-   * @optional Feature is opt-in for backward compatibility
+   * @optional Feature is opt-in.
    *
    * @example
    * ```ts
-   * // Signing enabled - privateKeyPath is required
    * signing: {
    *   enabled: true,
-   *   privateKeyPath: './keys/private-key.pem'
-   * }
-   *
-   * // Signing disabled - privateKeyPath is optional
-   * signing: {
-   *   enabled: false
+   *   privateKeyPath: './keys/private-key.pem',
    * }
    * ```
    */
   signing?: SigningConfig;
   build: (args: BasePluginArgs) => Promise<BuildPlugin> | BuildPlugin;
-  storage: () => Promise<NodeStoragePlugin> | NodeStoragePlugin;
-  database: () => Promise<DatabasePlugin> | DatabasePlugin;
+  storage: StoragePlugin;
+  database: BundleRepository;
 };
 interface NativeBuildOptions {
   outputPath?: string;
@@ -535,4 +493,4 @@ interface NativeBuildOptions {
   scheme?: string;
 }
 //#endregion
-export { type AppVersionGetBundlesArgs, ApplePlatform, BasePluginArgs, BuildPlugin, BuildPluginConfig, type Bundle$1 as Bundle, ConfigInput, DatabaseBundleCursor, DatabaseBundleIdFilter, DatabaseBundleQueryOptions, DatabaseBundleQueryOrder, DatabaseBundleQueryWhere, DatabasePlugin, DatabasePluginHooks, FingerprintExtraSources, type FingerprintGetBundlesArgs, type GetBundlesArgs$1 as GetBundlesArgs, HotUpdaterContext, IosBuildDestination, NativeBuildAndroidScheme, NativeBuildArgs, NativeBuildIosScheme, NativeBuildOptions, NodeStoragePlugin, NodeStorageProfile, Paginated, PaginatedResult, PaginationInfo, type Platform$1 as Platform, PlatformConfig, RequestEnvContext, RuntimeStoragePlugin, RuntimeStorageProfile, SigningConfig, StorageObject, StoragePlugin, StoragePluginHooks, StoragePluginProfiles, StorageResolveContext, UniversalStoragePlugin, type UpdateInfo$1 as UpdateInfo, supportedIosPlatforms };
+export { ApplePlatform, BasePluginArgs, BuildPlugin, BuildPluginConfig, type Bundle$1 as Bundle, BundleSigningPlugin, ConfigInput, DatabaseBundleCursor, DatabaseBundleIdFilter, DatabaseBundleQueryOptions, DatabaseBundleQueryOrder, DatabaseBundleQueryWhere, FingerprintExtraSources, IosBuildDestination, LocalSigningConfig, NativeBuildAndroidScheme, NativeBuildArgs, NativeBuildIosScheme, NativeBuildOptions, Paginated, PaginatedResult, PaginationInfo, type Platform$1 as Platform, PlatformConfig, SigningConfig, StorageDeleteInput, StorageDeleteResult, StorageExistsInput, StorageExistsResult, StorageGetDownloadUrlInput, StorageGetDownloadUrlResult, StorageGetInput, StorageGetResult, StorageObject, StoragePlugin, StoragePutInput, StoragePutResult, supportedIosPlatforms };