@gravito/monolith 1.0.0-alpha.6 → 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,168 @@
+import * as _gravito_core from '@gravito/core';
+import { GravitoContext, GravitoOrbit, PlanetCore } from '@gravito/core';
+import { TSchema } from '@gravito/mass';
+export { Schema } from '@gravito/mass';
+import { Hono } from 'hono';
+
+interface ContentItem {
+    slug: string;
+    body: string;
+    excerpt?: string;
+    meta: Record<string, any>;
+    raw: string;
+}
+interface CollectionConfig {
+    path: string;
+}
+declare class ContentManager {
+    private rootDir;
+    private collections;
+    private cache;
+    private renderer;
+    /**
+     * Create a new ContentManager instance.
+     *
+     * @param rootDir - The root directory of the application.
+     */
+    constructor(rootDir: string);
+    /**
+     * Register a new content collection.
+     *
+     * @param name - The name of the collection.
+     * @param config - The collection configuration.
+     */
+    defineCollection(name: string, config: CollectionConfig): void;
+    /**
+     * Find a single content item.
+     *
+     * @param collectionName - The collection name (e.g. 'docs').
+     * @param slug - The file slug (e.g. 'installation').
+     * @param locale - The locale (e.g. 'en'). Defaults to 'en'.
+     * @returns A promise resolving to the ContentItem or null if not found.
+     * @throws {Error} If the collection is not defined.
+     */
+    find(collectionName: string, slug: string, locale?: string): Promise<ContentItem | null>;
+    /**
+     * List all items in a collection for a locale.
+     * Useful for generating sitemaps or index pages.
+     *
+     * @param collectionName - The collection name.
+     * @param locale - The locale. Defaults to 'en'.
+     * @returns A promise resolving to an array of ContentItems.
+     * @throws {Error} If the collection is not defined.
+     */
+    list(collectionName: string, locale?: string): Promise<ContentItem[]>;
+    private sanitizeSegment;
+    private escapeHtml;
+    private isSafeUrl;
+}
+
+/**
+ * Utility to clean up request data.
+ */
+declare class Sanitizer {
+    /**
+     * Recursively trim strings and convert empty strings to null.
+     */
+    static clean(data: any): any;
+}
+
+declare abstract class BaseController {
+    protected sanitizer: Sanitizer;
+    call(ctx: GravitoContext, method: string): Promise<Response>;
+}
+declare abstract class Controller {
+    protected context: GravitoContext;
+    /**
+     * Set the request context for this controller instance.
+     */
+    setContext(context: GravitoContext): this;
+    /**
+     * Return a JSON response.
+     */
+    protected json(data: any, status?: number): Response;
+    /**
+     * Return a text response.
+     */
+    protected text(text: string, status?: number): Response;
+    /**
+     * Redirect to a given URL.
+     */
+    protected redirect(url: string, status?: number): Response;
+    /**
+     * Get an item from the context variables.
+     */
+    protected get(key: string): any;
+    /**
+     * Get the request object.
+     */
+    protected get request(): _gravito_core.GravitoRequest;
+    /**
+     * Validate the request against a schema.
+     */
+    protected validate(_schema: any, source?: 'json' | 'query' | 'form'): Promise<any>;
+    /**
+     * Resolve a controller action into a handler compatible with GravitoContext.
+     */
+    static call(method: string): any;
+}
+
+declare abstract class FormRequest {
+    protected context: GravitoContext;
+    /**
+     * Define the validation schema.
+     */
+    abstract schema(): TSchema;
+    /**
+     * Define the source of data (json, query, form, etc.).
+     */
+    source(): 'json' | 'query' | 'form';
+    /**
+     * Determine if the user is authorized to make this request.
+     */
+    authorize(): boolean;
+    /**
+     * Set the context.
+     */
+    setContext(context: GravitoContext): this;
+    /**
+     * Get the validated data.
+     */
+    validated(): any;
+    /**
+     * Static helper to create a middleware from this request class.
+     */
+    static middleware(): any;
+}
+
+declare class RouterHelper {
+    /**
+     * Register standard resource routes for a controller.
+     *
+     * GET    /prefix          -> index
+     * GET    /prefix/create   -> create
+     * POST   /prefix          -> store
+     * GET    /prefix/:id      -> show
+     * GET    /prefix/:id/edit -> edit
+     * PUT    /prefix/:id      -> update
+     * DELETE /prefix/:id      -> destroy
+     */
+    static resource(app: Hono<any, any, any>, prefix: string, controller: any): void;
+}
+
+declare module '@gravito/core' {
+    interface Variables {
+        content: ContentManager;
+    }
+}
+interface ContentConfig {
+    root?: string;
+    collections?: Record<string, CollectionConfig>;
+}
+declare class OrbitMonolith implements GravitoOrbit {
+    private config;
+    constructor(config?: ContentConfig);
+    install(core: PlanetCore): void;
+}
+
+export { BaseController, type CollectionConfig, type ContentConfig, type ContentItem, ContentManager, Controller, FormRequest, OrbitMonolith, RouterHelper as Route };