Merge pull request #12 from AurelienLourot/quality/interface-merging

qual: Use config interface merging
vikejs · Sep 20, 2023 · 12730c5 · 12730c5
2 parents 53a0f53 + a507ffe
commit 12730c5
Show file tree

Hide file tree

Showing 9 changed files with 66 additions and 63 deletions.
diff --git a/examples/basic/package.json b/examples/basic/package.json
@@ -10,8 +10,8 @@
     "cross-fetch": "^3.1.8",
     "node-fetch": "^3.3.2",
     "solid-js": "^1.7.11",
-    "vite-plugin-ssr": "^0.4.136",
-    "vike-solid": "workspace:*"
+    "vike-solid": "workspace:*",
+    "vite-plugin-ssr": "^0.4.141"
   },
   "devDependencies": {
     "typescript": "^5.1.6"

diff --git a/examples/basic/pages/+config.h.ts b/examples/basic/pages/+config.h.ts
@@ -1,4 +1,4 @@
-import type { Config } from "vike-solid";
+import type { Config } from "vite-plugin-ssr/types";
 import vikeSolid from "vike-solid";
 import Layout from "../layouts/LayoutDefault";
 import Head from "./Head";

diff --git a/examples/ssr-spa/package.json b/examples/ssr-spa/package.json
@@ -8,7 +8,8 @@
   },
   "dependencies": {
     "solid-js": "^1.7.11",
-    "vike-solid": "workspace:*"
+    "vike-solid": "workspace:*",
+    "vite-plugin-ssr": "^0.4.141"
   },
   "devDependencies": {
     "typescript": "^5.1.6"

diff --git a/examples/ssr-spa/pages/+config.h.ts b/examples/ssr-spa/pages/+config.h.ts
@@ -1,4 +1,4 @@
-import type { Config } from "vike-solid";
+import type { Config } from "vite-plugin-ssr/types";
 import vikeSolid from "vike-solid";
 import Layout from "../layouts/LayoutDefault";
 import Head from "./Head";

diff --git a/examples/ssr-spa/pages/spa/+config.h.ts b/examples/ssr-spa/pages/spa/+config.h.ts
@@ -1,4 +1,4 @@
-import type { Config } from "vike-solid";
+import type { Config } from "vite-plugin-ssr/types";
 
 export default {
   ssr: false, // SPA

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/vike-solid/package.json b/vike-solid/package.json
@@ -20,7 +20,7 @@
   },
   "peerDependencies": {
     "solid-js": "^1.7.11",
-    "vite-plugin-ssr": "^0.4.136"
+    "vite-plugin-ssr": "^0.4.141"
   },
   "devDependencies": {
     "@babel/core": "^7.22.10",
@@ -36,7 +36,7 @@
     "solid-js": "^1.7.11",
     "tslib": "^2.6.1",
     "typescript": "^5.1.6",
-    "vite-plugin-ssr": "^0.4.136"
+    "vite-plugin-ssr": "^0.4.141"
   },
   "typesVersions": {
     "*": {

diff --git a/vike-solid/renderer/+config.ts b/vike-solid/renderer/+config.ts
@@ -1,40 +1,12 @@
-import type { Config as ConfigCore } from "vite-plugin-ssr/types";
-import type { Component } from "./types.js";
-
-import type { Effect } from "vite-plugin-ssr/types";
-
-export type Config = ConfigCore & {
-  /** Solid element renderer and appended into <head></head> */
-  Head?: Component;
-  Layout?: Component;
-  title?: string;
-  description?: string;
-  /**
-   * @default 'en'
-   */
-  lang?: string;
-  /**
-   * If true, render mode is SSR or pre-rendering (aka SSG). In other words, the
-   * page's HTML will be rendered at build-time or request-time.
-   * If false, render mode is SPA. In other words, the page will only be
-   * rendered in the browser.
-   *
-   * See https://vite-plugin-ssr.com/render-modes
-   *
-   * @default true
-   *
-   */
-  ssr?: boolean;
-  Page?: Component;
-};
-
-// alias
-export type UserConfig = Config;
+import type { Config, ConfigEffect } from "vite-plugin-ssr/types";
 
 // Depending on the value of `config.meta.ssr`, set other config options' `env`
 // accordingly.
 // See https://vite-plugin-ssr.com/meta#modify-existing-configurations
-const toggleSsrRelatedConfig: Effect = ({ configDefinedAt, configValue }) => {
+const toggleSsrRelatedConfig: ConfigEffect = ({
+  configDefinedAt,
+  configValue,
+}) => {
   if (typeof configValue !== "boolean") {
     throw new Error(`${configDefinedAt} should be a boolean`);
   }
@@ -80,4 +52,35 @@ export default {
       effect: toggleSsrRelatedConfig,
     },
   },
-} satisfies ConfigCore;
+} satisfies Config;
+
+// We purposely define the ConfigVikeSolid interface in this file: that way we ensure it's always applied whenever the user `import vikeSolid from 'vike-solid'`
+import type { Component } from "./types.js";
+declare global {
+  namespace VikePackages {
+    export interface ConfigVikeSolid {
+      /** Solid element renderer and appended into <head></head> */
+      Head?: Component;
+      Layout?: Component;
+      title?: string;
+      description?: string;
+      /**
+       * @default 'en'
+       */
+      lang?: string;
+      /**
+       * If true, render mode is SSR or pre-rendering (aka SSG). In other words, the
+       * page's HTML will be rendered at build-time or request-time.
+       * If false, render mode is SPA. In other words, the page will only be
+       * rendered in the browser.
+       *
+       * See https://vite-plugin-ssr.com/render-modes
+       *
+       * @default true
+       *
+       */
+      ssr?: boolean;
+      Page?: Component;
+    }
+  }
+}
diff --git a/vike-solid/renderer/types.ts b/vike-solid/renderer/types.ts
@@ -5,10 +5,9 @@ export type { PageProps };
 export type { Page };
 
 import type {
-  PageContextBuiltIn,
+  PageContextBuiltInServer,
   PageContextBuiltInClientWithClientRouting as PageContextBuiltInClient,
 } from "vite-plugin-ssr/types";
-import type { Config } from "./+config";
 import type { JSX } from "solid-js";
 
 export type { Component } from "solid-js";
@@ -26,9 +25,6 @@ export type PageContextCommon = {
   };
 };
 
-type PageContextServer = PageContextBuiltIn<Page> &
-  PageContextCommon & {
-    config: Partial<Config>;
-  };
+type PageContextServer = PageContextBuiltInServer<Page> & PageContextCommon;
 type PageContextClient = PageContextBuiltInClient<Page> & PageContextCommon;
 type PageContext = PageContextClient | PageContextServer;