[chore] deduplicate config types (#2030)

sveltejs · Jul 30, 2021 · 8cbe3b0 · 8cbe3b0
1 parent 77cefe5
commit 8cbe3b0
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 76 deletions.
diff --git a/.changeset/olive-mayflies-retire.md b/.changeset/olive-mayflies-retire.md
@@ -0,0 +1,5 @@
+---
+"@sveltejs/kit": patch
+---
+
+Change `force` to `onError` in prerender config options
diff --git a/packages/kit/types/config.d.ts b/packages/kit/types/config.d.ts
@@ -1,6 +1,7 @@
+import { UserConfig as ViteConfig } from 'vite';
+import { RecursiveRequired } from './helper';
 import { ServerRequest } from './hooks';
 import { Logger, TrailingSlash } from './internal';
-import { UserConfig as ViteConfig } from 'vite';
 
 export interface AdapterUtils {
 	log: Logger;
@@ -11,20 +12,12 @@ export interface AdapterUtils {
 	copy_static_files: (dest: string) => void;
 	copy: (from: string, to: string, filter?: (basename: string) => boolean) => void;
 	update_ignores: ({ patterns, log }: { patterns: string[]; log?: boolean }) => void;
-	prerender: ({
-		all,
-		dest,
-		fallback
-	}: {
-		all?: boolean;
-		dest: string;
-		fallback?: string;
-	}) => Promise<void>;
+	prerender: (options: { all?: boolean; dest: string; fallback?: string }) => Promise<void>;
 }
 
 export interface Adapter {
 	name: string;
-	adapt: ({ utils, config }: { utils: AdapterUtils; config: ValidatedConfig }) => Promise<void>;
+	adapt: (context: { utils: AdapterUtils; config: ValidatedConfig }) => Promise<void>;
 }
 
 export interface PageOpts {
@@ -41,6 +34,17 @@ export interface PageOptsContext {
 
 export type ScriptablePageOpt<T> = T | (({ request, page }: PageOptsContext) => Promise<T>);
 
+export interface PrerenderErrorHandler {
+	(details: {
+		status: number;
+		path: string;
+		referrer: string | null;
+		referenceType: 'linked' | 'fetched';
+	}): void;
+}
+
+export type PrerenderOnErrorValue = 'fail' | 'continue' | PrerenderErrorHandler;
+
 export interface Config {
 	compilerOptions?: any;
 	extensions?: string[];
@@ -79,7 +83,7 @@ export interface Config {
 		prerender?: {
 			crawl?: boolean;
 			enabled?: ScriptablePageOpt<boolean>;
-			force?: boolean;
+			onError?: PrerenderOnErrorValue;
 			pages?: string[];
 		};
 		router?: ScriptablePageOpt<boolean>;
@@ -94,65 +98,6 @@ export interface Config {
 	preprocess?: any;
 }
 
-export type PrerenderErrorHandler = (errorDetails: {
-	status: number;
-	path: string;
-	referrer: string | null;
-	referenceType: 'linked' | 'fetched';
-}) => void | never;
-
-export type PrerenderOnErrorValue = 'fail' | 'continue' | PrerenderErrorHandler;
-
-export interface ValidatedConfig {
-	compilerOptions: any;
-	extensions: string[];
-	kit: {
-		adapter: Adapter;
-		amp: boolean;
-		appDir: string;
-		files: {
-			assets: string;
-			hooks: string;
-			lib: string;
-			routes: string;
-			serviceWorker: string;
-			setup: string;
-			template: string;
-		};
-		floc: boolean;
-		host: string;
-		hostHeader: string;
-		hydrate: ScriptablePageOpt<boolean>;
-		package: {
-			dir: string;
-			emitTypes: boolean;
-			exports: {
-				include: string[];
-				exclude: string[];
-			};
-			files: {
-				include: string[];
-				exclude: string[];
-			};
-		};
-		paths: {
-			assets: string;
-			base: string;
-		};
-		prerender: {
-			crawl: boolean;
-			enabled: ScriptablePageOpt<boolean>;
-			onError: PrerenderOnErrorValue;
-			pages: string[];
-		};
-		router: ScriptablePageOpt<boolean>;
-		serviceWorker: {
-			exclude: string[];
-		};
-		ssr: ScriptablePageOpt<boolean>;
-		target: string;
-		trailingSlash: TrailingSlash;
-		vite: () => ViteConfig;
-	};
-	preprocess: any;
-}
+export type ValidatedConfig = RecursiveRequired<Config> & {
+	kit: { files: { setup: string } }; // only for validated
+};
diff --git a/packages/kit/types/helper.d.ts b/packages/kit/types/helper.d.ts
@@ -31,3 +31,14 @@ export type InferValue<T, Key extends keyof T, Default> = T extends Record<Key,
 	: Default;
 export type MaybePromise<T> = T | Promise<T>;
 export type Rec<T = any> = Record<string, T>;
+export type RecursiveRequired<T> = {
+	// Recursive implementation of TypeScript's Required utility type.
+	// will continue until it reaches a primitive or union
+	// with a Function in it, except for the 'vite' key
+	// which we want the end result to be just a function
+	[K in keyof T]-?: Extract<T[K], Function> extends never
+		? RecursiveRequired<T[K]>
+		: K extends 'vite'
+		? Extract<T[K], Function>
+		: T[K];
+};
diff --git a/packages/kit/types/index.d.ts b/packages/kit/types/index.d.ts
@@ -3,7 +3,7 @@
 
 import './ambient-modules';
 
-export { Adapter, AdapterUtils, Config, ValidatedConfig, PrerenderErrorHandler } from './config';
+export { Adapter, AdapterUtils, Config, PrerenderErrorHandler, ValidatedConfig } from './config';
 export { EndpointOutput, RequestHandler } from './endpoint';
 export { ErrorLoad, ErrorLoadInput, Load, LoadInput, LoadOutput, Page } from './page';
 export {

diff --git a/packages/kit/types/internal.d.ts b/packages/kit/types/internal.d.ts
@@ -1,4 +1,4 @@
-import { PageOpts, ScriptablePageOpt, ValidatedConfig } from './config';
+import { PageOpts, ScriptablePageOpt } from './config';
 import { RequestHandler } from './endpoint';
 import { Headers, Location, ParameterizedBody } from './helper';
 import { GetSession, Handle, ServerResponse, ServerFetch, StrictBody } from './hooks';