@vibesdotdev/config 0.0.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/README.md +85 -0
- package/SPEC.md +71 -0
- package/dist/adapters/cli/flags.d.ts +75 -0
- package/dist/adapters/cli/flags.d.ts.map +1 -0
- package/dist/adapters/cli/flags.js +221 -0
- package/dist/adapters/cli/flags.js.map +1 -0
- package/dist/adapters/cli/index.d.ts +12 -0
- package/dist/adapters/cli/index.d.ts.map +1 -0
- package/dist/adapters/cli/index.js +9 -0
- package/dist/adapters/cli/index.js.map +1 -0
- package/dist/adapters/cli/mappings.d.ts +17 -0
- package/dist/adapters/cli/mappings.d.ts.map +1 -0
- package/dist/adapters/cli/mappings.js +32 -0
- package/dist/adapters/cli/mappings.js.map +1 -0
- package/dist/adapters/cli/prompts.d.ts +28 -0
- package/dist/adapters/cli/prompts.d.ts.map +1 -0
- package/dist/adapters/cli/prompts.js +55 -0
- package/dist/adapters/cli/prompts.js.map +1 -0
- package/dist/adapters/cli/schemas/flags.schema.d.ts +8 -0
- package/dist/adapters/cli/schemas/flags.schema.d.ts.map +1 -0
- package/dist/adapters/cli/schemas/flags.schema.js +2 -0
- package/dist/adapters/cli/schemas/flags.schema.js.map +1 -0
- package/dist/adapters/cli/schemas/mappings.schema.d.ts +2 -0
- package/dist/adapters/cli/schemas/mappings.schema.d.ts.map +1 -0
- package/dist/adapters/cli/schemas/mappings.schema.js +2 -0
- package/dist/adapters/cli/schemas/mappings.schema.js.map +1 -0
- package/dist/adapters/cli/schemas/prompts.schema.d.ts +5 -0
- package/dist/adapters/cli/schemas/prompts.schema.d.ts.map +1 -0
- package/dist/adapters/cli/schemas/prompts.schema.js +2 -0
- package/dist/adapters/cli/schemas/prompts.schema.js.map +1 -0
- package/dist/adapters/cli/schemas/wizard.schema.d.ts +19 -0
- package/dist/adapters/cli/schemas/wizard.schema.d.ts.map +1 -0
- package/dist/adapters/cli/schemas/wizard.schema.js +2 -0
- package/dist/adapters/cli/schemas/wizard.schema.js.map +1 -0
- package/dist/adapters/cli/wizard.d.ts +33 -0
- package/dist/adapters/cli/wizard.d.ts.map +1 -0
- package/dist/adapters/cli/wizard.js +77 -0
- package/dist/adapters/cli/wizard.js.map +1 -0
- package/dist/browser/index.d.ts +7 -0
- package/dist/browser/index.d.ts.map +1 -0
- package/dist/browser/index.js +4 -0
- package/dist/browser/index.js.map +1 -0
- package/dist/cli/settings.descriptor.d.ts +9 -0
- package/dist/cli/settings.descriptor.d.ts.map +1 -0
- package/dist/cli/settings.descriptor.js +18 -0
- package/dist/cli/settings.descriptor.js.map +1 -0
- package/dist/cli/types.d.ts +57 -0
- package/dist/cli/types.d.ts.map +1 -0
- package/dist/cli/types.js +9 -0
- package/dist/cli/types.js.map +1 -0
- package/dist/client/index.d.ts +19 -0
- package/dist/client/index.d.ts.map +1 -0
- package/dist/client/index.js +145 -0
- package/dist/client/index.js.map +1 -0
- package/dist/client/storage.d.ts +48 -0
- package/dist/client/storage.d.ts.map +1 -0
- package/dist/client/storage.js +46 -0
- package/dist/client/storage.js.map +1 -0
- package/dist/collection/collection.d.ts +46 -0
- package/dist/collection/collection.d.ts.map +1 -0
- package/dist/collection/collection.js +93 -0
- package/dist/collection/collection.js.map +1 -0
- package/dist/collection/index.d.ts +6 -0
- package/dist/collection/index.d.ts.map +1 -0
- package/dist/collection/index.js +5 -0
- package/dist/collection/index.js.map +1 -0
- package/dist/common/index.d.ts +7 -0
- package/dist/common/index.d.ts.map +1 -0
- package/dist/common/index.js +4 -0
- package/dist/common/index.js.map +1 -0
- package/dist/config.context.descriptor.d.ts +21 -0
- package/dist/config.context.descriptor.d.ts.map +1 -0
- package/dist/config.context.descriptor.js +11 -0
- package/dist/config.context.descriptor.js.map +1 -0
- package/dist/config.plugin.d.ts +15 -0
- package/dist/config.plugin.d.ts.map +1 -0
- package/dist/config.plugin.js +166 -0
- package/dist/config.plugin.js.map +1 -0
- package/dist/crud/base-types.d.ts +10 -0
- package/dist/crud/base-types.d.ts.map +1 -0
- package/dist/crud/base-types.js +10 -0
- package/dist/crud/base-types.js.map +1 -0
- package/dist/crud/index.d.ts +4 -0
- package/dist/crud/index.d.ts.map +1 -0
- package/dist/crud/index.js +2 -0
- package/dist/crud/index.js.map +1 -0
- package/dist/crud/schemas/base-types.schema.d.ts +19 -0
- package/dist/crud/schemas/base-types.schema.d.ts.map +1 -0
- package/dist/crud/schemas/base-types.schema.js +2 -0
- package/dist/crud/schemas/base-types.schema.js.map +1 -0
- package/dist/crud/schemas/shared.schema.d.ts +13 -0
- package/dist/crud/schemas/shared.schema.d.ts.map +1 -0
- package/dist/crud/schemas/shared.schema.js +2 -0
- package/dist/crud/schemas/shared.schema.js.map +1 -0
- package/dist/crud/shared.d.ts +8 -0
- package/dist/crud/shared.d.ts.map +1 -0
- package/dist/crud/shared.js +8 -0
- package/dist/crud/shared.js.map +1 -0
- package/dist/crud/types.d.ts +250 -0
- package/dist/crud/types.d.ts.map +1 -0
- package/dist/crud/types.js +22 -0
- package/dist/crud/types.js.map +1 -0
- package/dist/docs/environment.docs.descriptor.d.ts +4 -0
- package/dist/docs/environment.docs.descriptor.d.ts.map +1 -0
- package/dist/docs/environment.docs.descriptor.js +383 -0
- package/dist/docs/environment.docs.descriptor.js.map +1 -0
- package/dist/docs/manifests.docs.descriptor.d.ts +4 -0
- package/dist/docs/manifests.docs.descriptor.d.ts.map +1 -0
- package/dist/docs/manifests.docs.descriptor.js +503 -0
- package/dist/docs/manifests.docs.descriptor.js.map +1 -0
- package/dist/docs/validation.docs.descriptor.d.ts +4 -0
- package/dist/docs/validation.docs.descriptor.d.ts.map +1 -0
- package/dist/docs/validation.docs.descriptor.js +441 -0
- package/dist/docs/validation.docs.descriptor.js.map +1 -0
- package/dist/doctor.d.ts +42 -0
- package/dist/doctor.d.ts.map +1 -0
- package/dist/doctor.js +119 -0
- package/dist/doctor.js.map +1 -0
- package/dist/env.d.ts +28 -0
- package/dist/env.d.ts.map +1 -0
- package/dist/env.js +75 -0
- package/dist/env.js.map +1 -0
- package/dist/env.runtime.d.ts +19 -0
- package/dist/env.runtime.d.ts.map +1 -0
- package/dist/env.runtime.js +37 -0
- package/dist/env.runtime.js.map +1 -0
- package/dist/environment/current.d.ts +32 -0
- package/dist/environment/current.d.ts.map +1 -0
- package/dist/environment/current.js +91 -0
- package/dist/environment/current.js.map +1 -0
- package/dist/environment/environment.config.descriptor.d.ts +11 -0
- package/dist/environment/environment.config.descriptor.d.ts.map +1 -0
- package/dist/environment/environment.config.descriptor.js +51 -0
- package/dist/environment/environment.config.descriptor.js.map +1 -0
- package/dist/environment/environment.config.schema.d.ts +47 -0
- package/dist/environment/environment.config.schema.d.ts.map +1 -0
- package/dist/environment/environment.config.schema.js +19 -0
- package/dist/environment/environment.config.schema.js.map +1 -0
- package/dist/environment/environment.local.descriptor.d.ts +11 -0
- package/dist/environment/environment.local.descriptor.d.ts.map +1 -0
- package/dist/environment/environment.local.descriptor.js +42 -0
- package/dist/environment/environment.local.descriptor.js.map +1 -0
- package/dist/environment/environment.plugin.d.ts +9 -0
- package/dist/environment/environment.plugin.d.ts.map +1 -0
- package/dist/environment/environment.plugin.js +27 -0
- package/dist/environment/environment.plugin.js.map +1 -0
- package/dist/environment/environment.production.descriptor.d.ts +10 -0
- package/dist/environment/environment.production.descriptor.d.ts.map +1 -0
- package/dist/environment/environment.production.descriptor.js +37 -0
- package/dist/environment/environment.production.descriptor.js.map +1 -0
- package/dist/environment/environment.staging.descriptor.d.ts +11 -0
- package/dist/environment/environment.staging.descriptor.d.ts.map +1 -0
- package/dist/environment/environment.staging.descriptor.js +22 -0
- package/dist/environment/environment.staging.descriptor.js.map +1 -0
- package/dist/environment/index.d.ts +8 -0
- package/dist/environment/index.d.ts.map +1 -0
- package/dist/environment/index.js +9 -0
- package/dist/environment/index.js.map +1 -0
- package/dist/environment/kinds/environment.default.d.ts +23 -0
- package/dist/environment/kinds/environment.default.d.ts.map +1 -0
- package/dist/environment/kinds/environment.default.js +49 -0
- package/dist/environment/kinds/environment.default.js.map +1 -0
- package/dist/environment/kinds/environment.interface.d.ts +7 -0
- package/dist/environment/kinds/environment.interface.d.ts.map +1 -0
- package/dist/environment/kinds/environment.interface.js +7 -0
- package/dist/environment/kinds/environment.interface.js.map +1 -0
- package/dist/environment/kinds/environment.kind.d.ts +10 -0
- package/dist/environment/kinds/environment.kind.d.ts.map +1 -0
- package/dist/environment/kinds/environment.kind.js +57 -0
- package/dist/environment/kinds/environment.kind.js.map +1 -0
- package/dist/environment/kinds/environment.schema.d.ts +34 -0
- package/dist/environment/kinds/environment.schema.d.ts.map +1 -0
- package/dist/environment/kinds/environment.schema.js +46 -0
- package/dist/environment/kinds/environment.schema.js.map +1 -0
- package/dist/environment/kinds/index.d.ts +8 -0
- package/dist/environment/kinds/index.d.ts.map +1 -0
- package/dist/environment/kinds/index.js +7 -0
- package/dist/environment/kinds/index.js.map +1 -0
- package/dist/environment/kinds/schemas/environment.interface.schema.d.ts +11 -0
- package/dist/environment/kinds/schemas/environment.interface.schema.d.ts.map +1 -0
- package/dist/environment/kinds/schemas/environment.interface.schema.js +2 -0
- package/dist/environment/kinds/schemas/environment.interface.schema.js.map +1 -0
- package/dist/environment/kinds/schemas/environment.schema.d.ts +30 -0
- package/dist/environment/kinds/schemas/environment.schema.d.ts.map +1 -0
- package/dist/environment/kinds/schemas/environment.schema.js +2 -0
- package/dist/environment/kinds/schemas/environment.schema.js.map +1 -0
- package/dist/environment/schemas/current.schema.d.ts +20 -0
- package/dist/environment/schemas/current.schema.d.ts.map +1 -0
- package/dist/environment/schemas/current.schema.js +2 -0
- package/dist/environment/schemas/current.schema.js.map +1 -0
- package/dist/environment/schemas/environment.config.schema.d.ts +4 -0
- package/dist/environment/schemas/environment.config.schema.d.ts.map +1 -0
- package/dist/environment/schemas/environment.config.schema.js +2 -0
- package/dist/environment/schemas/environment.config.schema.js.map +1 -0
- package/dist/extensions/index.d.ts +8 -0
- package/dist/extensions/index.d.ts.map +1 -0
- package/dist/extensions/index.js +8 -0
- package/dist/extensions/index.js.map +1 -0
- package/dist/extensions/registry.d.ts +41 -0
- package/dist/extensions/registry.d.ts.map +1 -0
- package/dist/extensions/registry.js +142 -0
- package/dist/extensions/registry.js.map +1 -0
- package/dist/extensions/types.d.ts +101 -0
- package/dist/extensions/types.d.ts.map +1 -0
- package/dist/extensions/types.js +8 -0
- package/dist/extensions/types.js.map +1 -0
- package/dist/form/core/field-resolver.d.ts +42 -0
- package/dist/form/core/field-resolver.d.ts.map +1 -0
- package/dist/form/core/field-resolver.js +293 -0
- package/dist/form/core/field-resolver.js.map +1 -0
- package/dist/form/core/groups.d.ts +20 -0
- package/dist/form/core/groups.d.ts.map +1 -0
- package/dist/form/core/groups.js +69 -0
- package/dist/form/core/groups.js.map +1 -0
- package/dist/form/core/index.d.ts +8 -0
- package/dist/form/core/index.d.ts.map +1 -0
- package/dist/form/core/index.js +6 -0
- package/dist/form/core/index.js.map +1 -0
- package/dist/form/core/nested-utils.d.ts +40 -0
- package/dist/form/core/nested-utils.d.ts.map +1 -0
- package/dist/form/core/nested-utils.js +98 -0
- package/dist/form/core/nested-utils.js.map +1 -0
- package/dist/form/core/schemas/validation.schema.d.ts +9 -0
- package/dist/form/core/schemas/validation.schema.d.ts.map +1 -0
- package/dist/form/core/schemas/validation.schema.js +2 -0
- package/dist/form/core/schemas/validation.schema.js.map +1 -0
- package/dist/form/core/types.d.ts +103 -0
- package/dist/form/core/types.d.ts.map +1 -0
- package/dist/form/core/types.js +2 -0
- package/dist/form/core/types.js.map +1 -0
- package/dist/form/core/validation.d.ts +23 -0
- package/dist/form/core/validation.d.ts.map +1 -0
- package/dist/form/core/validation.js +103 -0
- package/dist/form/core/validation.js.map +1 -0
- package/dist/form/core/visibility.d.ts +37 -0
- package/dist/form/core/visibility.d.ts.map +1 -0
- package/dist/form/core/visibility.js +128 -0
- package/dist/form/core/visibility.js.map +1 -0
- package/dist/form/index.d.ts +8 -0
- package/dist/form/index.d.ts.map +1 -0
- package/dist/form/index.js +2 -0
- package/dist/form/index.js.map +1 -0
- package/dist/index.d.ts +18 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +18 -0
- package/dist/index.js.map +1 -0
- package/dist/loader/cli/index.d.ts +61 -0
- package/dist/loader/cli/index.d.ts.map +1 -0
- package/dist/loader/cli/index.js +263 -0
- package/dist/loader/cli/index.js.map +1 -0
- package/dist/loader/cli/loaders.d.ts +13 -0
- package/dist/loader/cli/loaders.d.ts.map +1 -0
- package/dist/loader/cli/loaders.js +132 -0
- package/dist/loader/cli/loaders.js.map +1 -0
- package/dist/loader/cli/types.d.ts +152 -0
- package/dist/loader/cli/types.d.ts.map +1 -0
- package/dist/loader/cli/types.js +5 -0
- package/dist/loader/cli/types.js.map +1 -0
- package/dist/loader/cli/utils.d.ts +53 -0
- package/dist/loader/cli/utils.d.ts.map +1 -0
- package/dist/loader/cli/utils.js +198 -0
- package/dist/loader/cli/utils.js.map +1 -0
- package/dist/loader/client.d.ts +18 -0
- package/dist/loader/client.d.ts.map +1 -0
- package/dist/loader/client.js +109 -0
- package/dist/loader/client.js.map +1 -0
- package/dist/loader/discovery.d.ts +48 -0
- package/dist/loader/discovery.d.ts.map +1 -0
- package/dist/loader/discovery.js +253 -0
- package/dist/loader/discovery.js.map +1 -0
- package/dist/loader/file-loader.d.ts +17 -0
- package/dist/loader/file-loader.d.ts.map +1 -0
- package/dist/loader/file-loader.js +237 -0
- package/dist/loader/file-loader.js.map +1 -0
- package/dist/loader/index.d.ts +9 -0
- package/dist/loader/index.d.ts.map +1 -0
- package/dist/loader/index.js +8 -0
- package/dist/loader/index.js.map +1 -0
- package/dist/loader/index.server.d.ts +66 -0
- package/dist/loader/index.server.d.ts.map +1 -0
- package/dist/loader/index.server.js +256 -0
- package/dist/loader/index.server.js.map +1 -0
- package/dist/loader/merge.d.ts +88 -0
- package/dist/loader/merge.d.ts.map +1 -0
- package/dist/loader/merge.js +301 -0
- package/dist/loader/merge.js.map +1 -0
- package/dist/loader/schemas/merge.schema.d.ts +8 -0
- package/dist/loader/schemas/merge.schema.d.ts.map +1 -0
- package/dist/loader/schemas/merge.schema.js +2 -0
- package/dist/loader/schemas/merge.schema.js.map +1 -0
- package/dist/loader/schemas/validation.schema.d.ts +17 -0
- package/dist/loader/schemas/validation.schema.d.ts.map +1 -0
- package/dist/loader/schemas/validation.schema.js +2 -0
- package/dist/loader/schemas/validation.schema.js.map +1 -0
- package/dist/loader/server.d.ts +3 -0
- package/dist/loader/server.d.ts.map +1 -0
- package/dist/loader/server.js +2 -0
- package/dist/loader/server.js.map +1 -0
- package/dist/loader/types.d.ts +136 -0
- package/dist/loader/types.d.ts.map +1 -0
- package/dist/loader/types.js +24 -0
- package/dist/loader/types.js.map +1 -0
- package/dist/loader/validation.d.ts +59 -0
- package/dist/loader/validation.d.ts.map +1 -0
- package/dist/loader/validation.js +218 -0
- package/dist/loader/validation.js.map +1 -0
- package/dist/manifest/builder.d.ts +172 -0
- package/dist/manifest/builder.d.ts.map +1 -0
- package/dist/manifest/builder.js +336 -0
- package/dist/manifest/builder.js.map +1 -0
- package/dist/manifest/config-manifest.d.ts +199 -0
- package/dist/manifest/config-manifest.d.ts.map +1 -0
- package/dist/manifest/config-manifest.js +388 -0
- package/dist/manifest/config-manifest.js.map +1 -0
- package/dist/manifest/index.d.ts +10 -0
- package/dist/manifest/index.d.ts.map +1 -0
- package/dist/manifest/index.js +20 -0
- package/dist/manifest/index.js.map +1 -0
- package/dist/manifest/schema.d.ts +460 -0
- package/dist/manifest/schema.d.ts.map +1 -0
- package/dist/manifest/schema.js +187 -0
- package/dist/manifest/schema.js.map +1 -0
- package/dist/manifest/schemas/builder.schema.d.ts +20 -0
- package/dist/manifest/schemas/builder.schema.d.ts.map +1 -0
- package/dist/manifest/schemas/builder.schema.js +2 -0
- package/dist/manifest/schemas/builder.schema.js.map +1 -0
- package/dist/manifest/schemas/config-manifest.schema.d.ts +2 -0
- package/dist/manifest/schemas/config-manifest.schema.d.ts.map +1 -0
- package/dist/manifest/schemas/config-manifest.schema.js +2 -0
- package/dist/manifest/schemas/config-manifest.schema.js.map +1 -0
- package/dist/manifest/schemas/schema.schema.d.ts +83 -0
- package/dist/manifest/schemas/schema.schema.d.ts.map +1 -0
- package/dist/manifest/schemas/schema.schema.js +2 -0
- package/dist/manifest/schemas/schema.schema.js.map +1 -0
- package/dist/manifest/types.d.ts +563 -0
- package/dist/manifest/types.d.ts.map +1 -0
- package/dist/manifest/types.js +9 -0
- package/dist/manifest/types.js.map +1 -0
- package/dist/routing/index.d.ts +29 -0
- package/dist/routing/index.d.ts.map +1 -0
- package/dist/routing/index.js +35 -0
- package/dist/routing/index.js.map +1 -0
- package/dist/routing/merge.d.ts +164 -0
- package/dist/routing/merge.d.ts.map +1 -0
- package/dist/routing/merge.js +460 -0
- package/dist/routing/merge.js.map +1 -0
- package/dist/routing/registry.d.ts +145 -0
- package/dist/routing/registry.d.ts.map +1 -0
- package/dist/routing/registry.js +459 -0
- package/dist/routing/registry.js.map +1 -0
- package/dist/routing/schemas/merge.schema.d.ts +5 -0
- package/dist/routing/schemas/merge.schema.d.ts.map +1 -0
- package/dist/routing/schemas/merge.schema.js +2 -0
- package/dist/routing/schemas/merge.schema.js.map +1 -0
- package/dist/routing/types.d.ts +358 -0
- package/dist/routing/types.d.ts.map +1 -0
- package/dist/routing/types.js +89 -0
- package/dist/routing/types.js.map +1 -0
- package/dist/schema/extend-zod.d.ts +137 -0
- package/dist/schema/extend-zod.d.ts.map +1 -0
- package/dist/schema/extend-zod.js +243 -0
- package/dist/schema/extend-zod.js.map +1 -0
- package/dist/schema/index.d.ts +9 -0
- package/dist/schema/index.d.ts.map +1 -0
- package/dist/schema/index.js +10 -0
- package/dist/schema/index.js.map +1 -0
- package/dist/schema/references.d.ts +9 -0
- package/dist/schema/references.d.ts.map +1 -0
- package/dist/schema/references.js +9 -0
- package/dist/schema/references.js.map +1 -0
- package/dist/schema/resolver.d.ts +45 -0
- package/dist/schema/resolver.d.ts.map +1 -0
- package/dist/schema/resolver.js +267 -0
- package/dist/schema/resolver.js.map +1 -0
- package/dist/schema/schemas/extend-zod.schema.d.ts +16 -0
- package/dist/schema/schemas/extend-zod.schema.d.ts.map +1 -0
- package/dist/schema/schemas/extend-zod.schema.js +2 -0
- package/dist/schema/schemas/extend-zod.schema.js.map +1 -0
- package/dist/schema/schemas/references.schema.d.ts +70 -0
- package/dist/schema/schemas/references.schema.d.ts.map +1 -0
- package/dist/schema/schemas/references.schema.js +2 -0
- package/dist/schema/schemas/references.schema.js.map +1 -0
- package/dist/schemas/collection.d.ts +31 -0
- package/dist/schemas/collection.d.ts.map +1 -0
- package/dist/schemas/collection.js +22 -0
- package/dist/schemas/collection.js.map +1 -0
- package/dist/schemas/config-manifest-descriptor.d.ts +495 -0
- package/dist/schemas/config-manifest-descriptor.d.ts.map +1 -0
- package/dist/schemas/config-manifest-descriptor.js +210 -0
- package/dist/schemas/config-manifest-descriptor.js.map +1 -0
- package/dist/schemas/config-registry-state.d.ts +8 -0
- package/dist/schemas/config-registry-state.d.ts.map +1 -0
- package/dist/schemas/config-registry-state.js +6 -0
- package/dist/schemas/config-registry-state.js.map +1 -0
- package/dist/schemas/doctor.schema.d.ts +25 -0
- package/dist/schemas/doctor.schema.d.ts.map +1 -0
- package/dist/schemas/doctor.schema.js +2 -0
- package/dist/schemas/doctor.schema.js.map +1 -0
- package/dist/schemas/index.d.ts +8 -0
- package/dist/schemas/index.d.ts.map +1 -0
- package/dist/schemas/index.js +21 -0
- package/dist/schemas/index.js.map +1 -0
- package/dist/server/index.d.ts +5 -0
- package/dist/server/index.d.ts.map +1 -0
- package/dist/server/index.js +4 -0
- package/dist/server/index.js.map +1 -0
- package/dist/services/config-accessor.d.ts +40 -0
- package/dist/services/config-accessor.d.ts.map +1 -0
- package/dist/services/config-accessor.js +180 -0
- package/dist/services/config-accessor.js.map +1 -0
- package/dist/services/config-storage/index.d.ts +8 -0
- package/dist/services/config-storage/index.d.ts.map +1 -0
- package/dist/services/config-storage/index.js +7 -0
- package/dist/services/config-storage/index.js.map +1 -0
- package/dist/services/config-storage/service.d.ts +63 -0
- package/dist/services/config-storage/service.d.ts.map +1 -0
- package/dist/services/config-storage/service.js +234 -0
- package/dist/services/config-storage/service.js.map +1 -0
- package/dist/services/config.d.ts +3 -0
- package/dist/services/config.d.ts.map +1 -0
- package/dist/services/config.js +30 -0
- package/dist/services/config.js.map +1 -0
- package/dist/services/encryption.d.ts +114 -0
- package/dist/services/encryption.d.ts.map +1 -0
- package/dist/services/encryption.js +232 -0
- package/dist/services/encryption.js.map +1 -0
- package/dist/services/index.d.ts +12 -0
- package/dist/services/index.d.ts.map +1 -0
- package/dist/services/index.js +16 -0
- package/dist/services/index.js.map +1 -0
- package/dist/services/loader/loader.descriptor.d.ts +103 -0
- package/dist/services/loader/loader.descriptor.d.ts.map +1 -0
- package/dist/services/loader/loader.descriptor.js +60 -0
- package/dist/services/loader/loader.descriptor.js.map +1 -0
- package/dist/services/loader/loader.impl.cloud.d.ts +55 -0
- package/dist/services/loader/loader.impl.cloud.d.ts.map +1 -0
- package/dist/services/loader/loader.impl.cloud.js +182 -0
- package/dist/services/loader/loader.impl.cloud.js.map +1 -0
- package/dist/services/loader/loader.impl.consumer.d.ts +48 -0
- package/dist/services/loader/loader.impl.consumer.d.ts.map +1 -0
- package/dist/services/loader/loader.impl.consumer.js +175 -0
- package/dist/services/loader/loader.impl.consumer.js.map +1 -0
- package/dist/services/loader/loader.impl.consumer.local-first.d.ts +59 -0
- package/dist/services/loader/loader.impl.consumer.local-first.d.ts.map +1 -0
- package/dist/services/loader/loader.impl.consumer.local-first.js +347 -0
- package/dist/services/loader/loader.impl.consumer.local-first.js.map +1 -0
- package/dist/services/manifest-utils.d.ts +47 -0
- package/dist/services/manifest-utils.d.ts.map +1 -0
- package/dist/services/manifest-utils.js +105 -0
- package/dist/services/manifest-utils.js.map +1 -0
- package/dist/services/schemas/config-accessor.schema.d.ts +10 -0
- package/dist/services/schemas/config-accessor.schema.d.ts.map +1 -0
- package/dist/services/schemas/config-accessor.schema.js +2 -0
- package/dist/services/schemas/config-accessor.schema.js.map +1 -0
- package/dist/services/schemas/encryption.schema.d.ts +22 -0
- package/dist/services/schemas/encryption.schema.d.ts.map +1 -0
- package/dist/services/schemas/encryption.schema.js +2 -0
- package/dist/services/schemas/encryption.schema.js.map +1 -0
- package/dist/services/schemas/manifest-utils.schema.d.ts +4 -0
- package/dist/services/schemas/manifest-utils.schema.d.ts.map +1 -0
- package/dist/services/schemas/manifest-utils.schema.js +2 -0
- package/dist/services/schemas/manifest-utils.schema.js.map +1 -0
- package/dist/settings/assemble.d.ts +28 -0
- package/dist/settings/assemble.d.ts.map +1 -0
- package/dist/settings/assemble.js +30 -0
- package/dist/settings/assemble.js.map +1 -0
- package/dist/settings/index.d.ts +10 -0
- package/dist/settings/index.d.ts.map +1 -0
- package/dist/settings/index.js +10 -0
- package/dist/settings/index.js.map +1 -0
- package/dist/settings/settings-section.schema.d.ts +49 -0
- package/dist/settings/settings-section.schema.d.ts.map +1 -0
- package/dist/settings/settings-section.schema.js +70 -0
- package/dist/settings/settings-section.schema.js.map +1 -0
- package/dist/storage/adapter.d.ts +11 -0
- package/dist/storage/adapter.d.ts.map +1 -0
- package/dist/storage/adapter.js +8 -0
- package/dist/storage/adapter.js.map +1 -0
- package/dist/storage/index.d.ts +8 -0
- package/dist/storage/index.d.ts.map +1 -0
- package/dist/storage/index.js +8 -0
- package/dist/storage/index.js.map +1 -0
- package/dist/storage/schemas.d.ts +257 -0
- package/dist/storage/schemas.d.ts.map +1 -0
- package/dist/storage/schemas.js +179 -0
- package/dist/storage/schemas.js.map +1 -0
- package/dist/storage/types.d.ts +74 -0
- package/dist/storage/types.d.ts.map +1 -0
- package/dist/storage/types.js +7 -0
- package/dist/storage/types.js.map +1 -0
- package/dist/system-constants.d.ts +95 -0
- package/dist/system-constants.d.ts.map +1 -0
- package/dist/system-constants.js +110 -0
- package/dist/system-constants.js.map +1 -0
- package/package.json +417 -0
- package/src/adapters/cli/flags.ts +260 -0
- package/src/adapters/cli/index.ts +24 -0
- package/src/adapters/cli/mappings.ts +43 -0
- package/src/adapters/cli/prompts.ts +70 -0
- package/src/adapters/cli/schemas/flags.schema.ts +8 -0
- package/src/adapters/cli/schemas/mappings.schema.ts +3 -0
- package/src/adapters/cli/schemas/prompts.schema.ts +4 -0
- package/src/adapters/cli/schemas/wizard.schema.ts +21 -0
- package/src/adapters/cli/wizard.ts +106 -0
- package/src/adapters/web/components/ManifestForm.svelte +817 -0
- package/src/browser/index.ts +86 -0
- package/src/cli/settings.descriptor.ts +23 -0
- package/src/cli/types.ts +59 -0
- package/src/client/index.ts +169 -0
- package/src/client/storage.ts +76 -0
- package/src/collection/collection.ts +121 -0
- package/src/collection/index.ts +6 -0
- package/src/common/index.ts +86 -0
- package/src/config.context.descriptor.ts +12 -0
- package/src/config.plugin.ts +214 -0
- package/src/crud/base-types.ts +10 -0
- package/src/crud/index.ts +15 -0
- package/src/crud/schemas/base-types.schema.ts +20 -0
- package/src/crud/schemas/shared.schema.ts +14 -0
- package/src/crud/shared.ts +8 -0
- package/src/crud/types.ts +299 -0
- package/src/docs/environment.docs.descriptor.ts +385 -0
- package/src/docs/manifests.docs.descriptor.ts +505 -0
- package/src/docs/validation.docs.descriptor.ts +443 -0
- package/src/doctor.ts +143 -0
- package/src/env.runtime.ts +49 -0
- package/src/env.ts +91 -0
- package/src/environment/current.ts +108 -0
- package/src/environment/environment.config.descriptor.ts +60 -0
- package/src/environment/environment.config.schema.ts +24 -0
- package/src/environment/environment.local.descriptor.ts +45 -0
- package/src/environment/environment.plugin.ts +31 -0
- package/src/environment/environment.production.descriptor.ts +40 -0
- package/src/environment/environment.staging.descriptor.ts +25 -0
- package/src/environment/index.ts +22 -0
- package/src/environment/kinds/environment.default.ts +57 -0
- package/src/environment/kinds/environment.interface.ts +10 -0
- package/src/environment/kinds/environment.kind.ts +69 -0
- package/src/environment/kinds/environment.schema.ts +57 -0
- package/src/environment/kinds/index.ts +8 -0
- package/src/environment/kinds/schemas/environment.interface.schema.ts +11 -0
- package/src/environment/kinds/schemas/environment.schema.ts +24 -0
- package/src/environment/schemas/current.schema.ts +21 -0
- package/src/environment/schemas/environment.config.schema.ts +3 -0
- package/src/extensions/index.ts +26 -0
- package/src/extensions/registry.ts +179 -0
- package/src/extensions/types.ts +123 -0
- package/src/form/core/field-resolver.ts +380 -0
- package/src/form/core/groups.ts +96 -0
- package/src/form/core/index.ts +41 -0
- package/src/form/core/nested-utils.ts +115 -0
- package/src/form/core/schemas/validation.schema.ts +9 -0
- package/src/form/core/types.ts +115 -0
- package/src/form/core/validation.ts +137 -0
- package/src/form/core/visibility.ts +172 -0
- package/src/form/index.ts +36 -0
- package/src/index.ts +69 -0
- package/src/js-yaml.d.ts +4 -0
- package/src/loader/cli/index.ts +386 -0
- package/src/loader/cli/loaders.ts +153 -0
- package/src/loader/cli/types.ts +181 -0
- package/src/loader/cli/utils.ts +236 -0
- package/src/loader/client.ts +140 -0
- package/src/loader/discovery.ts +291 -0
- package/src/loader/file-loader.ts +262 -0
- package/src/loader/index.server.ts +389 -0
- package/src/loader/index.ts +18 -0
- package/src/loader/merge.ts +366 -0
- package/src/loader/schemas/merge.schema.ts +8 -0
- package/src/loader/schemas/validation.schema.ts +18 -0
- package/src/loader/server.ts +15 -0
- package/src/loader/types.ts +142 -0
- package/src/loader/validation.ts +261 -0
- package/src/manifest/builder.ts +452 -0
- package/src/manifest/config-manifest.ts +482 -0
- package/src/manifest/index.ts +92 -0
- package/src/manifest/schema.ts +249 -0
- package/src/manifest/schemas/builder.schema.ts +33 -0
- package/src/manifest/schemas/config-manifest.schema.ts +1 -0
- package/src/manifest/schemas/schema.schema.ts +99 -0
- package/src/manifest/types.ts +726 -0
- package/src/routing/index.ts +105 -0
- package/src/routing/merge.ts +589 -0
- package/src/routing/registry.ts +595 -0
- package/src/routing/schemas/merge.schema.ts +6 -0
- package/src/routing/types.ts +470 -0
- package/src/schema/extend-zod.ts +289 -0
- package/src/schema/index.ts +44 -0
- package/src/schema/references.ts +21 -0
- package/src/schema/resolver.ts +343 -0
- package/src/schema/schemas/extend-zod.schema.ts +16 -0
- package/src/schema/schemas/references.schema.ts +86 -0
- package/src/schemas/collection.ts +38 -0
- package/src/schemas/config-manifest-descriptor.ts +259 -0
- package/src/schemas/config-registry-state.ts +13 -0
- package/src/schemas/doctor.schema.ts +27 -0
- package/src/schemas/index.ts +53 -0
- package/src/server/index.ts +4 -0
- package/src/services/config-accessor.ts +218 -0
- package/src/services/config-storage/index.ts +8 -0
- package/src/services/config-storage/service.ts +355 -0
- package/src/services/config.ts +37 -0
- package/src/services/encryption.ts +260 -0
- package/src/services/index.ts +34 -0
- package/src/services/loader/loader.descriptor.ts +96 -0
- package/src/services/loader/loader.impl.cloud.ts +214 -0
- package/src/services/loader/loader.impl.consumer.local-first.ts +417 -0
- package/src/services/loader/loader.impl.consumer.ts +213 -0
- package/src/services/manifest-utils.ts +119 -0
- package/src/services/schemas/config-accessor.schema.ts +11 -0
- package/src/services/schemas/encryption.schema.ts +23 -0
- package/src/services/schemas/manifest-utils.schema.ts +4 -0
- package/src/settings/assemble.ts +46 -0
- package/src/settings/index.ts +19 -0
- package/src/settings/settings-section.schema.ts +84 -0
- package/src/storage/adapter.ts +12 -0
- package/src/storage/index.ts +48 -0
- package/src/storage/schemas.ts +215 -0
- package/src/storage/types.ts +88 -0
- package/src/system-constants.ts +121 -0
|
@@ -0,0 +1,441 @@
|
|
|
1
|
+
const descriptor = {
|
|
2
|
+
kind: 'docs/topic',
|
|
3
|
+
id: 'config.validation',
|
|
4
|
+
title: 'Configuration Validation',
|
|
5
|
+
summary: 'Schema validation, error handling, and defaults',
|
|
6
|
+
body: {
|
|
7
|
+
type: 'markdown',
|
|
8
|
+
sourceType: 'raw',
|
|
9
|
+
source: `---
|
|
10
|
+
title: Configuration Validation
|
|
11
|
+
summary: Schema validation, error handling, and defaults
|
|
12
|
+
tags: [config, validation, schema, errors, defaults]
|
|
13
|
+
parent: config
|
|
14
|
+
order: 3
|
|
15
|
+
surfaces: [cli, web, in-app]
|
|
16
|
+
hardware: [consumer, cloud]
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
# Configuration Validation
|
|
20
|
+
|
|
21
|
+
Configuration validation ensures config data meets schema requirements, provides helpful error messages, and applies sensible defaults. The config system uses Zod schemas for type-safe validation.
|
|
22
|
+
|
|
23
|
+
## Schema Validation
|
|
24
|
+
|
|
25
|
+
### Zod Schema Basics
|
|
26
|
+
|
|
27
|
+
\`\`\`ts
|
|
28
|
+
import { z } from 'zod';
|
|
29
|
+
|
|
30
|
+
const configSchema = z.object({
|
|
31
|
+
// Required string
|
|
32
|
+
apiKey: z.string().min(1),
|
|
33
|
+
|
|
34
|
+
// Number with range
|
|
35
|
+
port: z.number().min(1).max(65535),
|
|
36
|
+
|
|
37
|
+
// Enum type
|
|
38
|
+
environment: z.enum(['development', 'production']),
|
|
39
|
+
|
|
40
|
+
// Optional with default
|
|
41
|
+
timeout: z.number().default(5000),
|
|
42
|
+
|
|
43
|
+
// Array of strings
|
|
44
|
+
allowedOrigins: z.array(z.string().url()),
|
|
45
|
+
|
|
46
|
+
// Nested object
|
|
47
|
+
database: z.object({
|
|
48
|
+
host: z.string(),
|
|
49
|
+
port: z.number(),
|
|
50
|
+
name: z.string()
|
|
51
|
+
})
|
|
52
|
+
});
|
|
53
|
+
\`\`\`
|
|
54
|
+
|
|
55
|
+
### Parsing Configuration
|
|
56
|
+
|
|
57
|
+
\`\`\`ts
|
|
58
|
+
import { z } from 'zod';
|
|
59
|
+
|
|
60
|
+
const configSchema = z.object({
|
|
61
|
+
apiKey: z.string().min(1),
|
|
62
|
+
port: z.number().default(3000)
|
|
63
|
+
});
|
|
64
|
+
|
|
65
|
+
const rawConfig = {
|
|
66
|
+
apiKey: '<api-key>',
|
|
67
|
+
port: '3000' // string, will be coerced
|
|
68
|
+
};
|
|
69
|
+
|
|
70
|
+
try {
|
|
71
|
+
const config = configSchema.parse(rawConfig);
|
|
72
|
+
console.log(config); // { apiKey: '<api-key>', port: 3000 }
|
|
73
|
+
} catch (error) {
|
|
74
|
+
if (error instanceof z.ZodError) {
|
|
75
|
+
console.error(error.errors);
|
|
76
|
+
// [
|
|
77
|
+
// {
|
|
78
|
+
// path: ['apiKey'],
|
|
79
|
+
// message: 'Required',
|
|
80
|
+
// code: 'invalid_type'
|
|
81
|
+
// }
|
|
82
|
+
// ]
|
|
83
|
+
}
|
|
84
|
+
}
|
|
85
|
+
\`\`\`
|
|
86
|
+
|
|
87
|
+
### Type Coercion
|
|
88
|
+
|
|
89
|
+
\`\`\`ts
|
|
90
|
+
const configSchema = z.object({
|
|
91
|
+
// Coerce string to number
|
|
92
|
+
port: z.coerce.number().default(3000),
|
|
93
|
+
|
|
94
|
+
// Coerce string to boolean
|
|
95
|
+
debug: z.coerce.boolean().default(false),
|
|
96
|
+
|
|
97
|
+
// Coerce string to date
|
|
98
|
+
createdAt: z.coerce.date()
|
|
99
|
+
});
|
|
100
|
+
|
|
101
|
+
const rawConfig = {
|
|
102
|
+
port: '3000',
|
|
103
|
+
debug: 'true',
|
|
104
|
+
createdAt: '2024-01-01'
|
|
105
|
+
};
|
|
106
|
+
|
|
107
|
+
const config = configSchema.parse(rawConfig);
|
|
108
|
+
// { port: 3000, debug: true, createdAt: Date }
|
|
109
|
+
\`\`\`
|
|
110
|
+
|
|
111
|
+
## Validation Errors
|
|
112
|
+
|
|
113
|
+
### Error Format
|
|
114
|
+
|
|
115
|
+
\`\`\`ts
|
|
116
|
+
interface ValidationError {
|
|
117
|
+
code: string; // 'invalid_type', 'too_small', etc.
|
|
118
|
+
path: string[]; // ['database', 'host']
|
|
119
|
+
message: string; // 'Required'
|
|
120
|
+
expected?: string; // 'string'
|
|
121
|
+
received?: string; // 'undefined'
|
|
122
|
+
}
|
|
123
|
+
\`\`\`
|
|
124
|
+
|
|
125
|
+
### Error Handling
|
|
126
|
+
|
|
127
|
+
\`\`\`ts
|
|
128
|
+
import { validateConfig } from '@vibesdotdev/config';
|
|
129
|
+
|
|
130
|
+
const result = validateConfig(configSchema, rawData);
|
|
131
|
+
|
|
132
|
+
if (!result.success) {
|
|
133
|
+
console.error('Validation failed:');
|
|
134
|
+
for (const error of result.errors) {
|
|
135
|
+
console.error(\` \${error.path.join('.')}: \${error.message}\`);
|
|
136
|
+
}
|
|
137
|
+
} else {
|
|
138
|
+
console.log('Config valid:', result.data);
|
|
139
|
+
}
|
|
140
|
+
\`\`\`
|
|
141
|
+
|
|
142
|
+
### Custom Error Messages
|
|
143
|
+
|
|
144
|
+
\`\`\`ts
|
|
145
|
+
const configSchema = z.object({
|
|
146
|
+
email: z.string().email('Must be a valid email address'),
|
|
147
|
+
password: z
|
|
148
|
+
.string()
|
|
149
|
+
.min(8, 'Password must be at least 8 characters')
|
|
150
|
+
.regex(/[A-Z]/, 'Password must contain uppercase letter')
|
|
151
|
+
.regex(/[0-9]/, 'Password must contain number'),
|
|
152
|
+
age: z.number().min(18, 'Must be 18 or older')
|
|
153
|
+
});
|
|
154
|
+
\`\`\`
|
|
155
|
+
|
|
156
|
+
### Error Formatting
|
|
157
|
+
|
|
158
|
+
\`\`\`ts
|
|
159
|
+
import { formatValidationErrors } from '@vibesdotdev/config';
|
|
160
|
+
|
|
161
|
+
try {
|
|
162
|
+
configSchema.parse(rawData);
|
|
163
|
+
} catch (error) {
|
|
164
|
+
if (error instanceof z.ZodError) {
|
|
165
|
+
const formatted = formatValidationErrors(error);
|
|
166
|
+
console.log(formatted);
|
|
167
|
+
// {
|
|
168
|
+
// fieldErrors: {
|
|
169
|
+
// email: ['Must be a valid email address'],
|
|
170
|
+
// password: ['Password must be at least 8 characters']
|
|
171
|
+
// },
|
|
172
|
+
// rootErrors: []
|
|
173
|
+
// }
|
|
174
|
+
}
|
|
175
|
+
}
|
|
176
|
+
\`\`\`
|
|
177
|
+
|
|
178
|
+
## Default Values
|
|
179
|
+
|
|
180
|
+
### Schema Defaults
|
|
181
|
+
|
|
182
|
+
\`\`\`ts
|
|
183
|
+
const configSchema = z.object({
|
|
184
|
+
// Simple default
|
|
185
|
+
debug: z.boolean().default(false),
|
|
186
|
+
|
|
187
|
+
// Default with transform
|
|
188
|
+
tags: z.string().transform((s) => s.split(',')).default(''),
|
|
189
|
+
|
|
190
|
+
// Default object
|
|
191
|
+
settings: z.object({
|
|
192
|
+
theme: z.enum(['light', 'dark']).default('system'),
|
|
193
|
+
notifications: z.boolean().default(true)
|
|
194
|
+
}).default({})
|
|
195
|
+
});
|
|
196
|
+
\`\`\`
|
|
197
|
+
|
|
198
|
+
### Context-Aware Defaults
|
|
199
|
+
|
|
200
|
+
\`\`\`ts
|
|
201
|
+
import { applyDefaults } from '@vibesdotdev/config';
|
|
202
|
+
|
|
203
|
+
const configSchema = z.object({
|
|
204
|
+
apiUrl: z.string(),
|
|
205
|
+
timeout: z.number()
|
|
206
|
+
});
|
|
207
|
+
|
|
208
|
+
const defaults = {
|
|
209
|
+
apiUrl: {
|
|
210
|
+
type: 'context',
|
|
211
|
+
rules: [
|
|
212
|
+
{
|
|
213
|
+
when: { environment: 'development' },
|
|
214
|
+
value: 'http://localhost:3000'
|
|
215
|
+
},
|
|
216
|
+
{
|
|
217
|
+
when: { environment: 'production' },
|
|
218
|
+
value: 'https://api.vibes.dev'
|
|
219
|
+
}
|
|
220
|
+
]
|
|
221
|
+
},
|
|
222
|
+
timeout: {
|
|
223
|
+
type: 'context',
|
|
224
|
+
rules: [
|
|
225
|
+
{
|
|
226
|
+
when: { hardware: 'consumer' },
|
|
227
|
+
value: 30000
|
|
228
|
+
},
|
|
229
|
+
{
|
|
230
|
+
when: { hardware: 'cloud' },
|
|
231
|
+
value: 10000
|
|
232
|
+
}
|
|
233
|
+
]
|
|
234
|
+
}
|
|
235
|
+
};
|
|
236
|
+
|
|
237
|
+
const config = applyDefaults(configSchema, rawData, {
|
|
238
|
+
environment: 'production',
|
|
239
|
+
hardware: 'cloud'
|
|
240
|
+
});
|
|
241
|
+
\`\`\`
|
|
242
|
+
|
|
243
|
+
### Lazy Defaults
|
|
244
|
+
|
|
245
|
+
\`\`\`ts
|
|
246
|
+
const configSchema = z.object({
|
|
247
|
+
// Default from environment variable
|
|
248
|
+
apiKey: z.string().default(() => process.env.API_KEY),
|
|
249
|
+
|
|
250
|
+
// Default from function
|
|
251
|
+
timestamp: z.number().default(() => Date.now()),
|
|
252
|
+
|
|
253
|
+
// Default from async function
|
|
254
|
+
version: z.string().default(async () => {
|
|
255
|
+
const pkg = await import('../package.json');
|
|
256
|
+
return pkg.version;
|
|
257
|
+
})
|
|
258
|
+
});
|
|
259
|
+
\`\`\`
|
|
260
|
+
|
|
261
|
+
## Custom Validation
|
|
262
|
+
|
|
263
|
+
### Refine Validation
|
|
264
|
+
|
|
265
|
+
\`\`\`ts
|
|
266
|
+
const configSchema = z.object({
|
|
267
|
+
password: z.string(),
|
|
268
|
+
confirmPassword: z.string()
|
|
269
|
+
}).refine(
|
|
270
|
+
(data) => data.password === data.confirmPassword,
|
|
271
|
+
{
|
|
272
|
+
message: 'Passwords do not match',
|
|
273
|
+
path: ['confirmPassword']
|
|
274
|
+
}
|
|
275
|
+
);
|
|
276
|
+
\`\`\`
|
|
277
|
+
|
|
278
|
+
### Async Validation
|
|
279
|
+
|
|
280
|
+
\`\`\`ts
|
|
281
|
+
const configSchema = z.object({
|
|
282
|
+
apiKey: z.string()
|
|
283
|
+
}).refineAsync(
|
|
284
|
+
async (data) => {
|
|
285
|
+
// Validate API key with remote service
|
|
286
|
+
const response = await fetch('https://api.example.com/validate', {
|
|
287
|
+
headers: { Authorization: \`Bearer \${data.apiKey}\` }
|
|
288
|
+
});
|
|
289
|
+
return response.ok;
|
|
290
|
+
},
|
|
291
|
+
{
|
|
292
|
+
message: 'Invalid API key',
|
|
293
|
+
path: ['apiKey']
|
|
294
|
+
}
|
|
295
|
+
);
|
|
296
|
+
\`\`\`
|
|
297
|
+
|
|
298
|
+
### Transform Validation
|
|
299
|
+
|
|
300
|
+
\`\`\`ts
|
|
301
|
+
const configSchema = z.object({
|
|
302
|
+
// Trim and lowercase email
|
|
303
|
+
email: z.string().transform((s) => s.trim().toLowerCase()),
|
|
304
|
+
|
|
305
|
+
// Parse JSON string
|
|
306
|
+
metadata: z.string().transform((s) => JSON.parse(s)),
|
|
307
|
+
|
|
308
|
+
// Validate and transform
|
|
309
|
+
port: z.string().transform((s) => {
|
|
310
|
+
const port = parseInt(s, 10);
|
|
311
|
+
if (port < 1 || port > 65535) {
|
|
312
|
+
throw new Error('Invalid port number');
|
|
313
|
+
}
|
|
314
|
+
return port;
|
|
315
|
+
})
|
|
316
|
+
});
|
|
317
|
+
\`\`\`
|
|
318
|
+
|
|
319
|
+
## Validation Strategies
|
|
320
|
+
|
|
321
|
+
### Strict Validation
|
|
322
|
+
|
|
323
|
+
\`\`\`ts
|
|
324
|
+
const configSchema = z.object({
|
|
325
|
+
apiKey: z.string()
|
|
326
|
+
}).strict(); // Reject unknown keys
|
|
327
|
+
|
|
328
|
+
try {
|
|
329
|
+
configSchema.parse({ apiKey: '<api-key>', unknown: 'value' });
|
|
330
|
+
} catch (error) {
|
|
331
|
+
console.error(error); // Unrecognized key 'unknown'
|
|
332
|
+
}
|
|
333
|
+
\`\`\`
|
|
334
|
+
|
|
335
|
+
### Passthrough Validation
|
|
336
|
+
|
|
337
|
+
\`\`\`ts
|
|
338
|
+
const configSchema = z.object({
|
|
339
|
+
apiKey: z.string()
|
|
340
|
+
}).passthrough(); // Allow unknown keys
|
|
341
|
+
|
|
342
|
+
const config = configSchema.parse({
|
|
343
|
+
apiKey: '<api-key>',
|
|
344
|
+
unknown: 'value' // preserved
|
|
345
|
+
});
|
|
346
|
+
\`\`\`
|
|
347
|
+
|
|
348
|
+
### Partial Validation
|
|
349
|
+
|
|
350
|
+
\`\`\`ts
|
|
351
|
+
const configSchema = z.object({
|
|
352
|
+
apiKey: z.string(),
|
|
353
|
+
port: z.number()
|
|
354
|
+
}).partial(); // All fields optional
|
|
355
|
+
|
|
356
|
+
const config = configSchema.parse({});
|
|
357
|
+
// {}
|
|
358
|
+
\`\`\`
|
|
359
|
+
|
|
360
|
+
## Validation Utilities
|
|
361
|
+
|
|
362
|
+
### Deep Merge
|
|
363
|
+
|
|
364
|
+
\`\`\`ts
|
|
365
|
+
import { deepMerge } from '@vibesdotdev/config';
|
|
366
|
+
|
|
367
|
+
const defaults = {
|
|
368
|
+
database: {
|
|
369
|
+
host: 'localhost',
|
|
370
|
+
port: 5432
|
|
371
|
+
}
|
|
372
|
+
};
|
|
373
|
+
|
|
374
|
+
const overrides = {
|
|
375
|
+
database: {
|
|
376
|
+
host: 'db.example.com'
|
|
377
|
+
}
|
|
378
|
+
};
|
|
379
|
+
|
|
380
|
+
const merged = deepMerge(defaults, overrides);
|
|
381
|
+
// { database: { host: 'db.example.com', port: 5432 } }
|
|
382
|
+
\`\`\`
|
|
383
|
+
|
|
384
|
+
### Flatten Errors
|
|
385
|
+
|
|
386
|
+
\`\`\`ts
|
|
387
|
+
import { flattenErrors } from '@vibesdotdev/config';
|
|
388
|
+
|
|
389
|
+
const zodError = new z.ZodError([...]);
|
|
390
|
+
const flat = flattenErrors(zodError);
|
|
391
|
+
|
|
392
|
+
console.log(flat);
|
|
393
|
+
// {
|
|
394
|
+
// 'database.host': ['Required'],
|
|
395
|
+
// 'database.port': ['Must be a number']
|
|
396
|
+
// }
|
|
397
|
+
\`\`\`
|
|
398
|
+
|
|
399
|
+
### Validate Against Schema
|
|
400
|
+
|
|
401
|
+
\`\`\`ts
|
|
402
|
+
import { validateAgainstSchema } from '@vibesdotdev/config';
|
|
403
|
+
|
|
404
|
+
const result = validateAgainstSchema(configSchema, rawData, {
|
|
405
|
+
strict: true,
|
|
406
|
+
applyDefaults: true,
|
|
407
|
+
context: { environment: 'production' }
|
|
408
|
+
});
|
|
409
|
+
|
|
410
|
+
if (result.success) {
|
|
411
|
+
console.log(result.data); // Validated config with defaults
|
|
412
|
+
} else {
|
|
413
|
+
console.error(result.errors);
|
|
414
|
+
}
|
|
415
|
+
\`\`\`
|
|
416
|
+
|
|
417
|
+
## Best Practices
|
|
418
|
+
|
|
419
|
+
1. **Use specific schemas** — Avoid \`z.any()\` or \`z.unknown()\`
|
|
420
|
+
2. **Provide helpful error messages** — Guide users to fix issues
|
|
421
|
+
3. **Apply sensible defaults** — Reduce required configuration
|
|
422
|
+
4. **Validate early** — Fail fast on invalid config
|
|
423
|
+
5. **Use context-aware defaults** — Different values per environment
|
|
424
|
+
6. **Document required fields** — Clear what must be provided
|
|
425
|
+
|
|
426
|
+
:::card{title="See also"}
|
|
427
|
+
- [\`config.manifests\`](config.manifests) — Configuration manifests
|
|
428
|
+
- [\`config.environment\`](config.environment) — Environment variables
|
|
429
|
+
- [\`storage.manifests\`](storage.manifests) — Storage manifests
|
|
430
|
+
:::
|
|
431
|
+
`
|
|
432
|
+
},
|
|
433
|
+
parent: 'config',
|
|
434
|
+
order: 3,
|
|
435
|
+
tags: ['config', 'validation', 'schema', 'errors', 'defaults'],
|
|
436
|
+
surfaces: ['cli', 'web', 'in-app'],
|
|
437
|
+
hardware: ['consumer', 'cloud'],
|
|
438
|
+
enabled: true
|
|
439
|
+
};
|
|
440
|
+
export default descriptor;
|
|
441
|
+
//# sourceMappingURL=validation.docs.descriptor.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"validation.docs.descriptor.js","sourceRoot":"","sources":["../../src/docs/validation.docs.descriptor.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,GAAwB;IACvC,IAAI,EAAE,YAAY;IAClB,EAAE,EAAE,mBAAmB;IACvB,KAAK,EAAE,0BAA0B;IACjC,OAAO,EAAE,iDAAiD;IAC1D,IAAI,EAAE;QACL,IAAI,EAAE,UAAU;QAChB,UAAU,EAAE,KAAK;QACjB,MAAM,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsaT;KACC;IACD,MAAM,EAAE,QAAQ;IAChB,KAAK,EAAE,CAAC;IACR,IAAI,EAAE,CAAC,QAAQ,EAAE,YAAY,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,CAAC;IAC9D,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,CAAC;IAClC,QAAQ,EAAE,CAAC,UAAU,EAAE,OAAO,CAAC;IAC/B,OAAO,EAAE,IAAI;CACb,CAAC;AAEF,eAAe,UAAU,CAAC"}
|
package/dist/doctor.d.ts
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Config Doctor
|
|
3
|
+
*
|
|
4
|
+
* Generic diagnostic functions for validating configuration state.
|
|
5
|
+
*/
|
|
6
|
+
import type { ConfigManifest } from './manifest/types';
|
|
7
|
+
import type { ConfigCollection } from './collection/collection';
|
|
8
|
+
import type { DetailedDiagnostic, DiagnoseConfigOptions } from './schemas/doctor.schema.ts';
|
|
9
|
+
export type { DiagnosticSeverity, DiagnosticIssue, DetailedDiagnostic, DiagnoseConfigOptions } from './schemas/doctor.schema.ts';
|
|
10
|
+
/**
|
|
11
|
+
* Generic diagnostic function for any ConfigManifest.
|
|
12
|
+
*
|
|
13
|
+
* Validates:
|
|
14
|
+
* - Required fields are present
|
|
15
|
+
* - Values match schema constraints
|
|
16
|
+
* - No deprecated settings (optional)
|
|
17
|
+
* - Custom validation rules
|
|
18
|
+
*
|
|
19
|
+
* @param manifest - The ConfigManifest to diagnose
|
|
20
|
+
* @param values - The current configuration values
|
|
21
|
+
* @param options - Diagnostic options
|
|
22
|
+
* @returns Detailed diagnostic result
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* ```typescript
|
|
26
|
+
* const result = diagnoseConfig(myManifest, currentValues);
|
|
27
|
+
* if (!result.ready) {
|
|
28
|
+
* console.error('Config errors:', result.issues.filter(i => i.severity === 'error'));
|
|
29
|
+
* }
|
|
30
|
+
* ```
|
|
31
|
+
*/
|
|
32
|
+
export declare function diagnoseConfig<T extends ConfigManifest>(manifest: T, values: Record<string, unknown>, options?: DiagnoseConfigOptions): DetailedDiagnostic;
|
|
33
|
+
/**
|
|
34
|
+
* Diagnose a ConfigCollection (group of related configs).
|
|
35
|
+
*
|
|
36
|
+
* Validates that all manifests in the collection are properly configured.
|
|
37
|
+
*
|
|
38
|
+
* @param collection - The ConfigCollection to diagnose
|
|
39
|
+
* @returns Diagnostic results for each manifest in the collection
|
|
40
|
+
*/
|
|
41
|
+
export declare function diagnoseCollection(collection: ConfigCollection): Promise<Record<string, DetailedDiagnostic>>;
|
|
42
|
+
//# sourceMappingURL=doctor.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"doctor.d.ts","sourceRoot":"","sources":["../src/doctor.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAEhE,OAAO,KAAK,EAAmB,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAE7G,YAAY,EAAE,kBAAkB,EAAE,eAAe,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAEjI;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,cAAc,EACtD,QAAQ,EAAE,CAAC,EACX,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,OAAO,GAAE,qBAA0B,GACjC,kBAAkB,CA0DpB;AAED;;;;;;;GAOG;AACH,wBAAsB,kBAAkB,CACvC,UAAU,EAAE,gBAAgB,GAC1B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC,CAc7C"}
|
package/dist/doctor.js
ADDED
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Config Doctor
|
|
3
|
+
*
|
|
4
|
+
* Generic diagnostic functions for validating configuration state.
|
|
5
|
+
*/
|
|
6
|
+
/**
|
|
7
|
+
* Generic diagnostic function for any ConfigManifest.
|
|
8
|
+
*
|
|
9
|
+
* Validates:
|
|
10
|
+
* - Required fields are present
|
|
11
|
+
* - Values match schema constraints
|
|
12
|
+
* - No deprecated settings (optional)
|
|
13
|
+
* - Custom validation rules
|
|
14
|
+
*
|
|
15
|
+
* @param manifest - The ConfigManifest to diagnose
|
|
16
|
+
* @param values - The current configuration values
|
|
17
|
+
* @param options - Diagnostic options
|
|
18
|
+
* @returns Detailed diagnostic result
|
|
19
|
+
*
|
|
20
|
+
* @example
|
|
21
|
+
* ```typescript
|
|
22
|
+
* const result = diagnoseConfig(myManifest, currentValues);
|
|
23
|
+
* if (!result.ready) {
|
|
24
|
+
* console.error('Config errors:', result.issues.filter(i => i.severity === 'error'));
|
|
25
|
+
* }
|
|
26
|
+
* ```
|
|
27
|
+
*/
|
|
28
|
+
export function diagnoseConfig(manifest, values, options = {}) {
|
|
29
|
+
const issues = [];
|
|
30
|
+
const { checkDeprecated = false } = options;
|
|
31
|
+
// Check all fields from manifest
|
|
32
|
+
for (const [fieldKey, fieldMeta] of Object.entries(manifest.fields)) {
|
|
33
|
+
const value = getValueAtPath(values, fieldKey);
|
|
34
|
+
// Check required fields (fields without defaults)
|
|
35
|
+
// Empty string and null count as missing
|
|
36
|
+
const hasValue = value !== undefined && value !== null && value !== '';
|
|
37
|
+
if (fieldMeta.defaults?.base === undefined && !hasValue) {
|
|
38
|
+
issues.push({
|
|
39
|
+
path: fieldKey,
|
|
40
|
+
message: `Required field '${fieldMeta.ui.label || fieldKey}' is missing`,
|
|
41
|
+
severity: 'error',
|
|
42
|
+
code: 'required_field_missing'
|
|
43
|
+
});
|
|
44
|
+
}
|
|
45
|
+
// Check deprecated fields
|
|
46
|
+
if (checkDeprecated && fieldMeta.tags?.includes('deprecated')) {
|
|
47
|
+
if (value !== undefined && value !== null) {
|
|
48
|
+
issues.push({
|
|
49
|
+
path: fieldKey,
|
|
50
|
+
message: `Field '${fieldMeta.ui.label || fieldKey}' is deprecated and should be removed`,
|
|
51
|
+
severity: 'warning',
|
|
52
|
+
code: 'deprecated_field_used'
|
|
53
|
+
});
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
// Run custom validators
|
|
58
|
+
if (options.customValidators) {
|
|
59
|
+
for (const { path, fn } of options.customValidators) {
|
|
60
|
+
const value = getValueAtPath(values, path);
|
|
61
|
+
const error = fn(value);
|
|
62
|
+
if (error) {
|
|
63
|
+
issues.push({
|
|
64
|
+
path,
|
|
65
|
+
message: error,
|
|
66
|
+
severity: 'error',
|
|
67
|
+
code: 'custom_validation_failed'
|
|
68
|
+
});
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
const errors = issues.filter((i) => i.severity === 'error').length;
|
|
73
|
+
const warnings = issues.filter((i) => i.severity === 'warning').length;
|
|
74
|
+
const info = issues.filter((i) => i.severity === 'info').length;
|
|
75
|
+
return {
|
|
76
|
+
ready: errors === 0,
|
|
77
|
+
issues,
|
|
78
|
+
summary: { errors, warnings, info }
|
|
79
|
+
};
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* Diagnose a ConfigCollection (group of related configs).
|
|
83
|
+
*
|
|
84
|
+
* Validates that all manifests in the collection are properly configured.
|
|
85
|
+
*
|
|
86
|
+
* @param collection - The ConfigCollection to diagnose
|
|
87
|
+
* @returns Diagnostic results for each manifest in the collection
|
|
88
|
+
*/
|
|
89
|
+
export async function diagnoseCollection(collection) {
|
|
90
|
+
const results = {};
|
|
91
|
+
for (const manifestId of collection.manifestIds) {
|
|
92
|
+
// Load current values for this manifest
|
|
93
|
+
// Note: This assumes manifests are registered and loadable
|
|
94
|
+
results[manifestId] = {
|
|
95
|
+
ready: true,
|
|
96
|
+
issues: [],
|
|
97
|
+
summary: { errors: 0, warnings: 0, info: 0 }
|
|
98
|
+
};
|
|
99
|
+
}
|
|
100
|
+
return results;
|
|
101
|
+
}
|
|
102
|
+
/**
|
|
103
|
+
* Helper: Get value at a dot-notation path from an object
|
|
104
|
+
*/
|
|
105
|
+
function getValueAtPath(obj, path) {
|
|
106
|
+
if (path in obj) {
|
|
107
|
+
return obj[path];
|
|
108
|
+
}
|
|
109
|
+
const parts = path.split('.');
|
|
110
|
+
let current = obj;
|
|
111
|
+
for (const part of parts) {
|
|
112
|
+
if (current == null || typeof current !== 'object') {
|
|
113
|
+
return undefined;
|
|
114
|
+
}
|
|
115
|
+
current = current[part];
|
|
116
|
+
}
|
|
117
|
+
return current;
|
|
118
|
+
}
|
|
119
|
+
//# sourceMappingURL=doctor.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"doctor.js","sourceRoot":"","sources":["../src/doctor.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AASH;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,cAAc,CAC7B,QAAW,EACX,MAA+B,EAC/B,UAAiC,EAAE;IAEnC,MAAM,MAAM,GAAsB,EAAE,CAAC;IACrC,MAAM,EAAE,eAAe,GAAG,KAAK,EAAE,GAAG,OAAO,CAAC;IAE5C,iCAAiC;IACjC,KAAK,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACrE,MAAM,KAAK,GAAG,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAE/C,kDAAkD;QAClD,yCAAyC;QACzC,MAAM,QAAQ,GAAG,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;QACvE,IAAI,SAAS,CAAC,QAAQ,EAAE,IAAI,KAAK,SAAS,IAAI,CAAC,QAAQ,EAAE,CAAC;YACzD,MAAM,CAAC,IAAI,CAAC;gBACX,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,mBAAmB,SAAS,CAAC,EAAE,CAAC,KAAK,IAAI,QAAQ,cAAc;gBACxE,QAAQ,EAAE,OAAO;gBACjB,IAAI,EAAE,wBAAwB;aAC9B,CAAC,CAAC;QACJ,CAAC;QAED,0BAA0B;QAC1B,IAAI,eAAe,IAAI,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;YAC/D,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gBAC3C,MAAM,CAAC,IAAI,CAAC;oBACX,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,UAAU,SAAS,CAAC,EAAE,CAAC,KAAK,IAAI,QAAQ,uCAAuC;oBACxF,QAAQ,EAAE,SAAS;oBACnB,IAAI,EAAE,uBAAuB;iBAC7B,CAAC,CAAC;YACJ,CAAC;QACF,CAAC;IACF,CAAC;IAED,wBAAwB;IACxB,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;QAC9B,KAAK,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;YACrD,MAAM,KAAK,GAAG,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAC3C,MAAM,KAAK,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;YACxB,IAAI,KAAK,EAAE,CAAC;gBACX,MAAM,CAAC,IAAI,CAAC;oBACX,IAAI;oBACJ,OAAO,EAAE,KAAK;oBACd,QAAQ,EAAE,OAAO;oBACjB,IAAI,EAAE,0BAA0B;iBAChC,CAAC,CAAC;YACJ,CAAC;QACF,CAAC;IACF,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,MAAM,CAAC;IACnE,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,MAAM,CAAC;IACvE,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,MAAM,CAAC,CAAC,MAAM,CAAC;IAEhE,OAAO;QACN,KAAK,EAAE,MAAM,KAAK,CAAC;QACnB,MAAM;QACN,OAAO,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE;KACnC,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACvC,UAA4B;IAE5B,MAAM,OAAO,GAAuC,EAAE,CAAC;IAEvD,KAAK,MAAM,UAAU,IAAI,UAAU,CAAC,WAAW,EAAE,CAAC;QACjD,wCAAwC;QACxC,2DAA2D;QAC3D,OAAO,CAAC,UAAU,CAAC,GAAG;YACrB,KAAK,EAAE,IAAI;YACX,MAAM,EAAE,EAAE;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE;SAC5C,CAAC;IACH,CAAC;IAED,OAAO,OAAO,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,SAAS,cAAc,CAAC,GAA4B,EAAE,IAAY;IACjE,IAAI,IAAI,IAAI,GAAG,EAAE,CAAC;QACjB,OAAO,GAAG,CAAC,IAAI,CAAC,CAAC;IAClB,CAAC;IAED,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC9B,IAAI,OAAO,GAAY,GAAG,CAAC;IAC3B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QAC1B,IAAI,OAAO,IAAI,IAAI,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YACpD,OAAO,SAAS,CAAC;QAClB,CAAC;QACD,OAAO,GAAI,OAAmC,CAAC,IAAI,CAAC,CAAC;IACtD,CAAC;IACD,OAAO,OAAO,CAAC;AAChB,CAAC"}
|
package/dist/env.d.ts
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generic environment-variable helpers.
|
|
3
|
+
*
|
|
4
|
+
* This module is the canonical home for *generic* env access: read a key,
|
|
5
|
+
* parse a number, parse a boolean, validate required keys at startup. It is
|
|
6
|
+
* isomorphic — works in Node/server and browser (`window.__env`).
|
|
7
|
+
*
|
|
8
|
+
* Domain-specific env (AI provider keys, OAuth callback URLs, SMTP, Linear
|
|
9
|
+
* status IDs, scheduler crons, …) lives with the owning module. Do not
|
|
10
|
+
* re-introduce a monorepo-wide `env` aggregate here.
|
|
11
|
+
*
|
|
12
|
+
* See `packages/config/SPEC.md` ("Does not own").
|
|
13
|
+
*/
|
|
14
|
+
/** Read an env var (or the `PUBLIC_`-prefixed variant) with a fallback. */
|
|
15
|
+
export declare function getEnv(key: string, defaultValue?: string): string;
|
|
16
|
+
/** Read an env var as a number, falling back when missing or unparseable. */
|
|
17
|
+
export declare function getEnvNumber(key: string, defaultValue: number): number;
|
|
18
|
+
/** Read an env var as a boolean (`"true"` is true; anything else is the default). */
|
|
19
|
+
export declare function getEnvBoolean(key: string, defaultValue: boolean): boolean;
|
|
20
|
+
/**
|
|
21
|
+
* Assert that the given env vars are set. No-op in browser runtimes.
|
|
22
|
+
* Throws with a formatted message listing every missing key.
|
|
23
|
+
*/
|
|
24
|
+
export declare function validateRequiredEnv(required: Array<{
|
|
25
|
+
key: string;
|
|
26
|
+
description: string;
|
|
27
|
+
}>): void;
|
|
28
|
+
//# sourceMappingURL=env.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"env.d.ts","sourceRoot":"","sources":["../src/env.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAkCH,2EAA2E;AAC3E,wBAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,CAEjE;AAED,6EAA6E;AAC7E,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,CAItE;AAED,qFAAqF;AACrF,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,GAAG,OAAO,CAIzE;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,KAAK,CAAC;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,CAAC,GAAG,IAAI,CAqB/F"}
|