vite-react-ssg 0.0.1

package/dist/types-fa5fe9c2.d.ts

@@ -0,0 +1,141 @@
+import { Options } from 'critters';
+import { ReactNode } from 'react';
+import { RouteObject, 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.
+     *
+     * @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 `class`.
+     *
+     * @default `root`
+     */
+    rootContainerId?: string;
+    /**
+     * The size of the SSG processing queue.
+     *
+     * @default 20
+     */
+    concurrency?: number;
+}
+interface ViteReactSSGContext<HasRouter extends boolean = true> {
+    app?: ReactNode;
+    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;
+}
+interface ViteReactSSGClientOptions {
+    transformState?: (state: any) => any;
+    registerComponents?: boolean;
+    /**
+     * The application's root container query selector.
+     *
+     * @default `#root`
+     */
+    rootContainer?: string | Element;
+}
+type RouteRecord = RouteObject & {};
+interface RouterOptions {
+    routes: RouteRecord[];
+    createFetchRequest?: <T>(req: T) => Request;
+}
+declare module 'vite' {
+    interface UserConfig {
+        ssgOptions?: ViteReactSSGOptions;
+    }
+}
+
+export { RouterOptions as R, ViteReactSSGContext as V, ViteReactSSGClientOptions as a, ViteReactSSGOptions as b };

package/package.json

@@ -0,0 +1,112 @@
+{
+  "name": "vite-react-ssg",
+  "type": "module",
+  "version": "0.0.1",
+  "packageManager": "pnpm@8.6.6",
+  "description": "",
+  "author": "Riri <Daydreamerriri@outlook.com>",
+  "license": "MIT",
+  "homepage": "https://github.com/Daydreamer-riri/vite-react-ssg#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Daydreamer-riri/vite-react-ssg.git"
+  },
+  "bugs": "https://github.com/Daydreamer-riri/vite-react-ssg/issues",
+  "keywords": [
+    "vite",
+    "vite-plugin",
+    "ssg",
+    "ssr",
+    "react"
+  ],
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.mjs"
+    },
+    "./node": {
+      "types": "./dist/node.d.ts",
+      "require": "./dist/node.cjs",
+      "import": "./dist/node.mjs"
+    }
+  },
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "node": [
+        "./dist/node.d.ts"
+      ]
+    }
+  },
+  "bin": {
+    "vite-react-ssg": "bin/vite-react-ssg.js"
+  },
+  "files": [
+    "dist",
+    "bin",
+    "*.d.ts"
+  ],
+  "scripts": {
+    "build": "unbuild",
+    "dev": "unbuild --stub",
+    "lint": "eslint .",
+    "prepublishOnly": "nr build",
+    "release": "bumpp && npm publish",
+    "start": "esno src/index.ts",
+    "typecheck": "tsc --noEmit"
+  },
+  "peerDependencies": {
+    "critters": "^0.0.19",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
+    "react-router-dom": "^6.14.1",
+    "vite": "^2.0.0 || ^3.0.0 || ^4.0.0"
+  },
+  "peerDependenciesMeta": {
+    "critters": {
+      "optional": true
+    },
+    "react-router-dom": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "fs-extra": "^11.1.1",
+    "html-minifier": "^4.0.0",
+    "html5parser": "^2.0.2",
+    "jsdom": "^22.1.0",
+    "kolorist": "^1.8.0",
+    "react-helmet-async": "^1.3.0",
+    "yargs": "^17.7.2"
+  },
+  "devDependencies": {
+    "@ririd/eslint-config": "0.5.1",
+    "@types/fs-extra": "^11.0.1",
+    "@types/html-minifier": "^4.0.2",
+    "@types/jsdom": "^21.1.1",
+    "@types/node": "^18.15.11",
+    "@types/react": "^18.2.14",
+    "@types/react-dom": "^18.2.6",
+    "@types/react-helmet-async": "^1.0.3",
+    "@types/yargs": "^17.0.24",
+    "bumpp": "^9.1.0",
+    "critters": "^0.0.19",
+    "eslint": "^8.40.0",
+    "esno": "^0.16.3",
+    "p-queue": "^7.3.4",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-router-dom": "^6.14.1",
+    "rimraf": "5.0.1",
+    "simple-git-hooks": "^2.8.1",
+    "typescript": "5.1.6",
+    "unbuild": "^1.2.1",
+    "vite": "^4.3.9",
+    "vite-plugin-pwa": "^0.16.4",
+    "vitest": "0.33.0"
+  }
+}