beam-alpha 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,74 @@
+/**
+ * Public types for `@blueprint/dev` — hand-written and copied to dist, so the
+ * package's type surface never leaks internal imports (`@blueprint/shared`,
+ * node builtins) into a consumer's typecheck. Keep in step with
+ * `src/index.ts`; the starter's own `tsc` is the drift check.
+ */
+
+/**
+ * Deliberately not vite's `Plugin`: naming it would bind this package to one
+ * physical vite installation, and with the package `file:`-linked (the dev
+ * repo, a pnpm workspace) the consumer's vite is a *different copy* whose
+ * private types don't unify. `{ name }` is the structural subset every vite
+ * accepts in `plugins: []`.
+ */
+export interface BlueprintPlugin {
+  name: string
+}
+
+export interface BlueprintOptions {
+  /**
+   * Register `.blueprint/` as a Tailwind content source by appending
+   * `@source` to the entry stylesheet, so utility classes used only in
+   * sandbox files compile. On by default; the injection only happens when the
+   * folder exists and the stylesheet imports tailwindcss.
+   */
+  tailwindSource?: boolean
+  /**
+   * Stamp `data-bp-source="file:line"` on host JSX elements (dev serve only).
+   * On by default.
+   */
+  sourceIds?: boolean
+  /**
+   * Let Blueprint start a coding agent for this project. Off by default:
+   * this mounts `/__blueprint/api/runner/*`, routes that spawn the agent CLI
+   * you already have installed, with your login, in this project's root.
+   *
+   * `true` runs the first installed agent Blueprint knows; a name
+   * (`'claude'`, `'gemini'`, …) picks one; an object names the agent and its
+   * permission posture. Starting a turn, answering its permission prompts
+   * and changing the posture need the code the dev server prints in its
+   * terminal — any script on the dev origin shares the page, so the page
+   * alone is never enough.
+   *
+   * `permissionMode`: `'inherit'` (default) runs under your own Claude Code
+   * permission settings; `'auto'` adds `--permission-mode auto`. The
+   * canvas's Permissions row records the same choice in
+   * `.blueprint/agent.json`, which wins over this option.
+   */
+  agent?: boolean | string | { name?: string; permissionMode?: 'inherit' | 'auto' }
+  /**
+   * Require the code the dev server prints in its terminal before a
+   * privileged call — starting a turn, answering an approval, changing the
+   * permission posture, writing editor config. On by default.
+   *
+   * The code never enters the browser except through your hands, which is
+   * what separates you from every other script on your app's origin. Set it
+   * to `false` and no code is minted and none is asked for: anything running
+   * on the dev origin can then start your agent and approve its edits and
+   * commands. Right for a project whose page you trust as much as your
+   * terminal; wrong for anything else.
+   */
+  controlCode?: boolean
+}
+
+/**
+ * The Blueprint dev plugin: the canvas at `/__blueprint`, the probe in every
+ * served page (dormant unless the page is a Blueprint frame), virtual sandbox
+ * routes, and the pin/source transforms. Serve-only by construction — emits
+ * nothing into production builds.
+ *
+ * Put it FIRST in the plugins array: `plugins: [blueprint(), react(), tailwindcss()]`.
+ */
+export declare function blueprint(options?: BlueprintOptions): BlueprintPlugin[]
+export default blueprint