arkenv 0.7.2 → 0.7.3
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/README.md +1 -1
- package/dist/index.cjs +115 -91
- package/dist/index.d.cts +157 -150
- package/dist/index.d.ts +157 -150
- package/dist/index.js +93 -69
- package/package.json +6 -5
package/README.md
CHANGED
|
@@ -110,7 +110,7 @@ bun add arkenv arktype
|
|
|
110
110
|
## Requirements
|
|
111
111
|
|
|
112
112
|
- TypeScript >= 5.1 and [anything else required by ArkType](https://arktype.io/docs/intro/setup#installation)
|
|
113
|
-
- [Node.js 22 LTS](https://github.com/yamcodes/arkenv/tree/main/examples/basic), [Bun 1.2](https://github.com/yamcodes/arkenv/tree/main/examples/with-bun), and [Vite 7](https://github.com/yamcodes/arkenv/tree/main/examples/with-vite-react-ts)
|
|
113
|
+
- Tested on [Node.js 22 LTS](https://github.com/yamcodes/arkenv/tree/main/examples/basic), [Bun 1.2](https://github.com/yamcodes/arkenv/tree/main/examples/with-bun), and [Vite from **2.9.18** to **7.x**](https://github.com/yamcodes/arkenv/tree/main/examples/with-vite-react-ts). Older versions may work but are not officially supported
|
|
114
114
|
|
|
115
115
|
## Plugins
|
|
116
116
|
|
package/dist/index.cjs
CHANGED
|
@@ -1,113 +1,137 @@
|
|
|
1
|
-
|
|
1
|
+
Object.defineProperty(exports, '__esModule', { value: true });
|
|
2
|
+
//#region rolldown:runtime
|
|
3
|
+
var __create = Object.create;
|
|
2
4
|
var __defProp = Object.defineProperty;
|
|
3
5
|
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
6
|
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
7
|
+
var __getProtoOf = Object.getPrototypeOf;
|
|
5
8
|
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
-
var __export = (target, all) => {
|
|
7
|
-
for (var name in all)
|
|
8
|
-
__defProp(target, name, { get: all[name], enumerable: true });
|
|
9
|
-
};
|
|
10
9
|
var __copyProps = (to, from, except, desc) => {
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
10
|
+
if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
|
|
11
|
+
key = keys[i];
|
|
12
|
+
if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
|
|
13
|
+
get: ((k) => from[k]).bind(null, key),
|
|
14
|
+
enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
|
|
15
|
+
});
|
|
16
|
+
}
|
|
17
|
+
return to;
|
|
17
18
|
};
|
|
18
|
-
var
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
__export(index_exports, {
|
|
23
|
-
ArkEnvError: () => ArkEnvError,
|
|
24
|
-
createEnv: () => createEnv,
|
|
25
|
-
default: () => index_default,
|
|
26
|
-
type: () => type4
|
|
27
|
-
});
|
|
28
|
-
module.exports = __toCommonJS(index_exports);
|
|
29
|
-
|
|
30
|
-
// src/create-env.ts
|
|
31
|
-
var import_arktype3 = require("arktype");
|
|
19
|
+
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
|
|
20
|
+
value: mod,
|
|
21
|
+
enumerable: true
|
|
22
|
+
}) : target, mod));
|
|
32
23
|
|
|
33
|
-
|
|
34
|
-
|
|
24
|
+
//#endregion
|
|
25
|
+
let arktype = require("arktype");
|
|
26
|
+
arktype = __toESM(arktype);
|
|
27
|
+
let node_util = require("node:util");
|
|
28
|
+
node_util = __toESM(node_util);
|
|
35
29
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
30
|
+
//#region src/utils.ts
|
|
31
|
+
/**
|
|
32
|
+
* Indent a string by a given amount
|
|
33
|
+
* @param str - The string to indent
|
|
34
|
+
* @param amt - The amount to indent by, defaults to 2
|
|
35
|
+
* @param options - {@link IndentOptions}
|
|
36
|
+
* @returns The indented string
|
|
37
|
+
*/
|
|
38
|
+
const indent = (str, amt = 2, { dontDetectNewlines = false } = {}) => {
|
|
39
|
+
if (!dontDetectNewlines) return str.split("\n").map((line) => `${" ".repeat(amt)}${line}`).join("\n");
|
|
40
|
+
return `${" ".repeat(amt)}${str}`;
|
|
43
41
|
};
|
|
44
42
|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
43
|
+
//#endregion
|
|
44
|
+
//#region src/errors.ts
|
|
45
|
+
/**
|
|
46
|
+
* Format the errors returned by ArkType to be more readable
|
|
47
|
+
* @param errors - The errors returned by ArkType
|
|
48
|
+
* @returns A string of the formatted errors
|
|
49
|
+
*/
|
|
50
|
+
const formatErrors = (errors) => Object.entries(errors.byPath).map(([path, error]) => {
|
|
51
|
+
const messageWithoutPath = error.message.startsWith(path) ? error.message.slice(path.length) : error.message;
|
|
52
|
+
const valueMatch = messageWithoutPath.match(/\(was "([^"]+)"\)/);
|
|
53
|
+
const formattedMessage = valueMatch ? messageWithoutPath.replace(`(was "${valueMatch[1]}")`, `(was ${(0, node_util.styleText)("cyan", `"${valueMatch[1]}"`)})`) : messageWithoutPath;
|
|
54
|
+
return `${(0, node_util.styleText)("yellow", path)}${formattedMessage}`;
|
|
54
55
|
}).join("\n");
|
|
55
56
|
var ArkEnvError = class extends Error {
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
this.name = "ArkEnvError";
|
|
61
|
-
}
|
|
57
|
+
constructor(errors, message = "Errors found while validating environment variables") {
|
|
58
|
+
super(`${(0, node_util.styleText)("red", message)}\n${indent(formatErrors(errors))}\n`);
|
|
59
|
+
this.name = "ArkEnvError";
|
|
60
|
+
}
|
|
62
61
|
};
|
|
63
62
|
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
if (!isInteger || !isBetween) {
|
|
74
|
-
ctx.mustBe("an integer between 0 and 65535");
|
|
75
|
-
}
|
|
76
|
-
return asNumber;
|
|
63
|
+
//#endregion
|
|
64
|
+
//#region src/types.ts
|
|
65
|
+
/**
|
|
66
|
+
* A `string` that can be parsed into a number between 0 and 65535
|
|
67
|
+
*/
|
|
68
|
+
const port = (0, arktype.type)("string", "=>", (data, ctx) => {
|
|
69
|
+
const asNumber = Number.parseInt(data, 10);
|
|
70
|
+
if (!Number.isInteger(asNumber) || !(0 <= asNumber && asNumber <= 65535)) ctx.mustBe("an integer between 0 and 65535");
|
|
71
|
+
return asNumber;
|
|
77
72
|
});
|
|
78
|
-
|
|
73
|
+
/**
|
|
74
|
+
* An IP address or `"localhost"`
|
|
75
|
+
*/
|
|
76
|
+
const host = (0, arktype.type)("string.ip | 'localhost'");
|
|
77
|
+
/**
|
|
78
|
+
* A boolean that accepts string values and converts them to boolean
|
|
79
|
+
* Accepts "true" or "false" strings and converts them to actual boolean values
|
|
80
|
+
*/
|
|
81
|
+
const boolean = (0, arktype.type)("'true' | 'false' | true | false", "=>", (str) => str === "true" || str === true);
|
|
79
82
|
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
83
|
+
//#endregion
|
|
84
|
+
//#region src/scope.ts
|
|
85
|
+
/**
|
|
86
|
+
* The root scope for the ArkEnv library, containing extensions to the ArkType scopes with ArkEnv-specific types like `string.host` and `number.port`.
|
|
87
|
+
*/
|
|
88
|
+
const $ = (0, arktype.scope)({
|
|
89
|
+
string: arktype.type.module({
|
|
90
|
+
...arktype.type.keywords.string,
|
|
91
|
+
host
|
|
92
|
+
}),
|
|
93
|
+
number: arktype.type.module({
|
|
94
|
+
...arktype.type.keywords.number,
|
|
95
|
+
port
|
|
96
|
+
}),
|
|
97
|
+
boolean
|
|
90
98
|
});
|
|
91
99
|
|
|
92
|
-
|
|
100
|
+
//#endregion
|
|
101
|
+
//#region src/create-env.ts
|
|
102
|
+
/**
|
|
103
|
+
* TODO: If possible, find a better type than "const T extends Record<string, unknown>",
|
|
104
|
+
* and be as close as possible to the type accepted by ArkType's `type`.
|
|
105
|
+
*/
|
|
106
|
+
/**
|
|
107
|
+
* Create an environment variables object from a schema and an environment
|
|
108
|
+
* @param def - The environment variable schema
|
|
109
|
+
* @param env - The environment variables to validate, defaults to `process.env`
|
|
110
|
+
* @returns The validated environment variable schema
|
|
111
|
+
* @throws An {@link ArkEnvError | error} if the environment variables are invalid.
|
|
112
|
+
*/
|
|
93
113
|
function createEnv(def, env = process.env) {
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
throw new ArkEnvError(validatedEnv);
|
|
98
|
-
}
|
|
99
|
-
return validatedEnv;
|
|
114
|
+
const validatedEnv = $.type.raw(def)(env);
|
|
115
|
+
if (validatedEnv instanceof arktype.type.errors) throw new ArkEnvError(validatedEnv);
|
|
116
|
+
return validatedEnv;
|
|
100
117
|
}
|
|
101
118
|
|
|
102
|
-
|
|
103
|
-
|
|
119
|
+
//#endregion
|
|
120
|
+
//#region src/type.ts
|
|
121
|
+
const type = $.type;
|
|
104
122
|
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
123
|
+
//#endregion
|
|
124
|
+
//#region src/index.ts
|
|
125
|
+
/**
|
|
126
|
+
* `arkenv`'s main export, an alias for {@link createEnv}
|
|
127
|
+
*
|
|
128
|
+
* {@link https://arkenv.js.org | ArkEnv} is a typesafe environment variables parser powered by {@link https://arktype.io | ArkType}, TypeScript's 1:1 validator.
|
|
129
|
+
*/
|
|
130
|
+
const arkenv = createEnv;
|
|
131
|
+
var src_default = arkenv;
|
|
132
|
+
|
|
133
|
+
//#endregion
|
|
134
|
+
exports.ArkEnvError = ArkEnvError;
|
|
135
|
+
exports.createEnv = createEnv;
|
|
136
|
+
exports.default = src_default;
|
|
137
|
+
exports.type = type;
|
package/dist/index.d.cts
CHANGED
|
@@ -1,84 +1,87 @@
|
|
|
1
|
-
import * as
|
|
2
|
-
import { type as type$1
|
|
3
|
-
import * as
|
|
4
|
-
import * as
|
|
5
|
-
import * as
|
|
1
|
+
import * as arktype16 from "arktype";
|
|
2
|
+
import { ArkErrors, distill, type as type$1 } from "arktype";
|
|
3
|
+
import * as arktype_internal_keywords_string_ts10 from "arktype/internal/keywords/string.ts";
|
|
4
|
+
import * as arktype_internal_attributes_ts5 from "arktype/internal/attributes.ts";
|
|
5
|
+
import * as arktype_internal_type_ts0 from "arktype/internal/type.ts";
|
|
6
6
|
|
|
7
|
+
//#region src/scope.d.ts
|
|
7
8
|
/**
|
|
8
9
|
* The root scope for the ArkEnv library, containing extensions to the ArkType scopes with ArkEnv-specific types like `string.host` and `number.port`.
|
|
9
10
|
*/
|
|
10
|
-
declare const $:
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
trim: arktype.Submodule<arktype_internal_keywords_string_ts.trim.$ & {
|
|
15
|
-
" arkInferred": (In: string) => arktype_internal_attributes_ts.To<string>;
|
|
16
|
-
}>;
|
|
17
|
-
normalize: arktype.Submodule<arktype_internal_keywords_string_ts.normalize.$ & {
|
|
18
|
-
" arkInferred": (In: string) => arktype_internal_attributes_ts.To<string>;
|
|
19
|
-
}>;
|
|
20
|
-
alpha: string;
|
|
21
|
-
alphanumeric: string;
|
|
22
|
-
hex: string;
|
|
23
|
-
base64: arktype.Submodule<{
|
|
24
|
-
root: string;
|
|
25
|
-
url: string;
|
|
26
|
-
} & {
|
|
27
|
-
" arkInferred": string;
|
|
28
|
-
}>;
|
|
29
|
-
capitalize: arktype.Submodule<arktype_internal_keywords_string_ts.capitalize.$ & {
|
|
30
|
-
" arkInferred": (In: string) => arktype_internal_attributes_ts.To<string>;
|
|
31
|
-
}>;
|
|
32
|
-
creditCard: string;
|
|
33
|
-
date: arktype.Submodule<arktype_internal_keywords_string_ts.stringDate.$ & {
|
|
34
|
-
" arkInferred": string;
|
|
35
|
-
}>;
|
|
36
|
-
digits: string;
|
|
37
|
-
email: string;
|
|
38
|
-
integer: arktype.Submodule<arktype_internal_keywords_string_ts.stringInteger.$ & {
|
|
39
|
-
" arkInferred": string;
|
|
40
|
-
}>;
|
|
41
|
-
ip: arktype.Submodule<arktype_internal_keywords_string_ts.ip.$ & {
|
|
42
|
-
" arkInferred": string;
|
|
43
|
-
}>;
|
|
44
|
-
json: arktype.Submodule<arktype_internal_keywords_string_ts.stringJson.$ & {
|
|
45
|
-
" arkInferred": string;
|
|
46
|
-
}>;
|
|
47
|
-
lower: arktype.Submodule<arktype_internal_keywords_string_ts.lower.$ & {
|
|
48
|
-
" arkInferred": (In: string) => arktype_internal_attributes_ts.To<string>;
|
|
49
|
-
}>;
|
|
50
|
-
numeric: arktype.Submodule<arktype_internal_keywords_string_ts.stringNumeric.$ & {
|
|
51
|
-
" arkInferred": string;
|
|
52
|
-
}>;
|
|
53
|
-
regex: string;
|
|
54
|
-
semver: string;
|
|
55
|
-
upper: arktype.Submodule<{
|
|
56
|
-
root: (In: string) => arktype_internal_attributes_ts.To<string>;
|
|
57
|
-
preformatted: string;
|
|
58
|
-
} & {
|
|
59
|
-
" arkInferred": (In: string) => arktype_internal_attributes_ts.To<string>;
|
|
60
|
-
}>;
|
|
61
|
-
url: arktype.Submodule<arktype_internal_keywords_string_ts.url.$ & {
|
|
62
|
-
" arkInferred": string;
|
|
63
|
-
}>;
|
|
64
|
-
uuid: arktype.Submodule<arktype_internal_keywords_string_ts.uuid.$ & {
|
|
65
|
-
" arkInferred": string;
|
|
66
|
-
}>;
|
|
67
|
-
host: string;
|
|
68
|
-
}>;
|
|
69
|
-
number: arktype.Submodule<{
|
|
70
|
-
NaN: number;
|
|
71
|
-
Infinity: number;
|
|
72
|
-
root: number;
|
|
73
|
-
" arkInferred": number;
|
|
74
|
-
integer: number;
|
|
75
|
-
epoch: number;
|
|
76
|
-
safe: number;
|
|
77
|
-
NegativeInfinity: number;
|
|
78
|
-
port: (In: string) => arktype.Out<number>;
|
|
11
|
+
declare const $: arktype16.Scope<{
|
|
12
|
+
string: arktype16.Submodule<{
|
|
13
|
+
trim: arktype16.Submodule<arktype_internal_keywords_string_ts10.trim.$ & {
|
|
14
|
+
" arkInferred": (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
79
15
|
}>;
|
|
16
|
+
normalize: arktype16.Submodule<arktype_internal_keywords_string_ts10.normalize.$ & {
|
|
17
|
+
" arkInferred": (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
18
|
+
}>;
|
|
19
|
+
root: string;
|
|
20
|
+
alpha: string;
|
|
21
|
+
alphanumeric: string;
|
|
22
|
+
hex: string;
|
|
23
|
+
base64: arktype16.Submodule<{
|
|
24
|
+
root: string;
|
|
25
|
+
url: string;
|
|
26
|
+
} & {
|
|
27
|
+
" arkInferred": string;
|
|
28
|
+
}>;
|
|
29
|
+
capitalize: arktype16.Submodule<arktype_internal_keywords_string_ts10.capitalize.$ & {
|
|
30
|
+
" arkInferred": (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
31
|
+
}>;
|
|
32
|
+
creditCard: string;
|
|
33
|
+
date: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringDate.$ & {
|
|
34
|
+
" arkInferred": string;
|
|
35
|
+
}>;
|
|
36
|
+
digits: string;
|
|
37
|
+
email: string;
|
|
38
|
+
integer: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringInteger.$ & {
|
|
39
|
+
" arkInferred": string;
|
|
40
|
+
}>;
|
|
41
|
+
ip: arktype16.Submodule<arktype_internal_keywords_string_ts10.ip.$ & {
|
|
42
|
+
" arkInferred": string;
|
|
43
|
+
}>;
|
|
44
|
+
json: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringJson.$ & {
|
|
45
|
+
" arkInferred": string;
|
|
46
|
+
}>;
|
|
47
|
+
lower: arktype16.Submodule<arktype_internal_keywords_string_ts10.lower.$ & {
|
|
48
|
+
" arkInferred": (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
49
|
+
}>;
|
|
50
|
+
numeric: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringNumeric.$ & {
|
|
51
|
+
" arkInferred": string;
|
|
52
|
+
}>;
|
|
53
|
+
regex: string;
|
|
54
|
+
semver: string;
|
|
55
|
+
upper: arktype16.Submodule<{
|
|
56
|
+
root: (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
57
|
+
preformatted: string;
|
|
58
|
+
} & {
|
|
59
|
+
" arkInferred": (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
60
|
+
}>;
|
|
61
|
+
url: arktype16.Submodule<arktype_internal_keywords_string_ts10.url.$ & {
|
|
62
|
+
" arkInferred": string;
|
|
63
|
+
}>;
|
|
64
|
+
uuid: arktype16.Submodule<arktype_internal_keywords_string_ts10.uuid.$ & {
|
|
65
|
+
" arkInferred": string;
|
|
66
|
+
}>;
|
|
67
|
+
" arkInferred": string;
|
|
68
|
+
host: string;
|
|
69
|
+
}>;
|
|
70
|
+
number: arktype16.Submodule<{
|
|
71
|
+
NaN: number;
|
|
72
|
+
Infinity: number;
|
|
73
|
+
root: number;
|
|
74
|
+
integer: number;
|
|
75
|
+
" arkInferred": number;
|
|
76
|
+
epoch: number;
|
|
77
|
+
safe: number;
|
|
78
|
+
NegativeInfinity: number;
|
|
79
|
+
port: (In: string) => arktype16.Out<number>;
|
|
80
|
+
}>;
|
|
81
|
+
boolean: (In: boolean | "false" | "true") => arktype16.Out<boolean>;
|
|
80
82
|
}>;
|
|
81
|
-
|
|
83
|
+
//#endregion
|
|
84
|
+
//#region src/create-env.d.ts
|
|
82
85
|
type RuntimeEnvironment = Record<string, string | undefined>;
|
|
83
86
|
type EnvSchema<def> = type$1.validate<def, (typeof $)["t"]>;
|
|
84
87
|
/**
|
|
@@ -93,88 +96,92 @@ type EnvSchema<def> = type$1.validate<def, (typeof $)["t"]>;
|
|
|
93
96
|
* @throws An {@link ArkEnvError | error} if the environment variables are invalid.
|
|
94
97
|
*/
|
|
95
98
|
declare function createEnv<const T extends Record<string, unknown>>(def: EnvSchema<T>, env?: RuntimeEnvironment): distill.Out<type$1.infer<T, (typeof $)["t"]>>;
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
" arkInferred": (In: string) => arktype_internal_attributes_ts.To<string>;
|
|
106
|
-
}>;
|
|
107
|
-
alpha: string;
|
|
108
|
-
alphanumeric: string;
|
|
109
|
-
hex: string;
|
|
110
|
-
base64: arktype.Submodule<{
|
|
111
|
-
root: string;
|
|
112
|
-
url: string;
|
|
113
|
-
} & {
|
|
114
|
-
" arkInferred": string;
|
|
115
|
-
}>;
|
|
116
|
-
capitalize: arktype.Submodule<arktype_internal_keywords_string_ts.capitalize.$ & {
|
|
117
|
-
" arkInferred": (In: string) => arktype_internal_attributes_ts.To<string>;
|
|
118
|
-
}>;
|
|
119
|
-
creditCard: string;
|
|
120
|
-
date: arktype.Submodule<arktype_internal_keywords_string_ts.stringDate.$ & {
|
|
121
|
-
" arkInferred": string;
|
|
122
|
-
}>;
|
|
123
|
-
digits: string;
|
|
124
|
-
email: string;
|
|
125
|
-
integer: arktype.Submodule<arktype_internal_keywords_string_ts.stringInteger.$ & {
|
|
126
|
-
" arkInferred": string;
|
|
127
|
-
}>;
|
|
128
|
-
ip: arktype.Submodule<arktype_internal_keywords_string_ts.ip.$ & {
|
|
129
|
-
" arkInferred": string;
|
|
130
|
-
}>;
|
|
131
|
-
json: arktype.Submodule<arktype_internal_keywords_string_ts.stringJson.$ & {
|
|
132
|
-
" arkInferred": string;
|
|
133
|
-
}>;
|
|
134
|
-
lower: arktype.Submodule<arktype_internal_keywords_string_ts.lower.$ & {
|
|
135
|
-
" arkInferred": (In: string) => arktype_internal_attributes_ts.To<string>;
|
|
136
|
-
}>;
|
|
137
|
-
numeric: arktype.Submodule<arktype_internal_keywords_string_ts.stringNumeric.$ & {
|
|
138
|
-
" arkInferred": string;
|
|
139
|
-
}>;
|
|
140
|
-
regex: string;
|
|
141
|
-
semver: string;
|
|
142
|
-
upper: arktype.Submodule<{
|
|
143
|
-
root: (In: string) => arktype_internal_attributes_ts.To<string>;
|
|
144
|
-
preformatted: string;
|
|
145
|
-
} & {
|
|
146
|
-
" arkInferred": (In: string) => arktype_internal_attributes_ts.To<string>;
|
|
147
|
-
}>;
|
|
148
|
-
url: arktype.Submodule<arktype_internal_keywords_string_ts.url.$ & {
|
|
149
|
-
" arkInferred": string;
|
|
150
|
-
}>;
|
|
151
|
-
uuid: arktype.Submodule<arktype_internal_keywords_string_ts.uuid.$ & {
|
|
152
|
-
" arkInferred": string;
|
|
153
|
-
}>;
|
|
154
|
-
host: string;
|
|
155
|
-
}>;
|
|
156
|
-
number: arktype.Submodule<{
|
|
157
|
-
NaN: number;
|
|
158
|
-
Infinity: number;
|
|
159
|
-
root: number;
|
|
160
|
-
" arkInferred": number;
|
|
161
|
-
integer: number;
|
|
162
|
-
epoch: number;
|
|
163
|
-
safe: number;
|
|
164
|
-
NegativeInfinity: number;
|
|
165
|
-
port: (In: string) => arktype.Out<number>;
|
|
99
|
+
//#endregion
|
|
100
|
+
//#region src/type.d.ts
|
|
101
|
+
declare const type: arktype_internal_type_ts0.TypeParser<{
|
|
102
|
+
string: arktype16.Submodule<{
|
|
103
|
+
trim: arktype16.Submodule<arktype_internal_keywords_string_ts10.trim.$ & {
|
|
104
|
+
" arkInferred": (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
105
|
+
}>;
|
|
106
|
+
normalize: arktype16.Submodule<arktype_internal_keywords_string_ts10.normalize.$ & {
|
|
107
|
+
" arkInferred": (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
166
108
|
}>;
|
|
109
|
+
root: string;
|
|
110
|
+
alpha: string;
|
|
111
|
+
alphanumeric: string;
|
|
112
|
+
hex: string;
|
|
113
|
+
base64: arktype16.Submodule<{
|
|
114
|
+
root: string;
|
|
115
|
+
url: string;
|
|
116
|
+
} & {
|
|
117
|
+
" arkInferred": string;
|
|
118
|
+
}>;
|
|
119
|
+
capitalize: arktype16.Submodule<arktype_internal_keywords_string_ts10.capitalize.$ & {
|
|
120
|
+
" arkInferred": (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
121
|
+
}>;
|
|
122
|
+
creditCard: string;
|
|
123
|
+
date: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringDate.$ & {
|
|
124
|
+
" arkInferred": string;
|
|
125
|
+
}>;
|
|
126
|
+
digits: string;
|
|
127
|
+
email: string;
|
|
128
|
+
integer: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringInteger.$ & {
|
|
129
|
+
" arkInferred": string;
|
|
130
|
+
}>;
|
|
131
|
+
ip: arktype16.Submodule<arktype_internal_keywords_string_ts10.ip.$ & {
|
|
132
|
+
" arkInferred": string;
|
|
133
|
+
}>;
|
|
134
|
+
json: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringJson.$ & {
|
|
135
|
+
" arkInferred": string;
|
|
136
|
+
}>;
|
|
137
|
+
lower: arktype16.Submodule<arktype_internal_keywords_string_ts10.lower.$ & {
|
|
138
|
+
" arkInferred": (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
139
|
+
}>;
|
|
140
|
+
numeric: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringNumeric.$ & {
|
|
141
|
+
" arkInferred": string;
|
|
142
|
+
}>;
|
|
143
|
+
regex: string;
|
|
144
|
+
semver: string;
|
|
145
|
+
upper: arktype16.Submodule<{
|
|
146
|
+
root: (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
147
|
+
preformatted: string;
|
|
148
|
+
} & {
|
|
149
|
+
" arkInferred": (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
150
|
+
}>;
|
|
151
|
+
url: arktype16.Submodule<arktype_internal_keywords_string_ts10.url.$ & {
|
|
152
|
+
" arkInferred": string;
|
|
153
|
+
}>;
|
|
154
|
+
uuid: arktype16.Submodule<arktype_internal_keywords_string_ts10.uuid.$ & {
|
|
155
|
+
" arkInferred": string;
|
|
156
|
+
}>;
|
|
157
|
+
" arkInferred": string;
|
|
158
|
+
host: string;
|
|
159
|
+
}>;
|
|
160
|
+
number: arktype16.Submodule<{
|
|
161
|
+
NaN: number;
|
|
162
|
+
Infinity: number;
|
|
163
|
+
root: number;
|
|
164
|
+
integer: number;
|
|
165
|
+
" arkInferred": number;
|
|
166
|
+
epoch: number;
|
|
167
|
+
safe: number;
|
|
168
|
+
NegativeInfinity: number;
|
|
169
|
+
port: (In: string) => arktype16.Out<number>;
|
|
170
|
+
}>;
|
|
171
|
+
boolean: (In: boolean | "false" | "true") => arktype16.Out<boolean>;
|
|
167
172
|
}>;
|
|
168
|
-
|
|
173
|
+
//#endregion
|
|
174
|
+
//#region src/errors.d.ts
|
|
169
175
|
declare class ArkEnvError extends Error {
|
|
170
|
-
|
|
176
|
+
constructor(errors: ArkErrors, message?: string);
|
|
171
177
|
}
|
|
172
|
-
|
|
178
|
+
//#endregion
|
|
179
|
+
//#region src/index.d.ts
|
|
173
180
|
/**
|
|
174
181
|
* `arkenv`'s main export, an alias for {@link createEnv}
|
|
175
182
|
*
|
|
176
183
|
* {@link https://arkenv.js.org | ArkEnv} is a typesafe environment variables parser powered by {@link https://arktype.io | ArkType}, TypeScript's 1:1 validator.
|
|
177
184
|
*/
|
|
178
185
|
declare const arkenv: typeof createEnv;
|
|
179
|
-
|
|
180
|
-
export { ArkEnvError, type EnvSchema, createEnv, arkenv as default, type };
|
|
186
|
+
//#endregion
|
|
187
|
+
export { ArkEnvError, type EnvSchema, createEnv, arkenv as default, type };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,84 +1,87 @@
|
|
|
1
|
-
import * as
|
|
2
|
-
import { type as type$1
|
|
3
|
-
import * as
|
|
4
|
-
import * as
|
|
5
|
-
import * as
|
|
1
|
+
import * as arktype16 from "arktype";
|
|
2
|
+
import { ArkErrors, distill, type as type$1 } from "arktype";
|
|
3
|
+
import * as arktype_internal_keywords_string_ts10 from "arktype/internal/keywords/string.ts";
|
|
4
|
+
import * as arktype_internal_attributes_ts5 from "arktype/internal/attributes.ts";
|
|
5
|
+
import * as arktype_internal_type_ts0 from "arktype/internal/type.ts";
|
|
6
6
|
|
|
7
|
+
//#region src/scope.d.ts
|
|
7
8
|
/**
|
|
8
9
|
* The root scope for the ArkEnv library, containing extensions to the ArkType scopes with ArkEnv-specific types like `string.host` and `number.port`.
|
|
9
10
|
*/
|
|
10
|
-
declare const $:
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
trim: arktype.Submodule<arktype_internal_keywords_string_ts.trim.$ & {
|
|
15
|
-
" arkInferred": (In: string) => arktype_internal_attributes_ts.To<string>;
|
|
16
|
-
}>;
|
|
17
|
-
normalize: arktype.Submodule<arktype_internal_keywords_string_ts.normalize.$ & {
|
|
18
|
-
" arkInferred": (In: string) => arktype_internal_attributes_ts.To<string>;
|
|
19
|
-
}>;
|
|
20
|
-
alpha: string;
|
|
21
|
-
alphanumeric: string;
|
|
22
|
-
hex: string;
|
|
23
|
-
base64: arktype.Submodule<{
|
|
24
|
-
root: string;
|
|
25
|
-
url: string;
|
|
26
|
-
} & {
|
|
27
|
-
" arkInferred": string;
|
|
28
|
-
}>;
|
|
29
|
-
capitalize: arktype.Submodule<arktype_internal_keywords_string_ts.capitalize.$ & {
|
|
30
|
-
" arkInferred": (In: string) => arktype_internal_attributes_ts.To<string>;
|
|
31
|
-
}>;
|
|
32
|
-
creditCard: string;
|
|
33
|
-
date: arktype.Submodule<arktype_internal_keywords_string_ts.stringDate.$ & {
|
|
34
|
-
" arkInferred": string;
|
|
35
|
-
}>;
|
|
36
|
-
digits: string;
|
|
37
|
-
email: string;
|
|
38
|
-
integer: arktype.Submodule<arktype_internal_keywords_string_ts.stringInteger.$ & {
|
|
39
|
-
" arkInferred": string;
|
|
40
|
-
}>;
|
|
41
|
-
ip: arktype.Submodule<arktype_internal_keywords_string_ts.ip.$ & {
|
|
42
|
-
" arkInferred": string;
|
|
43
|
-
}>;
|
|
44
|
-
json: arktype.Submodule<arktype_internal_keywords_string_ts.stringJson.$ & {
|
|
45
|
-
" arkInferred": string;
|
|
46
|
-
}>;
|
|
47
|
-
lower: arktype.Submodule<arktype_internal_keywords_string_ts.lower.$ & {
|
|
48
|
-
" arkInferred": (In: string) => arktype_internal_attributes_ts.To<string>;
|
|
49
|
-
}>;
|
|
50
|
-
numeric: arktype.Submodule<arktype_internal_keywords_string_ts.stringNumeric.$ & {
|
|
51
|
-
" arkInferred": string;
|
|
52
|
-
}>;
|
|
53
|
-
regex: string;
|
|
54
|
-
semver: string;
|
|
55
|
-
upper: arktype.Submodule<{
|
|
56
|
-
root: (In: string) => arktype_internal_attributes_ts.To<string>;
|
|
57
|
-
preformatted: string;
|
|
58
|
-
} & {
|
|
59
|
-
" arkInferred": (In: string) => arktype_internal_attributes_ts.To<string>;
|
|
60
|
-
}>;
|
|
61
|
-
url: arktype.Submodule<arktype_internal_keywords_string_ts.url.$ & {
|
|
62
|
-
" arkInferred": string;
|
|
63
|
-
}>;
|
|
64
|
-
uuid: arktype.Submodule<arktype_internal_keywords_string_ts.uuid.$ & {
|
|
65
|
-
" arkInferred": string;
|
|
66
|
-
}>;
|
|
67
|
-
host: string;
|
|
68
|
-
}>;
|
|
69
|
-
number: arktype.Submodule<{
|
|
70
|
-
NaN: number;
|
|
71
|
-
Infinity: number;
|
|
72
|
-
root: number;
|
|
73
|
-
" arkInferred": number;
|
|
74
|
-
integer: number;
|
|
75
|
-
epoch: number;
|
|
76
|
-
safe: number;
|
|
77
|
-
NegativeInfinity: number;
|
|
78
|
-
port: (In: string) => arktype.Out<number>;
|
|
11
|
+
declare const $: arktype16.Scope<{
|
|
12
|
+
string: arktype16.Submodule<{
|
|
13
|
+
trim: arktype16.Submodule<arktype_internal_keywords_string_ts10.trim.$ & {
|
|
14
|
+
" arkInferred": (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
79
15
|
}>;
|
|
16
|
+
normalize: arktype16.Submodule<arktype_internal_keywords_string_ts10.normalize.$ & {
|
|
17
|
+
" arkInferred": (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
18
|
+
}>;
|
|
19
|
+
root: string;
|
|
20
|
+
alpha: string;
|
|
21
|
+
alphanumeric: string;
|
|
22
|
+
hex: string;
|
|
23
|
+
base64: arktype16.Submodule<{
|
|
24
|
+
root: string;
|
|
25
|
+
url: string;
|
|
26
|
+
} & {
|
|
27
|
+
" arkInferred": string;
|
|
28
|
+
}>;
|
|
29
|
+
capitalize: arktype16.Submodule<arktype_internal_keywords_string_ts10.capitalize.$ & {
|
|
30
|
+
" arkInferred": (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
31
|
+
}>;
|
|
32
|
+
creditCard: string;
|
|
33
|
+
date: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringDate.$ & {
|
|
34
|
+
" arkInferred": string;
|
|
35
|
+
}>;
|
|
36
|
+
digits: string;
|
|
37
|
+
email: string;
|
|
38
|
+
integer: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringInteger.$ & {
|
|
39
|
+
" arkInferred": string;
|
|
40
|
+
}>;
|
|
41
|
+
ip: arktype16.Submodule<arktype_internal_keywords_string_ts10.ip.$ & {
|
|
42
|
+
" arkInferred": string;
|
|
43
|
+
}>;
|
|
44
|
+
json: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringJson.$ & {
|
|
45
|
+
" arkInferred": string;
|
|
46
|
+
}>;
|
|
47
|
+
lower: arktype16.Submodule<arktype_internal_keywords_string_ts10.lower.$ & {
|
|
48
|
+
" arkInferred": (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
49
|
+
}>;
|
|
50
|
+
numeric: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringNumeric.$ & {
|
|
51
|
+
" arkInferred": string;
|
|
52
|
+
}>;
|
|
53
|
+
regex: string;
|
|
54
|
+
semver: string;
|
|
55
|
+
upper: arktype16.Submodule<{
|
|
56
|
+
root: (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
57
|
+
preformatted: string;
|
|
58
|
+
} & {
|
|
59
|
+
" arkInferred": (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
60
|
+
}>;
|
|
61
|
+
url: arktype16.Submodule<arktype_internal_keywords_string_ts10.url.$ & {
|
|
62
|
+
" arkInferred": string;
|
|
63
|
+
}>;
|
|
64
|
+
uuid: arktype16.Submodule<arktype_internal_keywords_string_ts10.uuid.$ & {
|
|
65
|
+
" arkInferred": string;
|
|
66
|
+
}>;
|
|
67
|
+
" arkInferred": string;
|
|
68
|
+
host: string;
|
|
69
|
+
}>;
|
|
70
|
+
number: arktype16.Submodule<{
|
|
71
|
+
NaN: number;
|
|
72
|
+
Infinity: number;
|
|
73
|
+
root: number;
|
|
74
|
+
integer: number;
|
|
75
|
+
" arkInferred": number;
|
|
76
|
+
epoch: number;
|
|
77
|
+
safe: number;
|
|
78
|
+
NegativeInfinity: number;
|
|
79
|
+
port: (In: string) => arktype16.Out<number>;
|
|
80
|
+
}>;
|
|
81
|
+
boolean: (In: boolean | "false" | "true") => arktype16.Out<boolean>;
|
|
80
82
|
}>;
|
|
81
|
-
|
|
83
|
+
//#endregion
|
|
84
|
+
//#region src/create-env.d.ts
|
|
82
85
|
type RuntimeEnvironment = Record<string, string | undefined>;
|
|
83
86
|
type EnvSchema<def> = type$1.validate<def, (typeof $)["t"]>;
|
|
84
87
|
/**
|
|
@@ -93,88 +96,92 @@ type EnvSchema<def> = type$1.validate<def, (typeof $)["t"]>;
|
|
|
93
96
|
* @throws An {@link ArkEnvError | error} if the environment variables are invalid.
|
|
94
97
|
*/
|
|
95
98
|
declare function createEnv<const T extends Record<string, unknown>>(def: EnvSchema<T>, env?: RuntimeEnvironment): distill.Out<type$1.infer<T, (typeof $)["t"]>>;
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
" arkInferred": (In: string) => arktype_internal_attributes_ts.To<string>;
|
|
106
|
-
}>;
|
|
107
|
-
alpha: string;
|
|
108
|
-
alphanumeric: string;
|
|
109
|
-
hex: string;
|
|
110
|
-
base64: arktype.Submodule<{
|
|
111
|
-
root: string;
|
|
112
|
-
url: string;
|
|
113
|
-
} & {
|
|
114
|
-
" arkInferred": string;
|
|
115
|
-
}>;
|
|
116
|
-
capitalize: arktype.Submodule<arktype_internal_keywords_string_ts.capitalize.$ & {
|
|
117
|
-
" arkInferred": (In: string) => arktype_internal_attributes_ts.To<string>;
|
|
118
|
-
}>;
|
|
119
|
-
creditCard: string;
|
|
120
|
-
date: arktype.Submodule<arktype_internal_keywords_string_ts.stringDate.$ & {
|
|
121
|
-
" arkInferred": string;
|
|
122
|
-
}>;
|
|
123
|
-
digits: string;
|
|
124
|
-
email: string;
|
|
125
|
-
integer: arktype.Submodule<arktype_internal_keywords_string_ts.stringInteger.$ & {
|
|
126
|
-
" arkInferred": string;
|
|
127
|
-
}>;
|
|
128
|
-
ip: arktype.Submodule<arktype_internal_keywords_string_ts.ip.$ & {
|
|
129
|
-
" arkInferred": string;
|
|
130
|
-
}>;
|
|
131
|
-
json: arktype.Submodule<arktype_internal_keywords_string_ts.stringJson.$ & {
|
|
132
|
-
" arkInferred": string;
|
|
133
|
-
}>;
|
|
134
|
-
lower: arktype.Submodule<arktype_internal_keywords_string_ts.lower.$ & {
|
|
135
|
-
" arkInferred": (In: string) => arktype_internal_attributes_ts.To<string>;
|
|
136
|
-
}>;
|
|
137
|
-
numeric: arktype.Submodule<arktype_internal_keywords_string_ts.stringNumeric.$ & {
|
|
138
|
-
" arkInferred": string;
|
|
139
|
-
}>;
|
|
140
|
-
regex: string;
|
|
141
|
-
semver: string;
|
|
142
|
-
upper: arktype.Submodule<{
|
|
143
|
-
root: (In: string) => arktype_internal_attributes_ts.To<string>;
|
|
144
|
-
preformatted: string;
|
|
145
|
-
} & {
|
|
146
|
-
" arkInferred": (In: string) => arktype_internal_attributes_ts.To<string>;
|
|
147
|
-
}>;
|
|
148
|
-
url: arktype.Submodule<arktype_internal_keywords_string_ts.url.$ & {
|
|
149
|
-
" arkInferred": string;
|
|
150
|
-
}>;
|
|
151
|
-
uuid: arktype.Submodule<arktype_internal_keywords_string_ts.uuid.$ & {
|
|
152
|
-
" arkInferred": string;
|
|
153
|
-
}>;
|
|
154
|
-
host: string;
|
|
155
|
-
}>;
|
|
156
|
-
number: arktype.Submodule<{
|
|
157
|
-
NaN: number;
|
|
158
|
-
Infinity: number;
|
|
159
|
-
root: number;
|
|
160
|
-
" arkInferred": number;
|
|
161
|
-
integer: number;
|
|
162
|
-
epoch: number;
|
|
163
|
-
safe: number;
|
|
164
|
-
NegativeInfinity: number;
|
|
165
|
-
port: (In: string) => arktype.Out<number>;
|
|
99
|
+
//#endregion
|
|
100
|
+
//#region src/type.d.ts
|
|
101
|
+
declare const type: arktype_internal_type_ts0.TypeParser<{
|
|
102
|
+
string: arktype16.Submodule<{
|
|
103
|
+
trim: arktype16.Submodule<arktype_internal_keywords_string_ts10.trim.$ & {
|
|
104
|
+
" arkInferred": (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
105
|
+
}>;
|
|
106
|
+
normalize: arktype16.Submodule<arktype_internal_keywords_string_ts10.normalize.$ & {
|
|
107
|
+
" arkInferred": (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
166
108
|
}>;
|
|
109
|
+
root: string;
|
|
110
|
+
alpha: string;
|
|
111
|
+
alphanumeric: string;
|
|
112
|
+
hex: string;
|
|
113
|
+
base64: arktype16.Submodule<{
|
|
114
|
+
root: string;
|
|
115
|
+
url: string;
|
|
116
|
+
} & {
|
|
117
|
+
" arkInferred": string;
|
|
118
|
+
}>;
|
|
119
|
+
capitalize: arktype16.Submodule<arktype_internal_keywords_string_ts10.capitalize.$ & {
|
|
120
|
+
" arkInferred": (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
121
|
+
}>;
|
|
122
|
+
creditCard: string;
|
|
123
|
+
date: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringDate.$ & {
|
|
124
|
+
" arkInferred": string;
|
|
125
|
+
}>;
|
|
126
|
+
digits: string;
|
|
127
|
+
email: string;
|
|
128
|
+
integer: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringInteger.$ & {
|
|
129
|
+
" arkInferred": string;
|
|
130
|
+
}>;
|
|
131
|
+
ip: arktype16.Submodule<arktype_internal_keywords_string_ts10.ip.$ & {
|
|
132
|
+
" arkInferred": string;
|
|
133
|
+
}>;
|
|
134
|
+
json: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringJson.$ & {
|
|
135
|
+
" arkInferred": string;
|
|
136
|
+
}>;
|
|
137
|
+
lower: arktype16.Submodule<arktype_internal_keywords_string_ts10.lower.$ & {
|
|
138
|
+
" arkInferred": (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
139
|
+
}>;
|
|
140
|
+
numeric: arktype16.Submodule<arktype_internal_keywords_string_ts10.stringNumeric.$ & {
|
|
141
|
+
" arkInferred": string;
|
|
142
|
+
}>;
|
|
143
|
+
regex: string;
|
|
144
|
+
semver: string;
|
|
145
|
+
upper: arktype16.Submodule<{
|
|
146
|
+
root: (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
147
|
+
preformatted: string;
|
|
148
|
+
} & {
|
|
149
|
+
" arkInferred": (In: string) => arktype_internal_attributes_ts5.To<string>;
|
|
150
|
+
}>;
|
|
151
|
+
url: arktype16.Submodule<arktype_internal_keywords_string_ts10.url.$ & {
|
|
152
|
+
" arkInferred": string;
|
|
153
|
+
}>;
|
|
154
|
+
uuid: arktype16.Submodule<arktype_internal_keywords_string_ts10.uuid.$ & {
|
|
155
|
+
" arkInferred": string;
|
|
156
|
+
}>;
|
|
157
|
+
" arkInferred": string;
|
|
158
|
+
host: string;
|
|
159
|
+
}>;
|
|
160
|
+
number: arktype16.Submodule<{
|
|
161
|
+
NaN: number;
|
|
162
|
+
Infinity: number;
|
|
163
|
+
root: number;
|
|
164
|
+
integer: number;
|
|
165
|
+
" arkInferred": number;
|
|
166
|
+
epoch: number;
|
|
167
|
+
safe: number;
|
|
168
|
+
NegativeInfinity: number;
|
|
169
|
+
port: (In: string) => arktype16.Out<number>;
|
|
170
|
+
}>;
|
|
171
|
+
boolean: (In: boolean | "false" | "true") => arktype16.Out<boolean>;
|
|
167
172
|
}>;
|
|
168
|
-
|
|
173
|
+
//#endregion
|
|
174
|
+
//#region src/errors.d.ts
|
|
169
175
|
declare class ArkEnvError extends Error {
|
|
170
|
-
|
|
176
|
+
constructor(errors: ArkErrors, message?: string);
|
|
171
177
|
}
|
|
172
|
-
|
|
178
|
+
//#endregion
|
|
179
|
+
//#region src/index.d.ts
|
|
173
180
|
/**
|
|
174
181
|
* `arkenv`'s main export, an alias for {@link createEnv}
|
|
175
182
|
*
|
|
176
183
|
* {@link https://arkenv.js.org | ArkEnv} is a typesafe environment variables parser powered by {@link https://arktype.io | ArkType}, TypeScript's 1:1 validator.
|
|
177
184
|
*/
|
|
178
185
|
declare const arkenv: typeof createEnv;
|
|
179
|
-
|
|
180
|
-
export { ArkEnvError, type EnvSchema, createEnv, arkenv as default, type };
|
|
186
|
+
//#endregion
|
|
187
|
+
export { ArkEnvError, type EnvSchema, createEnv, arkenv as default, type };
|
package/dist/index.js
CHANGED
|
@@ -1,84 +1,108 @@
|
|
|
1
|
-
|
|
2
|
-
import {
|
|
1
|
+
import { scope, type as type$1 } from "arktype";
|
|
2
|
+
import { styleText } from "node:util";
|
|
3
3
|
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
4
|
+
//#region src/utils.ts
|
|
5
|
+
/**
|
|
6
|
+
* Indent a string by a given amount
|
|
7
|
+
* @param str - The string to indent
|
|
8
|
+
* @param amt - The amount to indent by, defaults to 2
|
|
9
|
+
* @param options - {@link IndentOptions}
|
|
10
|
+
* @returns The indented string
|
|
11
|
+
*/
|
|
12
|
+
const indent = (str, amt = 2, { dontDetectNewlines = false } = {}) => {
|
|
13
|
+
if (!dontDetectNewlines) return str.split("\n").map((line) => `${" ".repeat(amt)}${line}`).join("\n");
|
|
14
|
+
return `${" ".repeat(amt)}${str}`;
|
|
14
15
|
};
|
|
15
16
|
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
17
|
+
//#endregion
|
|
18
|
+
//#region src/errors.ts
|
|
19
|
+
/**
|
|
20
|
+
* Format the errors returned by ArkType to be more readable
|
|
21
|
+
* @param errors - The errors returned by ArkType
|
|
22
|
+
* @returns A string of the formatted errors
|
|
23
|
+
*/
|
|
24
|
+
const formatErrors = (errors) => Object.entries(errors.byPath).map(([path, error]) => {
|
|
25
|
+
const messageWithoutPath = error.message.startsWith(path) ? error.message.slice(path.length) : error.message;
|
|
26
|
+
const valueMatch = messageWithoutPath.match(/\(was "([^"]+)"\)/);
|
|
27
|
+
const formattedMessage = valueMatch ? messageWithoutPath.replace(`(was "${valueMatch[1]}")`, `(was ${styleText("cyan", `"${valueMatch[1]}"`)})`) : messageWithoutPath;
|
|
28
|
+
return `${styleText("yellow", path)}${formattedMessage}`;
|
|
25
29
|
}).join("\n");
|
|
26
30
|
var ArkEnvError = class extends Error {
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
this.name = "ArkEnvError";
|
|
32
|
-
}
|
|
31
|
+
constructor(errors, message = "Errors found while validating environment variables") {
|
|
32
|
+
super(`${styleText("red", message)}\n${indent(formatErrors(errors))}\n`);
|
|
33
|
+
this.name = "ArkEnvError";
|
|
34
|
+
}
|
|
33
35
|
};
|
|
34
36
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
if (!isInteger || !isBetween) {
|
|
45
|
-
ctx.mustBe("an integer between 0 and 65535");
|
|
46
|
-
}
|
|
47
|
-
return asNumber;
|
|
37
|
+
//#endregion
|
|
38
|
+
//#region src/types.ts
|
|
39
|
+
/**
|
|
40
|
+
* A `string` that can be parsed into a number between 0 and 65535
|
|
41
|
+
*/
|
|
42
|
+
const port = type$1("string", "=>", (data, ctx) => {
|
|
43
|
+
const asNumber = Number.parseInt(data, 10);
|
|
44
|
+
if (!Number.isInteger(asNumber) || !(0 <= asNumber && asNumber <= 65535)) ctx.mustBe("an integer between 0 and 65535");
|
|
45
|
+
return asNumber;
|
|
48
46
|
});
|
|
49
|
-
|
|
47
|
+
/**
|
|
48
|
+
* An IP address or `"localhost"`
|
|
49
|
+
*/
|
|
50
|
+
const host = type$1("string.ip | 'localhost'");
|
|
51
|
+
/**
|
|
52
|
+
* A boolean that accepts string values and converts them to boolean
|
|
53
|
+
* Accepts "true" or "false" strings and converts them to actual boolean values
|
|
54
|
+
*/
|
|
55
|
+
const boolean = type$1("'true' | 'false' | true | false", "=>", (str) => str === "true" || str === true);
|
|
50
56
|
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
57
|
+
//#endregion
|
|
58
|
+
//#region src/scope.ts
|
|
59
|
+
/**
|
|
60
|
+
* The root scope for the ArkEnv library, containing extensions to the ArkType scopes with ArkEnv-specific types like `string.host` and `number.port`.
|
|
61
|
+
*/
|
|
62
|
+
const $ = scope({
|
|
63
|
+
string: type$1.module({
|
|
64
|
+
...type$1.keywords.string,
|
|
65
|
+
host
|
|
66
|
+
}),
|
|
67
|
+
number: type$1.module({
|
|
68
|
+
...type$1.keywords.number,
|
|
69
|
+
port
|
|
70
|
+
}),
|
|
71
|
+
boolean
|
|
61
72
|
});
|
|
62
73
|
|
|
63
|
-
|
|
74
|
+
//#endregion
|
|
75
|
+
//#region src/create-env.ts
|
|
76
|
+
/**
|
|
77
|
+
* TODO: If possible, find a better type than "const T extends Record<string, unknown>",
|
|
78
|
+
* and be as close as possible to the type accepted by ArkType's `type`.
|
|
79
|
+
*/
|
|
80
|
+
/**
|
|
81
|
+
* Create an environment variables object from a schema and an environment
|
|
82
|
+
* @param def - The environment variable schema
|
|
83
|
+
* @param env - The environment variables to validate, defaults to `process.env`
|
|
84
|
+
* @returns The validated environment variable schema
|
|
85
|
+
* @throws An {@link ArkEnvError | error} if the environment variables are invalid.
|
|
86
|
+
*/
|
|
64
87
|
function createEnv(def, env = process.env) {
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
throw new ArkEnvError(validatedEnv);
|
|
69
|
-
}
|
|
70
|
-
return validatedEnv;
|
|
88
|
+
const validatedEnv = $.type.raw(def)(env);
|
|
89
|
+
if (validatedEnv instanceof type$1.errors) throw new ArkEnvError(validatedEnv);
|
|
90
|
+
return validatedEnv;
|
|
71
91
|
}
|
|
72
92
|
|
|
73
|
-
|
|
74
|
-
|
|
93
|
+
//#endregion
|
|
94
|
+
//#region src/type.ts
|
|
95
|
+
const type = $.type;
|
|
75
96
|
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
export {
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
97
|
+
//#endregion
|
|
98
|
+
//#region src/index.ts
|
|
99
|
+
/**
|
|
100
|
+
* `arkenv`'s main export, an alias for {@link createEnv}
|
|
101
|
+
*
|
|
102
|
+
* {@link https://arkenv.js.org | ArkEnv} is a typesafe environment variables parser powered by {@link https://arktype.io | ArkType}, TypeScript's 1:1 validator.
|
|
103
|
+
*/
|
|
104
|
+
const arkenv = createEnv;
|
|
105
|
+
var src_default = arkenv;
|
|
106
|
+
|
|
107
|
+
//#endregion
|
|
108
|
+
export { ArkEnvError, createEnv, src_default as default, type };
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "arkenv",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.7.
|
|
4
|
+
"version": "0.7.3",
|
|
5
5
|
"main": "./dist/index.cjs",
|
|
6
6
|
"module": "./dist/index.js",
|
|
7
7
|
"types": "./dist/index.d.ts",
|
|
@@ -33,18 +33,19 @@
|
|
|
33
33
|
"devDependencies": {
|
|
34
34
|
"@ark/schema": "^0.49.0",
|
|
35
35
|
"@types/node": "24.6.2",
|
|
36
|
-
"
|
|
37
|
-
"typescript": "^5.9.3"
|
|
36
|
+
"tsdown": "^0.15.6",
|
|
37
|
+
"typescript": "^5.9.3",
|
|
38
|
+
"vitest": "^3.2.4"
|
|
38
39
|
},
|
|
39
40
|
"peerDependencies": {
|
|
40
41
|
"arktype": "^2.1.22"
|
|
41
42
|
},
|
|
42
43
|
"scripts": {
|
|
43
|
-
"build": "
|
|
44
|
+
"build": "tsdown",
|
|
44
45
|
"test:once": "pnpm test",
|
|
45
46
|
"typecheck": "tsc --noEmit",
|
|
46
47
|
"clean": "rimraf dist node_modules",
|
|
47
|
-
"test": "
|
|
48
|
+
"test": "vitest",
|
|
48
49
|
"fix": "pnpm -w run fix"
|
|
49
50
|
}
|
|
50
51
|
}
|