@hot-updater/cli-tools 1.0.0-rc.16 → 1.0.0-rc.17

package/dist/index.d.mts

@@ -32,8 +32,40 @@ declare class BuildLogger {
   private showLogFileLocation;
 }
 //#endregion
-//#region src/apiKeyNote.d.ts
-declare const formatApiKeyNote: (apiKey: string) => string;
+//#region src/appSetup.d.ts
+/** The credential init gives an app, through the server's clientAuth plugin. */
+interface AppClientCredential {
+  /** Its name in output, such as "API key". */
+  readonly label: string;
+  /** The request header that carries it. */
+  readonly header: string;
+  readonly value: string;
+}
+/** A client plugin the server's plugins ask an app to add. */
+interface AppClientPlugin {
+  /** The module that exports it. */
+  readonly module: string;
+  /** The export, which the app calls with no arguments. */
+  readonly name: string;
+}
+interface AppSetup {
+  readonly credential?: AppClientCredential;
+  readonly clientPlugins?: readonly AppClientPlugin[];
+}
+/**
+ * The App.tsx code init prints: `HotUpdater.init` with the server's URL,
+ * the header that carries the client credential when the server takes one,
+ * and the client plugins the server's plugins ask for.
+ */
+declare const renderAppSetup: ({ baseURL, credential, clientPlugins }: AppSetup & {
+  readonly baseURL: string;
+}) => string;
+/** Prints the App.tsx code, when the URL is known, and the app's credential. */
+declare const printAppSetup: ({ baseURL, ...setup }: AppSetup & {
+  readonly baseURL?: string;
+  /** Required, so each init passes its server plugins' client plugins. */
+  readonly clientPlugins: readonly AppClientPlugin[];
+}) => void;
 //#endregion
 //#region src/banner.d.ts
 declare const link: (url: string) => string;
@@ -293,8 +325,9 @@ declare const writeHotUpdaterPlugins: (pkg: string, filePath?: string) => Promis
 declare const generateHotUpdaterPlugins: (pkg: string, filePath?: string) => Promise<WriteHotUpdaterPluginsResult>;
 /**
  * The plugins a project's `hotUpdater.plugins.ts` exports, which its server
- * runs; undefined when the project has no such file. The console assembles
- * them in process to read Insights and API keys as the server would.
+ * runs; undefined when the project has no such file. The console and the CLI
+ * assemble them in process as the server does, for the features and commands
+ * the plugins add.
  */
 declare const loadHotUpdaterPlugins: (cwd?: string) => Promise<readonly unknown[] | undefined>;
 //#endregion
@@ -1733,4 +1766,4 @@ type TransformTemplateArgs<T extends string> = { [Key in ExtractPlaceholders<T>]
  */
 declare function transformTemplate<T extends string>(templateString: T, values: TransformTemplateArgs<T>): string;
 //#endregion
-export { BuildLogger, BuildLoggerConfig, BuildType, BundleSigningSession, ConfigBuilder, ConfigBuilderScaffold, ConfigResponse, CreateHotUpdaterConfigScaffoldFromBuilderOptions, CreateHotUpdaterConfigScaffoldOptions, HOT_UPDATER_PLUGINS_PATH, HOT_UPDATER_SERVER_PACKAGE_VERSION_ENV, HotUpdateDirUtil, HotUpdaterConfigOptions, HotUpdaterConfigScaffold, HotUpdaterInitEnv, HotUpdaterLogWriter, IConfigBuilder, ImportInfo, InitEnvFileError, InitError, InitProviderDefinition, InitProviderInputDefinition, InitProviderInputPersistence, LEGACY_BUNDLE_ERROR, LegacyInfrastructureError, ManagedHelperStatement, ManagedHelperStrategy, MissingInitInputsError, PromptProgress, PromptSpinner, ProviderConfig, ReactNativeMetadata, ReadPackageUpResult, RunInitOptions, WriteHotUpdaterConfigResult, WriteHotUpdaterPluginsResult, assertInfrastructureGenerationAtUrl, assertInfrastructureGenerationPayload, assertInitInputs, assertInitProviderInputs, banner, typedColors as colors, confirmInitInputPersistence, copyDirToTmp, createCopiedBundleArtifacts, createHotUpdaterConfigScaffold, createHotUpdaterConfigScaffoldFromBuilder, createLogWriter, createTarBrTargetFiles, createZip, decryptJson, defineInitProvider, encryptJson, ensureInstallPackages, formatApiKeyNote, generateHotUpdaterPlugins, getAndroidSdkPath, getBundleSigningPublicKey, getCwd, getHotUpdaterEnvValue, getHotUpdaterInitInputEnv, getInitProviderEnvVars, getInitProviderTextPromptValues, getMissingInitInputs, getMissingInitProviderInputs, getPackageManager, getReactNativeMetadatas, getStorageFileByteSize, link, loadConfig, loadHotUpdaterPlugins, log, makeEnv, p, prepareBundleSigning, printBanner, putStorageFile, readBundleSigningPublicKeyFile, readHotUpdaterEnv, readHotUpdaterInitEnv, readPackageUp, renderHotUpdaterPlugins, renderImportStatements, resolveHotUpdaterServerVersion, resolveInitProviderInput, resolveInitProviderInputs, resolvePackageVersion, shouldAutoSelectOnlyInitResource, stripAnsi, transformEnv, transformTemplate, writeHotUpdaterConfig, writeHotUpdaterPlugins, writeStorageFile, writeStorageResponseFile };
+export { AppClientCredential, AppClientPlugin, BuildLogger, BuildLoggerConfig, BuildType, BundleSigningSession, ConfigBuilder, ConfigBuilderScaffold, ConfigResponse, CreateHotUpdaterConfigScaffoldFromBuilderOptions, CreateHotUpdaterConfigScaffoldOptions, HOT_UPDATER_PLUGINS_PATH, HOT_UPDATER_SERVER_PACKAGE_VERSION_ENV, HotUpdateDirUtil, HotUpdaterConfigOptions, HotUpdaterConfigScaffold, HotUpdaterInitEnv, HotUpdaterLogWriter, IConfigBuilder, ImportInfo, InitEnvFileError, InitError, InitProviderDefinition, InitProviderInputDefinition, InitProviderInputPersistence, LEGACY_BUNDLE_ERROR, LegacyInfrastructureError, ManagedHelperStatement, ManagedHelperStrategy, MissingInitInputsError, PromptProgress, PromptSpinner, ProviderConfig, ReactNativeMetadata, ReadPackageUpResult, RunInitOptions, WriteHotUpdaterConfigResult, WriteHotUpdaterPluginsResult, assertInfrastructureGenerationAtUrl, assertInfrastructureGenerationPayload, assertInitInputs, assertInitProviderInputs, banner, typedColors as colors, confirmInitInputPersistence, copyDirToTmp, createCopiedBundleArtifacts, createHotUpdaterConfigScaffold, createHotUpdaterConfigScaffoldFromBuilder, createLogWriter, createTarBrTargetFiles, createZip, decryptJson, defineInitProvider, encryptJson, ensureInstallPackages, generateHotUpdaterPlugins, getAndroidSdkPath, getBundleSigningPublicKey, getCwd, getHotUpdaterEnvValue, getHotUpdaterInitInputEnv, getInitProviderEnvVars, getInitProviderTextPromptValues, getMissingInitInputs, getMissingInitProviderInputs, getPackageManager, getReactNativeMetadatas, getStorageFileByteSize, link, loadConfig, loadHotUpdaterPlugins, log, makeEnv, p, prepareBundleSigning, printAppSetup, printBanner, putStorageFile, readBundleSigningPublicKeyFile, readHotUpdaterEnv, readHotUpdaterInitEnv, readPackageUp, renderAppSetup, renderHotUpdaterPlugins, renderImportStatements, resolveHotUpdaterServerVersion, resolveInitProviderInput, resolveInitProviderInputs, resolvePackageVersion, shouldAutoSelectOnlyInitResource, stripAnsi, transformEnv, transformTemplate, writeHotUpdaterConfig, writeHotUpdaterPlugins, writeStorageFile, writeStorageResponseFile };

package/dist/index.mjs

@@ -22905,8 +22905,47 @@ var BuildLogger = class {
 	}
 };
 //#endregion
-//#region src/apiKeyNote.ts
-const formatApiKeyNote = (apiKey) => apiKey;
+//#region src/appSetup.ts
+/**
+* The App.tsx code init prints: `HotUpdater.init` with the server's URL,
+* the header that carries the client credential when the server takes one,
+* and the client plugins the server's plugins ask for.
+*/
+const renderAppSetup = ({ baseURL, credential, clientPlugins = [] }) => [
+	"// Add this to your App.tsx",
+	"import { HotUpdater } from \"@hot-updater/react-native\";",
+	...clientPlugins.map(({ module, name }) => `import { ${name} } from ${JSON.stringify(module)};`),
+	"",
+	"function App() {",
+	"  return null; // Replace with your app root.",
+	"}",
+	"",
+	"HotUpdater.init({",
+	`  baseURL: ${JSON.stringify(baseURL)},`,
+	...credential === void 0 ? [] : [
+		"  requestHeaders: {",
+		`    ${JSON.stringify(credential.header)}: ${JSON.stringify(credential.value)},`,
+		"  },"
+	],
+	...clientPlugins.length === 0 ? [] : [`  plugins: [${clientPlugins.map(({ name }) => `${name}()`).join(", ")}],`],
+	"});",
+	"",
+	"// Call HotUpdater.checkForUpdate({ updateStrategy: \"appVersion\" })",
+	"// when your app is ready to check.",
+	"export default App;"
+].join("\n");
+/** Prints the App.tsx code, when the URL is known, and the app's credential. */
+const printAppSetup = ({ baseURL, ...setup }) => {
+	if (baseURL !== void 0) p.note(renderAppSetup({
+		baseURL,
+		...setup
+	}));
+	const { credential } = setup;
+	if (credential !== void 0) {
+		p.note(credential.value, credential.label);
+		p.log.message(`Store this ${credential.label} separately in a secure place.`);
+	}
+};
 //#endregion
 //#region ../../node_modules/.pnpm/ansi-regex@6.2.2/node_modules/ansi-regex/index.js
 function ansiRegex({ onlyFirst = false } = {}) {
@@ -44583,8 +44622,9 @@ const generateHotUpdaterPlugins = async (pkg, filePath = HOT_UPDATER_PLUGINS_PAT
 };
 /**
 * The plugins a project's `hotUpdater.plugins.ts` exports, which its server
-* runs; undefined when the project has no such file. The console assembles
-* them in process to read Insights and API keys as the server would.
+* runs; undefined when the project has no such file. The console and the CLI
+* assemble them in process as the server does, for the features and commands
+* the plugins add.
 */
 const loadHotUpdaterPlugins = async (cwd = getCwd()) => {
 	const { config, sources } = await loadConfig$1({
@@ -45408,4 +45448,4 @@ function transformTemplate(templateString, values) {
 	return result;
 }
 //#endregion
-export { BuildLogger, ConfigBuilder, HOT_UPDATER_PLUGINS_PATH, HOT_UPDATER_SERVER_PACKAGE_VERSION_ENV, HotUpdateDirUtil, InitEnvFileError, InitError, LEGACY_BUNDLE_ERROR, LegacyInfrastructureError, MissingInitInputsError, assertInfrastructureGenerationAtUrl, assertInfrastructureGenerationPayload, assertInitInputs, assertInitProviderInputs, banner, typedColors as colors, confirmInitInputPersistence, copyDirToTmp, createCopiedBundleArtifacts, createHotUpdaterConfigScaffold, createHotUpdaterConfigScaffoldFromBuilder, createLogWriter, createTarBrTargetFiles, createZip, decryptJson, defineInitProvider, encryptJson, ensureInstallPackages, formatApiKeyNote, generateHotUpdaterPlugins, getAndroidSdkPath, getBundleSigningPublicKey, getCwd, getHotUpdaterEnvValue, getHotUpdaterInitInputEnv, getInitProviderEnvVars, getInitProviderTextPromptValues, getMissingInitInputs, getMissingInitProviderInputs, getPackageManager, getReactNativeMetadatas, getStorageFileByteSize, link, loadConfig, loadHotUpdaterPlugins, log, makeEnv, p, prepareBundleSigning, printBanner, putStorageFile, readBundleSigningPublicKeyFile, readHotUpdaterEnv, readHotUpdaterInitEnv, readPackageUp, renderHotUpdaterPlugins, renderImportStatements, resolveHotUpdaterServerVersion, resolveInitProviderInput, resolveInitProviderInputs, resolvePackageVersion, shouldAutoSelectOnlyInitResource, stripAnsi, transformEnv, transformTemplate, writeHotUpdaterConfig, writeHotUpdaterPlugins, writeStorageFile, writeStorageResponseFile };
+export { BuildLogger, ConfigBuilder, HOT_UPDATER_PLUGINS_PATH, HOT_UPDATER_SERVER_PACKAGE_VERSION_ENV, HotUpdateDirUtil, InitEnvFileError, InitError, LEGACY_BUNDLE_ERROR, LegacyInfrastructureError, MissingInitInputsError, assertInfrastructureGenerationAtUrl, assertInfrastructureGenerationPayload, assertInitInputs, assertInitProviderInputs, banner, typedColors as colors, confirmInitInputPersistence, copyDirToTmp, createCopiedBundleArtifacts, createHotUpdaterConfigScaffold, createHotUpdaterConfigScaffoldFromBuilder, createLogWriter, createTarBrTargetFiles, createZip, decryptJson, defineInitProvider, encryptJson, ensureInstallPackages, generateHotUpdaterPlugins, getAndroidSdkPath, getBundleSigningPublicKey, getCwd, getHotUpdaterEnvValue, getHotUpdaterInitInputEnv, getInitProviderEnvVars, getInitProviderTextPromptValues, getMissingInitInputs, getMissingInitProviderInputs, getPackageManager, getReactNativeMetadatas, getStorageFileByteSize, link, loadConfig, loadHotUpdaterPlugins, log, makeEnv, p, prepareBundleSigning, printAppSetup, printBanner, putStorageFile, readBundleSigningPublicKeyFile, readHotUpdaterEnv, readHotUpdaterInitEnv, readPackageUp, renderAppSetup, renderHotUpdaterPlugins, renderImportStatements, resolveHotUpdaterServerVersion, resolveInitProviderInput, resolveInitProviderInputs, resolvePackageVersion, shouldAutoSelectOnlyInitResource, stripAnsi, transformEnv, transformTemplate, writeHotUpdaterConfig, writeHotUpdaterPlugins, writeStorageFile, writeStorageResponseFile };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hot-updater/cli-tools",
-  "version": "1.0.0-rc.16",
+  "version": "1.0.0-rc.17",
   "type": "module",
   "engines": {
     "node": ">=20.19.0"
@@ -50,7 +50,7 @@
     "oxc-transform": "0.141.0",
     "unconfig": "7.5.0",
     "@hot-updater/core": "1.0.0-rc.15",
-    "@hot-updater/plugin-core": "1.0.0-rc.16"
+    "@hot-updater/plugin-core": "1.0.0-rc.17"
   },
   "devDependencies": {
     "@clack/prompts": "1.7.0",
@@ -64,7 +64,7 @@
     "tar": "^7.5.16",
     "verkit": "0.4.0",
     "workspace-tools": "^0.41.7",
-    "@hot-updater/test-utils": "1.0.0-rc.16"
+    "@hot-updater/test-utils": "1.0.0-rc.17"
   },
   "inlinedDependencies": {
     "@babel/code-frame": "7.29.0",