@hot-updater/protocol 1.0.8 → 1.1.0

package/dist/index.d.cts

@@ -198,6 +198,12 @@ type UpdateCheckResult = {
   readonly releaseId: string | null;
   /** The Release before the check; it differs after an adoption. */
   readonly previousReleaseId: string | null;
+  /**
+   * When the event happened, in epoch milliseconds, for an event native
+   * code recorded before this runtime started (a native
+   * `HotUpdaterInstance`). Absent when the event happens now.
+   */
+  readonly occurredAt?: number;
 } | {
   /** The check found a Release to install, adopt, or roll back to. */
   readonly status: "UPDATE_AVAILABLE";
@@ -210,6 +216,12 @@ type UpdateCheckResult = {
   readonly updateStatus: "UPDATE" | "ROLLBACK";
   readonly shouldForceUpdate: boolean;
   readonly updateStrategy: UpdateStrategy;
+  /**
+   * When the event happened, in epoch milliseconds, for an event native
+   * code recorded before this runtime started (a native
+   * `HotUpdaterInstance`). Absent when the event happens now.
+   */
+  readonly occurredAt?: number;
 };
 /** A bundle the SDK downloaded, verified, and staged for the next launch. */
 interface BundleDownloadedInfo {
@@ -227,6 +239,12 @@ interface BundleDownloadedInfo {
   readonly delivery: "patch" | "manifest" | "archive";
   /** A patch was tried, but the file or the archive was downloaded instead. */
   readonly patchFallback: boolean;
+  /**
+   * When the event happened, in epoch milliseconds, for an event native code
+   * recorded before this runtime started (a native `HotUpdaterInstance`).
+   * Absent when the event happens now.
+   */
+  readonly occurredAt?: number;
 }
 /**
  * Where an update failed: `check` covers the Release catalog request,
@@ -266,16 +284,34 @@ interface UpdateError {
   readonly updateStrategy: UpdateStrategy;
   /** The error the SDK caught. */
   readonly cause: unknown;
+  /**
+   * When the event happened, in epoch milliseconds, for an event native code
+   * recorded before this runtime started (a native `HotUpdaterInstance`).
+   * Absent when the event happens now.
+   */
+  readonly occurredAt?: number;
 }
 /** A response from the update server's catalog or artifact API. */
 interface UpdateHttpResponse {
   readonly resource: "catalog" | "artifact";
+  /**
+   * The channel the request checked, for a response native code received before
+   * this runtime started (a native `HotUpdaterInstance`). Absent when the
+   * response belongs to the current channel.
+   */
+  readonly channel?: string;
   /** Request path only; authentication headers and query parameters are omitted. */
   readonly path: string;
   readonly status: number;
   /** The response as text, or null if the body could not be read. */
   readonly body: string | null;
   readonly bodyTruncated: boolean;
+  /**
+   * When the response arrived, in epoch milliseconds, for a response native
+   * code received before this runtime started (a native `HotUpdaterInstance`).
+   * Absent when it arrives now.
+   */
+  readonly occurredAt?: number;
 }
 /**
  * Lifecycle hooks a plugin returns from `setup` as `hooks`. Hooks observe:

package/dist/index.d.mts

@@ -198,6 +198,12 @@ type UpdateCheckResult = {
   readonly releaseId: string | null;
   /** The Release before the check; it differs after an adoption. */
   readonly previousReleaseId: string | null;
+  /**
+   * When the event happened, in epoch milliseconds, for an event native
+   * code recorded before this runtime started (a native
+   * `HotUpdaterInstance`). Absent when the event happens now.
+   */
+  readonly occurredAt?: number;
 } | {
   /** The check found a Release to install, adopt, or roll back to. */
   readonly status: "UPDATE_AVAILABLE";
@@ -210,6 +216,12 @@ type UpdateCheckResult = {
   readonly updateStatus: "UPDATE" | "ROLLBACK";
   readonly shouldForceUpdate: boolean;
   readonly updateStrategy: UpdateStrategy;
+  /**
+   * When the event happened, in epoch milliseconds, for an event native
+   * code recorded before this runtime started (a native
+   * `HotUpdaterInstance`). Absent when the event happens now.
+   */
+  readonly occurredAt?: number;
 };
 /** A bundle the SDK downloaded, verified, and staged for the next launch. */
 interface BundleDownloadedInfo {
@@ -227,6 +239,12 @@ interface BundleDownloadedInfo {
   readonly delivery: "patch" | "manifest" | "archive";
   /** A patch was tried, but the file or the archive was downloaded instead. */
   readonly patchFallback: boolean;
+  /**
+   * When the event happened, in epoch milliseconds, for an event native code
+   * recorded before this runtime started (a native `HotUpdaterInstance`).
+   * Absent when the event happens now.
+   */
+  readonly occurredAt?: number;
 }
 /**
  * Where an update failed: `check` covers the Release catalog request,
@@ -266,16 +284,34 @@ interface UpdateError {
   readonly updateStrategy: UpdateStrategy;
   /** The error the SDK caught. */
   readonly cause: unknown;
+  /**
+   * When the event happened, in epoch milliseconds, for an event native code
+   * recorded before this runtime started (a native `HotUpdaterInstance`).
+   * Absent when the event happens now.
+   */
+  readonly occurredAt?: number;
 }
 /** A response from the update server's catalog or artifact API. */
 interface UpdateHttpResponse {
   readonly resource: "catalog" | "artifact";
+  /**
+   * The channel the request checked, for a response native code received before
+   * this runtime started (a native `HotUpdaterInstance`). Absent when the
+   * response belongs to the current channel.
+   */
+  readonly channel?: string;
   /** Request path only; authentication headers and query parameters are omitted. */
   readonly path: string;
   readonly status: number;
   /** The response as text, or null if the body could not be read. */
   readonly body: string | null;
   readonly bodyTruncated: boolean;
+  /**
+   * When the response arrived, in epoch milliseconds, for a response native
+   * code received before this runtime started (a native `HotUpdaterInstance`).
+   * Absent when it arrives now.
+   */
+  readonly occurredAt?: number;
 }
 /**
  * Lifecycle hooks a plugin returns from `setup` as `hooks`. Hooks observe:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hot-updater/protocol",
-  "version": "1.0.8",
+  "version": "1.1.0",
   "type": "module",
   "description": "The data formats and pure computations that Hot Updater's app and server share",
   "sideEffects": false,