@hot-updater/protocol 1.0.0-rc.40 → 1.0.0-rc.41

package/dist/index.cjs

@@ -170,7 +170,7 @@ const MAX_STORAGE_VALUE_LENGTH = 65536;
 const pluginStorageKey = (pluginId, key) => `plugins/${encodeURIComponent(pluginId)}/${key}`;
 const createPluginHost = (environment) => {
 	let config = null;
-	/** Hooks by plugin, so a plugin configured again is not set up twice. */
+	/** Hooks and API by plugin, so a plugin configured again is not set up twice. */
 	const setUpPlugins = /* @__PURE__ */ new WeakMap();
 	let activePlugins = [];
 	/** What plugins read and wrote, so a read follows a write before native does. */
@@ -186,7 +186,7 @@ const createPluginHost = (environment) => {
 		console.warn(report.message, error);
 	};
 	const fetchFromServer = async (path, init = {}) => {
-		if (config === null) throw new Error("[HotUpdater] Plugins can fetch only after init or wrap.");
+		if (config === null) throw new Error("[HotUpdater] Plugins can fetch only after HotUpdater.init.");
 		if (/^[a-z][a-z\d+.-]*:/i.test(path) || path.startsWith("//")) throw new TypeError("[HotUpdater] Plugin fetch takes a path relative to baseURL.");
 		const { requestHeaders, requestTimeout } = config;
 		const url = `${await resolveBaseURL(config.baseURL)}/${path.replace(/^\/+/, "")}`;
@@ -264,6 +264,28 @@ const createPluginHost = (environment) => {
 		storage: createStorage(pluginId),
 		now: () => environment.now()
 	});
+	const setUpPlugin = (plugin) => {
+		let result;
+		try {
+			result = plugin.setup(createContext(plugin.id));
+		} catch (error) {
+			reportHookError(`Plugin "${plugin.id}" failed in setup`, error);
+			return {
+				hooks: {},
+				api: void 0
+			};
+		}
+		if (result === void 0 || result === null) return {
+			hooks: {},
+			api: void 0
+		};
+		const unknownKeys = Object.keys(result).filter((key) => key !== "hooks" && key !== "api");
+		if (unknownKeys.length > 0) reportHookError(`Plugin "${plugin.id}" setup returned ${unknownKeys.map((key) => `"${key}"`).join(", ")}; setup returns { hooks, api }`, /* @__PURE__ */ new TypeError("Unexpected setup result"));
+		return {
+			hooks: result.hooks ?? {},
+			api: result.api
+		};
+	};
 	const configurePlugins = (plugins, nextConfig) => {
 		const ids = /* @__PURE__ */ new Set();
 		for (const plugin of plugins ?? []) {
@@ -272,22 +294,20 @@ const createPluginHost = (environment) => {
 			ids.add(plugin.id);
 		}
 		config = nextConfig;
+		const apis = [];
 		activePlugins = (plugins ?? []).map((plugin) => {
-			let hooks = setUpPlugins.get(plugin);
-			if (hooks === void 0) {
-				try {
-					hooks = plugin.setup(createContext(plugin.id)) ?? {};
-				} catch (error) {
-					reportHookError(`Plugin "${plugin.id}" failed in setup`, error);
-					hooks = {};
-				}
-				setUpPlugins.set(plugin, hooks);
+			let setUp = setUpPlugins.get(plugin);
+			if (setUp === void 0) {
+				setUp = setUpPlugin(plugin);
+				setUpPlugins.set(plugin, setUp);
 			}
+			if (setUp.api !== void 0) apis.push([plugin.id, setUp.api]);
 			return {
 				plugin,
-				hooks
+				hooks: setUp.hooks
 			};
 		});
+		return Object.freeze(Object.fromEntries(apis));
 	};
 	const hasPluginHook = (name) => activePlugins.some(({ hooks }) => typeof hooks[name] === "function");
 	const buildPluginEvent = (name, createPayload) => {

package/dist/index.d.cts

@@ -247,10 +247,10 @@ interface UpdateHttpResponse {
   readonly bodyTruncated: boolean;
 }
 /**
- * Lifecycle hooks a plugin returns from `setup`. Hooks observe: the SDK
- * never waits for one and ignores what it returns, and a hook that throws or
- * rejects is reported through `onError`, or a console warning without one,
- * so a plugin can never delay or change an update.
+ * Lifecycle hooks a plugin returns from `setup` as `hooks`. Hooks observe:
+ * the SDK never waits for one and ignores what it returns, and a hook that
+ * throws or rejects is reported through `onError`, or a console warning
+ * without one, so a plugin can never delay or change an update.
  */
 interface HotUpdaterClientHooks {
   /** Called once per JavaScript runtime, after native reports the launch. */
@@ -303,22 +303,46 @@ interface HotUpdaterClientContext {
   /** The current time in milliseconds since the epoch. */
   now(): number;
 }
-interface HotUpdaterClientPlugin {
-  /** Unique among an app's plugins; two plugins with one id throw at init. */
-  readonly id: string;
+/**
+ * What a plugin's `setup` returns: the hooks it observes the SDK with, and
+ * the API `HotUpdater.init` puts on the instance it returns, under the
+ * plugin's id, as `hotUpdater.<id>`.
+ */
+interface HotUpdaterClientSetup<TApi = unknown> {
+  readonly hooks?: HotUpdaterClientHooks;
+  readonly api?: TApi;
+}
+/**
+ * A client plugin with the id `TId` and the API `TApi` it adds to the
+ * instance `HotUpdater.init` returns.
+ */
+interface HotUpdaterClientPlugin<TId extends string = string, TApi = unknown> {
+  /**
+   * Unique among an app's plugins; two plugins with one id throw at init.
+   * It names the plugin's API on the instance, so it cannot be the name of
+   * one of the instance's own methods.
+   */
+  readonly id: TId;
   /**
-   * Called once, when `HotUpdater.init` or `HotUpdater.wrap` first
-   * configures the runtime with this plugin.
+   * Called once for each plugin host it is configured in. The React Native
+   * SDK creates a host for each instance `HotUpdater.init` returns.
    */
-  setup(context: HotUpdaterClientContext): HotUpdaterClientHooks | void;
+  setup(context: HotUpdaterClientContext): HotUpdaterClientSetup<TApi> | void;
 }
+type SetupResult<P> = P extends {
+  setup(context: HotUpdaterClientContext): infer R;
+} ? Exclude<R, void | undefined> : never;
+/** The API a plugin's `setup` returns, or `never` for a plugin without one. */
+type ClientPluginApi<P> = "api" extends keyof SetupResult<P> ? Exclude<SetupResult<P>["api" & keyof SetupResult<P>], undefined> : never;
+/** The plugins' APIs by plugin id, as the instance `HotUpdater.init` returns has them. */
+type ClientPluginApis<TPlugins extends readonly HotUpdaterClientPlugin[]> = { readonly [P in TPlugins[number] as [ClientPluginApi<P>] extends [never] ? never : P["id"]]: ClientPluginApi<P>; };
 /** Declares a client plugin; built-in and third-party plugins use the same contract. */
 declare const defineClientPlugin: <const P extends HotUpdaterClientPlugin>(plugin: P) => P;
 //#endregion
 //#region src/createPluginHost.d.ts
 type PluginHookName = keyof HotUpdaterClientHooks;
 type PluginHookPayload<K extends PluginHookName> = Parameters<NonNullable<HotUpdaterClientHooks[K]>>[0];
-/** The init or wrap settings plugins see through their context. */
+/** The init settings plugins see through their context. */
 interface PluginHostConfig {
   readonly baseURL: HotUpdaterBaseURL;
   readonly requestHeaders?: Record<string, string>;
@@ -348,11 +372,11 @@ interface PluginHostEnvironment {
 }
 interface PluginHost {
   /**
-   * Sets up the plugins of an init or wrap call. A plugin passed to an
-   * earlier call keeps its hooks, and a plugin left out stops receiving
-   * events.
+   * Sets up the plugins of an init call and returns their APIs by plugin
+   * id. A plugin passed to an earlier call keeps its hooks and its API, and
+   * a plugin left out stops receiving events.
    */
-  configurePlugins(plugins: readonly HotUpdaterClientPlugin[] | undefined, config: PluginHostConfig): void;
+  configurePlugins(plugins: readonly HotUpdaterClientPlugin[] | undefined, config: PluginHostConfig): Readonly<Record<string, unknown>>;
   /** Whether any plugin listens to this hook, so callers build events only when one does. */
   hasPluginHook(name: PluginHookName): boolean;
   /**
@@ -552,4 +576,4 @@ declare function isCohortEligibleForUpdate(bundleId: string, cohort: string | nu
 declare const NIL_UUID = "00000000-0000-0000-0000-000000000000";
 declare const isUUIDv7: (value: unknown) => value is string;
 //#endregion
-export { ARTIFACT_PROTOCOL_VERSION, AppReadyResult, ArtifactAsset, ArtifactAssetFile, ArtifactInfo, Bundle, BundleDownloadedInfo, BundleMetadata, BundlePatchArtifact, CatalogAcceptance, CatalogHighWater, ChangedAssetPatch, DEFAULT_ROLLOUT_COHORT_COUNT, DesiredRelease, ExpectedReleaseCatalogScope, HotUpdaterBaseURL, HotUpdaterClientContext, HotUpdaterClientHooks, HotUpdaterClientPlugin, HotUpdaterClientStorage, INVALID_COHORT_ERROR_MESSAGE, MAX_COHORT_LENGTH, MAX_COMPILED_CATALOG_BYTES, MAX_CRASHED_BUNDLES, MAX_DISTINCT_TARGET_COHORTS_PER_SCOPE, MAX_RELEASE_CATALOG_WIRE_BYTES, MAX_TARGET_COHORTS_PER_RELEASE, ManifestArchive, NIL_UUID, NUMERIC_COHORT_SIZE, PersistedSelectionReceipt, Platform, PluginHookName, PluginHookPayload, PluginHost, PluginHostConfig, PluginHostEnvironment, RELEASE_CATALOG_FALLBACK_POLICY, RELEASE_CATALOG_SCHEMA_VERSION, Release, ReleaseCatalog, ReleaseCatalogDescriptor, ReleaseCatalogScopeKeyInput, ReleaseKind, ReleaseOperation, ReleaseSelectionContextInput, ReleaseSelectionInput, ReleaseStrategy, ReleaseTransitionAuthorization, ReleaseTransitionKind, SelectionKind, UpdateCheckResult, UpdateError, UpdateErrorReason, UpdateErrorResource, UpdateErrorStage, UpdateErrorTransport, UpdateHttpResponse, UpdateStatus, UpdateStrategy, assertCanonicalChannelName, assessCatalogAcceptance, authorizeReleaseTransition, canonicalizeAppVersion, createPluginHost, createReleaseCatalogScopeKey, createReleaseSelectionContextHash, decodeChannelKey, defineClientPlugin, encodeChannelKey, getAssetBaseStorageUri, getBundlePatch, getBundlePatches, getDefaultNumericCohort, getManifestFileHash, getManifestStorageUri, getNumericCohortRolloutPosition, getNumericCohortValue, getPatchBaseBundleId, getPatchBaseFileHash, getPatchFileHash, getPatchStorageUri, getRolledOutNumericCohorts, getUtf8ByteLength, hasExpectedReleaseCatalogScope, isCohortEligibleForUpdate, isCustomCohort, isNumericCohort, isReleaseEligibleForCohort, isUUIDv7, isValidCohort, normalizeChannelName, normalizeCohortValue, normalizeRolloutCohortCount, parseReleaseCatalog, parseReleaseCatalogScopeKey, pluginStorageKey, resolveBaseURL, selectDesiredRelease, stripBundleArtifactMetadata };
+export { ARTIFACT_PROTOCOL_VERSION, AppReadyResult, ArtifactAsset, ArtifactAssetFile, ArtifactInfo, Bundle, BundleDownloadedInfo, BundleMetadata, BundlePatchArtifact, CatalogAcceptance, CatalogHighWater, ChangedAssetPatch, ClientPluginApi, ClientPluginApis, DEFAULT_ROLLOUT_COHORT_COUNT, DesiredRelease, ExpectedReleaseCatalogScope, HotUpdaterBaseURL, HotUpdaterClientContext, HotUpdaterClientHooks, HotUpdaterClientPlugin, HotUpdaterClientSetup, HotUpdaterClientStorage, INVALID_COHORT_ERROR_MESSAGE, MAX_COHORT_LENGTH, MAX_COMPILED_CATALOG_BYTES, MAX_CRASHED_BUNDLES, MAX_DISTINCT_TARGET_COHORTS_PER_SCOPE, MAX_RELEASE_CATALOG_WIRE_BYTES, MAX_TARGET_COHORTS_PER_RELEASE, ManifestArchive, NIL_UUID, NUMERIC_COHORT_SIZE, PersistedSelectionReceipt, Platform, PluginHookName, PluginHookPayload, PluginHost, PluginHostConfig, PluginHostEnvironment, RELEASE_CATALOG_FALLBACK_POLICY, RELEASE_CATALOG_SCHEMA_VERSION, Release, ReleaseCatalog, ReleaseCatalogDescriptor, ReleaseCatalogScopeKeyInput, ReleaseKind, ReleaseOperation, ReleaseSelectionContextInput, ReleaseSelectionInput, ReleaseStrategy, ReleaseTransitionAuthorization, ReleaseTransitionKind, SelectionKind, UpdateCheckResult, UpdateError, UpdateErrorReason, UpdateErrorResource, UpdateErrorStage, UpdateErrorTransport, UpdateHttpResponse, UpdateStatus, UpdateStrategy, assertCanonicalChannelName, assessCatalogAcceptance, authorizeReleaseTransition, canonicalizeAppVersion, createPluginHost, createReleaseCatalogScopeKey, createReleaseSelectionContextHash, decodeChannelKey, defineClientPlugin, encodeChannelKey, getAssetBaseStorageUri, getBundlePatch, getBundlePatches, getDefaultNumericCohort, getManifestFileHash, getManifestStorageUri, getNumericCohortRolloutPosition, getNumericCohortValue, getPatchBaseBundleId, getPatchBaseFileHash, getPatchFileHash, getPatchStorageUri, getRolledOutNumericCohorts, getUtf8ByteLength, hasExpectedReleaseCatalogScope, isCohortEligibleForUpdate, isCustomCohort, isNumericCohort, isReleaseEligibleForCohort, isUUIDv7, isValidCohort, normalizeChannelName, normalizeCohortValue, normalizeRolloutCohortCount, parseReleaseCatalog, parseReleaseCatalogScopeKey, pluginStorageKey, resolveBaseURL, selectDesiredRelease, stripBundleArtifactMetadata };

package/dist/index.d.mts

@@ -247,10 +247,10 @@ interface UpdateHttpResponse {
   readonly bodyTruncated: boolean;
 }
 /**
- * Lifecycle hooks a plugin returns from `setup`. Hooks observe: the SDK
- * never waits for one and ignores what it returns, and a hook that throws or
- * rejects is reported through `onError`, or a console warning without one,
- * so a plugin can never delay or change an update.
+ * Lifecycle hooks a plugin returns from `setup` as `hooks`. Hooks observe:
+ * the SDK never waits for one and ignores what it returns, and a hook that
+ * throws or rejects is reported through `onError`, or a console warning
+ * without one, so a plugin can never delay or change an update.
  */
 interface HotUpdaterClientHooks {
   /** Called once per JavaScript runtime, after native reports the launch. */
@@ -303,22 +303,46 @@ interface HotUpdaterClientContext {
   /** The current time in milliseconds since the epoch. */
   now(): number;
 }
-interface HotUpdaterClientPlugin {
-  /** Unique among an app's plugins; two plugins with one id throw at init. */
-  readonly id: string;
+/**
+ * What a plugin's `setup` returns: the hooks it observes the SDK with, and
+ * the API `HotUpdater.init` puts on the instance it returns, under the
+ * plugin's id, as `hotUpdater.<id>`.
+ */
+interface HotUpdaterClientSetup<TApi = unknown> {
+  readonly hooks?: HotUpdaterClientHooks;
+  readonly api?: TApi;
+}
+/**
+ * A client plugin with the id `TId` and the API `TApi` it adds to the
+ * instance `HotUpdater.init` returns.
+ */
+interface HotUpdaterClientPlugin<TId extends string = string, TApi = unknown> {
+  /**
+   * Unique among an app's plugins; two plugins with one id throw at init.
+   * It names the plugin's API on the instance, so it cannot be the name of
+   * one of the instance's own methods.
+   */
+  readonly id: TId;
   /**
-   * Called once, when `HotUpdater.init` or `HotUpdater.wrap` first
-   * configures the runtime with this plugin.
+   * Called once for each plugin host it is configured in. The React Native
+   * SDK creates a host for each instance `HotUpdater.init` returns.
    */
-  setup(context: HotUpdaterClientContext): HotUpdaterClientHooks | void;
+  setup(context: HotUpdaterClientContext): HotUpdaterClientSetup<TApi> | void;
 }
+type SetupResult<P> = P extends {
+  setup(context: HotUpdaterClientContext): infer R;
+} ? Exclude<R, void | undefined> : never;
+/** The API a plugin's `setup` returns, or `never` for a plugin without one. */
+type ClientPluginApi<P> = "api" extends keyof SetupResult<P> ? Exclude<SetupResult<P>["api" & keyof SetupResult<P>], undefined> : never;
+/** The plugins' APIs by plugin id, as the instance `HotUpdater.init` returns has them. */
+type ClientPluginApis<TPlugins extends readonly HotUpdaterClientPlugin[]> = { readonly [P in TPlugins[number] as [ClientPluginApi<P>] extends [never] ? never : P["id"]]: ClientPluginApi<P>; };
 /** Declares a client plugin; built-in and third-party plugins use the same contract. */
 declare const defineClientPlugin: <const P extends HotUpdaterClientPlugin>(plugin: P) => P;
 //#endregion
 //#region src/createPluginHost.d.ts
 type PluginHookName = keyof HotUpdaterClientHooks;
 type PluginHookPayload<K extends PluginHookName> = Parameters<NonNullable<HotUpdaterClientHooks[K]>>[0];
-/** The init or wrap settings plugins see through their context. */
+/** The init settings plugins see through their context. */
 interface PluginHostConfig {
   readonly baseURL: HotUpdaterBaseURL;
   readonly requestHeaders?: Record<string, string>;
@@ -348,11 +372,11 @@ interface PluginHostEnvironment {
 }
 interface PluginHost {
   /**
-   * Sets up the plugins of an init or wrap call. A plugin passed to an
-   * earlier call keeps its hooks, and a plugin left out stops receiving
-   * events.
+   * Sets up the plugins of an init call and returns their APIs by plugin
+   * id. A plugin passed to an earlier call keeps its hooks and its API, and
+   * a plugin left out stops receiving events.
    */
-  configurePlugins(plugins: readonly HotUpdaterClientPlugin[] | undefined, config: PluginHostConfig): void;
+  configurePlugins(plugins: readonly HotUpdaterClientPlugin[] | undefined, config: PluginHostConfig): Readonly<Record<string, unknown>>;
   /** Whether any plugin listens to this hook, so callers build events only when one does. */
   hasPluginHook(name: PluginHookName): boolean;
   /**
@@ -552,4 +576,4 @@ declare function isCohortEligibleForUpdate(bundleId: string, cohort: string | nu
 declare const NIL_UUID = "00000000-0000-0000-0000-000000000000";
 declare const isUUIDv7: (value: unknown) => value is string;
 //#endregion
-export { ARTIFACT_PROTOCOL_VERSION, AppReadyResult, ArtifactAsset, ArtifactAssetFile, ArtifactInfo, Bundle, BundleDownloadedInfo, BundleMetadata, BundlePatchArtifact, CatalogAcceptance, CatalogHighWater, ChangedAssetPatch, DEFAULT_ROLLOUT_COHORT_COUNT, DesiredRelease, ExpectedReleaseCatalogScope, HotUpdaterBaseURL, HotUpdaterClientContext, HotUpdaterClientHooks, HotUpdaterClientPlugin, HotUpdaterClientStorage, INVALID_COHORT_ERROR_MESSAGE, MAX_COHORT_LENGTH, MAX_COMPILED_CATALOG_BYTES, MAX_CRASHED_BUNDLES, MAX_DISTINCT_TARGET_COHORTS_PER_SCOPE, MAX_RELEASE_CATALOG_WIRE_BYTES, MAX_TARGET_COHORTS_PER_RELEASE, ManifestArchive, NIL_UUID, NUMERIC_COHORT_SIZE, PersistedSelectionReceipt, Platform, PluginHookName, PluginHookPayload, PluginHost, PluginHostConfig, PluginHostEnvironment, RELEASE_CATALOG_FALLBACK_POLICY, RELEASE_CATALOG_SCHEMA_VERSION, Release, ReleaseCatalog, ReleaseCatalogDescriptor, ReleaseCatalogScopeKeyInput, ReleaseKind, ReleaseOperation, ReleaseSelectionContextInput, ReleaseSelectionInput, ReleaseStrategy, ReleaseTransitionAuthorization, ReleaseTransitionKind, SelectionKind, UpdateCheckResult, UpdateError, UpdateErrorReason, UpdateErrorResource, UpdateErrorStage, UpdateErrorTransport, UpdateHttpResponse, UpdateStatus, UpdateStrategy, assertCanonicalChannelName, assessCatalogAcceptance, authorizeReleaseTransition, canonicalizeAppVersion, createPluginHost, createReleaseCatalogScopeKey, createReleaseSelectionContextHash, decodeChannelKey, defineClientPlugin, encodeChannelKey, getAssetBaseStorageUri, getBundlePatch, getBundlePatches, getDefaultNumericCohort, getManifestFileHash, getManifestStorageUri, getNumericCohortRolloutPosition, getNumericCohortValue, getPatchBaseBundleId, getPatchBaseFileHash, getPatchFileHash, getPatchStorageUri, getRolledOutNumericCohorts, getUtf8ByteLength, hasExpectedReleaseCatalogScope, isCohortEligibleForUpdate, isCustomCohort, isNumericCohort, isReleaseEligibleForCohort, isUUIDv7, isValidCohort, normalizeChannelName, normalizeCohortValue, normalizeRolloutCohortCount, parseReleaseCatalog, parseReleaseCatalogScopeKey, pluginStorageKey, resolveBaseURL, selectDesiredRelease, stripBundleArtifactMetadata };
+export { ARTIFACT_PROTOCOL_VERSION, AppReadyResult, ArtifactAsset, ArtifactAssetFile, ArtifactInfo, Bundle, BundleDownloadedInfo, BundleMetadata, BundlePatchArtifact, CatalogAcceptance, CatalogHighWater, ChangedAssetPatch, ClientPluginApi, ClientPluginApis, DEFAULT_ROLLOUT_COHORT_COUNT, DesiredRelease, ExpectedReleaseCatalogScope, HotUpdaterBaseURL, HotUpdaterClientContext, HotUpdaterClientHooks, HotUpdaterClientPlugin, HotUpdaterClientSetup, HotUpdaterClientStorage, INVALID_COHORT_ERROR_MESSAGE, MAX_COHORT_LENGTH, MAX_COMPILED_CATALOG_BYTES, MAX_CRASHED_BUNDLES, MAX_DISTINCT_TARGET_COHORTS_PER_SCOPE, MAX_RELEASE_CATALOG_WIRE_BYTES, MAX_TARGET_COHORTS_PER_RELEASE, ManifestArchive, NIL_UUID, NUMERIC_COHORT_SIZE, PersistedSelectionReceipt, Platform, PluginHookName, PluginHookPayload, PluginHost, PluginHostConfig, PluginHostEnvironment, RELEASE_CATALOG_FALLBACK_POLICY, RELEASE_CATALOG_SCHEMA_VERSION, Release, ReleaseCatalog, ReleaseCatalogDescriptor, ReleaseCatalogScopeKeyInput, ReleaseKind, ReleaseOperation, ReleaseSelectionContextInput, ReleaseSelectionInput, ReleaseStrategy, ReleaseTransitionAuthorization, ReleaseTransitionKind, SelectionKind, UpdateCheckResult, UpdateError, UpdateErrorReason, UpdateErrorResource, UpdateErrorStage, UpdateErrorTransport, UpdateHttpResponse, UpdateStatus, UpdateStrategy, assertCanonicalChannelName, assessCatalogAcceptance, authorizeReleaseTransition, canonicalizeAppVersion, createPluginHost, createReleaseCatalogScopeKey, createReleaseSelectionContextHash, decodeChannelKey, defineClientPlugin, encodeChannelKey, getAssetBaseStorageUri, getBundlePatch, getBundlePatches, getDefaultNumericCohort, getManifestFileHash, getManifestStorageUri, getNumericCohortRolloutPosition, getNumericCohortValue, getPatchBaseBundleId, getPatchBaseFileHash, getPatchFileHash, getPatchStorageUri, getRolledOutNumericCohorts, getUtf8ByteLength, hasExpectedReleaseCatalogScope, isCohortEligibleForUpdate, isCustomCohort, isNumericCohort, isReleaseEligibleForCohort, isUUIDv7, isValidCohort, normalizeChannelName, normalizeCohortValue, normalizeRolloutCohortCount, parseReleaseCatalog, parseReleaseCatalogScopeKey, pluginStorageKey, resolveBaseURL, selectDesiredRelease, stripBundleArtifactMetadata };

package/dist/index.mjs

@@ -169,7 +169,7 @@ const MAX_STORAGE_VALUE_LENGTH = 65536;
 const pluginStorageKey = (pluginId, key) => `plugins/${encodeURIComponent(pluginId)}/${key}`;
 const createPluginHost = (environment) => {
 	let config = null;
-	/** Hooks by plugin, so a plugin configured again is not set up twice. */
+	/** Hooks and API by plugin, so a plugin configured again is not set up twice. */
 	const setUpPlugins = /* @__PURE__ */ new WeakMap();
 	let activePlugins = [];
 	/** What plugins read and wrote, so a read follows a write before native does. */
@@ -185,7 +185,7 @@ const createPluginHost = (environment) => {
 		console.warn(report.message, error);
 	};
 	const fetchFromServer = async (path, init = {}) => {
-		if (config === null) throw new Error("[HotUpdater] Plugins can fetch only after init or wrap.");
+		if (config === null) throw new Error("[HotUpdater] Plugins can fetch only after HotUpdater.init.");
 		if (/^[a-z][a-z\d+.-]*:/i.test(path) || path.startsWith("//")) throw new TypeError("[HotUpdater] Plugin fetch takes a path relative to baseURL.");
 		const { requestHeaders, requestTimeout } = config;
 		const url = `${await resolveBaseURL(config.baseURL)}/${path.replace(/^\/+/, "")}`;
@@ -263,6 +263,28 @@ const createPluginHost = (environment) => {
 		storage: createStorage(pluginId),
 		now: () => environment.now()
 	});
+	const setUpPlugin = (plugin) => {
+		let result;
+		try {
+			result = plugin.setup(createContext(plugin.id));
+		} catch (error) {
+			reportHookError(`Plugin "${plugin.id}" failed in setup`, error);
+			return {
+				hooks: {},
+				api: void 0
+			};
+		}
+		if (result === void 0 || result === null) return {
+			hooks: {},
+			api: void 0
+		};
+		const unknownKeys = Object.keys(result).filter((key) => key !== "hooks" && key !== "api");
+		if (unknownKeys.length > 0) reportHookError(`Plugin "${plugin.id}" setup returned ${unknownKeys.map((key) => `"${key}"`).join(", ")}; setup returns { hooks, api }`, /* @__PURE__ */ new TypeError("Unexpected setup result"));
+		return {
+			hooks: result.hooks ?? {},
+			api: result.api
+		};
+	};
 	const configurePlugins = (plugins, nextConfig) => {
 		const ids = /* @__PURE__ */ new Set();
 		for (const plugin of plugins ?? []) {
@@ -271,22 +293,20 @@ const createPluginHost = (environment) => {
 			ids.add(plugin.id);
 		}
 		config = nextConfig;
+		const apis = [];
 		activePlugins = (plugins ?? []).map((plugin) => {
-			let hooks = setUpPlugins.get(plugin);
-			if (hooks === void 0) {
-				try {
-					hooks = plugin.setup(createContext(plugin.id)) ?? {};
-				} catch (error) {
-					reportHookError(`Plugin "${plugin.id}" failed in setup`, error);
-					hooks = {};
-				}
-				setUpPlugins.set(plugin, hooks);
+			let setUp = setUpPlugins.get(plugin);
+			if (setUp === void 0) {
+				setUp = setUpPlugin(plugin);
+				setUpPlugins.set(plugin, setUp);
 			}
+			if (setUp.api !== void 0) apis.push([plugin.id, setUp.api]);
 			return {
 				plugin,
-				hooks
+				hooks: setUp.hooks
 			};
 		});
+		return Object.freeze(Object.fromEntries(apis));
 	};
 	const hasPluginHook = (name) => activePlugins.some(({ hooks }) => typeof hooks[name] === "function");
 	const buildPluginEvent = (name, createPayload) => {

package/package.json

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