vike-solid 0.1.3 → 0.2.0

package/README.md

@@ -1,18 +1,12 @@
-[<img src="https://avatars.githubusercontent.com/u/86403530?s=200&v=4" align="right" width="64" height="64">](https://vite-plugin-ssr.com)
+[<img src="https://avatars.githubusercontent.com/u/86403530?s=200&v=4" align="right" width="64" height="64">](https://vike.dev)
 [![npm version](https://img.shields.io/npm/v/vike-solid)](https://www.npmjs.com/package/vike-solid)
 
 # `vike-solid`
 
-Vike-solid is a demo showcasing a SolidJS framework built using [vite-plugin-ssr](https://vite-plugin-ssr.com/).
+SolidJS integration for [Vike](https://github.com/vikejs/vike/issues/736) (using the
+[V1 design](https://vike.dev/migration/v1-design)).
 
-It uses VPS's [V1 design](https://github.com/brillout/vite-plugin-ssr/issues/578) which is in beta.
+> [!NOTE]  
+> For integrations with React and Vue, see the other [`vike-*` packages](https://vike.dev/vike-packages).
 
-> **NOTE:** For VPS/Vike integrations with other UI frameworks (e.g. React), see
-> [`vike-*` packages](https://vite-plugin-ssr.com/vike-packages).
-
-To run the example:
-
-- Clone the repo: `git clone git@github.com:magne4000/vike-solid`
-- Install dependencies: `pnpm install`
-- Build vike-solid: `pnpm run build`
-- Run the example: `cd examples/basic/ && pnpm run dev`
+See [examples/](https://github.com/magne4000/vike-solid/tree/main/examples).

package/dist/+config.js

@@ -1,6 +1,8 @@
+// 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'`
+
 // Depending on the value of `config.meta.ssr`, set other config options' `env`
 // accordingly.
-// See https://vite-plugin-ssr.com/meta#modify-existing-configurations
+// See https://vike.dev/meta#modify-existing-configurations
 const toggleSsrRelatedConfig = ({
   configDefinedAt,
   configValue
@@ -49,6 +51,4 @@ var _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'`
-
 export { _config as default };

package/dist/+onRenderClient.js

@@ -38,30 +38,15 @@ function getPageElement(pageContext) {
   const page = createComponent(PageContextProvider, {
     pageContext: pageContext,
     get children() {
-      return createComponent(Wrapper, {
+      return createComponent(Layout, {
         get children() {
-          return createComponent(Layout, {
-            get children() {
-              return createComponent(Page, {});
-            }
-          });
+          return createComponent(Page, {});
         }
       });
     }
   });
   return page;
 }
-function Wrapper(props) {
-  const pageContext = usePageContext();
-  return createComponent(Dynamic, {
-    get component() {
-      return pageContext.config.Wrapper ?? Passthrough;
-    },
-    get children() {
-      return props.children;
-    }
-  });
-}
 function Layout(props) {
   const pageContext = usePageContext();
   return createComponent(Dynamic, {

package/dist/+onRenderHtml.js

@@ -1,5 +1,5 @@
 import { createComponent, Dynamic, mergeProps, renderToString, renderToStream, generateHydrationScript } from 'solid-js/web';
-import { escapeInject, stampPipe, dangerouslySkipEscape } from 'vite-plugin-ssr/server';
+import { escapeInject, stampPipe, dangerouslySkipEscape } from 'vike/server';
 import { P as PageContextProvider, u as usePageContext } from './usePageContext-a90cda5a.js';
 import 'solid-js';
 
@@ -38,30 +38,15 @@ function getPageElement(pageContext) {
   const page = createComponent(PageContextProvider, {
     pageContext: pageContext,
     get children() {
-      return createComponent(Wrapper, {
+      return createComponent(Layout, {
         get children() {
-          return createComponent(Layout, {
-            get children() {
-              return createComponent(Page, {});
-            }
-          });
+          return createComponent(Page, {});
         }
       });
     }
   });
   return page;
 }
-function Wrapper(props) {
-  const pageContext = usePageContext();
-  return createComponent(Dynamic, {
-    get component() {
-      return pageContext.config.Wrapper ?? Passthrough;
-    },
-    get children() {
-      return props.children;
-    }
-  });
-}
 function Layout(props) {
   const pageContext = usePageContext();
   return createComponent(Dynamic, {

package/dist/{build-15504eb6.js → build-4b79b655.js}

@@ -1,9 +1,9 @@
 import { build } from 'vite';
-import { c as config } from './vite.config-0442c29d.js';
+import { c as config } from './vite.config-2b9e1d28.js';
 import 'vite-plugin-solid';
-import 'vite-plugin-ssr/plugin';
+import 'vike/plugin';
 
-// import { prerender } from 'vite-plugin-ssr/prerender'
+// import { prerender } from 'vike/prerender'
 
 main();
 async function main() {

package/dist/components/usePageContext.d.ts

@@ -1,24 +1,42 @@
-import { PageContextBuiltInServer, PageContextBuiltInClientWithClientRouting } from 'vite-plugin-ssr/types';
-import { JSX } from 'solid-js';
-
-type Page = (pageProps: PageProps) => JSX.Element;
-type PageProps = Record<string, unknown>;
-type WrapperComponent = ({ children }: {
-    children: any;
-}) => JSX.Element;
-type PageContextCommon = {
-    Page: Page;
-    pageProps?: PageProps;
-    config: {
-        Layout?: WrapperComponent;
-        Wrapper?: WrapperComponent;
-    };
-};
-type PageContextServer = PageContextBuiltInServer<Page> & PageContextCommon;
-type PageContextClient = PageContextBuiltInClientWithClientRouting<Page> & PageContextCommon;
-type PageContext = PageContextClient | PageContextServer;
+import * as vike_dist_esm_shared_types from 'vike/dist/esm/shared/types';
+import * as vike_dist_esm_shared_addUrlComputedProps from 'vike/dist/esm/shared/addUrlComputedProps';
+import * as vike_dist_esm_shared_getPageFiles_getExports from 'vike/dist/esm/shared/getPageFiles/getExports';
+import * as vike_dist_esm_shared_page_configs_Config_PageContextConfig from 'vike/dist/esm/shared/page-configs/Config/PageContextConfig';
 
 /** Access the pageContext from any SolidJS component */
-declare function usePageContext(): PageContext;
+declare function usePageContext(): (Partial<{
+    Page: unknown;
+    routeParams: Record<string, string>;
+    config: vike_dist_esm_shared_page_configs_Config_PageContextConfig.PageContextConfig;
+    configEntries: vike_dist_esm_shared_getPageFiles_getExports.ConfigEntries;
+    exports: Record<string, unknown>;
+    exportsAll: vike_dist_esm_shared_getPageFiles_getExports.ExportsAll;
+    urlOriginal: string;
+    is404: boolean | null;
+    isClientSideNavigation: boolean;
+    abortReason?: unknown;
+    abortStatusCode?: undefined;
+    errorWhileRendering?: unknown;
+    url: string;
+    pageExports: Record<string, unknown>;
+}> & Pick<{
+    Page: unknown;
+    routeParams: Record<string, string>;
+    config: vike_dist_esm_shared_page_configs_Config_PageContextConfig.PageContextConfig;
+    configEntries: vike_dist_esm_shared_getPageFiles_getExports.ConfigEntries;
+    exports: Record<string, unknown>;
+    exportsAll: vike_dist_esm_shared_getPageFiles_getExports.ExportsAll;
+    urlOriginal: string;
+    is404: boolean | null;
+    isClientSideNavigation: boolean;
+    abortReason?: unknown;
+    abortStatusCode?: undefined;
+    errorWhileRendering?: unknown;
+    url: string;
+    pageExports: Record<string, unknown>;
+}, "Page" | "pageExports" | "config" | "configEntries" | "exports" | "exportsAll" | "abortReason"> & {
+    isHydration: boolean;
+    isBackwardNavigation: boolean | null;
+} & vike_dist_esm_shared_addUrlComputedProps.PageContextUrlComputedPropsClient & Vike.PageContext) | vike_dist_esm_shared_types.PageContextServer;
 
 export { usePageContext };

package/dist/{dev-66f2fdf4.js → dev-dfbf584d.js}

@@ -1,7 +1,7 @@
 import { createServer } from 'vite';
-import { c as config } from './vite.config-0442c29d.js';
+import { c as config } from './vite.config-2b9e1d28.js';
 import 'vite-plugin-solid';
-import 'vite-plugin-ssr/plugin';
+import 'vike/plugin';
 
 main();
 async function main() {

package/dist/index.js

@@ -3,13 +3,13 @@ const cmd = parseCliArgs();
 cli();
 async function cli() {
   if (cmd === "dev") {
-    await import('./dev-66f2fdf4.js');
+    await import('./dev-dfbf584d.js');
   }
   if (cmd === "build") {
-    await import('./build-15504eb6.js');
+    await import('./build-4b79b655.js');
   }
   if (cmd === "preview") {
-    await import('./preview-43d6feda.js');
+    await import('./preview-535a0307.js');
   }
 }
 function parseCliArgs() {

package/dist/{preview-43d6feda.js → preview-535a0307.js}

@@ -1,7 +1,7 @@
 import { preview } from 'vite';
-import { c as config } from './vite.config-0442c29d.js';
+import { c as config } from './vite.config-2b9e1d28.js';
 import 'vite-plugin-solid';
-import 'vite-plugin-ssr/plugin';
+import 'vike/plugin';
 
 main();
 async function main() {

package/dist/renderer/+config.d.ts

@@ -1,5 +1,17 @@
-import { ConfigEffect } from 'vite-plugin-ssr/types';
-import { Component } from 'solid-js';
+import { PageContext, ConfigEffect } from 'vike/types';
+import { JSX, Component } from 'solid-js';
+
+type Page = (pageProps: PageProps) => JSX.Element;
+type PageProps = Record<string, unknown>;
+declare global {
+    namespace Vike {
+        interface PageContext {
+            Page: Page;
+            pageProps: Record<string, unknown>;
+            title?: string;
+        }
+    }
+}
 
 declare const _default: {
     onRenderHtml: "import:vike-solid/renderer/onRenderHtml";
@@ -36,7 +48,7 @@ declare global {
             /** Solid element renderer and appended into <head></head> */
             Head?: Component;
             Layout?: Component;
-            title?: string;
+            title?: string | ((pageContext: PageContext) => string);
             description?: string;
             /**
              * @default 'en'
@@ -48,12 +60,13 @@ declare global {
              * 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
+             * See https://vike.dev/render-modes
              *
              * @default true
              *
              */
             ssr?: boolean;
+            /** The page's root Solid component */
             Page?: Component;
         }
     }

package/dist/vite-plugin-vike-solid.d.ts

@@ -1,5 +1,5 @@
 import { Options as Options$1 } from 'vite-plugin-solid';
-import { UserConfig } from 'vite-plugin-ssr/plugin';
+import { UserConfig } from 'vike/plugin';
 import { Plugin } from 'vite';
 
 interface Options {
@@ -8,4 +8,4 @@ interface Options {
 }
 declare function export_default(options?: Options): Plugin[];
 
-export { Options, export_default as default };
+export { type Options, export_default as default };

package/dist/vite-plugin-vike-solid.js

@@ -1,5 +1,5 @@
 import solidPlugin from 'vite-plugin-solid';
-import ssr from 'vite-plugin-ssr/plugin';
+import ssr from 'vike/plugin';
 import { mergeConfig } from 'vite';
 
 function overrideConfig() {

package/dist/{vite.config-0442c29d.js → vite.config-2b9e1d28.js}

@@ -1,5 +1,5 @@
 import solidPlugin from 'vite-plugin-solid';
-import ssr from 'vite-plugin-ssr/plugin';
+import ssr from 'vike/plugin';
 import { mergeConfig } from 'vite';
 
 function overrideConfig() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vike-solid",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "type": "module",
   "exports": {
     ".": "./dist/+config.js",
@@ -10,28 +10,29 @@
     "./renderer/onRenderClient": "./dist/+onRenderClient.js"
   },
   "dependencies": {
-    "vite": "^4.4.9",
     "vite-plugin-solid": "^2.7.0"
   },
   "peerDependencies": {
-    "solid-js": "^1.7.11",
-    "vite-plugin-ssr": "^0.4.141"
+    "solid-js": "^1.7.12",
+    "vite": "^4.4.9",
+    "vike": "^0.4.142"
   },
   "devDependencies": {
-    "@babel/core": "^7.22.10",
-    "@babel/preset-env": "^7.22.10",
-    "@babel/preset-typescript": "^7.22.5",
+    "@babel/core": "^7.22.20",
+    "@babel/preset-env": "^7.22.20",
+    "@babel/preset-typescript": "^7.22.15",
     "@rollup/plugin-babel": "^6.0.3",
-    "@rollup/plugin-node-resolve": "^15.1.0",
+    "@rollup/plugin-node-resolve": "^15.2.1",
     "@types/node": "^18.17.4",
-    "babel-preset-solid": "^1.7.7",
-    "bumpp": "^9.1.1",
-    "rollup": "^3.28.0",
-    "rollup-plugin-dts": "^5.3.1",
-    "solid-js": "^1.7.11",
-    "tslib": "^2.6.1",
-    "typescript": "^5.1.6",
-    "vite-plugin-ssr": "^0.4.141"
+    "babel-preset-solid": "^1.7.12",
+    "bumpp": "^9.2.0",
+    "rollup": "^3.29.2",
+    "rollup-plugin-dts": "^6.0.2",
+    "solid-js": "^1.7.12",
+    "tslib": "^2.6.2",
+    "typescript": "^5.2.2",
+    "vite": "^4.4.9",
+    "vike": "^0.4.142"
   },
   "typesVersions": {
     "*": {
@@ -60,7 +61,7 @@
   "license": "MIT",
   "scripts": {
     "dev": "rollup -c rollup.config.js --watch",
-    "build": "rollup -c rollup.config.js",
+    "build": "tsc --noEmit && rollup -c rollup.config.js",
     "release": "pnpm run build && bumpp --commit --push --tag && pnpm publish"
   }
 }