vite-react-ssg 0.5.1 → 0.6.0

package/dist/shared/vite-react-ssg.8cdb31f1.mjs

@@ -0,0 +1,40 @@
+import React, { useState, useEffect, isValidElement } from 'react';
+import { Helmet } from 'react-helmet-async';
+
+function documentReady(_passThrough) {
+  if (document.readyState === "loading") {
+    return new Promise((resolve) => {
+      document.addEventListener("DOMContentLoaded", () => resolve(_passThrough));
+    });
+  }
+  return Promise.resolve(_passThrough);
+}
+
+function Head(props) {
+  return /* @__PURE__ */ React.createElement(Helmet, { ...props });
+}
+
+function useIsClient() {
+  const [isBrowser, setIsBrowser] = useState(false);
+  useEffect(() => {
+    setIsBrowser(true);
+  }, []);
+  return isBrowser;
+}
+
+function ClientOnly({
+  children,
+  fallback
+}) {
+  const isBrowser = useIsClient();
+  if (isBrowser) {
+    if (typeof children !== "function" && process.env.NODE_ENV === "development") {
+      throw new Error(`vite-react-ssg error: The children of <ClientOnly> must be a "render function", e.g. <ClientOnly>{() => <span>{window.location.href}</span>}</ClientOnly>.
+Current type: ${isValidElement(children) ? "React element" : typeof children}`);
+    }
+    return /* @__PURE__ */ React.createElement(React.Fragment, null, children?.());
+  }
+  return fallback ?? null;
+}
+
+export { ClientOnly as C, Head as H, documentReady as d };

package/dist/shared/vite-react-ssg.a009fbf1.mjs

@@ -0,0 +1,34 @@
+const UNSAFE_CHARS_REGEXP = /[<>\/\u2028\u2029]/g;
+const ESCAPED_CHARS = {
+  "<": "\\u003C",
+  ">": "\\u003E",
+  "/": "\\u002F",
+  "\u2028": "\\u2028",
+  "\u2029": "\\u2029"
+};
+function escapeUnsafeChars(unsafeChar) {
+  return ESCAPED_CHARS[unsafeChar];
+}
+function serializeState(state) {
+  if (state == null || Object.keys(state).length === 0)
+    return null;
+  try {
+    return JSON.stringify(JSON.stringify(state || {})).replace(
+      UNSAFE_CHARS_REGEXP,
+      escapeUnsafeChars
+    );
+  } catch (error) {
+    console.error("[SSG] On state serialization -", error, state);
+    return null;
+  }
+}
+function deserializeState(state) {
+  try {
+    return JSON.parse(state || "{}");
+  } catch (error) {
+    console.error("[SSG] On state deserialization -", error, state);
+    return {};
+  }
+}
+
+export { deserializeState as d, serializeState as s };

package/dist/shared/vite-react-ssg.c639b3fe.cjs

@@ -0,0 +1,48 @@
+'use strict';
+
+const React = require('react');
+const reactHelmetAsync = require('react-helmet-async');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
+
+const React__default = /*#__PURE__*/_interopDefaultCompat(React);
+
+function documentReady(_passThrough) {
+  if (document.readyState === "loading") {
+    return new Promise((resolve) => {
+      document.addEventListener("DOMContentLoaded", () => resolve(_passThrough));
+    });
+  }
+  return Promise.resolve(_passThrough);
+}
+
+function Head(props) {
+  return /* @__PURE__ */ React__default.createElement(reactHelmetAsync.Helmet, { ...props });
+}
+
+function useIsClient() {
+  const [isBrowser, setIsBrowser] = React.useState(false);
+  React.useEffect(() => {
+    setIsBrowser(true);
+  }, []);
+  return isBrowser;
+}
+
+function ClientOnly({
+  children,
+  fallback
+}) {
+  const isBrowser = useIsClient();
+  if (isBrowser) {
+    if (typeof children !== "function" && process.env.NODE_ENV === "development") {
+      throw new Error(`vite-react-ssg error: The children of <ClientOnly> must be a "render function", e.g. <ClientOnly>{() => <span>{window.location.href}</span>}</ClientOnly>.
+Current type: ${React.isValidElement(children) ? "React element" : typeof children}`);
+    }
+    return /* @__PURE__ */ React__default.createElement(React__default.Fragment, null, children?.());
+  }
+  return fallback ?? null;
+}
+
+exports.ClientOnly = ClientOnly;
+exports.Head = Head;
+exports.documentReady = documentReady;

package/dist/shared/{vite-react-ssg.91f86102.d.cts → vite-react-ssg.d734eb79.d.cts}

@@ -1,5 +1,5 @@
 import { Options } from 'critters';
-import { ReactElement } from 'react';
+import { ReactNode, ReactElement } from 'react';
 import { NonIndexRouteObject, IndexRouteObject, createBrowserRouter } from 'react-router-dom';
 
 type Router = ReturnType<typeof createBrowserRouter>;
@@ -107,7 +107,7 @@ interface ViteReactSSGOptions {
 interface ViteReactSSGContext<HasRouter extends boolean = true> {
     router?: HasRouter extends true ? Router : undefined;
     routes: HasRouter extends true ? Readonly<RouteRecord[]> : undefined;
-    routerOptions: RouterOptions;
+    routerOptions: HasRouter extends true ? RouterOptions : undefined;
     initialState: Record<string, any>;
     isClient: boolean;
     onSSRAppRendered(cb: Function): void;
@@ -119,6 +119,7 @@ interface ViteReactSSGContext<HasRouter extends boolean = true> {
     routePath?: string;
     base: string;
     getStyleCollector: (() => StyleCollector | Promise<StyleCollector>) | null;
+    app?: HasRouter extends true ? never : ReactNode;
 }
 interface ViteReactSSGClientOptions {
     transformState?: (state: any) => any;
@@ -130,11 +131,7 @@ interface ViteReactSSGClientOptions {
      */
     rootContainer?: string | Element;
     /**
-     * Use SSR during development.
-     *
-     * If false, the 'dev' script in 'package.json' needs to be set to `"vite"`.
-     *
-     * @default true
+     * @deprecated This option is no longer needed
      */
     ssrWhenDev?: boolean;
     getStyleCollector?: (() => StyleCollector | Promise<StyleCollector>) | null;
@@ -164,6 +161,7 @@ type RouteRecord = NonIndexRouteRecord | IndexRouteRecord;
 interface RouterOptions {
     routes: RouteRecord[];
     createFetchRequest?: <T>(req: T) => Request;
+    basename?: string;
 }
 interface StyleCollector {
     collect: (app: ReactElement) => ReactElement;
@@ -176,4 +174,4 @@ declare module 'vite' {
     }
 }
 
-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 };
+export type { IndexRouteRecord as I, NonIndexRouteRecord as N, RouteRecord as R, StyleCollector as S, ViteReactSSGContext as V, ViteReactSSGClientOptions as a, ViteReactSSGOptions as b, RouterOptions as c };

package/dist/shared/{vite-react-ssg.91f86102.d.mts → vite-react-ssg.d734eb79.d.mts}

@@ -1,5 +1,5 @@
 import { Options } from 'critters';
-import { ReactElement } from 'react';
+import { ReactNode, ReactElement } from 'react';
 import { NonIndexRouteObject, IndexRouteObject, createBrowserRouter } from 'react-router-dom';
 
 type Router = ReturnType<typeof createBrowserRouter>;
@@ -107,7 +107,7 @@ interface ViteReactSSGOptions {
 interface ViteReactSSGContext<HasRouter extends boolean = true> {
     router?: HasRouter extends true ? Router : undefined;
     routes: HasRouter extends true ? Readonly<RouteRecord[]> : undefined;
-    routerOptions: RouterOptions;
+    routerOptions: HasRouter extends true ? RouterOptions : undefined;
     initialState: Record<string, any>;
     isClient: boolean;
     onSSRAppRendered(cb: Function): void;
@@ -119,6 +119,7 @@ interface ViteReactSSGContext<HasRouter extends boolean = true> {
     routePath?: string;
     base: string;
     getStyleCollector: (() => StyleCollector | Promise<StyleCollector>) | null;
+    app?: HasRouter extends true ? never : ReactNode;
 }
 interface ViteReactSSGClientOptions {
     transformState?: (state: any) => any;
@@ -130,11 +131,7 @@ interface ViteReactSSGClientOptions {
      */
     rootContainer?: string | Element;
     /**
-     * Use SSR during development.
-     *
-     * If false, the 'dev' script in 'package.json' needs to be set to `"vite"`.
-     *
-     * @default true
+     * @deprecated This option is no longer needed
      */
     ssrWhenDev?: boolean;
     getStyleCollector?: (() => StyleCollector | Promise<StyleCollector>) | null;
@@ -164,6 +161,7 @@ type RouteRecord = NonIndexRouteRecord | IndexRouteRecord;
 interface RouterOptions {
     routes: RouteRecord[];
     createFetchRequest?: <T>(req: T) => Request;
+    basename?: string;
 }
 interface StyleCollector {
     collect: (app: ReactElement) => ReactElement;
@@ -176,4 +174,4 @@ declare module 'vite' {
     }
 }
 
-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 };
+export type { IndexRouteRecord as I, NonIndexRouteRecord as N, RouteRecord as R, StyleCollector as S, ViteReactSSGContext as V, ViteReactSSGClientOptions as a, ViteReactSSGOptions as b, RouterOptions as c };

package/dist/shared/{vite-react-ssg.91f86102.d.ts → vite-react-ssg.d734eb79.d.ts}

@@ -1,5 +1,5 @@
 import { Options } from 'critters';
-import { ReactElement } from 'react';
+import { ReactNode, ReactElement } from 'react';
 import { NonIndexRouteObject, IndexRouteObject, createBrowserRouter } from 'react-router-dom';
 
 type Router = ReturnType<typeof createBrowserRouter>;
@@ -107,7 +107,7 @@ interface ViteReactSSGOptions {
 interface ViteReactSSGContext<HasRouter extends boolean = true> {
     router?: HasRouter extends true ? Router : undefined;
     routes: HasRouter extends true ? Readonly<RouteRecord[]> : undefined;
-    routerOptions: RouterOptions;
+    routerOptions: HasRouter extends true ? RouterOptions : undefined;
     initialState: Record<string, any>;
     isClient: boolean;
     onSSRAppRendered(cb: Function): void;
@@ -119,6 +119,7 @@ interface ViteReactSSGContext<HasRouter extends boolean = true> {
     routePath?: string;
     base: string;
     getStyleCollector: (() => StyleCollector | Promise<StyleCollector>) | null;
+    app?: HasRouter extends true ? never : ReactNode;
 }
 interface ViteReactSSGClientOptions {
     transformState?: (state: any) => any;
@@ -130,11 +131,7 @@ interface ViteReactSSGClientOptions {
      */
     rootContainer?: string | Element;
     /**
-     * Use SSR during development.
-     *
-     * If false, the 'dev' script in 'package.json' needs to be set to `"vite"`.
-     *
-     * @default true
+     * @deprecated This option is no longer needed
      */
     ssrWhenDev?: boolean;
     getStyleCollector?: (() => StyleCollector | Promise<StyleCollector>) | null;
@@ -164,6 +161,7 @@ type RouteRecord = NonIndexRouteRecord | IndexRouteRecord;
 interface RouterOptions {
     routes: RouteRecord[];
     createFetchRequest?: <T>(req: T) => Request;
+    basename?: string;
 }
 interface StyleCollector {
     collect: (app: ReactElement) => ReactElement;
@@ -176,4 +174,4 @@ declare module 'vite' {
     }
 }
 
-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 };
+export type { IndexRouteRecord as I, NonIndexRouteRecord as N, RouteRecord as R, StyleCollector as S, ViteReactSSGContext as V, ViteReactSSGClientOptions as a, ViteReactSSGOptions as b, RouterOptions as c };

package/dist/shared/{vite-react-ssg.9d005d5e.mjs → vite-react-ssg.e6991406.cjs}

@@ -1,5 +1,4 @@
-import React from 'react';
-import { Helmet } from 'react-helmet-async';
+'use strict';
 
 const UNSAFE_CHARS_REGEXP = /[<>\/\u2028\u2029]/g;
 const ESCAPED_CHARS = {
@@ -34,12 +33,5 @@ function deserializeState(state) {
   }
 }
 
-function Head(props) {
-  return /* @__PURE__ */ React.createElement(Helmet, { ...props });
-}
-
-function SiteMetadataDefaults() {
-  return /* @__PURE__ */ React.createElement(Head, null, /* @__PURE__ */ React.createElement("html", null), /* @__PURE__ */ React.createElement("meta", { name: "viewport", content: "width=device-width, initial-scale=1.0" }));
-}
-
-export { Head as H, SiteMetadataDefaults as S, deserializeState as d, serializeState as s };
+exports.deserializeState = deserializeState;
+exports.serializeState = serializeState;

package/dist/shared/vite-react-ssg.faf3855a.d.cts

@@ -0,0 +1,15 @@
+import { ReactNode } from 'react';
+import { HelmetProps } from 'react-helmet-async';
+
+type Props = HelmetProps & {
+    children: ReactNode;
+};
+declare function Head(props: Props): JSX.Element;
+
+interface ClientOnlyProps {
+    children?: () => JSX.Element;
+    fallback?: JSX.Element;
+}
+declare function ClientOnly({ children, fallback, }: ClientOnlyProps): JSX.Element | null;
+
+export { ClientOnly as C, Head as H };

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

@@ -0,0 +1,15 @@
+import { ReactNode } from 'react';
+import { HelmetProps } from 'react-helmet-async';
+
+type Props = HelmetProps & {
+    children: ReactNode;
+};
+declare function Head(props: Props): JSX.Element;
+
+interface ClientOnlyProps {
+    children?: () => JSX.Element;
+    fallback?: JSX.Element;
+}
+declare function ClientOnly({ children, fallback, }: ClientOnlyProps): JSX.Element | null;
+
+export { ClientOnly as C, Head as H };

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

@@ -0,0 +1,15 @@
+import { ReactNode } from 'react';
+import { HelmetProps } from 'react-helmet-async';
+
+type Props = HelmetProps & {
+    children: ReactNode;
+};
+declare function Head(props: Props): JSX.Element;
+
+interface ClientOnlyProps {
+    children?: () => JSX.Element;
+    fallback?: JSX.Element;
+}
+declare function ClientOnly({ children, fallback, }: ClientOnlyProps): JSX.Element | null;
+
+export { ClientOnly as C, Head as H };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vite-react-ssg",
   "type": "module",
-  "version": "0.5.1",
+  "version": "0.6.0",
   "packageManager": "pnpm@8.6.6",
   "description": "",
   "author": "Riri <Daydreamerriri@outlook.com>",
@@ -31,6 +31,11 @@
       "import": "./dist/node.mjs",
       "require": "./dist/node.cjs"
     },
+    "./single-page": {
+      "types": "./dist/client/single-page.d.ts",
+      "import": "./dist/client/single-page.mjs",
+      "require": "./dist/client/single-page.cjs"
+    },
     "./style-collectors/styled-components": {
       "types": "./dist/style-collectors/styled-components.d.ts",
       "import": "./dist/style-collectors/styled-components.mjs",
@@ -45,6 +50,9 @@
       "node": [
         "./dist/node.d.ts"
       ],
+      "single-page": [
+        "dist/client/single-page.d.ts"
+      ],
       "style-collectors/styled-components": [
         "./dist/style-collectors/styled-components.d.ts"
       ]
@@ -69,6 +77,7 @@
     "typecheck": "tsc --noEmit"
   },
   "peerDependencies": {
+    "@childrentime/devcert": "*",
     "critters": "^0.0.19",
     "react": "^18.0.0",
     "react-dom": "^18.0.0",
@@ -77,6 +86,9 @@
     "vite": "^2.0.0 || ^3.0.0 || ^4.0.0 || ^5.0.0"
   },
   "peerDependenciesMeta": {
+    "@childrentime/devcert": {
+      "optional": true
+    },
     "critters": {
       "optional": true
     },

package/dist/shared/vite-react-ssg.4ca822c0.cjs

@@ -1,54 +0,0 @@
-'use strict';
-
-const React = require('react');
-const reactHelmetAsync = require('react-helmet-async');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
-
-const React__default = /*#__PURE__*/_interopDefaultCompat(React);
-
-const UNSAFE_CHARS_REGEXP = /[<>\/\u2028\u2029]/g;
-const ESCAPED_CHARS = {
-  "<": "\\u003C",
-  ">": "\\u003E",
-  "/": "\\u002F",
-  "\u2028": "\\u2028",
-  "\u2029": "\\u2029"
-};
-function escapeUnsafeChars(unsafeChar) {
-  return ESCAPED_CHARS[unsafeChar];
-}
-function serializeState(state) {
-  if (state == null || Object.keys(state).length === 0)
-    return null;
-  try {
-    return JSON.stringify(JSON.stringify(state || {})).replace(
-      UNSAFE_CHARS_REGEXP,
-      escapeUnsafeChars
-    );
-  } catch (error) {
-    console.error("[SSG] On state serialization -", error, state);
-    return null;
-  }
-}
-function deserializeState(state) {
-  try {
-    return JSON.parse(state || "{}");
-  } catch (error) {
-    console.error("[SSG] On state deserialization -", error, state);
-    return {};
-  }
-}
-
-function Head(props) {
-  return /* @__PURE__ */ React__default.createElement(reactHelmetAsync.Helmet, { ...props });
-}
-
-function SiteMetadataDefaults() {
-  return /* @__PURE__ */ React__default.createElement(Head, null, /* @__PURE__ */ React__default.createElement("html", null), /* @__PURE__ */ React__default.createElement("meta", { name: "viewport", content: "width=device-width, initial-scale=1.0" }));
-}
-
-exports.Head = Head;
-exports.SiteMetadataDefaults = SiteMetadataDefaults;
-exports.deserializeState = deserializeState;
-exports.serializeState = serializeState;