localpreview 0.1.0

package/README.md

@@ -0,0 +1,114 @@
+# localpreview
+
+Node CLI for opening an ephemeral LocalPreview session from a local development
+server to a public URL.
+
+## Usage
+
+```sh
+localpreview connect 3000
+localpreview connect https://localhost:3000
+localpreview connect 3000 --name proyecto
+localpreview connect 3000 -l
+```
+
+`localpreview <target>` is still accepted as a deprecated compatibility alias and
+prints a warning. New usage should prefer `localpreview connect <target>`.
+
+Targets are parsed by `@localpreview/protocol`:
+
+- `4000` means `http://127.0.0.1:4000`.
+- URLs must use `http` or `https`.
+- URL targets must include an explicit port.
+
+## Runtime Flow
+
+1. The CLI validates the target and optional `--name`.
+2. It calls the control-plane `POST /api/tunnels`.
+3. The control-plane returns the public URL, relay WebSocket URL, tunnel id, and
+   client token.
+4. The CLI connects to the relay over WebSocket.
+5. Browser requests flow through:
+
+```txt
+browser -> control-plane -> relay -> CLI WebSocket -> local target
+```
+
+6. When the process exits or receives `SIGINT`/`SIGTERM`, the CLI closes the
+   relay connection and sends `DELETE /api/tunnels/:id` as best-effort cleanup.
+
+## Implementation Shape
+
+The package is structured as small Effect-backed services:
+
+- `src/command.ts`: command parsing, legacy alias handling, and top-level flow.
+- `src/config.ts`: runtime defaults and environment-derived limits.
+- `src/control-plane.ts`: tunnel create/delete HTTP adapter.
+- `src/relay-client.ts`: WebSocket lifecycle, signals, and relay event handling.
+- `src/local-proxy.ts`: relay message handling and local HTTP forwarding.
+- `src/errors.ts`: typed CLI failure model.
+
+`ws` remains the low-level WebSocket adapter. Promise/event APIs are kept at the
+edges; lifecycle, cleanup, concurrency, config, and typed failures are modeled in
+Effect.
+
+## Defaults and Limits
+
+- Control-plane URL precedence:
+  `-l|--local` > `https://localpreview.dev`
+- Request body limit: `10 MB`
+- Response body limit: `50 MB`
+- Local request timeout: `30 seconds`
+- Max in-flight requests: `100`
+- Response chunks sent to relay: `64 KiB`
+- Initial relay connect retry budget: `10 seconds`
+
+Optional environment overrides:
+
+```sh
+LOCALPREVIEW_REQUEST_BODY_LIMIT_BYTES=10485760
+LOCALPREVIEW_RESPONSE_BODY_LIMIT_BYTES=52428800
+LOCALPREVIEW_REQUEST_TIMEOUT_MS=30000
+LOCALPREVIEW_MAX_IN_FLIGHT_REQUESTS=100
+LOCALPREVIEW_RESPONSE_CHUNK_SIZE_BYTES=65536
+LOCALPREVIEW_RELAY_CONNECT_TIMEOUT_MS=10000
+```
+
+## Development
+
+From the repo root:
+
+```sh
+pnpm --filter localpreview test
+pnpm --filter localpreview typecheck
+pnpm --filter localpreview build
+```
+
+To make the CLI available globally during local development:
+
+```sh
+pnpm --filter localpreview build
+cd packages/cli
+pnpm link --global
+```
+
+Then verify it from any directory:
+
+```sh
+which localpreview
+localpreview connect 3000 -l
+```
+
+If pnpm reports that the global bin directory is missing, run `pnpm setup`, then
+restart the terminal so `PNPM_HOME` is added to `PATH`.
+
+The global command points at `dist/index.js`, so rebuild after changing CLI
+source files.
+
+For a local end-to-end run, start the relay and control-plane first:
+
+```sh
+pnpm dev:relay
+pnpm dev:web
+pnpm localpreview connect 3000 -l
+```

package/dist/args.d.ts

@@ -0,0 +1,3 @@
+export declare const normalizeCliArgs: (argv: ReadonlyArray<string>) => ReadonlyArray<string>;
+export declare const readFlagValue: (argv: ReadonlyArray<string>, flag: string) => string | undefined;
+//# sourceMappingURL=args.d.ts.map

package/dist/args.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"args.d.ts","sourceRoot":"","sources":["../src/args.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,gBAAgB,GAAI,MAAM,aAAa,CAAC,MAAM,CAAC,KAAG,aAAa,CAAC,MAAM,CAC1C,CAAC;AAE1C,eAAO,MAAM,aAAa,GAAI,MAAM,aAAa,CAAC,MAAM,CAAC,EAAE,MAAM,MAAM,KAAG,MAAM,GAAG,SAQlF,CAAC"}

package/dist/args.js

@@ -0,0 +1,8 @@
+export const normalizeCliArgs = (argv) => argv[0] === "--" ? argv.slice(1) : argv;
+export const readFlagValue = (argv, flag) => {
+    const index = argv.indexOf(flag);
+    if (index === -1) {
+        return undefined;
+    }
+    return argv[index + 1];
+};

package/dist/command.d.ts

@@ -0,0 +1,5 @@
+import { Effect } from "effect";
+import { CliUsageError, type CliRuntimeError } from "./errors.js";
+export declare const runCli: (argv: ReadonlyArray<string>) => Effect.Effect<void, CliRuntimeError | CliUsageError>;
+export declare const normalizeCliArgs: (argv: ReadonlyArray<string>) => ReadonlyArray<string>;
+//# sourceMappingURL=command.d.ts.map

package/dist/command.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"command.d.ts","sourceRoot":"","sources":["../src/command.ts"],"names":[],"mappings":"AAKA,OAAO,EAAW,MAAM,EAAiB,MAAM,QAAQ,CAAC;AAOxD,OAAO,EAAE,aAAa,EAAgB,KAAK,eAAe,EAAE,MAAM,aAAa,CAAC;AA6BhF,eAAO,MAAM,MAAM,GACjB,MAAM,aAAa,CAAC,MAAM,CAAC,KAC1B,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,eAAe,GAAG,aAAa,CAkBrD,CAAC;AAEF,eAAO,MAAM,gBAAgB,GAAI,MAAM,aAAa,CAAC,MAAM,CAAC,KAAG,aAAa,CAAC,MAAM,CAC1C,CAAC"}

package/dist/command.js

@@ -0,0 +1,298 @@
+import { parseTarget, validateRequestedSubdomain, } from "@localpreview/protocol";
+import { Console, Effect, Layer, Option } from "effect";
+import { CliConfig, CliConfigLive, LOCAL_CONTROL_PLANE_URL } from "./config.js";
+import { ControlPlaneClient, ControlPlaneClientLive, } from "./control-plane.js";
+import { CliUsageError, errorMessage } from "./errors.js";
+import { LocalProxyLive } from "./local-proxy.js";
+import { RelayClient, RelayClientLive } from "./relay-client.js";
+export const runCli = (argv) => {
+    const normalized = normalizeCliArgs(argv);
+    if (isHelpInvocation(normalized)) {
+        return printHelp();
+    }
+    if (isVersionInvocation(normalized)) {
+        return Console.log("0.0.0");
+    }
+    const parsed = parseCommand(normalized);
+    if (!parsed.ok) {
+        return Effect.fail(new CliUsageError({ message: parsed.message }));
+    }
+    return runSubcommand(parsed.command);
+};
+export const normalizeCliArgs = (argv) => argv[0] === "--" ? argv.slice(1) : argv;
+const isHelpInvocation = (argv) => argv.length === 0 || argv.includes("--help") || argv.includes("-h");
+const isVersionInvocation = (argv) => argv.includes("--version");
+const isLegacyConnectInvocation = (argv) => {
+    const first = argv[0];
+    if (first === undefined) {
+        return false;
+    }
+    return first !== "connect" && !first.startsWith("-");
+};
+const printHelp = () => Console.log([
+    "Usage: localpreview connect <port|target-url> [--name subdomain] [-l|--local]",
+    "       localpreview clean <subdomain> [--force] [-l|--local] [--admin-token token]",
+    "       localpreview clean --all --force [-l|--local] [--admin-token token]",
+    "",
+    "Examples:",
+    "  localpreview connect 3000",
+    "  localpreview connect https://localhost:3000 --name proyecto",
+    "  localpreview connect 3000 -l",
+    "  localpreview clean proyecto --force",
+    "  localpreview clean --all --force",
+].join("\n"));
+const parseCommand = (argv) => {
+    if (argv[0] === "clean") {
+        const parsed = parseCleanArgs(argv.slice(1));
+        if (!parsed.ok) {
+            return parsed;
+        }
+        return {
+            command: {
+                config: parsed.config,
+                kind: "clean",
+            },
+            ok: true,
+        };
+    }
+    const legacy = isLegacyConnectInvocation(argv);
+    const args = legacy ? argv : argv[0] === "connect" ? argv.slice(1) : argv;
+    const parsed = parseConnectArgs(args);
+    if (!parsed.ok) {
+        return parsed;
+    }
+    return {
+        command: {
+            config: parsed.config,
+            kind: "connect",
+            legacy,
+        },
+        ok: true,
+    };
+};
+const parseConnectArgs = (argv) => {
+    const rest = [...argv];
+    const target = rest.shift();
+    if (target === undefined || target.startsWith("-")) {
+        return {
+            message: "Usage: localpreview connect <port|target-url> [--name subdomain] [-l|--local]",
+            ok: false,
+        };
+    }
+    let controlPlane;
+    let requestedName;
+    for (let index = 0; index < rest.length; index += 1) {
+        const arg = rest[index];
+        if (arg === "--name") {
+            const value = readRequiredOptionValue(rest, index, "--name");
+            if (!value.ok) {
+                return value;
+            }
+            requestedName = value.value;
+            index += 1;
+            continue;
+        }
+        if (arg === "-l" || arg === "--local") {
+            controlPlane = LOCAL_CONTROL_PLANE_URL;
+            continue;
+        }
+        return {
+            message: `Unknown option: ${arg}`,
+            ok: false,
+        };
+    }
+    return {
+        config: {
+            controlPlane: toOption(controlPlane),
+            requestedName: toOption(requestedName),
+            target,
+        },
+        ok: true,
+    };
+};
+const parseCleanArgs = (argv) => {
+    const rest = [...argv];
+    let adminToken;
+    let all = false;
+    let controlPlane;
+    let force = false;
+    let subdomain;
+    for (let index = 0; index < rest.length; index += 1) {
+        const arg = rest[index];
+        if (arg === "--admin-token") {
+            const value = readRequiredOptionValue(rest, index, "--admin-token");
+            if (!value.ok) {
+                return value;
+            }
+            adminToken = value.value;
+            index += 1;
+            continue;
+        }
+        if (arg === "--all") {
+            all = true;
+            continue;
+        }
+        if (arg === "--force") {
+            force = true;
+            continue;
+        }
+        if (arg === "-l" || arg === "--local") {
+            controlPlane = LOCAL_CONTROL_PLANE_URL;
+            continue;
+        }
+        if (arg !== undefined && !arg.startsWith("-") && subdomain === undefined) {
+            subdomain = arg;
+            continue;
+        }
+        if (arg !== undefined && !arg.startsWith("-")) {
+            return {
+                message: `Unexpected argument: ${arg}`,
+                ok: false,
+            };
+        }
+        return {
+            message: `Unknown option: ${arg}`,
+            ok: false,
+        };
+    }
+    if (all && subdomain !== undefined) {
+        return {
+            message: "Use either `localpreview clean <subdomain>` or `localpreview clean --all --force`, not both.",
+            ok: false,
+        };
+    }
+    if (!all && subdomain === undefined) {
+        return {
+            message: "Usage: localpreview clean <subdomain> [--force] [-l|--local] [--admin-token token]\n       localpreview clean --all --force [-l|--local] [--admin-token token]",
+            ok: false,
+        };
+    }
+    return {
+        config: {
+            all,
+            adminToken: toOption(adminToken),
+            controlPlane: toOption(controlPlane),
+            force,
+            subdomain: toOption(subdomain),
+        },
+        ok: true,
+    };
+};
+const readRequiredOptionValue = (argv, index, option) => {
+    const value = argv[index + 1];
+    if (value === undefined || value.startsWith("-")) {
+        return {
+            message: `Missing value for ${option}.`,
+            ok: false,
+        };
+    }
+    return {
+        ok: true,
+        value,
+    };
+};
+const toOption = (value) => value === undefined ? Option.none() : Option.some(value);
+const runSubcommand = (command) => {
+    const controlPlane = Option.getOrUndefined(command.config.controlPlane);
+    const effect = command.kind === "connect"
+        ? runConnect(command.config, command.legacy)
+        : runClean(command.config);
+    return effect.pipe(Effect.provide(makeCommandLayer(makeConfigInput(controlPlane))));
+};
+const makeConfigInput = (controlPlaneUrl) => controlPlaneUrl === undefined ? {} : { controlPlaneUrl };
+const makeCommandLayer = (input) => {
+    const ConfigLive = CliConfigLive(input);
+    const ProxyLive = LocalProxyLive.pipe(Layer.provide(ConfigLive));
+    const RelayLive = RelayClientLive.pipe(Layer.provide(Layer.mergeAll(ConfigLive, ProxyLive)));
+    return Layer.mergeAll(ConfigLive, ControlPlaneClientLive, ProxyLive, RelayLive);
+};
+const runConnect = (config, legacy) => Effect.scoped(Effect.gen(function* () {
+    if (legacy) {
+        yield* Console.error("Warning: `localpreview <target>` is deprecated. Use `localpreview connect <target>`.");
+    }
+    const target = parseTarget(config.target);
+    if (!target.ok) {
+        return yield* Effect.fail(new CliUsageError({ message: target.message }));
+    }
+    const requestedSubdomain = yield* validateRequestedName(config.requestedName);
+    const controlPlane = yield* ControlPlaneClient;
+    const relay = yield* RelayClient;
+    const cliConfig = yield* CliConfig;
+    const tunnel = yield* Effect.acquireRelease(controlPlane.createTunnel(cliConfig.controlPlaneUrl, requestedSubdomain === undefined ? {} : { requestedSubdomain }), (tunnel) => closeTunnelBestEffort(controlPlane, cliConfig.controlPlaneUrl, tunnel));
+    yield* Console.log(`Tunnel ready: ${tunnel.publicUrl}`);
+    yield* Console.log(`Forwarding to ${target.target.protocol}://${target.target.hostname}:${target.target.port}`);
+    yield* relay.connectAndServe(tunnel, target.target);
+}));
+const validateRequestedName = (value) => Option.match(value, {
+    onNone: () => Effect.succeed(undefined),
+    onSome: (requestedName) => {
+        const validation = validateRequestedSubdomain(requestedName);
+        if (!validation.valid) {
+            return Effect.fail(new CliUsageError({
+                message: `Subdomain "${requestedName}" is not available: ${validation.reason}.`,
+            }));
+        }
+        return Effect.succeed(validation.subdomain);
+    },
+});
+const runClean = (config) => Effect.gen(function* () {
+    const subdomain = Option.getOrUndefined(config.subdomain);
+    if (config.all && !config.force) {
+        return yield* Effect.fail(new CliUsageError({
+            message: "Bulk cleanup requires --force.",
+        }));
+    }
+    const controlPlane = yield* ControlPlaneClient;
+    const cliConfig = yield* CliConfig;
+    const adminToken = Option.getOrUndefined(config.adminToken) ?? cliConfig.cleanupAdminToken;
+    if (adminToken === undefined || adminToken.length === 0) {
+        return yield* Effect.fail(new CliUsageError({
+            message: "Subdomain cleanup requires an admin token. Set LOCALPREVIEW_CLEANUP_TOKEN or pass --admin-token.",
+        }));
+    }
+    if (config.all) {
+        const result = yield* controlPlane.cleanAllSubdomains(cliConfig.controlPlaneUrl, {
+            adminToken,
+            force: config.force,
+        });
+        if (!result.cleaned) {
+            yield* Console.log("No subdomains were active.");
+            return;
+        }
+        const untracked = result.untrackedRelays;
+        const untrackedSuffix = untracked === undefined || untracked.total === 0
+            ? ""
+            : ` Found ${untracked.total} untracked relays/sandboxes.`;
+        yield* Console.log(`Cleaned ${result.total} subdomains. Stopped ${result.stopped} relays/sandboxes.` +
+            (result.failedToStop === 0 ? "" : ` Failed to stop ${result.failedToStop}.`) +
+            untrackedSuffix);
+        return;
+    }
+    if (subdomain === undefined) {
+        return yield* Effect.fail(new CliUsageError({
+            message: "Usage: localpreview clean <subdomain> [--force] [-l|--local] [--admin-token token]",
+        }));
+    }
+    const validation = validateRequestedSubdomain(subdomain);
+    if (!validation.valid) {
+        return yield* Effect.fail(new CliUsageError({
+            message: `Subdomain "${subdomain}" is not available: ${validation.reason}.`,
+        }));
+    }
+    const result = yield* controlPlane.cleanSubdomain(cliConfig.controlPlaneUrl, {
+        adminToken,
+        force: config.force,
+        subdomain: validation.subdomain,
+    });
+    if (!result.cleaned) {
+        yield* Console.log(`Subdomain "${result.subdomain}" was already clean.`);
+        return;
+    }
+    const suffix = result.tunnelId === undefined
+        ? ""
+        : ` Tunnel ${result.tunnelId} was ${result.relayStopped ? "stopped" : "removed from the store"}.`;
+    yield* Console.log(`Subdomain "${result.subdomain}" cleaned.${suffix}`);
+});
+const closeTunnelBestEffort = (controlPlane, controlPlaneUrl, tunnel) => controlPlane
+    .closeTunnel(controlPlaneUrl, tunnel)
+    .pipe(Effect.catch((error) => Console.error(`Warning: ${errorMessage(error)}`)));

package/dist/config.d.ts

@@ -0,0 +1,30 @@
+import { Context, Effect, Layer } from "effect";
+export type CliConfigShape = {
+    readonly cleanupAdminToken: string | undefined;
+    readonly controlPlaneUrl: string;
+    readonly maxInFlightRequests: number;
+    readonly relayConnectTimeoutMs: number;
+    readonly requestBodyLimitBytes: number;
+    readonly requestTimeoutMs: number;
+    readonly responseBodyLimitBytes: number;
+    readonly responseChunkSizeBytes: number;
+};
+declare const CliConfig_base: Context.ServiceClass<CliConfig, "CliConfig", CliConfigShape>;
+export declare class CliConfig extends CliConfig_base {
+}
+export declare const PUBLIC_CONTROL_PLANE_URL = "https://localpreview.dev";
+export declare const LOCAL_CONTROL_PLANE_URL = "http://localhost:3000";
+export declare const makeCliConfig: (input: {
+    readonly controlPlaneUrl?: string;
+    readonly env?: NodeJS.ProcessEnv;
+}) => CliConfigShape;
+export declare const CliConfigLive: (input: {
+    readonly controlPlaneUrl?: string;
+    readonly env?: NodeJS.ProcessEnv;
+}) => Layer.Layer<CliConfig, never, never>;
+export declare const readCliConfig: (input: {
+    readonly controlPlaneUrl?: string;
+    readonly env?: NodeJS.ProcessEnv;
+}) => Effect.Effect<CliConfigShape>;
+export {};
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAEhD,MAAM,MAAM,cAAc,GAAG;IAC3B,QAAQ,CAAC,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/C,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC;IACrC,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IACvC,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IACvC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAClC,QAAQ,CAAC,sBAAsB,EAAE,MAAM,CAAC;IACxC,QAAQ,CAAC,sBAAsB,EAAE,MAAM,CAAC;CACzC,CAAC;;AAEF,qBAAa,SAAU,SAAQ,cAAyD;CAAG;AAE3F,eAAO,MAAM,wBAAwB,6BAA6B,CAAC;AACnE,eAAO,MAAM,uBAAuB,0BAA0B,CAAC;AAE/D,eAAO,MAAM,aAAa,GAAI,OAAO;IACnC,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAClC,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;CAClC,KAAG,cAoBH,CAAC;AAEF,eAAO,MAAM,aAAa,GAAI,OAAO;IACnC,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAClC,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;CAClC,yCAAmD,CAAC;AAWrD,eAAO,MAAM,aAAa,GAAI,OAAO;IACnC,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAClC,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;CAClC,KAAG,MAAM,CAAC,MAAM,CAAC,cAAc,CAA4C,CAAC"}

package/dist/config.js

@@ -0,0 +1,31 @@
+import { LOCALPREVIEW_PUBLIC_ORIGIN } from "@localpreview/protocol";
+import { Context, Effect, Layer } from "effect";
+export class CliConfig extends Context.Service()("CliConfig") {
+}
+export const PUBLIC_CONTROL_PLANE_URL = LOCALPREVIEW_PUBLIC_ORIGIN;
+export const LOCAL_CONTROL_PLANE_URL = "http://localhost:3000";
+export const makeCliConfig = (input) => {
+    const env = input.env ?? process.env;
+    const controlPlaneUrl = input.controlPlaneUrl ?? PUBLIC_CONTROL_PLANE_URL;
+    const cleanupAdminToken = env.LOCALPREVIEW_CLEANUP_TOKEN ??
+        (controlPlaneUrl === LOCAL_CONTROL_PLANE_URL ? "local-dev-cleanup-token" : undefined);
+    return {
+        cleanupAdminToken,
+        controlPlaneUrl,
+        maxInFlightRequests: readNumber(env.LOCALPREVIEW_MAX_IN_FLIGHT_REQUESTS, 100),
+        relayConnectTimeoutMs: readNumber(env.LOCALPREVIEW_RELAY_CONNECT_TIMEOUT_MS, 10_000),
+        requestBodyLimitBytes: readNumber(env.LOCALPREVIEW_REQUEST_BODY_LIMIT_BYTES, 10 * 1024 * 1024),
+        requestTimeoutMs: readNumber(env.LOCALPREVIEW_REQUEST_TIMEOUT_MS, 30_000),
+        responseBodyLimitBytes: readNumber(env.LOCALPREVIEW_RESPONSE_BODY_LIMIT_BYTES, 50 * 1024 * 1024),
+        responseChunkSizeBytes: readNumber(env.LOCALPREVIEW_RESPONSE_CHUNK_SIZE_BYTES, 64 * 1024),
+    };
+};
+export const CliConfigLive = (input) => Layer.succeed(CliConfig, makeCliConfig(input));
+const readNumber = (value, fallback) => {
+    if (value === undefined) {
+        return fallback;
+    }
+    const parsed = Number(value);
+    return Number.isFinite(parsed) && parsed > 0 ? parsed : fallback;
+};
+export const readCliConfig = (input) => Effect.sync(() => makeCliConfig(input));

package/dist/control-plane.d.ts

@@ -0,0 +1,59 @@
+import { type CreateTunnelResponse } from "@localpreview/protocol";
+import { Context, Effect, Layer } from "effect";
+import { ControlPlaneError } from "./errors.js";
+export type ControlPlaneClientShape = {
+    readonly cleanAllSubdomains: (controlPlaneUrl: string, input: {
+        readonly adminToken: string;
+        readonly force: boolean;
+    }) => Effect.Effect<CleanAllSubdomainsResponse, ControlPlaneError>;
+    readonly cleanSubdomain: (controlPlaneUrl: string, input: {
+        readonly adminToken: string;
+        readonly force: boolean;
+        readonly subdomain: string;
+    }) => Effect.Effect<CleanSubdomainResponse, ControlPlaneError>;
+    readonly closeTunnel: (controlPlaneUrl: string, tunnel: Pick<CreateTunnelResponse, "clientToken" | "tunnelId">) => Effect.Effect<void, ControlPlaneError>;
+    readonly createTunnel: (controlPlaneUrl: string, body: {
+        readonly requestedSubdomain?: string;
+    }) => Effect.Effect<CreateTunnelResponse, ControlPlaneError>;
+};
+export type CleanSubdomainResponse = {
+    readonly cleaned: boolean;
+    readonly relayStopped: boolean;
+    readonly subdomain: string;
+    readonly tunnelId?: string;
+};
+export type CleanAllSubdomainsResponse = {
+    readonly cleaned: boolean;
+    readonly failedToStop: number;
+    readonly results: ReadonlyArray<CleanSubdomainResponse>;
+    readonly stopped: number;
+    readonly total: number;
+    readonly untrackedRelays?: {
+        readonly failedToStop: number;
+        readonly results: ReadonlyArray<{
+            readonly relayStopped: boolean;
+            readonly sandboxId: string;
+        }>;
+        readonly stopped: number;
+        readonly total: number;
+    };
+};
+declare const ControlPlaneClient_base: Context.ServiceClass<ControlPlaneClient, "ControlPlaneClient", ControlPlaneClientShape>;
+export declare class ControlPlaneClient extends ControlPlaneClient_base {
+}
+export declare const ControlPlaneClientLive: Layer.Layer<ControlPlaneClient, never, never>;
+export declare const createTunnel: (controlPlaneUrl: string, body: {
+    readonly requestedSubdomain?: string;
+}) => Promise<CreateTunnelResponse>;
+export declare const closeTunnel: (controlPlaneUrl: string, tunnel: Pick<CreateTunnelResponse, "clientToken" | "tunnelId">) => Promise<void>;
+export declare const cleanSubdomain: (controlPlaneUrl: string, input: {
+    readonly adminToken: string;
+    readonly force: boolean;
+    readonly subdomain: string;
+}) => Promise<CleanSubdomainResponse>;
+export declare const cleanAllSubdomains: (controlPlaneUrl: string, input: {
+    readonly adminToken: string;
+    readonly force: boolean;
+}) => Promise<CleanAllSubdomainsResponse>;
+export {};
+//# sourceMappingURL=control-plane.d.ts.map

package/dist/control-plane.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"control-plane.d.ts","sourceRoot":"","sources":["../src/control-plane.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,oBAAoB,EAC1B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAY,MAAM,QAAQ,CAAC;AAC1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAEhD,MAAM,MAAM,uBAAuB,GAAG;IACpC,QAAQ,CAAC,kBAAkB,EAAE,CAC3B,eAAe,EAAE,MAAM,EACvB,KAAK,EAAE;QACL,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;QAC5B,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;KACzB,KACE,MAAM,CAAC,MAAM,CAAC,0BAA0B,EAAE,iBAAiB,CAAC,CAAC;IAClE,QAAQ,CAAC,cAAc,EAAE,CACvB,eAAe,EAAE,MAAM,EACvB,KAAK,EAAE;QACL,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;QAC5B,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;QACxB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;KAC5B,KACE,MAAM,CAAC,MAAM,CAAC,sBAAsB,EAAE,iBAAiB,CAAC,CAAC;IAC9D,QAAQ,CAAC,WAAW,EAAE,CACpB,eAAe,EAAE,MAAM,EACvB,MAAM,EAAE,IAAI,CAAC,oBAAoB,EAAE,aAAa,GAAG,UAAU,CAAC,KAC3D,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;IAC5C,QAAQ,CAAC,YAAY,EAAE,CACrB,eAAe,EAAE,MAAM,EACvB,IAAI,EAAE;QACJ,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC;KACtC,KACE,MAAM,CAAC,MAAM,CAAC,oBAAoB,EAAE,iBAAiB,CAAC,CAAC;CAC7D,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;IAC/B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC,sBAAsB,CAAC,CAAC;IACxD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,eAAe,CAAC,EAAE;QACzB,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;QAC9B,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC;YAC9B,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;YAC/B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;SAC5B,CAAC,CAAC;QACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;QACzB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;KACxB,CAAC;CACH,CAAC;;AAEF,qBAAa,kBAAmB,SAAQ,uBAGf;CAAG;AAE5B,eAAO,MAAM,sBAAsB,+CAWjC,CAAC;AAEH,eAAO,MAAM,YAAY,GACvB,iBAAiB,MAAM,EACvB,MAAM;IACJ,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC;CACtC,KACA,OAAO,CAAC,oBAAoB,CAAiE,CAAC;AAEjG,eAAO,MAAM,WAAW,GACtB,iBAAiB,MAAM,EACvB,QAAQ,IAAI,CAAC,oBAAoB,EAAE,aAAa,GAAG,UAAU,CAAC,KAC7D,OAAO,CAAC,IAAI,CAAkE,CAAC;AAElF,eAAO,MAAM,cAAc,GACzB,iBAAiB,MAAM,EACvB,OAAO;IACL,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B,KACA,OAAO,CAAC,sBAAsB,CACgC,CAAC;AAElE,eAAO,MAAM,kBAAkB,GAC7B,iBAAiB,MAAM,EACvB,OAAO;IACL,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;CACzB,KACA,OAAO,CAAC,0BAA0B,CACgC,CAAC"}