@dbx-tools/shared-core 0.6.82 → 0.6.85
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 +0 -40
- package/index.ts +2 -3
- package/lib/index.d.ts +2 -3
- package/lib/index.js +2 -3
- package/lib/src/context.d.ts +64 -0
- package/lib/src/context.js +148 -0
- package/lib/src/object.d.ts +2 -2
- package/lib/src/object.js +3 -3
- package/lib/tsconfig.tsbuildinfo +1 -1
- package/package.json +1 -1
- package/src/context.ts +164 -0
- package/src/object.ts +4 -3
- package/lib/src/env.d.ts +0 -101
- package/lib/src/env.js +0 -153
- package/src/env.ts +0 -177
package/src/context.ts
ADDED
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The ambient CONTEXT a cached value belongs to, and a cache keyed by it.
|
|
3
|
+
*
|
|
4
|
+
* Most of the expensive lookups in this repo are pure functions of the directory
|
|
5
|
+
* (or the page) they were asked from: `npm prefix`, `git rev-parse`, a `.env`
|
|
6
|
+
* file, `databricks bundle validate`. Memoizing them with
|
|
7
|
+
* {@link functionModule.memoize} is wrong in exactly one situation, and it is the
|
|
8
|
+
* situation a CLI hits: the process changes directory, and the cached answer now
|
|
9
|
+
* describes somewhere else. Every caller therefore grew the same guard - resolve
|
|
10
|
+
* `cwd`, compare it against `process.cwd()`, and skip the cache when they differ
|
|
11
|
+
* (see the `cacheEnabled` dance this module replaced in node-core's `project`).
|
|
12
|
+
*
|
|
13
|
+
* This is that guard, once. A cache slot stores the context it was loaded under,
|
|
14
|
+
* so a context change (a moved `cwd`, a different origin) MISSES rather than
|
|
15
|
+
* returns a stale value, and a lookup for some OTHER directory is not cached at
|
|
16
|
+
* all - one off-context call must not evict or poison the hot path.
|
|
17
|
+
*
|
|
18
|
+
* The context is the process working directory on a server and
|
|
19
|
+
* `location.origin` in a browser, whichever this runtime has. Browser-safe:
|
|
20
|
+
* `process` and `location` are reached through `globalThis` and guarded, so this
|
|
21
|
+
* module needs no Node types and simply has no context off-process.
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* const roots = context.cached(["project", "npm", "prefix"], (cwd) =>
|
|
25
|
+
* spawnSync("npm", ["prefix"], { cwd }),
|
|
26
|
+
* );
|
|
27
|
+
*
|
|
28
|
+
* @module
|
|
29
|
+
*/
|
|
30
|
+
|
|
31
|
+
import type { OneOrMany } from "./object.ts";
|
|
32
|
+
|
|
33
|
+
/** A loader for a cached value; receives the resolved context. */
|
|
34
|
+
export type ContextLoader<T> = (context: string | undefined) => T;
|
|
35
|
+
|
|
36
|
+
interface CacheEntry {
|
|
37
|
+
context: string;
|
|
38
|
+
value: unknown;
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
const CACHE = new Map<string, CacheEntry>();
|
|
42
|
+
|
|
43
|
+
/**
|
|
44
|
+
* The current context: the process working directory, else `location.origin`,
|
|
45
|
+
* else `undefined` (a runtime with neither, where nothing is cacheable).
|
|
46
|
+
*/
|
|
47
|
+
export function getContext(): string | undefined {
|
|
48
|
+
for (const context of getContexts()) return context;
|
|
49
|
+
return undefined;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
/**
|
|
53
|
+
* Whether `value` names a context this runtime is CURRENTLY in - the live `cwd`
|
|
54
|
+
* or origin. This is the cacheability test: a value loaded for some other
|
|
55
|
+
* directory is correct but not shareable, so it is never stored.
|
|
56
|
+
*/
|
|
57
|
+
export function isContext(value: unknown): boolean {
|
|
58
|
+
const context = toContext(value);
|
|
59
|
+
if (context === undefined) return false;
|
|
60
|
+
for (const candidate of getContexts()) {
|
|
61
|
+
if (candidate === context) return true;
|
|
62
|
+
}
|
|
63
|
+
return false;
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
/**
|
|
67
|
+
* Load `name` through `loader`, reusing the cached value while the context is
|
|
68
|
+
* unchanged.
|
|
69
|
+
*
|
|
70
|
+
* `context` selects what the value is loaded FOR: omitted, `null`, or `"."` mean
|
|
71
|
+
* the current context. It is passed straight to `loader`, so a loader never has
|
|
72
|
+
* to reach for `process.cwd()` itself.
|
|
73
|
+
*
|
|
74
|
+
* Caching happens only when the resolved context is one this runtime is in
|
|
75
|
+
* ({@link isContext}), so `cached(name, loader, "/somewhere/else")` always calls
|
|
76
|
+
* `loader` and stores nothing. A stored entry remembers its context and is
|
|
77
|
+
* discarded on the next call once that context changes. A thrown error is never
|
|
78
|
+
* cached; a rejected promise evicts its entry so a later call retries.
|
|
79
|
+
*
|
|
80
|
+
* `name` identifies the slot and must be stable across calls - pass a
|
|
81
|
+
* module-qualified list of string parts (`["project", command, ...args]`) so two
|
|
82
|
+
* modules cannot collide on one slot.
|
|
83
|
+
*/
|
|
84
|
+
export function cached<T>(
|
|
85
|
+
name: OneOrMany<string>,
|
|
86
|
+
loader: ContextLoader<T>,
|
|
87
|
+
context?: string | null,
|
|
88
|
+
): T {
|
|
89
|
+
const resolved = toContext(context) ?? getContext();
|
|
90
|
+
const key = resolved !== undefined && isContext(resolved) ? cacheKey(name) : undefined;
|
|
91
|
+
if (key !== undefined) {
|
|
92
|
+
const entry = CACHE.get(key);
|
|
93
|
+
if (entry && entry.context === resolved) return entry.value as T;
|
|
94
|
+
}
|
|
95
|
+
const value = loader(resolved);
|
|
96
|
+
if (key !== undefined && resolved !== undefined) {
|
|
97
|
+
const entry: CacheEntry = { context: resolved, value };
|
|
98
|
+
CACHE.set(key, entry);
|
|
99
|
+
if (isThenable(value)) {
|
|
100
|
+
void Promise.resolve(value).catch(() => {
|
|
101
|
+
if (CACHE.get(key) === entry) CACHE.delete(key);
|
|
102
|
+
});
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
return value;
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
/** Drop one cached slot, or the whole cache when `name` is omitted. */
|
|
109
|
+
export function clear(name?: OneOrMany<string>): void {
|
|
110
|
+
if (name === undefined) CACHE.clear();
|
|
111
|
+
else CACHE.delete(cacheKey(name));
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
/**
|
|
115
|
+
* Canonical slot key. `JSON.stringify` over the parts rather than a hash: the
|
|
116
|
+
* parts are already strings, and an exact key cannot collide two unrelated
|
|
117
|
+
* lookups onto one slot the way a truncated digest can.
|
|
118
|
+
*/
|
|
119
|
+
function cacheKey(name: OneOrMany<string>): string {
|
|
120
|
+
return JSON.stringify(typeof name === "string" ? [name] : name);
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
/**
|
|
124
|
+
* Every context this runtime reports, in precedence order. A server yields its
|
|
125
|
+
* `cwd`; a browser yields `location.origin`. A hybrid (a worker with both) yields
|
|
126
|
+
* both, which is what makes {@link isContext} accept either.
|
|
127
|
+
*/
|
|
128
|
+
function* getContexts(): Generator<string, void, void> {
|
|
129
|
+
const global = globalThis as {
|
|
130
|
+
process?: { cwd?: () => string };
|
|
131
|
+
location?: { origin?: string };
|
|
132
|
+
};
|
|
133
|
+
const cwd = global.process?.cwd;
|
|
134
|
+
if (typeof cwd === "function") {
|
|
135
|
+
let current: unknown;
|
|
136
|
+
try {
|
|
137
|
+
current = cwd();
|
|
138
|
+
} catch {
|
|
139
|
+
current = undefined;
|
|
140
|
+
}
|
|
141
|
+
const context = toContext(current);
|
|
142
|
+
if (context !== undefined) yield context;
|
|
143
|
+
}
|
|
144
|
+
const origin = toContext(global.location?.origin);
|
|
145
|
+
if (origin !== undefined) yield origin;
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
/** A non-blank string, with `"."` treated as "the current context" (unresolved). */
|
|
149
|
+
function toContext(value: unknown): string | undefined {
|
|
150
|
+
if (typeof value !== "string") return undefined;
|
|
151
|
+
const trimmed = value.trim();
|
|
152
|
+
return trimmed && trimmed !== "." ? trimmed : undefined;
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
/** Duck-type any value with a callable `.then` as a thenable. */
|
|
156
|
+
function isThenable(value: unknown): value is PromiseLike<unknown> {
|
|
157
|
+
return (
|
|
158
|
+
value instanceof Promise ||
|
|
159
|
+
(typeof value === "object" &&
|
|
160
|
+
value !== null &&
|
|
161
|
+
"then" in value &&
|
|
162
|
+
typeof (value as PromiseLike<unknown>).then === "function")
|
|
163
|
+
);
|
|
164
|
+
}
|
package/src/object.ts
CHANGED
|
@@ -26,7 +26,8 @@
|
|
|
26
26
|
/** Lazy sequence over iterable source(s). See {@link sequence}. */
|
|
27
27
|
export type Sequence<T> = SequenceImpl<T>;
|
|
28
28
|
|
|
29
|
-
type SequenceSource<T> =
|
|
29
|
+
type SequenceSource<T> =
|
|
30
|
+
Iterable<T> | ReadonlyMap<unknown, T> | OneOrMany<T> | Extract<T, string> | null | undefined;
|
|
30
31
|
|
|
31
32
|
/**
|
|
32
33
|
* A non-scalar {@link Iterable} - one to treat as a collection of elements
|
|
@@ -159,7 +160,7 @@ function sequenceSources<T>(...sources: SequenceSource<T>[]): Iterable<T>[] {
|
|
|
159
160
|
const sourceIterables: Iterable<T>[] = [];
|
|
160
161
|
for (const source of sources) {
|
|
161
162
|
if (source == null || (isCollection(source) && isEmpty(source))) continue;
|
|
162
|
-
sourceIterables.push(values(source));
|
|
163
|
+
sourceIterables.push(isContainer<T>(source) ? values(source) : [source as T]);
|
|
163
164
|
}
|
|
164
165
|
return sourceIterables;
|
|
165
166
|
}
|
|
@@ -979,7 +980,7 @@ export function toStableKey(value: unknown, seen: Set<object> = new Set()): stri
|
|
|
979
980
|
*
|
|
980
981
|
* @example
|
|
981
982
|
* return {
|
|
982
|
-
* ...optional("appId",
|
|
983
|
+
* ...optional("appId", configuredAppId),
|
|
983
984
|
* ...optional("endpoint", config.endpoint),
|
|
984
985
|
* };
|
|
985
986
|
*/
|
package/lib/src/env.d.ts
DELETED
|
@@ -1,101 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Reading configuration out of the environment.
|
|
3
|
-
*
|
|
4
|
-
* Every plugin config in this repo resolves the same way: take the typed
|
|
5
|
-
* config value when the caller set one, else fall back to one or more
|
|
6
|
-
* environment variables, else a default. Written by hand that becomes a
|
|
7
|
-
* `config.x ?? Number(process.env.X)` chain per field, and each package grew
|
|
8
|
-
* its own `fromEnv` / `resolvePositiveInt` helper with slightly different
|
|
9
|
-
* coercion rules. These are those helpers, once.
|
|
10
|
-
*
|
|
11
|
-
* Browser-safe: `process` is reached through `globalThis` and guarded, so this
|
|
12
|
-
* module needs no Node types and is inert in a browser (every lookup misses and
|
|
13
|
-
* the caller's fallback applies).
|
|
14
|
-
*
|
|
15
|
-
* @module
|
|
16
|
-
*/
|
|
17
|
-
/** Highest valid TCP port number. */
|
|
18
|
-
export declare const MAX_TCP_PORT = 65535;
|
|
19
|
-
/** One env var name, or several tried in order. */
|
|
20
|
-
export type EnvKey = string | readonly string[];
|
|
21
|
-
/**
|
|
22
|
-
* Detect the Databricks App runtime from its required environment shape.
|
|
23
|
-
*
|
|
24
|
-
* A valid app has a non-empty name, an HTTP(S) workspace host, and a valid
|
|
25
|
-
* `DATABRICKS_APP_PORT`. Reads the ambient environment when none is supplied.
|
|
26
|
-
*/
|
|
27
|
-
export declare function isAppEnv(source?: Record<string, string | undefined>): boolean;
|
|
28
|
-
/**
|
|
29
|
-
* The PRIMARY (current, non-deprecated) name in an {@link EnvKey}.
|
|
30
|
-
*
|
|
31
|
-
* Use this when naming a variable in a log line or error rather than indexing
|
|
32
|
-
* `keys[0]`: an {@link EnvKey} may be a bare string, and `"TUNNEL_X"[0]` is the
|
|
33
|
-
* character `"T"`, which produces a message naming a variable that does not
|
|
34
|
-
* exist. Returns `""` only for an empty list, which no caller should have.
|
|
35
|
-
*
|
|
36
|
-
* @example
|
|
37
|
-
* logger.warn(`${env.name(JWT_SECRET_ENV)} is not set`);
|
|
38
|
-
*/
|
|
39
|
-
export declare function name(keys: EnvKey): string;
|
|
40
|
-
/**
|
|
41
|
-
* First non-empty value among `keys`, trimmed, else `null`.
|
|
42
|
-
*
|
|
43
|
-
* Several names for one setting is the norm (a package-specific variable plus
|
|
44
|
-
* the Databricks-standard one), so `keys` is order-sensitive: earlier names win.
|
|
45
|
-
*
|
|
46
|
-
* @example
|
|
47
|
-
* env.text(["TEAMS_APP_ID", "MICROSOFT_APP_ID"]);
|
|
48
|
-
*/
|
|
49
|
-
export declare function text(keys: EnvKey): string | null;
|
|
50
|
-
/**
|
|
51
|
-
* Resolve a string setting: `configured` when set and non-empty, else the first
|
|
52
|
-
* non-empty variable among `keys`, else `null`.
|
|
53
|
-
*
|
|
54
|
-
* @example
|
|
55
|
-
* env.string(config.host, "SMTP_HOST");
|
|
56
|
-
*/
|
|
57
|
-
export declare function string(configured: unknown, keys: EnvKey): string | null;
|
|
58
|
-
/**
|
|
59
|
-
* Resolve a boolean setting through {@link toBoolean}, so the loose spellings an
|
|
60
|
-
* env var actually carries (`1`, `on`, `yes`, ...) are accepted. Returns
|
|
61
|
-
* `undefined` when neither source is interpretable, letting the caller pick a
|
|
62
|
-
* default with `??`.
|
|
63
|
-
*
|
|
64
|
-
* @example
|
|
65
|
-
* env.boolean(config.fuzzy, "WEB_SEARCH_FUZZY") ?? true;
|
|
66
|
-
*/
|
|
67
|
-
export declare function boolean(configured: unknown, keys: EnvKey): boolean | undefined;
|
|
68
|
-
/**
|
|
69
|
-
* Resolve a positive-number setting that may be fractional (a score threshold,
|
|
70
|
-
* a ratio): `configured` when it is a finite number greater than zero, else the
|
|
71
|
-
* first variable among `keys` that parses that way, else `fallback`.
|
|
72
|
-
*
|
|
73
|
-
* {@link positiveInt} is the right choice for a count; this one keeps the
|
|
74
|
-
* fraction, so a `0.4` threshold does not floor to `0`.
|
|
75
|
-
*
|
|
76
|
-
* @example
|
|
77
|
-
* env.positiveNumber(config.fuzzyThreshold, "SEARCH_FUZZY_THRESHOLD", 0.4);
|
|
78
|
-
*/
|
|
79
|
-
export declare function positiveNumber(configured: unknown, keys: EnvKey, fallback: number): number;
|
|
80
|
-
/**
|
|
81
|
-
* Resolve a positive-integer setting (a port, timeout, page size, or cap):
|
|
82
|
-
* `configured` when it is a finite number greater than zero, else the first
|
|
83
|
-
* variable among `keys` that parses that way, else `fallback`. Floored, so a
|
|
84
|
-
* fractional value can't leak into a count.
|
|
85
|
-
*
|
|
86
|
-
* A non-numeric or non-positive value is treated as absent rather than fatal -
|
|
87
|
-
* these are ceilings and timeouts where a sane default beats a boot failure.
|
|
88
|
-
*
|
|
89
|
-
* @example
|
|
90
|
-
* env.positiveInt(config.timeoutMs, "SEARCH_TIMEOUT_MS", 30_000);
|
|
91
|
-
*/
|
|
92
|
-
export declare function positiveInt(configured: unknown, keys: EnvKey, fallback: number): number;
|
|
93
|
-
/**
|
|
94
|
-
* Resolve a list setting through {@link parseList}, so an array from typed
|
|
95
|
-
* config and a `"a, b c"` env string normalize identically. Returns `[]` when
|
|
96
|
-
* neither source has entries.
|
|
97
|
-
*
|
|
98
|
-
* @example
|
|
99
|
-
* env.list(config.modelFallbacks, "WEB_SEARCH_MODEL_FALLBACKS");
|
|
100
|
-
*/
|
|
101
|
-
export declare function list(configured: string | readonly string[] | undefined | null, keys: EnvKey, transform?: (entry: string) => string): string[];
|
package/lib/src/env.js
DELETED
|
@@ -1,153 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Reading configuration out of the environment.
|
|
3
|
-
*
|
|
4
|
-
* Every plugin config in this repo resolves the same way: take the typed
|
|
5
|
-
* config value when the caller set one, else fall back to one or more
|
|
6
|
-
* environment variables, else a default. Written by hand that becomes a
|
|
7
|
-
* `config.x ?? Number(process.env.X)` chain per field, and each package grew
|
|
8
|
-
* its own `fromEnv` / `resolvePositiveInt` helper with slightly different
|
|
9
|
-
* coercion rules. These are those helpers, once.
|
|
10
|
-
*
|
|
11
|
-
* Browser-safe: `process` is reached through `globalThis` and guarded, so this
|
|
12
|
-
* module needs no Node types and is inert in a browser (every lookup misses and
|
|
13
|
-
* the caller's fallback applies).
|
|
14
|
-
*
|
|
15
|
-
* @module
|
|
16
|
-
*/
|
|
17
|
-
import { toBoolean, toNumber } from "./object.js";
|
|
18
|
-
import { parseList, trimToNull } from "./string.js";
|
|
19
|
-
/** Highest valid TCP port number. */
|
|
20
|
-
export const MAX_TCP_PORT = 65_535;
|
|
21
|
-
/** The ambient environment, or `{}` off-process (a browser). */
|
|
22
|
-
function environment() {
|
|
23
|
-
return globalThis.process?.env ?? {};
|
|
24
|
-
}
|
|
25
|
-
/**
|
|
26
|
-
* Detect the Databricks App runtime from its required environment shape.
|
|
27
|
-
*
|
|
28
|
-
* A valid app has a non-empty name, an HTTP(S) workspace host, and a valid
|
|
29
|
-
* `DATABRICKS_APP_PORT`. Reads the ambient environment when none is supplied.
|
|
30
|
-
*/
|
|
31
|
-
export function isAppEnv(source = environment()) {
|
|
32
|
-
const appName = source.DATABRICKS_APP_NAME?.trim();
|
|
33
|
-
const host = source.DATABRICKS_HOST?.trim();
|
|
34
|
-
const port = source.DATABRICKS_APP_PORT?.trim();
|
|
35
|
-
if (!appName || !host || !port)
|
|
36
|
-
return false;
|
|
37
|
-
try {
|
|
38
|
-
if (!["http:", "https:"].includes(new URL(host).protocol))
|
|
39
|
-
return false;
|
|
40
|
-
}
|
|
41
|
-
catch {
|
|
42
|
-
return false;
|
|
43
|
-
}
|
|
44
|
-
const portNumber = toNumber(port);
|
|
45
|
-
return (portNumber !== undefined &&
|
|
46
|
-
Number.isInteger(portNumber) &&
|
|
47
|
-
portNumber >= 1 &&
|
|
48
|
-
portNumber <= MAX_TCP_PORT);
|
|
49
|
-
}
|
|
50
|
-
/**
|
|
51
|
-
* The PRIMARY (current, non-deprecated) name in an {@link EnvKey}.
|
|
52
|
-
*
|
|
53
|
-
* Use this when naming a variable in a log line or error rather than indexing
|
|
54
|
-
* `keys[0]`: an {@link EnvKey} may be a bare string, and `"TUNNEL_X"[0]` is the
|
|
55
|
-
* character `"T"`, which produces a message naming a variable that does not
|
|
56
|
-
* exist. Returns `""` only for an empty list, which no caller should have.
|
|
57
|
-
*
|
|
58
|
-
* @example
|
|
59
|
-
* logger.warn(`${env.name(JWT_SECRET_ENV)} is not set`);
|
|
60
|
-
*/
|
|
61
|
-
export function name(keys) {
|
|
62
|
-
return typeof keys === "string" ? keys : (keys[0] ?? "");
|
|
63
|
-
}
|
|
64
|
-
/**
|
|
65
|
-
* First non-empty value among `keys`, trimmed, else `null`.
|
|
66
|
-
*
|
|
67
|
-
* Several names for one setting is the norm (a package-specific variable plus
|
|
68
|
-
* the Databricks-standard one), so `keys` is order-sensitive: earlier names win.
|
|
69
|
-
*
|
|
70
|
-
* @example
|
|
71
|
-
* env.text(["TEAMS_APP_ID", "MICROSOFT_APP_ID"]);
|
|
72
|
-
*/
|
|
73
|
-
export function text(keys) {
|
|
74
|
-
const env = environment();
|
|
75
|
-
for (const key of typeof keys === "string" ? [keys] : keys) {
|
|
76
|
-
const value = trimToNull(env[key]);
|
|
77
|
-
if (value !== null)
|
|
78
|
-
return value;
|
|
79
|
-
}
|
|
80
|
-
return null;
|
|
81
|
-
}
|
|
82
|
-
/**
|
|
83
|
-
* Resolve a string setting: `configured` when set and non-empty, else the first
|
|
84
|
-
* non-empty variable among `keys`, else `null`.
|
|
85
|
-
*
|
|
86
|
-
* @example
|
|
87
|
-
* env.string(config.host, "SMTP_HOST");
|
|
88
|
-
*/
|
|
89
|
-
export function string(configured, keys) {
|
|
90
|
-
return trimToNull(configured) ?? text(keys);
|
|
91
|
-
}
|
|
92
|
-
/**
|
|
93
|
-
* Resolve a boolean setting through {@link toBoolean}, so the loose spellings an
|
|
94
|
-
* env var actually carries (`1`, `on`, `yes`, ...) are accepted. Returns
|
|
95
|
-
* `undefined` when neither source is interpretable, letting the caller pick a
|
|
96
|
-
* default with `??`.
|
|
97
|
-
*
|
|
98
|
-
* @example
|
|
99
|
-
* env.boolean(config.fuzzy, "WEB_SEARCH_FUZZY") ?? true;
|
|
100
|
-
*/
|
|
101
|
-
export function boolean(configured, keys) {
|
|
102
|
-
return toBoolean(configured) ?? toBoolean(text(keys));
|
|
103
|
-
}
|
|
104
|
-
/**
|
|
105
|
-
* Resolve a positive-number setting that may be fractional (a score threshold,
|
|
106
|
-
* a ratio): `configured` when it is a finite number greater than zero, else the
|
|
107
|
-
* first variable among `keys` that parses that way, else `fallback`.
|
|
108
|
-
*
|
|
109
|
-
* {@link positiveInt} is the right choice for a count; this one keeps the
|
|
110
|
-
* fraction, so a `0.4` threshold does not floor to `0`.
|
|
111
|
-
*
|
|
112
|
-
* @example
|
|
113
|
-
* env.positiveNumber(config.fuzzyThreshold, "SEARCH_FUZZY_THRESHOLD", 0.4);
|
|
114
|
-
*/
|
|
115
|
-
export function positiveNumber(configured, keys, fallback) {
|
|
116
|
-
return toPositiveNumber(configured) ?? toPositiveNumber(text(keys)) ?? fallback;
|
|
117
|
-
}
|
|
118
|
-
/**
|
|
119
|
-
* Resolve a positive-integer setting (a port, timeout, page size, or cap):
|
|
120
|
-
* `configured` when it is a finite number greater than zero, else the first
|
|
121
|
-
* variable among `keys` that parses that way, else `fallback`. Floored, so a
|
|
122
|
-
* fractional value can't leak into a count.
|
|
123
|
-
*
|
|
124
|
-
* A non-numeric or non-positive value is treated as absent rather than fatal -
|
|
125
|
-
* these are ceilings and timeouts where a sane default beats a boot failure.
|
|
126
|
-
*
|
|
127
|
-
* @example
|
|
128
|
-
* env.positiveInt(config.timeoutMs, "SEARCH_TIMEOUT_MS", 30_000);
|
|
129
|
-
*/
|
|
130
|
-
export function positiveInt(configured, keys, fallback) {
|
|
131
|
-
return toPositiveInt(configured) ?? toPositiveInt(text(keys)) ?? fallback;
|
|
132
|
-
}
|
|
133
|
-
function toPositiveNumber(value) {
|
|
134
|
-
const parsed = toNumber(value);
|
|
135
|
-
return parsed !== undefined && parsed > 0 ? parsed : undefined;
|
|
136
|
-
}
|
|
137
|
-
function toPositiveInt(value) {
|
|
138
|
-
const parsed = toPositiveNumber(value);
|
|
139
|
-
return parsed === undefined ? undefined : Math.floor(parsed);
|
|
140
|
-
}
|
|
141
|
-
/**
|
|
142
|
-
* Resolve a list setting through {@link parseList}, so an array from typed
|
|
143
|
-
* config and a `"a, b c"` env string normalize identically. Returns `[]` when
|
|
144
|
-
* neither source has entries.
|
|
145
|
-
*
|
|
146
|
-
* @example
|
|
147
|
-
* env.list(config.modelFallbacks, "WEB_SEARCH_MODEL_FALLBACKS");
|
|
148
|
-
*/
|
|
149
|
-
export function list(configured, keys, transform) {
|
|
150
|
-
const fromConfig = parseList(configured, transform);
|
|
151
|
-
return fromConfig.length > 0 ? fromConfig : parseList(text(keys), transform);
|
|
152
|
-
}
|
|
153
|
-
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"env.js","sourceRoot":"","sources":["../../src/env.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAOpD,qCAAqC;AACrC,MAAM,CAAC,MAAM,YAAY,GAAG,MAAM,CAAC;AAKnC,gEAAgE;AAChE,SAAS,WAAW;IAClB,OAAQ,UAAwC,CAAC,OAAO,EAAE,GAAG,IAAI,EAAE,CAAC;AACtE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,QAAQ,CAAC,SAA6C,WAAW,EAAE;IACjF,MAAM,OAAO,GAAG,MAAM,CAAC,mBAAmB,EAAE,IAAI,EAAE,CAAC;IACnD,MAAM,IAAI,GAAG,MAAM,CAAC,eAAe,EAAE,IAAI,EAAE,CAAC;IAC5C,MAAM,IAAI,GAAG,MAAM,CAAC,mBAAmB,EAAE,IAAI,EAAE,CAAC;IAChD,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI;QAAE,OAAO,KAAK,CAAC;IAE7C,IAAI,CAAC;QACH,IAAI,CAAC,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC;YAAE,OAAO,KAAK,CAAC;IAC1E,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;IAClC,OAAO,CACL,UAAU,KAAK,SAAS;QACxB,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC;QAC5B,UAAU,IAAI,CAAC;QACf,UAAU,IAAI,YAAY,CAC3B,CAAC;AACJ,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,IAAI,CAAC,IAAY;IAC/B,OAAO,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;AAC3D,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,IAAI,CAAC,IAAY;IAC/B,MAAM,GAAG,GAAG,WAAW,EAAE,CAAC;IAC1B,KAAK,MAAM,GAAG,IAAI,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAC3D,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QACnC,IAAI,KAAK,KAAK,IAAI;YAAE,OAAO,KAAK,CAAC;IACnC,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,MAAM,CAAC,UAAmB,EAAE,IAAY;IACtD,OAAO,UAAU,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;AAC9C,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,OAAO,CAAC,UAAmB,EAAE,IAAY;IACvD,OAAO,SAAS,CAAC,UAAU,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AACxD,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,cAAc,CAAC,UAAmB,EAAE,IAAY,EAAE,QAAgB;IAChF,OAAO,gBAAgB,CAAC,UAAU,CAAC,IAAI,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,QAAQ,CAAC;AAClF,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,WAAW,CAAC,UAAmB,EAAE,IAAY,EAAE,QAAgB;IAC7E,OAAO,aAAa,CAAC,UAAU,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,QAAQ,CAAC;AAC5E,CAAC;AAED,SAAS,gBAAgB,CAAC,KAAc;IACtC,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC/B,OAAO,MAAM,KAAK,SAAS,IAAI,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;AACjE,CAAC;AAED,SAAS,aAAa,CAAC,KAAc;IACnC,MAAM,MAAM,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;IACvC,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,IAAI,CAClB,UAAyD,EACzD,IAAY,EACZ,SAAqC;IAErC,MAAM,UAAU,GAAG,SAAS,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;IACpD,OAAO,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC,CAAC;AAC/E,CAAC","sourcesContent":["/**\n * Reading configuration out of the environment.\n *\n * Every plugin config in this repo resolves the same way: take the typed\n * config value when the caller set one, else fall back to one or more\n * environment variables, else a default. Written by hand that becomes a\n * `config.x ?? Number(process.env.X)` chain per field, and each package grew\n * its own `fromEnv` / `resolvePositiveInt` helper with slightly different\n * coercion rules. These are those helpers, once.\n *\n * Browser-safe: `process` is reached through `globalThis` and guarded, so this\n * module needs no Node types and is inert in a browser (every lookup misses and\n * the caller's fallback applies).\n *\n * @module\n */\n\nimport { toBoolean, toNumber } from \"./object.ts\";\nimport { parseList, trimToNull } from \"./string.ts\";\n\n/** `process`-shaped view off `globalThis`, so no node types are needed. */\ninterface ProcessLike {\n  env?: Record<string, string | undefined>;\n}\n\n/** Highest valid TCP port number. */\nexport const MAX_TCP_PORT = 65_535;\n\n/** One env var name, or several tried in order. */\nexport type EnvKey = string | readonly string[];\n\n/** The ambient environment, or `{}` off-process (a browser). */\nfunction environment(): Record<string, string | undefined> {\n  return (globalThis as { process?: ProcessLike }).process?.env ?? {};\n}\n\n/**\n * Detect the Databricks App runtime from its required environment shape.\n *\n * A valid app has a non-empty name, an HTTP(S) workspace host, and a valid\n * `DATABRICKS_APP_PORT`. Reads the ambient environment when none is supplied.\n */\nexport function isAppEnv(source: Record<string, string | undefined> = environment()): boolean {\n  const appName = source.DATABRICKS_APP_NAME?.trim();\n  const host = source.DATABRICKS_HOST?.trim();\n  const port = source.DATABRICKS_APP_PORT?.trim();\n  if (!appName || !host || !port) return false;\n\n  try {\n    if (![\"http:\", \"https:\"].includes(new URL(host).protocol)) return false;\n  } catch {\n    return false;\n  }\n\n  const portNumber = toNumber(port);\n  return (\n    portNumber !== undefined &&\n    Number.isInteger(portNumber) &&\n    portNumber >= 1 &&\n    portNumber <= MAX_TCP_PORT\n  );\n}\n\n/**\n * The PRIMARY (current, non-deprecated) name in an {@link EnvKey}.\n *\n * Use this when naming a variable in a log line or error rather than indexing\n * `keys[0]`: an {@link EnvKey} may be a bare string, and `\"TUNNEL_X\"[0]` is the\n * character `\"T\"`, which produces a message naming a variable that does not\n * exist. Returns `\"\"` only for an empty list, which no caller should have.\n *\n * @example\n * logger.warn(`${env.name(JWT_SECRET_ENV)} is not set`);\n */\nexport function name(keys: EnvKey): string {\n  return typeof keys === \"string\" ? keys : (keys[0] ?? \"\");\n}\n\n/**\n * First non-empty value among `keys`, trimmed, else `null`.\n *\n * Several names for one setting is the norm (a package-specific variable plus\n * the Databricks-standard one), so `keys` is order-sensitive: earlier names win.\n *\n * @example\n * env.text([\"TEAMS_APP_ID\", \"MICROSOFT_APP_ID\"]);\n */\nexport function text(keys: EnvKey): string | null {\n  const env = environment();\n  for (const key of typeof keys === \"string\" ? [keys] : keys) {\n    const value = trimToNull(env[key]);\n    if (value !== null) return value;\n  }\n  return null;\n}\n\n/**\n * Resolve a string setting: `configured` when set and non-empty, else the first\n * non-empty variable among `keys`, else `null`.\n *\n * @example\n * env.string(config.host, \"SMTP_HOST\");\n */\nexport function string(configured: unknown, keys: EnvKey): string | null {\n  return trimToNull(configured) ?? text(keys);\n}\n\n/**\n * Resolve a boolean setting through {@link toBoolean}, so the loose spellings an\n * env var actually carries (`1`, `on`, `yes`, ...) are accepted. Returns\n * `undefined` when neither source is interpretable, letting the caller pick a\n * default with `??`.\n *\n * @example\n * env.boolean(config.fuzzy, \"WEB_SEARCH_FUZZY\") ?? true;\n */\nexport function boolean(configured: unknown, keys: EnvKey): boolean | undefined {\n  return toBoolean(configured) ?? toBoolean(text(keys));\n}\n\n/**\n * Resolve a positive-number setting that may be fractional (a score threshold,\n * a ratio): `configured` when it is a finite number greater than zero, else the\n * first variable among `keys` that parses that way, else `fallback`.\n *\n * {@link positiveInt} is the right choice for a count; this one keeps the\n * fraction, so a `0.4` threshold does not floor to `0`.\n *\n * @example\n * env.positiveNumber(config.fuzzyThreshold, \"SEARCH_FUZZY_THRESHOLD\", 0.4);\n */\nexport function positiveNumber(configured: unknown, keys: EnvKey, fallback: number): number {\n  return toPositiveNumber(configured) ?? toPositiveNumber(text(keys)) ?? fallback;\n}\n\n/**\n * Resolve a positive-integer setting (a port, timeout, page size, or cap):\n * `configured` when it is a finite number greater than zero, else the first\n * variable among `keys` that parses that way, else `fallback`. Floored, so a\n * fractional value can't leak into a count.\n *\n * A non-numeric or non-positive value is treated as absent rather than fatal -\n * these are ceilings and timeouts where a sane default beats a boot failure.\n *\n * @example\n * env.positiveInt(config.timeoutMs, \"SEARCH_TIMEOUT_MS\", 30_000);\n */\nexport function positiveInt(configured: unknown, keys: EnvKey, fallback: number): number {\n  return toPositiveInt(configured) ?? toPositiveInt(text(keys)) ?? fallback;\n}\n\nfunction toPositiveNumber(value: unknown): number | undefined {\n  const parsed = toNumber(value);\n  return parsed !== undefined && parsed > 0 ? parsed : undefined;\n}\n\nfunction toPositiveInt(value: unknown): number | undefined {\n  const parsed = toPositiveNumber(value);\n  return parsed === undefined ? undefined : Math.floor(parsed);\n}\n\n/**\n * Resolve a list setting through {@link parseList}, so an array from typed\n * config and a `\"a, b c\"` env string normalize identically. Returns `[]` when\n * neither source has entries.\n *\n * @example\n * env.list(config.modelFallbacks, \"WEB_SEARCH_MODEL_FALLBACKS\");\n */\nexport function list(\n  configured: string | readonly string[] | undefined | null,\n  keys: EnvKey,\n  transform?: (entry: string) => string,\n): string[] {\n  const fromConfig = parseList(configured, transform);\n  return fromConfig.length > 0 ? fromConfig : parseList(text(keys), transform);\n}\n"]}
|
package/src/env.ts
DELETED
|
@@ -1,177 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Reading configuration out of the environment.
|
|
3
|
-
*
|
|
4
|
-
* Every plugin config in this repo resolves the same way: take the typed
|
|
5
|
-
* config value when the caller set one, else fall back to one or more
|
|
6
|
-
* environment variables, else a default. Written by hand that becomes a
|
|
7
|
-
* `config.x ?? Number(process.env.X)` chain per field, and each package grew
|
|
8
|
-
* its own `fromEnv` / `resolvePositiveInt` helper with slightly different
|
|
9
|
-
* coercion rules. These are those helpers, once.
|
|
10
|
-
*
|
|
11
|
-
* Browser-safe: `process` is reached through `globalThis` and guarded, so this
|
|
12
|
-
* module needs no Node types and is inert in a browser (every lookup misses and
|
|
13
|
-
* the caller's fallback applies).
|
|
14
|
-
*
|
|
15
|
-
* @module
|
|
16
|
-
*/
|
|
17
|
-
|
|
18
|
-
import { toBoolean, toNumber } from "./object.ts";
|
|
19
|
-
import { parseList, trimToNull } from "./string.ts";
|
|
20
|
-
|
|
21
|
-
/** `process`-shaped view off `globalThis`, so no node types are needed. */
|
|
22
|
-
interface ProcessLike {
|
|
23
|
-
env?: Record<string, string | undefined>;
|
|
24
|
-
}
|
|
25
|
-
|
|
26
|
-
/** Highest valid TCP port number. */
|
|
27
|
-
export const MAX_TCP_PORT = 65_535;
|
|
28
|
-
|
|
29
|
-
/** One env var name, or several tried in order. */
|
|
30
|
-
export type EnvKey = string | readonly string[];
|
|
31
|
-
|
|
32
|
-
/** The ambient environment, or `{}` off-process (a browser). */
|
|
33
|
-
function environment(): Record<string, string | undefined> {
|
|
34
|
-
return (globalThis as { process?: ProcessLike }).process?.env ?? {};
|
|
35
|
-
}
|
|
36
|
-
|
|
37
|
-
/**
|
|
38
|
-
* Detect the Databricks App runtime from its required environment shape.
|
|
39
|
-
*
|
|
40
|
-
* A valid app has a non-empty name, an HTTP(S) workspace host, and a valid
|
|
41
|
-
* `DATABRICKS_APP_PORT`. Reads the ambient environment when none is supplied.
|
|
42
|
-
*/
|
|
43
|
-
export function isAppEnv(source: Record<string, string | undefined> = environment()): boolean {
|
|
44
|
-
const appName = source.DATABRICKS_APP_NAME?.trim();
|
|
45
|
-
const host = source.DATABRICKS_HOST?.trim();
|
|
46
|
-
const port = source.DATABRICKS_APP_PORT?.trim();
|
|
47
|
-
if (!appName || !host || !port) return false;
|
|
48
|
-
|
|
49
|
-
try {
|
|
50
|
-
if (!["http:", "https:"].includes(new URL(host).protocol)) return false;
|
|
51
|
-
} catch {
|
|
52
|
-
return false;
|
|
53
|
-
}
|
|
54
|
-
|
|
55
|
-
const portNumber = toNumber(port);
|
|
56
|
-
return (
|
|
57
|
-
portNumber !== undefined &&
|
|
58
|
-
Number.isInteger(portNumber) &&
|
|
59
|
-
portNumber >= 1 &&
|
|
60
|
-
portNumber <= MAX_TCP_PORT
|
|
61
|
-
);
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
/**
|
|
65
|
-
* The PRIMARY (current, non-deprecated) name in an {@link EnvKey}.
|
|
66
|
-
*
|
|
67
|
-
* Use this when naming a variable in a log line or error rather than indexing
|
|
68
|
-
* `keys[0]`: an {@link EnvKey} may be a bare string, and `"TUNNEL_X"[0]` is the
|
|
69
|
-
* character `"T"`, which produces a message naming a variable that does not
|
|
70
|
-
* exist. Returns `""` only for an empty list, which no caller should have.
|
|
71
|
-
*
|
|
72
|
-
* @example
|
|
73
|
-
* logger.warn(`${env.name(JWT_SECRET_ENV)} is not set`);
|
|
74
|
-
*/
|
|
75
|
-
export function name(keys: EnvKey): string {
|
|
76
|
-
return typeof keys === "string" ? keys : (keys[0] ?? "");
|
|
77
|
-
}
|
|
78
|
-
|
|
79
|
-
/**
|
|
80
|
-
* First non-empty value among `keys`, trimmed, else `null`.
|
|
81
|
-
*
|
|
82
|
-
* Several names for one setting is the norm (a package-specific variable plus
|
|
83
|
-
* the Databricks-standard one), so `keys` is order-sensitive: earlier names win.
|
|
84
|
-
*
|
|
85
|
-
* @example
|
|
86
|
-
* env.text(["TEAMS_APP_ID", "MICROSOFT_APP_ID"]);
|
|
87
|
-
*/
|
|
88
|
-
export function text(keys: EnvKey): string | null {
|
|
89
|
-
const env = environment();
|
|
90
|
-
for (const key of typeof keys === "string" ? [keys] : keys) {
|
|
91
|
-
const value = trimToNull(env[key]);
|
|
92
|
-
if (value !== null) return value;
|
|
93
|
-
}
|
|
94
|
-
return null;
|
|
95
|
-
}
|
|
96
|
-
|
|
97
|
-
/**
|
|
98
|
-
* Resolve a string setting: `configured` when set and non-empty, else the first
|
|
99
|
-
* non-empty variable among `keys`, else `null`.
|
|
100
|
-
*
|
|
101
|
-
* @example
|
|
102
|
-
* env.string(config.host, "SMTP_HOST");
|
|
103
|
-
*/
|
|
104
|
-
export function string(configured: unknown, keys: EnvKey): string | null {
|
|
105
|
-
return trimToNull(configured) ?? text(keys);
|
|
106
|
-
}
|
|
107
|
-
|
|
108
|
-
/**
|
|
109
|
-
* Resolve a boolean setting through {@link toBoolean}, so the loose spellings an
|
|
110
|
-
* env var actually carries (`1`, `on`, `yes`, ...) are accepted. Returns
|
|
111
|
-
* `undefined` when neither source is interpretable, letting the caller pick a
|
|
112
|
-
* default with `??`.
|
|
113
|
-
*
|
|
114
|
-
* @example
|
|
115
|
-
* env.boolean(config.fuzzy, "WEB_SEARCH_FUZZY") ?? true;
|
|
116
|
-
*/
|
|
117
|
-
export function boolean(configured: unknown, keys: EnvKey): boolean | undefined {
|
|
118
|
-
return toBoolean(configured) ?? toBoolean(text(keys));
|
|
119
|
-
}
|
|
120
|
-
|
|
121
|
-
/**
|
|
122
|
-
* Resolve a positive-number setting that may be fractional (a score threshold,
|
|
123
|
-
* a ratio): `configured` when it is a finite number greater than zero, else the
|
|
124
|
-
* first variable among `keys` that parses that way, else `fallback`.
|
|
125
|
-
*
|
|
126
|
-
* {@link positiveInt} is the right choice for a count; this one keeps the
|
|
127
|
-
* fraction, so a `0.4` threshold does not floor to `0`.
|
|
128
|
-
*
|
|
129
|
-
* @example
|
|
130
|
-
* env.positiveNumber(config.fuzzyThreshold, "SEARCH_FUZZY_THRESHOLD", 0.4);
|
|
131
|
-
*/
|
|
132
|
-
export function positiveNumber(configured: unknown, keys: EnvKey, fallback: number): number {
|
|
133
|
-
return toPositiveNumber(configured) ?? toPositiveNumber(text(keys)) ?? fallback;
|
|
134
|
-
}
|
|
135
|
-
|
|
136
|
-
/**
|
|
137
|
-
* Resolve a positive-integer setting (a port, timeout, page size, or cap):
|
|
138
|
-
* `configured` when it is a finite number greater than zero, else the first
|
|
139
|
-
* variable among `keys` that parses that way, else `fallback`. Floored, so a
|
|
140
|
-
* fractional value can't leak into a count.
|
|
141
|
-
*
|
|
142
|
-
* A non-numeric or non-positive value is treated as absent rather than fatal -
|
|
143
|
-
* these are ceilings and timeouts where a sane default beats a boot failure.
|
|
144
|
-
*
|
|
145
|
-
* @example
|
|
146
|
-
* env.positiveInt(config.timeoutMs, "SEARCH_TIMEOUT_MS", 30_000);
|
|
147
|
-
*/
|
|
148
|
-
export function positiveInt(configured: unknown, keys: EnvKey, fallback: number): number {
|
|
149
|
-
return toPositiveInt(configured) ?? toPositiveInt(text(keys)) ?? fallback;
|
|
150
|
-
}
|
|
151
|
-
|
|
152
|
-
function toPositiveNumber(value: unknown): number | undefined {
|
|
153
|
-
const parsed = toNumber(value);
|
|
154
|
-
return parsed !== undefined && parsed > 0 ? parsed : undefined;
|
|
155
|
-
}
|
|
156
|
-
|
|
157
|
-
function toPositiveInt(value: unknown): number | undefined {
|
|
158
|
-
const parsed = toPositiveNumber(value);
|
|
159
|
-
return parsed === undefined ? undefined : Math.floor(parsed);
|
|
160
|
-
}
|
|
161
|
-
|
|
162
|
-
/**
|
|
163
|
-
* Resolve a list setting through {@link parseList}, so an array from typed
|
|
164
|
-
* config and a `"a, b c"` env string normalize identically. Returns `[]` when
|
|
165
|
-
* neither source has entries.
|
|
166
|
-
*
|
|
167
|
-
* @example
|
|
168
|
-
* env.list(config.modelFallbacks, "WEB_SEARCH_MODEL_FALLBACKS");
|
|
169
|
-
*/
|
|
170
|
-
export function list(
|
|
171
|
-
configured: string | readonly string[] | undefined | null,
|
|
172
|
-
keys: EnvKey,
|
|
173
|
-
transform?: (entry: string) => string,
|
|
174
|
-
): string[] {
|
|
175
|
-
const fromConfig = parseList(configured, transform);
|
|
176
|
-
return fromConfig.length > 0 ? fromConfig : parseList(text(keys), transform);
|
|
177
|
-
}
|