envapt 7.1.0 → 8.0.0-next.1
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/CHANGELOG.md +44 -99
- package/README.md +1 -1
- package/dist/node/converters/BuiltInConverters.cjs +1 -1
- package/dist/node/converters/BuiltInConverters.cjs.map +1 -1
- package/dist/node/converters/BuiltInConverters.mjs +1 -1
- package/dist/node/converters/BuiltInConverters.mjs.map +1 -1
- package/dist/node/converters/Converters.cjs.map +1 -1
- package/dist/node/converters/Converters.mjs.map +1 -1
- package/dist/node/converters/ValueConverter.cjs +1 -1
- package/dist/node/converters/ValueConverter.cjs.map +1 -1
- package/dist/node/converters/ValueConverter.mjs +1 -1
- package/dist/node/converters/ValueConverter.mjs.map +1 -1
- package/dist/node/core/AdvancedMethods.cjs +1 -1
- package/dist/node/core/AdvancedMethods.cjs.map +1 -1
- package/dist/node/core/AdvancedMethods.mjs +1 -1
- package/dist/node/core/AdvancedMethods.mjs.map +1 -1
- package/dist/node/core/EnvapterBase.cjs +1 -1
- package/dist/node/core/EnvapterBase.cjs.map +1 -1
- package/dist/node/core/EnvapterBase.mjs +1 -1
- package/dist/node/core/EnvapterBase.mjs.map +1 -1
- package/dist/node/core/Environment.cjs +2 -0
- package/dist/node/core/Environment.cjs.map +1 -0
- package/dist/node/core/Environment.mjs +2 -0
- package/dist/node/core/Environment.mjs.map +1 -0
- package/dist/node/core/EnvironmentMethods.cjs +1 -1
- package/dist/node/core/EnvironmentMethods.cjs.map +1 -1
- package/dist/node/core/EnvironmentMethods.mjs +1 -1
- package/dist/node/core/EnvironmentMethods.mjs.map +1 -1
- package/dist/node/core/PrimitiveMethods.cjs +1 -1
- package/dist/node/core/PrimitiveMethods.cjs.map +1 -1
- package/dist/node/core/PrimitiveMethods.mjs +1 -1
- package/dist/node/core/PrimitiveMethods.mjs.map +1 -1
- package/dist/node/core/engine.cjs +2 -0
- package/dist/node/core/engine.cjs.map +1 -0
- package/dist/node/core/engine.mjs +2 -0
- package/dist/node/core/engine.mjs.map +1 -0
- package/dist/node/core/missing.cjs +2 -0
- package/dist/node/core/missing.cjs.map +1 -0
- package/dist/node/core/missing.mjs +2 -0
- package/dist/node/core/missing.mjs.map +1 -0
- package/dist/node/core/paths.cjs +2 -0
- package/dist/node/core/paths.cjs.map +1 -0
- package/dist/node/core/paths.mjs +2 -0
- package/dist/node/core/paths.mjs.map +1 -0
- package/dist/node/core/state.cjs +2 -0
- package/dist/node/core/state.cjs.map +1 -0
- package/dist/node/core/state.mjs +2 -0
- package/dist/node/core/state.mjs.map +1 -0
- package/dist/node/decorators/legacy/Envapt.cjs.map +1 -1
- package/dist/node/decorators/legacy/Envapt.mjs.map +1 -1
- package/dist/node/decorators/legacy/SugarDecorators.cjs.map +1 -1
- package/dist/node/decorators/legacy/SugarDecorators.mjs.map +1 -1
- package/dist/node/decorators/modern/Envapt.cjs.map +1 -1
- package/dist/node/decorators/modern/Envapt.mjs.map +1 -1
- package/dist/node/decorators/modern/SugarDecorators.cjs.map +1 -1
- package/dist/node/decorators/modern/SugarDecorators.mjs.map +1 -1
- package/dist/node/decorators/resolveDecoratorValue.cjs +1 -1
- package/dist/node/decorators/resolveDecoratorValue.cjs.map +1 -1
- package/dist/node/decorators/resolveDecoratorValue.mjs +1 -1
- package/dist/node/decorators/resolveDecoratorValue.mjs.map +1 -1
- package/dist/node/engine/Envapter.cjs +1 -1
- package/dist/node/engine/Envapter.cjs.map +1 -1
- package/dist/node/engine/Envapter.mjs +1 -1
- package/dist/node/engine/Envapter.mjs.map +1 -1
- package/dist/node/engine/NodeEnvapter.cjs +1 -1
- package/dist/node/engine/NodeEnvapter.cjs.map +1 -1
- package/dist/node/engine/NodeEnvapter.mjs +1 -1
- package/dist/node/engine/NodeEnvapter.mjs.map +1 -1
- package/dist/node/engine/TemplateResolver.cjs +1 -1
- package/dist/node/engine/TemplateResolver.cjs.map +1 -1
- package/dist/node/engine/TemplateResolver.mjs +1 -1
- package/dist/node/engine/TemplateResolver.mjs.map +1 -1
- package/dist/node/engine/Validators.cjs +1 -1
- package/dist/node/engine/Validators.cjs.map +1 -1
- package/dist/node/engine/Validators.mjs +1 -1
- package/dist/node/engine/Validators.mjs.map +1 -1
- package/dist/node/index.cjs +1 -1
- package/dist/node/index.mjs +1 -1
- package/dist/node/infra/Debug.cjs +1 -1
- package/dist/node/infra/Debug.cjs.map +1 -1
- package/dist/node/infra/Debug.mjs +1 -1
- package/dist/node/infra/Debug.mjs.map +1 -1
- package/dist/node/infra/Dotenv.cjs.map +1 -1
- package/dist/node/infra/Dotenv.mjs.map +1 -1
- package/dist/node/infra/Error.cjs +1 -1
- package/dist/node/infra/Error.cjs.map +1 -1
- package/dist/node/infra/Error.mjs +1 -1
- package/dist/node/infra/Error.mjs.map +1 -1
- package/dist/node/infra/recase.cjs +2 -0
- package/dist/node/infra/recase.cjs.map +1 -0
- package/dist/node/infra/recase.mjs +2 -0
- package/dist/node/infra/recase.mjs.map +1 -0
- package/dist/node/infra/runtime.cjs +1 -1
- package/dist/node/infra/runtime.cjs.map +1 -1
- package/dist/node/infra/runtime.mjs +1 -1
- package/dist/node/infra/runtime.mjs.map +1 -1
- package/dist/node/sources/{NodeEnvSource.cjs → FileSource.cjs} +2 -2
- package/dist/node/sources/FileSource.cjs.map +1 -0
- package/dist/node/sources/{NodeEnvSource.mjs → FileSource.mjs} +2 -2
- package/dist/node/sources/FileSource.mjs.map +1 -0
- package/dist/node/sources/PortableSource.cjs.map +1 -1
- package/dist/node/sources/PortableSource.mjs.map +1 -1
- package/dist/node/sources/{UnboundEnvSource.cjs → UnboundSource.cjs} +2 -2
- package/dist/node/sources/UnboundSource.cjs.map +1 -0
- package/dist/{browser/sources/UnboundEnvSource.mjs → node/sources/UnboundSource.mjs} +2 -2
- package/dist/node/sources/UnboundSource.mjs.map +1 -0
- package/dist/node/sources/coerce.cjs.map +1 -1
- package/dist/node/sources/coerce.mjs.map +1 -1
- package/dist/node/sources/merge.cjs +2 -0
- package/dist/node/sources/merge.cjs.map +1 -0
- package/dist/node/sources/merge.mjs +2 -0
- package/dist/node/sources/merge.mjs.map +1 -0
- package/dist/node/sources/normalizeSource.cjs +2 -0
- package/dist/node/sources/normalizeSource.cjs.map +1 -0
- package/dist/node/sources/normalizeSource.mjs +2 -0
- package/dist/node/sources/normalizeSource.mjs.map +1 -0
- package/dist/portable/converters/BuiltInConverters.mjs +2 -0
- package/dist/portable/converters/BuiltInConverters.mjs.map +1 -0
- package/dist/portable/converters/Converters.mjs.map +1 -0
- package/dist/portable/converters/ValueConverter.mjs +2 -0
- package/dist/portable/converters/ValueConverter.mjs.map +1 -0
- package/dist/portable/core/AdvancedMethods.mjs +2 -0
- package/dist/portable/core/AdvancedMethods.mjs.map +1 -0
- package/dist/portable/core/EnvapterBase.mjs +2 -0
- package/dist/portable/core/EnvapterBase.mjs.map +1 -0
- package/dist/portable/core/Environment.mjs +2 -0
- package/dist/portable/core/Environment.mjs.map +1 -0
- package/dist/portable/core/EnvironmentMethods.mjs +2 -0
- package/dist/portable/core/EnvironmentMethods.mjs.map +1 -0
- package/dist/portable/core/PrimitiveMethods.mjs +2 -0
- package/dist/portable/core/PrimitiveMethods.mjs.map +1 -0
- package/dist/portable/core/engine.mjs +2 -0
- package/dist/portable/core/engine.mjs.map +1 -0
- package/dist/portable/core/missing.mjs +2 -0
- package/dist/portable/core/missing.mjs.map +1 -0
- package/dist/portable/core/paths.mjs +2 -0
- package/dist/portable/core/paths.mjs.map +1 -0
- package/dist/portable/core/state.mjs +2 -0
- package/dist/portable/core/state.mjs.map +1 -0
- package/dist/{workerd → portable}/decorators/legacy/Envapt.mjs.map +1 -1
- package/dist/portable/decorators/legacy/SugarDecorators.mjs.map +1 -0
- package/dist/{browser → portable}/decorators/modern/Envapt.mjs.map +1 -1
- package/dist/portable/decorators/modern/SugarDecorators.mjs.map +1 -0
- package/dist/portable/decorators/resolveDecoratorValue.mjs +2 -0
- package/dist/portable/decorators/resolveDecoratorValue.mjs.map +1 -0
- package/dist/portable/engine/Envapter.mjs +2 -0
- package/dist/portable/engine/Envapter.mjs.map +1 -0
- package/dist/portable/engine/PortableEnvapter.mjs +2 -0
- package/dist/portable/engine/PortableEnvapter.mjs.map +1 -0
- package/dist/portable/engine/TemplateResolver.mjs +2 -0
- package/dist/portable/engine/TemplateResolver.mjs.map +1 -0
- package/dist/portable/engine/Validators.mjs +2 -0
- package/dist/portable/engine/Validators.mjs.map +1 -0
- package/dist/portable/engine/fileApiStub.mjs +2 -0
- package/dist/portable/engine/fileApiStub.mjs.map +1 -0
- package/dist/portable/index.mjs +1 -0
- package/dist/portable/infra/Debug.mjs +2 -0
- package/dist/portable/infra/Debug.mjs.map +1 -0
- package/dist/portable/infra/Dotenv.mjs.map +1 -0
- package/dist/{browser → portable}/infra/Error.mjs +1 -1
- package/dist/portable/infra/Error.mjs.map +1 -0
- package/dist/portable/infra/recase.mjs +2 -0
- package/dist/portable/infra/recase.mjs.map +1 -0
- package/dist/portable/infra/runtime.mjs +2 -0
- package/dist/portable/infra/runtime.mjs.map +1 -0
- package/dist/portable/sources/PortableSource.mjs.map +1 -0
- package/dist/{node/sources/UnboundEnvSource.mjs → portable/sources/UnboundSource.mjs} +2 -2
- package/dist/portable/sources/UnboundSource.mjs.map +1 -0
- package/dist/portable/sources/coerce.mjs.map +1 -0
- package/dist/portable/sources/merge.mjs +2 -0
- package/dist/portable/sources/merge.mjs.map +1 -0
- package/dist/portable/sources/normalizeSource.mjs +2 -0
- package/dist/portable/sources/normalizeSource.mjs.map +1 -0
- package/dist/types/converters/Converters.d.mts +3 -24
- package/dist/types/core/AdvancedMethods.d.mts +40 -19
- package/dist/types/core/EnvapterBase.d.mts +21 -26
- package/dist/types/core/Environment.d.mts +26 -0
- package/dist/types/core/EnvironmentMethods.d.mts +8 -67
- package/dist/types/core/PrimitiveMethods.d.mts +7 -10
- package/dist/types/decorators/legacy/SugarDecorators.d.mts +5 -0
- package/dist/types/decorators/modern/SugarDecorators.d.mts +5 -0
- package/dist/types/engine/Envapter.d.mts +6 -5
- package/dist/types/engine/NodeEnvapter.d.mts +18 -9
- package/dist/types/engine/PortableEnvapter.d.mts +17 -5
- package/dist/types/index.d.mts +10 -14
- package/dist/types/index.portable.d.mts +9 -13
- package/dist/types/infra/Debug.d.mts +1 -0
- package/dist/types/infra/Dotenv.d.mts +1 -0
- package/dist/types/infra/Error.d.mts +5 -1
- package/dist/types/infra/StandardSchema.d.mts +2 -12
- package/dist/types/sources/{NodeEnvSource.d.mts → FileSource.d.mts} +6 -5
- package/dist/types/sources/PortableSource.d.mts +3 -2
- package/dist/types/sources/merge.d.mts +16 -0
- package/dist/types/types/Casing.d.mts +8 -0
- package/dist/types/types/Conversion.d.mts +12 -71
- package/dist/types/types/Decorator.d.mts +0 -14
- package/dist/types/types/Env.d.mts +1 -10
- package/dist/types/types/Options.d.mts +13 -2
- package/dist/types/types/Schema.d.mts +1 -13
- package/dist/types/types/Source.d.mts +11 -33
- package/package.json +62 -19
- package/aliases/browser.d.mts +0 -7
- package/aliases/browser.mjs +0 -4
- package/aliases/workerd.d.mts +0 -7
- package/aliases/workerd.mjs +0 -4
- package/dist/browser/converters/BuiltInConverters.mjs +0 -2
- package/dist/browser/converters/BuiltInConverters.mjs.map +0 -1
- package/dist/browser/converters/Converters.mjs.map +0 -1
- package/dist/browser/converters/ValueConverter.mjs +0 -2
- package/dist/browser/converters/ValueConverter.mjs.map +0 -1
- package/dist/browser/core/AdvancedMethods.mjs +0 -2
- package/dist/browser/core/AdvancedMethods.mjs.map +0 -1
- package/dist/browser/core/EnvapterBase.mjs +0 -2
- package/dist/browser/core/EnvapterBase.mjs.map +0 -1
- package/dist/browser/core/EnvironmentMethods.mjs +0 -2
- package/dist/browser/core/EnvironmentMethods.mjs.map +0 -1
- package/dist/browser/core/PrimitiveMethods.mjs +0 -2
- package/dist/browser/core/PrimitiveMethods.mjs.map +0 -1
- package/dist/browser/decorators/legacy/Envapt.mjs.map +0 -1
- package/dist/browser/decorators/legacy/SugarDecorators.mjs.map +0 -1
- package/dist/browser/decorators/modern/SugarDecorators.mjs.map +0 -1
- package/dist/browser/decorators/resolveDecoratorValue.mjs +0 -2
- package/dist/browser/decorators/resolveDecoratorValue.mjs.map +0 -1
- package/dist/browser/engine/Envapter.mjs +0 -2
- package/dist/browser/engine/Envapter.mjs.map +0 -1
- package/dist/browser/engine/PortableEnvapter.mjs +0 -2
- package/dist/browser/engine/PortableEnvapter.mjs.map +0 -1
- package/dist/browser/engine/TemplateResolver.mjs +0 -2
- package/dist/browser/engine/TemplateResolver.mjs.map +0 -1
- package/dist/browser/engine/Validators.mjs +0 -2
- package/dist/browser/engine/Validators.mjs.map +0 -1
- package/dist/browser/engine/installFileApiStubs.mjs +0 -2
- package/dist/browser/engine/installFileApiStubs.mjs.map +0 -1
- package/dist/browser/index.mjs +0 -1
- package/dist/browser/infra/Debug.mjs +0 -2
- package/dist/browser/infra/Debug.mjs.map +0 -1
- package/dist/browser/infra/Dotenv.mjs.map +0 -1
- package/dist/browser/infra/Error.mjs.map +0 -1
- package/dist/browser/infra/runtime.mjs +0 -2
- package/dist/browser/infra/runtime.mjs.map +0 -1
- package/dist/browser/sources/ManualEnvSource.mjs +0 -2
- package/dist/browser/sources/ManualEnvSource.mjs.map +0 -1
- package/dist/browser/sources/PortableSource.mjs.map +0 -1
- package/dist/browser/sources/UnboundEnvSource.mjs.map +0 -1
- package/dist/browser/sources/WorkerEnvSource.mjs +0 -2
- package/dist/browser/sources/WorkerEnvSource.mjs.map +0 -1
- package/dist/browser/sources/coerce.mjs.map +0 -1
- package/dist/node/sources/ManualEnvSource.cjs +0 -2
- package/dist/node/sources/ManualEnvSource.cjs.map +0 -1
- package/dist/node/sources/ManualEnvSource.mjs +0 -2
- package/dist/node/sources/ManualEnvSource.mjs.map +0 -1
- package/dist/node/sources/NodeEnvSource.cjs.map +0 -1
- package/dist/node/sources/NodeEnvSource.mjs.map +0 -1
- package/dist/node/sources/UnboundEnvSource.cjs.map +0 -1
- package/dist/node/sources/UnboundEnvSource.mjs.map +0 -1
- package/dist/node/sources/WorkerEnvSource.cjs +0 -2
- package/dist/node/sources/WorkerEnvSource.cjs.map +0 -1
- package/dist/node/sources/WorkerEnvSource.mjs +0 -2
- package/dist/node/sources/WorkerEnvSource.mjs.map +0 -1
- package/dist/types/converters/ValueConverter.d.mts +0 -25
- package/dist/types/engine/TemplateResolver.d.mts +0 -17
- package/dist/types/sources/ManualEnvSource.d.mts +0 -12
- package/dist/types/sources/WorkerEnvSource.d.mts +0 -12
- package/dist/workerd/converters/BuiltInConverters.mjs +0 -2
- package/dist/workerd/converters/BuiltInConverters.mjs.map +0 -1
- package/dist/workerd/converters/Converters.mjs +0 -2
- package/dist/workerd/converters/Converters.mjs.map +0 -1
- package/dist/workerd/converters/ListOfBuiltInConverters.mjs +0 -2
- package/dist/workerd/converters/ListOfBuiltInConverters.mjs.map +0 -1
- package/dist/workerd/converters/ValueConverter.mjs +0 -2
- package/dist/workerd/converters/ValueConverter.mjs.map +0 -1
- package/dist/workerd/core/AdvancedMethods.mjs +0 -2
- package/dist/workerd/core/AdvancedMethods.mjs.map +0 -1
- package/dist/workerd/core/EnvapterBase.mjs +0 -2
- package/dist/workerd/core/EnvapterBase.mjs.map +0 -1
- package/dist/workerd/core/EnvironmentMethods.mjs +0 -2
- package/dist/workerd/core/EnvironmentMethods.mjs.map +0 -1
- package/dist/workerd/core/PrimitiveMethods.mjs +0 -2
- package/dist/workerd/core/PrimitiveMethods.mjs.map +0 -1
- package/dist/workerd/decorators/legacy/Envapt.mjs +0 -2
- package/dist/workerd/decorators/legacy/SugarDecorators.mjs +0 -2
- package/dist/workerd/decorators/legacy/SugarDecorators.mjs.map +0 -1
- package/dist/workerd/decorators/legacy/createPropertyDecorator.mjs +0 -2
- package/dist/workerd/decorators/legacy/createPropertyDecorator.mjs.map +0 -1
- package/dist/workerd/decorators/modern/Envapt.mjs +0 -2
- package/dist/workerd/decorators/modern/Envapt.mjs.map +0 -1
- package/dist/workerd/decorators/modern/SugarDecorators.mjs +0 -2
- package/dist/workerd/decorators/modern/SugarDecorators.mjs.map +0 -1
- package/dist/workerd/decorators/modern/createAccessorDecorator.mjs +0 -2
- package/dist/workerd/decorators/modern/createAccessorDecorator.mjs.map +0 -1
- package/dist/workerd/decorators/parseEnvaptOptions.mjs +0 -2
- package/dist/workerd/decorators/parseEnvaptOptions.mjs.map +0 -1
- package/dist/workerd/decorators/resolveDecoratorValue.mjs +0 -2
- package/dist/workerd/decorators/resolveDecoratorValue.mjs.map +0 -1
- package/dist/workerd/engine/Envapter.mjs +0 -2
- package/dist/workerd/engine/Envapter.mjs.map +0 -1
- package/dist/workerd/engine/PortableEnvapter.mjs +0 -2
- package/dist/workerd/engine/PortableEnvapter.mjs.map +0 -1
- package/dist/workerd/engine/TemplateResolver.mjs +0 -2
- package/dist/workerd/engine/TemplateResolver.mjs.map +0 -1
- package/dist/workerd/engine/Validators.mjs +0 -2
- package/dist/workerd/engine/Validators.mjs.map +0 -1
- package/dist/workerd/engine/installFileApiStubs.mjs +0 -2
- package/dist/workerd/engine/installFileApiStubs.mjs.map +0 -1
- package/dist/workerd/index.mjs +0 -1
- package/dist/workerd/infra/Debug.mjs +0 -2
- package/dist/workerd/infra/Debug.mjs.map +0 -1
- package/dist/workerd/infra/Dotenv.mjs +0 -3
- package/dist/workerd/infra/Dotenv.mjs.map +0 -1
- package/dist/workerd/infra/Error.mjs +0 -2
- package/dist/workerd/infra/Error.mjs.map +0 -1
- package/dist/workerd/infra/runtime.mjs +0 -2
- package/dist/workerd/infra/runtime.mjs.map +0 -1
- package/dist/workerd/legacy.mjs +0 -1
- package/dist/workerd/sources/ManualEnvSource.mjs +0 -2
- package/dist/workerd/sources/ManualEnvSource.mjs.map +0 -1
- package/dist/workerd/sources/PortableSource.mjs +0 -2
- package/dist/workerd/sources/PortableSource.mjs.map +0 -1
- package/dist/workerd/sources/UnboundEnvSource.mjs +0 -2
- package/dist/workerd/sources/UnboundEnvSource.mjs.map +0 -1
- package/dist/workerd/sources/WorkerEnvSource.mjs +0 -2
- package/dist/workerd/sources/WorkerEnvSource.mjs.map +0 -1
- package/dist/workerd/sources/coerce.mjs +0 -2
- package/dist/workerd/sources/coerce.mjs.map +0 -1
- /package/dist/{browser → portable}/converters/Converters.mjs +0 -0
- /package/dist/{browser → portable}/converters/ListOfBuiltInConverters.mjs +0 -0
- /package/dist/{browser → portable}/converters/ListOfBuiltInConverters.mjs.map +0 -0
- /package/dist/{browser → portable}/decorators/legacy/Envapt.mjs +0 -0
- /package/dist/{browser → portable}/decorators/legacy/SugarDecorators.mjs +0 -0
- /package/dist/{browser → portable}/decorators/legacy/createPropertyDecorator.mjs +0 -0
- /package/dist/{browser → portable}/decorators/legacy/createPropertyDecorator.mjs.map +0 -0
- /package/dist/{browser → portable}/decorators/modern/Envapt.mjs +0 -0
- /package/dist/{browser → portable}/decorators/modern/SugarDecorators.mjs +0 -0
- /package/dist/{browser → portable}/decorators/modern/createAccessorDecorator.mjs +0 -0
- /package/dist/{browser → portable}/decorators/modern/createAccessorDecorator.mjs.map +0 -0
- /package/dist/{browser → portable}/decorators/parseEnvaptOptions.mjs +0 -0
- /package/dist/{browser → portable}/decorators/parseEnvaptOptions.mjs.map +0 -0
- /package/dist/{browser → portable}/infra/Dotenv.mjs +0 -0
- /package/dist/{browser → portable}/legacy.mjs +0 -0
- /package/dist/{browser → portable}/sources/PortableSource.mjs +0 -0
- /package/dist/{browser → portable}/sources/coerce.mjs +0 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"runtime.mjs","names":[],"sources":["../../../src/infra/runtime.ts"],"sourcesContent":["import type { Source } from '../types';\n\n// importing Debug back into EnvapterBase would cycle, so the source and sink are injected via the setters below.\n/* v8 ignore start -- @preserve replaced at load on Node so the Node suite never runs these defaults */\nlet sink: (line: string) => void = (line) => {\n // eslint-disable-next-line no-console -- the off-Node fallback log sink\n console.error(line);\n};\nlet envReader: () => Record<string, string> = () => ({});\nlet varReader: ((key: string) => string | undefined) | undefined;\n/* v8 ignore stop */\n\nexport function setRuntimeSink(fn: (line: string) => void): void {\n sink = fn;\n}\n\nexport function writeRuntimeLine(line: string): void {\n sink(line);\n}\n\n// check snapshot first, then the source's per-key reader, so a reader source (empty snapshot) still resolves a key\nexport function readRuntimeVar(key: string): string | undefined {\n const fromSnapshot = envReader()[key];\n if (fromSnapshot !== undefined) return fromSnapshot;\n // ENVAPT_DEBUG resolves through here, so a throwing reader must not abort the config load that triggered it\n try {\n return varReader?.(key);\n } catch {\n return undefined;\n }\n}\n\nexport function bindRuntimeFromSource(source: Source): void {\n envReader = (): Record<string, string> => source.readVars();\n const readVar = source.readVar;\n varReader = typeof readVar === 'function' ? readVar.bind(source) : undefined;\n}\n"],"mappings":"AAIA,IAAI,EAAgC,GAAS,CAEzC,QAAQ,MAAM,CAAI,CACtB,EACI,OAAiD,CAAC,GAClD,EAOJ,SAAgB,EAAiB,EAAoB,CACjD,EAAK,CAAI,CACb,CAGA,SAAgB,EAAe,EAAiC,CAC5D,IAAM,EAAe,EAAU,CAAC,CAAC,GACjC,GAAI,IAAiB,IAAA,GAAW,OAAO,EAEvC,GAAI,CACA,OAAO,IAAY,CAAG,CAC1B,MAAQ,CACJ,MACJ,CACJ,CAEA,SAAgB,EAAsB,EAAsB,CACxD,MAA0C,EAAO,SAAS,EAC1D,IAAM,EAAU,EAAO,QACvB,EAAY,OAAO,GAAY,WAAa,EAAQ,KAAK,CAAM,EAAI,IAAA,EACvE"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"PortableSource.mjs","names":[],"sources":["../../../src/sources/PortableSource.ts"],"sourcesContent":["import { coerceToStringRecord } from './coerce';\n\nimport type { BareSource } from '../types';\n\n/**\n * Environment source seeded from an object you provide, for every runtime without a filesystem. The\n * config your bundler injects into a browser build (Vite's `import.meta.env`, a webpack `DefinePlugin`\n * global), the Cloudflare `env` binding, a Vercel Edge or Fastly config object, a test fixture, or any\n * plain object. Pass it straight through. Non-string values are JSON-stringified so the converters\n * still apply, which means they must be JSON-serializable. Without a filesystem the `.env` cascade and\n * file APIs do not apply.\n * @public\n * @see {@link https://envapt.materwelon.dev/docs/sources#the-providers}\n */\nexport class PortableSource implements BareSource {\n /** Always `false`. With no filesystem, the `.env` cascade and file APIs do not apply. */\n readonly supportsFiles = false;\n private readonly vars: Record<string, string>;\n\n /** Seed the source from `vars`. Non-string values are JSON-stringified so the converters still apply. */\n constructor(vars: object) {\n this.vars = coerceToStringRecord(vars);\n }\n\n /** Returns a snapshot clone of the provided object as plain strings. */\n readVars(): Record<string, string> {\n return { ...this.vars };\n }\n}\n"],"mappings":"oDAcA,IAAa,EAAb,KAAkD,CAE9C,cAAyB,GACzB,KAGA,YAAY,EAAc,CACtB,KAAK,KAAO,EAAqB,CAAI,CACzC,CAGA,UAAmC,CAC/B,MAAO,CAAE,GAAG,KAAK,IAAK,CAC1B,CACJ"}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{EnvaptError as e}from"../infra/Error.mjs";var t=class{supportsFiles=!1;readVars(){throw new e(307,`No environment source is bound. Call Envapter.useSource(...) with a source such as new PortableSource({...}) before reading.`)}};export{t as
|
|
2
|
-
//# sourceMappingURL=
|
|
1
|
+
import{EnvaptError as e}from"../infra/Error.mjs";var t=class{supportsFiles=!1;readVars(){throw new e(307,`No environment source is bound. Call Envapter.useSource(...) with a source such as new PortableSource({...}) before reading.`)}};export{t as UnboundSource};
|
|
2
|
+
//# sourceMappingURL=UnboundSource.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"UnboundSource.mjs","names":[],"sources":["../../../src/sources/UnboundSource.ts"],"sourcesContent":["import { EnvaptError, EnvaptErrorCodes } from '../infra/Error';\n\nimport type { BareSource } from '../types';\n\n/**\n * The default source until one is bound. Every read throws NoSourceBound so a forgotten `useSource`\n * surfaces at read time instead of silently yielding nothing. The Node entry binds {@link FileSource}\n * at load, browser and Workers bundles must call `Envapter.useSource(...)` before reading.\n * @internal\n */\nexport class UnboundSource implements BareSource {\n readonly supportsFiles = false;\n\n readVars(): Record<string, string> {\n throw new EnvaptError(\n EnvaptErrorCodes.NoSourceBound,\n 'No environment source is bound. Call Envapter.useSource(...) with a source such as new PortableSource({...}) before reading.'\n );\n }\n}\n"],"mappings":"iDAUA,IAAa,EAAb,KAAiD,CAC7C,cAAyB,GAEzB,UAAmC,CAC/B,MAAM,IAAI,EAAA,IAEN,8HACJ,CACJ,CACJ"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"coerce.mjs","names":[],"sources":["../../../src/sources/coerce.ts"],"sourcesContent":["// The returned record is fresh, so a caller mutating its object\n// later cannot leak into the source, and non-string values are JSON-stringified.\nexport function coerceToStringRecord(env: object): Record<string, string> {\n const snapshot: Record<string, string> = {};\n // `object` so a Cloudflare `Env` (an interface with no index signature) is accepted. cast to a record\n // to read entries as `unknown` rather than `any`.\n for (const [key, value] of Object.entries(env as Record<string, unknown>)) {\n if (typeof value === 'string') {\n snapshot[key] = value;\n continue;\n }\n const encoded = JSON.stringify(value);\n // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- TS lib mistypes JSON.stringify's return as always-string when it is string | undefined at runtime\n if (encoded !== undefined) snapshot[key] = encoded;\n }\n return snapshot;\n}\n"],"mappings":"AAEA,SAAgB,EAAqB,EAAqC,CACtE,IAAM,EAAmC,CAAC,EAG1C,IAAK,GAAM,CAAC,EAAK,KAAU,OAAO,QAAQ,CAA8B,EAAG,CACvE,GAAI,OAAO,GAAU,SAAU,CAC3B,EAAS,GAAO,EAChB,QACJ,CACA,IAAM,EAAU,KAAK,UAAU,CAAK,EAEhC,IAAY,IAAA,KAAW,EAAS,GAAO,EAC/C,CACA,OAAO,CACX"}
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
import{EnvaptError as e}from"../infra/Error.mjs";import{normalizeSource as t}from"./normalizeSource.mjs";function n(...n){if(n.length===0)throw new e(308,`merge requires at least one source.`);let r=n.map(t),i=r.filter(e=>e.supportsFiles===!0);if(i.length>1)throw new e(308,`merge accepts at most one filesystem-backed source, so the .env cascade and file APIs route to a single member.`);let a=()=>{let e={};for(let t of r)Object.assign(e,t.readVars());return e},o=r.filter(e=>typeof e.readVar==`function`),s=o.length===0?void 0:e=>{for(let t=o.length-1;t>=0;t--){let n=o[t]?.readVar(e);if(n!==void 0)return n}},c=i[0];if(!c){let e={readVars:a};return s&&(e.readVar=s),e}let l={readVars:a,supportsFiles:!0,readFile:(e,t)=>c.readFile(e,t),resolvePath:(e,t)=>c.resolvePath(e,t),normalizeBaseDir:e=>c.normalizeBaseDir(e),writeVars:e=>c.writeVars(e)};return s&&(l.readVar=s),l}export{n as merge};
|
|
2
|
+
//# sourceMappingURL=merge.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"merge.mjs","names":[],"sources":["../../../src/sources/merge.ts"],"sourcesContent":["import { normalizeSource } from './normalizeSource';\nimport { EnvaptError, EnvaptErrorCodes } from '../infra/Error';\n\nimport type { BareSource, FileCapableSource, Source } from '../types';\n\n/**\n * Compose several sources into one, read last-wins. A later member's `readVars()` value overrides an\n * earlier member's for the same key. A member may be a `(key) => string | undefined` reader for a\n * source that reads one key at a time, and it fills a key missing from every snapshot. Bind the result\n * with `Envapter.useSource`. Throws {@link EnvaptErrorCodes.InvalidMergedSource} with no members or with\n * more than one file-backed member.\n * @public\n * @see {@link https://envapt.materwelon.dev/docs/sources#combining-sources}\n */\nexport function merge(...members: (Source | ((key: string) => string | undefined))[]): Source {\n if (members.length === 0) {\n throw new EnvaptError(EnvaptErrorCodes.InvalidMergedSource, 'merge requires at least one source.');\n }\n\n const sources = members.map(normalizeSource);\n\n const fileMembers = sources.filter((m): m is FileCapableSource => m.supportsFiles === true);\n if (fileMembers.length > 1) {\n throw new EnvaptError(\n EnvaptErrorCodes.InvalidMergedSource,\n 'merge accepts at most one filesystem-backed source, so the .env cascade and file APIs route to a single member.'\n );\n }\n\n const readVars = (): Record<string, string> => {\n const merged: Record<string, string> = {};\n for (const m of sources) Object.assign(merged, m.readVars());\n return merged;\n };\n\n const readers = sources.filter(\n (m): m is Source & { readVar: (key: string) => string | undefined } => typeof m.readVar === 'function'\n );\n const readVar =\n readers.length === 0\n ? undefined\n : (key: string): string | undefined => {\n // last reader that answers wins, so scan from the end and return the first defined value\n for (let i = readers.length - 1; i >= 0; i--) {\n const found = readers[i]?.readVar(key);\n if (found !== undefined) return found;\n }\n return undefined;\n };\n\n const fileMember = fileMembers[0];\n if (!fileMember) {\n const bare: BareSource = { readVars };\n if (readVar) bare.readVar = readVar;\n return bare;\n }\n\n const fileCapable: FileCapableSource = {\n readVars,\n supportsFiles: true,\n readFile: (path, encoding) => fileMember.readFile(path, encoding),\n resolvePath: (baseDir, candidate) => fileMember.resolvePath(baseDir, candidate),\n normalizeBaseDir: (value) => fileMember.normalizeBaseDir(value),\n writeVars: (vars) => fileMember.writeVars(vars)\n };\n if (readVar) fileCapable.readVar = readVar;\n return fileCapable;\n}\n"],"mappings":"yGAcA,SAAgB,EAAM,GAAG,EAAqE,CAC1F,GAAI,EAAQ,SAAW,EACnB,MAAM,IAAI,EAAA,IAAkD,qCAAqC,EAGrG,IAAM,EAAU,EAAQ,IAAI,CAAe,EAErC,EAAc,EAAQ,OAAQ,GAA8B,EAAE,gBAAkB,EAAI,EAC1F,GAAI,EAAY,OAAS,EACrB,MAAM,IAAI,EAAA,IAEN,iHACJ,EAGJ,IAAM,MAAyC,CAC3C,IAAM,EAAiC,CAAC,EACxC,IAAK,IAAM,KAAK,EAAS,OAAO,OAAO,EAAQ,EAAE,SAAS,CAAC,EAC3D,OAAO,CACX,EAEM,EAAU,EAAQ,OACnB,GAAsE,OAAO,EAAE,SAAY,UAChG,EACM,EACF,EAAQ,SAAW,EACb,IAAA,GACC,GAAoC,CAEjC,IAAK,IAAI,EAAI,EAAQ,OAAS,EAAG,GAAK,EAAG,IAAK,CAC1C,IAAM,EAAQ,EAAQ,EAAE,EAAE,QAAQ,CAAG,EACrC,GAAI,IAAU,IAAA,GAAW,OAAO,CACpC,CAEJ,EAEJ,EAAa,EAAY,GAC/B,GAAI,CAAC,EAAY,CACb,IAAM,EAAmB,CAAE,UAAS,EAEpC,OADI,IAAS,EAAK,QAAU,GACrB,CACX,CAEA,IAAM,EAAiC,CACnC,WACA,cAAe,GACf,UAAW,EAAM,IAAa,EAAW,SAAS,EAAM,CAAQ,EAChE,aAAc,EAAS,IAAc,EAAW,YAAY,EAAS,CAAS,EAC9E,iBAAmB,GAAU,EAAW,iBAAiB,CAAK,EAC9D,UAAY,GAAS,EAAW,UAAU,CAAI,CAClD,EAEA,OADI,IAAS,EAAY,QAAU,GAC5B,CACX"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"normalizeSource.mjs","names":[],"sources":["../../../src/sources/normalizeSource.ts"],"sourcesContent":["import type { Source } from '../types';\n\nexport function normalizeSource(source: Source | ((key: string) => string | undefined)): Source {\n return typeof source === 'function' ? { supportsFiles: false, readVars: () => ({}), readVar: source } : source;\n}\n"],"mappings":"AAEA,SAAgB,EAAgB,EAAgE,CAC5F,OAAO,OAAO,GAAW,WAAa,CAAE,cAAe,GAAO,cAAiB,CAAC,GAAI,QAAS,CAAO,EAAI,CAC5G"}
|
|
@@ -13,42 +13,20 @@ declare const SCALAR: {
|
|
|
13
13
|
readonly Date: "date";
|
|
14
14
|
readonly Time: "time";
|
|
15
15
|
};
|
|
16
|
-
/**
|
|
17
|
-
* String tokens for every built-in scalar converter.
|
|
18
|
-
* @public
|
|
19
|
-
*/
|
|
20
16
|
type ConverterToken = (typeof SCALAR)[keyof typeof SCALAR];
|
|
21
17
|
/**
|
|
22
18
|
* Custom element converter for use inside {@link Converters.array}. Receives the trimmed,
|
|
23
19
|
* non-empty raw string for one array slot and returns the parsed value.
|
|
24
20
|
* @public
|
|
21
|
+
* @see {@link https://envapt.materwelon.dev/docs/converters#custom-converters}
|
|
25
22
|
*/
|
|
26
23
|
type CustomElementConverter<TReturn = unknown> = (raw: string) => TReturn;
|
|
27
|
-
/**
|
|
28
|
-
* Valid element converters for {@link Converters.array}: any scalar token except
|
|
29
|
-
* `json` and `regexp` (those don't compose as array elements), or a custom function.
|
|
30
|
-
* @public
|
|
31
|
-
*/
|
|
32
24
|
type ArrayElement = Exclude<ConverterToken, 'json' | 'regexp'> | CustomElementConverter;
|
|
33
|
-
/**
|
|
34
|
-
* Phantom-branded token produced by {@link Converters.array}. The `T` type parameter carries
|
|
35
|
-
* the element converter through any variable indirection so inference survives. The
|
|
36
|
-
* `__envaptKind` discriminant is present at runtime for dispatch.
|
|
37
|
-
* @public
|
|
38
|
-
*/
|
|
39
25
|
interface ArrayOf<TElement extends ArrayElement = ArrayElement> {
|
|
40
|
-
/** Runtime discriminant marking this token as an array converter. Don't use directly. */
|
|
41
26
|
readonly __envaptKind: 'array';
|
|
42
|
-
/** The element converter applied to each split slot. */
|
|
43
27
|
readonly of: TElement;
|
|
44
|
-
/** The string the raw value is split on. */
|
|
45
28
|
readonly delimiter: string;
|
|
46
29
|
}
|
|
47
|
-
/**
|
|
48
|
-
* Runtime type guard for tokens produced by {@link Converters.array}.
|
|
49
|
-
* @internal
|
|
50
|
-
*/
|
|
51
|
-
declare function isArrayOf(value: unknown): value is ArrayOf;
|
|
52
30
|
type ArrayScalarElement = Exclude<ConverterToken, 'json' | 'regexp'>;
|
|
53
31
|
declare function buildArrayConverter<TReturn>(opts: {
|
|
54
32
|
of: CustomElementConverter<TReturn>;
|
|
@@ -75,6 +53,7 @@ declare function buildArrayConverter(opts?: {
|
|
|
75
53
|
* ```
|
|
76
54
|
*
|
|
77
55
|
* @public
|
|
56
|
+
* @see {@link https://envapt.materwelon.dev/docs/converters#built-in-tokens}
|
|
78
57
|
*/
|
|
79
58
|
declare const Converters: {
|
|
80
59
|
readonly array: typeof buildArrayConverter;
|
|
@@ -92,5 +71,5 @@ declare const Converters: {
|
|
|
92
71
|
readonly Time: "time";
|
|
93
72
|
};
|
|
94
73
|
//#endregion
|
|
95
|
-
export {
|
|
74
|
+
export { ArrayOf, ConverterToken, Converters, CustomElementConverter };
|
|
96
75
|
//# sourceMappingURL=Converters.d.mts.map
|
|
@@ -1,19 +1,12 @@
|
|
|
1
1
|
import { ArrayOf } from "../converters/Converters.mjs";
|
|
2
|
-
import { AdvancedConverterReturn, BuiltInConverter, ConditionalReturn, ConverterFunction, InferConverterReturnType, TimeFallback } from "../types/Conversion.mjs";
|
|
2
|
+
import { AdvancedConverterReturn, BuiltInConverter, ConditionalReturn, ConverterFunction, InferConverterReturnType, InferSpecField, RequiredSpec, TimeFallback } from "../types/Conversion.mjs";
|
|
3
|
+
import { KeyCasing, RecaseKey } from "../types/Casing.mjs";
|
|
3
4
|
import { InferSchemaOutput, StandardSchemaV1 } from "../infra/StandardSchema.mjs";
|
|
4
5
|
import { SchemaConstraint } from "../types/Schema.mjs";
|
|
5
6
|
import { EnvKeyInput } from "../types/Env.mjs";
|
|
6
7
|
import { PrimitiveMethods } from "./PrimitiveMethods.mjs";
|
|
7
8
|
|
|
8
9
|
//#region src/core/AdvancedMethods.d.ts
|
|
9
|
-
interface GetUsingRequiredOptions<TConverter> {
|
|
10
|
-
converter: TConverter;
|
|
11
|
-
required: true;
|
|
12
|
-
}
|
|
13
|
-
interface GetWithRequiredOptions<TReturnType> {
|
|
14
|
-
converter: ConverterFunction<TReturnType>;
|
|
15
|
-
required: true;
|
|
16
|
-
}
|
|
17
10
|
/**
|
|
18
11
|
* Mixin for advanced methods for environment variable conversion using built-in and custom converters
|
|
19
12
|
* @internal
|
|
@@ -23,38 +16,65 @@ declare class AdvancedMethods extends PrimitiveMethods {
|
|
|
23
16
|
* Get an environment variable using a built-in converter.
|
|
24
17
|
*
|
|
25
18
|
* Supports both scalar tokens (e.g. `Converters.Number`) and `ArrayOf<...>` tokens
|
|
26
|
-
* produced by `Converters.array(...)`. The key can be a single name or an ordered list
|
|
27
|
-
*
|
|
19
|
+
* produced by `Converters.array(...)`. The key can be a single name or an ordered list.
|
|
20
|
+
* The first defined value wins.
|
|
21
|
+
* @see {@link https://envapt.materwelon.dev/docs/envapter#converters}
|
|
22
|
+
* @see {@link https://envapt.materwelon.dev/docs/converters#custom-converters}
|
|
28
23
|
*/
|
|
29
24
|
static getUsing<TFallback extends TimeFallback | undefined = undefined>(key: EnvKeyInput, converter: 'time', fallback?: TFallback): ConditionalReturn<number, TFallback>;
|
|
30
25
|
static getUsing<TConverter extends BuiltInConverter | ArrayOf, TFallback = undefined>(key: EnvKeyInput, converter: TConverter, fallback?: TFallback): AdvancedConverterReturn<TConverter, TFallback>;
|
|
31
26
|
static getUsing<TReturn>(key: EnvKeyInput, converter: BuiltInConverter | ArrayOf, fallback?: TReturn): TReturn;
|
|
32
|
-
static getUsing(key: EnvKeyInput, options: GetUsingRequiredOptions<'time'>): number;
|
|
33
|
-
static getUsing<TConverter extends BuiltInConverter | ArrayOf>(key: EnvKeyInput, options: GetUsingRequiredOptions<TConverter>): InferConverterReturnType<TConverter>;
|
|
34
27
|
/**
|
|
35
28
|
* @see {@link AdvancedMethods.getUsing}
|
|
36
29
|
*/
|
|
37
30
|
getUsing<TFallback extends TimeFallback | undefined = undefined>(key: EnvKeyInput, converter: 'time', fallback?: TFallback): ConditionalReturn<number, TFallback>;
|
|
38
31
|
getUsing<TConverter extends BuiltInConverter | ArrayOf, TFallback = undefined>(key: EnvKeyInput, converter: TConverter, fallback?: TFallback): AdvancedConverterReturn<TConverter, TFallback>;
|
|
39
32
|
getUsing<TReturn>(key: EnvKeyInput, converter: BuiltInConverter | ArrayOf, fallback?: TReturn): TReturn;
|
|
40
|
-
getUsing(key: EnvKeyInput, options: GetUsingRequiredOptions<'time'>): number;
|
|
41
|
-
getUsing<TConverter extends BuiltInConverter | ArrayOf>(key: EnvKeyInput, options: GetUsingRequiredOptions<TConverter>): InferConverterReturnType<TConverter>;
|
|
42
33
|
/**
|
|
43
34
|
* Get an environment variable using a custom converter function.
|
|
44
35
|
* Accepts a single key or an ordered list for automatic fallback.
|
|
36
|
+
* @see {@link https://envapt.materwelon.dev/docs/envapter#converters}
|
|
37
|
+
* @see {@link https://envapt.materwelon.dev/docs/converters#custom-converters}
|
|
45
38
|
*/
|
|
46
39
|
static getWith<TReturnType, TFallback extends TReturnType | undefined = undefined>(key: EnvKeyInput, converter: ConverterFunction<TReturnType>, fallback?: TFallback): ConditionalReturn<TReturnType, TFallback>;
|
|
47
|
-
static getWith<TReturnType>(key: EnvKeyInput, options: GetWithRequiredOptions<TReturnType>): TReturnType;
|
|
48
40
|
/**
|
|
49
41
|
* @see {@link AdvancedMethods.getWith}
|
|
50
42
|
*/
|
|
51
43
|
getWith<TReturnType, TFallback extends TReturnType | undefined = undefined>(key: EnvKeyInput, converter: ConverterFunction<TReturnType>, fallback?: TFallback): ConditionalReturn<TReturnType, TFallback>;
|
|
52
|
-
|
|
44
|
+
/**
|
|
45
|
+
* Read a required environment variable and convert it, throwing `MissingEnvValue` when the value
|
|
46
|
+
* is missing or empty. Returns the non-undefined converter output. Accepts a built-in or `ArrayOf`
|
|
47
|
+
* token, or a custom parser function. The key can be a single name or an ordered list.
|
|
48
|
+
* @see {@link https://envapt.materwelon.dev/docs/envapter#fail-fast-on-missing-values}
|
|
49
|
+
* @see {@link https://envapt.materwelon.dev/docs/converters#require-a-converted-value}
|
|
50
|
+
*/
|
|
51
|
+
static getRequired<TConverter extends BuiltInConverter | ArrayOf>(key: EnvKeyInput, converter: TConverter): InferConverterReturnType<TConverter>;
|
|
52
|
+
static getRequired<TReturnType>(key: EnvKeyInput, converter: ConverterFunction<TReturnType, string>): TReturnType;
|
|
53
|
+
/**
|
|
54
|
+
* @see {@link AdvancedMethods.getRequired}
|
|
55
|
+
*/
|
|
56
|
+
getRequired<TConverter extends BuiltInConverter | ArrayOf>(key: EnvKeyInput, converter: TConverter): InferConverterReturnType<TConverter>;
|
|
57
|
+
getRequired<TReturnType>(key: EnvKeyInput, converter: ConverterFunction<TReturnType, string>): TReturnType;
|
|
58
|
+
/**
|
|
59
|
+
* Read a group of required environment variables in one call. Each key in `spec` maps to a
|
|
60
|
+
* converter (a token, an `array()` token, or a custom parser), and the returned record holds
|
|
61
|
+
* every converted value, all non-undefined. Collects every missing or empty key and throws one
|
|
62
|
+
* `MissingEnvValue` listing them all. Pass a `casing` (`'camelCase'`, `'PascalCase'`, or
|
|
63
|
+
* `'kebab-case'`) to rename the record keys, splitting on underscores, which assumes the
|
|
64
|
+
* conventional SCREAMING_SNAKE env-var names. With no casing the keys stay as-is.
|
|
65
|
+
* @see {@link https://envapt.materwelon.dev/docs/envapter#fail-fast-on-missing-values}
|
|
66
|
+
* @see {@link https://envapt.materwelon.dev/docs/converters#require-a-converted-value}
|
|
67
|
+
*/
|
|
68
|
+
static getRequiredAll<Spec extends RequiredSpec, Casing extends KeyCasing | undefined = undefined>(spec: Spec, casing?: Casing): { [K in keyof Spec as RecaseKey<K & string, Casing>]: InferSpecField<Spec[K]> };
|
|
69
|
+
/**
|
|
70
|
+
* @see {@link AdvancedMethods.getRequiredAll}
|
|
71
|
+
*/
|
|
72
|
+
getRequiredAll<Spec extends RequiredSpec, Casing extends KeyCasing | undefined = undefined>(spec: Spec, casing?: Casing): { [K in keyof Spec as RecaseKey<K & string, Casing>]: InferSpecField<Spec[K]> };
|
|
53
73
|
/**
|
|
54
74
|
* Validate an environment variable through a {@link StandardSchemaV1}-conformant schema
|
|
55
75
|
* (zod, valibot, arktype, etc). Throws `MissingEnvValue` if the env value is absent and
|
|
56
|
-
* no fallback is provided. The fallback, when provided, is returned as-is on missing
|
|
57
|
-
*
|
|
76
|
+
* no fallback is provided. The fallback, when provided, is returned as-is on missing.
|
|
77
|
+
* It does NOT pass through the schema, mirroring custom-converter behavior.
|
|
58
78
|
*
|
|
59
79
|
* Synchronous schemas only. A Promise-returning `validate` triggers an
|
|
60
80
|
* `InvalidUserDefinedConfig` throw at the call site.
|
|
@@ -64,6 +84,7 @@ declare class AdvancedMethods extends PrimitiveMethods {
|
|
|
64
84
|
* import { z } from 'zod';
|
|
65
85
|
* const port = Envapter.parse('PORT', z.coerce.number().min(1024).max(65535), 3000);
|
|
66
86
|
* ```
|
|
87
|
+
* @see {@link https://envapt.materwelon.dev/docs/standard-schema#any-conformant-validator-or-none}
|
|
67
88
|
*/
|
|
68
89
|
static parse<Schema extends StandardSchemaV1>(key: EnvKeyInput, schema: SchemaConstraint<Schema>, fallback?: InferSchemaOutput<Schema>): InferSchemaOutput<Schema>;
|
|
69
90
|
/**
|
|
@@ -1,22 +1,15 @@
|
|
|
1
1
|
import { DebugLevel } from "../infra/Debug.mjs";
|
|
2
|
-
import {
|
|
2
|
+
import { FileApiMode } from "../types/Options.mjs";
|
|
3
3
|
import { EnvKeyInput } from "../types/Env.mjs";
|
|
4
|
-
import {
|
|
4
|
+
import { Source } from "../types/Source.mjs";
|
|
5
5
|
|
|
6
6
|
//#region src/core/EnvapterBase.d.ts
|
|
7
7
|
/** @internal */
|
|
8
8
|
declare abstract class EnvapterBase {
|
|
9
|
-
protected static _envPaths: string[];
|
|
10
|
-
protected static _envPathsExplicitlySet: boolean;
|
|
11
|
-
protected static _baseDir: string | undefined;
|
|
12
|
-
protected static _userDefinedEnvFileOptions: EnvFileOptions;
|
|
13
|
-
protected static _strict: boolean;
|
|
14
|
-
protected static _syncProcessEnv: boolean;
|
|
15
|
-
protected static _dotenvAddedKeys: Set<string>;
|
|
16
|
-
protected static _source: Source;
|
|
17
9
|
/**
|
|
18
10
|
* Enable or disable strict mode. Default `false`. Setting refreshes the cache so
|
|
19
11
|
* previously-cached converted values get re-evaluated under the new rule.
|
|
12
|
+
* @see {@link https://envapt.materwelon.dev/docs/strict-mode#what-strict-mode-changes}
|
|
20
13
|
*/
|
|
21
14
|
static set strict(value: boolean);
|
|
22
15
|
static get strict(): boolean;
|
|
@@ -24,6 +17,7 @@ declare abstract class EnvapterBase {
|
|
|
24
17
|
* Set the debug log level. Defaults to `silent`. When unset, reads `ENVAPT_DEBUG` from the
|
|
25
18
|
* bound source on first access. The setter overrides any env-var value. Output goes to stderr
|
|
26
19
|
* on Node (the console elsewhere), prefixed with `[envapt]`.
|
|
20
|
+
* @see {@link https://envapt.materwelon.dev/docs/configuration#debug-logging}
|
|
27
21
|
*/
|
|
28
22
|
static set debug(level: DebugLevel);
|
|
29
23
|
static get debug(): DebugLevel;
|
|
@@ -37,36 +31,37 @@ declare abstract class EnvapterBase {
|
|
|
37
31
|
* Flipping `false → true` mirrors the existing tracked delta immediately (no cache
|
|
38
32
|
* refresh). Flipping `true → false` is one-way: previously mirrored keys remain in
|
|
39
33
|
* `process.env` until the process exits.
|
|
34
|
+
* @see {@link https://envapt.materwelon.dev/docs/configuration#mirroring-to-processenv}
|
|
40
35
|
*/
|
|
41
36
|
static set syncProcessEnv(value: boolean);
|
|
42
37
|
static get syncProcessEnv(): boolean;
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
key: string;
|
|
53
|
-
value: string | undefined;
|
|
54
|
-
};
|
|
55
|
-
protected static get config(): Map<string, unknown>;
|
|
38
|
+
/**
|
|
39
|
+
* On the portable build, this controls the filesystem-only config APIs (`envPaths`, `baseDir`,
|
|
40
|
+
* `envFileOptions`, `configureProfiles`, `resetProfiles`). `'warn'` (the default) warns once and
|
|
41
|
+
* no-ops, `'throw'` throws {@link EnvaptError} `FileApiUnsupported`. The node build runs these
|
|
42
|
+
* APIs normally and this value has no effect there.
|
|
43
|
+
* @see {@link https://envapt.materwelon.dev/docs/compatibility#binding-by-runtime}
|
|
44
|
+
*/
|
|
45
|
+
static set fileApiMode(mode: FileApiMode);
|
|
46
|
+
static get fileApiMode(): FileApiMode;
|
|
56
47
|
/**
|
|
57
48
|
* Eagerly load the `.env` cascade now instead of lazily on the first read. Idempotent: a no-op
|
|
58
49
|
* once the cache is built. Useful before mirroring to `process.env` (see {@link syncProcessEnv}),
|
|
59
50
|
* which is what the `envapt/config` side-effect entry does.
|
|
51
|
+
* @see {@link https://envapt.materwelon.dev/docs/configuration#which-files-load}
|
|
60
52
|
*/
|
|
61
53
|
static load(): void;
|
|
62
54
|
/**
|
|
63
|
-
* Bind the environment {@link Source}. On Node the entry binds {@link
|
|
55
|
+
* Bind the environment {@link Source}. On Node the entry binds {@link FileSource} for you
|
|
64
56
|
* (a `process.env` snapshot plus the `.env` cascade). On the browser or Workers, pass a
|
|
65
|
-
* `PortableSource` (or any `Source`) before reading.
|
|
57
|
+
* `PortableSource` (or any `Source`) before reading. Pass a `(key) => string | undefined` reader for
|
|
58
|
+
* a source that reads one key at a time and cannot list its keys. Clears and rebuilds the cache.
|
|
59
|
+
* @see {@link https://envapt.materwelon.dev/docs/sources#the-providers}
|
|
66
60
|
*/
|
|
67
|
-
static useSource(source: Source): void;
|
|
61
|
+
static useSource(source: Source | ((key: string) => string | undefined)): void;
|
|
68
62
|
/**
|
|
69
63
|
* Read an environment variable as its raw string, skipping parsing and conversion.
|
|
64
|
+
* @see {@link https://envapt.materwelon.dev/docs/envapter#raw-values}
|
|
70
65
|
*/
|
|
71
66
|
getRaw(key: EnvKeyInput): string | undefined;
|
|
72
67
|
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
//#region src/core/Environment.d.ts
|
|
2
|
+
/**
|
|
3
|
+
* Environment types supported by Envapter
|
|
4
|
+
*
|
|
5
|
+
* The following keys are checked in order until the first with a present (non-missing) value, defaulting to development if none are set:
|
|
6
|
+
* - `ENVIRONMENT`
|
|
7
|
+
* - `ENV`
|
|
8
|
+
* - `NODE_ENV`
|
|
9
|
+
* - `MODE`
|
|
10
|
+
*
|
|
11
|
+
* @public
|
|
12
|
+
* @see {@link https://envapt.materwelon.dev/docs/environment#detecting-the-environment}
|
|
13
|
+
*/
|
|
14
|
+
declare enum Environment {
|
|
15
|
+
/** The default when no environment variable names a known environment. */
|
|
16
|
+
Development = 0,
|
|
17
|
+
/** Selected when an environment variable reads `staging`. */
|
|
18
|
+
Staging = 1,
|
|
19
|
+
/** Selected when an environment variable reads `production`. */
|
|
20
|
+
Production = 2,
|
|
21
|
+
/** Selected when an environment variable reads `test`. */
|
|
22
|
+
Test = 3
|
|
23
|
+
}
|
|
24
|
+
//#endregion
|
|
25
|
+
export { Environment };
|
|
26
|
+
//# sourceMappingURL=Environment.d.mts.map
|
|
@@ -1,44 +1,20 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { Environment } from "./Environment.mjs";
|
|
2
2
|
import { EnvapterBase } from "./EnvapterBase.mjs";
|
|
3
3
|
|
|
4
4
|
//#region src/core/EnvironmentMethods.d.ts
|
|
5
|
-
/**
|
|
6
|
-
* Environment types supported by Envapter
|
|
7
|
-
*
|
|
8
|
-
* The following keys are checked in order until the first with a non-empty value is found, or defaulting to development if none are set:
|
|
9
|
-
* - `ENVIRONMENT`
|
|
10
|
-
* - `ENV`
|
|
11
|
-
* - `NODE_ENV`
|
|
12
|
-
* - `MODE`
|
|
13
|
-
*
|
|
14
|
-
* @public
|
|
15
|
-
*/
|
|
16
|
-
declare enum Environment {
|
|
17
|
-
/** The default when no environment variable names a known environment. */
|
|
18
|
-
Development = 0,
|
|
19
|
-
/** Selected when an environment variable reads `staging`. */
|
|
20
|
-
Staging = 1,
|
|
21
|
-
/** Selected when an environment variable reads `production`. */
|
|
22
|
-
Production = 2,
|
|
23
|
-
/** Selected when an environment variable reads `test`. */
|
|
24
|
-
Test = 3
|
|
25
|
-
}
|
|
26
5
|
/**
|
|
27
6
|
* Mixin for environment detection and checking methods
|
|
28
7
|
* @internal
|
|
29
8
|
*/
|
|
30
9
|
declare class EnvironmentMethods extends EnvapterBase {
|
|
31
|
-
protected static _environment: Environment | undefined;
|
|
32
|
-
protected static _environmentExplicitlySet: boolean;
|
|
33
|
-
protected static _profiles: ProfilesConfig | undefined;
|
|
34
|
-
protected static determineEnvironment(env?: string | Environment): void;
|
|
35
|
-
private static firstEnvKeyValue;
|
|
36
10
|
/**
|
|
37
11
|
* Get the current application environment
|
|
12
|
+
* @see {@link https://envapt.materwelon.dev/docs/environment#detecting-the-environment}
|
|
38
13
|
*/
|
|
39
14
|
static get environment(): Environment;
|
|
40
15
|
/**
|
|
41
16
|
* Set the application environment. Accepts either Environment enum or string value.
|
|
17
|
+
* @see {@link https://envapt.materwelon.dev/docs/environment#detecting-the-environment}
|
|
42
18
|
*/
|
|
43
19
|
static set environment(env: string | Environment);
|
|
44
20
|
/**
|
|
@@ -51,6 +27,7 @@ declare class EnvironmentMethods extends EnvapterBase {
|
|
|
51
27
|
set environment(env: string | Environment);
|
|
52
28
|
/**
|
|
53
29
|
* Check if the current environment is production
|
|
30
|
+
* @see {@link https://envapt.materwelon.dev/docs/environment#branching-on-the-environment}
|
|
54
31
|
*/
|
|
55
32
|
static get isProduction(): boolean;
|
|
56
33
|
/**
|
|
@@ -59,6 +36,7 @@ declare class EnvironmentMethods extends EnvapterBase {
|
|
|
59
36
|
get isProduction(): boolean;
|
|
60
37
|
/**
|
|
61
38
|
* Check if the current environment is staging
|
|
39
|
+
* @see {@link https://envapt.materwelon.dev/docs/environment#branching-on-the-environment}
|
|
62
40
|
*/
|
|
63
41
|
static get isStaging(): boolean;
|
|
64
42
|
/**
|
|
@@ -67,6 +45,7 @@ declare class EnvironmentMethods extends EnvapterBase {
|
|
|
67
45
|
get isStaging(): boolean;
|
|
68
46
|
/**
|
|
69
47
|
* Check if the current environment is development
|
|
48
|
+
* @see {@link https://envapt.materwelon.dev/docs/environment#branching-on-the-environment}
|
|
70
49
|
*/
|
|
71
50
|
static get isDevelopment(): boolean;
|
|
72
51
|
/**
|
|
@@ -75,52 +54,14 @@ declare class EnvironmentMethods extends EnvapterBase {
|
|
|
75
54
|
get isDevelopment(): boolean;
|
|
76
55
|
/**
|
|
77
56
|
* Check if the current environment is test
|
|
57
|
+
* @see {@link https://envapt.materwelon.dev/docs/environment#branching-on-the-environment}
|
|
78
58
|
*/
|
|
79
59
|
static get isTest(): boolean;
|
|
80
60
|
/**
|
|
81
61
|
* @see {@link EnvironmentMethods.isTest}
|
|
82
62
|
*/
|
|
83
63
|
get isTest(): boolean;
|
|
84
|
-
protected static refreshCache(): void;
|
|
85
|
-
/**
|
|
86
|
-
* Reads the source's raw vars (not `this.config`, which would recurse: cascade selection runs
|
|
87
|
-
* before the `.env` load). `Envapter.environment` may differ post-load if a file sets `ENVIRONMENT`.
|
|
88
|
-
* @internal
|
|
89
|
-
*/
|
|
90
|
-
protected static getCascadeEnvironment(): Environment;
|
|
91
|
-
/**
|
|
92
|
-
* Build the dotenv-flow cascade for a given environment, in dotenv first-wins precedence
|
|
93
|
-
* order (highest precedence first). Missing files are silently filtered.
|
|
94
|
-
*
|
|
95
|
-
* Precedence is **most-specific-wins** (matches Vite / Astro / Vocs):
|
|
96
|
-
* `.env.${env}.local` \> `.env.${env}` \> `.env.local` \> `.env`
|
|
97
|
-
*
|
|
98
|
-
* This differs from dotenv-flow / Next.js convention which puts `.env.local` above
|
|
99
|
-
* `.env.${env}`. We chose the most-specific-wins order so committed env-specific files
|
|
100
|
-
* (`.env.production`) are authoritative for that environment regardless of whether a
|
|
101
|
-
* stray `.env.local` is present.
|
|
102
|
-
* @internal
|
|
103
|
-
*/
|
|
104
|
-
protected static buildCascadePaths(env: Environment): string[];
|
|
105
|
-
private static normalizeProfilePaths;
|
|
106
|
-
/**
|
|
107
|
-
* Override the base implementation to layer the dotenv-flow cascade + any
|
|
108
|
-
* `Envapter.configureProfiles` overrides on top of `_envPaths` when the user has NOT
|
|
109
|
-
* explicitly set `envPaths`.
|
|
110
|
-
*
|
|
111
|
-
* Precedence (passed to dotenv with first-wins semantics):
|
|
112
|
-
* 1. profile-configured paths for the current env (if any)
|
|
113
|
-
* 2. `.env.${env}.local`
|
|
114
|
-
* 3. `.env.${env}`
|
|
115
|
-
* 4. `.env.local`
|
|
116
|
-
* 5. `.env`
|
|
117
|
-
*
|
|
118
|
-
* If `useDefaults: false` is set on the profiles config, only (1) is loaded, no cascade.
|
|
119
|
-
* If `envPaths` was explicitly set, only `envPaths` is loaded (everything else ignored).
|
|
120
|
-
* @internal
|
|
121
|
-
*/
|
|
122
|
-
protected static resolveEffectivePaths(): string[];
|
|
123
64
|
}
|
|
124
65
|
//#endregion
|
|
125
|
-
export {
|
|
66
|
+
export { EnvironmentMethods };
|
|
126
67
|
//# sourceMappingURL=EnvironmentMethods.d.mts.map
|
|
@@ -1,24 +1,17 @@
|
|
|
1
1
|
import { ConditionalReturn } from "../types/Conversion.mjs";
|
|
2
|
+
import { EnvKeyInput } from "../types/Env.mjs";
|
|
2
3
|
import { EnvironmentMethods } from "./EnvironmentMethods.mjs";
|
|
3
|
-
import { EnvKeyInput, EnvapterService } from "../types/Env.mjs";
|
|
4
|
-
import { ValueConverter } from "../converters/ValueConverter.mjs";
|
|
5
|
-
import { TemplateResolver } from "../engine/TemplateResolver.mjs";
|
|
6
4
|
|
|
7
5
|
//#region src/core/PrimitiveMethods.d.ts
|
|
8
6
|
/**
|
|
9
7
|
* @internal
|
|
10
8
|
*/
|
|
11
|
-
declare class PrimitiveMethods extends EnvironmentMethods
|
|
12
|
-
private static readonly service;
|
|
13
|
-
protected static readonly templateResolver: TemplateResolver;
|
|
14
|
-
protected static readonly valueConverter: ValueConverter;
|
|
15
|
-
isStrict(): boolean;
|
|
16
|
-
protected static resolveForMirror(key: string, value: string): string;
|
|
17
|
-
private static _get;
|
|
9
|
+
declare class PrimitiveMethods extends EnvironmentMethods {
|
|
18
10
|
/**
|
|
19
11
|
* Get a string environment variable with optional fallback.
|
|
20
12
|
* Supports template variable resolution using `${VAR}` syntax.
|
|
21
13
|
* Accepts a single key or an ordered array of keys (first match wins).
|
|
14
|
+
* @see {@link https://envapt.materwelon.dev/docs/envapter#primitives}
|
|
22
15
|
*/
|
|
23
16
|
static get<Default extends string | undefined = undefined>(key: EnvKeyInput, def?: Default): ConditionalReturn<string, Default>;
|
|
24
17
|
/**
|
|
@@ -29,6 +22,7 @@ declare class PrimitiveMethods extends EnvironmentMethods implements EnvapterSer
|
|
|
29
22
|
* Get a number environment variable with optional fallback.
|
|
30
23
|
* Automatically converts string values to numbers.
|
|
31
24
|
* Accepts a single key or an ordered array of keys (first match wins).
|
|
25
|
+
* @see {@link https://envapt.materwelon.dev/docs/envapter#primitives}
|
|
32
26
|
*/
|
|
33
27
|
static getNumber<Default extends number | undefined = undefined>(key: EnvKeyInput, def?: Default): ConditionalReturn<number, Default>;
|
|
34
28
|
/**
|
|
@@ -39,6 +33,7 @@ declare class PrimitiveMethods extends EnvironmentMethods implements EnvapterSer
|
|
|
39
33
|
* Get a boolean environment variable with optional fallback.
|
|
40
34
|
* Recognizes: `1`, `yes`, `true`, `on` as **true**; `0`, `no`, `false`, `off` as **false** (case-insensitive).
|
|
41
35
|
* Accepts a single key or an ordered array of keys (first match wins).
|
|
36
|
+
* @see {@link https://envapt.materwelon.dev/docs/envapter#primitives}
|
|
42
37
|
*/
|
|
43
38
|
static getBoolean<Default extends boolean | undefined = undefined>(key: EnvKeyInput, def?: Default): ConditionalReturn<boolean, Default>;
|
|
44
39
|
/**
|
|
@@ -49,6 +44,7 @@ declare class PrimitiveMethods extends EnvironmentMethods implements EnvapterSer
|
|
|
49
44
|
* Get a bigint environment variable with optional fallback.
|
|
50
45
|
* Automatically converts string values to bigint.
|
|
51
46
|
* Accepts a single key or an ordered array of keys (first match wins).
|
|
47
|
+
* @see {@link https://envapt.materwelon.dev/docs/envapter#primitives}
|
|
52
48
|
*/
|
|
53
49
|
static getBigInt<Default extends bigint | undefined = undefined>(key: EnvKeyInput, def?: Default): ConditionalReturn<bigint, Default>;
|
|
54
50
|
/**
|
|
@@ -59,6 +55,7 @@ declare class PrimitiveMethods extends EnvironmentMethods implements EnvapterSer
|
|
|
59
55
|
* Get a symbol environment variable with optional fallback.
|
|
60
56
|
* Creates a symbol from the string value.
|
|
61
57
|
* Accepts a single key or an ordered array of keys (first match wins).
|
|
58
|
+
* @see {@link https://envapt.materwelon.dev/docs/envapter#primitives}
|
|
62
59
|
*/
|
|
63
60
|
static getSymbol<Default extends symbol | undefined = undefined>(key: EnvKeyInput, def?: Default): ConditionalReturn<symbol, Default>;
|
|
64
61
|
/**
|
|
@@ -6,18 +6,21 @@ import { EnvaptFieldDecorator } from "../../types/Decorator.mjs";
|
|
|
6
6
|
/**
|
|
7
7
|
* Shorthand for `@Envapt(key, { converter: Converters.Boolean, fallback })`.
|
|
8
8
|
* @public
|
|
9
|
+
* @see {@link https://envapt.materwelon.dev/docs/decorators#shorthand-decorators}
|
|
9
10
|
*/
|
|
10
11
|
declare function EnvBool(key: EnvKeyInput, fallback: boolean): EnvaptFieldDecorator<boolean>;
|
|
11
12
|
declare function EnvBool(key: EnvKeyInput): EnvaptFieldDecorator<boolean | null>;
|
|
12
13
|
/**
|
|
13
14
|
* Shorthand for `@Envapt(key, { converter: Converters.Number, fallback })`.
|
|
14
15
|
* @public
|
|
16
|
+
* @see {@link https://envapt.materwelon.dev/docs/decorators#shorthand-decorators}
|
|
15
17
|
*/
|
|
16
18
|
declare function EnvNum(key: EnvKeyInput, fallback: number): EnvaptFieldDecorator<number>;
|
|
17
19
|
declare function EnvNum(key: EnvKeyInput): EnvaptFieldDecorator<number | null>;
|
|
18
20
|
/**
|
|
19
21
|
* Shorthand for `@Envapt(key, { converter: Converters.String, fallback })`.
|
|
20
22
|
* @public
|
|
23
|
+
* @see {@link https://envapt.materwelon.dev/docs/decorators#shorthand-decorators}
|
|
21
24
|
*/
|
|
22
25
|
declare function EnvStr(key: EnvKeyInput, fallback: string): EnvaptFieldDecorator<string>;
|
|
23
26
|
declare function EnvStr(key: EnvKeyInput): EnvaptFieldDecorator<string | null>;
|
|
@@ -25,6 +28,7 @@ declare function EnvStr(key: EnvKeyInput): EnvaptFieldDecorator<string | null>;
|
|
|
25
28
|
* Shorthand for `@Envapt(key, { converter: Converters.Time, fallback })`. The fallback is a
|
|
26
29
|
* millisecond number or a time string (`'15m'`), and the resolved value is always milliseconds.
|
|
27
30
|
* @public
|
|
31
|
+
* @see {@link https://envapt.materwelon.dev/docs/decorators#shorthand-decorators}
|
|
28
32
|
*/
|
|
29
33
|
declare function EnvTime(key: EnvKeyInput, fallback: TimeFallback): EnvaptFieldDecorator<number>;
|
|
30
34
|
declare function EnvTime(key: EnvKeyInput): EnvaptFieldDecorator<number | null>;
|
|
@@ -32,6 +36,7 @@ declare function EnvTime(key: EnvKeyInput): EnvaptFieldDecorator<number | null>;
|
|
|
32
36
|
* Shorthand for `@Envapt(key, { converter: Converters.Url, fallback })`. The fallback is a `URL`
|
|
33
37
|
* instance, not a URL string.
|
|
34
38
|
* @public
|
|
39
|
+
* @see {@link https://envapt.materwelon.dev/docs/decorators#shorthand-decorators}
|
|
35
40
|
*/
|
|
36
41
|
declare function EnvUrl(key: EnvKeyInput, fallback: URL): EnvaptFieldDecorator<URL>;
|
|
37
42
|
declare function EnvUrl(key: EnvKeyInput): EnvaptFieldDecorator<URL | null>;
|
|
@@ -6,18 +6,21 @@ import { EnvaptAccessorDecorator } from "../../types/Decorator.mjs";
|
|
|
6
6
|
/**
|
|
7
7
|
* Shorthand for `@Envapt(key, { converter: Converters.Boolean, fallback })`.
|
|
8
8
|
* @public
|
|
9
|
+
* @see {@link https://envapt.materwelon.dev/docs/decorators#shorthand-decorators}
|
|
9
10
|
*/
|
|
10
11
|
declare function EnvBool(key: EnvKeyInput, fallback: boolean): EnvaptAccessorDecorator<boolean>;
|
|
11
12
|
declare function EnvBool(key: EnvKeyInput): EnvaptAccessorDecorator<boolean | null>;
|
|
12
13
|
/**
|
|
13
14
|
* Shorthand for `@Envapt(key, { converter: Converters.Number, fallback })`.
|
|
14
15
|
* @public
|
|
16
|
+
* @see {@link https://envapt.materwelon.dev/docs/decorators#shorthand-decorators}
|
|
15
17
|
*/
|
|
16
18
|
declare function EnvNum(key: EnvKeyInput, fallback: number): EnvaptAccessorDecorator<number>;
|
|
17
19
|
declare function EnvNum(key: EnvKeyInput): EnvaptAccessorDecorator<number | null>;
|
|
18
20
|
/**
|
|
19
21
|
* Shorthand for `@Envapt(key, { converter: Converters.String, fallback })`.
|
|
20
22
|
* @public
|
|
23
|
+
* @see {@link https://envapt.materwelon.dev/docs/decorators#shorthand-decorators}
|
|
21
24
|
*/
|
|
22
25
|
declare function EnvStr(key: EnvKeyInput, fallback: string): EnvaptAccessorDecorator<string>;
|
|
23
26
|
declare function EnvStr(key: EnvKeyInput): EnvaptAccessorDecorator<string | null>;
|
|
@@ -25,6 +28,7 @@ declare function EnvStr(key: EnvKeyInput): EnvaptAccessorDecorator<string | null
|
|
|
25
28
|
* Shorthand for `@Envapt(key, { converter: Converters.Time, fallback })`. The fallback is a
|
|
26
29
|
* millisecond number or a time string (`'15m'`), and the resolved value is always milliseconds.
|
|
27
30
|
* @public
|
|
31
|
+
* @see {@link https://envapt.materwelon.dev/docs/decorators#shorthand-decorators}
|
|
28
32
|
*/
|
|
29
33
|
declare function EnvTime(key: EnvKeyInput, fallback: TimeFallback): EnvaptAccessorDecorator<number>;
|
|
30
34
|
declare function EnvTime(key: EnvKeyInput): EnvaptAccessorDecorator<number | null>;
|
|
@@ -32,6 +36,7 @@ declare function EnvTime(key: EnvKeyInput): EnvaptAccessorDecorator<number | nul
|
|
|
32
36
|
* Shorthand for `@Envapt(key, { converter: Converters.Url, fallback })`. The fallback is a `URL`
|
|
33
37
|
* instance, not a URL string.
|
|
34
38
|
* @public
|
|
39
|
+
* @see {@link https://envapt.materwelon.dev/docs/decorators#shorthand-decorators}
|
|
35
40
|
*/
|
|
36
41
|
declare function EnvUrl(key: EnvKeyInput, fallback: URL): EnvaptAccessorDecorator<URL>;
|
|
37
42
|
declare function EnvUrl(key: EnvKeyInput): EnvaptAccessorDecorator<URL | null>;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Environment } from "../core/
|
|
1
|
+
import { Environment } from "../core/Environment.mjs";
|
|
2
2
|
import { AdvancedMethods } from "../core/AdvancedMethods.mjs";
|
|
3
3
|
|
|
4
4
|
//#region src/engine/Envapter.d.ts
|
|
@@ -40,6 +40,7 @@ declare class Envapter extends AdvancedMethods {
|
|
|
40
40
|
* const message = Envapter.resolve`Service endpoint: ${'API_URL'}`;
|
|
41
41
|
* // Returns: "Service endpoint: https://api.example.com:8080"
|
|
42
42
|
* ```
|
|
43
|
+
* @see {@link https://envapt.materwelon.dev/docs/templates#the-resolve-tagged-template}
|
|
43
44
|
*/
|
|
44
45
|
static resolve(strings: TemplateStringsArray, ...keys: string[]): string;
|
|
45
46
|
/**
|
|
@@ -47,10 +48,11 @@ declare class Envapter extends AdvancedMethods {
|
|
|
47
48
|
*/
|
|
48
49
|
resolve(strings: TemplateStringsArray, ...keys: string[]): string;
|
|
49
50
|
/**
|
|
50
|
-
* Assert that one or more environment variables are present and non-empty
|
|
51
|
-
*
|
|
51
|
+
* Assert that one or more environment variables are present and non-empty after template
|
|
52
|
+
* resolution. Throws `MissingEnvValue` listing every missing key. A whitespace-only value
|
|
53
|
+
* counts as missing only under strict mode.
|
|
52
54
|
*
|
|
53
|
-
* For typed
|
|
55
|
+
* For a typed required read in functional code, use `Envapter.getRequired(key, converter)`.
|
|
54
56
|
*
|
|
55
57
|
* @example
|
|
56
58
|
* ```ts
|
|
@@ -59,7 +61,6 @@ declare class Envapter extends AdvancedMethods {
|
|
|
59
61
|
* ```
|
|
60
62
|
*/
|
|
61
63
|
static require(...keys: [string, ...string[]]): void;
|
|
62
|
-
private static resolveAndValidate;
|
|
63
64
|
/**
|
|
64
65
|
* @see {@link Envapter.require}
|
|
65
66
|
*/
|