@arkenv/vite-plugin 0.0.17 → 0.0.18
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.cts +190 -3
- package/dist/index.d.cts.map +1 -1
- package/dist/index.d.ts +190 -4
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +6 -5
package/dist/index.d.cts
CHANGED
|
@@ -1,14 +1,201 @@
|
|
|
1
|
-
|
|
1
|
+
/**
|
|
2
|
+
* Augment the `import.meta.env` object with typesafe environment variables
|
|
3
|
+
* based on the schema validator.
|
|
4
|
+
*
|
|
5
|
+
* This type extracts the inferred type from the schema (result of `type()` from arkenv),
|
|
6
|
+
* filters it to only include variables matching the Vite prefix (defaults to "VITE_"),
|
|
7
|
+
* and makes them available on `import.meta.env`.
|
|
8
|
+
*
|
|
9
|
+
* @template TSchema - The environment variable schema (result of `type()` from arkenv)
|
|
10
|
+
* @template Prefix - The prefix to filter by (defaults to "VITE_")
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```ts
|
|
14
|
+
* // vite.config.ts
|
|
15
|
+
* import arkenv from '@arkenv/vite-plugin';
|
|
16
|
+
* import { type } from 'arkenv';
|
|
17
|
+
*
|
|
18
|
+
* export const Env = type({
|
|
19
|
+
* VITE_API_URL: 'string',
|
|
20
|
+
* VITE_API_KEY: 'string',
|
|
21
|
+
* PORT: 'number.port', // Server-only, won't be in ImportMetaEnvAugmented
|
|
22
|
+
* });
|
|
23
|
+
*
|
|
24
|
+
* export default defineConfig({
|
|
25
|
+
* plugins: [arkenv(Env)],
|
|
26
|
+
* });
|
|
27
|
+
* ```
|
|
28
|
+
*
|
|
29
|
+
* @example
|
|
30
|
+
* ```ts
|
|
31
|
+
* // src/vite-env.d.ts
|
|
32
|
+
* /// <reference types="vite/client" />
|
|
33
|
+
*
|
|
34
|
+
* import type { ImportMetaEnvAugmented } from '@arkenv/vite-plugin';
|
|
35
|
+
* import type { Env } from './env'; // or from vite.config.ts
|
|
36
|
+
*
|
|
37
|
+
* interface ImportMetaEnv extends ImportMetaEnvAugmented<typeof Env> {}
|
|
38
|
+
* ```
|
|
39
|
+
*
|
|
40
|
+
* @see {@link https://github.com/Julien-R44/vite-plugin-validate-env#typing-importmetaenv | Original implementation by Julien-R44}
|
|
41
|
+
*/import * as arktype16 from "arktype";
|
|
2
42
|
import { type } from "arktype";
|
|
43
|
+
import * as arktype_internal_keywords_string_ts10 from "arktype/internal/keywords/string.ts";
|
|
44
|
+
import * as arktype_internal_attributes_ts5 from "arktype/internal/attributes.ts";
|
|
3
45
|
import { Plugin } from "vite";
|
|
4
46
|
|
|
5
|
-
//#region
|
|
47
|
+
//#region ../arkenv/dist/index.d.ts
|
|
48
|
+
|
|
49
|
+
//#endregion
|
|
50
|
+
//#region src/scope.d.ts
|
|
51
|
+
/**
|
|
52
|
+
* The root scope for the ArkEnv library, containing extensions to the ArkType scopes with ArkEnv-specific types like `string.host` and `number.port`.
|
|
53
|
+
*/
|
|
54
|
+
declare const $: arktype16.Scope<{
|
|
55
|
+
string: arktype16.Submodule<{
|
|
56
|
+
trim: arktype16.Submodule<arktype_internal_keywords_string_ts10.trim.$ & {
|
|
57
|
+
" arkInferred": (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
58
|
+
}>;
|
|
59
|
+
normalize: arktype16.Submodule<arktype_internal_keywords_string_ts10.normalize.$ & {
|
|
60
|
+
" arkInferred": (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
61
|
+
}>;
|
|
62
|
+
root: string;
|
|
63
|
+
alpha: string;
|
|
64
|
+
alphanumeric: string;
|
|
65
|
+
hex: string;
|
|
66
|
+
base64: arktype16.Submodule<{
|
|
67
|
+
root: string;
|
|
68
|
+
url: string;
|
|
69
|
+
} & {
|
|
70
|
+
" arkInferred": string;
|
|
71
|
+
}>;
|
|
72
|
+
capitalize: arktype16.Submodule<arktype_internal_keywords_string_ts10.capitalize.$ & {
|
|
73
|
+
" arkInferred": (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
74
|
+
}>;
|
|
75
|
+
creditCard: string;
|
|
76
|
+
date: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringDate.$ & {
|
|
77
|
+
" arkInferred": string;
|
|
78
|
+
}>;
|
|
79
|
+
digits: string;
|
|
80
|
+
email: string;
|
|
81
|
+
integer: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringInteger.$ & {
|
|
82
|
+
" arkInferred": string;
|
|
83
|
+
}>;
|
|
84
|
+
ip: arktype16.Submodule<arktype_internal_keywords_string_ts10.ip.$ & {
|
|
85
|
+
" arkInferred": string;
|
|
86
|
+
}>;
|
|
87
|
+
json: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringJson.$ & {
|
|
88
|
+
" arkInferred": string;
|
|
89
|
+
}>;
|
|
90
|
+
lower: arktype16.Submodule<arktype_internal_keywords_string_ts10.lower.$ & {
|
|
91
|
+
" arkInferred": (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
92
|
+
}>;
|
|
93
|
+
numeric: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringNumeric.$ & {
|
|
94
|
+
" arkInferred": string;
|
|
95
|
+
}>;
|
|
96
|
+
regex: string;
|
|
97
|
+
semver: string;
|
|
98
|
+
upper: arktype16.Submodule<{
|
|
99
|
+
root: (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
100
|
+
preformatted: string;
|
|
101
|
+
} & {
|
|
102
|
+
" arkInferred": (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
103
|
+
}>;
|
|
104
|
+
url: arktype16.Submodule<arktype_internal_keywords_string_ts10.url.$ & {
|
|
105
|
+
" arkInferred": string;
|
|
106
|
+
}>;
|
|
107
|
+
uuid: arktype16.Submodule<arktype_internal_keywords_string_ts10.uuid.$ & {
|
|
108
|
+
" arkInferred": string;
|
|
109
|
+
}>;
|
|
110
|
+
" arkInferred": string;
|
|
111
|
+
host: string;
|
|
112
|
+
}>;
|
|
113
|
+
number: arktype16.Submodule<{
|
|
114
|
+
NaN: number;
|
|
115
|
+
Infinity: number;
|
|
116
|
+
root: number;
|
|
117
|
+
integer: number;
|
|
118
|
+
" arkInferred": number;
|
|
119
|
+
epoch: number;
|
|
120
|
+
safe: number;
|
|
121
|
+
NegativeInfinity: number;
|
|
122
|
+
port: (In: string) => arktype16.Out<number>;
|
|
123
|
+
}>;
|
|
124
|
+
boolean: (In: boolean | "false" | "true") => arktype16.Out<boolean>;
|
|
125
|
+
}>;
|
|
126
|
+
//#endregion
|
|
127
|
+
//#region src/create-env.d.ts
|
|
6
128
|
|
|
129
|
+
type EnvSchema<def$1> = type.validate<def$1, (typeof $)["t"]>;
|
|
130
|
+
/**
|
|
131
|
+
* TODO: If possible, find a better type than "const T extends Record<string, unknown>",
|
|
132
|
+
* and be as close as possible to the type accepted by ArkType's `type`.
|
|
133
|
+
*/
|
|
134
|
+
/**
|
|
135
|
+
* Create an environment variables object from a schema and an environment
|
|
136
|
+
* @param def - The environment variable schema (raw object or type definition created with `type()`)
|
|
137
|
+
* @param env - The environment variables to validate, defaults to `process.env`
|
|
138
|
+
* @returns The validated environment variable schema
|
|
139
|
+
* @throws An {@link ArkEnvError | error} if the environment variables are invalid.
|
|
140
|
+
*/
|
|
141
|
+
//#endregion
|
|
142
|
+
//#region ../internal/types/dist/infer-type.d.ts
|
|
143
|
+
/**
|
|
144
|
+
* Extract the inferred type from an ArkType type definition by checking its call signature.
|
|
145
|
+
* When a type definition is called, it returns either the validated value or type.errors.
|
|
146
|
+
*
|
|
147
|
+
* @template T - The ArkType type definition to infer from
|
|
148
|
+
*/
|
|
149
|
+
type InferType<T> = T extends ((value: Record<string, string | undefined>) => infer R) ? R extends type.errors ? never : R : T extends type.Any<infer U, infer _Scope> ? U : never;
|
|
150
|
+
//#endregion
|
|
151
|
+
//#region src/types.d.ts
|
|
152
|
+
/**
|
|
153
|
+
* Filter environment variables to only include those that start with the given prefix.
|
|
154
|
+
* This ensures only client-exposed variables (e.g., VITE_*) are included in import.meta.env.
|
|
155
|
+
*/
|
|
156
|
+
type FilterByPrefix<T extends Record<string, unknown>, Prefix extends string = "VITE_"> = { [K in keyof T as K extends `${Prefix}${string}` ? K : never]: T[K] };
|
|
157
|
+
type ImportMetaEnvAugmented<TSchema extends type.Any, Prefix extends string = "VITE_"> = FilterByPrefix<InferType<TSchema>, Prefix>;
|
|
158
|
+
//#endregion
|
|
159
|
+
//#region src/index.d.ts
|
|
7
160
|
/**
|
|
8
161
|
* TODO: If possible, find a better type than "const T extends Record<string, unknown>",
|
|
9
162
|
* and be as close as possible to the type accepted by ArkType's `type`.
|
|
10
163
|
*/
|
|
164
|
+
/**
|
|
165
|
+
* Vite plugin to validate environment variables using ArkEnv and expose them to client code.
|
|
166
|
+
*
|
|
167
|
+
* The plugin validates environment variables using ArkEnv's schema validation and
|
|
168
|
+
* automatically filters them based on Vite's `envPrefix` configuration (defaults to `"VITE_"`).
|
|
169
|
+
* Only environment variables matching the prefix are exposed to client code via `import.meta.env.*`.
|
|
170
|
+
*
|
|
171
|
+
* @param options - The environment variable schema definition. Can be an `EnvSchema` object
|
|
172
|
+
* for typesafe validation or an ArkType `type.Any` for dynamic schemas.
|
|
173
|
+
* @returns A Vite plugin that validates environment variables and exposes them to the client.
|
|
174
|
+
*
|
|
175
|
+
* @example
|
|
176
|
+
* ```ts
|
|
177
|
+
* // vite.config.ts
|
|
178
|
+
* import { defineConfig } from 'vite';
|
|
179
|
+
* import arkenv from '@arkenv/vite-plugin';
|
|
180
|
+
*
|
|
181
|
+
* export default defineConfig({
|
|
182
|
+
* plugins: [
|
|
183
|
+
* arkenv({
|
|
184
|
+
* VITE_API_URL: 'string',
|
|
185
|
+
* VITE_API_KEY: 'string',
|
|
186
|
+
* }),
|
|
187
|
+
* ],
|
|
188
|
+
* });
|
|
189
|
+
* ```
|
|
190
|
+
*
|
|
191
|
+
* @example
|
|
192
|
+
* ```ts
|
|
193
|
+
* // In your client code
|
|
194
|
+
* console.log(import.meta.env.VITE_API_URL); // Type-safe access
|
|
195
|
+
* ```
|
|
196
|
+
*/
|
|
11
197
|
declare function arkenv<const T extends Record<string, unknown>>(options: EnvSchema<T>): Plugin;
|
|
12
198
|
declare function arkenv(options: type.Any): Plugin;
|
|
13
|
-
|
|
199
|
+
//#endregion
|
|
200
|
+
export { type ImportMetaEnvAugmented, arkenv as default };
|
|
14
201
|
//# sourceMappingURL=index.d.cts.map
|
package/dist/index.d.cts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.cts","names":[],"sources":["../src/index.ts"],"sourcesContent":[],"mappings":";;;;;;;;AAG4C;;AAQxB,iBADI,MACJ,CAAA,gBAD2B,MAC3B,CAAA,MAAA,EAAA,OAAA,CAAA,CAAA,CAAA,OAAA,EAAV,SAAU,CAAA,CAAA,CAAA,CAAA,EACjB,MADiB;AAAV,iBAEc,MAAA,CAFd,OAAA,EAE8B,IAAA,CAAK,GAFnC,CAAA,EAEyC,MAFzC;AAAA"}
|
|
1
|
+
{"version":3,"file":"index.d.cts","names":["arktype16","ArkErrors","distill","type","type$1","arktype_internal_keywords_string_ts10","arktype_internal_attributes_ts5","arktype_internal_type_ts0","InferType","T","Record","R","errors","Any","U","$","trim","To","Submodule","normalize","capitalize","stringDate","stringInteger","ip","stringJson","lower","stringNumeric","url","uuid","Out","Scope","RuntimeEnvironment","EnvSchema","def$1","validate","createEnv","infer","def","TypeParser","ArkEnvError","Error","arkenv","default","type","InferType","T","Record","R","errors","Any","U"],"sources":["../../arkenv/dist/index.d.ts","../../internal/types/dist/infer-type.d.ts","../src/types.ts","../src/index.ts"],"sourcesContent":["import * as arktype16 from \"arktype\";\nimport { ArkErrors, distill, type as type$1 } from \"arktype\";\nimport * as arktype_internal_keywords_string_ts10 from \"arktype/internal/keywords/string.ts\";\nimport * as arktype_internal_attributes_ts5 from \"arktype/internal/attributes.ts\";\nimport * as arktype_internal_type_ts0 from \"arktype/internal/type.ts\";\n\n//#region ../internal/types/dist/infer-type.d.ts\n/**\n * Extract the inferred type from an ArkType type definition by checking its call signature.\n * When a type definition is called, it returns either the validated value or type.errors.\n *\n * @template T - The ArkType type definition to infer from\n */\ntype InferType<T> = T extends ((value: Record<string, string | undefined>) => infer R) ? R extends type$1.errors ? never : R : T extends type$1.Any<infer U, infer _Scope> ? U : never;\n//#endregion\n//#region src/scope.d.ts\n/**\n * The root scope for the ArkEnv library, containing extensions to the ArkType scopes with ArkEnv-specific types like `string.host` and `number.port`.\n */\ndeclare const $: arktype16.Scope<{\n string: arktype16.Submodule<{\n trim: arktype16.Submodule<arktype_internal_keywords_string_ts10.trim.$ & {\n \" arkInferred\": (In: string) => arktype_internal_attributes_ts5.To<string>;\n }>;\n normalize: arktype16.Submodule<arktype_internal_keywords_string_ts10.normalize.$ & {\n \" arkInferred\": (In: string) => arktype_internal_attributes_ts5.To<string>;\n }>;\n root: string;\n alpha: string;\n alphanumeric: string;\n hex: string;\n base64: arktype16.Submodule<{\n root: string;\n url: string;\n } & {\n \" arkInferred\": string;\n }>;\n capitalize: arktype16.Submodule<arktype_internal_keywords_string_ts10.capitalize.$ & {\n \" arkInferred\": (In: string) => arktype_internal_attributes_ts5.To<string>;\n }>;\n creditCard: string;\n date: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringDate.$ & {\n \" arkInferred\": string;\n }>;\n digits: string;\n email: string;\n integer: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringInteger.$ & {\n \" arkInferred\": string;\n }>;\n ip: arktype16.Submodule<arktype_internal_keywords_string_ts10.ip.$ & {\n \" arkInferred\": string;\n }>;\n json: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringJson.$ & {\n \" arkInferred\": string;\n }>;\n lower: arktype16.Submodule<arktype_internal_keywords_string_ts10.lower.$ & {\n \" arkInferred\": (In: string) => arktype_internal_attributes_ts5.To<string>;\n }>;\n numeric: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringNumeric.$ & {\n \" arkInferred\": string;\n }>;\n regex: string;\n semver: string;\n upper: arktype16.Submodule<{\n root: (In: string) => arktype_internal_attributes_ts5.To<string>;\n preformatted: string;\n } & {\n \" arkInferred\": (In: string) => arktype_internal_attributes_ts5.To<string>;\n }>;\n url: arktype16.Submodule<arktype_internal_keywords_string_ts10.url.$ & {\n \" arkInferred\": string;\n }>;\n uuid: arktype16.Submodule<arktype_internal_keywords_string_ts10.uuid.$ & {\n \" arkInferred\": string;\n }>;\n \" arkInferred\": string;\n host: string;\n }>;\n number: arktype16.Submodule<{\n NaN: number;\n Infinity: number;\n root: number;\n integer: number;\n \" arkInferred\": number;\n epoch: number;\n safe: number;\n NegativeInfinity: number;\n port: (In: string) => arktype16.Out<number>;\n }>;\n boolean: (In: boolean | \"false\" | \"true\") => arktype16.Out<boolean>;\n}>;\n//#endregion\n//#region src/create-env.d.ts\ntype RuntimeEnvironment = Record<string, string | undefined>;\ntype EnvSchema<def$1> = type$1.validate<def$1, (typeof $)[\"t\"]>;\n/**\n * TODO: If possible, find a better type than \"const T extends Record<string, unknown>\",\n * and be as close as possible to the type accepted by ArkType's `type`.\n */\n/**\n * Create an environment variables object from a schema and an environment\n * @param def - The environment variable schema (raw object or type definition created with `type()`)\n * @param env - The environment variables to validate, defaults to `process.env`\n * @returns The validated environment variable schema\n * @throws An {@link ArkEnvError | error} if the environment variables are invalid.\n */\ndeclare function createEnv<const T extends Record<string, unknown>>(def: EnvSchema<T>, env?: RuntimeEnvironment): distill.Out<type$1.infer<T, (typeof $)[\"t\"]>>;\ndeclare function createEnv<T extends type$1.Any>(def: T, env?: RuntimeEnvironment): InferType<T>;\ndeclare function createEnv<const T extends Record<string, unknown>>(def: EnvSchema<T> | type$1.Any, env?: RuntimeEnvironment): distill.Out<type$1.infer<T, (typeof $)[\"t\"]>> | InferType<typeof def>;\n//#endregion\n//#region src/type.d.ts\ndeclare const type: arktype_internal_type_ts0.TypeParser<{\n string: arktype16.Submodule<{\n trim: arktype16.Submodule<arktype_internal_keywords_string_ts10.trim.$ & {\n \" arkInferred\": (In: string) => arktype_internal_attributes_ts5.To<string>;\n }>;\n normalize: arktype16.Submodule<arktype_internal_keywords_string_ts10.normalize.$ & {\n \" arkInferred\": (In: string) => arktype_internal_attributes_ts5.To<string>;\n }>;\n root: string;\n alpha: string;\n alphanumeric: string;\n hex: string;\n base64: arktype16.Submodule<{\n root: string;\n url: string;\n } & {\n \" arkInferred\": string;\n }>;\n capitalize: arktype16.Submodule<arktype_internal_keywords_string_ts10.capitalize.$ & {\n \" arkInferred\": (In: string) => arktype_internal_attributes_ts5.To<string>;\n }>;\n creditCard: string;\n date: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringDate.$ & {\n \" arkInferred\": string;\n }>;\n digits: string;\n email: string;\n integer: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringInteger.$ & {\n \" arkInferred\": string;\n }>;\n ip: arktype16.Submodule<arktype_internal_keywords_string_ts10.ip.$ & {\n \" arkInferred\": string;\n }>;\n json: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringJson.$ & {\n \" arkInferred\": string;\n }>;\n lower: arktype16.Submodule<arktype_internal_keywords_string_ts10.lower.$ & {\n \" arkInferred\": (In: string) => arktype_internal_attributes_ts5.To<string>;\n }>;\n numeric: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringNumeric.$ & {\n \" arkInferred\": string;\n }>;\n regex: string;\n semver: string;\n upper: arktype16.Submodule<{\n root: (In: string) => arktype_internal_attributes_ts5.To<string>;\n preformatted: string;\n } & {\n \" arkInferred\": (In: string) => arktype_internal_attributes_ts5.To<string>;\n }>;\n url: arktype16.Submodule<arktype_internal_keywords_string_ts10.url.$ & {\n \" arkInferred\": string;\n }>;\n uuid: arktype16.Submodule<arktype_internal_keywords_string_ts10.uuid.$ & {\n \" arkInferred\": string;\n }>;\n \" arkInferred\": string;\n host: string;\n }>;\n number: arktype16.Submodule<{\n NaN: number;\n Infinity: number;\n root: number;\n integer: number;\n \" arkInferred\": number;\n epoch: number;\n safe: number;\n NegativeInfinity: number;\n port: (In: string) => arktype16.Out<number>;\n }>;\n boolean: (In: boolean | \"false\" | \"true\") => arktype16.Out<boolean>;\n}>;\n//#endregion\n//#region src/errors.d.ts\ndeclare class ArkEnvError extends Error {\n constructor(errors: ArkErrors, message?: string);\n}\n//#endregion\n//#region src/index.d.ts\n/**\n * `arkenv`'s main export, an alias for {@link createEnv}\n *\n * {@link https://arkenv.js.org | ArkEnv} is a typesafe environment variables parser powered by {@link https://arktype.io | ArkType}, TypeScript's 1:1 validator.\n */\ndeclare const arkenv: typeof createEnv;\n//#endregion\nexport { ArkEnvError, type EnvSchema, createEnv, arkenv as default, type };\n//# sourceMappingURL=index.d.ts.map","import type { type } from \"arktype\";\n/**\n * Extract the inferred type from an ArkType type definition by checking its call signature.\n * When a type definition is called, it returns either the validated value or type.errors.\n *\n * @template T - The ArkType type definition to infer from\n */\nexport type InferType<T> = T extends (value: Record<string, string | undefined>) => infer R ? R extends type.errors ? never : R : T extends type.Any<infer U, infer _Scope> ? U : never;\n//# sourceMappingURL=infer-type.d.ts.map"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6FgC;;;;;;;;;;;;;;;;;;cA1ElBe,CAsBMG,EAtBHlB,SAAAA,CAAU8B,KAsBPZ,CAAAA;EAKab,MAAAA,EA1BvBL,SAAAA,CAAUkB,SA0Bab,CAAAA;IAApBL,IAAAA,EAzBHA,SAAAA,CAAUkB,SAyBGA,CAzBOb,qCAAAA,CAAsCW,IAAAA,CAAKD,CAyBlDG,GAAAA;MAGKb,cAAAA,EAAAA,CAAAA,EAAAA,EAAAA,MAAAA,EAAAA,GA3BUC,+BAAAA,CAAgCW,EA2BDF,CAAAA,MAAAA,CAAAA;IAA7Df,CAAAA,CAAAA;IAGsBK,SAAAA,EA5BfL,SAAAA,CAAUkB,SA4BKb,CA5BKA,qCAAAA,CAAsCc,SAAAA,CAAUJ,CA4BJA,GAAAA;MAArEf,cAAUkB,EAAAA,CAAAA,EAAAA,EAAAA,MAAAA,EAAAA,GA3BkBZ,+BAAAA,CAAgCW,EA2BlDC,CAAAA,MAAAA,CAAAA;IAGWb,CAAAA,CAAAA;IACOC,IAAAA,EAAAA,MAAAA;IAD3BN,KAAAA,EAAUkB,MAAAA;IAGYb,YAAAA,EAAAA,MAAAA;IAApBL,GAAAA,EAAAA,MAAUkB;IAMKZ,MAAAA,EAjChBN,SAAAA,CAAUkB,SAiCMZ,CAAAA;MAGUA,IAAAA,EAAAA,MAAAA;MAJ3BN,GAAAA,EAAUkB,MAAAA;IAMQb,CAAAA,GAAAA;MAApBL,cAAUkB,EAAAA,MAAAA;IAGWb,CAAAA,CAAAA;IAApBL,UAAUkB,EAnCJlB,SAAAA,CAAUkB,SAmCNA,CAnCgBb,qCAAAA,CAAsCe,UAAAA,CAAWL,CAmCjEG,GAAAA;MApDVlB,cAAUkB,EAAAA,CAAAA,EAAAA,EAAAA,MAAAA,EAAAA,GAkBkBZ,+BAAAA,CAAgCW,EAlBlDC,CAAAA,MAAAA,CAAAA;IAmEMlB,CAAAA,CAAAA;IAThBA,UAAUkB,EAAAA,MAAAA;IAW2BlB,IAAAA,EAhDrCA,SAAAA,CAAUkB,SAgDqCW,CAhD3BxB,qCAAAA,CAAsCgB,UAAAA,CAAWN,CAgDtBc,GAAAA;MAtExC7B,cAAU8B,EAAAA,MAAAA;IAAK,CAAA,CAAA;IA2E3BE,MAAAA,EAAAA,MAAS;IAA0BC,KAAAA,EAAAA,MAAAA;IAAelB,OAAAA,EAhD1Cf,SAAAA,CAAUkB,SAgDgCH,CAhDtBV,qCAAAA,CAAsCiB,aAAAA,CAAcP,CAgD9BA,GAAAA;MAAxBmB,cAAAA,EAAAA,MAAAA;IAAQ,CAAA,CAAA;QA7C/BlC,SAAAA,CAAUkB,UAAUb,qCAAAA,CAAsCkB,EAAAA,CAAGR;;;IC1CzD6B,IAAAA,ED6CF5C,SAAAA,CAAUkB,SC7CC,CD6CSb,qCAAAA,CAAsCmB,UAAAA,CAAWT,CC7C1D,GAAA;MAAM8B,cAAAA,EAAAA,MAAAA;IAAkBC,CAAAA,CAAAA;IAAiDC,KAAAA,EDgDnF/C,SAAAA,CAAUkB,SChDyE6B,CDgD/D1C,qCAAAA,CAAsCoB,KAAAA,CAAMV,CChDmBgC,GAAAA;MAAeC,cAAAA,EAAAA,CAAAA,EAAAA,EAAAA,MAAAA,EAAAA,GDiDvE1C,+BAAAA,CAAgCW,ECjDuC+B,CAAAA,MAAAA,CAAAA;IAAiBD,CAAAA,CAAAA;IAAIF,OAAAA,EDmDrH7C,SAAAA,CAAUkB,SCnD2G2B,CDmDjGxC,qCAAAA,CAAsCqB,aAAAA,CAAcX,CCnD6C8B,GAAAA;MAAeI,cAAAA,EAAAA,MAAAA;IAA6BC,CAAAA,CAAAA;IAAC,KAAA,EAAA,MAAA;;WDwDpKlD,SAAAA,CAAUkB;4BACOZ,+BAAAA,CAAgCW;MEzDvD,YAAA,EAAA,MAAc;IACR,CAAA,GAAA;MAGE,cAAA,EAAA,CAAA,EAAA,EAAA,MAAA,EAAA,GFwDyBX,+BAAAA,CAAgCW,EExDzD,CAAA,MAAA,CAAA;IAAK,CAAA,CAAA;IAAa,GAAA,EF0DtBjB,SAAAA,CAAUkB,SE1DY,CF0DFb,qCAAAA,CAAsCsB,GAAAA,CAAIZ,CE1DxC,GAAA;MAAoB,cAAA,EAAA,MAAA;IAAY,CAAA,CAAA;IAAE,IAAA,EF6DvDf,SAAAA,CAAUkB,SE7D6C,CF6DnCb,qCAAAA,CAAsCuB,IAAAA,CAAKb,CE7DR,GAAA;MAAC,cAAA,EAAA,MAAA;IA4CtD,CAAA,CAAA;IACK,cAAK,EAAA,MAAA;IAEO,IAAA,EAAA,MAAA;EAAV,CAAA,CAAA;EAAoB,MAAA,EFoB7Bf,SAAAA,CAAUkB,SEpBmB,CAAA;IAAnC,GAAA,EAAA,MAAA;IAAc,QAAA,EAAA,MAAA;;;;ICbM,KAAA,EAAA,MAAM;IAAiB,IAAA,EAAA,MAAA;IAC3B,gBAAA,EAAA,MAAA;IAAV,IAAA,EAAA,CAAA,EAAA,EAAA,MAAA,EAAA,GHyCgBlB,SAAAA,CAAU6B,GGzC1B,CAAA,MAAA,CAAA;EACP,CAAA,CAAA;EAAM,OAAA,EAAA,CAAA,EAAA,EAAA,OAAA,GAAA,OAAA,GAAA,MAAA,EAAA,GH0CsC7B,SAAAA,CAAU6B,GG1ChD,CAAA,OAAA,CAAA;AAAA,CAAA,CAAA;;;;KH+CJG,mBAAmB5B,IAAAA,CAAO8B,SAASD,eAAelB;;;;;;;;;;;;;;;;;;;;AA3EzCA,KCZF6B,SDmFV,CAAA,CAAA,CAAA,GCnFyBC,CDmFzB,UAAA,CAAA,KAAA,ECnF2CC,MDmF3C,CAAA,MAAA,EAAA,MAAA,GAAA,SAAA,CAAA,EAAA,GAAA,KAAA,EAAA,ICnF4FC,CDmF5F,SCnFsGJ,IAAAA,CAAKK,MDmF3G,GAAA,KAAA,GCnF4HD,CDmF5H,GCnFgIF,CDmFhI,SCnF0IF,IAAAA,CAAKM,GDmF/I,CAAA,KAAA,EAAA,EAAA,KAAA,OAAA,CAAA,GCnF4KC,CDmF5K,GAAA,KAAA;;;;;;;KEnFG,yBACM,oEFkFT,ME/EW,CF+EX,IE/EgB,CF+EhB,SAAA,GE/E6B,MF+E7B,GAAA,MAAA,EAAA,GE/EiD,CF+EjD,GAAA,KAAA,GE/E6D,CF+E7D,CE/E+D,CF+E/D,CAAA,EArE4B7C;KEkClB,uCACK,IAAA,CAAK,wCAElB,eAAe,UAAU,UAAU;;;;;;AF7CuI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4ErHwB,iBG5CjC,MH4CiCA,CAAAA,gBG5CV,MH4CUA,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,CAAAA,CAAAA,OAAAA,EG3C/C,SH2C+CA,CG3CrC,CH2CqCA,CAAAA,CAAAA,EG1CtD,MH0CsDA;AAtE9BC,iBG6BH,MAAA,CH7BGA,OAAAA,EG6Ba,IAAA,CAAK,GH7BlBA,CAAAA,EG6BwB,MH7BxBA"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,15 +1,201 @@
|
|
|
1
|
-
|
|
2
|
-
import
|
|
1
|
+
/**
|
|
2
|
+
* Augment the `import.meta.env` object with typesafe environment variables
|
|
3
|
+
* based on the schema validator.
|
|
4
|
+
*
|
|
5
|
+
* This type extracts the inferred type from the schema (result of `type()` from arkenv),
|
|
6
|
+
* filters it to only include variables matching the Vite prefix (defaults to "VITE_"),
|
|
7
|
+
* and makes them available on `import.meta.env`.
|
|
8
|
+
*
|
|
9
|
+
* @template TSchema - The environment variable schema (result of `type()` from arkenv)
|
|
10
|
+
* @template Prefix - The prefix to filter by (defaults to "VITE_")
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```ts
|
|
14
|
+
* // vite.config.ts
|
|
15
|
+
* import arkenv from '@arkenv/vite-plugin';
|
|
16
|
+
* import { type } from 'arkenv';
|
|
17
|
+
*
|
|
18
|
+
* export const Env = type({
|
|
19
|
+
* VITE_API_URL: 'string',
|
|
20
|
+
* VITE_API_KEY: 'string',
|
|
21
|
+
* PORT: 'number.port', // Server-only, won't be in ImportMetaEnvAugmented
|
|
22
|
+
* });
|
|
23
|
+
*
|
|
24
|
+
* export default defineConfig({
|
|
25
|
+
* plugins: [arkenv(Env)],
|
|
26
|
+
* });
|
|
27
|
+
* ```
|
|
28
|
+
*
|
|
29
|
+
* @example
|
|
30
|
+
* ```ts
|
|
31
|
+
* // src/vite-env.d.ts
|
|
32
|
+
* /// <reference types="vite/client" />
|
|
33
|
+
*
|
|
34
|
+
* import type { ImportMetaEnvAugmented } from '@arkenv/vite-plugin';
|
|
35
|
+
* import type { Env } from './env'; // or from vite.config.ts
|
|
36
|
+
*
|
|
37
|
+
* interface ImportMetaEnv extends ImportMetaEnvAugmented<typeof Env> {}
|
|
38
|
+
* ```
|
|
39
|
+
*
|
|
40
|
+
* @see {@link https://github.com/Julien-R44/vite-plugin-validate-env#typing-importmetaenv | Original implementation by Julien-R44}
|
|
41
|
+
*/import { Plugin } from "vite";
|
|
42
|
+
import * as arktype16 from "arktype";
|
|
3
43
|
import { type } from "arktype";
|
|
44
|
+
import * as arktype_internal_keywords_string_ts10 from "arktype/internal/keywords/string.ts";
|
|
45
|
+
import * as arktype_internal_attributes_ts5 from "arktype/internal/attributes.ts";
|
|
4
46
|
|
|
5
|
-
//#region
|
|
47
|
+
//#region ../arkenv/dist/index.d.ts
|
|
48
|
+
|
|
49
|
+
//#endregion
|
|
50
|
+
//#region src/scope.d.ts
|
|
51
|
+
/**
|
|
52
|
+
* The root scope for the ArkEnv library, containing extensions to the ArkType scopes with ArkEnv-specific types like `string.host` and `number.port`.
|
|
53
|
+
*/
|
|
54
|
+
declare const $: arktype16.Scope<{
|
|
55
|
+
string: arktype16.Submodule<{
|
|
56
|
+
trim: arktype16.Submodule<arktype_internal_keywords_string_ts10.trim.$ & {
|
|
57
|
+
" arkInferred": (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
58
|
+
}>;
|
|
59
|
+
normalize: arktype16.Submodule<arktype_internal_keywords_string_ts10.normalize.$ & {
|
|
60
|
+
" arkInferred": (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
61
|
+
}>;
|
|
62
|
+
root: string;
|
|
63
|
+
alpha: string;
|
|
64
|
+
alphanumeric: string;
|
|
65
|
+
hex: string;
|
|
66
|
+
base64: arktype16.Submodule<{
|
|
67
|
+
root: string;
|
|
68
|
+
url: string;
|
|
69
|
+
} & {
|
|
70
|
+
" arkInferred": string;
|
|
71
|
+
}>;
|
|
72
|
+
capitalize: arktype16.Submodule<arktype_internal_keywords_string_ts10.capitalize.$ & {
|
|
73
|
+
" arkInferred": (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
74
|
+
}>;
|
|
75
|
+
creditCard: string;
|
|
76
|
+
date: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringDate.$ & {
|
|
77
|
+
" arkInferred": string;
|
|
78
|
+
}>;
|
|
79
|
+
digits: string;
|
|
80
|
+
email: string;
|
|
81
|
+
integer: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringInteger.$ & {
|
|
82
|
+
" arkInferred": string;
|
|
83
|
+
}>;
|
|
84
|
+
ip: arktype16.Submodule<arktype_internal_keywords_string_ts10.ip.$ & {
|
|
85
|
+
" arkInferred": string;
|
|
86
|
+
}>;
|
|
87
|
+
json: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringJson.$ & {
|
|
88
|
+
" arkInferred": string;
|
|
89
|
+
}>;
|
|
90
|
+
lower: arktype16.Submodule<arktype_internal_keywords_string_ts10.lower.$ & {
|
|
91
|
+
" arkInferred": (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
92
|
+
}>;
|
|
93
|
+
numeric: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringNumeric.$ & {
|
|
94
|
+
" arkInferred": string;
|
|
95
|
+
}>;
|
|
96
|
+
regex: string;
|
|
97
|
+
semver: string;
|
|
98
|
+
upper: arktype16.Submodule<{
|
|
99
|
+
root: (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
100
|
+
preformatted: string;
|
|
101
|
+
} & {
|
|
102
|
+
" arkInferred": (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
103
|
+
}>;
|
|
104
|
+
url: arktype16.Submodule<arktype_internal_keywords_string_ts10.url.$ & {
|
|
105
|
+
" arkInferred": string;
|
|
106
|
+
}>;
|
|
107
|
+
uuid: arktype16.Submodule<arktype_internal_keywords_string_ts10.uuid.$ & {
|
|
108
|
+
" arkInferred": string;
|
|
109
|
+
}>;
|
|
110
|
+
" arkInferred": string;
|
|
111
|
+
host: string;
|
|
112
|
+
}>;
|
|
113
|
+
number: arktype16.Submodule<{
|
|
114
|
+
NaN: number;
|
|
115
|
+
Infinity: number;
|
|
116
|
+
root: number;
|
|
117
|
+
integer: number;
|
|
118
|
+
" arkInferred": number;
|
|
119
|
+
epoch: number;
|
|
120
|
+
safe: number;
|
|
121
|
+
NegativeInfinity: number;
|
|
122
|
+
port: (In: string) => arktype16.Out<number>;
|
|
123
|
+
}>;
|
|
124
|
+
boolean: (In: boolean | "false" | "true") => arktype16.Out<boolean>;
|
|
125
|
+
}>;
|
|
126
|
+
//#endregion
|
|
127
|
+
//#region src/create-env.d.ts
|
|
6
128
|
|
|
129
|
+
type EnvSchema<def$1> = type.validate<def$1, (typeof $)["t"]>;
|
|
7
130
|
/**
|
|
8
131
|
* TODO: If possible, find a better type than "const T extends Record<string, unknown>",
|
|
9
132
|
* and be as close as possible to the type accepted by ArkType's `type`.
|
|
10
133
|
*/
|
|
134
|
+
/**
|
|
135
|
+
* Create an environment variables object from a schema and an environment
|
|
136
|
+
* @param def - The environment variable schema (raw object or type definition created with `type()`)
|
|
137
|
+
* @param env - The environment variables to validate, defaults to `process.env`
|
|
138
|
+
* @returns The validated environment variable schema
|
|
139
|
+
* @throws An {@link ArkEnvError | error} if the environment variables are invalid.
|
|
140
|
+
*/
|
|
141
|
+
//#endregion
|
|
142
|
+
//#region ../internal/types/dist/infer-type.d.ts
|
|
143
|
+
/**
|
|
144
|
+
* Extract the inferred type from an ArkType type definition by checking its call signature.
|
|
145
|
+
* When a type definition is called, it returns either the validated value or type.errors.
|
|
146
|
+
*
|
|
147
|
+
* @template T - The ArkType type definition to infer from
|
|
148
|
+
*/
|
|
149
|
+
type InferType<T> = T extends ((value: Record<string, string | undefined>) => infer R) ? R extends type.errors ? never : R : T extends type.Any<infer U, infer _Scope> ? U : never;
|
|
150
|
+
//#endregion
|
|
151
|
+
//#region src/types.d.ts
|
|
152
|
+
/**
|
|
153
|
+
* Filter environment variables to only include those that start with the given prefix.
|
|
154
|
+
* This ensures only client-exposed variables (e.g., VITE_*) are included in import.meta.env.
|
|
155
|
+
*/
|
|
156
|
+
type FilterByPrefix<T extends Record<string, unknown>, Prefix extends string = "VITE_"> = { [K in keyof T as K extends `${Prefix}${string}` ? K : never]: T[K] };
|
|
157
|
+
type ImportMetaEnvAugmented<TSchema extends type.Any, Prefix extends string = "VITE_"> = FilterByPrefix<InferType<TSchema>, Prefix>;
|
|
158
|
+
//#endregion
|
|
159
|
+
//#region src/index.d.ts
|
|
160
|
+
/**
|
|
161
|
+
* TODO: If possible, find a better type than "const T extends Record<string, unknown>",
|
|
162
|
+
* and be as close as possible to the type accepted by ArkType's `type`.
|
|
163
|
+
*/
|
|
164
|
+
/**
|
|
165
|
+
* Vite plugin to validate environment variables using ArkEnv and expose them to client code.
|
|
166
|
+
*
|
|
167
|
+
* The plugin validates environment variables using ArkEnv's schema validation and
|
|
168
|
+
* automatically filters them based on Vite's `envPrefix` configuration (defaults to `"VITE_"`).
|
|
169
|
+
* Only environment variables matching the prefix are exposed to client code via `import.meta.env.*`.
|
|
170
|
+
*
|
|
171
|
+
* @param options - The environment variable schema definition. Can be an `EnvSchema` object
|
|
172
|
+
* for typesafe validation or an ArkType `type.Any` for dynamic schemas.
|
|
173
|
+
* @returns A Vite plugin that validates environment variables and exposes them to the client.
|
|
174
|
+
*
|
|
175
|
+
* @example
|
|
176
|
+
* ```ts
|
|
177
|
+
* // vite.config.ts
|
|
178
|
+
* import { defineConfig } from 'vite';
|
|
179
|
+
* import arkenv from '@arkenv/vite-plugin';
|
|
180
|
+
*
|
|
181
|
+
* export default defineConfig({
|
|
182
|
+
* plugins: [
|
|
183
|
+
* arkenv({
|
|
184
|
+
* VITE_API_URL: 'string',
|
|
185
|
+
* VITE_API_KEY: 'string',
|
|
186
|
+
* }),
|
|
187
|
+
* ],
|
|
188
|
+
* });
|
|
189
|
+
* ```
|
|
190
|
+
*
|
|
191
|
+
* @example
|
|
192
|
+
* ```ts
|
|
193
|
+
* // In your client code
|
|
194
|
+
* console.log(import.meta.env.VITE_API_URL); // Type-safe access
|
|
195
|
+
* ```
|
|
196
|
+
*/
|
|
11
197
|
declare function arkenv<const T extends Record<string, unknown>>(options: EnvSchema<T>): Plugin;
|
|
12
198
|
declare function arkenv(options: type.Any): Plugin;
|
|
13
199
|
//#endregion
|
|
14
|
-
export { arkenv as default };
|
|
200
|
+
export { type ImportMetaEnvAugmented, arkenv as default };
|
|
15
201
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","names":[],"sources":["../src/index.ts"],"sourcesContent":[],"mappings":";;;;;;;;AAG4C;;AAQxB,iBADI,MACJ,CAAA,gBAD2B,MAC3B,CAAA,MAAA,EAAA,OAAA,CAAA,CAAA,CAAA,OAAA,EAAV,SAAU,CAAA,CAAA,CAAA,CAAA,EACjB,MADiB;AAAV,iBAEc,MAAA,CAFd,OAAA,EAE8B,IAAA,CAAK,GAFnC,CAAA,EAEyC,MAFzC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","names":["arktype16","ArkErrors","distill","type","type$1","arktype_internal_keywords_string_ts10","arktype_internal_attributes_ts5","arktype_internal_type_ts0","InferType","T","Record","R","errors","Any","U","$","trim","To","Submodule","normalize","capitalize","stringDate","stringInteger","ip","stringJson","lower","stringNumeric","url","uuid","Out","Scope","RuntimeEnvironment","EnvSchema","def$1","validate","createEnv","infer","def","TypeParser","ArkEnvError","Error","arkenv","default","type","InferType","T","Record","R","errors","Any","U"],"sources":["../../arkenv/dist/index.d.ts","../../internal/types/dist/infer-type.d.ts","../src/types.ts","../src/index.ts"],"sourcesContent":["import * as arktype16 from \"arktype\";\nimport { ArkErrors, distill, type as type$1 } from \"arktype\";\nimport * as arktype_internal_keywords_string_ts10 from \"arktype/internal/keywords/string.ts\";\nimport * as arktype_internal_attributes_ts5 from \"arktype/internal/attributes.ts\";\nimport * as arktype_internal_type_ts0 from \"arktype/internal/type.ts\";\n\n//#region ../internal/types/dist/infer-type.d.ts\n/**\n * Extract the inferred type from an ArkType type definition by checking its call signature.\n * When a type definition is called, it returns either the validated value or type.errors.\n *\n * @template T - The ArkType type definition to infer from\n */\ntype InferType<T> = T extends ((value: Record<string, string | undefined>) => infer R) ? R extends type$1.errors ? never : R : T extends type$1.Any<infer U, infer _Scope> ? U : never;\n//#endregion\n//#region src/scope.d.ts\n/**\n * The root scope for the ArkEnv library, containing extensions to the ArkType scopes with ArkEnv-specific types like `string.host` and `number.port`.\n */\ndeclare const $: arktype16.Scope<{\n string: arktype16.Submodule<{\n trim: arktype16.Submodule<arktype_internal_keywords_string_ts10.trim.$ & {\n \" arkInferred\": (In: string) => arktype_internal_attributes_ts5.To<string>;\n }>;\n normalize: arktype16.Submodule<arktype_internal_keywords_string_ts10.normalize.$ & {\n \" arkInferred\": (In: string) => arktype_internal_attributes_ts5.To<string>;\n }>;\n root: string;\n alpha: string;\n alphanumeric: string;\n hex: string;\n base64: arktype16.Submodule<{\n root: string;\n url: string;\n } & {\n \" arkInferred\": string;\n }>;\n capitalize: arktype16.Submodule<arktype_internal_keywords_string_ts10.capitalize.$ & {\n \" arkInferred\": (In: string) => arktype_internal_attributes_ts5.To<string>;\n }>;\n creditCard: string;\n date: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringDate.$ & {\n \" arkInferred\": string;\n }>;\n digits: string;\n email: string;\n integer: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringInteger.$ & {\n \" arkInferred\": string;\n }>;\n ip: arktype16.Submodule<arktype_internal_keywords_string_ts10.ip.$ & {\n \" arkInferred\": string;\n }>;\n json: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringJson.$ & {\n \" arkInferred\": string;\n }>;\n lower: arktype16.Submodule<arktype_internal_keywords_string_ts10.lower.$ & {\n \" arkInferred\": (In: string) => arktype_internal_attributes_ts5.To<string>;\n }>;\n numeric: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringNumeric.$ & {\n \" arkInferred\": string;\n }>;\n regex: string;\n semver: string;\n upper: arktype16.Submodule<{\n root: (In: string) => arktype_internal_attributes_ts5.To<string>;\n preformatted: string;\n } & {\n \" arkInferred\": (In: string) => arktype_internal_attributes_ts5.To<string>;\n }>;\n url: arktype16.Submodule<arktype_internal_keywords_string_ts10.url.$ & {\n \" arkInferred\": string;\n }>;\n uuid: arktype16.Submodule<arktype_internal_keywords_string_ts10.uuid.$ & {\n \" arkInferred\": string;\n }>;\n \" arkInferred\": string;\n host: string;\n }>;\n number: arktype16.Submodule<{\n NaN: number;\n Infinity: number;\n root: number;\n integer: number;\n \" arkInferred\": number;\n epoch: number;\n safe: number;\n NegativeInfinity: number;\n port: (In: string) => arktype16.Out<number>;\n }>;\n boolean: (In: boolean | \"false\" | \"true\") => arktype16.Out<boolean>;\n}>;\n//#endregion\n//#region src/create-env.d.ts\ntype RuntimeEnvironment = Record<string, string | undefined>;\ntype EnvSchema<def$1> = type$1.validate<def$1, (typeof $)[\"t\"]>;\n/**\n * TODO: If possible, find a better type than \"const T extends Record<string, unknown>\",\n * and be as close as possible to the type accepted by ArkType's `type`.\n */\n/**\n * Create an environment variables object from a schema and an environment\n * @param def - The environment variable schema (raw object or type definition created with `type()`)\n * @param env - The environment variables to validate, defaults to `process.env`\n * @returns The validated environment variable schema\n * @throws An {@link ArkEnvError | error} if the environment variables are invalid.\n */\ndeclare function createEnv<const T extends Record<string, unknown>>(def: EnvSchema<T>, env?: RuntimeEnvironment): distill.Out<type$1.infer<T, (typeof $)[\"t\"]>>;\ndeclare function createEnv<T extends type$1.Any>(def: T, env?: RuntimeEnvironment): InferType<T>;\ndeclare function createEnv<const T extends Record<string, unknown>>(def: EnvSchema<T> | type$1.Any, env?: RuntimeEnvironment): distill.Out<type$1.infer<T, (typeof $)[\"t\"]>> | InferType<typeof def>;\n//#endregion\n//#region src/type.d.ts\ndeclare const type: arktype_internal_type_ts0.TypeParser<{\n string: arktype16.Submodule<{\n trim: arktype16.Submodule<arktype_internal_keywords_string_ts10.trim.$ & {\n \" arkInferred\": (In: string) => arktype_internal_attributes_ts5.To<string>;\n }>;\n normalize: arktype16.Submodule<arktype_internal_keywords_string_ts10.normalize.$ & {\n \" arkInferred\": (In: string) => arktype_internal_attributes_ts5.To<string>;\n }>;\n root: string;\n alpha: string;\n alphanumeric: string;\n hex: string;\n base64: arktype16.Submodule<{\n root: string;\n url: string;\n } & {\n \" arkInferred\": string;\n }>;\n capitalize: arktype16.Submodule<arktype_internal_keywords_string_ts10.capitalize.$ & {\n \" arkInferred\": (In: string) => arktype_internal_attributes_ts5.To<string>;\n }>;\n creditCard: string;\n date: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringDate.$ & {\n \" arkInferred\": string;\n }>;\n digits: string;\n email: string;\n integer: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringInteger.$ & {\n \" arkInferred\": string;\n }>;\n ip: arktype16.Submodule<arktype_internal_keywords_string_ts10.ip.$ & {\n \" arkInferred\": string;\n }>;\n json: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringJson.$ & {\n \" arkInferred\": string;\n }>;\n lower: arktype16.Submodule<arktype_internal_keywords_string_ts10.lower.$ & {\n \" arkInferred\": (In: string) => arktype_internal_attributes_ts5.To<string>;\n }>;\n numeric: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringNumeric.$ & {\n \" arkInferred\": string;\n }>;\n regex: string;\n semver: string;\n upper: arktype16.Submodule<{\n root: (In: string) => arktype_internal_attributes_ts5.To<string>;\n preformatted: string;\n } & {\n \" arkInferred\": (In: string) => arktype_internal_attributes_ts5.To<string>;\n }>;\n url: arktype16.Submodule<arktype_internal_keywords_string_ts10.url.$ & {\n \" arkInferred\": string;\n }>;\n uuid: arktype16.Submodule<arktype_internal_keywords_string_ts10.uuid.$ & {\n \" arkInferred\": string;\n }>;\n \" arkInferred\": string;\n host: string;\n }>;\n number: arktype16.Submodule<{\n NaN: number;\n Infinity: number;\n root: number;\n integer: number;\n \" arkInferred\": number;\n epoch: number;\n safe: number;\n NegativeInfinity: number;\n port: (In: string) => arktype16.Out<number>;\n }>;\n boolean: (In: boolean | \"false\" | \"true\") => arktype16.Out<boolean>;\n}>;\n//#endregion\n//#region src/errors.d.ts\ndeclare class ArkEnvError extends Error {\n constructor(errors: ArkErrors, message?: string);\n}\n//#endregion\n//#region src/index.d.ts\n/**\n * `arkenv`'s main export, an alias for {@link createEnv}\n *\n * {@link https://arkenv.js.org | ArkEnv} is a typesafe environment variables parser powered by {@link https://arktype.io | ArkType}, TypeScript's 1:1 validator.\n */\ndeclare const arkenv: typeof createEnv;\n//#endregion\nexport { ArkEnvError, type EnvSchema, createEnv, arkenv as default, type };\n//# sourceMappingURL=index.d.ts.map","import type { type } from \"arktype\";\n/**\n * Extract the inferred type from an ArkType type definition by checking its call signature.\n * When a type definition is called, it returns either the validated value or type.errors.\n *\n * @template T - The ArkType type definition to infer from\n */\nexport type InferType<T> = T extends (value: Record<string, string | undefined>) => infer R ? R extends type.errors ? never : R : T extends type.Any<infer U, infer _Scope> ? U : never;\n//# sourceMappingURL=infer-type.d.ts.map"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6FgC;;;;;;;;;;;;;;;;;;cA1ElBe,CAsBMG,EAtBHlB,SAAAA,CAAU8B,KAsBPZ,CAAAA;EAKab,MAAAA,EA1BvBL,SAAAA,CAAUkB,SA0Bab,CAAAA;IAApBL,IAAAA,EAzBHA,SAAAA,CAAUkB,SAyBGA,CAzBOb,qCAAAA,CAAsCW,IAAAA,CAAKD,CAyBlDG,GAAAA;MAGKb,cAAAA,EAAAA,CAAAA,EAAAA,EAAAA,MAAAA,EAAAA,GA3BUC,+BAAAA,CAAgCW,EA2BDF,CAAAA,MAAAA,CAAAA;IAA7Df,CAAAA,CAAAA;IAGsBK,SAAAA,EA5BfL,SAAAA,CAAUkB,SA4BKb,CA5BKA,qCAAAA,CAAsCc,SAAAA,CAAUJ,CA4BJA,GAAAA;MAArEf,cAAUkB,EAAAA,CAAAA,EAAAA,EAAAA,MAAAA,EAAAA,GA3BkBZ,+BAAAA,CAAgCW,EA2BlDC,CAAAA,MAAAA,CAAAA;IAGWb,CAAAA,CAAAA;IACOC,IAAAA,EAAAA,MAAAA;IAD3BN,KAAAA,EAAUkB,MAAAA;IAGYb,YAAAA,EAAAA,MAAAA;IAApBL,GAAAA,EAAAA,MAAUkB;IAMKZ,MAAAA,EAjChBN,SAAAA,CAAUkB,SAiCMZ,CAAAA;MAGUA,IAAAA,EAAAA,MAAAA;MAJ3BN,GAAAA,EAAUkB,MAAAA;IAMQb,CAAAA,GAAAA;MAApBL,cAAUkB,EAAAA,MAAAA;IAGWb,CAAAA,CAAAA;IAApBL,UAAUkB,EAnCJlB,SAAAA,CAAUkB,SAmCNA,CAnCgBb,qCAAAA,CAAsCe,UAAAA,CAAWL,CAmCjEG,GAAAA;MApDVlB,cAAUkB,EAAAA,CAAAA,EAAAA,EAAAA,MAAAA,EAAAA,GAkBkBZ,+BAAAA,CAAgCW,EAlBlDC,CAAAA,MAAAA,CAAAA;IAmEMlB,CAAAA,CAAAA;IAThBA,UAAUkB,EAAAA,MAAAA;IAW2BlB,IAAAA,EAhDrCA,SAAAA,CAAUkB,SAgDqCW,CAhD3BxB,qCAAAA,CAAsCgB,UAAAA,CAAWN,CAgDtBc,GAAAA;MAtExC7B,cAAU8B,EAAAA,MAAAA;IAAK,CAAA,CAAA;IA2E3BE,MAAAA,EAAAA,MAAS;IAA0BC,KAAAA,EAAAA,MAAAA;IAAelB,OAAAA,EAhD1Cf,SAAAA,CAAUkB,SAgDgCH,CAhDtBV,qCAAAA,CAAsCiB,aAAAA,CAAcP,CAgD9BA,GAAAA;MAAxBmB,cAAAA,EAAAA,MAAAA;IAAQ,CAAA,CAAA;QA7C/BlC,SAAAA,CAAUkB,UAAUb,qCAAAA,CAAsCkB,EAAAA,CAAGR;;;IC1CzD6B,IAAAA,ED6CF5C,SAAAA,CAAUkB,SC7CC,CD6CSb,qCAAAA,CAAsCmB,UAAAA,CAAWT,CC7C1D,GAAA;MAAM8B,cAAAA,EAAAA,MAAAA;IAAkBC,CAAAA,CAAAA;IAAiDC,KAAAA,EDgDnF/C,SAAAA,CAAUkB,SChDyE6B,CDgD/D1C,qCAAAA,CAAsCoB,KAAAA,CAAMV,CChDmBgC,GAAAA;MAAeC,cAAAA,EAAAA,CAAAA,EAAAA,EAAAA,MAAAA,EAAAA,GDiDvE1C,+BAAAA,CAAgCW,ECjDuC+B,CAAAA,MAAAA,CAAAA;IAAiBD,CAAAA,CAAAA;IAAIF,OAAAA,EDmDrH7C,SAAAA,CAAUkB,SCnD2G2B,CDmDjGxC,qCAAAA,CAAsCqB,aAAAA,CAAcX,CCnD6C8B,GAAAA;MAAeI,cAAAA,EAAAA,MAAAA;IAA6BC,CAAAA,CAAAA;IAAC,KAAA,EAAA,MAAA;;WDwDpKlD,SAAAA,CAAUkB;4BACOZ,+BAAAA,CAAgCW;MEzDvD,YAAA,EAAA,MAAc;IACR,CAAA,GAAA;MAGE,cAAA,EAAA,CAAA,EAAA,EAAA,MAAA,EAAA,GFwDyBX,+BAAAA,CAAgCW,EExDzD,CAAA,MAAA,CAAA;IAAK,CAAA,CAAA;IAAa,GAAA,EF0DtBjB,SAAAA,CAAUkB,SE1DY,CF0DFb,qCAAAA,CAAsCsB,GAAAA,CAAIZ,CE1DxC,GAAA;MAAoB,cAAA,EAAA,MAAA;IAAY,CAAA,CAAA;IAAE,IAAA,EF6DvDf,SAAAA,CAAUkB,SE7D6C,CF6DnCb,qCAAAA,CAAsCuB,IAAAA,CAAKb,CE7DR,GAAA;MAAC,cAAA,EAAA,MAAA;IA4CtD,CAAA,CAAA;IACK,cAAK,EAAA,MAAA;IAEO,IAAA,EAAA,MAAA;EAAV,CAAA,CAAA;EAAoB,MAAA,EFoB7Bf,SAAAA,CAAUkB,SEpBmB,CAAA;IAAnC,GAAA,EAAA,MAAA;IAAc,QAAA,EAAA,MAAA;;;;ICbM,KAAA,EAAA,MAAM;IAAiB,IAAA,EAAA,MAAA;IAC3B,gBAAA,EAAA,MAAA;IAAV,IAAA,EAAA,CAAA,EAAA,EAAA,MAAA,EAAA,GHyCgBlB,SAAAA,CAAU6B,GGzC1B,CAAA,MAAA,CAAA;EACP,CAAA,CAAA;EAAM,OAAA,EAAA,CAAA,EAAA,EAAA,OAAA,GAAA,OAAA,GAAA,MAAA,EAAA,GH0CsC7B,SAAAA,CAAU6B,GG1ChD,CAAA,OAAA,CAAA;AAAA,CAAA,CAAA;;;;KH+CJG,mBAAmB5B,IAAAA,CAAO8B,SAASD,eAAelB;;;;;;;;;;;;;;;;;;;;AA3EzCA,KCZF6B,SDmFV,CAAA,CAAA,CAAA,GCnFyBC,CDmFzB,UAAA,CAAA,KAAA,ECnF2CC,MDmF3C,CAAA,MAAA,EAAA,MAAA,GAAA,SAAA,CAAA,EAAA,GAAA,KAAA,EAAA,ICnF4FC,CDmF5F,SCnFsGJ,IAAAA,CAAKK,MDmF3G,GAAA,KAAA,GCnF4HD,CDmF5H,GCnFgIF,CDmFhI,SCnF0IF,IAAAA,CAAKM,GDmF/I,CAAA,KAAA,EAAA,EAAA,KAAA,OAAA,CAAA,GCnF4KC,CDmF5K,GAAA,KAAA;;;;;;;KEnFG,yBACM,oEFkFT,ME/EW,CF+EX,IE/EgB,CF+EhB,SAAA,GE/E6B,MF+E7B,GAAA,MAAA,EAAA,GE/EiD,CF+EjD,GAAA,KAAA,GE/E6D,CF+E7D,CE/E+D,CF+E/D,CAAA,EArE4B7C;KEkClB,uCACK,IAAA,CAAK,wCAElB,eAAe,UAAU,UAAU;;;;;;AF7CuI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4ErHwB,iBG5CjC,MH4CiCA,CAAAA,gBG5CV,MH4CUA,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,CAAAA,CAAAA,OAAAA,EG3C/C,SH2C+CA,CG3CrC,CH2CqCA,CAAAA,CAAAA,EG1CtD,MH0CsDA;AAtE9BC,iBG6BH,MAAA,CH7BGA,OAAAA,EG6Ba,IAAA,CAAK,GH7BlBA,CAAAA,EG6BwB,MH7BxBA"}
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import type { EnvSchema } from \"arkenv\";\nimport { createEnv } from \"arkenv\";\nimport type { type } from \"arktype\";\nimport { loadEnv, type Plugin } from \"vite\";\n\n/**\n * TODO: If possible, find a better type than \"const T extends Record<string, unknown>\",\n * and be as close as possible to the type accepted by ArkType's `type`.\n */\n\nexport default function arkenv<const T extends Record<string, unknown>>(\n\toptions: EnvSchema<T>,\n): Plugin;\nexport default function arkenv(options: type.Any): Plugin;\nexport default function arkenv<const T extends Record<string, unknown>>(\n\toptions: EnvSchema<T> | type.Any,\n): Plugin {\n\treturn {\n\t\tname: \"@arkenv/vite-plugin\",\n\t\tconfig(config, { mode }) {\n\t\t\t// Get the Vite prefix for client-exposed environment variables\n\t\t\t// Defaults to \"VITE_\" if not specified\n\t\t\t// Vite allows envPrefix to be a string or array of strings\n\t\t\tconst envPrefix = config.envPrefix ?? \"VITE_\";\n\t\t\tconst prefixes = Array.isArray(envPrefix) ? envPrefix : [envPrefix];\n\n\t\t\t// createEnv accepts both EnvSchema and type.Any at runtime\n\t\t\t// We use overloads above to provide external type precision\n\t\t\tconst env = createEnv(options, loadEnv(mode, process.cwd(), \"\"));\n\n\t\t\t// Filter to only include environment variables matching the prefix\n\t\t\t// This prevents server-only variables from being exposed to client code\n\t\t\tconst filteredEnv = Object.fromEntries(\n\t\t\t\tObject.entries(<Record<string, unknown>>env).filter(([key]) =>\n\t\t\t\t\tprefixes.some((prefix) => key.startsWith(prefix)),\n\t\t\t\t),\n\t\t\t);\n\n\t\t\t// Expose transformed environment variables through Vite's define option\n\t\t\t// Only prefixed variables are exposed to client code\n\t\t\tconst define = Object.fromEntries(\n\t\t\t\tObject.entries(filteredEnv).map(([key, value]) => [\n\t\t\t\t\t`import.meta.env.${key}`,\n\t\t\t\t\tJSON.stringify(value),\n\t\t\t\t]),\n\t\t\t);\n\n\t\t\treturn { define };\n\t\t},\n\t};\n}\n"],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import type { EnvSchema } from \"arkenv\";\nimport { createEnv } from \"arkenv\";\nimport type { type } from \"arktype\";\nimport { loadEnv, type Plugin } from \"vite\";\n\nexport type { ImportMetaEnvAugmented } from \"./types\";\n\n/**\n * TODO: If possible, find a better type than \"const T extends Record<string, unknown>\",\n * and be as close as possible to the type accepted by ArkType's `type`.\n */\n\n/**\n * Vite plugin to validate environment variables using ArkEnv and expose them to client code.\n *\n * The plugin validates environment variables using ArkEnv's schema validation and\n * automatically filters them based on Vite's `envPrefix` configuration (defaults to `\"VITE_\"`).\n * Only environment variables matching the prefix are exposed to client code via `import.meta.env.*`.\n *\n * @param options - The environment variable schema definition. Can be an `EnvSchema` object\n * for typesafe validation or an ArkType `type.Any` for dynamic schemas.\n * @returns A Vite plugin that validates environment variables and exposes them to the client.\n *\n * @example\n * ```ts\n * // vite.config.ts\n * import { defineConfig } from 'vite';\n * import arkenv from '@arkenv/vite-plugin';\n *\n * export default defineConfig({\n * plugins: [\n * arkenv({\n * VITE_API_URL: 'string',\n * VITE_API_KEY: 'string',\n * }),\n * ],\n * });\n * ```\n *\n * @example\n * ```ts\n * // In your client code\n * console.log(import.meta.env.VITE_API_URL); // Type-safe access\n * ```\n */\nexport default function arkenv<const T extends Record<string, unknown>>(\n\toptions: EnvSchema<T>,\n): Plugin;\nexport default function arkenv(options: type.Any): Plugin;\nexport default function arkenv<const T extends Record<string, unknown>>(\n\toptions: EnvSchema<T> | type.Any,\n): Plugin {\n\treturn {\n\t\tname: \"@arkenv/vite-plugin\",\n\t\tconfig(config, { mode }) {\n\t\t\t// Get the Vite prefix for client-exposed environment variables\n\t\t\t// Defaults to \"VITE_\" if not specified\n\t\t\t// Vite allows envPrefix to be a string or array of strings\n\t\t\tconst envPrefix = config.envPrefix ?? \"VITE_\";\n\t\t\tconst prefixes = Array.isArray(envPrefix) ? envPrefix : [envPrefix];\n\n\t\t\t// createEnv accepts both EnvSchema and type.Any at runtime\n\t\t\t// We use overloads above to provide external type precision\n\t\t\tconst env = createEnv(options, loadEnv(mode, process.cwd(), \"\"));\n\n\t\t\t// Filter to only include environment variables matching the prefix\n\t\t\t// This prevents server-only variables from being exposed to client code\n\t\t\tconst filteredEnv = Object.fromEntries(\n\t\t\t\tObject.entries(<Record<string, unknown>>env).filter(([key]) =>\n\t\t\t\t\tprefixes.some((prefix) => key.startsWith(prefix)),\n\t\t\t\t),\n\t\t\t);\n\n\t\t\t// Expose transformed environment variables through Vite's define option\n\t\t\t// Only prefixed variables are exposed to client code\n\t\t\tconst define = Object.fromEntries(\n\t\t\t\tObject.entries(filteredEnv).map(([key, value]) => [\n\t\t\t\t\t`import.meta.env.${key}`,\n\t\t\t\t\tJSON.stringify(value),\n\t\t\t\t]),\n\t\t\t);\n\n\t\t\treturn { define };\n\t\t},\n\t};\n}\n"],"mappings":"kEAiDA,SAAwB,EACvB,EACS,CACT,MAAO,CACN,KAAM,sBACN,OAAO,EAAQ,CAAE,QAAQ,CAIxB,IAAM,EAAY,EAAO,WAAa,QAChC,EAAW,MAAM,QAAQ,EAAU,CAAG,EAAY,CAAC,EAAU,CAI7D,EAAM,EAAU,EAAS,EAAQ,EAAM,QAAQ,KAAK,CAAE,GAAG,CAAC,CAI1D,EAAc,OAAO,YAC1B,OAAO,QAAiC,EAAI,CAAC,QAAQ,CAAC,KACrD,EAAS,KAAM,GAAW,EAAI,WAAW,EAAO,CAAC,CACjD,CACD,CAWD,MAAO,CAAE,OAPM,OAAO,YACrB,OAAO,QAAQ,EAAY,CAAC,KAAK,CAAC,EAAK,KAAW,CACjD,mBAAmB,IACnB,KAAK,UAAU,EAAM,CACrB,CAAC,CACF,CAEgB,EAElB"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@arkenv/vite-plugin",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.18",
|
|
4
4
|
"author": "Yam Borodetsky <yam@yam.codes>",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -13,13 +13,14 @@
|
|
|
13
13
|
},
|
|
14
14
|
"devDependencies": {
|
|
15
15
|
"@size-limit/preset-small-lib": "11.2.0",
|
|
16
|
-
"arktype": "2.1.
|
|
16
|
+
"arktype": "2.1.27",
|
|
17
17
|
"size-limit": "11.2.0",
|
|
18
|
-
"tsdown": "0.16.
|
|
18
|
+
"tsdown": "0.16.5",
|
|
19
19
|
"typescript": "5.9.3",
|
|
20
|
-
"vite": "
|
|
20
|
+
"vite": "7.2.4",
|
|
21
21
|
"vite-tsconfig-paths": "5.1.4",
|
|
22
|
-
"vitest": "4.0.
|
|
22
|
+
"vitest": "4.0.10",
|
|
23
|
+
"@repo/types": "0.0.0"
|
|
23
24
|
},
|
|
24
25
|
"peerDependencies": {
|
|
25
26
|
"arktype": "^2.1.22",
|