@sveltejs/kit 1.0.0-next.24 → 1.0.0-next.240

package/types/helper.d.ts

@@ -0,0 +1,32 @@
+type ToJSON = { toJSON(...args: any[]): JSONValue };
+type JSONValue = Exclude<JSONString, ToJSON>;
+export type JSONString =
+	| string
+	| number
+	| boolean
+	| null
+	| ToJSON
+	| JSONString[]
+	| { [key: string]: JSONString };
+
+/** `string[]` is only for set-cookie, everything else must be type of `string` */
+export type ResponseHeaders = Record<string, string | string[]>;
+
+// <-- Utility Types -->
+type Only<T, U> = { [P in keyof T]: T[P] } & { [P in keyof U]?: never };
+
+export type Either<T, U> = Only<T, U> | Only<U, T>;
+export type InferValue<T, Key extends keyof T, Default> = T extends Record<Key, infer Val>
+	? Val
+	: Default;
+export type MaybePromise<T> = T | Promise<T>;
+export type RecursiveRequired<T> = {
+	// Recursive implementation of TypeScript's Required utility type.
+	// Will recursively continue until it reaches primitive or union
+	// with a Function in it, except those commented below
+	[K in keyof T]-?: Extract<T[K], Function> extends never // If it does not have a Function type
+		? RecursiveRequired<T[K]> // recursively continue through.
+		: K extends 'vite' // If it reaches the 'vite' key
+		? Extract<T[K], Function> // only take the Function type.
+		: T[K]; // Use the exact type for everything else
+};

package/types/hooks.d.ts

@@ -0,0 +1,42 @@
+import { MaybePromise } from './helper';
+
+export type StrictBody = string | Uint8Array;
+
+export interface RequestEvent<Locals = Record<string, any>> {
+	request: Request;
+	url: URL;
+	params: Record<string, string>;
+	locals: Locals;
+}
+
+export interface GetSession<Locals = Record<string, any>, Session = any> {
+	(event: RequestEvent<Locals>): MaybePromise<Session>;
+}
+
+export interface ResolveOpts {
+	ssr?: boolean;
+}
+
+export interface Handle<Locals = Record<string, any>> {
+	(input: {
+		event: RequestEvent<Locals>;
+		resolve(event: RequestEvent<Locals>, opts?: ResolveOpts): MaybePromise<Response>;
+	}): MaybePromise<Response>;
+}
+
+// internally, `resolve` could return `undefined`, so we differentiate InternalHandle
+// from the public Handle type
+export interface InternalHandle<Locals = Record<string, any>> {
+	(input: {
+		event: RequestEvent<Locals>;
+		resolve(event: RequestEvent<Locals>, opts?: ResolveOpts): MaybePromise<Response | undefined>;
+	}): MaybePromise<Response | undefined>;
+}
+
+export interface HandleError<Locals = Record<string, any>> {
+	(input: { error: Error & { frame?: string }; event: RequestEvent<Locals> }): void;
+}
+
+export interface ExternalFetch {
+	(req: Request): Promise<Response>;
+}

package/types/index.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="svelte" />
+/// <reference types="vite/client" />
+
+import './ambient-modules';
+
+export { App, SSRManifest } from './app';
+export { Adapter, Builder, Config, PrerenderErrorHandler, ValidatedConfig } from './config';
+export { EndpointOutput, RequestHandler } from './endpoint';
+export { ErrorLoad, ErrorLoadInput, Load, LoadInput, LoadOutput } from './page';
+export { ExternalFetch, GetSession, Handle, HandleError, RequestEvent, ResolveOpts } from './hooks';

package/types/internal.d.ts

@@ -0,0 +1,234 @@
+import { OutputAsset, OutputChunk } from 'rollup';
+import { InternalApp, SSRManifest } from './app';
+import { Fallthrough, RequestHandler } from './endpoint';
+import { Either } from './helper';
+import { ExternalFetch, GetSession, HandleError, InternalHandle, RequestEvent } from './hooks';
+import { Load } from './page';
+
+export interface PrerenderOptions {
+	fallback?: string;
+	all: boolean;
+	dependencies: Map<string, Response>;
+}
+
+export interface AppModule {
+	App: typeof InternalApp;
+
+	override(options: {
+		paths: {
+			base: string;
+			assets: string;
+		};
+		prerendering: boolean;
+		protocol?: 'http' | 'https';
+		read(file: string): Buffer;
+	}): void;
+}
+
+export interface Logger {
+	(msg: string): void;
+	success(msg: string): void;
+	error(msg: string): void;
+	warn(msg: string): void;
+	minor(msg: string): void;
+	info(msg: string): void;
+}
+
+export interface SSRComponent {
+	router?: boolean;
+	hydrate?: boolean;
+	prerender?: boolean;
+	load: Load;
+	default: {
+		render(props: Record<string, any>): {
+			html: string;
+			head: string;
+			css: {
+				code: string;
+				map: any; // TODO
+			};
+		};
+	};
+}
+
+export type SSRComponentLoader = () => Promise<SSRComponent>;
+
+export type CSRComponent = any; // TODO
+
+export type CSRComponentLoader = () => Promise<CSRComponent>;
+
+export interface SSRPagePart {
+	id: string;
+	load: SSRComponentLoader;
+}
+
+export type GetParams = (match: RegExpExecArray) => Record<string, string>;
+
+export interface SSRPage {
+	type: 'page';
+	pattern: RegExp;
+	params: GetParams;
+	/**
+	 * plan a is to render 1 or more layout components followed by a leaf component.
+	 */
+	a: number[];
+	/**
+	 * plan b — if one of them components fails in `load` we backtrack until we find
+	 * the nearest error component.
+	 */
+	b: number[];
+}
+
+export interface SSREndpoint {
+	type: 'endpoint';
+	pattern: RegExp;
+	params: GetParams;
+	load(): Promise<{
+		[method: string]: RequestHandler;
+	}>;
+}
+
+export type SSRRoute = SSREndpoint | SSRPage;
+
+export type CSRRoute = [RegExp, CSRComponentLoader[], CSRComponentLoader[], GetParams?];
+
+export type SSRNodeLoader = () => Promise<SSRNode>;
+
+export interface Hooks {
+	externalFetch: ExternalFetch;
+	getSession: GetSession;
+	handle: InternalHandle;
+	handleError: HandleError;
+}
+
+export interface SSRNode {
+	module: SSRComponent;
+	/** client-side module URL for this component */
+	entry: string;
+	/** external CSS files */
+	css: string[];
+	/** external JS files */
+	js: string[];
+	/** inlined styles */
+	styles?: Record<string, string>;
+}
+
+export interface SSRRenderOptions {
+	amp: boolean;
+	dev: boolean;
+	floc: boolean;
+	get_stack: (error: Error) => string | undefined;
+	handle_error(error: Error & { frame?: string }, event: RequestEvent): void;
+	hooks: Hooks;
+	hydrate: boolean;
+	manifest: SSRManifest;
+	method_override: MethodOverride;
+	paths: {
+		base: string;
+		assets: string;
+	};
+	prefix: string;
+	prerender: boolean;
+	read(file: string): Buffer;
+	root: SSRComponent['default'];
+	router: boolean;
+	service_worker?: string;
+	target: string;
+	template({ head, body, assets }: { head: string; body: string; assets: string }): string;
+	trailing_slash: TrailingSlash;
+}
+
+export interface SSRRenderState {
+	fetched?: string;
+	initiator?: SSRPage | null;
+	prerender?: PrerenderOptions;
+	fallback?: string;
+}
+
+export interface Asset {
+	file: string;
+	size: number;
+	type: string | null;
+}
+
+export interface RouteSegment {
+	content: string;
+	dynamic: boolean;
+	rest: boolean;
+}
+
+export type HttpMethod = 'get' | 'head' | 'post' | 'put' | 'delete' | 'patch';
+
+export interface PageData {
+	type: 'page';
+	segments: RouteSegment[];
+	pattern: RegExp;
+	params: string[];
+	path: string;
+	a: string[];
+	b: string[];
+}
+
+export interface EndpointData {
+	type: 'endpoint';
+	segments: RouteSegment[];
+	pattern: RegExp;
+	params: string[];
+	file: string;
+}
+
+export type RouteData = PageData | EndpointData;
+
+export interface ManifestData {
+	assets: Asset[];
+	layout: string;
+	error: string;
+	components: string[];
+	routes: RouteData[];
+}
+
+export interface BuildData {
+	app_dir: string;
+	manifest_data: ManifestData;
+	client: {
+		assets: OutputAsset[];
+		chunks: OutputChunk[];
+		entry: {
+			file: string;
+			js: string[];
+			css: string[];
+		};
+		vite_manifest: import('vite').Manifest;
+	};
+	server: {
+		chunks: OutputChunk[];
+		methods: Record<string, HttpMethod[]>;
+		vite_manifest: import('vite').Manifest;
+	};
+	static: string[];
+	entries: string[];
+}
+
+export type NormalizedLoadOutput = Either<
+	{
+		status: number;
+		error?: Error;
+		redirect?: string;
+		props?: Record<string, any> | Promise<Record<string, any>>;
+		stuff?: Record<string, any>;
+		maxage?: number;
+	},
+	Fallthrough
+>;
+
+export type TrailingSlash = 'never' | 'always' | 'ignore';
+export interface MethodOverride {
+	parameter: string;
+	allowed: string[];
+}
+
+export interface Respond {
+	(request: Request, options: SSRRenderOptions, state?: SSRRenderState): Promise<
+		Response | undefined
+	>;
+}

package/types/page.d.ts

@@ -0,0 +1,85 @@
+import { Fallthrough } from './endpoint';
+import { Either, InferValue, MaybePromise } from './helper';
+
+export interface LoadInput<
+	PageParams extends Record<string, string> = Record<string, string>,
+	Stuff extends Record<string, any> = Record<string, any>,
+	Session = any
+> {
+	url: URL;
+	params: PageParams;
+	fetch(info: RequestInfo, init?: RequestInit): Promise<Response>;
+	session: Session;
+	stuff: Stuff;
+}
+
+export interface ErrorLoadInput<
+	PageParams extends Record<string, string> = Record<string, string>,
+	Stuff extends Record<string, any> = Record<string, any>,
+	Session = any
+> extends LoadInput<PageParams, Stuff, Session> {
+	status?: number;
+	error?: Error;
+}
+
+export interface LoadOutput<
+	Props extends Record<string, any> = Record<string, any>,
+	Stuff extends Record<string, any> = Record<string, any>
+> {
+	status?: number;
+	error?: string | Error;
+	redirect?: string;
+	props?: Props;
+	stuff?: Stuff;
+	maxage?: number;
+}
+
+interface LoadInputExtends {
+	stuff?: Record<string, any>;
+	pageParams?: Record<string, string>;
+	session?: any;
+}
+
+interface LoadOutputExtends {
+	stuff?: Record<string, any>;
+	props?: Record<string, any>;
+}
+
+export interface Load<
+	Input extends LoadInputExtends = Required<LoadInputExtends>,
+	Output extends LoadOutputExtends = Required<LoadOutputExtends>
+> {
+	(
+		input: LoadInput<
+			InferValue<Input, 'pageParams', Record<string, string>>,
+			InferValue<Input, 'stuff', Record<string, any>>,
+			InferValue<Input, 'session', any>
+		>
+	): MaybePromise<
+		Either<
+			Fallthrough,
+			LoadOutput<
+				InferValue<Output, 'props', Record<string, any>>,
+				InferValue<Output, 'stuff', Record<string, any>>
+			>
+		>
+	>;
+}
+
+export interface ErrorLoad<
+	Input extends LoadInputExtends = Required<LoadInputExtends>,
+	Output extends LoadOutputExtends = Required<LoadOutputExtends>
+> {
+	(
+		input: ErrorLoadInput<
+			InferValue<Input, 'pageParams', Record<string, string>>,
+			InferValue<Input, 'stuff', Record<string, any>>,
+			InferValue<Input, 'session', any>
+		>
+	): MaybePromise<
+		LoadOutput<
+			InferValue<Output, 'props', Record<string, any>>,
+			InferValue<Output, 'stuff', Record<string, any>>
+		>
+	>;
+}

package/CHANGELOG.md

@@ -1,300 +0,0 @@
-# @sveltejs/kit
-
-## 1.0.0-next.24
-
-### Patch Changes
-
-- 26643df: Account for config.paths when prerendering
-
-## 1.0.0-next.23
-
-### Patch Changes
-
-- 9b758aa: Upgrade to Snowpack 3
-
-## 1.0.0-next.22
-
-### Patch Changes
-
-- bb68595: use readFileSync instead of createReadStream
-
-## 1.0.0-next.21
-
-### Patch Changes
-
-- 217e4cc: Set paths to empty string before prerender
-
-## 1.0.0-next.20
-
-### Patch Changes
-
-- ccf4aa7: Implement prerender config
-
-## 1.0.0-next.19
-
-### Patch Changes
-
-- deda984: Make navigating store contain from and to properties
-
-## 1.0.0-next.18
-
-### Patch Changes
-
-- c29b61e: Announce page changes
-- 72da270: Reset focus properly
-
-## 1.0.0-next.17
-
-### Patch Changes
-
-- f7dea55: Set process.env.NODE_ENV when invoking via the CLI
-
-## 1.0.0-next.16
-
-### Patch Changes
-
-- Remove temporary logging
-- Add sveltekit:prefetch and sveltekit:noscroll
-
-## 1.0.0-next.15
-
-### Patch Changes
-
-- 6d1bb11: Fix AMP CSS
-- d8b53af: Ignore $layout and $error files when finding static paths
-- Better scroll tracking
-
-## 1.0.0-next.14
-
-### Patch Changes
-
-- Fix dev loader
-
-## 1.0.0-next.13
-
-### Patch Changes
-
-- 1ea4d6b: More robust CSS extraction
-
-## 1.0.0-next.12
-
-### Patch Changes
-
-- e7c88dd: Tweak AMP validation screen
-
-## 1.0.0-next.11
-
-### Patch Changes
-
-- a31f218: Fix SSR loader invalidation
-
-## 1.0.0-next.10
-
-### Patch Changes
-
-- 8b14d29: Omit svelte-data scripts from AMP pages
-
-## 1.0.0-next.9
-
-### Patch Changes
-
-- f5fa223: AMP support
-- 47f2ee1: Always remove trailing slashes
-- 1becb94: Replace preload with load
-
-## 1.0.0-next.8
-
-### Patch Changes
-
-- 15dd751: Use meta http-equiv=refresh
-- be7e031: Fix handling of static files
-- ed6b8fd: Implement \$app/env
-
-## 1.0.0-next.7
-
-### Patch Changes
-
-- 76705b0: make HMR work outside localhost
-
-## 1.0.0-next.6
-
-### Patch Changes
-
-- 0e45255: Move options behind kit namespace, change paths -> kit.files
-- fa7f2b2: Implement live bindings for SSR code
-
-## 1.0.0-next.5
-
-### Patch Changes
-
-- Return dependencies from render
-
-## 1.0.0-next.4
-
-### Patch Changes
-
-- af01b0d: Move renderer out of app assets folder
-
-## 1.0.0-next.3
-
-### Patch Changes
-
-- Add paths to manifest, for static prerendering
-
-## 1.0.0-next.2
-
-### Patch Changes
-
-- Fix typo causing misnamed assets folder
-
-## 1.0.0-next.1
-
-### Patch Changes
-
-- a4bc090: Transform exported functions correctly
-- 00bbf98: Fix nested layouts
-
-## 0.0.31-next.0
-
-### Patch Changes
-
-- ffd7bba: Fix SSR cache invalidation
-
-## 0.0.30
-
-### Patch Changes
-
-- Add back stores(), but with deprecation warning
-- Rename stores.preloading to stores.navigating
-- Rewrite routing logic
-
-## 0.0.29
-
-### Patch Changes
-
-- 10872cc: Normalize request.query
-
-## 0.0.28
-
-### Patch Changes
-
-- Add svelte-kit start command
-
-## 0.0.27
-
-### Patch Changes
-
-- rename CLI to svelte-kit
-- 0904e22: rename svelte CLI to svelte-kit
-- Validate route responses
-- Make paths and target configurable
-
-## 0.0.26
-
-### Patch Changes
-
-- b475ed4: Overhaul adapter API - fixes #166
-- Updated dependencies [b475ed4]
-  - @sveltejs/app-utils@0.0.18
-
-## 0.0.25
-
-### Patch Changes
-
-- Updated dependencies [3bdf33b]
-  - @sveltejs/app-utils@0.0.17
-
-## 0.0.24
-
-### Patch Changes
-
-- 67eaeea: Move app-utils stuff into subpackages
-- 7f8df30: Move kit runtime code, expose via \$app aliases
-- Updated dependencies [67eaeea]
-  - @sveltejs/app-utils@0.0.16
-
-## 0.0.23
-
-### Patch Changes
-
-- a163000: Parse body on incoming requests
-- a346eab: Copy over latest Sapper router code
-- Updated dependencies [a163000]
-  - @sveltejs/app-utils@0.0.15
-
-## 0.0.22
-
-### Patch Changes
-
-- Force bump version
-
-## 0.0.21
-
-### Patch Changes
-
-- Build setup entry point
-- Work around pkg.exports constraint
-- Respond with 500s if render fails
-- Updated dependencies [undefined]
-- Updated dependencies [undefined]
-- Updated dependencies [undefined]
-  - @sveltejs/app-utils@0.0.14
-
-## 0.0.20
-
-### Patch Changes
-
-- Pass setup module to renderer
-- Bump Snowpack version
-- Updated dependencies [undefined]
-- Updated dependencies [96c06d8]
-  - @sveltejs/app-utils@0.0.13
-
-## 0.0.19
-
-### Patch Changes
-
-- fa9d7ce: Handle import.meta in SSR module loader
-- 0320208: Rename 'server route' to 'endpoint'
-- b9444d2: Update to Snowpack 2.15
-- 5ca907c: Use shared mkdirp helper
-- Updated dependencies [0320208]
-- Updated dependencies [5ca907c]
-  - @sveltejs/app-utils@0.0.12
-
-## 0.0.18
-
-### Patch Changes
-
-- Updated dependencies [undefined]
-  - @sveltejs/app-utils@0.0.11
-
-## 0.0.17
-
-### Patch Changes
-
-- 19323e9: Update Snowpack
-- Updated dependencies [19323e9]
-  - @sveltejs/app-utils@0.0.10
-
-## 0.0.16
-
-### Patch Changes
-
-- Updated dependencies [90a98ae]
-  - @sveltejs/app-utils@0.0.9
-
-## 0.0.15
-
-### Patch Changes
-
-- Updated dependencies [undefined]
-  - @sveltejs/app-utils@0.0.8
-
-## 0.0.14
-
-### Patch Changes
-
-- various
-- Updated dependencies [undefined]
-  - @sveltejs/app-utils@0.0.7