@dyanet/nextjs-config-aws 1.0.0-beta.1 → 1.1.0
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 +208 -173
- package/dist/cjs/client/env.js +9 -1
- package/dist/cjs/client/env.js.map +1 -1
- package/dist/cjs/components/public-env-script.js +4 -0
- package/dist/cjs/components/public-env-script.js.map +1 -1
- package/dist/cjs/index.js +54 -28
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/react.js +50 -0
- package/dist/cjs/react.js.map +1 -0
- package/dist/cjs/server/get-config.js +74 -28
- package/dist/cjs/server/get-config.js.map +1 -1
- package/dist/cjs/server/index.js +7 -6
- package/dist/cjs/server/index.js.map +1 -1
- package/dist/cjs/server/internal/environment.js +38 -0
- package/dist/cjs/server/internal/environment.js.map +1 -0
- package/dist/cjs/server/internal/index.js +13 -0
- package/dist/cjs/server/internal/index.js.map +1 -0
- package/dist/cjs/server/internal/loader-factory.js +61 -0
- package/dist/cjs/server/internal/loader-factory.js.map +1 -0
- package/dist/esm/client/env.js +9 -1
- package/dist/esm/client/env.js.map +1 -1
- package/dist/esm/components/public-env-script.js +4 -0
- package/dist/esm/components/public-env-script.js.map +1 -1
- package/dist/esm/index.js +57 -8
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/react.js +43 -0
- package/dist/esm/react.js.map +1 -0
- package/dist/esm/server/get-config.js +74 -28
- package/dist/esm/server/get-config.js.map +1 -1
- package/dist/esm/server/index.js +6 -1
- package/dist/esm/server/index.js.map +1 -1
- package/dist/esm/server/internal/environment.js +35 -0
- package/dist/esm/server/internal/environment.js.map +1 -0
- package/dist/esm/server/internal/index.js +8 -0
- package/dist/esm/server/internal/index.js.map +1 -0
- package/dist/esm/server/internal/loader-factory.js +58 -0
- package/dist/esm/server/internal/loader-factory.js.map +1 -0
- package/dist/types/client/env.d.ts +9 -1
- package/dist/types/client/env.d.ts.map +1 -1
- package/dist/types/components/public-env-script.d.ts +4 -0
- package/dist/types/components/public-env-script.d.ts.map +1 -1
- package/dist/types/index.d.ts +54 -7
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/react.d.ts +43 -0
- package/dist/types/react.d.ts.map +1 -0
- package/dist/types/server/get-config.d.ts +102 -24
- package/dist/types/server/get-config.d.ts.map +1 -1
- package/dist/types/server/index.d.ts +8 -1
- package/dist/types/server/index.d.ts.map +1 -1
- package/dist/types/server/internal/environment.d.ts +30 -0
- package/dist/types/server/internal/environment.d.ts.map +1 -0
- package/dist/types/server/internal/index.d.ts +8 -0
- package/dist/types/server/internal/index.d.ts.map +1 -0
- package/dist/types/server/internal/loader-factory.d.ts +51 -0
- package/dist/types/server/internal/loader-factory.d.ts.map +1 -0
- package/package.json +9 -4
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* React-specific exports for Next.js configuration management.
|
|
3
|
+
*
|
|
4
|
+
* This module provides React context providers and hooks for accessing
|
|
5
|
+
* configuration in React server components. These exports require React
|
|
6
|
+
* to be available in the runtime environment.
|
|
7
|
+
*
|
|
8
|
+
* For React-free configuration loading (API routes, middleware), use the
|
|
9
|
+
* main package exports instead:
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* ```typescript
|
|
13
|
+
* // API routes, middleware (React-free)
|
|
14
|
+
* import { getConfig } from '@dyanet/nextjs-config-aws';
|
|
15
|
+
*
|
|
16
|
+
* // React server components (React context)
|
|
17
|
+
* import { ConfigProvider, useConfig } from '@dyanet/nextjs-config-aws/react';
|
|
18
|
+
* ```
|
|
19
|
+
*
|
|
20
|
+
* @example
|
|
21
|
+
* ```typescript
|
|
22
|
+
* // In layout.tsx (Server Component)
|
|
23
|
+
* import { getConfig } from '@dyanet/nextjs-config-aws';
|
|
24
|
+
* import { ConfigProvider } from '@dyanet/nextjs-config-aws/react';
|
|
25
|
+
*
|
|
26
|
+
* export default async function RootLayout({ children }) {
|
|
27
|
+
* const config = await getConfig({ schema });
|
|
28
|
+
* return (
|
|
29
|
+
* <html>
|
|
30
|
+
* <body>
|
|
31
|
+
* <ConfigProvider config={config}>
|
|
32
|
+
* {children}
|
|
33
|
+
* </ConfigProvider>
|
|
34
|
+
* </body>
|
|
35
|
+
* </html>
|
|
36
|
+
* );
|
|
37
|
+
* }
|
|
38
|
+
* ```
|
|
39
|
+
*
|
|
40
|
+
* @packageDocumentation
|
|
41
|
+
*/
|
|
42
|
+
export { createConfigProvider, ConfigProvider, useConfig, ConfigContext, } from './server/config-provider';
|
|
43
|
+
//# sourceMappingURL=react.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"react.js","sourceRoot":"","sources":["../../src/react.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AAEH,OAAO,EACL,oBAAoB,EACpB,cAAc,EACd,SAAS,EACT,aAAa,GACd,MAAM,0BAA0B,CAAC"}
|
|
@@ -1,8 +1,35 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Server-side configuration loading for Next.js applications.
|
|
3
3
|
* Provides a cached getConfig() function that uses ConfigManager from @dyanet/config-aws.
|
|
4
|
+
*
|
|
5
|
+
* This module provides a simplified, opinionated API that hides loader complexity.
|
|
6
|
+
* For advanced usage such as custom loaders, direct AWS SDK integration, or
|
|
7
|
+
* fine-grained control over configuration loading, import from `@dyanet/config-aws` directly:
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* ```typescript
|
|
11
|
+
* // Advanced usage with custom loaders
|
|
12
|
+
* import {
|
|
13
|
+
* ConfigManager,
|
|
14
|
+
* EnvironmentLoader,
|
|
15
|
+
* SecretsManagerLoader,
|
|
16
|
+
* SSMParameterStoreLoader,
|
|
17
|
+
* } from '@dyanet/config-aws';
|
|
18
|
+
*
|
|
19
|
+
* const manager = new ConfigManager({
|
|
20
|
+
* loaders: [
|
|
21
|
+
* new EnvironmentLoader({ prefix: 'APP_' }),
|
|
22
|
+
* new SecretsManagerLoader({ secretName: '/my-app/config' }),
|
|
23
|
+
* ],
|
|
24
|
+
* schema: mySchema,
|
|
25
|
+
* });
|
|
26
|
+
* await manager.load();
|
|
27
|
+
* const config = manager.getAll();
|
|
28
|
+
* ```
|
|
4
29
|
*/
|
|
5
30
|
import { ConfigManager, } from '@dyanet/config-aws';
|
|
31
|
+
import { detectEnvironment } from './internal/environment';
|
|
32
|
+
import { createLoaders } from './internal/loader-factory';
|
|
6
33
|
/**
|
|
7
34
|
* Cache storage for configuration
|
|
8
35
|
* Uses a Map to support multiple cache keys (for different option combinations)
|
|
@@ -14,15 +41,16 @@ const configCache = new Map();
|
|
|
14
41
|
*/
|
|
15
42
|
let awsApiCallCount = 0;
|
|
16
43
|
/**
|
|
17
|
-
* Generate a cache key from options
|
|
44
|
+
* Generate a cache key from options.
|
|
45
|
+
* The cache key is based on aws options, environment, and forceAwsInDev.
|
|
18
46
|
* @internal
|
|
19
47
|
*/
|
|
20
|
-
function generateCacheKey(options) {
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
: options.
|
|
25
|
-
|
|
48
|
+
function generateCacheKey(options, resolvedEnvironment) {
|
|
49
|
+
return JSON.stringify({
|
|
50
|
+
aws: options.aws,
|
|
51
|
+
environment: resolvedEnvironment,
|
|
52
|
+
forceAwsInDev: options.forceAwsInDev ?? false,
|
|
53
|
+
});
|
|
26
54
|
}
|
|
27
55
|
/**
|
|
28
56
|
* Check if a cache entry is still valid
|
|
@@ -36,12 +64,18 @@ function isCacheValid(entry) {
|
|
|
36
64
|
/**
|
|
37
65
|
* Load configuration for Next.js server-side use.
|
|
38
66
|
*
|
|
39
|
-
* This function provides
|
|
40
|
-
*
|
|
67
|
+
* This function provides automatic environment detection and caching to avoid
|
|
68
|
+
* repeated AWS API calls during request handling. Configuration is cached based
|
|
69
|
+
* on the AWS options, environment, and forceAwsInDev setting.
|
|
70
|
+
*
|
|
71
|
+
* Environment Behavior:
|
|
72
|
+
* - development: env vars + .env.local/.env files, AWS only if forceAwsInDev
|
|
73
|
+
* - production: env vars + .env file + AWS sources (if configured)
|
|
74
|
+
* - test: env vars only (no file or AWS access)
|
|
41
75
|
*
|
|
42
76
|
* @example
|
|
43
77
|
* ```typescript
|
|
44
|
-
* import { getConfig
|
|
78
|
+
* import { getConfig } from '@dyanet/nextjs-config-aws';
|
|
45
79
|
* import { z } from 'zod';
|
|
46
80
|
*
|
|
47
81
|
* const schema = z.object({
|
|
@@ -49,29 +83,34 @@ function isCacheValid(entry) {
|
|
|
49
83
|
* API_KEY: z.string(),
|
|
50
84
|
* });
|
|
51
85
|
*
|
|
52
|
-
* //
|
|
53
|
-
*
|
|
54
|
-
* const config = await getConfig({
|
|
55
|
-
* schema,
|
|
56
|
-
* loaders: [
|
|
57
|
-
* new EnvironmentLoader(),
|
|
58
|
-
* new SecretsManagerLoader({ secretName: '/my-app/config' }),
|
|
59
|
-
* ],
|
|
60
|
-
* precedence: 'aws-first',
|
|
61
|
-
* });
|
|
86
|
+
* // Minimal usage - auto-detects environment
|
|
87
|
+
* const config = await getConfig({ schema });
|
|
62
88
|
*
|
|
63
|
-
*
|
|
64
|
-
*
|
|
89
|
+
* // With AWS Secrets Manager (loaded in production)
|
|
90
|
+
* const config = await getConfig({
|
|
91
|
+
* schema,
|
|
92
|
+
* aws: { secretName: '/my-app/config', region: 'us-east-1' }
|
|
93
|
+
* });
|
|
94
|
+
*
|
|
95
|
+
* // Force AWS in development for testing
|
|
96
|
+
* const config = await getConfig({
|
|
97
|
+
* schema,
|
|
98
|
+
* aws: { secretName: '/my-app/config' },
|
|
99
|
+
* forceAwsInDev: true
|
|
100
|
+
* });
|
|
65
101
|
* ```
|
|
66
102
|
*
|
|
67
103
|
* @param options Configuration options
|
|
68
104
|
* @returns Promise resolving to the validated configuration object
|
|
105
|
+
* @throws {ValidationError} When schema validation fails (includes invalid key names)
|
|
69
106
|
*/
|
|
70
107
|
export async function getConfig(options = {}) {
|
|
71
|
-
const { schema,
|
|
108
|
+
const { schema, aws, environment: explicitEnvironment, forceAwsInDev = false, cache = true, cacheTTL = 60000, // 1 minute default
|
|
72
109
|
enableLogging = false, } = options;
|
|
73
|
-
//
|
|
74
|
-
const
|
|
110
|
+
// Determine environment: explicit option takes precedence over auto-detection
|
|
111
|
+
const resolvedEnvironment = explicitEnvironment ?? detectEnvironment();
|
|
112
|
+
// Generate cache key based on aws options, environment, and forceAwsInDev
|
|
113
|
+
const cacheKey = generateCacheKey(options, resolvedEnvironment);
|
|
75
114
|
// Check cache if enabled
|
|
76
115
|
if (cache) {
|
|
77
116
|
const cached = configCache.get(cacheKey);
|
|
@@ -81,11 +120,17 @@ export async function getConfig(options = {}) {
|
|
|
81
120
|
}
|
|
82
121
|
// Increment API call counter (for testing)
|
|
83
122
|
awsApiCallCount++;
|
|
84
|
-
// Create
|
|
123
|
+
// Create loaders using the internal factory
|
|
124
|
+
const loaders = createLoaders({
|
|
125
|
+
environment: resolvedEnvironment,
|
|
126
|
+
aws,
|
|
127
|
+
forceAwsInDev,
|
|
128
|
+
});
|
|
129
|
+
// Create ConfigManager with generated loaders
|
|
85
130
|
const managerOptions = {
|
|
86
131
|
loaders,
|
|
87
132
|
schema,
|
|
88
|
-
precedence,
|
|
133
|
+
precedence: 'aws-first',
|
|
89
134
|
validateOnLoad: true,
|
|
90
135
|
enableLogging,
|
|
91
136
|
};
|
|
@@ -139,7 +184,8 @@ export function resetAwsApiCallCount() {
|
|
|
139
184
|
* @param options The options used to create the cache entry
|
|
140
185
|
*/
|
|
141
186
|
export function invalidateConfig(options) {
|
|
142
|
-
const
|
|
187
|
+
const resolvedEnvironment = options.environment ?? detectEnvironment();
|
|
188
|
+
const cacheKey = generateCacheKey(options, resolvedEnvironment);
|
|
143
189
|
configCache.delete(cacheKey);
|
|
144
190
|
}
|
|
145
191
|
//# sourceMappingURL=get-config.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"get-config.js","sourceRoot":"","sources":["../../../src/server/get-config.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"get-config.js","sourceRoot":"","sources":["../../../src/server/get-config.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAGH,OAAO,EACL,aAAa,GAGd,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAmB,MAAM,wBAAwB,CAAC;AAC5E,OAAO,EAAE,aAAa,EAAc,MAAM,2BAA2B,CAAC;AA8EtE;;;GAGG;AACH,MAAM,WAAW,GAAG,IAAI,GAAG,EAA+B,CAAC;AAE3D;;;GAGG;AACH,IAAI,eAAe,GAAG,CAAC,CAAC;AAExB;;;;GAIG;AACH,SAAS,gBAAgB,CAAI,OAA6B,EAAE,mBAAoC;IAC9F,OAAO,IAAI,CAAC,SAAS,CAAC;QACpB,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,WAAW,EAAE,mBAAmB;QAChC,aAAa,EAAE,OAAO,CAAC,aAAa,IAAI,KAAK;KAC9C,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,SAAS,YAAY,CAAI,KAAgC;IACvD,IAAI,CAAC,KAAK;QAAE,OAAO,KAAK,CAAC;IACzB,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,SAAS,CAAC;AACtC,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,UAAgC,EAAE;IAElC,MAAM,EACJ,MAAM,EACN,GAAG,EACH,WAAW,EAAE,mBAAmB,EAChC,aAAa,GAAG,KAAK,EACrB,KAAK,GAAG,IAAI,EACZ,QAAQ,GAAG,KAAK,EAAE,mBAAmB;IACrC,aAAa,GAAG,KAAK,GACtB,GAAG,OAAO,CAAC;IAEZ,8EAA8E;IAC9E,MAAM,mBAAmB,GAAG,mBAAmB,IAAI,iBAAiB,EAAE,CAAC;IAEvE,0EAA0E;IAC1E,MAAM,QAAQ,GAAG,gBAAgB,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC;IAEhE,yBAAyB;IACzB,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,MAAM,GAAG,WAAW,CAAC,GAAG,CAAC,QAAQ,CAA8B,CAAC;QACtE,IAAI,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC;YACzB,OAAO,MAAM,CAAC,MAAM,CAAC;QACvB,CAAC;IACH,CAAC;IAED,2CAA2C;IAC3C,eAAe,EAAE,CAAC;IAElB,4CAA4C;IAC5C,MAAM,OAAO,GAAG,aAAa,CAAC;QAC5B,WAAW,EAAE,mBAAmB;QAChC,GAAG;QACH,aAAa;KACd,CAAC,CAAC;IAEH,8CAA8C;IAC9C,MAAM,cAAc,GAA4B;QAC9C,OAAO;QACP,MAAM;QACN,UAAU,EAAE,WAAW;QACvB,cAAc,EAAE,IAAI;QACpB,aAAa;KACd,CAAC;IAEF,MAAM,OAAO,GAAG,IAAI,aAAa,CAAI,cAAc,CAAC,CAAC;IACrD,MAAM,OAAO,CAAC,IAAI,EAAE,CAAC;IAErB,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAChC,MAAM,UAAU,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAE3C,4BAA4B;IAC5B,IAAI,KAAK,IAAI,UAAU,EAAE,CAAC;QACxB,MAAM,KAAK,GAAkB;YAC3B,MAAM;YACN,UAAU;YACV,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,QAAQ;SACjC,CAAC;QACF,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,KAA4B,CAAC,CAAC;IAC1D,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB;IAC9B,WAAW,CAAC,KAAK,EAAE,CAAC;AACtB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,kBAAkB;IAChC,OAAO,WAAW,CAAC,IAAI,CAAC;AAC1B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,kBAAkB;IAChC,OAAO,eAAe,CAAC;AACzB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,oBAAoB;IAClC,eAAe,GAAG,CAAC,CAAC;AACtB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAI,OAA6B;IAC/D,MAAM,mBAAmB,GAAG,OAAO,CAAC,WAAW,IAAI,iBAAiB,EAAE,CAAC;IACvE,MAAM,QAAQ,GAAG,gBAAgB,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC;IAChE,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AAC/B,CAAC"}
|
package/dist/esm/server/index.js
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Server-side exports for Next.js configuration management.
|
|
3
|
+
*
|
|
4
|
+
* This module exports React-free configuration utilities that work in all
|
|
5
|
+
* server contexts including API routes, middleware, and server components.
|
|
6
|
+
*
|
|
7
|
+
* For React context providers (ConfigProvider, useConfig), import from
|
|
8
|
+
* '@dyanet/nextjs-config-aws/react' instead.
|
|
3
9
|
*/
|
|
4
10
|
export { getConfig, clearConfigCache, getConfigCacheSize, invalidateConfig, } from './get-config';
|
|
5
|
-
export { createConfigProvider, ConfigProvider, useConfig, ConfigContext, } from './config-provider';
|
|
6
11
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/server/index.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/server/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EACL,SAAS,EACT,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,GAEjB,MAAM,cAAc,CAAC"}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Environment detection utilities for Next.js configuration.
|
|
3
|
+
* @internal
|
|
4
|
+
*/
|
|
5
|
+
/**
|
|
6
|
+
* Detect the current environment mode based on NODE_ENV.
|
|
7
|
+
*
|
|
8
|
+
* @returns The detected environment mode:
|
|
9
|
+
* - 'production' if NODE_ENV is 'production'
|
|
10
|
+
* - 'test' if NODE_ENV is 'test'
|
|
11
|
+
* - 'development' for all other cases (including undefined)
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```typescript
|
|
15
|
+
* // NODE_ENV=production
|
|
16
|
+
* detectEnvironment(); // 'production'
|
|
17
|
+
*
|
|
18
|
+
* // NODE_ENV=test
|
|
19
|
+
* detectEnvironment(); // 'test'
|
|
20
|
+
*
|
|
21
|
+
* // NODE_ENV=development or undefined
|
|
22
|
+
* detectEnvironment(); // 'development'
|
|
23
|
+
* ```
|
|
24
|
+
*/
|
|
25
|
+
export function detectEnvironment() {
|
|
26
|
+
const nodeEnv = process.env['NODE_ENV'];
|
|
27
|
+
if (nodeEnv === 'production') {
|
|
28
|
+
return 'production';
|
|
29
|
+
}
|
|
30
|
+
if (nodeEnv === 'test') {
|
|
31
|
+
return 'test';
|
|
32
|
+
}
|
|
33
|
+
return 'development';
|
|
34
|
+
}
|
|
35
|
+
//# sourceMappingURL=environment.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"environment.js","sourceRoot":"","sources":["../../../../src/server/internal/environment.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAOH;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,iBAAiB;IAC/B,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAExC,IAAI,OAAO,KAAK,YAAY,EAAE,CAAC;QAC7B,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,IAAI,OAAO,KAAK,MAAM,EAAE,CAAC;QACvB,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO,aAAa,CAAC;AACvB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/server/internal/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,iBAAiB,EAAwB,MAAM,eAAe,CAAC;AACxE,OAAO,EAAE,aAAa,EAA6B,MAAM,kBAAkB,CAAC"}
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Internal loader factory for Next.js configuration.
|
|
3
|
+
* Creates loaders based on environment and options.
|
|
4
|
+
* @internal
|
|
5
|
+
*/
|
|
6
|
+
import { EnvironmentLoader, EnvFileLoader, SecretsManagerLoader, SSMParameterStoreLoader, } from '@dyanet/config-aws';
|
|
7
|
+
/**
|
|
8
|
+
* Environment Behavior Matrix:
|
|
9
|
+
*
|
|
10
|
+
* | Environment | Env Vars | .env Files | AWS Sources |
|
|
11
|
+
* |-------------|----------|----------------------|-----------------------|
|
|
12
|
+
* | development | ✓ | .env.local, .env | Only if forceAwsInDev |
|
|
13
|
+
* | production | ✓ | .env | ✓ (if configured) |
|
|
14
|
+
* | test | ✓ | ✗ | ✗ |
|
|
15
|
+
*/
|
|
16
|
+
/**
|
|
17
|
+
* Create loaders based on environment and options.
|
|
18
|
+
*
|
|
19
|
+
* This factory implements the environment behavior matrix:
|
|
20
|
+
* - development: env vars + .env.local/.env files, AWS only if forceAwsInDev
|
|
21
|
+
* - production: env vars + .env file + AWS sources (if configured)
|
|
22
|
+
* - test: env vars only (no file or AWS access)
|
|
23
|
+
*
|
|
24
|
+
* @param options - Factory options including environment and AWS config
|
|
25
|
+
* @returns Array of ConfigLoader instances
|
|
26
|
+
*/
|
|
27
|
+
export function createLoaders(options) {
|
|
28
|
+
const { environment, aws, forceAwsInDev = false } = options;
|
|
29
|
+
const loaders = [];
|
|
30
|
+
// Always include environment variables
|
|
31
|
+
loaders.push(new EnvironmentLoader());
|
|
32
|
+
// Include .env files based on environment
|
|
33
|
+
if (environment === 'development') {
|
|
34
|
+
loaders.push(new EnvFileLoader({ paths: ['.env.local', '.env'] }));
|
|
35
|
+
}
|
|
36
|
+
else if (environment === 'production') {
|
|
37
|
+
loaders.push(new EnvFileLoader({ paths: ['.env'] }));
|
|
38
|
+
}
|
|
39
|
+
// test environment: no file loading
|
|
40
|
+
// Include AWS loaders in production or when forced in development
|
|
41
|
+
const shouldLoadAws = environment === 'production' || (environment === 'development' && forceAwsInDev);
|
|
42
|
+
if (shouldLoadAws && aws) {
|
|
43
|
+
if (aws.secretName) {
|
|
44
|
+
loaders.push(new SecretsManagerLoader({
|
|
45
|
+
secretName: aws.secretName,
|
|
46
|
+
region: aws.region,
|
|
47
|
+
}));
|
|
48
|
+
}
|
|
49
|
+
if (aws.ssmPrefix) {
|
|
50
|
+
loaders.push(new SSMParameterStoreLoader({
|
|
51
|
+
parameterPath: aws.ssmPrefix,
|
|
52
|
+
region: aws.region,
|
|
53
|
+
}));
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
return loaders;
|
|
57
|
+
}
|
|
58
|
+
//# sourceMappingURL=loader-factory.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"loader-factory.js","sourceRoot":"","sources":["../../../../src/server/internal/loader-factory.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAEL,iBAAiB,EACjB,aAAa,EACb,oBAAoB,EACpB,uBAAuB,GACxB,MAAM,oBAAoB,CAAC;AA2B5B;;;;;;;;GAQG;AAEH;;;;;;;;;;GAUG;AACH,MAAM,UAAU,aAAa,CAAC,OAA6B;IACzD,MAAM,EAAE,WAAW,EAAE,GAAG,EAAE,aAAa,GAAG,KAAK,EAAE,GAAG,OAAO,CAAC;IAC5D,MAAM,OAAO,GAAmB,EAAE,CAAC;IAEnC,uCAAuC;IACvC,OAAO,CAAC,IAAI,CAAC,IAAI,iBAAiB,EAAE,CAAC,CAAC;IAEtC,0CAA0C;IAC1C,IAAI,WAAW,KAAK,aAAa,EAAE,CAAC;QAClC,OAAO,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,EAAE,KAAK,EAAE,CAAC,YAAY,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;IACrE,CAAC;SAAM,IAAI,WAAW,KAAK,YAAY,EAAE,CAAC;QACxC,OAAO,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,EAAE,KAAK,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;IACvD,CAAC;IACD,oCAAoC;IAEpC,kEAAkE;IAClE,MAAM,aAAa,GAAG,WAAW,KAAK,YAAY,IAAI,CAAC,WAAW,KAAK,aAAa,IAAI,aAAa,CAAC,CAAC;IAEvG,IAAI,aAAa,IAAI,GAAG,EAAE,CAAC;QACzB,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC;YACnB,OAAO,CAAC,IAAI,CAAC,IAAI,oBAAoB,CAAC;gBACpC,UAAU,EAAE,GAAG,CAAC,UAAU;gBAC1B,MAAM,EAAE,GAAG,CAAC,MAAM;aACnB,CAAC,CAAC,CAAC;QACN,CAAC;QAED,IAAI,GAAG,CAAC,SAAS,EAAE,CAAC;YAClB,OAAO,CAAC,IAAI,CAAC,IAAI,uBAAuB,CAAC;gBACvC,aAAa,EAAE,GAAG,CAAC,SAAS;gBAC5B,MAAM,EAAE,GAAG,CAAC,MAAM;aACnB,CAAC,CAAC,CAAC;QACN,CAAC;IACH,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC"}
|
|
@@ -4,11 +4,19 @@
|
|
|
4
4
|
* This module provides a function to read runtime environment variables
|
|
5
5
|
* that were injected by the PublicEnvScript server component.
|
|
6
6
|
*
|
|
7
|
+
* @remarks
|
|
8
|
+
* This is part of the simplified Next.js API. For advanced configuration loading
|
|
9
|
+
* with custom loaders or direct AWS SDK integration, import from `@dyanet/config-aws` directly:
|
|
10
|
+
*
|
|
11
|
+
* ```typescript
|
|
12
|
+
* import { ConfigManager, EnvironmentLoader } from '@dyanet/config-aws';
|
|
13
|
+
* ```
|
|
14
|
+
*
|
|
7
15
|
* @example
|
|
8
16
|
* ```tsx
|
|
9
17
|
* 'use client';
|
|
10
18
|
*
|
|
11
|
-
* import { env } from '@dyanet/nextjs-config-aws
|
|
19
|
+
* import { env } from '@dyanet/nextjs-config-aws';
|
|
12
20
|
*
|
|
13
21
|
* function MyComponent() {
|
|
14
22
|
* const apiUrl = env('API_URL');
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"env.d.ts","sourceRoot":"","sources":["../../../src/client/env.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"env.d.ts","sourceRoot":"","sources":["../../../src/client/env.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAEH;;GAEG;AACH,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC/B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB;CACF;AA2BD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;AAErD;;;;;;;;;;;;GAYG;AACH,wBAAgB,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,GAAG,MAAM,GAAG,CAAC,CAAC;AAgBjE;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,OAAO,CAAC,YAAY,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;AAE/E;;;;;;;GAOG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,GAAG,MAAM,GAAG,CAAC,CAAC;AAgB3F;;;;;;;;;;;GAWG;AACH,wBAAgB,SAAS,CAAC,YAAY,GAAE,MAA8B,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAE9F;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,GAAE,MAA8B,GAAG,OAAO,CAGzF;AAED,eAAe,GAAG,CAAC"}
|
|
@@ -5,6 +5,10 @@
|
|
|
5
5
|
* into the client-side JavaScript context, enabling runtime environment variable access
|
|
6
6
|
* without requiring NEXT_PUBLIC_ prefixes at build time.
|
|
7
7
|
*
|
|
8
|
+
* @remarks
|
|
9
|
+
* This is part of the simplified Next.js API. For advanced configuration loading
|
|
10
|
+
* with custom loaders or direct AWS SDK integration, import from `@dyanet/config-aws` directly.
|
|
11
|
+
*
|
|
8
12
|
* @example
|
|
9
13
|
* ```tsx
|
|
10
14
|
* // In your root layout.tsx
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"public-env-script.d.ts","sourceRoot":"","sources":["../../../src/components/public-env-script.tsx"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"public-env-script.d.ts","sourceRoot":"","sources":["../../../src/components/public-env-script.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IAEtB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAC3B,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,EACvC,UAAU,CAAC,EAAE,MAAM,EAAE,EACrB,YAAY,CAAC,EAAE,MAAM,GACpB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CA0BxB;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CACnC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACnC,YAAY,EAAE,MAAM,GACnB,MAAM,CAGR;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,eAAe,CAAC,EAC9B,UAAU,EACV,YAAY,EACZ,YAAsB,EACtB,KAAK,GACN,EAAE,oBAAoB,GAAG,KAAK,CAAC,YAAY,GAAG,IAAI,CAuBlD;AAED,eAAe,eAAe,CAAC"}
|
package/dist/types/index.d.ts
CHANGED
|
@@ -2,12 +2,59 @@
|
|
|
2
2
|
* @dyanet/nextjs-config-aws
|
|
3
3
|
*
|
|
4
4
|
* Next.js adapter for AWS configuration management.
|
|
5
|
-
* Provides
|
|
6
|
-
*
|
|
5
|
+
* Provides a simplified, opinionated API for loading configuration
|
|
6
|
+
* with automatic environment detection and AWS integration.
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* ```typescript
|
|
10
|
+
* // Server-side configuration loading (works in API routes, middleware, etc.)
|
|
11
|
+
* import { getConfig } from '@dyanet/nextjs-config-aws';
|
|
12
|
+
*
|
|
13
|
+
* const config = await getConfig({
|
|
14
|
+
* schema: mySchema,
|
|
15
|
+
* aws: { secretName: '/myapp/config' }
|
|
16
|
+
* });
|
|
17
|
+
* ```
|
|
18
|
+
*
|
|
19
|
+
* @example
|
|
20
|
+
* ```typescript
|
|
21
|
+
* // Runtime environment variables for client
|
|
22
|
+
* // In layout.tsx (server component)
|
|
23
|
+
* import { PublicEnvScript } from '@dyanet/nextjs-config-aws';
|
|
24
|
+
*
|
|
25
|
+
* <PublicEnvScript publicVars={['API_URL', 'APP_NAME']} />
|
|
26
|
+
*
|
|
27
|
+
* // In client component
|
|
28
|
+
* import { env } from '@dyanet/nextjs-config-aws';
|
|
29
|
+
*
|
|
30
|
+
* const apiUrl = env('API_URL');
|
|
31
|
+
* ```
|
|
32
|
+
*
|
|
33
|
+
* @example
|
|
34
|
+
* ```typescript
|
|
35
|
+
* // React context providers (for server components only)
|
|
36
|
+
* // Import from '@dyanet/nextjs-config-aws/react' to avoid loading React
|
|
37
|
+
* // in non-React contexts like API routes
|
|
38
|
+
* import { ConfigProvider, useConfig } from '@dyanet/nextjs-config-aws/react';
|
|
39
|
+
* ```
|
|
40
|
+
*
|
|
41
|
+
* @remarks
|
|
42
|
+
* For advanced loader access, custom loaders, or direct AWS SDK integration,
|
|
43
|
+
* import from `@dyanet/config-aws` directly:
|
|
44
|
+
*
|
|
45
|
+
* ```typescript
|
|
46
|
+
* import {
|
|
47
|
+
* ConfigManager,
|
|
48
|
+
* EnvironmentLoader,
|
|
49
|
+
* SecretsManagerLoader,
|
|
50
|
+
* SSMParameterStoreLoader,
|
|
51
|
+
* } from '@dyanet/config-aws';
|
|
52
|
+
* ```
|
|
53
|
+
*
|
|
54
|
+
* @packageDocumentation
|
|
7
55
|
*/
|
|
8
|
-
export
|
|
9
|
-
export {
|
|
10
|
-
export {
|
|
11
|
-
export {
|
|
12
|
-
export { env, envFrom, getAllEnv, hasEnv } from './client';
|
|
56
|
+
export { ConfigurationError, ValidationError } from '@dyanet/config-aws';
|
|
57
|
+
export { getConfig, type NextConfigOptions } from './server';
|
|
58
|
+
export { PublicEnvScript, type PublicEnvScriptProps } from './components';
|
|
59
|
+
export { env } from './client';
|
|
13
60
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AAGH,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAGzE,OAAO,EAAE,SAAS,EAAE,KAAK,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAG7D,OAAO,EAAE,eAAe,EAAE,KAAK,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAG1E,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC"}
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* React-specific exports for Next.js configuration management.
|
|
3
|
+
*
|
|
4
|
+
* This module provides React context providers and hooks for accessing
|
|
5
|
+
* configuration in React server components. These exports require React
|
|
6
|
+
* to be available in the runtime environment.
|
|
7
|
+
*
|
|
8
|
+
* For React-free configuration loading (API routes, middleware), use the
|
|
9
|
+
* main package exports instead:
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* ```typescript
|
|
13
|
+
* // API routes, middleware (React-free)
|
|
14
|
+
* import { getConfig } from '@dyanet/nextjs-config-aws';
|
|
15
|
+
*
|
|
16
|
+
* // React server components (React context)
|
|
17
|
+
* import { ConfigProvider, useConfig } from '@dyanet/nextjs-config-aws/react';
|
|
18
|
+
* ```
|
|
19
|
+
*
|
|
20
|
+
* @example
|
|
21
|
+
* ```typescript
|
|
22
|
+
* // In layout.tsx (Server Component)
|
|
23
|
+
* import { getConfig } from '@dyanet/nextjs-config-aws';
|
|
24
|
+
* import { ConfigProvider } from '@dyanet/nextjs-config-aws/react';
|
|
25
|
+
*
|
|
26
|
+
* export default async function RootLayout({ children }) {
|
|
27
|
+
* const config = await getConfig({ schema });
|
|
28
|
+
* return (
|
|
29
|
+
* <html>
|
|
30
|
+
* <body>
|
|
31
|
+
* <ConfigProvider config={config}>
|
|
32
|
+
* {children}
|
|
33
|
+
* </ConfigProvider>
|
|
34
|
+
* </body>
|
|
35
|
+
* </html>
|
|
36
|
+
* );
|
|
37
|
+
* }
|
|
38
|
+
* ```
|
|
39
|
+
*
|
|
40
|
+
* @packageDocumentation
|
|
41
|
+
*/
|
|
42
|
+
export { createConfigProvider, ConfigProvider, useConfig, ConfigContext, } from './server/config-provider';
|
|
43
|
+
//# sourceMappingURL=react.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"react.d.ts","sourceRoot":"","sources":["../../src/react.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AAEH,OAAO,EACL,oBAAoB,EACpB,cAAc,EACd,SAAS,EACT,aAAa,GACd,MAAM,0BAA0B,CAAC"}
|