rasengan 1.0.0-beta.6 → 1.0.0-beta.60

package/lib/types/routing/types.d.ts

@@ -0,0 +1,213 @@
+import { FunctionComponent } from 'react';
+import { RouteObject as RRRouteObject } from 'react-router';
+import { RouterComponent } from './interfaces.js';
+export type MetadataLink = {
+    rel: string;
+    type?: string;
+    sizes?: string;
+    href: string;
+};
+export type MetaTag = {
+    name?: string;
+    property?: string;
+    content: string;
+};
+export type MetadataWithoutTitleAndDescription = {
+    /**
+     * Configuring link preview on social media like facebook, linkedin, etc.
+     */
+    openGraph?: {
+        type?: string;
+        title?: string;
+        description?: string;
+        url: string;
+        image: string;
+        width?: string;
+        height?: string;
+    };
+    /**
+     * Configuring link preview on twitter
+     */
+    twitter?: {
+        card: 'summary_large_image' | 'summary';
+        image: string;
+        title: string;
+        description?: string;
+        creator?: string;
+        site?: string;
+    };
+    /**
+     * Configuring link tags to define icons and others
+     */
+    links?: Array<MetadataLink>;
+    /**
+     * Other metadata tags
+     */
+    metaTags?: Array<MetaTag>;
+};
+export type Metadata = MetadataWithoutTitleAndDescription & {
+    /**
+     * Title of the pate
+     */
+    title?: string;
+    /**
+     * Description of the page
+     */
+    description?: string;
+};
+/**
+ * Props for Router Decorators
+ */
+export type RouterProps = {
+    /**
+     * Usefull to collect sub routers
+     */
+    imports?: Array<Promise<RouterComponent>>;
+    /**
+     * Usefull to define a layout
+     */
+    layout?: LayoutComponent;
+    /**
+     * Usefull to collect pages
+     */
+    pages?: Array<PageComponent | MDXPageComponent | Array<PageComponent | MDXPageComponent>>;
+    /**
+     * Usefull to display a screen that let know to the user that the page is loading.
+     */
+    loaderComponent?: FunctionComponent;
+    /**
+     * Usefull to display a screen that let know to the user that the page is not found.
+     */
+    notFoundComponent?: FunctionComponent;
+    /**
+     * Determines whether the current page should use the parent layout, or render its own layout.
+     */
+    useParentLayout?: boolean;
+};
+/**
+ * Options for the loader function that loads data for a page from the server
+ */
+export type LoaderOptions = {
+    params: {
+        [key: string]: any;
+    };
+    request: Request;
+};
+/**
+ * Data returned from the loader function
+ */
+export type LoaderResponse = {
+    props?: {
+        [key: string]: any;
+    };
+    redirect?: string;
+    meta?: Metadata | MetadataWithoutTitleAndDescription;
+};
+export type RouteLoaderFunction = (options: LoaderOptions) => Promise<LoaderResponse>;
+export type LoaderFunction = ({ params, request, }: {
+    params: Record<string, string>;
+    request: Request;
+}) => Promise<LoaderResponse | Response>;
+export type RouteObject = RRRouteObject & {
+    loader?: LoaderFunction;
+    /**
+     * Routes children
+     */
+    children?: Array<RouteObject>;
+    /**
+     * Determines if the route is nested
+     */
+    nested?: boolean;
+};
+export type RoutesGroupProps = {
+    /**
+     * Path of the group
+     */
+    path: string;
+    /**
+     * Routes children
+     */
+    children: Array<PageComponent | MDXPageComponent | Array<PageComponent | MDXPageComponent>>;
+};
+export type RasenganPageComponentProps = {
+    page: PageComponent;
+    data: LoaderResponse;
+};
+/**
+ * Props for react components
+ */
+export type ReactComponentProps = {
+    [key: string]: any;
+    params: {
+        [key: string]: any;
+    };
+} | any;
+/**
+ * Layout component that represents a layout
+ */
+export type LayoutComponent<T = ReactComponentProps> = FunctionComponent<T> & {
+    /**
+     * Base path for the page
+     */
+    path: string;
+    /**
+     * Metadata for the page
+     */
+    metadata?: MetadataWithoutTitleAndDescription;
+    /**
+     * Loader function that loads data for the page from the server
+     */
+    loader?: RouteLoaderFunction;
+};
+/**
+ * Page component that extends LayoutComponent and represents a page
+ */
+export type PageComponent<T = ReactComponentProps> = LayoutComponent<T> & {
+    /**
+     * Metadata for the page omit title
+     */
+    metadata?: Metadata;
+};
+/**
+ * A React functional component that represents an MDX page.
+ *
+ * The `MDXPageComponent` type extends the `React.FC<ReactComponentProps>` type,
+ * which means it is a React functional component that accepts the standard props for a React component.
+ *
+ * The `MDXPageComponent` type also has an optional `metadata` property of type `Metadata`,
+ * which can be used to store metadata about the page.
+ */
+export type MDXPageComponent = FunctionComponent & {
+    metadata?: {
+        path: string;
+        metadata: Metadata;
+    };
+};
+/**
+ * A React functional component that represents a simple block element.
+ */
+export type MDXRendererProps = {
+    children: MDXPageComponent;
+    className?: string;
+};
+/**
+ * Template props
+ */
+export type TemplateProps = {
+    Head: FunctionComponent<{
+        children: React.ReactNode;
+    }>;
+    Body: FunctionComponent<{
+        children: React.ReactNode;
+    }>;
+    Script: FunctionComponent<{
+        children?: React.ReactNode;
+    }>;
+};
+/**
+ * Props for the base Component that takes the app router
+ */
+export type RootComponentProps = {
+    router: Promise<RouterComponent>;
+    children: React.ReactNode;
+};

package/lib/types/routing/utils/define-router.d.ts

@@ -0,0 +1,8 @@
+import { RouterProps } from '../types.js';
+import { RouterComponent } from '../interfaces.js';
+/**
+ * This function adds metadata to a router
+ * @param option
+ * @returns
+ */
+export declare const defineRouter: (option: RouterProps) => (Router: new () => RouterComponent) => Promise<RouterComponent>;

package/lib/types/routing/utils/define-routes-group.d.ts

@@ -0,0 +1,7 @@
+import { RoutesGroupProps, PageComponent, MDXPageComponent } from '../types.js';
+/**
+ * Recursively loops through an array of `PageComponent`, `MDXPageComponent`, or `RoutesGroupProps` and extracts all the pages into a single array.
+ * @param option - An object containing the `path` and `children` properties, which are used to define a routes group.
+ * @returns An array of `PageComponent` or `MDXPageComponent` objects.
+ */
+export declare const defineRoutesGroup: (option: RoutesGroupProps) => (PageComponent | MDXPageComponent)[];

package/lib/types/routing/utils/generate-metadata.d.ts

@@ -0,0 +1,7 @@
+import { Metadata } from '../types.js';
+import { JSX } from 'react';
+/**
+ * This function generates metadata useful for pages to show images when sharing on social media
+ * @param {Metadata[]} metadatas
+ */
+export declare const generateMetadata: (metadatas: Metadata[]) => JSX.Element[];

package/lib/types/routing/utils/generate-routes.d.ts

@@ -0,0 +1,13 @@
+import { RouterComponent } from '../interfaces.js';
+import { RouteObject, LayoutComponent } from '../types.js';
+/**
+ * This function receives a router component and get a formated router first
+ * and then return a router.
+ */
+export declare const getRouter: (routerInstance: RouterComponent) => () => import("react/jsx-runtime.js").JSX.Element;
+/**
+ * This function receives a router component and return a formated router for static routing
+ * @param router Represents the router component
+ * @returns
+ */
+export declare const generateRoutes: (router: RouterComponent, isRoot?: boolean, parentLayout?: LayoutComponent | undefined) => RouteObject[];

package/lib/types/routing/utils/index.d.ts

@@ -0,0 +1,4 @@
+export * from './define-router.js';
+export * from './define-routes-group.js';
+export * from './generate-routes.js';
+export * from './generate-metadata.js';

package/lib/types/scripts/utils/check-os.d.ts

@@ -0,0 +1 @@
+export function checkOsPlateform(osname: "aix" | "darwin" | "freebsd" | "linux" | "openbsd" | "sunos" | "win32"): boolean;

package/lib/types/scripts/utils/copy.d.ts

@@ -0,0 +1 @@
+export function generateCopyExecaArray(from: string, to: string): Array<string>;

package/lib/types/server/build/index.d.ts

@@ -0,0 +1,13 @@
+export interface BuildOptions {
+    buildDirectory: string;
+    manifestPathDirectory: string;
+    assetPathDirectory: string;
+    clientPathDirectory: string;
+    serverPathDirectory: string;
+    entryServerPath: string;
+}
+export declare const resolveBuildOptions: ({ buildDirectory, clientPathDirectory, serverPathDirectory, }: {
+    buildDirectory?: string;
+    clientPathDirectory?: string;
+    serverPathDirectory?: string;
+}) => BuildOptions;

package/lib/types/server/build/manifest.d.ts

@@ -0,0 +1,27 @@
+interface ResolvedAssets {
+    scripts: string[];
+    styles: string[];
+}
+export declare class ManifestManager {
+    private _manifestPath;
+    private _manifest;
+    private _entry;
+    constructor(manifestPath: string);
+    /**
+     * Load the manifest file.
+     */
+    private loadManifest;
+    /**
+     * Resolve all assets for a given page.
+     * @param pageName - The name of the page to resolve.
+     * @returns Resolved assets with scripts and styles.
+     */
+    resolveAssets(pageName: string): ResolvedAssets;
+    /**
+     * Generate meta tags for a given page.
+     * @param pageName - The name of the page to generate meta tags for.
+     * @returns HTML string containing script and style tags.
+     */
+    generateMetaTags(pageName: string): import("react/jsx-runtime").JSX.Element[];
+}
+export {};

package/lib/types/server/build/rendering.d.ts

@@ -0,0 +1,7 @@
+import { FunctionComponent } from "react";
+import { AppConfig } from "../../core/config/type.js";
+import { TemplateProps } from "../../routing/types.js";
+export declare const renderIndexHTML: (template: FunctionComponent<TemplateProps>, options: {
+    rootPath: string;
+    config: AppConfig;
+}) => Promise<void>;

package/lib/types/server/dev/handlers.d.ts

@@ -0,0 +1,27 @@
+import { StaticHandler, StaticHandlerContext } from 'react-router';
+import { AppConfig, Redirect } from '../../core/config/type.js';
+import type * as Express from 'express';
+import { ModuleRunner } from 'vite/module-runner';
+/**
+ * Handle redirect request
+ * @param req
+ * @param res
+ * @param options
+ * @returns
+ */
+export declare function handleRedirectRequest(req: Express.Request, res: Express.Response, { context, redirects, }: {
+    context: StaticHandlerContext | Response;
+    redirects: Redirect[];
+}): Promise<void>;
+export declare function handleDocumentRequest(req: Express.Request, res: Express.Response, runner: ModuleRunner, options: {
+    rootPath: string;
+    __dirname: string;
+    config: AppConfig;
+    handler: StaticHandler;
+}): Promise<any>;
+export declare function handleDataRequest(request: Express.Request, handler: StaticHandler): Promise<Response>;
+export declare function handleSpaModeRequest(res: Express.Response, runner: ModuleRunner, options: {
+    rootPath: string;
+    __dirname: string;
+    config: AppConfig;
+}): Promise<Express.Response<any, Record<string, any>>>;

package/lib/types/server/dev/server.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/types/server/dev/utils.d.ts

@@ -0,0 +1,39 @@
+import { ServerMode } from '../runtime/mode.js';
+import { StaticHandlerContext } from 'react-router';
+import { Metadata } from '../../routing/types.js';
+import type * as Express from 'express';
+import { Redirect } from '../../core/config/type.js';
+export default function getIPAddress(): string;
+/**
+ * Log server info after the server is started
+ * @param {number} port The port the server is running on
+ * @param {boolean} isProduction Whether the server is running in production mode
+ * @param {boolean} open Whether to open the browser automatically
+ */
+export declare function logServerInfo(port: number, mode: ServerMode, open?: boolean): Promise<void>;
+/**
+ * This function extracts the meta data from the React Router context
+ * @param context React Router context
+ */
+export declare function extractMetaFromRRContext(context: StaticHandlerContext): {
+    page: Metadata;
+    layout: Metadata;
+};
+/**
+ * This function extracts the headers from the React Router context
+ * @param context React Router context
+ */
+export declare function extractHeadersFromRRContext(context: StaticHandlerContext): Headers;
+/**
+ * Check if the request is a document request
+ * @param request Express request object
+ */
+export declare function isDocumentRequest(request: Express.Request): boolean;
+export declare function isDataRequest(request: Express.Request): boolean;
+export declare function isResourceRequest(request: Express.Request): boolean;
+/**
+ * Check if the request is an Redirect request
+ * @param context Response context
+ */
+export declare function isRedirectResponse(context: Response): boolean;
+export declare function isStaticRedirectFromConfig(req: Express.Request, redirects: Redirect[]): Promise<boolean>;

package/lib/types/server/node/index.d.ts

@@ -0,0 +1,9 @@
+import type * as Express from 'express';
+import { BuildOptions } from '../build/index.js';
+interface CreateRequestHandlerOptions {
+    build: BuildOptions;
+}
+export declare function createRequestHandler(options: CreateRequestHandlerOptions): (req: Express.Request, res: Express.Response) => Promise<void | Response>;
+export declare function handleDocumentRequest(): void;
+export declare function handleDataRequest(): void;
+export {};

package/lib/types/server/node/rendering.d.ts

@@ -0,0 +1,9 @@
+import type * as Express from 'express';
+/**
+ * Render a React component to a stream.
+ * @param Component
+ * @param res
+ * @returns
+ */
+export declare const renderToStream: (Component: React.ReactNode, res: Express.Response) => Promise<unknown>;
+export declare const renderToString: (Component: React.ReactNode) => string;

package/lib/types/server/node/stream.d.ts

@@ -0,0 +1,7 @@
+import type { Readable, Writable } from 'node:stream';
+export declare function writeReadableStreamToWritable(stream: ReadableStream, writable: Writable): Promise<void>;
+export declare function writeAsyncIterableToWritable(iterable: AsyncIterable<Uint8Array>, writable: Writable): Promise<void>;
+export declare function readableStreamToString(stream: ReadableStream<Uint8Array>, encoding?: BufferEncoding): Promise<string>;
+export declare const createReadableStreamFromReadable: (source: Readable & {
+    readableHighWaterMark?: number;
+}) => ReadableStream<ArrayBufferView<ArrayBufferLike>>;

package/lib/types/server/node/utils.d.ts

@@ -0,0 +1,18 @@
+import type * as Express from 'express';
+/**
+ * This function is used to create a Rasengan request from an Express request.
+ * Reference: https://github.com/remix-run/react-router/blob/main/packages/react-router-express/server.ts#L86
+ */
+export default function createRasenganRequest(req: Express.Request, res: Express.Response): Request;
+/**
+ * This function is used to send a Rasengan response to an Express response.
+ * @param res
+ * @param nodeResponse
+ */
+export declare function sendRasenganResponse(res: Express.Response, nodeResponse: Response): Promise<void>;
+/**
+ * This function is used to create a Rasengan headers from Express request headers.
+ * @param requestHeaders
+ * @returns
+ */
+export declare function createRasenganHeaders(requestHeaders: Record<string, string | string[]>): Headers;

package/lib/types/server/runtime/mode.d.ts

@@ -0,0 +1,9 @@
+/**
+ * The mode to use when running the server.
+ */
+export declare enum ServerMode {
+    Development = "development",
+    Production = "production",
+    Test = "test"
+}
+export declare function isServerMode(value: any): value is ServerMode;

package/lib/types/server/runtime/utils.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Check if the current OS is the provided one
+ */
+export declare const checkOsPlateform: (osname: "aix" | "darwin" | "freebsd" | "linux" | "openbsd" | "sunos" | "win32") => boolean;

package/lib/types/server/virtual/index.d.ts

@@ -0,0 +1,5 @@
+export declare function create(name: string): {
+    id: string;
+    resolvedId: string;
+    url: string;
+};

package/lib/types/server.d.ts

@@ -0,0 +1,4 @@
+import { createRequestHandler } from './server/node/index.js';
+import { resolveBuildOptions } from './server/build/index.js';
+export * from './server/build/manifest.js';
+export { createRequestHandler, resolveBuildOptions };

package/package.json

@@ -1,30 +1,50 @@
 {
   "name": "rasengan",
   "private": false,
-  "version": "1.0.0-beta.6",
+  "version": "1.0.0-beta.60",
+  "description": "The modern React Framework",
   "type": "module",
-  "main": "lib/index.js",
+  "main": "lib/esm/index.js",
   "bin": {
-    "rasengan": "./lib/cli/index.js"
+    "rasengan": "bin.js"
   },
   "exports": {
     ".": {
+      "types": "./lib/types/index.d.ts",
       "import": {
-        "types": "./lib/index.d.ts",
-        "default": "./lib/index.js"
+        "types": "./lib/types/index.d.ts",
+        "default": "./lib/esm/index.js"
       },
       "require": {
-        "types": "./lib/index.d.ts",
-        "default": "./lib/index.js"
-      }
+        "types": "./lib/types/index.d.ts",
+        "default": "./lib/esm/index.js"
+      },
+      "default": "./lib/esm/index.js"
+    },
+    "./types/client": {
+      "types": "./types/client.d.ts"
     },
-    "./types/image": {
-      "types": "./types/image.d.ts"
+    "./package.json": "./package.json",
+    "./dynamic": {
+      "types": "./lib/types/core/dynamic/index.d.ts",
+      "import": "./lib/esm/core/dynamic/index.js",
+      "require": "./lib/esm/core/dynamic/index.js"
     },
-    "./types/style": {
-      "types": "./types/style.d.ts"
+    "./server": {
+      "types": "./lib/types/server.d.ts",
+      "import": "./lib/esm/server.js",
+      "require": "./lib/esm/server.js"
     },
-    "./package.json": "./package.json"
+    "./client": {
+      "types": "./lib/types/client.d.ts",
+      "import": "./lib/esm/client.js",
+      "require": "./lib/esm/client.js"
+    },
+    "./plugin": {
+      "types": "./lib/types/plugin.d.ts",
+      "import": "./lib/esm/plugin.js",
+      "require": "./lib/esm/plugin.js"
+    }
   },
   "author": {
     "name": "dilane3",
@@ -35,60 +55,90 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/rasengan/rasengan.git",
-    "issues": "https://github.com/rasengan/rasengan/issues"
+    "url": "https://github.com/rasengan-dev/rasenganjs.git",
+    "issues": "https://github.com/rasengan-dev/rasenganjs/issues"
   },
   "homepage": "https://rasengan.dev",
-  "scripts": {
-    "dev": "node server",
-    "build": "npm run build:client && npm run build:server",
-    "build:client": "vite build --ssrManifest --outDir dist/client",
-    "build:server": "vite build --ssr node_modules/rasengan/lib/entries/entry-server.js --outDir dist/server",
-    "build:lib": "tsc -p tsconfig.lib.json",
-    "preview": "cross-env NODE_ENV=production node server",
-    "deploy": "npm publish --access public",
-    "deploy:beta": "npm run deploy --tag beta",
-    "pack": "npm pack --pack-destination ./../packages/rasengan/"
-  },
   "dependencies": {
-    "@vercel/node": "^3.0.14",
     "@vitejs/plugin-react": "^4.2.1",
     "chalk": "^5.3.0",
     "commander": "^11.1.0",
     "compression": "^1.7.4",
-    "cross-spawn": "^7.0.3",
     "execa": "^8.0.1",
     "express": "^4.18.2",
     "inquirer": "^9.2.12",
-    "keypress": "^0.2.1",
-    "node-fetch": "^3.3.2",
     "open": "^10.1.0",
     "ora": "^7.0.1",
-    "react-helmet-async": "^2.0.4",
-    "react-router-dom": "^6.20.1",
-    "sirv": "^2.0.3",
-    "vite": "^5.0.12"
+    "react-router": "^7.0.0"
   },
   "peerDependencies": {
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0"
+    "@types/node": "^18.0.0 || >=20.0.0",
+    "less": "*",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "sass": "*",
+    "stylus": "*",
+    "vite": "^6.0.0",
+    "@rasenganjs/mdx": "^1.1.0-beta.1"
+  },
+  "peerDependenciesMeta": {
+    "@types/node": {
+      "optional": true
+    },
+    "sass": {
+      "optional": true
+    },
+    "stylus": {
+      "optional": true
+    },
+    "less": {
+      "optional": true
+    },
+    "@rasenganjs/mdx": {
+      "optional": true
+    }
   },
   "devDependencies": {
     "@types/compression": "^1.7.4",
-    "@types/cross-spawn": "^6.0.4",
     "@types/express": "^4.17.19",
     "@types/node": "^20.8.6",
-    "@types/react": "^18.2.28",
-    "@types/react-dom": "^18.2.13",
-    "cross-env": "^7.0.3",
-    "typescript": "^5.2.2"
-  },
-  "resolutions": {
-    "@vitejs/plugin-react": "^4.2.1"
+    "@types/react": "^19.0.1",
+    "@types/react-dom": "^19.0.1",
+    "cross-env": "^7.0.3"
   },
   "license": "MIT",
   "engines": {
-    "node": ">=16.0.0",
-    "npm": ">=7.0.0"
+    "node": ">=20.13.1"
+  },
+  "files": [
+    "lib/",
+    "types/",
+    "bin.js",
+    "CHANGELOG.md",
+    "LICENSE.md",
+    "README.md",
+    "tsconfig.esm.json",
+    "tsconfig.types.json",
+    "tsconfig.base.json",
+    "vite.config.ts"
+  ],
+  "keywords": [
+    "rasengan",
+    "frontend",
+    "framework",
+    "react framework",
+    "react",
+    "vite",
+    "ssr",
+    "ssg",
+    "spa"
+  ],
+  "scripts": {
+    "build:compile": "tsc -b ./tsconfig.esm.json ./tsconfig.types.json",
+    "build:clean": "rimraf ./lib",
+    "build": "pnpm run build:clean & pnpm run build:compile",
+    "deploy": "pnpm publish --access public",
+    "deploy:beta": "pnpm run deploy --tag beta",
+    "pack": "pnpm pack --pack-destination ./release/"
   }
-}
+}