@hot-updater/firebase 1.0.0-rc.18 → 1.0.0-rc.21

package/dist/index.d.mts

@@ -1,6 +1,5 @@
-import { PluginTables } from "@hot-updater/server/database";
+import { DatabaseJsonObject, EngineDatabase, Platform, PluginTables, StorageAdapterWith } from "@hot-updater/plugin-core";
 import { AppOptions } from "firebase-admin/app";
-import { EngineDatabase, StoragePluginWith } from "@hot-updater/plugin-core";
 //#region src/firebaseDatabase.d.ts
 type FirebaseDatabaseConfig = AppOptions & {
   /** The one collection the database keeps its items in. */
@@ -33,15 +32,305 @@ interface FirebaseStorageConfig extends AppOptions {
   /** Firebase signed URL lifetime in seconds. @default 3600 */
   signedUrlExpiresIn?: number;
 }
-declare const firebaseStorage: (config: FirebaseStorageConfig) => StoragePluginWith<"put" | "get" | "getDownloadUrl" | "exists" | "delete">;
+declare const firebaseStorage: (config: FirebaseStorageConfig) => StorageAdapterWith<"put" | "get" | "getDownloadUrl" | "exists" | "delete">;
+//#endregion
+//#region ../insights/dist/server/eventRow.d.mts
+//#region src/server/eventRow.d.ts
+/** Where an update failed, and what failed; open sets, `unknown` for any other value. */
+type BundleEventFailureStage = "check" | "download" | "install" | "unknown";
+type BundleEventFailureReason = "network" | "http" | "invalid_response" | "hash_mismatch" | "signature" | "patch" | "extract" | "storage" | "unknown";
+/** An `UPDATE_FAILED` report's failure, as stored. */
+type BundleEventFailure = DatabaseJsonObject & {
+  readonly stage: BundleEventFailureStage;
+  readonly reason: BundleEventFailureReason;
+  /** What the client was fetching or writing. */
+  readonly resource?: "catalog" | "artifact" | "manifest" | "file" | "patch" | "archive" | "unknown";
+  readonly http_status?: number;
+  /** How the connection failed, when it did. */
+  readonly transport?: "timeout" | "dns" | "tls" | "connection" | "offline" | "cancelled" | "unknown";
+  /** The storage origin's error code, such as `ExpiredToken`. */
+  readonly origin_code?: string;
+  /** Android's `ApplicationExitInfo` reason for the process before this one. */
+  readonly previous_process_exit?: string;
+};
+/** Ancillary report data; queryable identity and lifecycle fields stay on the row. */
+type DatabaseBundleEventMetadata = DatabaseJsonObject & {
+  readonly cohort: string;
+  readonly update_strategy: "fingerprint" | "appVersion" | null;
+  readonly fingerprint_hash: string | null;
+  readonly sdk_version: string | null;
+  /** `UPDATE_FAILED`: what failed. */
+  readonly failure?: BundleEventFailure;
+  /** `UPDATE_DOWNLOADED`: how the bundle arrived. */
+  readonly delivery?: "patch" | "manifest" | "archive" | "unknown";
+  /** `UPDATE_DOWNLOADED`: a patch failed and the full files came instead. */
+  readonly patch_fallback?: boolean;
+  /** `RECOVERED`: Android's `ApplicationExitInfo` reason for the crashed process. */
+  readonly previous_process_exit?: string;
+};
+type BundleEventRowBase = {
+  readonly id: string;
+  readonly install_id: string;
+  readonly user_id: string | null;
+  readonly from_release_id: string | null;
+  readonly to_release_id: string | null;
+  readonly to_bundle_id: string;
+  readonly platform: Platform;
+  readonly app_version: string;
+  readonly channel: string;
+  readonly metadata: DatabaseBundleEventMetadata;
+  readonly received_at_ms: number;
+};
+type BundleEventRow = BundleEventRowBase & ({
+  readonly type: "UPDATE_DOWNLOADED";
+  readonly from_bundle_id: string;
+} | {
+  readonly type: "UPDATE_APPLIED" | "RECOVERED";
+  readonly from_bundle_id: string;
+} |
+/** An update that failed: `from` is the running bundle, `to` the target (for a check, the running bundle). */
+{
+  readonly type: "UPDATE_FAILED";
+  readonly from_bundle_id: string;
+} | {
+  readonly type: "UNCHANGED";
+  readonly from_bundle_id: null;
+});
+//#endregion
+//#region ../insights/dist/server/modelTypes.d.mts
+//#region src/server/modelTypes.d.ts
+interface InsightsEventCursor {
+  readonly receivedAtMs: number;
+  readonly id: string;
+}
+interface InsightsScope {
+  readonly platform: "ios" | "android";
+  readonly channel: string;
+}
+/**
+ * Raw event predicates; recovery is attributed to the source bundle. An
+ * UNCHANGED report is kept as no event, so no filter names it.
+ */
+type InsightsBundleEventFilter = InsightsScope & ({
+  readonly type: "RECOVERED";
+  readonly fromBundleId: string;
+} | {
+  readonly type: "UPDATE_DOWNLOADED" | "UPDATE_APPLIED" | "UPDATE_FAILED";
+  readonly toBundleId: string;
+});
+type InsightsEventFilter = {
+  readonly kind: "all";
+} | {
+  readonly kind: "installationMovement";
+  readonly installId: string;
+} | ({
+  readonly kind: "bundle";
+} & InsightsBundleEventFilter);
+interface InsightsListEventsInput {
+  readonly filter: InsightsEventFilter;
+  readonly sinceMs?: number;
+  readonly beforeReceivedAtMs: number;
+  readonly after?: InsightsEventCursor;
+  readonly limit: number;
+}
+type InsightsFindLatestEventsInput = {
+  readonly installId: string;
+} | {
+  readonly userId: string;
+  readonly afterInstallId?: string;
+  readonly limit: number;
+};
+interface InsightsCountLatestEventsInput extends InsightsScope {
+  /** A UTC day's start: latest events are counted by the day they fall in. */
+  readonly sinceMs: number;
+  /** Optional OR of one or two fixed predicates; count a matching event once. */
+  readonly bundle?: readonly {
+    readonly field: "from_bundle_id" | "to_bundle_id";
+    readonly value: string;
+    readonly types: readonly BundleEventRow["type"][];
+  }[];
+}
+interface InsightsCountEventsInput {
+  readonly filter: InsightsBundleEventFilter;
+  readonly sinceMs: number;
+  readonly beforeReceivedAtMs: number;
+}
+interface ReleaseReference {
+  readonly releaseId: string;
+  readonly platform: "ios" | "android";
+  readonly channel: string;
+}
+interface InsightsTimeRange {
+  /** Inclusive UTC Unix timestamp in milliseconds. */
+  readonly start: number;
+  /** Exclusive UTC Unix timestamp in milliseconds. */
+  readonly end: number;
+}
+type InsightsCoverage = {
+  readonly kind: "complete";
+  readonly sinceMs: number;
+} | {
+  readonly kind: "partial";
+  readonly sinceMs: number | null;
+};
+interface ReleaseActivityMetrics {
+  readonly downloads: number;
+  readonly launches: number;
+  readonly failedLaunches: number;
+  /** Omitted for lifetime-only bundle-row reads. */
+  readonly uniqueUsers?: number;
+  /** Daily points, present only for period reads. */
+  readonly series?: readonly {
+    readonly startMs: number;
+    readonly launches: number;
+    readonly failedLaunches: number;
+  }[];
+}
+type InsightsGetReleaseActivityInput = {
+  readonly releases: readonly ReleaseReference[];
+  readonly timeRange?: InsightsTimeRange;
+  readonly scope?: never;
+} | {
+  readonly scope: InsightsScope;
+  readonly timeRange: InsightsTimeRange;
+  readonly releases?: never;
+};
+interface InsightsGetReleaseActivityResult {
+  readonly coverage: InsightsCoverage;
+  readonly data: readonly {
+    readonly release?: ReleaseReference;
+    readonly scope?: InsightsScope;
+    readonly metrics: ReleaseActivityMetrics;
+  }[];
+  readonly measuredAtMs: number;
+}
+interface InsightsGetAppUsageInput {
+  readonly channel: string;
+  readonly platform: "all" | "ios" | "android";
+  readonly appVersion?: string;
+  readonly timeRange: InsightsTimeRange;
+  readonly intervalMs: number;
+}
+interface InsightsGetAppUsageResult {
+  readonly coverage: InsightsCoverage;
+  readonly activeInstallations: number;
+  readonly points: readonly {
+    readonly startMs: number;
+    readonly installations: number;
+  }[];
+  readonly appVersions: readonly string[];
+  readonly versions: readonly {
+    readonly name: string;
+    readonly installations: number;
+  }[];
+  readonly platforms: readonly {
+    readonly name: string;
+    readonly installations: number;
+  }[];
+  readonly bundleDistribution: readonly {
+    readonly appVersion: string;
+    readonly platform: "ios" | "android";
+    readonly releaseId: string | null;
+    readonly installations: number;
+  }[];
+  readonly measuredAtMs: number;
+}
+//#endregion
+//#region ../insights/dist/server/schema.d.mts
+//#region src/server/schema.d.ts
+/** How long Insights keeps its rows, in whole days. Lifetime counters are kept. */
+interface InsightsRetention {
+  /** Raw events and hourly rollups. */
+  readonly rawDays: number;
+  /** Daily rollups, and each installation's latest event and the gauges that count it. */
+  readonly dailyDays: number;
+}
+//#endregion
+//#region ../insights/dist/server/reads.d.mts
+//#region src/server/reads.d.ts
+interface InsightsUpdateFailuresInput {
+  readonly platform: "ios" | "android";
+  readonly channel: string;
+  /** A release's failures; without it, the channel's, which need a time range. */
+  readonly releaseId?: string;
+  /** Without it, a release's failures since its first report. */
+  readonly timeRange?: InsightsTimeRange;
+}
+/** Update failures of one stage and reason, and what else their clients knew. */
+interface InsightsFailureBreakdown {
+  readonly stage: string;
+  readonly reason: string;
+  readonly events: number;
+  /** By resource, HTTP status, origin code, and transport, most first. */
+  readonly details: readonly {
+    readonly resource: string | null;
+    readonly httpStatus: number | null;
+    readonly originCode: string | null;
+    readonly transport: string | null;
+    readonly events: number;
+  }[];
+}
+interface InsightsUpdateFailures {
+  readonly coverage: InsightsCoverage;
+  readonly measuredAtMs: number;
+  /** Update failures other than failed checks: each client reports one at most once a UTC day. */
+  readonly failedUpdates: number;
+  /** Installations with such a failure, estimated. */
+  readonly failedInstallations: number;
+  /** Download reports: each installation reports a bundle's download once. */
+  readonly downloads: number;
+  /** Downloads a patch delivered, and those that fell back from a patch to files or the archive. */
+  readonly patchDownloads: number;
+  readonly patchFallbacks: number;
+  /** A channel's failed update checks, installations with one, and its active installations, estimated. */
+  readonly checks?: {
+    readonly failures: number;
+    readonly failedInstallations: number;
+    readonly activeInstallations: number;
+  };
+  /** Over a time range: failures by stage and reason, most first. */
+  readonly breakdown?: readonly InsightsFailureBreakdown[];
+  /**
+   * Over a time range: failed launches, and the recoveries whose crashed
+   * process exited for a reason Android 11+ reported, by reason, most first.
+   */
+  readonly recoveries?: {
+    readonly failedLaunches: number;
+    readonly byExitReason: readonly {
+      readonly exitReason: string;
+      readonly events: number;
+    }[];
+  };
+}
+//#endregion
+//#region ../api-keys/dist/server/model.d.mts
+//#region src/server/model.d.ts
+interface ApiKeyRow {
+  readonly id: string;
+  readonly hash: string;
+  readonly name: string;
+  readonly prefix: string;
+  readonly role: "client";
+  readonly created_at_ms: number;
+  readonly revoked_at_ms: number | null;
+}
+//#endregion
+//#region ../api-keys/dist/server/apiKeys.d.mts
+type ApiKeyMetadata = Omit<ApiKeyRow, "hash">;
+interface CreatedApiKey {
+  /** Plaintext credential. It cannot be recovered after this call returns. */
+  readonly apiKey: string;
+  /** Non-secret metadata. The persisted SHA-256 hash is never exposed. */
+  readonly record: ApiKeyMetadata;
+}
 //#endregion
 //#region src/plugins.d.ts
 /**
  * The plugins the managed Firebase server runs: Insights, and API keys on every
  * client route. Its Cloud Function imports this list.
  */
-declare const plugins: readonly [import("@hot-updater/server/plugins").HotUpdaterPlugin<"insights", {
-  readonly bundle_events: import("@hot-updater/server/database").TableDefinition<{
+declare const plugins: readonly [import("@hot-updater/plugin-core").HotUpdaterPlugin<"insights", {
+  readonly bundle_events: import("@hot-updater/plugin-core").TableDefinition<{
     readonly id: {
       readonly type: "string";
       readonly maxLength: 36;
@@ -116,7 +405,7 @@ declare const plugins: readonly [import("@hot-updater/server/plugins").HotUpdate
       readonly sort: readonly ["received_at_ms"];
     };
   }, readonly ["id"]>;
-  readonly bundle_event_heads: import("@hot-updater/server/database").TableDefinition<{
+  readonly bundle_event_heads: import("@hot-updater/plugin-core").TableDefinition<{
     readonly install_id: {
       readonly type: "string";
       readonly maxLength: 255;
@@ -169,13 +458,13 @@ declare const plugins: readonly [import("@hot-updater/server/plugins").HotUpdate
     readonly received_at_ms: {
       readonly type: "integer";
     };
-  }, Readonly<Record<string, import("@hot-updater/server/database").FieldType>>, {
+  }, Readonly<Record<string, import("@hot-updater/plugin-core").FieldType>>, {
     readonly byUser: {
       readonly eq: readonly ["user_id"];
       readonly sort: readonly ["install_id"];
     };
   }, readonly ["install_id"]>;
-  readonly insights_overview: import("@hot-updater/server/database").AggregateDefinition<{
+  readonly insights_overview: import("@hot-updater/plugin-core").AggregateDefinition<{
     readonly identity: {
       readonly type: "string";
       readonly maxLength: 32;
@@ -189,7 +478,7 @@ declare const plugins: readonly [import("@hot-updater/server/plugins").HotUpdate
       readonly sort: readonly ["bucket_start_ms"];
     };
   }, never, readonly ["identity", "bucket_start_ms"]>;
-  readonly insights_sketches: import("@hot-updater/server/database").AggregateDefinition<{
+  readonly insights_sketches: import("@hot-updater/plugin-core").AggregateDefinition<{
     readonly identity: {
       readonly type: "string";
       readonly maxLength: 32;
@@ -203,7 +492,7 @@ declare const plugins: readonly [import("@hot-updater/server/plugins").HotUpdate
       readonly sort: readonly ["bucket_start_ms"];
     };
   }, "launch_users" | "activity_users" | "failed_users", readonly ["identity", "bucket_start_ms"]>;
-  readonly insights_overview_daily: import("@hot-updater/server/database").AggregateDefinition<{
+  readonly insights_overview_daily: import("@hot-updater/plugin-core").AggregateDefinition<{
     readonly identity: {
       readonly type: "string";
       readonly maxLength: 32;
@@ -217,7 +506,7 @@ declare const plugins: readonly [import("@hot-updater/server/plugins").HotUpdate
       readonly sort: readonly ["bucket_start_ms"];
     };
   }, never, readonly ["identity", "bucket_start_ms"]>;
-  readonly insights_sketches_daily: import("@hot-updater/server/database").AggregateDefinition<{
+  readonly insights_sketches_daily: import("@hot-updater/plugin-core").AggregateDefinition<{
     readonly identity: {
       readonly type: "string";
       readonly maxLength: 32;
@@ -231,7 +520,7 @@ declare const plugins: readonly [import("@hot-updater/server/plugins").HotUpdate
       readonly sort: readonly ["bucket_start_ms"];
     };
   }, "launch_users" | "activity_users" | "failed_users", readonly ["identity", "bucket_start_ms"]>;
-  readonly insights_overview_lifetime: import("@hot-updater/server/database").AggregateDefinition<{
+  readonly insights_overview_lifetime: import("@hot-updater/plugin-core").AggregateDefinition<{
     readonly identity: {
       readonly type: "string";
       readonly maxLength: 32;
@@ -245,7 +534,7 @@ declare const plugins: readonly [import("@hot-updater/server/plugins").HotUpdate
       readonly sort: readonly ["bucket_start_ms"];
     };
   }, never, readonly ["identity", "bucket_start_ms"]>;
-  readonly insights_sketches_lifetime: import("@hot-updater/server/database").AggregateDefinition<{
+  readonly insights_sketches_lifetime: import("@hot-updater/plugin-core").AggregateDefinition<{
     readonly identity: {
       readonly type: "string";
       readonly maxLength: 32;
@@ -259,7 +548,7 @@ declare const plugins: readonly [import("@hot-updater/server/plugins").HotUpdate
       readonly sort: readonly ["bucket_start_ms"];
     };
   }, "failed_users", readonly ["identity", "bucket_start_ms"]>;
-  readonly insights_distribution: import("@hot-updater/server/database").AggregateDefinition<{
+  readonly insights_distribution: import("@hot-updater/plugin-core").AggregateDefinition<{
     readonly channel: {
       readonly type: "string";
     };
@@ -287,7 +576,7 @@ declare const plugins: readonly [import("@hot-updater/server/plugins").HotUpdate
       readonly sort: readonly ["bucket_start_ms"];
     };
   }, never, readonly ["channel", "platform", "app_version", "release_id", "bucket_start_ms"]>;
-  readonly insights_latest_by_bundle: import("@hot-updater/server/database").AggregateDefinition<{
+  readonly insights_latest_by_bundle: import("@hot-updater/plugin-core").AggregateDefinition<{
     readonly platform: {
       readonly type: "string";
       readonly maxLength: 16;
@@ -316,7 +605,7 @@ declare const plugins: readonly [import("@hot-updater/server/plugins").HotUpdate
       readonly sort: readonly ["bucket_start_ms"];
     };
   }, never, readonly ["platform", "channel", "bundle_field", "bundle_id", "type", "bucket_start_ms"]>;
-  readonly insights_outcomes: import("@hot-updater/server/database").AggregateDefinition<{
+  readonly insights_outcomes: import("@hot-updater/plugin-core").AggregateDefinition<{
     readonly platform: {
       readonly type: "string";
       readonly maxLength: 16;
@@ -341,7 +630,7 @@ declare const plugins: readonly [import("@hot-updater/server/plugins").HotUpdate
       readonly sort: readonly ["bucket_start_ms"];
     };
   }, never, readonly ["platform", "channel", "type", "bundle_ref", "bucket_start_ms"]>;
-  readonly insights_failures: import("@hot-updater/server/database").AggregateDefinition<{
+  readonly insights_failures: import("@hot-updater/plugin-core").AggregateDefinition<{
     readonly platform: {
       readonly type: "string";
       readonly maxLength: 16;
@@ -376,19 +665,19 @@ declare const plugins: readonly [import("@hot-updater/server/plugins").HotUpdate
   }, never, readonly ["platform", "channel", "bucket_start_ms", "release_id", "stage", "reason", "detail"]>;
 }, {
   api: {
-    retention: import("@hot-updater/server/plugins/insights").InsightsRetention;
-    recordEvent: (event: import("@hot-updater/server/plugins/insights").BundleEventRow) => Promise<void>;
-    listEvents: (input: import("@hot-updater/server/plugins/insights").InsightsListEventsInput) => Promise<readonly import("@hot-updater/server/plugins/insights").BundleEventRow[]>;
-    findLatestEvents: (input: import("@hot-updater/server/plugins/insights").InsightsFindLatestEventsInput) => Promise<readonly import("@hot-updater/server/plugins/insights").BundleEventRow[]>;
-    countLatestEvents: (input: import("@hot-updater/server/plugins/insights").InsightsCountLatestEventsInput) => Promise<number>;
-    countEvents: (input: import("@hot-updater/server/plugins/insights").InsightsCountEventsInput) => Promise<number>;
-    getReleaseActivity: (input: import("@hot-updater/server/plugins/insights").InsightsGetReleaseActivityInput) => Promise<import("@hot-updater/server/plugins/insights").InsightsGetReleaseActivityResult>;
-    getAppUsage: (input: import("@hot-updater/server/plugins/insights").InsightsGetAppUsageInput) => Promise<import("@hot-updater/server/plugins/insights").InsightsGetAppUsageResult>;
-    getUpdateFailures: (input: import("@hot-updater/server/plugins/insights").InsightsUpdateFailuresInput) => Promise<import("@hot-updater/server/plugins/insights").InsightsUpdateFailures>;
+    retention: InsightsRetention;
+    recordEvent: (event: BundleEventRow) => Promise<void>;
+    listEvents: (input: InsightsListEventsInput) => Promise<readonly BundleEventRow[]>;
+    findLatestEvents: (input: InsightsFindLatestEventsInput) => Promise<readonly BundleEventRow[]>;
+    countLatestEvents: (input: InsightsCountLatestEventsInput) => Promise<number>;
+    countEvents: (input: InsightsCountEventsInput) => Promise<number>;
+    getReleaseActivity: (input: InsightsGetReleaseActivityInput) => Promise<InsightsGetReleaseActivityResult>;
+    getAppUsage: (input: InsightsGetAppUsageInput) => Promise<InsightsGetAppUsageResult>;
+    getUpdateFailures: (input: InsightsUpdateFailuresInput) => Promise<InsightsUpdateFailures>;
   };
-  endpoints: import("@hot-updater/server/plugins").PluginEndpoint[];
-}, {}>, import("@hot-updater/server/plugins").HotUpdaterPlugin<"apiKeys", {
-  readonly api_keys: import("@hot-updater/server/database").TableDefinition<{
+  endpoints: import("@hot-updater/plugin-core").PluginEndpoint[];
+}, {}>, import("@hot-updater/plugin-core").HotUpdaterPlugin<"apiKeys", {
+  readonly api_keys: import("@hot-updater/plugin-core").TableDefinition<{
     readonly id: {
       readonly type: "string";
       readonly maxLength: 255;
@@ -429,21 +718,21 @@ declare const plugins: readonly [import("@hot-updater/server/plugins").HotUpdate
       readonly apiKey: string;
       readonly name: string;
       readonly createdAtMs?: number;
-    }) => Promise<import("@hot-updater/server/plugins/api-keys").CreatedApiKey>;
+    }) => Promise<CreatedApiKey>;
     provision: (input: {
       readonly existingApiKey?: string;
       readonly name: string;
-    }) => Promise<import("@hot-updater/server/plugins/api-keys").CreatedApiKey>;
+    }) => Promise<CreatedApiKey>;
     create(input: {
       readonly name: string;
     }): Promise<{
       readonly apiKey: string;
-      readonly record: import("@hot-updater/server/plugins/api-keys").ApiKeyMetadata;
+      readonly record: ApiKeyMetadata;
     }>;
-    list(): Promise<readonly import("@hot-updater/server/plugins/api-keys").ApiKeyMetadata[]>;
+    list(): Promise<readonly ApiKeyMetadata[]>;
     revoke(input: {
       readonly id: string;
-    }): Promise<import("@hot-updater/server/plugins/api-keys").ApiKeyMetadata | null>;
+    }): Promise<ApiKeyMetadata | null>;
   };
   clientAuth: {
     varyHeaders: string[];

package/dist/index.mjs

@@ -1,8 +1,7 @@
-import { createEngineDatabase, createKvAdapter, migrateCoreSchema } from "@hot-updater/server/database";
+import { createEngineDatabase, createKvAdapter, createStorageAdapter, createStorageKeyBuilder, createStorageUri, migrateCoreSchema, parseStorageUri } from "@hot-updater/plugin-core";
 import { getApp, getApps, initializeApp } from "firebase-admin/app";
 import { FieldPath, FieldValue, Timestamp, getFirestore } from "firebase-admin/firestore";
 import { createHash } from "node:crypto";
-import { createStorageKeyBuilder, createStoragePlugin, createStorageUri, parseStorageUri } from "@hot-updater/plugin-core";
 import { getStorage } from "firebase-admin/storage";
 import { apiKeys } from "@hot-updater/server/plugins/api-keys";
 import { insights } from "@hot-updater/server/plugins/insights";
@@ -201,7 +200,7 @@ const firebaseStorage = (config) => {
 		if (parsed.bucket !== config.storageBucket) throw new Error(`Bucket name mismatch: expected "${config.storageBucket}", but found "${parsed.bucket}".`);
 		return parsed;
 	};
-	return createStoragePlugin({
+	return createStorageAdapter({
 		name: "firebaseStorage",
 		protocol: "gs",
 		async put({ key, body, contentType }) {