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

package/dist/package.mjs

@@ -1,4 +1,4 @@
 //#region package.json
-var version = "1.0.0-rc.18";
+var version = "1.0.0-rc.21";
 //#endregion
 export { version };

package/dist/plugins/api-keys/index.cjs

@@ -1,53 +1,9 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_definePlugin = require("../definePlugin.cjs");
-const require_apiKeys = require("./apiKeys.cjs");
-const require_cli = require("./cli.cjs");
-const require_model = require("./model.cjs");
-const require_schema = require("./schema.cjs");
-//#region src/plugins/api-keys/index.ts
-/**
-* API keys: protects client routes with keys whose SHA-256 digests
-* are stored, and manages them in-process.
-*/
-const apiKeys = (options = {}) => {
-	const headerName = require_apiKeys.normalizeApiKeyHeaderName(options.headerName ?? "x-api-key");
-	return require_definePlugin.definePlugin({
-		id: "apiKeys",
-		namespace: false,
-		provides: { clientAuth: true },
-		schemaVersion: "1.0.0",
-		schema: require_schema.apiKeysSchema,
-		init: ({ db }) => {
-			const model = require_model.createApiKeyModel(db);
-			return {
-				api: {
-					...require_apiKeys.createApiKeyManagement({ apiKeys: model }),
-					/** Registers a known plaintext key idempotently, for managed init. */
-					register: (input) => require_apiKeys.registerApiKey({
-						...input,
-						apiKeys: model
-					}),
-					/** Reuses a saved key or creates one, for managed init. */
-					provision: (input) => require_apiKeys.provisionApiKey({
-						...input,
-						apiKeys: model
-					})
-				},
-				clientAuth: {
-					varyHeaders: [headerName],
-					authenticate: (headers) => require_apiKeys.authenticateApiKey({
-						apiKeys: model,
-						headerName,
-						request: { headers }
-					})
-				}
-			};
-		},
-		cli: require_cli.apiKeysCli(headerName)
+var _hot_updater_plugin_api_keys_server = require("@hot-updater/plugin-api-keys/server");
+Object.keys(_hot_updater_plugin_api_keys_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_api_keys_server[k];
+		}
 	});
-};
-//#endregion
-exports.API_KEY_HEADER_NAME = require_apiKeys.API_KEY_HEADER_NAME;
-exports.apiKeys = apiKeys;
-exports.apiKeysSchema = require_schema.apiKeysSchema;
-exports.createApiKeyModel = require_model.createApiKeyModel;
+});

package/dist/plugins/api-keys/index.d.cts

@@ -1,84 +1 @@
-import { TableDefinition } from "../../database/schema.cjs";
-import { HotUpdaterPlugin } from "../definePlugin.cjs";
-import "../index.cjs";
-import { ApiKeysSchema, apiKeysSchema } from "./schema.cjs";
-import { ApiKeyModel, ApiKeyRow, createApiKeyModel } from "./model.cjs";
-import { API_KEY_HEADER_NAME, ApiKeyManagementAPI, ApiKeyMetadata, CreatedApiKey } from "./apiKeys.cjs";
-//#region src/plugins/api-keys/index.d.ts
-interface ApiKeysOptions {
-  /** The request header that carries the key; defaults to `x-api-key`. */
-  readonly headerName?: string;
-}
-/**
- * API keys: protects client routes with keys whose SHA-256 digests
- * are stored, and manages them in-process.
- */
-declare const apiKeys: (options?: ApiKeysOptions) => HotUpdaterPlugin<"apiKeys", {
-  readonly api_keys: TableDefinition<{
-    readonly id: {
-      readonly type: "string";
-      readonly maxLength: 255;
-    };
-    readonly hash: {
-      readonly type: "string";
-      readonly maxLength: 64;
-      readonly unique: true;
-    };
-    readonly name: {
-      readonly type: "string";
-      readonly maxLength: 64;
-    };
-    readonly prefix: {
-      readonly type: "string";
-      readonly maxLength: 16;
-    };
-    readonly role: {
-      readonly type: "string";
-      readonly maxLength: 16;
-    };
-    readonly created_at_ms: {
-      readonly type: "integer";
-    };
-    readonly revoked_at_ms: {
-      readonly type: "integer";
-      readonly required: false;
-    };
-  }, {}, {
-    readonly byCreated: {
-      readonly eq: readonly [];
-      readonly sort: readonly ["created_at_ms"];
-    };
-  }, readonly ["id"]>;
-}, {
-  api: {
-    /** Registers a known plaintext key idempotently, for managed init. */
-    register: (input: {
-      readonly apiKey: string;
-      readonly name: string;
-      readonly createdAtMs?: number;
-    }) => Promise<CreatedApiKey>;
-    /** Reuses a saved key or creates one, for managed init. */
-    provision: (input: {
-      readonly existingApiKey?: string;
-      readonly name: string;
-    }) => Promise<CreatedApiKey>;
-    create(input: {
-      readonly name: string;
-    }): Promise<{
-      readonly apiKey: string;
-      readonly record: ApiKeyMetadata;
-    }>;
-    list(): Promise<readonly ApiKeyMetadata[]>;
-    revoke(input: {
-      readonly id: string;
-    }): Promise<ApiKeyMetadata | null>;
-  };
-  clientAuth: {
-    varyHeaders: string[];
-    authenticate: (headers: Headers) => Promise<boolean>;
-  };
-}, {
-  readonly clientAuth: true;
-}>;
-//#endregion
-export { API_KEY_HEADER_NAME, type ApiKeyManagementAPI, type ApiKeyMetadata, type ApiKeyModel, type ApiKeyRow, ApiKeysOptions, type ApiKeysSchema, type CreatedApiKey, apiKeys, apiKeysSchema, createApiKeyModel };
+export * from "@hot-updater/plugin-api-keys/server";

package/dist/plugins/api-keys/index.d.mts

@@ -1,84 +1 @@
-import { TableDefinition } from "../../database/schema.mjs";
-import { HotUpdaterPlugin } from "../definePlugin.mjs";
-import "../index.mjs";
-import { ApiKeysSchema, apiKeysSchema } from "./schema.mjs";
-import { ApiKeyModel, ApiKeyRow, createApiKeyModel } from "./model.mjs";
-import { API_KEY_HEADER_NAME, ApiKeyManagementAPI, ApiKeyMetadata, CreatedApiKey } from "./apiKeys.mjs";
-//#region src/plugins/api-keys/index.d.ts
-interface ApiKeysOptions {
-  /** The request header that carries the key; defaults to `x-api-key`. */
-  readonly headerName?: string;
-}
-/**
- * API keys: protects client routes with keys whose SHA-256 digests
- * are stored, and manages them in-process.
- */
-declare const apiKeys: (options?: ApiKeysOptions) => HotUpdaterPlugin<"apiKeys", {
-  readonly api_keys: TableDefinition<{
-    readonly id: {
-      readonly type: "string";
-      readonly maxLength: 255;
-    };
-    readonly hash: {
-      readonly type: "string";
-      readonly maxLength: 64;
-      readonly unique: true;
-    };
-    readonly name: {
-      readonly type: "string";
-      readonly maxLength: 64;
-    };
-    readonly prefix: {
-      readonly type: "string";
-      readonly maxLength: 16;
-    };
-    readonly role: {
-      readonly type: "string";
-      readonly maxLength: 16;
-    };
-    readonly created_at_ms: {
-      readonly type: "integer";
-    };
-    readonly revoked_at_ms: {
-      readonly type: "integer";
-      readonly required: false;
-    };
-  }, {}, {
-    readonly byCreated: {
-      readonly eq: readonly [];
-      readonly sort: readonly ["created_at_ms"];
-    };
-  }, readonly ["id"]>;
-}, {
-  api: {
-    /** Registers a known plaintext key idempotently, for managed init. */
-    register: (input: {
-      readonly apiKey: string;
-      readonly name: string;
-      readonly createdAtMs?: number;
-    }) => Promise<CreatedApiKey>;
-    /** Reuses a saved key or creates one, for managed init. */
-    provision: (input: {
-      readonly existingApiKey?: string;
-      readonly name: string;
-    }) => Promise<CreatedApiKey>;
-    create(input: {
-      readonly name: string;
-    }): Promise<{
-      readonly apiKey: string;
-      readonly record: ApiKeyMetadata;
-    }>;
-    list(): Promise<readonly ApiKeyMetadata[]>;
-    revoke(input: {
-      readonly id: string;
-    }): Promise<ApiKeyMetadata | null>;
-  };
-  clientAuth: {
-    varyHeaders: string[];
-    authenticate: (headers: Headers) => Promise<boolean>;
-  };
-}, {
-  readonly clientAuth: true;
-}>;
-//#endregion
-export { API_KEY_HEADER_NAME, type ApiKeyManagementAPI, type ApiKeyMetadata, type ApiKeyModel, type ApiKeyRow, ApiKeysOptions, type ApiKeysSchema, type CreatedApiKey, apiKeys, apiKeysSchema, createApiKeyModel };
+export * from "@hot-updater/plugin-api-keys/server";

package/dist/plugins/api-keys/index.mjs

@@ -1,49 +1,2 @@
-import { definePlugin } from "../definePlugin.mjs";
-import { API_KEY_HEADER_NAME, authenticateApiKey, createApiKeyManagement, normalizeApiKeyHeaderName, provisionApiKey, registerApiKey } from "./apiKeys.mjs";
-import { apiKeysCli } from "./cli.mjs";
-import { createApiKeyModel } from "./model.mjs";
-import { apiKeysSchema } from "./schema.mjs";
-//#region src/plugins/api-keys/index.ts
-/**
-* API keys: protects client routes with keys whose SHA-256 digests
-* are stored, and manages them in-process.
-*/
-const apiKeys = (options = {}) => {
-	const headerName = normalizeApiKeyHeaderName(options.headerName ?? "x-api-key");
-	return definePlugin({
-		id: "apiKeys",
-		namespace: false,
-		provides: { clientAuth: true },
-		schemaVersion: "1.0.0",
-		schema: apiKeysSchema,
-		init: ({ db }) => {
-			const model = createApiKeyModel(db);
-			return {
-				api: {
-					...createApiKeyManagement({ apiKeys: model }),
-					/** Registers a known plaintext key idempotently, for managed init. */
-					register: (input) => registerApiKey({
-						...input,
-						apiKeys: model
-					}),
-					/** Reuses a saved key or creates one, for managed init. */
-					provision: (input) => provisionApiKey({
-						...input,
-						apiKeys: model
-					})
-				},
-				clientAuth: {
-					varyHeaders: [headerName],
-					authenticate: (headers) => authenticateApiKey({
-						apiKeys: model,
-						headerName,
-						request: { headers }
-					})
-				}
-			};
-		},
-		cli: apiKeysCli(headerName)
-	});
-};
-//#endregion
-export { API_KEY_HEADER_NAME, apiKeys, apiKeysSchema, createApiKeyModel };
+export * from "@hot-updater/plugin-api-keys/server";
+export {};

package/dist/plugins/definePlugin.d.cts

@@ -1,200 +1,2 @@
-import { ModuleSchema } from "../database/schema.cjs";
-import { HotUpdaterDatabase } from "../database/database.cjs";
-import { CoreReads } from "../core/reads.cjs";
-//#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 };