hatchkit 0.1.42 → 0.1.45

package/dist/dev-setup.d.ts

@@ -0,0 +1,106 @@
+import { CADDYFILE_PATH, DEV_CONFIG_DIR, isLocalDevActive, LOCAL_DEV_DOMAIN, LOCAL_DEV_DOMAIN_WILDCARD, MANAGED_MARKER, projectFragmentPath, PROJECTS_DIR, readCaddyPort, removeProjectFragment, type TailscaleIdentity, tailscaleIdentity, tailscaleServeTcpTarget, writeProjectFragment } from "@hatchkit/dev-shared";
+export { CADDYFILE_PATH, DEV_CONFIG_DIR, LOCAL_DEV_DOMAIN, LOCAL_DEV_DOMAIN_WILDCARD, MANAGED_MARKER, PROJECTS_DIR, isLocalDevActive, readCaddyPort, tailscaleIdentity, tailscaleServeTcpTarget, };
+export type { TailscaleIdentity };
+export declare const CADDY_LOG_PATH: string;
+export declare const CADDY_ERR_LOG_PATH: string;
+export declare const CADDY_WRAPPER_PATH: string;
+export declare const LAUNCHD_LABEL = "com.hatchkit.dev-caddy";
+export declare const LAUNCHD_PLIST_PATH: string;
+/** Default keychain pair used when the Caddy ACME token lives outside
+ *  the launchd plist. When this entry exists, `dev-setup init` writes a
+ *  wrapper-style plist that exec's a small shell script which pulls the
+ *  token from keychain on demand — no plaintext secret in
+ *  `~/Library/LaunchAgents/`. Override via
+ *  `DevSetupInitOptions.caddyTokenKeychain`. */
+export declare const DEFAULT_CADDY_KEYCHAIN_SERVICE = "caddy-dev";
+export declare const DEFAULT_CADDY_KEYCHAIN_ACCOUNT = "cloudflare-acme";
+export interface CheckResult {
+    name: string;
+    status: "ok" | "fail" | "skip";
+    detail?: string;
+    hint?: string[];
+}
+export declare function caddyfileContents(caddyPort: number): string;
+export declare function pickFreeCaddyPort(): Promise<number | null>;
+export declare function checkLocalDevHost(): Promise<CheckResult[]>;
+export interface DevSetupInitOptions {
+    force?: boolean;
+    skipLaunchd?: boolean;
+    skipServe?: boolean;
+    caddyBinPath?: string;
+    cloudflareToken?: string | null;
+    /** Pull the Cloudflare ACME token from a macOS Keychain entry at
+     *  Caddy start time instead of embedding it in the launchd plist.
+     *  When set (or when the `caddy-dev/cloudflare-acme` default entry
+     *  exists), `init` writes a wrapper script and a plist that exec's
+     *  the wrapper — the secret never lands on disk in plaintext. Pass
+     *  `false` to force inline-env mode even if the default entry exists. */
+    caddyTokenKeychain?: {
+        service: string;
+        account: string;
+    } | false;
+}
+export interface DevSetupInitResult {
+    caddyPort: number;
+    wroteCaddyfile: boolean;
+    wrotePlist: boolean;
+    /** True when the wrapper script at CADDY_WRAPPER_PATH was created or
+     *  rewritten. Only set in wrapper-mode runs. */
+    wroteWrapper: boolean;
+    loadedLaunchd: boolean;
+    registeredServe: boolean;
+    /** State of the `*.local.ricoslabs.com` DNS A record that points at
+     *  the laptop's tailnet IP. `null` when no Cloudflare token is
+     *  reachable (manual DNS setup expected); a status string when
+     *  hatchkit managed the record itself. */
+    dnsRecord: "created" | "updated" | "unchanged" | "skipped-no-token" | "failed" | null;
+    notes: string[];
+}
+export declare function runDevSetupInit(opts?: DevSetupInitOptions): Promise<DevSetupInitResult>;
+export { projectFragmentPath, removeProjectFragment, writeProjectFragment };
+export interface EnableProjectLocalDevInput {
+    /** Absolute path to the project root (contains `.hatchkit.json`). */
+    projectDir: string;
+    slug: string;
+    /** Dev port the Caddy fragment should reverse-proxy to. For client-
+     *  bearing projects this is the client port; for server-only, the
+     *  server port. The dev plugin will overwrite the fragment with the
+     *  live port at the next `pnpm dev` if this guess is wrong. */
+    devPort: number;
+    /** When false, skip the framework-config patch (next.config.ts).
+     *  Useful for `hatchkit dev-setup enable` invocations on projects
+     *  whose Next config has been hand-edited beyond the auto-patch
+     *  comfort zone — the user can wire the plugin themselves. */
+    patchNextConfig?: boolean;
+    /** When false, skip the package.json dep injection. Same rationale. */
+    patchPackageJson?: boolean;
+}
+export interface EnableProjectLocalDevResult {
+    wroteFragment: "created" | "updated" | "unchanged";
+    wroteDocs: boolean;
+    /** Which framework the patcher detected (or `none` when neither a
+     *  Next nor a Vite config is reachable from the project). Drives
+     *  which plugin package is injected. */
+    framework: "next" | "vite" | "none";
+    patchedConfig: "added" | "already-wrapped" | "no-file" | "unsupported-shape" | "manual-wire-required" | "skipped";
+    patchedPackageJson: "added" | "already-present" | "no-file" | "skipped";
+}
+/** Wire a single project for Tailscale-served local dev. Idempotent —
+ *  safe to call from scaffold (first run) AND from `dev-setup enable`
+ *  on an already-wired project. */
+export declare function enableProjectLocalDev(input: EnableProjectLocalDevInput): Promise<EnableProjectLocalDevResult>;
+/** Remove the project's Caddy fragment + the docs file. Leaves the
+ *  next.config wrapper + the plugin dep in place — they're inert when
+ *  `~/.config/dev/projects/<slug>.caddy` is gone, and ripping them
+ *  back out risks colliding with user edits to either file. */
+export declare function disableProjectLocalDev(projectDir: string, slug: string): {
+    removedFragment: boolean;
+    removedDocs: boolean;
+};
+export interface DevSetupDocsInput {
+    slug: string;
+    tailscale?: TailscaleIdentity | null;
+}
+export declare function renderDevSetupDocs(input: DevSetupDocsInput): string;
+export declare function runDevSetupCli(args: string[]): Promise<void>;
+//# sourceMappingURL=dev-setup.d.ts.map

package/dist/dev-setup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dev-setup.d.ts","sourceRoot":"","sources":["../src/dev-setup.ts"],"names":[],"mappings":"AAgCA,OAAO,EACL,cAAc,EACd,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,yBAAyB,EACzB,cAAc,EACd,mBAAmB,EACnB,YAAY,EACZ,aAAa,EACb,qBAAqB,EACrB,KAAK,iBAAiB,EACtB,iBAAiB,EACjB,uBAAuB,EACvB,oBAAoB,EACrB,MAAM,sBAAsB,CAAC;AAG9B,OAAO,EACL,cAAc,EACd,cAAc,EACd,gBAAgB,EAChB,yBAAyB,EACzB,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,aAAa,EACb,iBAAiB,EACjB,uBAAuB,GACxB,CAAC;AACF,YAAY,EAAE,iBAAiB,EAAE,CAAC;AAElC,eAAO,MAAM,cAAc,QAAoC,CAAC;AAChE,eAAO,MAAM,kBAAkB,QAAwC,CAAC;AACxE,eAAO,MAAM,kBAAkB,QAA2C,CAAC;AAC3E,eAAO,MAAM,aAAa,2BAA2B,CAAC;AACtD,eAAO,MAAM,kBAAkB,QAK9B,CAAC;AAEF;;;;;gDAKgD;AAChD,eAAO,MAAM,8BAA8B,cAAc,CAAC;AAC1D,eAAO,MAAM,8BAA8B,oBAAoB,CAAC;AAKhE,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,CAAC;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAMD,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CA2B3D;AAkHD,wBAAsB,iBAAiB,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAKhE;AAmBD,wBAAsB,iBAAiB,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC,CA4MhE;AAMD,MAAM,WAAW,mBAAmB;IAClC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC;;;;;6EAKyE;IACzE,kBAAkB,CAAC,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG,KAAK,CAAC;CACnE;AAED,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,OAAO,CAAC;IACxB,UAAU,EAAE,OAAO,CAAC;IACpB;oDACgD;IAChD,YAAY,EAAE,OAAO,CAAC;IACtB,aAAa,EAAE,OAAO,CAAC;IACvB,eAAe,EAAE,OAAO,CAAC;IACzB;;;8CAG0C;IAC1C,SAAS,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,kBAAkB,GAAG,QAAQ,GAAG,IAAI,CAAC;IACtF,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,wBAAsB,eAAe,CACnC,IAAI,GAAE,mBAAwB,GAC7B,OAAO,CAAC,kBAAkB,CAAC,CA2J7B;AAwMD,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,CAAC;AAc5E,MAAM,WAAW,0BAA0B;IACzC,qEAAqE;IACrE,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb;;;mEAG+D;IAC/D,OAAO,EAAE,MAAM,CAAC;IAChB;;;kEAG8D;IAC9D,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,uEAAuE;IACvE,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,2BAA2B;IAC1C,aAAa,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,CAAC;IACnD,SAAS,EAAE,OAAO,CAAC;IACnB;;4CAEwC;IACxC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACpC,aAAa,EACT,OAAO,GACP,iBAAiB,GACjB,SAAS,GACT,mBAAmB,GACnB,sBAAsB,GACtB,SAAS,CAAC;IACd,kBAAkB,EAAE,OAAO,GAAG,iBAAiB,GAAG,SAAS,GAAG,SAAS,CAAC;CACzE;AAED;;mCAEmC;AACnC,wBAAsB,qBAAqB,CACzC,KAAK,EAAE,0BAA0B,GAChC,OAAO,CAAC,2BAA2B,CAAC,CAyDtC;AAED;;;+DAG+D;AAC/D,wBAAgB,sBAAsB,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG;IACxE,eAAe,EAAE,OAAO,CAAC;IACzB,WAAW,EAAE,OAAO,CAAC;CACtB,CASA;AAgKD,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAC;CACtC;AAED,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,iBAAiB,GAAG,MAAM,CAuInE;AAMD,wBAAsB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CA+FlE"}