feat: move defineEnvVars to @sveltejs/kit/env

.changeset/ninety-jobs-bet.md

@@ -0,0 +1,5 @@
+---
+'@sveltejs/kit': minor
+---
+
+feat: move `defineEnvVars` to `@sveltejs/kit/env`

documentation/docs/20-core-concepts/70-environment-variables.md

@@ -48,14 +48,14 @@ export default {
 
 ```ts
 /// file: src/env.ts
-import { defineEnvVars } from '@sveltejs/kit/hooks';
+import { defineEnvVars } from '@sveltejs/kit/env';
 
 export const variables = defineEnvVars({
 	// ...
 });
 ```
 
-Each value in the object passed to [`defineEnvVars`](@sveltejs-kit-hooks#defineEnvVars) is an [`EnvVarConfig`](@sveltejs-kit#EnvVarConfig) object that configures the environment variable.
+Each value in the object passed to [`defineEnvVars`](@sveltejs-kit-env#defineEnvVars) is an [`EnvVarConfig`](@sveltejs-kit#EnvVarConfig) object that configures the environment variable.
 
 > [!NOTE] `defineEnvVars` returns its argument unaltered — it exists purely to help with type safety.
 
@@ -65,7 +65,7 @@ By default, all variables are considered private. For example, you don't want to
 
 ```ts
 /// file: src/env.ts
-import { defineEnvVars } from '@sveltejs/kit/hooks';
+import { defineEnvVars } from '@sveltejs/kit/env';
 
 export const variables = defineEnvVars({
 	+++API_KEY: {}+++
@@ -88,7 +88,7 @@ Some variables are perfectly safe — necessary, even — to expose to the brow
 
 ```ts
 /// file: src/env.ts
-import { defineEnvVars } from '@sveltejs/kit/hooks';
+import { defineEnvVars } from '@sveltejs/kit/env';
 
 export const variables = defineEnvVars({
 	GOOGLE_ANALYTICS_ID: {
@@ -133,7 +133,7 @@ You can specify a [Standard Schema](https://standardschema.dev/) validator such
 
 ```ts
 /// file: src/env.ts
-import { defineEnvVars } from '@sveltejs/kit/hooks';
+import { defineEnvVars } from '@sveltejs/kit/env';
 +++import * as v from 'valibot';+++
 
 export const variables = defineEnvVars({
@@ -148,7 +148,7 @@ If a value is invalid, the app will fail to start (or build). To opt out of one
 
 ```ts
 /// file: src/env.ts
-import { defineEnvVars } from '@sveltejs/kit/hooks';
+import { defineEnvVars } from '@sveltejs/kit/env';
 +++import { building } from '$app/env'+++
 import * as v from 'valibot';
 
@@ -168,7 +168,7 @@ By default, variables are dynamic. If a variable is configured with `static: tru
 
 ```ts
 /// file: src/env.ts
-import { defineEnvVars } from '@sveltejs/kit/hooks';
+import { defineEnvVars } from '@sveltejs/kit/env';
 import * as v from 'valibot';
 
 export const variables = defineEnvVars({
@@ -212,7 +212,7 @@ You can document the purpose of an environment variable by adding a `description
 
 ```ts
 /// file: src/env.ts
-import { defineEnvVars } from '@sveltejs/kit/hooks';
+import { defineEnvVars } from '@sveltejs/kit/env';
 
 export const variables = defineEnvVars({
 	CACHE_TTL_SECONDS: {

documentation/docs/98-reference/15-@sveltejs-kit-env.md

@@ -0,0 +1,5 @@
+---
+title: @sveltejs/kit/env
+---
+
+> MODULE: @sveltejs/kit/env

packages/kit/package.json

@@ -133,6 +133,10 @@
 			"types": "./types/index.d.ts",
 			"import": "./src/exports/hooks/index.js"
 		},
+		"./env": {
+			"types": "./types/index.d.ts",
+			"import": "./src/exports/env/index.js"
+		},
 		"./vite": {
 			"types": "./types/index.d.ts",
 			"import": "./src/exports/vite/index.js"

packages/kit/scripts/generate-dts.js

@@ -5,6 +5,7 @@ await createBundle({
 	output: 'types/index.d.ts',
 	modules: {
 		'@sveltejs/kit': 'src/exports/public.d.ts',
+		'@sveltejs/kit/env': 'src/exports/env/index.js',
 		'@sveltejs/kit/hooks': 'src/exports/hooks/index.js',
 		'@sveltejs/kit/node': 'src/exports/node/index.js',
 		'@sveltejs/kit/node/polyfills': 'src/exports/node/polyfills.js',

packages/kit/src/exports/env/index.js

@@ -0,0 +1,12 @@
+/** @import { EnvVarConfig } from '@sveltejs/kit' */
+
+/**
+ * Utility for defining [environment variables](https://svelte.dev/docs/kit/environment-variables),
+ * which are made available via `$app/env/public` and `$app/env/private`.
+ * @template {Record<string, EnvVarConfig<any>>} T
+ * @param {T} variables
+ * @returns {T}
+ */
+export function defineEnvVars(variables) {
+	return variables;
+}

packages/kit/src/exports/hooks/index.js

@@ -8,7 +8,9 @@ export { sequence } from './sequence.js';
  * @template {Record<string, EnvVarConfig<any>>} T
  * @param {T} variables
  * @returns {T}
+ * @deprecated Import `defineEnvVars` from `@sveltejs/kit/env` instead
  */
 export function defineEnvVars(variables) {
+	console.warn(`\`defineEnvVars\` has moved — import it from \`@sveltejs/kit/env\` instead`);
 	return variables;
 }

packages/kit/src/exports/public.d.ts

@@ -2366,7 +2366,7 @@ export type RemoteLiveQueryFunction<Input, Output, _Validated = Input> = (
 
 /**
  * [Environment variables](https://svelte.dev/docs/kit/environment-variables) can be configured by exporting
- * a `variables` object from `src/env.ts`, using [`defineEnvVars`](https://svelte.dev/docs/kit/@sveltejs-kit-hooks#defineEnvVars).
+ * a `variables` object from `src/env.ts`, using [`defineEnvVars`](https://svelte.dev/docs/kit/@sveltejs-kit-env#defineEnvVars).
  */
 export interface EnvVarConfig<T> {
 	/**

packages/kit/types/index.d.ts

@@ -2339,7 +2339,7 @@ declare module '@sveltejs/kit' {
 
 	/**
 	 * [Environment variables](https://svelte.dev/docs/kit/environment-variables) can be configured by exporting
-	 * a `variables` object from `src/env.ts`, using [`defineEnvVars`](https://svelte.dev/docs/kit/@sveltejs-kit-hooks#defineEnvVars).
+	 * a `variables` object from `src/env.ts`, using [`defineEnvVars`](https://svelte.dev/docs/kit/@sveltejs-kit-env#defineEnvVars).
 	 */
 	export interface EnvVarConfig<T> {
 		/**
@@ -3045,12 +3045,24 @@ declare module '@sveltejs/kit' {
 	export {};
 }
 
+declare module '@sveltejs/kit/env' {
+	import type { EnvVarConfig } from '@sveltejs/kit';
+	/**
+	 * Utility for defining [environment variables](https://svelte.dev/docs/kit/environment-variables),
+	 * which are made available via `$app/env/public` and `$app/env/private`.
+	 * */
+	export function defineEnvVars<T extends Record<string, EnvVarConfig<any>>>(variables: T): T;
+
+	export {};
+}
+
 declare module '@sveltejs/kit/hooks' {
 	import type { EnvVarConfig, Handle } from '@sveltejs/kit';
 	/**
 	 * Utility for defining [environment variables](https://svelte.dev/docs/kit/environment-variables),
 	 * which are made available via `$app/env/public` and `$app/env/private`.
-	 * */
+	 * @deprecated Import `defineEnvVars` from `@sveltejs/kit/env` instead
+	 */
 	export function defineEnvVars<T extends Record<string, EnvVarConfig<any>>>(variables: T): T;
 	/**
 	 * A helper function for sequencing multiple `handle` calls in a middleware-like manner.