@hamedb89/localghost 0.1.6 → 0.1.9

package/dist/index.d.ts

@@ -1,9 +1,9 @@
-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 { D as DevHostEntry, R as ReadDevHostsOptions, a as GhostTunnelConfig, C as ConfigPattern, G as GhostTunnelOptions } from './tunnel-DzfLXZ8O.js';
+export { b as ConstructGhostTunnelUrlInput, c as GhostTunnelDisplayDefaults, d as GhostTunnelDomainOptions, e as GhostTunnelMode, f as GhostTunnelNamespaceConfig, g as GhostTunnelNamespaceOptions, h as GhostTunnelNamespaceTag, i as GhostTunnelNamespaceValues, j as GhostTunnelPreviewOptions, k as GhostTunnelRoute, L as LOCALGHOST_CONFIG_FILE, l as ResolvedDevHostsPath, m as assertSecureGhostTunnelRequest, n as constructGhostTunnelHost, o as constructGhostTunnelURL, p as constructGhostTunnelUrl, q as findLocalMdnsHosts, r as getConfigFileCandidates, s as getDevHostsPath, t as getGhostTunnelDefaultDisplayUrl, u as getGhostTunnelDisplayUrl, v as getGhostTunnelDisplayUrls, w as getGhostTunnelEntryHost, x as getGhostTunnelPreviewUrl, y as getGhostTunnelWildcardHost, z as getProjectName, A as parseDevHosts, B as parseGhostTunnelHost, E as readDevHosts, F as resolveDevHostsPath, H as resolveGhostTunnelConfig, I as sanitizeProjectName } from './tunnel-DzfLXZ8O.js';
 import * as execa from 'execa';
 
 declare const LOCALGHOST_ACTIVITY_VERSION = 1;
-type LocalghostRunMode = "dev" | "run";
+type LocalghostRunMode = "dev" | "run" | "vite";
 type LocalghostRunRecord = {
     id: string;
     mode: LocalghostRunMode;
@@ -23,15 +23,29 @@ type LocalghostRunRecord = {
     dynamicPort?: boolean;
     entries: DevHostEntry[];
 };
+type LocalghostSetupRecord = {
+    id: string;
+    cwd: string;
+    projectName: string;
+    updatedAt: string;
+    configPath?: string;
+    caddyfilePath?: string;
+    https?: boolean;
+    entries: DevHostEntry[];
+};
 type LocalghostActivity = {
     version: typeof LOCALGHOST_ACTIVITY_VERSION;
     runs: LocalghostRunRecord[];
+    setups: LocalghostSetupRecord[];
 };
 type RegisterLocalghostRunInput = Omit<LocalghostRunRecord, "id" | "pid" | "startedAt" | "updatedAt"> & {
     id?: string;
     pid?: number;
     startedAt?: string;
 };
+type RegisterLocalghostSetupInput = Omit<LocalghostSetupRecord, "id" | "updatedAt"> & {
+    id?: string;
+};
 declare function getLocalghostActivityPath(env?: NodeJS.ProcessEnv): string;
 declare function isProcessRunning(pid: number): boolean;
 declare function readLocalghostActivity(path?: string): LocalghostActivity;
@@ -40,10 +54,18 @@ declare function pruneLocalghostActivity(path?: string): {
     path: string;
     pruned: boolean;
     runs: LocalghostRunRecord[];
+    setups: LocalghostSetupRecord[];
 };
 declare function listLocalghostRuns(path?: string): LocalghostRunRecord[];
+declare function listLocalghostSetups(path?: string): LocalghostSetupRecord[];
 declare function registerLocalghostRun(input: RegisterLocalghostRunInput, path?: string): LocalghostRunRecord;
+declare function registerLocalghostSetup(input: RegisterLocalghostSetupInput, path?: string): LocalghostSetupRecord;
 declare function unregisterLocalghostRun(id: string, path?: string): void;
+declare function unregisterLocalghostSetup(options: {
+    cwd: string;
+    projectName?: string;
+    configPath?: string;
+}, path?: string): void;
 
 type CaddyModeOptions = {
     https?: boolean;
@@ -57,10 +79,12 @@ 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;
@@ -69,6 +93,8 @@ type LocalghostContextOptions = {
     bindHost?: string | boolean;
     primaryHost?: string;
     dynamicPort?: boolean;
+    wwwAlias?: boolean;
+    ghostTunnel?: GhostTunnelOptions;
 };
 type LocalghostContext = {
     cwd: string;
@@ -85,7 +111,19 @@ type LocalghostContext = {
     bindHost: string | boolean;
     primaryHost: string;
     https: boolean;
+    wwwAlias: boolean;
+    ghostTunnel: GhostTunnelConfig;
+    projectConfigPath?: string;
+};
+type LocalghostProjectConfig = Omit<LocalghostContextOptions, "cwd" | "localghostConfig">;
+type LocalghostProjectConfigResult = {
+    config: LocalghostProjectConfig;
+    path?: string;
 };
+declare function readLocalghostProjectConfig(options?: {
+    cwd?: string;
+    configFile?: string | false;
+}): Promise<LocalghostProjectConfigResult>;
 declare function defineLocalghostConfig<T extends LocalghostContextOptions>(config: T): T;
 declare function resolveLocalghostContext(options?: LocalghostContextOptions): Promise<LocalghostContext>;
 
@@ -153,6 +191,92 @@ type FindAvailablePortOptions = {
 declare function isPortAvailable(port: number, host?: string): Promise<boolean>;
 declare function findAvailablePort(startPort: number, options?: FindAvailablePortOptions): Promise<number>;
 
+type RelayProtocol = "http" | "https";
+type RelayAccessMode = "private" | "public";
+type RelayLocalTarget = {
+    protocol?: RelayProtocol;
+    host: string;
+    port: number;
+};
+type RelayLimits = {
+    requestBodyBytes: number;
+    responseBytes: number;
+    timeoutMs: number;
+    maxConcurrentRequests: number;
+    perRouteRequestsPerMinute: number;
+    perIpRequestsPerMinute: number;
+};
+type RelayTargetPolicy = {
+    allowedHosts: string[];
+    blockedPorts: number[];
+    allowPrivateNetworkTargets: boolean;
+};
+type RelayRouteClaim = {
+    host: string;
+    scope: string;
+    expiresAt: string;
+    agentId: string;
+};
+type SignedRelayRouteClaim = {
+    payload: RelayRouteClaim;
+    token: string;
+};
+type RelayRouteRegistrationInput = {
+    authorizationHeader?: string | null;
+    agentToken: string;
+    claimToken: string;
+    signingSecret: string;
+    expectedScope: string;
+    target: RelayLocalTarget;
+    access?: RelayAccessMode;
+    publicMode?: boolean;
+    passwordProtected?: boolean;
+    authRequired?: boolean;
+    now?: Date;
+    targetPolicy?: Partial<RelayTargetPolicy>;
+    limits?: Partial<RelayLimits>;
+};
+type ActiveRelayRoute = {
+    host: string;
+    scope: string;
+    agentId: string;
+    expiresAt: string;
+    target: Required<RelayLocalTarget>;
+    access: RelayAccessMode;
+    passwordProtected: boolean;
+    authRequired: boolean;
+    limits: RelayLimits;
+};
+type RelayOfflineResponse = {
+    status: 503;
+    headers: Record<string, string>;
+    body: string;
+};
+declare const DEFAULT_RELAY_ALLOWED_TARGET_HOSTS: readonly ["localhost", "127.0.0.1", "::1"];
+declare const DEFAULT_RELAY_BLOCKED_PORTS: readonly [22, 2375, 2376, 5432, 6379, 9200, 9229, 27017];
+declare const DEFAULT_RELAY_LIMITS: RelayLimits;
+declare const DEFAULT_RELAY_TARGET_POLICY: RelayTargetPolicy;
+declare function assertExactRelayHost(host: string): string;
+declare function assertRelayLocalTarget(target: RelayLocalTarget, policyInput?: Partial<RelayTargetPolicy>): Required<RelayLocalTarget>;
+declare function authenticateRelayAgentToken(input: {
+    authorizationHeader?: string | null;
+    agentToken: string;
+}): boolean;
+declare function signRelayRouteClaim(claim: RelayRouteClaim, signingSecret: string): SignedRelayRouteClaim;
+declare function verifyRelayRouteClaim(token: string, signingSecret: string, options: {
+    expectedScope: string;
+    now?: Date;
+}): RelayRouteClaim;
+declare function createRelayRouteRegistration(input: RelayRouteRegistrationInput): ActiveRelayRoute;
+declare function isRelayRouteActive(route: ActiveRelayRoute, options: {
+    agentConnected: boolean;
+    now?: Date;
+}): boolean;
+declare function stripRelayForwardHeaders(headers: Record<string, string | string[] | undefined>): Record<string, string | string[]>;
+declare function redactRelayHeaders(headers: Record<string, string | string[] | undefined>): Record<string, string | string[]>;
+declare function redactRelayLogUrl(input: string): string;
+declare function renderRelayOfflineResponse(): RelayOfflineResponse;
+
 type DomainRoute = {
     host: string;
     port: number;
@@ -162,8 +286,14 @@ type DomainRoute = {
 type DomainRouteOptions = {
     https?: boolean;
 };
+type GhostTunnelFormatOptions = {
+    color?: boolean;
+    label?: "configured" | "expected" | "ready" | "running";
+    verbose?: boolean;
+};
 declare function getDomainRoutes(entries: DevHostEntry[], options?: DomainRouteOptions): DomainRoute[];
 declare function formatDomainRoutes(entries: DevHostEntry[], options?: DomainRouteOptions): string;
+declare function formatGhostTunnel(config: GhostTunnelConfig, options?: GhostTunnelFormatOptions): string | null;
 
 declare const LOCALGHOST_STATE_FILE = "ops/local/localghost-state.json";
 type LocalghostStateAction = "setup" | "teardown";
@@ -180,15 +310,18 @@ type LocalghostState = {
     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.6";
+declare const LOCALGHOST_VERSION = "0.1.9";
 declare const UPDATE_CHECK_CACHE_TTL_MS: number;
 declare const UPDATE_CHECK_NOTIFY_TTL_MS: number;
 declare const UPDATE_CHECK_TIMEOUT_MS = 900;
@@ -225,4 +358,4 @@ declare function maybeNotifyAboutUpdate(options?: {
     disabled?: boolean;
 }): Promise<void>;
 
-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, pruneLocalghostActivity, readLocalghostActivity, readLocalghostState, registerLocalghostRun, removeManagedBlock, removeSystemHosts, renderCaddyfile, renderHostsBlock, resolveLocalghostContext, runCaddy, runDoctor, shouldNotifyAboutUpdate, startCaddy, unregisterLocalghostRun, updateSystemHosts, upsertManagedBlock, validateCaddyfile, writeCaddyfile, writeLocalghostActivity, writeLocalghostState };
+export { type ActiveRelayRoute, type CaddyModeOptions, ConfigPattern, DEFAULT_RELAY_ALLOWED_TARGET_HOSTS, DEFAULT_RELAY_BLOCKED_PORTS, DEFAULT_RELAY_LIMITS, DEFAULT_RELAY_TARGET_POLICY, DevHostEntry, type DoctorResult, type DomainRoute, type DomainRouteOptions, type FindAvailablePortOptions, GhostTunnelConfig, GhostTunnelOptions, type InitOptions, type InitResult, LOCALGHOST_ACTIVITY_VERSION, LOCALGHOST_PACKAGE_NAME, LOCALGHOST_STATE_FILE, LOCALGHOST_VERSION, type LocalghostActivity, type LocalghostContext, type LocalghostContextOptions, type LocalghostEnvironment, type LocalghostProjectConfig, type LocalghostProjectConfigResult, type LocalghostRunMode, type LocalghostRunRecord, type LocalghostSetupRecord, type LocalghostState, type LocalghostStateAction, type PackageManager, ReadDevHostsOptions, type RegisterLocalghostRunInput, type RegisterLocalghostSetupInput, type RelayAccessMode, type RelayLimits, type RelayLocalTarget, type RelayOfflineResponse, type RelayProtocol, type RelayRouteClaim, type RelayRouteRegistrationInput, type RelayTargetPolicy, type RemoveSystemHostsResult, type SignedRelayRouteClaim, UPDATE_CHECK_CACHE_TTL_MS, UPDATE_CHECK_NOTIFY_TTL_MS, UPDATE_CHECK_TIMEOUT_MS, type UpdateCheckCache, type UpdateCheckResult, type UpdateSystemHostsResult, type WriteLocalghostStateInput, assertExactRelayHost, assertLocalDevelopment, assertRelayLocalTarget, authenticateRelayAgentToken, checkCaddy, checkForUpdate, compareVersions, createRelayRouteRegistration, defineLocalghostConfig, detectPackageManager, findAvailablePort, formatDomainRoutes, formatGhostTunnel, formatUpdateMessage, getCaddyfilePath, getDomainRoutes, getLocalghostActivityPath, getLocalghostStatePath, getProductionEnvKeys, getProductionReason, getSystemHostsPath, getUpdateCheckCachePath, initLocalghost, isNewerVersion, isPortAvailable, isProcessRunning, isProductionLike, isRelayRouteActive, isUpdateCheckDisabled, listLocalghostRuns, listLocalghostSetups, markUpdateNotified, maybeNotifyAboutUpdate, packageAddCommand, packageRunCommand, patchLocalghostState, pruneLocalghostActivity, readLocalghostActivity, readLocalghostProjectConfig, readLocalghostState, redactRelayHeaders, redactRelayLogUrl, registerLocalghostRun, registerLocalghostSetup, removeManagedBlock, removeSystemHosts, renderCaddyfile, renderHostsBlock, renderRelayOfflineResponse, resolveLocalghostContext, runCaddy, runDoctor, shouldNotifyAboutUpdate, signRelayRouteClaim, startCaddy, stripRelayForwardHeaders, trustCaddy, unregisterLocalghostRun, unregisterLocalghostSetup, updateSystemHosts, upsertManagedBlock, validateCaddyfile, verifyRelayRouteClaim, writeCaddyfile, writeLocalghostActivity, writeLocalghostState };