@beastjs/page-builder 0.0.0-stage → 0.1.0

package/dist/types/rsbuild.d.ts

@@ -0,0 +1,4 @@
+import type { RsbuildPlugin } from '@rsbuild/core';
+import type { BeastPageBuilderOptions } from './shared/types.js';
+export type { BeastPageBuilderOptions, ProjectScan, DetectedCollection, DetectedItem, ItemType, ItemField, NavigationTarget } from './shared/types.js';
+export declare function beastPageBuilder(options?: BeastPageBuilderOptions): RsbuildPlugin;

package/dist/types/rspack.d.ts

@@ -0,0 +1,9 @@
+import type { Compiler, RspackPluginInstance } from '@rspack/core';
+import type { BeastPageBuilderOptions } from './shared/types.js';
+export type { BeastPageBuilderOptions, ProjectScan, DetectedCollection, DetectedItem, ItemType, ItemField, NavigationTarget } from './shared/types.js';
+export declare class BeastPageBuilderRspackPlugin implements RspackPluginInstance {
+    readonly options: BeastPageBuilderOptions;
+    constructor(options?: BeastPageBuilderOptions);
+    apply(compiler: Compiler): void;
+}
+export declare function beastPageBuilder(options?: BeastPageBuilderOptions): BeastPageBuilderRspackPlugin;

package/dist/types/server/discovery.d.ts

@@ -0,0 +1,8 @@
+import type { DetectedCollection } from '../shared/types.js';
+export interface DiscoverySource {
+    file: string;
+    source: string;
+    page: boolean;
+}
+/** Inspect source and types without importing or executing the project's modules. */
+export declare function discoverCollections(root: string, sources: DiscoverySource[]): DetectedCollection[];

package/dist/types/server/integration.d.ts

@@ -0,0 +1,6 @@
+import ts from 'typescript';
+import type { BeastPageBuilderOptions, NavigationTarget } from '../shared/types.js';
+export declare function parseTypeScript(source: string, file: string): ts.SourceFile;
+export declare function registerRoute(source: string, file: string, pageFile: string, name: string, path: string): string;
+export declare function discoverNavigation(source: string, file: string, config?: BeastPageBuilderOptions['navigation']): NavigationTarget[];
+export declare function addNavigation(source: string, target: NavigationTarget, path: string, label: string, config?: BeastPageBuilderOptions['navigation']): string;

package/dist/types/server/project.d.ts

@@ -0,0 +1,24 @@
+import type { BeastPageBuilderOptions, PageDraft, PagePreview, ProjectScan } from '../shared/types.js';
+export declare class BuilderError extends Error {
+    readonly status: number;
+    constructor(message: string, status?: number);
+}
+export declare class BuilderProject {
+    private readonly options;
+    readonly root: string;
+    readonly include: string[];
+    readonly pagesDir: string;
+    readonly routerFile: string;
+    private compiler;
+    private mutation;
+    private creations;
+    constructor(root: string, options?: BeastPageBuilderOptions);
+    /** Check existing ancestors too, so a configured directory cannot escape through a symlink. */
+    private safe;
+    scan(): Promise<ProjectScan>;
+    source(path: string): Promise<string>;
+    preview(draft: PageDraft): Promise<PagePreview>;
+    create(draft: PageDraft, hash: string): Promise<PagePreview>;
+    /** A reload can interrupt the browser response while the file transaction finishes. */
+    creation(hash: string): Promise<PagePreview>;
+}

package/dist/types/server/server.d.ts

@@ -0,0 +1,10 @@
+import type { IncomingMessage, ServerResponse } from 'node:http';
+import { type BeastPageBuilderOptions, type ClientConfig } from '../shared/types.js';
+import { BuilderProject } from './project.js';
+export declare const CLIENT_ENTRY: string;
+export declare function clientConfig(options: BeastPageBuilderOptions): ClientConfig;
+export declare function createBuilderServer(root: string, options?: BeastPageBuilderOptions, basePath?: string): {
+    middleware: (req: IncomingMessage, res: ServerResponse, next: (error?: unknown) => void) => void;
+    project: BuilderProject;
+    clientEntry: string;
+};

package/dist/types/shared/types.d.ts

@@ -0,0 +1,121 @@
+export declare const BASE = "/__beast-page-builder";
+export interface BeastPageBuilderOptions {
+    /** Project-relative folders to scan. */
+    include?: string[];
+    /** New pages are created here; existing files are never overwritten. */
+    pagesDir?: string;
+    /** TanStack Router module containing rootRoute.addChildren([...]). */
+    routerFile?: string;
+    /** Limit page-link insertion to this file and optionally one nav/array/group. */
+    navigation?: {
+        file: string;
+        selector?: string;
+        array?: string;
+        group?: string;
+        itemDefaults?: Record<string, string | number | boolean | string[]>;
+    };
+    /** Mod means Command on macOS and Control elsewhere. */
+    shortcut?: string;
+    position?: 'center' | 'bottom-right';
+    theme?: 'light' | 'dark' | 'auto';
+    /** Minimum scan animation duration in milliseconds. */
+    scanDuration?: number;
+    launcher?: boolean;
+}
+export interface ClientConfig {
+    shortcut: string;
+    position: 'center' | 'bottom-right';
+    theme: 'light' | 'dark' | 'auto';
+    scanDuration: number;
+    launcher: boolean;
+    pagesDir: string;
+    routerFile: string;
+}
+export interface ProjectFile {
+    path: string;
+    name: string;
+    kind: 'page' | 'component';
+    lines: number;
+    components: string[];
+    error: string | null;
+}
+export interface ProjectScan {
+    name: string;
+    files: ProjectFile[];
+    scannedAt: string;
+    warnings: string[];
+    navigationTargets: NavigationTarget[];
+    collections: DetectedCollection[];
+}
+export interface ItemField {
+    name: string;
+    type: string;
+    optional: boolean;
+    values?: Array<string | number | boolean>;
+}
+export interface ItemType {
+    name: string;
+    origin: 'declared' | 'inferred';
+    fields: ItemField[];
+    variants?: ItemType[];
+}
+export interface DetectedItem {
+    label: string;
+    kind: 'internal-link' | 'external-link' | 'anchor' | 'action' | 'tab' | 'unknown';
+    line: number;
+    component?: string;
+    destination?: string;
+    value?: string;
+    itemType: ItemType;
+}
+export interface CollectionConsumer {
+    file: string;
+    line: number;
+    name: string;
+}
+export interface DetectedCollection {
+    id: string;
+    file: string;
+    line: number;
+    name: string;
+    kind: 'navigation' | 'tabs';
+    source: 'markup' | 'data';
+    itemType: ItemType;
+    items: DetectedItem[];
+    editable: boolean;
+    reason?: string;
+    array?: string;
+    group?: string;
+    bindings: string[];
+    consumers: CollectionConsumer[];
+    dataSources: string[];
+}
+export interface NavigationTarget {
+    id: string;
+    file: string;
+    label: string;
+    array?: string;
+    group?: string;
+    itemType?: ItemType;
+}
+export interface PageDraft {
+    name: string;
+    source: string;
+    routePath?: string;
+    navLabel?: string;
+    navigationTarget?: string;
+}
+export interface PlannedFile {
+    path: string;
+    action: 'create' | 'edit';
+    before: string | null;
+    source: string;
+}
+export interface PagePreview {
+    path: string;
+    source: string;
+    hash: string;
+    routePath: string;
+    navLabel: string;
+    files: PlannedFile[];
+}

package/dist/types/vite.d.ts

@@ -0,0 +1,4 @@
+import type { Plugin } from 'vite';
+import { type BeastPageBuilderOptions } from './shared/types.js';
+export type { BeastPageBuilderOptions, ProjectScan, DetectedCollection, DetectedItem, ItemType, ItemField, NavigationTarget } from './shared/types.js';
+export declare function beastPageBuilder(options?: BeastPageBuilderOptions): Plugin;

package/dist/vite.d.ts

@@ -0,0 +1 @@
+export * from './types/vite.js'