@hamedb89/localghost 0.1.3 → 0.1.8

package/dist/index.d.ts

@@ -1,11 +1,98 @@
-import { D as DevHostEntry } from './config-Cde1Bich.js';
-export { C as ConfigPattern, L as LOCALGHOST_CONFIG_FILE, R as ReadDevHostsOptions, a as ResolvedDevHostsPath, f as findLocalMdnsHosts, g as getConfigFileCandidates, b as getDevHostsPath, c as getProjectName, p as parseDevHosts, r as readDevHosts, d as resolveDevHostsPath, s as sanitizeProjectName } from './config-Cde1Bich.js';
+import { D as DevHostEntry, R as ReadDevHostsOptions, C as ConfigPattern } from './config-Cde1Bich.js';
+export { L as LOCALGHOST_CONFIG_FILE, a as ResolvedDevHostsPath, f as findLocalMdnsHosts, g as getConfigFileCandidates, b as getDevHostsPath, c as getProjectName, p as parseDevHosts, r as readDevHosts, d as resolveDevHostsPath, s as sanitizeProjectName } from './config-Cde1Bich.js';
+import * as execa from 'execa';
 
+declare const LOCALGHOST_ACTIVITY_VERSION = 1;
+type LocalghostRunMode = "dev" | "run";
+type LocalghostRunRecord = {
+    id: string;
+    mode: LocalghostRunMode;
+    pid: number;
+    cwd: string;
+    projectName: string;
+    startedAt: string;
+    updatedAt: string;
+    configPath?: string;
+    caddyfilePath?: string;
+    caddyPid?: number;
+    childPid?: number;
+    childCommand?: string[];
+    https?: boolean;
+    requestedPort?: number;
+    port?: number;
+    dynamicPort?: boolean;
+    entries: DevHostEntry[];
+};
+type LocalghostActivity = {
+    version: typeof LOCALGHOST_ACTIVITY_VERSION;
+    runs: LocalghostRunRecord[];
+};
+type RegisterLocalghostRunInput = Omit<LocalghostRunRecord, "id" | "pid" | "startedAt" | "updatedAt"> & {
+    id?: string;
+    pid?: number;
+    startedAt?: string;
+};
+declare function getLocalghostActivityPath(env?: NodeJS.ProcessEnv): string;
+declare function isProcessRunning(pid: number): boolean;
+declare function readLocalghostActivity(path?: string): LocalghostActivity;
+declare function writeLocalghostActivity(activity: LocalghostActivity, path?: string): string;
+declare function pruneLocalghostActivity(path?: string): {
+    path: string;
+    pruned: boolean;
+    runs: LocalghostRunRecord[];
+};
+declare function listLocalghostRuns(path?: string): LocalghostRunRecord[];
+declare function registerLocalghostRun(input: RegisterLocalghostRunInput, path?: string): LocalghostRunRecord;
+declare function unregisterLocalghostRun(id: string, path?: string): void;
+
+type CaddyModeOptions = {
+    https?: boolean;
+};
 declare function getCaddyfilePath(cwd?: string): string;
-declare function renderCaddyfile(entries: DevHostEntry[]): string;
-declare function writeCaddyfile(entries: DevHostEntry[], cwd?: string): Promise<string>;
+declare function renderCaddyfile(entries: DevHostEntry[], options?: CaddyModeOptions): string;
+declare function writeCaddyfile(entries: DevHostEntry[], cwd?: string, options?: CaddyModeOptions): Promise<string>;
 declare function validateCaddyfile(path: string): Promise<void>;
 declare function runCaddy(path: string): Promise<void>;
+declare function startCaddy(path: string): execa.ResultPromise<{
+    cwd: string;
+    stdio: "inherit";
+}>;
+declare function trustCaddy(path: string): Promise<void>;
+
+type LocalghostContextOptions = {
+    cwd?: string;
+    project?: string;
+    localghostConfig?: string | false;
+    fileName?: string;
+    configFiles?: string[];
+    configPattern?: ConfigPattern;
+    port?: number;
+    https?: boolean;
+    bindHost?: string | boolean;
+    primaryHost?: string;
+    dynamicPort?: boolean;
+    wwwAlias?: boolean;
+};
+type LocalghostContext = {
+    cwd: string;
+    projectName: string;
+    readOptions: ReadDevHostsOptions;
+    configPath: string;
+    configFileName: string;
+    configEntries: DevHostEntry[];
+    entries: DevHostEntry[];
+    hosts: string[];
+    requestedPort: number;
+    port: number;
+    dynamicPort: boolean;
+    bindHost: string | boolean;
+    primaryHost: string;
+    https: boolean;
+    wwwAlias: boolean;
+    projectConfigPath?: string;
+};
+declare function defineLocalghostConfig<T extends LocalghostContextOptions>(config: T): T;
+declare function resolveLocalghostContext(options?: LocalghostContextOptions): Promise<LocalghostContext>;
 
 type DoctorResult = {
     ok: boolean;
@@ -18,6 +105,12 @@ type DoctorResult = {
 declare function checkCaddy(): Promise<DoctorResult["caddy"]>;
 declare function runDoctor(): Promise<DoctorResult>;
 
+type LocalghostEnvironment = NodeJS.ProcessEnv;
+declare function getProductionReason(env?: LocalghostEnvironment): "LOCALGHOST_ENV=production" | "NODE_ENV=production" | "VERCEL_ENV=production" | "NETLIFY=true and CONTEXT=production" | "CF_PAGES_BRANCH matches CF_PAGES_PRODUCTION_BRANCH" | null;
+declare function isProductionLike(env?: LocalghostEnvironment): boolean;
+declare function assertLocalDevelopment(command: string, env?: LocalghostEnvironment): void;
+declare function getProductionEnvKeys(): readonly ["NODE_ENV", "VERCEL_ENV", "NETLIFY", "CF_PAGES_BRANCH", "LOCALGHOST_ENV"];
+
 type UpdateSystemHostsResult = {
     changed: boolean;
     hostsPath: string;
@@ -58,6 +151,13 @@ declare function packageRunCommand(packageManager: PackageManager, script: strin
 declare function packageAddCommand(packageManager: PackageManager, packageName?: string): string;
 declare function initLocalghost(options?: InitOptions): InitResult;
 
+type FindAvailablePortOptions = {
+    host?: string;
+    maxAttempts?: number;
+};
+declare function isPortAvailable(port: number, host?: string): Promise<boolean>;
+declare function findAvailablePort(startPort: number, options?: FindAvailablePortOptions): Promise<number>;
+
 type DomainRoute = {
     host: string;
     port: number;
@@ -84,15 +184,19 @@ type LocalghostState = {
     hostsTempPath?: string;
     caddyfilePath?: string;
     caddyfileRemoved?: boolean;
+    caddyHttps?: boolean;
+    caddyTrustedAt?: string;
+    caddyTrustPromptedAt?: string;
     entries?: DevHostEntry[];
 };
 type WriteLocalghostStateInput = Omit<LocalghostState, "version" | "updatedAt">;
 declare function getLocalghostStatePath(cwd?: string): string;
 declare function readLocalghostState(cwd?: string): LocalghostState | null;
 declare function writeLocalghostState(cwd: string, state: WriteLocalghostStateInput): string;
+declare function patchLocalghostState(cwd: string, patch: Partial<WriteLocalghostStateInput>): string | null;
 
 declare const LOCALGHOST_PACKAGE_NAME = "@hamedb89/localghost";
-declare const LOCALGHOST_VERSION = "0.1.0";
+declare const LOCALGHOST_VERSION = "0.1.8";
 declare const UPDATE_CHECK_CACHE_TTL_MS: number;
 declare const UPDATE_CHECK_NOTIFY_TTL_MS: number;
 declare const UPDATE_CHECK_TIMEOUT_MS = 900;
@@ -129,4 +233,4 @@ declare function maybeNotifyAboutUpdate(options?: {
     disabled?: boolean;
 }): Promise<void>;
 
-export { DevHostEntry, type DoctorResult, type DomainRoute, type DomainRouteOptions, type InitOptions, type InitResult, LOCALGHOST_PACKAGE_NAME, LOCALGHOST_STATE_FILE, LOCALGHOST_VERSION, type LocalghostState, type LocalghostStateAction, type PackageManager, type RemoveSystemHostsResult, UPDATE_CHECK_CACHE_TTL_MS, UPDATE_CHECK_NOTIFY_TTL_MS, UPDATE_CHECK_TIMEOUT_MS, type UpdateCheckCache, type UpdateCheckResult, type UpdateSystemHostsResult, type WriteLocalghostStateInput, checkCaddy, checkForUpdate, compareVersions, detectPackageManager, formatDomainRoutes, formatUpdateMessage, getCaddyfilePath, getDomainRoutes, getLocalghostStatePath, getSystemHostsPath, getUpdateCheckCachePath, initLocalghost, isNewerVersion, isUpdateCheckDisabled, markUpdateNotified, maybeNotifyAboutUpdate, packageAddCommand, packageRunCommand, readLocalghostState, removeManagedBlock, removeSystemHosts, renderCaddyfile, renderHostsBlock, runCaddy, runDoctor, shouldNotifyAboutUpdate, updateSystemHosts, upsertManagedBlock, validateCaddyfile, writeCaddyfile, writeLocalghostState };
+export { type CaddyModeOptions, ConfigPattern, DevHostEntry, type DoctorResult, type DomainRoute, type DomainRouteOptions, type FindAvailablePortOptions, type InitOptions, type InitResult, LOCALGHOST_ACTIVITY_VERSION, LOCALGHOST_PACKAGE_NAME, LOCALGHOST_STATE_FILE, LOCALGHOST_VERSION, type LocalghostActivity, type LocalghostContext, type LocalghostContextOptions, type LocalghostEnvironment, type LocalghostRunMode, type LocalghostRunRecord, type LocalghostState, type LocalghostStateAction, type PackageManager, ReadDevHostsOptions, type RegisterLocalghostRunInput, type RemoveSystemHostsResult, UPDATE_CHECK_CACHE_TTL_MS, UPDATE_CHECK_NOTIFY_TTL_MS, UPDATE_CHECK_TIMEOUT_MS, type UpdateCheckCache, type UpdateCheckResult, type UpdateSystemHostsResult, type WriteLocalghostStateInput, assertLocalDevelopment, checkCaddy, checkForUpdate, compareVersions, defineLocalghostConfig, detectPackageManager, findAvailablePort, formatDomainRoutes, formatUpdateMessage, getCaddyfilePath, getDomainRoutes, getLocalghostActivityPath, getLocalghostStatePath, getProductionEnvKeys, getProductionReason, getSystemHostsPath, getUpdateCheckCachePath, initLocalghost, isNewerVersion, isPortAvailable, isProcessRunning, isProductionLike, isUpdateCheckDisabled, listLocalghostRuns, markUpdateNotified, maybeNotifyAboutUpdate, packageAddCommand, packageRunCommand, patchLocalghostState, pruneLocalghostActivity, readLocalghostActivity, readLocalghostState, registerLocalghostRun, removeManagedBlock, removeSystemHosts, renderCaddyfile, renderHostsBlock, resolveLocalghostContext, runCaddy, runDoctor, shouldNotifyAboutUpdate, startCaddy, trustCaddy, unregisterLocalghostRun, updateSystemHosts, upsertManagedBlock, validateCaddyfile, writeCaddyfile, writeLocalghostActivity, writeLocalghostState };