Docs for the new API #5810

dummdidumm · 2022-08-04T12:18:27Z

Companion to #5782

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
This message body should clearly illustrate what problems it solves.
Ideally, include a test that fails without this PR but passes with it.

Tests

Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. All changesets should be patch until SvelteKit 1.0

- add overview of special files at the beginning (TODO: make this its own page?) - update special file names - shuffle endpoints and standalone endpoints to make it more clear what separates them (TODO: move each into its own page?)

changeset-bot · 2022-08-04T12:18:30Z

⚠️ No Changeset found

Latest commit: f613088

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Mlocik97 · 2022-08-04T17:21:56Z

documentation/docs/03-routing.md


-Pages typically generate HTML to display to the user (as well as any CSS and JavaScript needed for the page). By default, pages are rendered on both the client and server, though this behaviour is configurable.
+> The `+` prefix was chosen for several reasons:
+>


is this supposed to be here?

documentation/docs/03-routing.md

documentation/docs/04-layouts.md

documentation/docs/05-loading.md

Mlocik97 · 2022-08-04T18:24:58Z

Also, don't forget about FAQ section.

documentation/docs/80-migrating.md

documentation/docs/03-routing.md

Rich-Harris · 2022-08-08T18:27:45Z

Going to merge this into #5778, so that the docs are able to build (since typechecking will fail otherwise)

* skeleton * add moved info to files to be able to rewrite imports later * add magic-string, start load extraction and manipulation logic * move migration logic into new svelte-migrate package * remove commented code * lockfile * move components, extract load * +page.server.js and +server.js * remove unused code * uncomment prompt * add some errors * fix detection * consistent casing * not sure if typescript will ever fail to parse, but in any case its handled now * handle error with module context * add some comments * update demo app * update skeleton app * migrate kit.svelte.dev * fix dynamic import on windows, fix js/ts file ending, handle index.json.js endpoint case * extract imports into Svelte migration task for QOL, don't adjust imports in standalone index edge case * migrate amp app * show message either way, could be other things gone wrong * windooows * more sophisticated auto migrations - unpack props/body - redirect/error in load - standalone endpoint * migrate test/apps/basics * fix regex, dont show props message on error page, more sophisticated error/redirect checks, set-cookie suggestion * pretend to make this more readable * adjust import location for error and redirect * update tests * only show short automigration message on success, only migrate where we are confident it works, annotate non-migrated return statements, handle export { X } case * shorten redirect/error if no second argument given * use git mv if available * update options tests * update options-2 tests * update writes tests * migrate (most) prerendering/basics tests * migrate more tests * update adapter-static tests * it begins (#5782) * it begins * update some more test fixtures * update more tests * more * more * more * more * last one * need to add dot: true to catch routes inside .well-known * fixes, update tests * fix more tests * fix various things * all create_manifest_data unit tests passing * update write_manifest * fix * remove config.kit.routes * update RequestHandler type * simplify endpoint code * simplify some more stuff * move respond code into render_page, where it belongs * purge all references to stuff * simplify * vite build completes, albeit with a broken build * vite dev now starts * now rendering a blank page * rendering an error page * it renders html! * tidy up * get error page rendering correctly * add placeholder setHeaders function * replace CSRComponent with CSRPageNode * fix build * amp tests passing! now for the client * fix create_manifest_data unit tests * add error/redirect helpers * rename @sveltejs/kit/data -> @sveltejs/kit * add error/redirect to @sveltejs/kit types * fixes * fix a slew of typescript errors * data loading belongs in load_node * holy shit the tests are starting to pass * update some tests * start working on write_types * science experiment * typo * i think it basically works * expose ServerData as Data when no load is specified * replace magic number * handle missing GET separately from failure * oops i think i did a bad git * remove typings tests, these are no longer useful * tidy * use server data if no load is provided * temporarily disable non-SSR tests * apply headers * update test * allow load to return void * remove some tests that no longer make sense * remove some more unused tests * this is fun. delete delete delete * fix test * handle accept:json requests * fix test * small tidy up * tidy * simplify * simplify, improve efficiency * simplify * rename to disambiguate with client * tweaks * tidy up * load data in parallel * throw error pointing to migration if router folder exists but no routes are found * load nodes on client in parallel * handle redirect * fix parent usage bug, avoid waterfall when awaiting parents, remove try-catch which would make subsequent catch never getting called * error handling * construct redirect URL properly * fix redirects * handle POST requests etc * oof this took an embarrassingly long time to find * add types * update/remove some tests as appropriate * implement $page.data on the server * fix test * handle invalid redirect statuses * update test, fix off-by-one error * fix a bunch more tests * tweak tests * include dynamically imported styles from +page.js in dev * same but for build * track cookies * apply tracked cookies * down to three failing SSR tests * render errors * all SSR tests in test/apps/basics passing * fix write tests * all SSR tests passing * remove a couple of unused deps * tidy up * dont use instanceof checks * fix off-by-one error in client * client-side fetching, start of redirect/error handling * re-add missing dist file * for now, duplicate route.path logic where needed. in future, rethink manifest for this purpose * fix parent data retrieval, add $page.data to client * fix most prerendering tests * add cache http-equiv * test * get prerender tests passing Co-authored-by: Simon Holthausen <simon.holthausen@vercel.com> * Docs for the new API (#5810) * Update routing - add overview of special files at the beginning (TODO: make this its own page?) - update special file names - shuffle endpoints and standalone endpoints to make it more clear what separates them (TODO: move each into its own page?) * update layouts/error * remove obsolete option * updates to file names in various places * update loading docs * update sapper migration * missed some * clarify depends API * Update documentation/docs/03-routing.md Co-authored-by: Rich Harris <richard.a.harris@gmail.com> * enable all tests * Unbundling (#5853) * tweak bundling strategy * unbundle * remove some unused deps * simplify * simplify further * fix export map * fix adapter-static tests * format * replace some TODOs * only add param tag if param exists * fix some type stuff * fix some type stuff * more type fixes * reuse load_data * fix imports. damn you vscode, you dont have to be like this * fix some stuff * remove unused import * fix prefetchRoutes * fix a handful more tests * comment out likely obsolete setHeaders in test * fix write_client_manifest * fix off-by-one error for client error page rendering * update page store when only data changed * handle page endpoint without get * reenable tests * fix windows/vite path issue * pass serialized server data to client * fix uses tracking for page endpoints in client * unfix the buggy drive letter fix * set headers/etag for page endpoints * add HttpError identifier to serialized version and make connection visible through types * call handle_error in json request * fix test * omit json-data when ssr but no hydration * remove obsolete caching logic from client, adjust test * add migration link * make typescript non-required again by lazy-loading it, fix package.files * only create proxy if something was modified * update pnpm lock * always bundle @sveltejs/kit * fix some write_types stuff * this took waaaay too long to figure out * prettier * fix a bunch of typescript stuff * shrug * probably no point generating types if no ts? * refactor write_types to support addition of layout types * rename Data to PageData and LayoutData * fix manifest generation with named layouts * update tests * generate LayoutLoad and LayoutData types * windows fix, deduplicate, use AwaitedProperties * write Errors type * fix AwaitedProperties type, add AwaitedErrors type * fix test * fix test * trying an env fix, not sure if that works on linux * mhm * temporary run only env test on CI * fix type reference in create-svelte * getting desperate * even more scoped test execution * check why posixify doesnt work * Data -> PageData * wtf, does this work now or not? * remove unnecessary migration warnings, add error for props -> data * omg works, reenable all tests * some docs progress * fix file ending issue in write_types * fix path resolution in write_types * fix type error in generated d.ts file * updates * ooh it works * sprinkle some types * add checkJs * get some pages building * .ts -> .js * simplify write_types * more docs types stuff * rename node.module to node.shared, which is more descriptive * rename route.page to route.leaf * return all route data with __data.json, not just the leaf * load all server data in one go on the client. this should probably have a bunch of tests * update types on file edit * only write types that have changed * debounce updates to manifest * add parent data type inference. introduce a breaking change to the Load typing (another generic which is placed before an existing one) * rename/tidy up some stuff * fix * fix some stuff * set cookies on __data.json requests * fix some stuff * only load data from server if we have some * remove obsolete todo * update test * lint * fix prerendered __data.json * add json helper * use json helper in migration * fixes * center routing documentation on + files * get docs building again * update example * tidy up * update load docs * document promise unwrapping * typo * remove obsolete logic which is now handled elsewhere * implement invalidate() * invalidate() should also loads without dependencies * Update documentation/docs/05-load.md Co-authored-by: Simon H <5968653+dummdidumm@users.noreply.github.com> * Update documentation/docs/03-routing.md * inject $types.d.ts files into code snippets where possible * add a note about shared state. not 100% sure this is the best place for it but will do for now * Update documentation/docs/05-load.md * document set-cookie exception * tweaks * tweaks * more tweaks * cheat * GET->load * more tweaks * fix create-svelte * more tweaks * Update documentation/docs/05-load.md Co-authored-by: Simon H <5968653+dummdidumm@users.noreply.github.com> * fixes * remove outdated Get reference * actions * rewrite type names * rename Load to PageLoad or LayoutLoad etc * include filename in migration scripts * updates * fix search * mention export let errors * changesets * fix types in create-svelte template Co-authored-by: Simon Holthausen <simon.holthausen@vercel.com> Co-authored-by: Simon H <5968653+dummdidumm@users.noreply.github.com>

dummdidumm added 2 commits August 4, 2022 13:49

Update routing

a8c0ed9

- add overview of special files at the beginning (TODO: make this its own page?) - update special file names - shuffle endpoints and standalone endpoints to make it more clear what separates them (TODO: move each into its own page?)

update layouts/error

47743b0

dummdidumm added 3 commits August 4, 2022 14:31

remove obsolete option

c8d0f76

updates to file names in various places

e6877f7

update loading docs

af84f79

vercel bot deployed to Preview – kit August 4, 2022 14:16 View deployment

vercel bot had a problem deploying to Preview – kit-svelte-dev August 4, 2022 14:16 Failure

update sapper migration

560a728

vercel bot had a problem deploying to Preview – kit-svelte-dev August 4, 2022 14:55 Failure

vercel bot deployed to Preview – kit August 4, 2022 14:55 View deployment

missed some

f02fd25

vercel bot deployed to Preview – kit August 4, 2022 16:42 View deployment

vercel bot had a problem deploying to Preview – kit-svelte-dev August 4, 2022 16:43 Failure