vite-react-ssg 0.3.3 → 0.4.0

package/dist/{types-3aee4b6b.d.ts → shared/vite-react-ssg.d5f23f74.d.cts}

@@ -175,4 +175,4 @@ declare module 'vite' {
     }
 }
 
-export { IndexRouteRecord as I, NonIndexRouteRecord as N, RouterOptions as R, StyleCollector as S, ViteReactSSGContext as V, ViteReactSSGClientOptions as a, ViteReactSSGOptions as b, RouteRecord as c };
+export type { IndexRouteRecord as I, NonIndexRouteRecord as N, RouterOptions as R, StyleCollector as S, ViteReactSSGOptions as V, ViteReactSSGContext as a, ViteReactSSGClientOptions as b, RouteRecord as c };

package/dist/shared/vite-react-ssg.d5f23f74.d.mts

@@ -0,0 +1,178 @@
+import { Options } from 'critters';
+import { ReactElement } from 'react';
+import { NonIndexRouteObject, IndexRouteObject, createBrowserRouter } from 'react-router-dom';
+
+type Router = ReturnType<typeof createBrowserRouter>;
+interface ViteReactSSGOptions {
+    /**
+     * Set the scripts' loading mode. Only works for `type="module"`.
+     *
+     * @default 'sync'
+     */
+    script?: 'sync' | 'async' | 'defer' | 'async defer';
+    /**
+     * Build format.
+     *
+     * @default 'esm'
+     */
+    format?: 'esm' | 'cjs';
+    /**
+     * The path of the main entry file (relative to the project root).
+     *
+     * @default 'src/main.ts'
+     */
+    entry?: string;
+    /**
+     * Mock browser global variables (window, document, etc...) from SSG.
+     *
+     * @default false
+     */
+    mock?: boolean;
+    /**
+     * Apply formatter to the generated index file.
+     *
+     * **It will cause Hydration Failed.**
+     *
+     * @default 'none'
+     */
+    formatting?: 'minify' | 'prettify' | 'none';
+    /**
+     * Vite environmeng mode.
+     */
+    mode?: string;
+    /**
+     * Directory style of the output directory.
+     *
+     * flat: `/foo` -> `/foo.html`
+     * nested: `/foo` -> `/foo/index.html`
+     *
+     * @default 'flat'
+     */
+    dirStyle?: 'flat' | 'nested';
+    /**
+     * Generate for all routes, including dynamic routes.
+     * If enabled, you will need to configGure your serve
+     * manually to handle dynamic routes properly.
+     *
+     * @default false
+     */
+    includeAllRoutes?: boolean;
+    /**
+     * Options for the critters packages.
+     *
+     * @see https://github.com/GoogleChromeLabs/critters
+     */
+    crittersOptions?: Options | false;
+    /**
+     * Custom function to modify the routes to do the SSG.
+     *
+     * Works only when `includeAllRoutes` is set to false.
+     *
+     * Defaults to a handler that filters out all the dynamic routes.
+     * When passing your custom handler, you should also take care of the dynamic routes yourself.
+     */
+    includedRoutes?: (paths: string[], routes: Readonly<RouteRecord[]>) => Promise<string[]> | string[];
+    /**
+     * Callback to be called before every page render.
+     *
+     * It can be used to transform the project's `index.html` file before passing it to the renderer.
+     *
+     * To do so, you can change the 'index.html' file contents (passed in through the `indexHTML` parameter), and return it.
+     * The returned value will then be passed to renderer.
+     */
+    onBeforePageRender?: (route: string, indexHTML: string, appCtx: ViteReactSSGContext<true>) => Promise<string | null | undefined> | string | null | undefined;
+    /**
+     * Callback to be called on every rendered page.
+     *
+     * It can be used to transform the current route's rendered HTML.
+     *
+     * To do so, you can transform the route's rendered HTML (passed in through the `renderedHTML` parameter), and return it.
+     * The returned value will be used as the HTML of the route.
+     */
+    onPageRendered?: (route: string, renderedHTML: string, appCtx: ViteReactSSGContext<true>) => Promise<string | null | undefined> | string | null | undefined;
+    onFinished?: () => Promise<void> | void;
+    /**
+     * The application's root container `id`.
+     *
+     * @default `root`
+     */
+    rootContainerId?: string;
+    /**
+     * The size of the SSG processing queue.
+     *
+     * @default 20
+     */
+    concurrency?: number;
+}
+interface ViteReactSSGContext<HasRouter extends boolean = true> {
+    router?: HasRouter extends true ? Router : undefined;
+    routes: HasRouter extends true ? Readonly<RouteRecord[]> : undefined;
+    routerOptions: RouterOptions;
+    initialState: Record<string, any>;
+    isClient: boolean;
+    onSSRAppRendered(cb: Function): void;
+    triggerOnSSRAppRendered(route: string, appHTML: string, appCtx: ViteReactSSGContext): Promise<unknown[]>;
+    transformState?(state: any): any;
+    /**
+     * Current router path on SSG, `undefined` on client side.
+     */
+    routePath?: string;
+    getStyleCollector: (() => StyleCollector | Promise<StyleCollector>) | null;
+}
+interface ViteReactSSGClientOptions {
+    transformState?: (state: any) => any;
+    registerComponents?: boolean;
+    /**
+     * The application's root container query selector.
+     *
+     * @default `#root`
+     */
+    rootContainer?: string | Element;
+    /**
+     * Use SSR during development.
+     *
+     * If false, the 'dev' script in 'package.json' needs to be set to `"vite"`.
+     *
+     * @default true
+     */
+    ssrWhenDev?: boolean;
+    getStyleCollector?: (() => StyleCollector | Promise<StyleCollector>) | null;
+}
+interface CommonRouteOptions {
+    /**
+     * Used to obtain static resources through manifest
+     *
+     * @example `src/pages/home.tsx`
+     */
+    entry?: string;
+    /**
+     * The getStaticPaths() function should return an array of path
+     * to determine which paths will be pre-rendered by vite-react-ssg.
+     *
+     * This function is only valid for dynamic route.
+     *
+     * @example () => ['path1', 'path2']
+     */
+    getStaticPaths?: () => string[] | Promise<string[]>;
+}
+type NonIndexRouteRecord = Omit<NonIndexRouteObject, 'children'> & {
+    children?: RouteRecord[];
+} & CommonRouteOptions;
+type IndexRouteRecord = IndexRouteObject & CommonRouteOptions;
+type RouteRecord = NonIndexRouteRecord | IndexRouteRecord;
+interface RouterOptions {
+    routes: RouteRecord[];
+    createFetchRequest?: <T>(req: T) => Request;
+}
+interface StyleCollector {
+    collect: (app: ReactElement) => ReactElement;
+    toString: (html: string) => string;
+    cleanup?: () => void;
+}
+declare module 'vite' {
+    interface UserConfig {
+        ssgOptions?: ViteReactSSGOptions;
+    }
+}
+
+export type { IndexRouteRecord as I, NonIndexRouteRecord as N, RouterOptions as R, StyleCollector as S, ViteReactSSGOptions as V, ViteReactSSGContext as a, ViteReactSSGClientOptions as b, RouteRecord as c };

package/dist/shared/vite-react-ssg.d5f23f74.d.ts

@@ -0,0 +1,178 @@
+import { Options } from 'critters';
+import { ReactElement } from 'react';
+import { NonIndexRouteObject, IndexRouteObject, createBrowserRouter } from 'react-router-dom';
+
+type Router = ReturnType<typeof createBrowserRouter>;
+interface ViteReactSSGOptions {
+    /**
+     * Set the scripts' loading mode. Only works for `type="module"`.
+     *
+     * @default 'sync'
+     */
+    script?: 'sync' | 'async' | 'defer' | 'async defer';
+    /**
+     * Build format.
+     *
+     * @default 'esm'
+     */
+    format?: 'esm' | 'cjs';
+    /**
+     * The path of the main entry file (relative to the project root).
+     *
+     * @default 'src/main.ts'
+     */
+    entry?: string;
+    /**
+     * Mock browser global variables (window, document, etc...) from SSG.
+     *
+     * @default false
+     */
+    mock?: boolean;
+    /**
+     * Apply formatter to the generated index file.
+     *
+     * **It will cause Hydration Failed.**
+     *
+     * @default 'none'
+     */
+    formatting?: 'minify' | 'prettify' | 'none';
+    /**
+     * Vite environmeng mode.
+     */
+    mode?: string;
+    /**
+     * Directory style of the output directory.
+     *
+     * flat: `/foo` -> `/foo.html`
+     * nested: `/foo` -> `/foo/index.html`
+     *
+     * @default 'flat'
+     */
+    dirStyle?: 'flat' | 'nested';
+    /**
+     * Generate for all routes, including dynamic routes.
+     * If enabled, you will need to configGure your serve
+     * manually to handle dynamic routes properly.
+     *
+     * @default false
+     */
+    includeAllRoutes?: boolean;
+    /**
+     * Options for the critters packages.
+     *
+     * @see https://github.com/GoogleChromeLabs/critters
+     */
+    crittersOptions?: Options | false;
+    /**
+     * Custom function to modify the routes to do the SSG.
+     *
+     * Works only when `includeAllRoutes` is set to false.
+     *
+     * Defaults to a handler that filters out all the dynamic routes.
+     * When passing your custom handler, you should also take care of the dynamic routes yourself.
+     */
+    includedRoutes?: (paths: string[], routes: Readonly<RouteRecord[]>) => Promise<string[]> | string[];
+    /**
+     * Callback to be called before every page render.
+     *
+     * It can be used to transform the project's `index.html` file before passing it to the renderer.
+     *
+     * To do so, you can change the 'index.html' file contents (passed in through the `indexHTML` parameter), and return it.
+     * The returned value will then be passed to renderer.
+     */
+    onBeforePageRender?: (route: string, indexHTML: string, appCtx: ViteReactSSGContext<true>) => Promise<string | null | undefined> | string | null | undefined;
+    /**
+     * Callback to be called on every rendered page.
+     *
+     * It can be used to transform the current route's rendered HTML.
+     *
+     * To do so, you can transform the route's rendered HTML (passed in through the `renderedHTML` parameter), and return it.
+     * The returned value will be used as the HTML of the route.
+     */
+    onPageRendered?: (route: string, renderedHTML: string, appCtx: ViteReactSSGContext<true>) => Promise<string | null | undefined> | string | null | undefined;
+    onFinished?: () => Promise<void> | void;
+    /**
+     * The application's root container `id`.
+     *
+     * @default `root`
+     */
+    rootContainerId?: string;
+    /**
+     * The size of the SSG processing queue.
+     *
+     * @default 20
+     */
+    concurrency?: number;
+}
+interface ViteReactSSGContext<HasRouter extends boolean = true> {
+    router?: HasRouter extends true ? Router : undefined;
+    routes: HasRouter extends true ? Readonly<RouteRecord[]> : undefined;
+    routerOptions: RouterOptions;
+    initialState: Record<string, any>;
+    isClient: boolean;
+    onSSRAppRendered(cb: Function): void;
+    triggerOnSSRAppRendered(route: string, appHTML: string, appCtx: ViteReactSSGContext): Promise<unknown[]>;
+    transformState?(state: any): any;
+    /**
+     * Current router path on SSG, `undefined` on client side.
+     */
+    routePath?: string;
+    getStyleCollector: (() => StyleCollector | Promise<StyleCollector>) | null;
+}
+interface ViteReactSSGClientOptions {
+    transformState?: (state: any) => any;
+    registerComponents?: boolean;
+    /**
+     * The application's root container query selector.
+     *
+     * @default `#root`
+     */
+    rootContainer?: string | Element;
+    /**
+     * Use SSR during development.
+     *
+     * If false, the 'dev' script in 'package.json' needs to be set to `"vite"`.
+     *
+     * @default true
+     */
+    ssrWhenDev?: boolean;
+    getStyleCollector?: (() => StyleCollector | Promise<StyleCollector>) | null;
+}
+interface CommonRouteOptions {
+    /**
+     * Used to obtain static resources through manifest
+     *
+     * @example `src/pages/home.tsx`
+     */
+    entry?: string;
+    /**
+     * The getStaticPaths() function should return an array of path
+     * to determine which paths will be pre-rendered by vite-react-ssg.
+     *
+     * This function is only valid for dynamic route.
+     *
+     * @example () => ['path1', 'path2']
+     */
+    getStaticPaths?: () => string[] | Promise<string[]>;
+}
+type NonIndexRouteRecord = Omit<NonIndexRouteObject, 'children'> & {
+    children?: RouteRecord[];
+} & CommonRouteOptions;
+type IndexRouteRecord = IndexRouteObject & CommonRouteOptions;
+type RouteRecord = NonIndexRouteRecord | IndexRouteRecord;
+interface RouterOptions {
+    routes: RouteRecord[];
+    createFetchRequest?: <T>(req: T) => Request;
+}
+interface StyleCollector {
+    collect: (app: ReactElement) => ReactElement;
+    toString: (html: string) => string;
+    cleanup?: () => void;
+}
+declare module 'vite' {
+    interface UserConfig {
+        ssgOptions?: ViteReactSSGOptions;
+    }
+}
+
+export type { IndexRouteRecord as I, NonIndexRouteRecord as N, RouterOptions as R, StyleCollector as S, ViteReactSSGOptions as V, ViteReactSSGContext as a, ViteReactSSGClientOptions as b, RouteRecord as c };

package/dist/style-collectors/styled-components.d.cts

@@ -0,0 +1,9 @@
+import { ReactElement } from 'react';
+
+declare function ssrCollector(): Promise<{
+    collect(app: ReactElement): JSX.Element;
+    toString(): string;
+    cleanup(): void;
+}>;
+
+export { ssrCollector as default };

package/dist/style-collectors/styled-components.d.mts

@@ -0,0 +1,9 @@
+import { ReactElement } from 'react';
+
+declare function ssrCollector(): Promise<{
+    collect(app: ReactElement): JSX.Element;
+    toString(): string;
+    cleanup(): void;
+}>;
+
+export { ssrCollector as default };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vite-react-ssg",
   "type": "module",
-  "version": "0.3.3",
+  "version": "0.4.0",
   "packageManager": "pnpm@8.6.6",
   "description": "",
   "author": "Riri <Daydreamerriri@outlook.com>",
@@ -23,18 +23,18 @@
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "require": "./dist/index.cjs",
-      "import": "./dist/index.mjs"
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
     },
     "./node": {
       "types": "./dist/node.d.ts",
-      "require": "./dist/node.cjs",
-      "import": "./dist/node.mjs"
+      "import": "./dist/node.mjs",
+      "require": "./dist/node.cjs"
     },
     "./style-collectors/styled-components": {
       "types": "./dist/style-collectors/styled-components.d.ts",
-      "require": "./dist/style-collectors/styled-components.cjs",
-      "import": "./dist/style-collectors/styled-components.mjs"
+      "import": "./dist/style-collectors/styled-components.mjs",
+      "require": "./dist/style-collectors/styled-components.cjs"
     }
   },
   "main": "./dist/index.mjs",
@@ -88,7 +88,7 @@
     }
   },
   "dependencies": {
-    "@remix-run/web-fetch": "^4.3.5",
+    "@remix-run/web-fetch": "^4.3.8",
     "express": "^4.18.2",
     "fs-extra": "^11.1.1",
     "html-minifier": "^4.0.0",
@@ -100,13 +100,13 @@
     "yargs": "^17.7.2"
   },
   "devDependencies": {
-    "@ririd/eslint-config": "0.6.0",
+    "@childrentime/devcert": "^1.2.5",
+    "@ririd/eslint-config": "0.7.0",
     "@types/express": "^4.17.17",
     "@types/fs-extra": "^11.0.1",
     "@types/html-minifier": "^4.0.2",
     "@types/jsdom": "^21.1.1",
     "@types/node": "^18.15.11",
-    "@types/prettier": "^2.7.3",
     "@types/react": "^18.2.14",
     "@types/react-dom": "^18.2.6",
     "@types/yargs": "^17.0.24",
@@ -115,14 +115,14 @@
     "eslint": "^8.45.0",
     "esno": "^0.17.0",
     "fast-glob": "3.3.1",
-    "p-queue": "^7.3.4",
+    "p-queue": "^7.4.1",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "react-router-dom": "^6.14.1",
+    "react-router-dom": "^6.15.0",
     "rimraf": "5.0.1",
     "styled-components": "6.0.5",
     "typescript": "5.1.6",
-    "unbuild": "^1.2.1",
+    "unbuild": "^2.0.0",
     "vite": "^4.4.9",
     "vite-plugin-pwa": "^0.16.4",
     "vitest": "0.34.1"