@config-bound/nestjs 0.2.0 → 1.0.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @config-bound/nestjs
 
+## 1.0.0
+
+### Patch Changes
+
+- Updated dependencies [87d2ab6]
+  - @config-bound/core@1.0.0
+
+## 0.3.0
+
+### Minor Changes
+
+- 0a6960f: Add synchronous cache API for constructor-safe config reads.
+
+  Introduces `getFromCache()`, `getOrThrowFromCache()`, `populateCache()`, and `isCacheReady()` on both `TypedConfigBound` and `ConfigBoundService`. A `cacheMode` option (`'eager' | 'manual'`) controls whether the cache is populated automatically at startup (`eager`, default) or on demand (`manual`). This enables config reads in NestJS constructors and other sync-only call sites that cannot `await`.
+
+### Patch Changes
+
+- Updated dependencies [0a6960f]
+  - @config-bound/config-bound@0.3.0
+
 ## 0.2.0
 
 ### Patch Changes

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Robert Keyser
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -5,7 +5,7 @@ NestJS integration for the ConfigBound configuration library. This package provi
 ## Installation
 
 ```bash
-npm install @config-bound/nestjs @config-bound/config-bound
+npm install @config-bound/nestjs @config-bound/core
 ```
 
 ## Quick Start
@@ -15,8 +15,8 @@ npm install @config-bound/nestjs @config-bound/config-bound
 ```typescript
 import { Module } from '@nestjs/common';
 import { ConfigBoundModule } from '@config-bound/nestjs';
-import { configItem, configSection } from '@config-bound/config-bound';
-import { EnvVarBind } from '@config-bound/config-bound/bind/binds/envVar';
+import { configItem, configSection } from '@config-bound/core';
+import { EnvVarBind } from '@config-bound/core/binds/env';
 import { z } from 'zod';
 
 const appConfig = {
@@ -46,7 +46,7 @@ const appConfig = {
   imports: [
     ConfigBoundModule.forRoot({
       schema: appConfig,
-      binds: [new EnvVarBind({ prefix: 'APP' })],
+      binds: [await EnvVarBind.create({ prefix: 'APP' })],
       validateOnInit: true,
       isGlobal: true
     })
@@ -98,7 +98,7 @@ import { ConfigService } from '@nestjs/config';
       ): Promise<ConfigBoundModuleOptions> => {
         return {
           schema: appConfig,
-          binds: [new EnvVarBind({ prefix: 'APP' })],
+          binds: [await EnvVarBind.create({ prefix: 'APP' })],
           validateOnInit: true
         };
       },
@@ -124,7 +124,7 @@ export class ConfigBoundConfigService implements ConfigBoundOptionsFactory {
   createConfigBoundOptions(): ConfigBoundModuleOptions {
     return {
       schema: appConfig,
-      binds: [new EnvVarBind({ prefix: 'APP' })],
+      binds: [await EnvVarBind.create({ prefix: 'APP' })],
       validateOnInit: true
     };
   }
@@ -199,7 +199,7 @@ The service provides full type-safe access to your configuration:
 3. **Use `getOrThrow()`** for required configuration values
 4. **Use `get()`** for optional configuration values with proper fallback handling
 5. **Define your schema in a separate file** for reusability and better organization
-6. **Use a prefix with `EnvVarBind`** to give a meaningful prefix to environment variable names (e.g., `new EnvVarBind({ prefix: "APP" })`)
+6. **Use a prefix with `EnvVarBind`** to give a meaningful prefix to environment variable names (e.g., `await EnvVarBind.create({ prefix: "APP" })`)
 7. **Remember top-level items go in the 'app' section**: Top-level `configItem` entries are automatically placed in a section named after the `name` option (default: 'app'), so access them with `config.getOrThrow("app", "port")`
 
 ## Type Safety

package/package.json

@@ -1,24 +1,32 @@
 {
   "name": "@config-bound/nestjs",
-  "version": "0.2.0",
+  "version": "1.0.0",
   "description": "NestJS integration for ConfigBound configuration library",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "require": "./dist/index.js",
-      "import": "./dist/index.js"
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
     }
   },
-  "scripts": {
-    "build": "tsc",
-    "clean": "rimraf dist",
-    "test": "jest",
-    "lint": "eslint src/**/*.ts --fix",
-    "lint:ci": "eslint src/**/*.ts",
-    "format": "prettier --write --config ../../.config/.prettierrc --ignore-path ../../.config/.prettierignore src/**/*.ts",
-    "format:ci": "prettier --check --config ../../.config/.prettierrc --ignore-path ../../.config/.prettierignore src/**/*.ts"
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
+  "engines": {
+    "node": ">=20"
   },
   "keywords": [
     "nestjs",
@@ -30,7 +38,7 @@
   "author": "Robert Keyser",
   "license": "MIT",
   "dependencies": {
-    "@config-bound/config-bound": "0.2.0"
+    "@config-bound/core": "1.0.0"
   },
   "peerDependencies": {
     "@nestjs/common": "^10.0.0 || ^11.0.0",
@@ -39,7 +47,6 @@
     "rxjs": "^7.0.0"
   },
   "devDependencies": {
-    "@config-bound/eslint-config": "*",
     "@nestjs/common": "^11.1.8",
     "@nestjs/core": "^11.1.8",
     "@nestjs/testing": "^11.1.8",
@@ -49,14 +56,36 @@
     "jest": "^30.2.0",
     "rimraf": "^6.1.0",
     "ts-jest": "^29.4.5",
-    "typescript": "^6.0.0"
+    "typescript": "^6.0.0",
+    "zod": "^4.4.1",
+    "@config-bound/eslint-config": "0.0.0",
+    "@config-bound/typescript-config": "0.0.0"
   },
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
   },
+  "typedocOptions": {
+    "entryPoints": [
+      "./src/index.ts"
+    ],
+    "tsconfig": "./tsconfig.typedoc.json",
+    "exclude": [
+      "**/*.spec.ts"
+    ]
+  },
   "repository": {
     "type": "git",
-    "url": "https://github.com/notr-ai/ConfigBound"
+    "url": "git+https://github.com/notr-ai/ConfigBound.git"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "typecheck": "tsc --noEmit",
+    "clean": "rimraf dist",
+    "test": "jest --config jest.config.cjs",
+    "lint": "eslint src/**/*.ts --fix",
+    "lint:ci": "eslint src/**/*.ts",
+    "format": "prettier --write --config ../../.config/.prettierrc --ignore-path ../../.config/.prettierignore src/**/*.ts",
+    "format:ci": "prettier --check --config ../../.config/.prettierrc --ignore-path ../../.config/.prettierignore src/**/*.ts"
   }
-}
+}

package/PUBLISHING.md

@@ -1,211 +0,0 @@
-# Publishing @config-bound/nestjs
-
-This document outlines the steps to publish the `@config-bound/nestjs` package to npm.
-
-## Prerequisites
-
-1. npm account with access to the `@config-bound` scope
-2. Authentication configured: `npm login`
-3. Package built successfully: `npm run build`
-
-## Pre-publish Checklist
-
-- [ ] All tests pass
-- [ ] Build succeeds without errors
-- [ ] README.md is complete and accurate
-- [ ] Version number is updated in package.json
-- [ ] CHANGELOG.md is updated (if applicable)
-- [ ] LICENSE file is present
-- [ ] .npmignore is configured correctly
-
-## Publishing Steps
-
-### 1. Verify Package Contents
-
-Preview what will be published:
-
-```bash
-cd packages/nestjs
-npm pack --dry-run
-```
-
-This shows all files that will be included in the package.
-
-### 2. Verify Package Configuration
-
-Check the package.json exports:
-
-```bash
-cat package.json | grep -A 10 "exports"
-```
-
-Should show:
-
-```json
-"exports": {
-  ".": {
-    "types": "./dist/index.d.ts",
-    "require": "./dist/index.js",
-    "import": "./dist/index.js"
-  }
-}
-```
-
-### 3. Test Installation Locally
-
-Create a test package and install from local directory:
-
-```bash
-mkdir /tmp/test-nestjs-package
-cd /tmp/test-nestjs-package
-npm init -y
-npm install /path/to/configBound/packages/nestjs
-```
-
-### 4. Update Version
-
-Use semantic versioning:
-
-```bash
-# For bug fixes
-npm version patch
-
-# For new features
-npm version minor
-
-# For breaking changes
-npm version major
-```
-
-Or manually update `package.json`:
-
-```json
-{
-  "version": "0.0.2"
-}
-```
-
-### 5. Build the Package
-
-```bash
-npm run clean
-npm run build
-```
-
-### 6. Publish to npm
-
-For the first release:
-
-```bash
-npm publish --access public
-```
-
-For subsequent releases:
-
-```bash
-npm publish
-```
-
-### 7. Verify Publication
-
-```bash
-npm view @config-bound/nestjs
-```
-
-### 8. Test Installation from npm
-
-```bash
-cd /tmp/test-install
-npm init -y
-npm install @config-bound/nestjs @config-bound/config-bound @nestjs/common @nestjs/core
-```
-
-## Publishing from CI/CD
-
-If using GitHub Actions or similar:
-
-```yaml
-name: Publish Package
-
-on:
-  push:
-    tags:
-      - 'nestjs-v*'
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-
-      - uses: actions/setup-node@v3
-        with:
-          node-version: '22'
-          registry-url: 'https://registry.npmjs.org'
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Build
-        run: npm run build
-
-      - name: Publish to npm
-        working-directory: packages/nestjs
-        run: npm publish --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-```
-
-## Post-publish
-
-1. Create a GitHub release with the same version tag
-2. Update documentation website (if applicable)
-3. Announce on relevant channels
-4. Update dependent packages to use new version
-
-## Troubleshooting
-
-### "Package already exists"
-
-You cannot republish the same version. Bump the version and try again.
-
-### "403 Forbidden"
-
-Ensure you're logged in and have permission to publish to the `@config-bound` scope:
-
-```bash
-npm whoami
-npm access list packages
-```
-
-### "EPERM: operation not permitted"
-
-Make sure you have write permissions in the package directory.
-
-### Type definitions not working
-
-Verify that:
-
-- `declaration: true` in tsconfig.json
-- `types` field in package.json points to correct .d.ts file
-- Build process generates .d.ts files
-
-## Version History
-
-- 0.0.1 - Initial release
-
-## Related Commands
-
-```bash
-# View package info
-npm view @config-bound/nestjs
-
-# Download package tarball
-npm pack
-
-# Deprecate a version
-npm deprecate @config-bound/nestjs@0.0.1 "Reason for deprecation"
-
-# Unpublish (only within 72 hours)
-npm unpublish @config-bound/nestjs@0.0.1
-```

package/eslint.config.mjs

@@ -1,3 +0,0 @@
-import configBoundConfig from '@config-bound/eslint-config/package.eslint.mjs';
-
-export default configBoundConfig;

package/jest.config.js

@@ -1,23 +0,0 @@
-/* eslint-disable @typescript-eslint/naming-convention */
-
-/** @type {import('ts-jest').JestConfigWithTsJest} **/
-module.exports = {
-  testEnvironment: 'node',
-  rootDir: './src',
-  testMatch: ['**/*.spec.ts'],
-  transform: {
-    '^.+\\.tsx?$': [
-      'ts-jest',
-      {
-        tsconfig: {
-          experimentalDecorators: true,
-          emitDecoratorMetadata: true,
-          isolatedModules: false
-        },
-        diagnostics: {
-          ignoreCodes: [151002]
-        }
-      }
-    ]
-  }
-};