@nage-api/config 1.0.0-beta.2

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,172 @@
+# @nage-api/config
+
+One typed configuration for a `@nage-api` application, validated once at boot
+(PLAN.md §11).
+
+Replaces the legacy pair of an `env.ts` singleton and `@nestjs/config` — two
+systems, no validation, `env.get<T>() as T` — with a single source: a committed
+`defineConfig()` literal, a zod schema for the environment, and a
+`SecretProviderPort` for everything that must not be committed.
+
+## Usage
+
+```ts
+// apps/api/src/config/env.schema.ts
+import { baseEnvSchema, secretSchema } from '@nage-api/config';
+import { z } from 'zod';
+
+export const EnvSchema = baseEnvSchema.extend({
+  DATABASE_URL: z.url(),
+  JWT_PRIVATE_KEY: secretSchema,
+});
+
+export type Env = z.infer<typeof EnvSchema>;
+```
+
+```ts
+// apps/api/src/config/nage.config.ts
+import { defineConfig, defineConfigFragment } from '@nage-api/config';
+
+import type { Env } from './env.schema.js';
+
+// Normally imported from `@app/config`, shared by every app in the workspace.
+const workspaceDefaults = defineConfigFragment({
+  logging: { json: true },
+  database: { driver: 'postgres', ssl: 'verify-full' },
+});
+
+export const buildConfig = (env: Env) =>
+  defineConfig(
+    {
+      app: { name: 'my-api', environment: env.NODE_ENV, port: env.PORT },
+      // Omitting `cors` disables it; an allow-list is what switches it on.
+      http: {
+        ...(env.CORS_ORIGINS === undefined ? {} : { cors: { origins: env.CORS_ORIGINS } }),
+      },
+      database: { enabled: true, driver: 'postgres', url: env.DATABASE_URL },
+      secrets: { provider: 'aws', prefix: 'prod/my-api/' },
+    },
+    { extends: [workspaceDefaults] },
+  );
+```
+
+```ts
+// apps/api/src/app.module.ts
+import { NageConfigModule } from '@nage-api/config';
+import { NageCoreModule } from '@nage-api/core';
+import { Module } from '@nestjs/common';
+
+import { EnvSchema } from './config/env.schema.js';
+import { buildConfig } from './config/nage.config.js';
+
+const config = buildConfig(EnvSchema.parse(process.env));
+
+@Module({
+  imports: [
+    // Core first: both modules publish NAGE_CONFIG, and the later import wins.
+    NageCoreModule.forRoot(config),
+    NageConfigModule.forRoot({ config, envSchema: EnvSchema }),
+  ],
+})
+export class AppModule {}
+```
+
+```ts
+// apps/api/src/main.ts
+import { loadEnvOrExit } from '@nage-api/config';
+import { bootstrap } from '@nage-api/core';
+
+import { AppModule } from './app.module.js';
+import { EnvSchema } from './config/env.schema.js';
+import { buildConfig } from './config/nage.config.js';
+
+const env = loadEnvOrExit(EnvSchema); // invalid env → stderr report, exit 1
+void bootstrap({ module: AppModule, config: buildConfig(env) });
+```
+
+```ts
+import { Inject, Injectable } from '@nestjs/common';
+import { ConfigService } from '@nage-api/config';
+
+import type { Env } from './env.schema.js';
+
+@Injectable()
+export class ReportService {
+  constructor(@Inject(ConfigService) private readonly config: ConfigService<Env>) {}
+
+  async run(): Promise<void> {
+    this.config.env('DATABASE_URL'); // string, typed by the schema
+    this.config.isEnabled('database'); // feature toggles (§11.1 item 6)
+    await this.config.requireSecret('JWT_PRIVATE_KEY');
+  }
+}
+```
+
+## The layers (§11.1)
+
+| #   | Layer              | Where                                                            |
+| --- | ------------------ | ---------------------------------------------------------------- |
+| 1   | Framework defaults | `withDefaults()` — applied when the config is published          |
+| 2   | Workspace defaults | `defineConfigFragment()` in `@app/config`, passed via `extends`  |
+| 3   | App config         | the app's own `defineConfig()` literal                           |
+| 4   | Environment        | `env.schema.ts`, validated by `loadEnv`/`loadEnvOrExit`          |
+| 5   | Secrets            | `SecretProviderPort` — env, AWS Secrets Manager, or your own     |
+| 6   | Feature flags      | `enabled` per block; a disabled feature contributes no providers |
+
+Later layers win. Arrays **replace** rather than concatenate: a CORS allow-list
+is a complete statement of policy, and appending to an inherited one is how an
+override silently widens it.
+
+## Behaviour worth knowing
+
+**Failures are complete and early.** `loadEnv` reports _every_ problem at once,
+so a misconfigured deployment is fixed in one pass instead of one restart per
+variable. `NageConfigModule.forRoot()` validates while the module is being
+built — before a port is bound.
+
+**Reports never publish what they were validating.** For variables whose name
+contains `SECRET`, `PASSWORD`, `TOKEN`, `KEY`, `CREDENTIAL`, `DSN`, `URL` or
+`URI`, the message is reduced to "is required but not set" / "is set but has the
+wrong shape (value hidden)". Env reports land in CI logs, and
+`expected url, received postgres://user:pw@…` would publish the credential it
+was rejecting.
+
+**The env is only validated if you hand over the schema.** `forRoot({ config })`
+without `envSchema` publishes an empty environment, so `config.env('X')` is
+typed by your schema and `undefined` at run time. Passing `envSchema` is what
+makes `ConfigService<Env>` true rather than a claim.
+
+**Errors separate the two audiences.** `Error.message` names the variable, the
+section or the secret for the operator and the log; the client-facing payload
+stays `{ code: 'CONFIGURATION_INVALID', message: 'Internal server error' }`.
+
+**Secrets are a port.** `EnvSecretProvider` is the default; `AwsSecretProvider`
+loads the SDK lazily and treats it as an optional peer, so an app using env
+secrets carries no AWS client. `CachingSecretProvider` wraps either with a TTL,
+because a signing key should not be a per-request network call.
+
+**Defaults are the safe ones.** `verify-full` TLS, a bounded `maxQueryLimit`,
+RS256 with 15m access tokens, rotating refresh tokens with reuse detection,
+argon2id passwords — applied whenever the relevant block is present, and
+overridable in the open where `nage doctor` (Phase 4) can see it.
+
+## Where the types live
+
+The config _types_ (`NageConfig` and every block) are declared in
+`@nage-api/contracts`, not here. Feature packages may not import each other, so a
+package reading its own config block must find that type at the bottom of the
+graph. This package owns the runtime that produces and validates a value.
+
+## Not yet implemented
+
+- The `vault` secret provider. `secrets.provider: 'vault'` throws a
+  `ConfigurationError` naming the two that work, rather than falling back to a
+  provider you did not ask for.
+- Runtime configuration — the `Settings` module of §11.1 item 7, for values that
+  change without a redeploy. Everything here is settled at boot.
+- Reading a `.env` file. Nothing in this package touches one: `loadEnv` reads
+  `process.env`, and populating it is the job of the process manager,
+  `docker compose`, or `node --env-file=.env`. `nage doctor` reads the
+  workspace's `.env` for its own audit, which is a different thing.
+
+The deeper guide is [docs/packages/config.md](../../docs/packages/config.md).

package/dist/config.module.d.ts

@@ -0,0 +1,28 @@
+/**
+ * `NageConfigModule.forRoot({ config, envSchema })` (PLAN.md §11).
+ *
+ * Validates the environment and publishes the typed config, env and secret
+ * provider. Validation happens while the module is being built, so a
+ * misconfigured process fails during boot — before a port is bound and before a
+ * single request is served (§21).
+ */
+import { type DynamicModule } from '@nestjs/common';
+import type { NageConfig, SecretProviderPort, SecretsConfig } from '@nage-api/contracts';
+import { type EnvRecord } from './config.service.js';
+import { type EnvSchema } from './env/load-env.js';
+export interface NageConfigModuleOptions<TEnv extends EnvRecord = EnvRecord> {
+    /** The application's `defineConfig()` result. */
+    readonly config: NageConfig;
+    /** Schema for the variables this app reads; validated at boot. */
+    readonly envSchema?: EnvSchema<TEnv>;
+    /** Defaults to `process.env`. */
+    readonly envSource?: Record<string, string | undefined>;
+    /** Pre-built provider; overrides `config.secrets.provider`. */
+    readonly secretProvider?: SecretProviderPort;
+}
+/** Build the provider named by the config, wrapped in the configured cache. */
+export declare function createSecretProvider(secrets: SecretsConfig | undefined): SecretProviderPort;
+export declare class NageConfigModule {
+    static forRoot<TEnv extends EnvRecord = EnvRecord>(options: NageConfigModuleOptions<TEnv>): DynamicModule;
+}
+//# sourceMappingURL=config.module.d.ts.map

package/dist/config.module.js

@@ -0,0 +1,84 @@
+"use strict";
+/**
+ * `NageConfigModule.forRoot({ config, envSchema })` (PLAN.md §11).
+ *
+ * Validates the environment and publishes the typed config, env and secret
+ * provider. Validation happens while the module is being built, so a
+ * misconfigured process fails during boot — before a port is bound and before a
+ * single request is served (§21).
+ */
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var NageConfigModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NageConfigModule = void 0;
+exports.createSecretProvider = createSecretProvider;
+const common_1 = require("@nestjs/common");
+const core_1 = require("@nage-api/core");
+const config_service_js_1 = require("./config.service.js");
+const define_config_js_1 = require("./define-config.js");
+const load_env_js_1 = require("./env/load-env.js");
+const aws_secret_provider_js_1 = require("./secrets/aws.secret-provider.js");
+const caching_secret_provider_js_1 = require("./secrets/caching.secret-provider.js");
+const env_secret_provider_js_1 = require("./secrets/env.secret-provider.js");
+const tokens_js_1 = require("./tokens.js");
+/** Build the provider named by the config, wrapped in the configured cache. */
+function createSecretProvider(secrets) {
+    const provider = (() => {
+        switch (secrets?.provider ?? 'env') {
+            case 'env':
+                return new env_secret_provider_js_1.EnvSecretProvider(secrets?.prefix === undefined ? {} : { prefix: secrets.prefix });
+            case 'aws':
+                return new aws_secret_provider_js_1.AwsSecretProvider({
+                    ...(secrets?.prefix === undefined ? {} : { prefix: secrets.prefix }),
+                    ...(secrets?.region === undefined ? {} : { region: secrets.region }),
+                });
+            case 'vault':
+                throw new core_1.ConfigurationError({
+                    detail: 'The vault secret provider is not implemented yet',
+                    meta: { hint: 'Use secrets.provider "env" or "aws", or supply secretProvider directly.' },
+                });
+            default:
+                throw new core_1.ConfigurationError({
+                    message: `Unknown secret provider "${String(secrets?.provider)}"`,
+                });
+        }
+    })();
+    const ttlSeconds = secrets?.cacheTtlSeconds ?? 300;
+    return ttlSeconds > 0 ? new caching_secret_provider_js_1.CachingSecretProvider(provider, { ttlSeconds }) : provider;
+}
+let NageConfigModule = NageConfigModule_1 = class NageConfigModule {
+    static forRoot(options) {
+        // Throws EnvValidationError listing every problem at once. Callers that want
+        // an exit code instead of a stack trace validate with `loadEnvOrExit` before
+        // building the module.
+        const env = options.envSchema === undefined
+            ? {}
+            : (0, load_env_js_1.loadEnv)(options.envSchema, {
+                ...(options.envSource === undefined ? {} : { source: options.envSource }),
+            });
+        const config = (0, define_config_js_1.withDefaults)(options.config);
+        const secretProvider = options.secretProvider ?? createSecretProvider(config.secrets);
+        const providers = [
+            { provide: core_1.NAGE_CONFIG, useValue: config },
+            { provide: tokens_js_1.NAGE_ENV, useValue: env },
+            { provide: tokens_js_1.NAGE_SECRET_PROVIDER, useValue: secretProvider },
+            config_service_js_1.ConfigService,
+        ];
+        return {
+            module: NageConfigModule_1,
+            providers,
+            exports: [core_1.NAGE_CONFIG, tokens_js_1.NAGE_ENV, tokens_js_1.NAGE_SECRET_PROVIDER, config_service_js_1.ConfigService],
+        };
+    }
+};
+exports.NageConfigModule = NageConfigModule;
+exports.NageConfigModule = NageConfigModule = NageConfigModule_1 = __decorate([
+    (0, common_1.Global)(),
+    (0, common_1.Module)({})
+], NageConfigModule);
+//# sourceMappingURL=config.module.js.map

package/dist/config.service.d.ts

@@ -0,0 +1,47 @@
+/**
+ * `ConfigService<TEnv>` — one typed way to read configuration (PLAN.md §11, §13).
+ *
+ * The legacy framework had two systems: an `env.ts` singleton with
+ * `env.get<T>() as T`, and `@nestjs/config` alongside it. Here there is one
+ * service, and every read is typed:
+ *
+ *   - `service.config` is the validated `NageConfig` literal
+ *   - `service.env('DATABASE_URL')` is typed by the app's own zod schema
+ *   - `service.secret('JWT_PRIVATE_KEY')` goes through the `SecretProviderPort`
+ *
+ * There is deliberately no string-keyed `get('a.b.c')`: a path is not a type.
+ */
+import type { NageConfig, NodeEnvironment, SecretProviderPort } from '@nage-api/contracts';
+/** Any validated environment object. */
+export type EnvRecord = Record<string, unknown>;
+export declare class ConfigService<TEnv extends EnvRecord = EnvRecord> {
+    private readonly configuration;
+    private readonly environment;
+    private readonly secrets;
+    constructor(configuration: NageConfig, environment: TEnv, secrets: SecretProviderPort);
+    /** The whole validated configuration. */
+    get config(): NageConfig;
+    /** One config block, e.g. `configService.section('database')`. */
+    section<TKey extends keyof NageConfig>(key: TKey): NageConfig[TKey];
+    /**
+     * A config block that must be present and enabled. Feature packages call this
+     * in `forRoot`, so a feature enabled without its settings fails at boot rather
+     * than at the first request.
+     */
+    requireSection<TKey extends keyof NageConfig>(key: TKey): NonNullable<NageConfig[TKey]>;
+    /** Is an optional feature switched on? (§11.1 item 6.) */
+    isEnabled(feature: 'database' | 'auth' | 'cache' | 'queue' | 'storage' | 'realtime' | 'notify'): boolean;
+    /** A validated environment variable, typed by the application's schema. */
+    env<TKey extends keyof TEnv>(key: TKey): TEnv[TKey];
+    /** The whole validated environment. */
+    get envs(): TEnv;
+    /** A secret from the configured provider, or `null` when unset. */
+    secret(name: string): Promise<string | null>;
+    /** A secret that must exist; rejects otherwise. */
+    requireSecret(name: string): Promise<string>;
+    get environmentName(): NodeEnvironment;
+    get isProduction(): boolean;
+    get isDevelopment(): boolean;
+    get isTest(): boolean;
+}
+//# sourceMappingURL=config.service.d.ts.map

package/dist/config.service.js

@@ -0,0 +1,106 @@
+"use strict";
+/**
+ * `ConfigService<TEnv>` — one typed way to read configuration (PLAN.md §11, §13).
+ *
+ * The legacy framework had two systems: an `env.ts` singleton with
+ * `env.get<T>() as T`, and `@nestjs/config` alongside it. Here there is one
+ * service, and every read is typed:
+ *
+ *   - `service.config` is the validated `NageConfig` literal
+ *   - `service.env('DATABASE_URL')` is typed by the app's own zod schema
+ *   - `service.secret('JWT_PRIVATE_KEY')` goes through the `SecretProviderPort`
+ *
+ * There is deliberately no string-keyed `get('a.b.c')`: a path is not a type.
+ */
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigService = void 0;
+const common_1 = require("@nestjs/common");
+const core_1 = require("@nage-api/core");
+const tokens_js_1 = require("./tokens.js");
+const core_2 = require("@nage-api/core");
+let ConfigService = class ConfigService {
+    configuration;
+    environment;
+    secrets;
+    constructor(configuration, environment, secrets) {
+        this.configuration = configuration;
+        this.environment = environment;
+        this.secrets = secrets;
+    }
+    /** The whole validated configuration. */
+    get config() {
+        return this.configuration;
+    }
+    /** One config block, e.g. `configService.section('database')`. */
+    section(key) {
+        return this.configuration[key];
+    }
+    /**
+     * A config block that must be present and enabled. Feature packages call this
+     * in `forRoot`, so a feature enabled without its settings fails at boot rather
+     * than at the first request.
+     */
+    requireSection(key) {
+        const section = this.configuration[key];
+        if (section === undefined) {
+            throw new core_1.ConfigurationError({
+                detail: `Configuration section "${key}" is required but missing`,
+                meta: { section: key },
+            });
+        }
+        return section;
+    }
+    /** Is an optional feature switched on? (§11.1 item 6.) */
+    isEnabled(feature) {
+        return this.configuration[feature]?.enabled === true;
+    }
+    /** A validated environment variable, typed by the application's schema. */
+    env(key) {
+        return this.environment[key];
+    }
+    /** The whole validated environment. */
+    get envs() {
+        return this.environment;
+    }
+    /** A secret from the configured provider, or `null` when unset. */
+    secret(name) {
+        return this.secrets.get(name);
+    }
+    /** A secret that must exist; rejects otherwise. */
+    requireSecret(name) {
+        return this.secrets.require(name);
+    }
+    get environmentName() {
+        return this.configuration.app.environment;
+    }
+    get isProduction() {
+        return this.environmentName === 'production';
+    }
+    get isDevelopment() {
+        return this.environmentName === 'development';
+    }
+    get isTest() {
+        return this.environmentName === 'test';
+    }
+};
+exports.ConfigService = ConfigService;
+exports.ConfigService = ConfigService = __decorate([
+    (0, common_1.Injectable)(),
+    __param(0, (0, common_1.Inject)(core_2.NAGE_CONFIG)),
+    __param(1, (0, common_1.Inject)(tokens_js_1.NAGE_ENV)),
+    __param(2, (0, common_1.Inject)(tokens_js_1.NAGE_SECRET_PROVIDER)),
+    __metadata("design:paramtypes", [Object, Object, Object])
+], ConfigService);
+//# sourceMappingURL=config.service.js.map