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

package/dist/plugins/definePlugin.d.mts

@@ -1,200 +1,2 @@
-import { ModuleSchema } from "../database/schema.mjs";
-import { HotUpdaterDatabase } from "../database/database.mjs";
-import { CoreReads } from "../core/reads.mjs";
-//#region src/plugins/definePlugin.d.ts
-type PluginEndpointMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
-interface PluginEndpoint {
-  readonly method: PluginEndpointMethod;
-  /** Relative to the handler's mount; `:name` segments become `params`. */
-  readonly path: string;
-  /**
-   * `"client"` mounts on `handlers.client` behind the client-route policy;
-   * `"admin"` mounts on `handlers.admin`, which the host protects.
-   */
-  readonly access: "client" | "admin";
-  readonly handler: (request: Request, params: Readonly<Record<string, string>>) => Promise<Response>;
-}
-/** The client-route policy a plugin provides, such as a key or token check. */
-interface ClientAuth {
-  /** Request headers the decision reads; core adds them to `Vary` on cacheable client responses. */
-  readonly varyHeaders: readonly string[];
-  /** Whether the request may use client routes; a throw answers 503. */
-  authenticate(headers: Headers): Promise<boolean>;
-}
-interface PluginInstance<Api = unknown> {
-  readonly api: Api;
-  readonly endpoints?: readonly PluginEndpoint[];
-  readonly clientAuth?: ClientAuth;
-}
-/** Core's reads: bundles, Releases, Catalogs, and channels, each through a declared index. Plugins never write core. */
-type CoreReader = CoreReads;
-interface PluginContext<S extends ModuleSchema> {
-  /** The plugin's own tables and aggregates. */
-  readonly db: HotUpdaterDatabase<S>;
-  readonly core: CoreReader;
-  now(): number;
-}
-interface PluginProvides {
-  readonly clientAuth?: true;
-}
-/** An instance whose `clientAuth` matches what the plugin declares it provides. */
-type InstanceFor<TProvides, TInstance> = TProvides extends {
-  readonly clientAuth: true;
-} ? TInstance & {
-  readonly clientAuth: ClientAuth;
-} : TInstance & {
-  readonly clientAuth?: "Declare provides: { clientAuth: true } to return clientAuth";
-};
-/** A positional argument of a plugin command. */
-interface PluginCommandArgument {
-  /** The key of its value in `args`. */
-  readonly name: string;
-  readonly description: string;
-  /** Defaults to true. */
-  readonly required?: boolean;
-}
-/** An option of a plugin command. */
-interface PluginCommandOption {
-  /** Flags as the CLI writes them, such as `--name <name>` or `-y, --yes`. */
-  readonly flags: string;
-  readonly description: string;
-  /** The command fails without it. */
-  readonly required?: boolean;
-}
-interface PluginTableColumn<TKey extends string> {
-  readonly key: TKey;
-  readonly label?: string;
-  /** Styles the padded cell. */
-  readonly format?: (value: string) => string;
-}
-/**
- * The CLI's output style, so plugin commands read like core ones: the
- * formatters return styled text, and the writers print it.
- */
-interface PluginCommandUi {
-  block(heading: string, lines: readonly string[]): string;
-  kv(label: string, value: string): string;
-  table<TKey extends string>(columns: readonly PluginTableColumn<TKey>[], rows: readonly Readonly<Record<TKey, string>>[]): string;
-  id(value: string): string;
-  muted(value: string): string;
-  success(value: string): string;
-  danger(value: string): string;
-  warning(value: string): string;
-  message(text: string): void;
-  info(text: string): void;
-  warn(text: string): void;
-  /** Writes machine-readable output, such as JSON, to stdout. */
-  print(text: string): void;
-  /**
-   * Returns once the user agrees to `message`. Declining ends the command,
-   * and a non-interactive shell fails it, asking for `-y`.
-   */
-  confirm(message: string): Promise<void>;
-}
-/** A plugin command run over a database the CLI opens itself. */
-interface PluginCommandContext<Api = unknown> {
-  /** The plugin's API over that database, assembled as the server assembles it. */
-  readonly api: Api;
-  /** Positional arguments by name. */
-  readonly args: Readonly<Record<string, string | undefined>>;
-  /** Options by camel-cased long flag: `dryRun` for `--dry-run`. */
-  readonly options: Readonly<Record<string, unknown>>;
-  readonly ui: PluginCommandUi;
-}
-/**
- * A `hot-updater` command a plugin adds. It groups `commands`, or runs `run`
- * over a database the CLI opens itself, so it refuses a `standaloneRepository`
- * config. A command that runs also takes the server config's path as its
- * last, optional argument.
- */
-interface PluginCommand<Api = unknown> {
-  /** Lowercase words joined by hyphens, such as `api-key`. */
-  readonly name: string;
-  readonly description: string;
-  readonly arguments?: readonly PluginCommandArgument[];
-  readonly options?: readonly PluginCommandOption[];
-  readonly commands?: readonly PluginCommand<Api>[];
-  run?(context: PluginCommandContext<Api>): Promise<void>;
-}
-/**
- * The credential an app sends to client routes that the plugin's clientAuth
- * guards. Init provisions it and prints the header to send, the agent
- * scaffold stores it, and doctor checks it.
- */
-interface PluginClientCredential<Api = unknown> {
-  /** Its name in output, such as "API key". */
-  readonly label: string;
-  /** The request header that carries it, one of clientAuth's varyHeaders. */
-  readonly header: string;
-  /** The environment variable init stores it in. */
-  readonly env: string;
-  /** A new credential, made without a database, so tooling can save it before registering it. */
-  generate(): string;
-  /** Registers `existing` idempotently, or creates one; returns the credential. */
-  provision(api: Api, input: {
-    readonly existing?: string;
-    readonly name: string;
-  }): Promise<string>;
-}
-/**
- * A client plugin an app adds to `HotUpdater.init`'s `plugins` to work with
- * the server plugin. Init prints it in the app code, and the agent scaffold
- * asks for it.
- */
-interface PluginClientPlugin {
-  /** The module that exports it, such as `@hot-updater/react-native/plugins/insights`. */
-  readonly module: string;
-  /** The export, which the app calls with no arguments, such as `insights`. */
-  readonly name: string;
-}
-/** What a plugin adds to the `hot-updater` CLI. */
-interface PluginCli<Api = unknown> {
-  /** Commands the CLI finds in the project's plugins. */
-  readonly commands?: readonly PluginCommand<Api>[];
-  /** Needs provides: { clientAuth: true }. */
-  readonly clientCredential?: PluginClientCredential<Api>;
-  readonly clientPlugin?: PluginClientPlugin;
-}
-/** CLI additions whose `clientCredential` matches what the plugin declares it provides. */
-type CliFor<TProvides, TApi> = TProvides extends {
-  readonly clientAuth: true;
-} ? PluginCli<TApi> : Omit<PluginCli<TApi>, "clientCredential"> & {
-  readonly clientCredential?: "Declare provides: { clientAuth: true } to add clientCredential";
-};
-interface HotUpdaterPlugin<TId extends string = string, TSchema extends ModuleSchema = ModuleSchema, TInstance extends PluginInstance = PluginInstance, TProvides extends PluginProvides = PluginProvides> {
-  readonly id: TId;
-  /** Static, so the type system and startup can count client-route policies. */
-  readonly provides?: TProvides;
-  /** Stored under the settings key `schema.<id>`. */
-  readonly schemaVersion: string;
-  readonly schema: TSchema;
-  /**
-   * `false` keeps the declared table names instead of prefixing them with
-   * the plugin's id. The plugin then owns collisions with core's tables and
-   * other plugins' tables, which startup checks for the plugins a server
-   * runs, and only such a plugin may take a camelCase id.
-   */
-  readonly namespace?: false;
-  /** Called once at startup, synchronously. */
-  init(context: PluginContext<TSchema>): TInstance;
-  /** Read by the CLI only; the server never runs it. */
-  readonly cli?: PluginCli<TInstance["api"]>;
-  /** Only core modules carry a kind. */
-  readonly kind?: "Core is built in; it is not a plugin";
-}
-/** Declares a plugin; Hot Updater's own plugins and third-party ones use the same contract. */
-declare const definePlugin: <const TId extends string, const TSchema extends ModuleSchema, TInstance extends PluginInstance, const TProvides extends PluginProvides = {}>(plugin: {
-  readonly id: TId;
-  readonly provides?: TProvides;
-  readonly schemaVersion: string;
-  readonly schema: TSchema;
-  readonly namespace?: false;
-  init(context: PluginContext<TSchema>): InstanceFor<TProvides, TInstance>;
-  readonly cli?: CliFor<TProvides, NoInfer<TInstance["api"]>>;
-}) => HotUpdaterPlugin<TId, TSchema, TInstance, TProvides>;
-/** Any plugin, whatever its schema and API. */
-type AnyHotUpdaterPlugin = HotUpdaterPlugin<string, any, any, any>;
-/** Each plugin's API by id. */
-type PluginApis<TPlugins extends readonly AnyHotUpdaterPlugin[]> = { readonly [TPlugin in TPlugins[number] as TPlugin["id"]]: ReturnType<TPlugin["init"]>["api"]; };
-//#endregion
-export { AnyHotUpdaterPlugin, CliFor, ClientAuth, CoreReader, HotUpdaterPlugin, InstanceFor, PluginApis, PluginCli, PluginClientCredential, PluginClientPlugin, PluginCommand, PluginCommandArgument, PluginCommandContext, PluginCommandOption, PluginCommandUi, PluginContext, PluginEndpoint, PluginEndpointMethod, PluginInstance, PluginProvides, PluginTableColumn, definePlugin };
+import { AnyHotUpdaterPlugin, PluginApis } from "@hot-updater/plugin-core";
+export type { AnyHotUpdaterPlugin, PluginApis };

package/dist/plugins/insights/index.cjs

@@ -1,128 +1,9 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_configError = require("../../assembly/configError.cjs");
-const require_definePlugin = require("../definePlugin.cjs");
-const require_busy = require("../../database/busy.cjs");
-const require_model = require("./model.cjs");
-const require_provider = require("./provider.cjs");
-const require_schema = require("./schema.cjs");
-const require_recordEvent = require("./recordEvent.cjs");
-const require_reads = require("./reads.cjs");
-const require_routes = require("./routes.cjs");
-let _hot_updater_plugin_core = require("@hot-updater/plugin-core");
-//#region src/plugins/insights/index.ts
-const createInsightsApi = (db, now, retention) => ({
-	/** How long this plugin keeps its rows. */
-	retention,
-	/** Records one validated event row; a repeated id changes nothing. */
-	recordEvent: (event) => require_recordEvent.recordEvent(db, event),
-	listEvents: (input) => require_reads.listEvents(db, input),
-	findLatestEvents: (input) => require_reads.findLatestEvents(db, input),
-	countLatestEvents: (input) => require_reads.countLatestEvents(db, input),
-	countEvents: (input) => require_reads.countEvents(db, input),
-	getReleaseActivity: (input) => require_reads.getReleaseActivity(db, input, now, retention),
-	getAppUsage: (input) => require_reads.getAppUsage(db, input, now, retention),
-	/** A release's or a channel's update failures, and their breakdown over a time range. */
-	getUpdateFailures: (input) => require_reads.getUpdateFailures(db, input, now, retention)
-});
-/** `GET /failures`'s query: a scope, an optional release, and a time range or none. */
-const readFailuresQuery = (url) => {
-	const query = url.searchParams;
-	const time = (name) => {
-		const value = query.get(name);
-		return value === null ? void 0 : Number(value);
-	};
-	const [start, end] = [time("start"), time("end")];
-	const platform = query.get("platform");
-	const releaseId = query.get("releaseId");
-	if (platform !== "ios" && platform !== "android" || start === void 0 !== (end === void 0)) throw new _hot_updater_plugin_core.DatabasePluginInputError("invalid-query");
-	return {
-		platform,
-		channel: query.get("channel") ?? "",
-		...releaseId === null ? {} : { releaseId },
-		...start === void 0 ? {} : { timeRange: {
-			start,
-			end
-		} }
-	};
-};
-/**
-* The admin route of the update failures read: a release's (`releaseId`)
-* since its first report, or over `start`–`end`, or a channel's over a range,
-* which covers at most 30 days.
-*/
-const failuresEndpoint = (api) => ({
-	access: "admin",
-	method: "GET",
-	path: "/failures",
-	handler: async (request) => {
-		try {
-			return Response.json(await api.getUpdateFailures(readFailuresQuery(new URL(request.url))), { headers: { "cache-control": "private, no-store" } });
-		} catch (error) {
-			if (error instanceof _hot_updater_plugin_core.DatabasePluginInputError) return Response.json({ error: "Send platform and channel, and releaseId or start and end in epoch milliseconds, at most 30 days apart." }, { status: 400 });
-			if (!require_busy.isDatabaseBusyError(error)) throw error;
-			return Response.json({ error: "Service unavailable" }, {
-				status: 503,
-				headers: { "retry-after": "5" }
-			});
+var _hot_updater_plugin_insights_server = require("@hot-updater/plugin-insights/server");
+Object.keys(_hot_updater_plugin_insights_server).forEach(function(k) {
+	if (k !== "default" && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+		enumerable: true,
+		get: function() {
+			return _hot_updater_plugin_insights_server[k];
 		}
-	}
-});
-const retentionOf = ({ retention }) => {
-	const rawDays = retention?.rawDays ?? 90;
-	const dailyDays = retention?.dailyDays ?? 400;
-	const whole = (days) => Number.isSafeInteger(days) && days >= 1;
-	if (!whole(rawDays) || !whole(dailyDays) || dailyDays < rawDays) throw new require_configError.HotUpdaterConfigError(`insights({ retention }) takes whole days of at least 1, with dailyDays at least rawDays; got rawDays ${rawDays} and dailyDays ${dailyDays}.`);
-	return {
-		rawDays,
-		dailyDays
-	};
-};
-/**
-* Insights: bundle lifecycle events and update failures, each
-* installation's latest event, and the counters, gauges, and sketches its
-* reads come from, each kept for its retention. It serves `POST /events` to
-* clients, and the Insights reads, update failures, and retention to admins.
-*/
-const insights = (options = {}) => {
-	const retention = retentionOf(options);
-	return require_definePlugin.definePlugin({
-		id: "insights",
-		namespace: false,
-		schemaVersion: "1.2.0",
-		schema: require_schema.createInsightsSchema(retention),
-		init: ({ db, now }) => {
-			const api = createInsightsApi(db, now, retention);
-			const routes = require_routes.createInsightsRouteHandlers(require_provider.createInsightsProvider(require_model.createInsightsModel(api)));
-			return {
-				api,
-				endpoints: [
-					...require_routes.INSIGHTS_ROUTES.map(({ access, method, path, handler }) => ({
-						access,
-						method,
-						path,
-						handler: (request, params) => routes[handler](params, request)
-					})),
-					failuresEndpoint(api),
-					{
-						access: "admin",
-						method: "GET",
-						path: "/retention",
-						handler: async () => Response.json(retention)
-					}
-				]
-			};
-		},
-		cli: { clientPlugin: {
-			module: "@hot-updater/react-native/plugins/insights",
-			name: "insights"
-		} }
 	});
-};
-//#endregion
-exports.DEFAULT_INSIGHTS_RETENTION = require_schema.DEFAULT_INSIGHTS_RETENTION;
-exports.createInsightsModel = require_model.createInsightsModel;
-exports.createInsightsProvider = require_provider.createInsightsProvider;
-exports.createInsightsSchema = require_schema.createInsightsSchema;
-exports.insights = insights;
-exports.insightsIdentity = require_recordEvent.insightsIdentity;
-exports.insightsSchema = require_schema.insightsSchema;
+});