@hot-updater/aws 1.0.0-rc.40 → 1.0.0-rc.42

package/dist/index.cjs

@@ -9,6 +9,7 @@ let _aws_sdk_client_s3 = require("@aws-sdk/client-s3");
 let _aws_sdk_lib_storage = require("@aws-sdk/lib-storage");
 let _hot_updater_server_plugins_api_keys = require("@hot-updater/server/plugins/api-keys");
 let _hot_updater_server_plugins_insights = require("@hot-updater/server/plugins/insights");
+let _hot_updater_server_plugins_remote_config = require("@hot-updater/server/plugins/remote-config");
 //#region src/cloudFrontInvalidation.ts
 const DEFAULT_POLL_INTERVAL_MS = 2e3;
 const DEFAULT_TIMEOUT_MS = 3e5;
@@ -583,10 +584,14 @@ function s3Storage(config) {
 //#endregion
 //#region src/plugins.ts
 /**
-* The plugins the managed AWS server runs: Insights, and API keys on every
-* client route. Its Lambda@Edge function imports this list.
+* The plugins the managed AWS server runs: Insights, API keys on every
+* client route, and Remote Config. Its Lambda@Edge function imports this list.
 */
-const plugins = [(0, _hot_updater_server_plugins_insights.insights)(), (0, _hot_updater_server_plugins_api_keys.apiKeys)()];
+const plugins = [
+	(0, _hot_updater_server_plugins_insights.insights)(),
+	(0, _hot_updater_server_plugins_api_keys.apiKeys)(),
+	(0, _hot_updater_server_plugins_remote_config.remoteConfig)()
+];
 //#endregion
 exports.cloudFrontDownloadUrl = cloudFrontDownloadUrl;
 exports.dynamoDB = dynamoDB;

package/dist/index.d.cts

@@ -398,10 +398,198 @@ interface CreatedApiKey {
   readonly record: ApiKeyMetadata;
 }
 //#endregion
+//#region ../remote-config/dist/shared/wire.d.mts
+//#region src/shared/wire.d.ts
+/** What a device tells the server, so the server can evaluate conditions. */
+interface RemoteConfigDeviceContext {
+  readonly platform: "ios" | "android";
+  /** The native app version, or null when the build has none. */
+  readonly appVersion: string | null;
+  readonly channel: string;
+  /** A numeric cohort from 1 to 1000, or a custom cohort's slug. */
+  readonly cohort: string;
+  /** The native build's fingerprint, or null without one. */
+  readonly fingerprintHash: string | null;
+}
+/** The body of a `200` from `GET /remote-config`. */
+interface RemoteConfigFetchResponse {
+  /** The published template version the values come from; 0 before the first publish. */
+  readonly version: number;
+  /**
+   * Each parameter's value for this device, as text. A parameter whose
+   * value is the app's own default is left out.
+   */
+  readonly values: Readonly<Record<string, string>>;
+}
+//#endregion
+//#region ../remote-config/dist/server/template.d.mts
+//#region src/server/template.d.ts
+/**
+ * How the Console edits a parameter's value and checks it before a publish.
+ * Devices receive every value as text.
+ */
+type RemoteConfigValueType = "STRING" | "NUMBER" | "BOOLEAN" | "JSON";
+/** A value a parameter takes: text, or the app's own default. */
+type RemoteConfigParameterValue = {
+  readonly value: string;
+} | {
+  readonly useInAppDefault: true;
+};
+interface RemoteConfigParameter {
+  readonly valueType: RemoteConfigValueType;
+  /** The value when none of the parameter's conditions match. */
+  readonly defaultValue: RemoteConfigParameterValue;
+  /**
+   * Values by condition name. When several of these conditions match, the
+   * one listed first in the template's `conditions` wins.
+   */
+  readonly conditionalValues?: Readonly<Record<string, RemoteConfigParameterValue>>;
+  readonly description?: string;
+}
+/** A test on a device's context; a condition matches when all of its rules do. */
+type RemoteConfigRule = {
+  readonly type: "platform";
+  readonly platforms: readonly ("ios" | "android")[];
+} | {
+  readonly type: "channel";
+  readonly channels: readonly string[];
+} |
+/** A semver range, such as `>=1.4.0` or `2.x`, as release targets use. */
+{
+  readonly type: "appVersion";
+  readonly range: string;
+} |
+/** Devices whose cohort is one of these: numbers from 1 to 1000 or slugs. */
+{
+  readonly type: "cohort";
+  readonly cohorts: readonly string[];
+} |
+/**
+ * A share of numeric cohorts: the devices whose cohort lands in
+ * `[from, to)` percent once `seed` shuffles the 1,000 cohorts. Rules with
+ * one seed pick from one order, so `0–10` and `10–20` never overlap; a new
+ * seed picks other devices. Custom cohorts never match.
+ */
+{
+  readonly type: "percent";
+  readonly seed: string;
+  readonly from: number;
+  readonly to: number;
+} | {
+  readonly type: "fingerprint";
+  readonly hashes: readonly string[];
+} |
+/**
+ * While the server's clock is in `[from, to)`: ISO 8601 date-times in UTC,
+ * either of them open. A device gets the change at its next fetch.
+ */
+{
+  readonly type: "dateTime";
+  readonly from?: string;
+  readonly to?: string;
+};
+interface RemoteConfigCondition {
+  /** Unique in the template; parameters name it in `conditionalValues`. */
+  readonly name: string;
+  /** Every rule must match. */
+  readonly rules: readonly RemoteConfigRule[];
+}
+/**
+ * Everything Remote Config serves, published as a whole and versioned.
+ */
+interface RemoteConfigTemplate {
+  /** In priority order: the first one that matches decides a parameter's value. */
+  readonly conditions: readonly RemoteConfigCondition[];
+  readonly parameters: Readonly<Record<string, RemoteConfigParameter>>;
+}
+/** What the server knows of a device; a rule on a missing field never matches. */
+type RemoteConfigEvaluationContext = Partial<Readonly<{ [K in keyof RemoteConfigDeviceContext]: RemoteConfigDeviceContext[K] | null; }>> & {
+  /**
+   * When to evaluate, in ms since the epoch. The server uses its own clock;
+   * a `dateTime` rule never matches without it.
+   */
+  readonly now?: number;
+};
+//#endregion
+//#region ../remote-config/dist/server/api.d.mts
+//#region src/server/api.d.ts
+/** A published version's record, without its template. */
+interface RemoteConfigVersion {
+  readonly version: number;
+  readonly description: string | null;
+  /** `ROLLBACK` when the version copies `rollbackSource`. */
+  readonly updateType: "PUBLISH" | "ROLLBACK";
+  readonly rollbackSource: number | null;
+  readonly createdAtMs: number;
+}
+interface RemoteConfigVersionDetail extends RemoteConfigVersion {
+  readonly template: RemoteConfigTemplate;
+}
+/** The template devices receive now. */
+interface RemoteConfigActive {
+  /** 0, with an empty template, before the first publish. */
+  readonly version: number;
+  readonly template: RemoteConfigTemplate;
+  readonly updatedAtMs: number | null;
+}
+/**
+ * How a publish or a rollback ended: `conflict` when another publish moved
+ * the active version past `baseVersion` first, so a stale edit never
+ * replaces a newer template.
+ */
+type RemoteConfigPublishResult = {
+  readonly status: "published";
+  readonly version: RemoteConfigVersion;
+} | {
+  readonly status: "conflict";
+  readonly currentVersion: number;
+};
+interface RemoteConfigVersionsPage {
+  /** Newest first. */
+  readonly versions: readonly RemoteConfigVersion[];
+  /** Pass as `cursor` for the next page; absent on the last one. */
+  readonly next?: string;
+}
+/** `hotUpdater.api.remoteConfig`. */
+interface RemoteConfigApi {
+  /** The active template and its version. */
+  getActive(): Promise<RemoteConfigActive>;
+  /**
+   * Validates and publishes a template as the next version. Throws
+   * `RemoteConfigValidationError` for an invalid template.
+   */
+  publish(input: {
+    readonly template: unknown;
+    /** The version the edit started from; 0 before the first publish. */
+    readonly baseVersion: number;
+    readonly description?: string;
+  }): Promise<RemoteConfigPublishResult>;
+  /** Publishes a copy of an earlier version; `not_found` when it does not exist. */
+  rollback(input: {
+    readonly version: number;
+    readonly baseVersion: number;
+    readonly description?: string;
+  }): Promise<RemoteConfigPublishResult | {
+    readonly status: "not_found";
+  }>;
+  /** One page of published versions, newest first. */
+  listVersions(input?: {
+    readonly limit?: number;
+    readonly cursor?: string;
+  }): Promise<RemoteConfigVersionsPage>;
+  /** One version with its template, or null. */
+  getVersion(version: number): Promise<RemoteConfigVersionDetail | null>;
+  /**
+   * What a device with this context receives from `GET /remote-config`, at
+   * `context.now` or, without it, now.
+   */
+  resolve(context: RemoteConfigEvaluationContext): Promise<RemoteConfigFetchResponse>;
+}
+//#endregion
 //#region src/plugins.d.ts
 /**
- * The plugins the managed AWS server runs: Insights, and API keys on every
- * client route. Its Lambda@Edge function imports this list.
+ * The plugins the managed AWS server runs: Insights, API keys on every
+ * client route, and Remote Config. Its Lambda@Edge function imports this list.
  */
 declare const plugins: readonly [import("@hot-updater/plugin-core").HotUpdaterPlugin<"insights", {
   readonly bundle_events: import("@hot-updater/plugin-core").TableDefinition<{
@@ -843,6 +1031,54 @@ declare const plugins: readonly [import("@hot-updater/plugin-core").HotUpdaterPl
   };
 }, {
   readonly clientAuth: true;
-}>];
+}>, import("@hot-updater/plugin-core").HotUpdaterPlugin<"remoteConfig", {
+  readonly remote_config_active: import("@hot-updater/plugin-core").TableDefinition<{
+    readonly id: {
+      readonly type: "string";
+      readonly maxLength: 16;
+    };
+    readonly version: {
+      readonly type: "integer";
+    };
+    readonly template: {
+      readonly type: "json";
+    };
+    readonly updated_at_ms: {
+      readonly type: "integer";
+    };
+  }, {}, {}, readonly ["id"]>;
+  readonly remote_config_versions: import("@hot-updater/plugin-core").TableDefinition<{
+    readonly version: {
+      readonly type: "integer";
+    };
+    readonly template: {
+      readonly type: "json";
+    };
+    readonly description: {
+      readonly type: "string";
+      readonly maxLength: 256;
+      readonly required: false;
+    };
+    readonly update_type: {
+      readonly type: "string";
+      readonly maxLength: 16;
+    };
+    readonly rollback_source: {
+      readonly type: "integer";
+      readonly required: false;
+    };
+    readonly created_at_ms: {
+      readonly type: "integer";
+    };
+  }, {}, {
+    readonly byVersion: {
+      readonly eq: readonly [];
+      readonly sort: readonly ["version"];
+    };
+  }, readonly ["version"]>;
+}, {
+  api: RemoteConfigApi;
+  endpoints: readonly import("@hot-updater/plugin-core").PluginEndpoint[];
+}, {}>];
 //#endregion
 export { CloudFrontDownloadUrlOptions, type DynamoDBConfig, S3StorageConfig, S3StorageConfigWithDownloadUrl, cloudFrontDownloadUrl, dynamoDB, migrateDynamoDB, plugins, s3Storage };

package/dist/index.d.mts

@@ -398,10 +398,198 @@ interface CreatedApiKey {
   readonly record: ApiKeyMetadata;
 }
 //#endregion
+//#region ../remote-config/dist/shared/wire.d.mts
+//#region src/shared/wire.d.ts
+/** What a device tells the server, so the server can evaluate conditions. */
+interface RemoteConfigDeviceContext {
+  readonly platform: "ios" | "android";
+  /** The native app version, or null when the build has none. */
+  readonly appVersion: string | null;
+  readonly channel: string;
+  /** A numeric cohort from 1 to 1000, or a custom cohort's slug. */
+  readonly cohort: string;
+  /** The native build's fingerprint, or null without one. */
+  readonly fingerprintHash: string | null;
+}
+/** The body of a `200` from `GET /remote-config`. */
+interface RemoteConfigFetchResponse {
+  /** The published template version the values come from; 0 before the first publish. */
+  readonly version: number;
+  /**
+   * Each parameter's value for this device, as text. A parameter whose
+   * value is the app's own default is left out.
+   */
+  readonly values: Readonly<Record<string, string>>;
+}
+//#endregion
+//#region ../remote-config/dist/server/template.d.mts
+//#region src/server/template.d.ts
+/**
+ * How the Console edits a parameter's value and checks it before a publish.
+ * Devices receive every value as text.
+ */
+type RemoteConfigValueType = "STRING" | "NUMBER" | "BOOLEAN" | "JSON";
+/** A value a parameter takes: text, or the app's own default. */
+type RemoteConfigParameterValue = {
+  readonly value: string;
+} | {
+  readonly useInAppDefault: true;
+};
+interface RemoteConfigParameter {
+  readonly valueType: RemoteConfigValueType;
+  /** The value when none of the parameter's conditions match. */
+  readonly defaultValue: RemoteConfigParameterValue;
+  /**
+   * Values by condition name. When several of these conditions match, the
+   * one listed first in the template's `conditions` wins.
+   */
+  readonly conditionalValues?: Readonly<Record<string, RemoteConfigParameterValue>>;
+  readonly description?: string;
+}
+/** A test on a device's context; a condition matches when all of its rules do. */
+type RemoteConfigRule = {
+  readonly type: "platform";
+  readonly platforms: readonly ("ios" | "android")[];
+} | {
+  readonly type: "channel";
+  readonly channels: readonly string[];
+} |
+/** A semver range, such as `>=1.4.0` or `2.x`, as release targets use. */
+{
+  readonly type: "appVersion";
+  readonly range: string;
+} |
+/** Devices whose cohort is one of these: numbers from 1 to 1000 or slugs. */
+{
+  readonly type: "cohort";
+  readonly cohorts: readonly string[];
+} |
+/**
+ * A share of numeric cohorts: the devices whose cohort lands in
+ * `[from, to)` percent once `seed` shuffles the 1,000 cohorts. Rules with
+ * one seed pick from one order, so `0–10` and `10–20` never overlap; a new
+ * seed picks other devices. Custom cohorts never match.
+ */
+{
+  readonly type: "percent";
+  readonly seed: string;
+  readonly from: number;
+  readonly to: number;
+} | {
+  readonly type: "fingerprint";
+  readonly hashes: readonly string[];
+} |
+/**
+ * While the server's clock is in `[from, to)`: ISO 8601 date-times in UTC,
+ * either of them open. A device gets the change at its next fetch.
+ */
+{
+  readonly type: "dateTime";
+  readonly from?: string;
+  readonly to?: string;
+};
+interface RemoteConfigCondition {
+  /** Unique in the template; parameters name it in `conditionalValues`. */
+  readonly name: string;
+  /** Every rule must match. */
+  readonly rules: readonly RemoteConfigRule[];
+}
+/**
+ * Everything Remote Config serves, published as a whole and versioned.
+ */
+interface RemoteConfigTemplate {
+  /** In priority order: the first one that matches decides a parameter's value. */
+  readonly conditions: readonly RemoteConfigCondition[];
+  readonly parameters: Readonly<Record<string, RemoteConfigParameter>>;
+}
+/** What the server knows of a device; a rule on a missing field never matches. */
+type RemoteConfigEvaluationContext = Partial<Readonly<{ [K in keyof RemoteConfigDeviceContext]: RemoteConfigDeviceContext[K] | null; }>> & {
+  /**
+   * When to evaluate, in ms since the epoch. The server uses its own clock;
+   * a `dateTime` rule never matches without it.
+   */
+  readonly now?: number;
+};
+//#endregion
+//#region ../remote-config/dist/server/api.d.mts
+//#region src/server/api.d.ts
+/** A published version's record, without its template. */
+interface RemoteConfigVersion {
+  readonly version: number;
+  readonly description: string | null;
+  /** `ROLLBACK` when the version copies `rollbackSource`. */
+  readonly updateType: "PUBLISH" | "ROLLBACK";
+  readonly rollbackSource: number | null;
+  readonly createdAtMs: number;
+}
+interface RemoteConfigVersionDetail extends RemoteConfigVersion {
+  readonly template: RemoteConfigTemplate;
+}
+/** The template devices receive now. */
+interface RemoteConfigActive {
+  /** 0, with an empty template, before the first publish. */
+  readonly version: number;
+  readonly template: RemoteConfigTemplate;
+  readonly updatedAtMs: number | null;
+}
+/**
+ * How a publish or a rollback ended: `conflict` when another publish moved
+ * the active version past `baseVersion` first, so a stale edit never
+ * replaces a newer template.
+ */
+type RemoteConfigPublishResult = {
+  readonly status: "published";
+  readonly version: RemoteConfigVersion;
+} | {
+  readonly status: "conflict";
+  readonly currentVersion: number;
+};
+interface RemoteConfigVersionsPage {
+  /** Newest first. */
+  readonly versions: readonly RemoteConfigVersion[];
+  /** Pass as `cursor` for the next page; absent on the last one. */
+  readonly next?: string;
+}
+/** `hotUpdater.api.remoteConfig`. */
+interface RemoteConfigApi {
+  /** The active template and its version. */
+  getActive(): Promise<RemoteConfigActive>;
+  /**
+   * Validates and publishes a template as the next version. Throws
+   * `RemoteConfigValidationError` for an invalid template.
+   */
+  publish(input: {
+    readonly template: unknown;
+    /** The version the edit started from; 0 before the first publish. */
+    readonly baseVersion: number;
+    readonly description?: string;
+  }): Promise<RemoteConfigPublishResult>;
+  /** Publishes a copy of an earlier version; `not_found` when it does not exist. */
+  rollback(input: {
+    readonly version: number;
+    readonly baseVersion: number;
+    readonly description?: string;
+  }): Promise<RemoteConfigPublishResult | {
+    readonly status: "not_found";
+  }>;
+  /** One page of published versions, newest first. */
+  listVersions(input?: {
+    readonly limit?: number;
+    readonly cursor?: string;
+  }): Promise<RemoteConfigVersionsPage>;
+  /** One version with its template, or null. */
+  getVersion(version: number): Promise<RemoteConfigVersionDetail | null>;
+  /**
+   * What a device with this context receives from `GET /remote-config`, at
+   * `context.now` or, without it, now.
+   */
+  resolve(context: RemoteConfigEvaluationContext): Promise<RemoteConfigFetchResponse>;
+}
+//#endregion
 //#region src/plugins.d.ts
 /**
- * The plugins the managed AWS server runs: Insights, and API keys on every
- * client route. Its Lambda@Edge function imports this list.
+ * The plugins the managed AWS server runs: Insights, API keys on every
+ * client route, and Remote Config. Its Lambda@Edge function imports this list.
  */
 declare const plugins: readonly [import("@hot-updater/plugin-core").HotUpdaterPlugin<"insights", {
   readonly bundle_events: import("@hot-updater/plugin-core").TableDefinition<{
@@ -843,6 +1031,54 @@ declare const plugins: readonly [import("@hot-updater/plugin-core").HotUpdaterPl
   };
 }, {
   readonly clientAuth: true;
-}>];
+}>, import("@hot-updater/plugin-core").HotUpdaterPlugin<"remoteConfig", {
+  readonly remote_config_active: import("@hot-updater/plugin-core").TableDefinition<{
+    readonly id: {
+      readonly type: "string";
+      readonly maxLength: 16;
+    };
+    readonly version: {
+      readonly type: "integer";
+    };
+    readonly template: {
+      readonly type: "json";
+    };
+    readonly updated_at_ms: {
+      readonly type: "integer";
+    };
+  }, {}, {}, readonly ["id"]>;
+  readonly remote_config_versions: import("@hot-updater/plugin-core").TableDefinition<{
+    readonly version: {
+      readonly type: "integer";
+    };
+    readonly template: {
+      readonly type: "json";
+    };
+    readonly description: {
+      readonly type: "string";
+      readonly maxLength: 256;
+      readonly required: false;
+    };
+    readonly update_type: {
+      readonly type: "string";
+      readonly maxLength: 16;
+    };
+    readonly rollback_source: {
+      readonly type: "integer";
+      readonly required: false;
+    };
+    readonly created_at_ms: {
+      readonly type: "integer";
+    };
+  }, {}, {
+    readonly byVersion: {
+      readonly eq: readonly [];
+      readonly sort: readonly ["version"];
+    };
+  }, readonly ["version"]>;
+}, {
+  api: RemoteConfigApi;
+  endpoints: readonly import("@hot-updater/plugin-core").PluginEndpoint[];
+}, {}>];
 //#endregion
 export { CloudFrontDownloadUrlOptions, type DynamoDBConfig, S3StorageConfig, S3StorageConfigWithDownloadUrl, cloudFrontDownloadUrl, dynamoDB, migrateDynamoDB, plugins, s3Storage };

package/dist/index.mjs

@@ -8,6 +8,7 @@ import { DeleteObjectCommand, DeleteObjectsCommand, GetObjectCommand, HeadObject
 import { Upload } from "@aws-sdk/lib-storage";
 import { apiKeys } from "@hot-updater/server/plugins/api-keys";
 import { insights } from "@hot-updater/server/plugins/insights";
+import { remoteConfig } from "@hot-updater/server/plugins/remote-config";
 //#region src/cloudFrontInvalidation.ts
 const DEFAULT_POLL_INTERVAL_MS = 2e3;
 const DEFAULT_TIMEOUT_MS = 3e5;
@@ -582,9 +583,13 @@ function s3Storage(config) {
 //#endregion
 //#region src/plugins.ts
 /**
-* The plugins the managed AWS server runs: Insights, and API keys on every
-* client route. Its Lambda@Edge function imports this list.
+* The plugins the managed AWS server runs: Insights, API keys on every
+* client route, and Remote Config. Its Lambda@Edge function imports this list.
 */
-const plugins = [insights(), apiKeys()];
+const plugins = [
+	insights(),
+	apiKeys(),
+	remoteConfig()
+];
 //#endregion
 export { cloudFrontDownloadUrl, dynamoDB, migrateDynamoDB, plugins, s3Storage };