@solidjs/start 1.2.0 → 1.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -1,12 +1,92 @@
|
|
|
1
|
-
|
|
1
|
+
<div align="center">
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://github.com/solidjs)
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
[](https://npmjs.com/package/@solidjs/start)
|
|
6
|
+
[](https://npmjs.com/package/@solidjs/start)
|
|
7
|
+
[](https://github.com/solidjs/solid-start)
|
|
8
|
+
[](https://discord.com/invite/solidjs)
|
|
9
|
+
[](https://reddit.com/r/solidjs)
|
|
10
|
+
|
|
11
|
+
</div>
|
|
12
|
+
|
|
13
|
+
**SolidStart** brings fine-grained reactivity fullstack with full flexibility. Built with features like unified rendering and isomorphic code execution, SolidStart enables you to create highly performant and scalable web applications.
|
|
14
|
+
|
|
15
|
+
Explore the official [documentation](https://docs.solidjs.com/solid-start) for detailed guides and examples.
|
|
16
|
+
|
|
17
|
+
## Core Features
|
|
18
|
+
|
|
19
|
+
- **All Rendering Modes**:
|
|
20
|
+
- Server-Side Rendering _(SSR)_ with sync, async, and stream [modes](https://docs.solidjs.com/solid-start/reference/server/create-handler)
|
|
21
|
+
- Client-Side Rendering _(CSR)_ with the possibility of being page/component [scoped](https://docs.solidjs.com/solid-start/reference/client/client-only)
|
|
22
|
+
- Static Site Generation _(SSG)_ with route [pre-rendering](https://docs.solidjs.com/solid-start/building-your-application/route-prerendering)
|
|
23
|
+
- **TypeScript**: Full integration for robust, type-safe development
|
|
24
|
+
- **File-Based Routing**: Intuitive routing based on your project’s file structure
|
|
25
|
+
- **API Routes**: Dedicated server-side endpoints for seamless API development
|
|
26
|
+
- **Streaming**: Efficient data rendering for faster page loads
|
|
27
|
+
- **Build Optimizations**: Code splitting, tree shaking, and dead code elimination
|
|
28
|
+
- **Deployment Adapters**: Easily deploy to platforms like Vercel, Netlify, Cloudflare, and more
|
|
29
|
+
|
|
30
|
+
## Getting Started
|
|
31
|
+
|
|
32
|
+
### Installation
|
|
33
|
+
|
|
34
|
+
Create a SolidStart template project with your preferred package manager
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
# using npm
|
|
38
|
+
npm create solid@latest -- -s
|
|
39
|
+
```
|
|
6
40
|
|
|
7
41
|
```bash
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
```
|
|
42
|
+
# using pnpm
|
|
43
|
+
pnpm create solid@latest -s
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
# using bun
|
|
48
|
+
bun create solid@latest --s
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Project Structure
|
|
52
|
+
|
|
53
|
+
- `public/`: Static assets like icons, images, and fonts
|
|
54
|
+
- `src/`: Core application (aliased to `~/`)
|
|
55
|
+
- `routes/`: File-based routing for pages and APIs
|
|
56
|
+
- `app.tsx`: Root component of your application
|
|
57
|
+
- `entry-client.tsx`: Handles client-side hydration
|
|
58
|
+
- `entry-server.tsx`: Manages server-side request handling
|
|
59
|
+
- **Configuration Files**: `app.config.ts`, `package.json`, and more
|
|
60
|
+
|
|
61
|
+
Learn more about [routing](https://docs.solidjs.com/solid-start/building-your-application/routing)
|
|
62
|
+
|
|
63
|
+
## Adapters
|
|
64
|
+
|
|
65
|
+
Configure adapters in `app.config.ts` to deploy to platforms like Vercel, Netlify, Cloudflare, and others
|
|
66
|
+
|
|
67
|
+
```ts
|
|
68
|
+
import { defineConfig } from "@solidjs/start/config";
|
|
69
|
+
|
|
70
|
+
export default defineConfig({
|
|
71
|
+
ssr: true, // false for client-side rendering only
|
|
72
|
+
server: { preset: "netlify" },
|
|
73
|
+
});
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
Presets also include runtimes like Node.js, Bun or Deno. For example, a preset like `node-server` enables hosting on your server.
|
|
77
|
+
Learn more about [`defineConfig`](https://docs.solidjs.com/solid-start/reference/config/define-config)
|
|
78
|
+
|
|
79
|
+
## Building
|
|
80
|
+
|
|
81
|
+
Generate production-ready bundles
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
npm run build # or pnpm build or bun build
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
After the build completes, you’ll be guided through deployment for your specific preset.
|
|
88
|
+
|
|
89
|
+
## Contributing
|
|
90
|
+
|
|
91
|
+
- For contributing to the codebase, check [CONTRIBUTING.md](https://github.com/solidjs/solid-start/blob/main/CONTRIBUTING.md)
|
|
92
|
+
- For creating a new template, please head on to [solidjs/templates](https://github.com/solidjs/templates)
|
|
@@ -12,7 +12,7 @@ export declare function createMiddleware({ onRequest, onBeforeResponse }: {
|
|
|
12
12
|
onRequest?: RequestMiddleware | RequestMiddleware[] | undefined;
|
|
13
13
|
onBeforeResponse?: ResponseMiddleware | ResponseMiddleware[] | undefined;
|
|
14
14
|
}): {
|
|
15
|
-
onRequest?: import("
|
|
16
|
-
onBeforeResponse?: import("
|
|
15
|
+
onRequest?: import("vinxi/http")._RequestMiddleware | import("vinxi/http")._RequestMiddleware[] | undefined;
|
|
16
|
+
onBeforeResponse?: import("vinxi/http")._ResponseMiddleware | import("vinxi/http")._ResponseMiddleware[] | undefined;
|
|
17
17
|
};
|
|
18
18
|
export {};
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
declare const _default: import("
|
|
1
|
+
declare const _default: import("vinxi/http").EventHandler<import("vinxi/http").EventHandlerRequest, Promise<unknown>>;
|
|
2
2
|
export default _default;
|
package/dist/server/handler.d.ts
CHANGED
|
@@ -4,9 +4,9 @@ import type { FetchEvent, HandlerOptions, PageEvent, ResponseStub } from "./type
|
|
|
4
4
|
* If not, falls back to the 302 (temporary redirect)
|
|
5
5
|
*/
|
|
6
6
|
export declare function getExpectedRedirectStatus(response: ResponseStub): number;
|
|
7
|
-
export declare function createBaseHandler(fn: (context: PageEvent) => unknown, createPageEvent: (event: FetchEvent) => Promise<PageEvent>, options?: HandlerOptions | ((context: PageEvent) => HandlerOptions | Promise<HandlerOptions>), routerLoad?: (event: FetchEvent) => Promise<void>): import("
|
|
7
|
+
export declare function createBaseHandler(fn: (context: PageEvent) => unknown, createPageEvent: (event: FetchEvent) => Promise<PageEvent>, options?: HandlerOptions | ((context: PageEvent) => HandlerOptions | Promise<HandlerOptions>), routerLoad?: (event: FetchEvent) => Promise<void>): import("vinxi/http").EventHandler<import("vinxi/http").EventHandlerRequest, Promise<any>>;
|
|
8
8
|
/**
|
|
9
9
|
*
|
|
10
10
|
* Read more: https://docs.solidjs.com/solid-start/reference/server/create-handler
|
|
11
11
|
*/
|
|
12
|
-
export declare function createHandler(fn: (context: PageEvent) => unknown, options?: HandlerOptions | ((context: PageEvent) => HandlerOptions | Promise<HandlerOptions>), routerLoad?: (event: FetchEvent) => Promise<void>): import("
|
|
12
|
+
export declare function createHandler(fn: (context: PageEvent) => unknown, options?: HandlerOptions | ((context: PageEvent) => HandlerOptions | Promise<HandlerOptions>), routerLoad?: (event: FetchEvent) => Promise<void>): import("vinxi/http").EventHandler<import("vinxi/http").EventHandlerRequest, Promise<any>>;
|
|
@@ -3,5 +3,5 @@ import { FetchEvent, HandlerOptions, PageEvent } from "../types";
|
|
|
3
3
|
*
|
|
4
4
|
* Read more: https://docs.solidjs.com/solid-start/reference/server/create-handler
|
|
5
5
|
*/
|
|
6
|
-
export declare function createHandler(fn: (context: PageEvent) => unknown, options?: HandlerOptions | ((context: PageEvent) => HandlerOptions), routerLoad?: (event: FetchEvent) => Promise<void>): import("
|
|
6
|
+
export declare function createHandler(fn: (context: PageEvent) => unknown, options?: HandlerOptions | ((context: PageEvent) => HandlerOptions), routerLoad?: (event: FetchEvent) => Promise<void>): import("vinxi/http").EventHandler<import("vinxi/http").EventHandlerRequest, Promise<any>>;
|
|
7
7
|
export declare function createPageEvent(ctx: FetchEvent): Promise<PageEvent>;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@solidjs/start",
|
|
3
|
-
"version": "1.2.
|
|
3
|
+
"version": "1.2.1",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"author": "Ryan Carniato",
|
|
6
6
|
"license": "MIT",
|
|
@@ -68,8 +68,8 @@
|
|
|
68
68
|
"error-stack-parser": "^2.1.4",
|
|
69
69
|
"html-to-image": "^1.11.11",
|
|
70
70
|
"radix3": "^1.1.0",
|
|
71
|
-
"seroval": "^1.
|
|
72
|
-
"seroval-plugins": "^1.0
|
|
71
|
+
"seroval": "^1.4.1",
|
|
72
|
+
"seroval-plugins": "^1.4.0",
|
|
73
73
|
"shiki": "^1.26.1",
|
|
74
74
|
"source-map-js": "^1.0.2",
|
|
75
75
|
"terracotta": "^1.0.4",
|