pastoria 1.1.0 → 1.2.1

package/dist/generate.d.ts

@@ -1,61 +1,58 @@
 /**
  * @fileoverview Router Code Generator
  *
- * This script generates type-safe router configuration files by scanning TypeScript
- * source code for JSDoc annotations. It's part of the "Pastoria" routing framework.
- *
- * How it works:
- * 1. Scans all TypeScript files in the project for exported functions/classes
- * 2. Looks for JSDoc tags: @route, @resource, @appRoot, and @param
- * 3. Looks for exported classes that extend PastoriaRootContext for GraphQL context
- * 4. Generates files from templates:
- *    - js_resource.ts: Resource configuration for lazy loading
- *    - router.tsx: Client-side router with type-safe routes
- *    - app_root.ts: Re-export of the app root component (if @appRoot is found)
- *    - context.ts: Re-export of user's context class, or generate a default one
- *
- * Usage:
- * - Add @route <route-name> to functions to create routes
- * - Add @param <name> <type> to document route parameters
- * - Add @resource <resource-name> to exports for lazy loading
- * - Add @appRoot to a component to designate it as the application root wrapper
- * - Add @gqlContext to a class extending PastoriaRootContext to provide a custom GraphQL context
- * - Add @serverRoute to functions to add an express handler
- *
- * The generator automatically creates Zod schemas for route parameters based on
- * TypeScript types, enabling runtime validation and type safety.
+ * This script generates type-safe router configuration files using filesystem-based
+ * routing, similar to Next.js App Router.
+ *
+ * ## Filesystem Routing Convention
+ *
+ * Routes are defined by the directory structure under `pastoria/`:
+ * - `pastoria/page.tsx` → Route `/`
+ * - `pastoria/about/page.tsx` → Route `/about`
+ * - `pastoria/post/[slug]/page.tsx` → Route `/post/:slug`
+ * - `pastoria/app.tsx` → Root layout component
+ * - `pastoria/api/.../route.ts` → API route handlers
+ * - `pastoria/*.page.tsx` → Nested entry points
+ * - `pastoria/entrypoint.ts` → Manual entry point definitions
+ *
+ * ## Page Files
+ *
+ * Each `page.tsx` should:
+ * - Default export a React component
+ * - Optionally export `queries` object mapping query refs to Relay query types
+ *
+ * ## Generated Files
+ *
+ * Output is placed in `__generated__/router/`:
+ * - `js_resource.ts` - Resource configuration for lazy loading
+ * - `router.tsx` - Client-side router with type-safe routes
+ * - `app_root.ts` - Re-export of the app root component
+ * - `environment.ts` - Re-export of the user's PastoriaEnvironment
+ * - `server_handler.ts` - API route handlers
+ * - `types.ts` - PageProps and other type definitions
  */
-import { Project, SourceFile, Symbol, ts } from 'ts-morph';
-type RouterResource = {
-    sourceFile: SourceFile;
-    symbol: Symbol;
-    queries: Map<string, string>;
-    entryPoints: Map<string, string>;
-};
-type RouterRoute = {
-    sourceFile: SourceFile;
-    symbol: Symbol;
-    params: Map<string, ts.Type>;
-};
-type ExportedSymbol = {
-    sourceFile: SourceFile;
-    symbol: Symbol;
-};
-export interface PastoriaMetadata {
-    resources: Map<string, RouterResource>;
-    routes: Map<string, RouterRoute>;
-    serverHandlers: Map<string, ExportedSymbol>;
-    appRoot: ExportedSymbol | null;
-    gqlContext: ExportedSymbol | null;
-}
-export declare const PASTORIA_TAG_REGEX: RegExp;
-export declare function generatePastoriaExports(project: Project): Promise<PastoriaMetadata>;
-export declare function generatePastoriaArtifacts(project: Project, metadata?: PastoriaMetadata): Promise<void>;
+import { Project } from 'ts-morph';
+import { type FilesystemMetadata } from './filesystem.js';
+/**
+ * Generates all Pastoria artifacts from the filesystem.
+ *
+ * This is the main entry point for code generation.
+ */
+export declare function generatePastoriaArtifacts(project: Project): Promise<FilesystemMetadata>;
 export interface PastoriaCapabilities {
     hasAppRoot: boolean;
     hasServerHandler: boolean;
 }
+/**
+ * Detects what capabilities are available based on source files.
+ */
+export declare function detectCapabilities(): Promise<PastoriaCapabilities>;
+/**
+ * Generates the client entry point code.
+ */
 export declare function generateClientEntry({ hasAppRoot, }: PastoriaCapabilities): string;
+/**
+ * Generates the server entry point code.
+ */
 export declare function generateServerEntry({ hasAppRoot, hasServerHandler, }: PastoriaCapabilities): string;
-export {};
 //# sourceMappingURL=generate.d.ts.map

package/dist/generate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../src/generate.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAKH,OAAO,EAEL,OAAO,EACP,UAAU,EACV,MAAM,EAEN,EAAE,EAEH,MAAM,UAAU,CAAC;AAsBlB,KAAK,cAAc,GAAG;IACpB,UAAU,EAAE,UAAU,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC,CAAC;AAEF,KAAK,WAAW,GAAG;IACjB,UAAU,EAAE,UAAU,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;CAC9B,CAAC;AAEF,KAAK,cAAc,GAAG;IACpB,UAAU,EAAE,UAAU,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACvC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACjC,cAAc,EAAE,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC5C,OAAO,EAAE,cAAc,GAAG,IAAI,CAAC;IAC/B,UAAU,EAAE,cAAc,GAAG,IAAI,CAAC;CACnC;AAGD,eAAO,MAAM,kBAAkB,QAC6B,CAAC;AAgtB7D,wBAAsB,uBAAuB,CAAC,OAAO,EAAE,OAAO,6BAM7D;AAED,wBAAsB,yBAAyB,CAC7C,OAAO,EAAE,OAAO,EAChB,QAAQ,mBAAmC,iBAK5C;AAED,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,OAAO,CAAC;IACpB,gBAAgB,EAAE,OAAO,CAAC;CAC3B;AAED,wBAAgB,mBAAmB,CAAC,EAClC,UAAU,GACX,EAAE,oBAAoB,GAAG,MAAM,CAkB/B;AAED,wBAAgB,mBAAmB,CAAC,EAClC,UAAU,EACV,gBAAgB,GACjB,EAAE,oBAAoB,GAAG,MAAM,CA6D/B"}
+{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../src/generate.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAKH,OAAO,EAEL,OAAO,EAKR,MAAM,UAAU,CAAC;AAClB,OAAO,EACL,KAAK,kBAAkB,EAKxB,MAAM,iBAAiB,CAAC;AAoiCzB;;;;GAIG;AACH,wBAAsB,yBAAyB,CAAC,OAAO,EAAE,OAAO,+BAa/D;AAMD,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,OAAO,CAAC;IACpB,gBAAgB,EAAE,OAAO,CAAC;CAC3B;AAED;;GAEG;AACH,wBAAsB,kBAAkB,IAAI,OAAO,CAAC,oBAAoB,CAAC,CAcxE;AAMD;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,EAClC,UAAU,GACX,EAAE,oBAAoB,GAAG,MAAM,CAgB/B;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,EAClC,UAAU,EACV,gBAAgB,GACjB,EAAE,oBAAoB,GAAG,MAAM,CA+C/B"}