Merge branch 'master' into sejohnson-make-public-typings

sveltejs · Apr 14, 2022 · b34fa52 · b34fa52
2 parents 888ae6d + e70f80b
commit b34fa52
Show file tree

Hide file tree

Showing 20 changed files with 77 additions and 3 deletions.
diff --git a/.changeset/pre.json b/.changeset/pre.json
@@ -306,6 +306,7 @@
     "honest-islands-flash",
     "honest-jars-report",
     "honest-singers-guess",
+    "honest-wasps-cough",
     "hot-bags-jump",
     "hot-clouds-work",
     "hot-dogs-fry",

diff --git a/documentation/docs/01-web-standards.md b/documentation/docs/01-web-standards.md
@@ -0,0 +1,67 @@
+---
+title: Web standards
+---
+
+Throughout this documentation, you'll see references to the standard [Web APIs](https://developer.mozilla.org/en-US/docs/Web/API) that SvelteKit builds on top of. Rather than reinventing the wheel, we _use the platform_, which means your existing web development skills are applicable to SvelteKit. Conversely, time spent learning SvelteKit will help you be a better web developer elsewhere.
+
+These APIs are available in all modern browsers and in many non-browser environments like Cloudflare Workers, Deno and Vercel Edge Functions. During development, and in [adapters](/docs/adapters) for Node-based environments (including AWS Lambda), they're made available via polyfills where necessary (for now, that is — Node is rapidly adding support for more web standards).
+
+In particular, you'll get comfortable with the following:
+
+### Fetch APIs
+
+SvelteKit uses [`fetch`](https://developer.mozilla.org/en-US/docs/Web/API/fetch) for getting data from the network. It's available in [hooks](/docs/hooks) and [endpoints](/docs/routing#endpoints) as well as in the browser.
+
+> A special version of `fetch` is available in [`load`](/docs/loading) functions for accessing data directly from endpoints while preserving credentials.
+
+Besides `fetch` itself, the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) includes the following interfaces:
+
+#### Request
+
+An instance of [`Request`](https://developer.mozilla.org/en-US/docs/Web/API/Request) is accessible in [hooks](/docs/hooks) and [endpoints](/docs/routing#endpoints) as `event.request`. It contains useful methods like `request.json()` and `request.formData()` for e.g. getting data that was posted to an endpoint.
+
+#### Response
+
+An instance of [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response) is returned from `await fetch(...)`. Fundamentally, a SvelteKit app is a machine for turning a `Request` into a `Response`.
+
+#### Headers
+
+The [`Headers`](https://developer.mozilla.org/en-US/docs/Web/API/Headers) interface allows you to read incoming `request.headers` and set outgoing `response.headers`:
+
+```js
+// @errors: 2461
+/// file: src/routes/what-is-my-user-agent.js
+/** @type {import('@sveltejs/kit').RequestHandler} */
+export function get(event) {
+	// log all headers
+	console.log(...event.request.headers);
+
+	return {
+		body: {
+			// retrieve a specific header
+			userAgent: event.request.headers.get('user-agent')
+		}
+	};
+}
+```
+
+### URL APIs
+
+URLs are represented by the [`URL`](https://developer.mozilla.org/en-US/docs/Web/API/URL) interface, which includes useful properties like `origin` and `pathname` (and, in the browser, `hash`). This interface shows up in various places — `event.url` in [hooks](/docs/hooks) and [endpoints](/docs/routing#endpoints), [`$page.url`](http://localhost:3000/docs/modules#$app-stores) in [pages](http://localhost:3000/docs/routing#pages), `from` and `to` in [`beforeNavigate` and `afterNavigate`](http://localhost:3000/docs/modules#$app-navigation) and so on.
+
+#### URLSearchParams
+
+Wherever you encounter a URL, you can access query parameters via `url.searchParams`, which is an instance of [`URLSearchParams`](https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams):
+
+```js
+// @filename: ambient.d.ts
+declare global {
+	const url: URL;
+}
+
+export {};
+
+// @filename: index.js
+// ---cut---
+const foo = url.searchParams.get('foo');
+```
diff --git a/documentation/docs/01-routing.md → documentation/docs/02-routing.md b/documentation/docs/01-routing.md → documentation/docs/02-routing.md
@@ -81,7 +81,7 @@ export async function get({ params }) {
 }
 ```
 
-> All server-side code, including endpoints, has access to `fetch` in case you need to request data from external APIs. Don't worry about the `$lib` import, we'll get to that [later](/docs/modules#$lib).
+> Don't worry about the `$lib` import, we'll get to that [later](/docs/modules#$lib).
 
 The type of the `get` function above comes from `./[id].d.ts`, which is a file generated by SvelteKit (inside your [`outDir`](/docs/configuration#outdir), using the [`rootDirs`](https://www.typescriptlang.org/tsconfig#rootDirs) option) that provides type safety when accessing `params`. See the section on [generated types](/docs/types#generated-types) for more detail.
 

diff --git a/documentation/docs/02-layouts.md → documentation/docs/03-layouts.md b/documentation/docs/02-layouts.md → documentation/docs/03-layouts.md
diff --git a/documentation/docs/03-loading.md → documentation/docs/04-loading.md b/documentation/docs/03-loading.md → documentation/docs/04-loading.md
diff --git a/documentation/docs/04-hooks.md → documentation/docs/05-hooks.md b/documentation/docs/04-hooks.md → documentation/docs/05-hooks.md
@@ -8,7 +8,7 @@ An optional `src/hooks.js` (or `src/hooks.ts`, or `src/hooks/index.js`) file exp
 
 ### handle
 
-This function runs every time the SvelteKit server receives a request — whether that happens while the app is running, or during [prerendering](/docs/page-options#prerender) — and determines the response. It receives an `event` object representing the request and a function called `resolve`, which invokes SvelteKit's router and generates a response (rendering a page, or invoking an endpoint) accordingly. This allows you to modify response headers or bodies, or bypass SvelteKit entirely (for implementing endpoints programmatically, for example).
+This function runs every time the SvelteKit server receives a [request](/docs/web-standards#fetch-apis-request) — whether that happens while the app is running, or during [prerendering](/docs/page-options#prerender) — and determines the [response](/docs/web-standards#fetch-apis-response). It receives an `event` object representing the request and a function called `resolve`, which invokes SvelteKit's router and generates a response (rendering a page, or invoking an endpoint) accordingly. This allows you to modify response headers or bodies, or bypass SvelteKit entirely (for implementing endpoints programmatically, for example).
 
 ```js
 /// file: src/hooks.js

diff --git a/documentation/docs/05-modules.md → documentation/docs/06-modules.md b/documentation/docs/05-modules.md → documentation/docs/06-modules.md
diff --git a/documentation/docs/06-service-workers.md → documentation/docs/07-service-workers.md b/documentation/docs/06-service-workers.md → documentation/docs/07-service-workers.md
diff --git a/documentation/docs/07-a-options.md → documentation/docs/08-a-options.md b/documentation/docs/07-a-options.md → documentation/docs/08-a-options.md
diff --git a/documentation/docs/08-events.md → documentation/docs/09-events.md b/documentation/docs/08-events.md → documentation/docs/09-events.md
diff --git a/documentation/docs/09-adapters.md → documentation/docs/10-adapters.md b/documentation/docs/09-adapters.md → documentation/docs/10-adapters.md
diff --git a/documentation/docs/10-page-options.md → documentation/docs/11-page-options.md b/documentation/docs/10-page-options.md → documentation/docs/11-page-options.md
diff --git a/documentation/docs/11-packaging.md → documentation/docs/12-packaging.md b/documentation/docs/11-packaging.md → documentation/docs/12-packaging.md
diff --git a/documentation/docs/12-cli.md → documentation/docs/13-cli.md b/documentation/docs/12-cli.md → documentation/docs/13-cli.md
diff --git a/documentation/docs/13-configuration.md → documentation/docs/14-configuration.md b/documentation/docs/13-configuration.md → documentation/docs/14-configuration.md
diff --git a/documentation/docs/14-types.md → documentation/docs/15-types.md b/documentation/docs/14-types.md → documentation/docs/15-types.md
diff --git a/documentation/docs/15-seo.md → documentation/docs/16-seo.md b/documentation/docs/15-seo.md → documentation/docs/16-seo.md
diff --git a/documentation/docs/16-assets.md → documentation/docs/17-assets.md b/documentation/docs/16-assets.md → documentation/docs/17-assets.md
diff --git a/packages/kit/CHANGELOG.md b/packages/kit/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @sveltejs/kit
 
+## 1.0.0-next.313
+
+### Patch Changes
+
+- add `platform` to requests triggered by `fetch` in `load` during SSR ([#4599](https://github.com/sveltejs/kit/pull/4599))
+
 ## 1.0.0-next.312
 
 ### Patch Changes

diff --git a/packages/kit/package.json b/packages/kit/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "@sveltejs/kit",
-	"version": "1.0.0-next.312",
+	"version": "1.0.0-next.313",
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/sveltejs/kit",
-Original file line number
+Diff line change
@@ Expand Up / @@ -81,7 +81,7 @@ export async function get({ params }) { @@
     }
     ```
-    > All server-side code, including endpoints, has access to `fetch` in case you need to request data from external APIs. Don't worry about the `$lib` import, we'll get to that [later](/docs/modules#$lib).
+    > Don't worry about the `$lib` import, we'll get to that [later](/docs/modules#$lib).
     The type of the `get` function above comes from `./[id].d.ts`, which is a file generated by SvelteKit (inside your [`outDir`](/docs/configuration#outdir), using the [`rootDirs`](https://www.typescriptlang.org/tsconfig#rootDirs) option) that provides type safety when accessing `params`. See the section on [generated types](/docs/types#generated-types) for more detail.
@@ Expand Down @@