@timber-js/app 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,150 @@
+import type { PluginOption } from 'vite';
+import type { RouteTree } from './routing/types';
+import type { BuildManifest } from './server/build-manifest';
+import type { StartupTimer } from './utils/startup-timer';
+/** Configuration for client-side JavaScript output. */
+export interface ClientJavascriptConfig {
+    /** When true, no client JS bundles are emitted or referenced in HTML. */
+    disabled: boolean;
+    /**
+     * When `disabled` is true, still inject the Vite HMR client in dev mode
+     * so hot reloading works during development. Default: true.
+     */
+    enableHMRInDev?: boolean;
+}
+/** Fully resolved client JavaScript configuration (no optionals). */
+export interface ResolvedClientJavascript {
+    disabled: boolean;
+    enableHMRInDev: boolean;
+}
+export interface TimberUserConfig {
+    output?: 'server' | 'static';
+    /**
+     * Control client-side JavaScript output.
+     *
+     * Boolean shorthand:
+     *   `clientJavascript: false` disables all client JS (equivalent to `{ disabled: true }`).
+     *   `clientJavascript: true` enables client JS (the default).
+     *
+     * Object form:
+     *   `clientJavascript: { disabled: true, enableHMRInDev: true }` disables client JS
+     *   in production but preserves Vite HMR in dev mode.
+     *
+     * When `disabled` is true, `enableHMRInDev` defaults to `true`.
+     * Server-side JS still runs — this only affects what is sent to the browser.
+     */
+    clientJavascript?: boolean | ClientJavascriptConfig;
+    /**
+     * @deprecated Use `clientJavascript: false` or `clientJavascript: { disabled: true }` instead.
+     *
+     * Disable all client-side JavaScript output. When true, no client JS
+     * bundles are emitted or referenced in HTML. Pages work entirely via
+     * server-rendered HTML. Works in both 'server' and 'static' modes.
+     *
+     * Server-side JS still runs — this only affects what is sent to the browser.
+     */
+    noClientJavascript?: boolean;
+    adapter?: unknown;
+    cacheHandler?: unknown;
+    allowedOrigins?: string[];
+    csrf?: boolean;
+    limits?: {
+        actionBodySize?: string;
+        uploadBodySize?: string;
+        maxFields?: number;
+    };
+    pageExtensions?: string[];
+    /** Dev-mode options. These have no effect in production builds. */
+    dev?: {
+        /** Threshold in ms to highlight slow phases in dev logging output. Default: 200. */
+        slowPhaseMs?: number;
+    };
+    /**
+     * Cookie signing configuration. See design/29-cookies.md §"Signed Cookies".
+     *
+     * Provide `secret` for a single key, or `secrets` (array) for key rotation.
+     * When `secrets` is used, index 0 is the signing key; all are tried for verification.
+     */
+    cookies?: {
+        /** Single signing secret. Shorthand for `secrets: [secret]`. */
+        secret?: string;
+        /** Array of signing secrets for key rotation. Index 0 signs; all verify. */
+        secrets?: string[];
+    };
+    /**
+     * Override the app directory location. By default, timber auto-detects
+     * `app/` at the project root, falling back to `src/app/`.
+     *
+     * Set this to a relative path from the project root (e.g. `'src/app'`)
+     * to use a custom location.
+     */
+    appDir?: string;
+    /** MDX compilation options passed to @mdx-js/rollup. See design/20-content-collections.md. */
+    mdx?: {
+        remarkPlugins?: unknown[];
+        rehypePlugins?: unknown[];
+        recmaPlugins?: unknown[];
+        remarkRehypeOptions?: Record<string, unknown>;
+    };
+}
+/**
+ * Resolve `clientJavascript` (new) and `noClientJavascript` (deprecated) into
+ * a fully resolved config. Emits a deprecation warning for the old option.
+ */
+export declare function resolveClientJavascript(config: TimberUserConfig): ResolvedClientJavascript;
+/**
+ * Shared context object passed to all sub-plugins via closure.
+ *
+ * Sub-plugins communicate through this context — not through Vite's
+ * plugin API or global state.
+ * See design/18-build-system.md §"Shared Plugin Context".
+ */
+export interface PluginContext {
+    config: TimberUserConfig;
+    /** Resolved client JavaScript configuration */
+    clientJavascript: ResolvedClientJavascript;
+    /** The scanned route tree (populated by timber-routing, consumed by timber-entries) */
+    routeTree: RouteTree | null;
+    /** Absolute path to the app/ directory */
+    appDir: string;
+    /** Absolute path to the project root */
+    root: string;
+    /** Whether the dev server is running (set by timber-root-sync in configResolved) */
+    dev: boolean;
+    /** CSS build manifest (populated by adapter after client build, null in dev) */
+    buildManifest: BuildManifest | null;
+    /** Startup timer for profiling cold start phases (active in dev, no-op in prod) */
+    timer: StartupTimer;
+}
+/**
+ * Resolve the app directory. Checks (in order):
+ * 1. Explicit `configAppDir` from timber.config.ts
+ * 2. `<root>/app`
+ * 3. `<root>/src/app`
+ *
+ * Throws if none exist.
+ */
+export declare function resolveAppDir(root: string, configAppDir?: string): string;
+/**
+ * Detect config keys set in both inline (vite.config.ts) and file (timber.config.ts)
+ * and warn the user. The `output` key is excluded because it defaults to 'server'
+ * in createPluginContext and would always appear as an inline key.
+ *
+ * Returns the list of conflicting key names (for testing).
+ */
+export declare function warnConfigConflicts(inline: TimberUserConfig, fileConfig: TimberUserConfig): string[];
+export declare function timber(config?: TimberUserConfig): PluginOption[];
+/**
+ * Route map interface — augmented by the generated timber-routes.d.ts.
+ *
+ * Each key is a route path pattern. Values have:
+ *   params: shape of URL params (e.g. { id: string })
+ *   searchParams: parsed type from search-params.ts, or {} if none
+ *
+ * This interface is empty by default and populated via codegen.
+ * See design/09-typescript.md §"Typed Routes".
+ */
+export interface Routes {
+}
+export default timber;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAU,YAAY,EAAE,MAAM,MAAM,CAAC;AAuBjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAG1D,uDAAuD;AACvD,MAAM,WAAW,sBAAsB;IACrC,yEAAyE;IACzE,QAAQ,EAAE,OAAO,CAAC;IAClB;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,qEAAqE;AACrE,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,OAAO,CAAC;IAClB,cAAc,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAC7B;;;;;;;;;;;;;OAaG;IACH,gBAAgB,CAAC,EAAE,OAAO,GAAG,sBAAsB,CAAC;IACpD;;;;;;;;OAQG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE;QACP,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,mEAAmE;IACnE,GAAG,CAAC,EAAE;QACJ,oFAAoF;QACpF,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;IACF;;;;;OAKG;IACH,OAAO,CAAC,EAAE;QACR,gEAAgE;QAChE,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,4EAA4E;QAC5E,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;KACpB,CAAC;IACF;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,8FAA8F;IAC9F,GAAG,CAAC,EAAE;QACJ,aAAa,CAAC,EAAE,OAAO,EAAE,CAAC;QAC1B,aAAa,CAAC,EAAE,OAAO,EAAE,CAAC;QAC1B,YAAY,CAAC,EAAE,OAAO,EAAE,CAAC;QACzB,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KAC/C,CAAC;CACH;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,gBAAgB,GAAG,wBAAwB,CAgC1F;AAED;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,gBAAgB,CAAC;IACzB,+CAA+C;IAC/C,gBAAgB,EAAE,wBAAwB,CAAC;IAC3C,uFAAuF;IACvF,SAAS,EAAE,SAAS,GAAG,IAAI,CAAC;IAC5B,0CAA0C;IAC1C,MAAM,EAAE,MAAM,CAAC;IACf,wCAAwC;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,oFAAoF;IACpF,GAAG,EAAE,OAAO,CAAC;IACb,gFAAgF;IAChF,aAAa,EAAE,aAAa,GAAG,IAAI,CAAC;IACpC,mFAAmF;IACnF,KAAK,EAAE,YAAY,CAAC;CACrB;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,CAqBzE;AAmCD;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,gBAAgB,EACxB,UAAU,EAAE,gBAAgB,GAC3B,MAAM,EAAE,CAiBV;AA6BD,wBAAgB,MAAM,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,YAAY,EAAE,CAkGhE;AAED;;;;;;;;;GASG;AAEH,MAAM,WAAW,MAAM;CAAG;AAE1B,eAAe,MAAM,CAAC"}