opticedge-cloud-utils 1.1.23 → 1.1.24

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/dist/env.d.ts CHANGED
@@ -1 +1 @@
1
- export declare function getEnv(name: string, fallback?: any): any;
1
+ export declare function requireEnv(name: string, defaultValue?: string): string;
package/dist/env.js CHANGED
@@ -1,13 +1,13 @@
1
1
  "use strict";
2
- /* eslint-disable @typescript-eslint/no-explicit-any */
3
2
  Object.defineProperty(exports, "__esModule", { value: true });
4
- exports.getEnv = getEnv;
5
- function getEnv(name, fallback) {
3
+ exports.requireEnv = requireEnv;
4
+ function requireEnv(name, defaultValue) {
6
5
  const value = process.env[name];
7
- if (!value) {
8
- if (fallback !== undefined)
9
- return fallback;
10
- throw new Error(`Missing env var ${name}`);
6
+ if (value === undefined || value === '') {
7
+ if (defaultValue !== undefined) {
8
+ return defaultValue;
9
+ }
10
+ throw new Error(`${name} env var must be set`);
11
11
  }
12
12
  return value;
13
13
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "opticedge-cloud-utils",
3
- "version": "1.1.23",
3
+ "version": "1.1.24",
4
4
  "description": "Common utilities for cloud functions",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
package/src/env.ts CHANGED
@@ -1,10 +1,12 @@
1
- /* eslint-disable @typescript-eslint/no-explicit-any */
2
-
3
- export function getEnv(name: string, fallback?: any): any {
1
+ export function requireEnv(name: string, defaultValue?: string): string {
4
2
  const value = process.env[name]
5
- if (!value) {
6
- if (fallback !== undefined) return fallback
7
- throw new Error(`Missing env var ${name}`)
3
+
4
+ if (value === undefined || value === '') {
5
+ if (defaultValue !== undefined) {
6
+ return defaultValue
7
+ }
8
+ throw new Error(`${name} env var must be set`)
8
9
  }
10
+
9
11
  return value
10
- }
12
+ }
package/tests/env.test.ts CHANGED
@@ -1,18 +1,65 @@
1
- import { getEnv } from '../src/env'
1
+ import { requireEnv } from '../src/env'
2
2
 
3
- describe('getEnv', () => {
4
- it('returns the value of an existing env var', () => {
5
- process.env.TEST_KEY = 'test-value'
6
- expect(getEnv('TEST_KEY')).toBe('test-value')
3
+ describe('requireEnv', () => {
4
+ const ORIGINAL_ENV = process.env
5
+
6
+ beforeEach(() => {
7
+ jest.resetModules()
8
+ process.env = { ...ORIGINAL_ENV }
9
+ })
10
+
11
+ afterAll(() => {
12
+ process.env = ORIGINAL_ENV
13
+ })
14
+
15
+ // ============================================================
16
+ // Success cases
17
+ // ============================================================
18
+
19
+ it('returns env value when set', () => {
20
+ process.env.TEST_VAR = 'hello'
21
+ expect(requireEnv('TEST_VAR')).toBe('hello')
22
+ })
23
+
24
+ it('returns "0" correctly (should not treat as missing)', () => {
25
+ process.env.TEST_VAR = '0'
26
+ expect(requireEnv('TEST_VAR')).toBe('0')
7
27
  })
8
28
 
9
- it('returns fallback if env var is not set', () => {
10
- delete process.env.OPTIONAL_KEY
11
- expect(getEnv('OPTIONAL_KEY', 'default')).toBe('default')
29
+ it('returns "false" correctly (should not treat as missing)', () => {
30
+ process.env.TEST_VAR = 'false'
31
+ expect(requireEnv('TEST_VAR')).toBe('false')
32
+ })
33
+
34
+ // ============================================================
35
+ // Default handling
36
+ // ============================================================
37
+
38
+ it('returns default when env is undefined', () => {
39
+ delete process.env.TEST_VAR
40
+ expect(requireEnv('TEST_VAR', 'fallback')).toBe('fallback')
41
+ })
42
+
43
+ it('returns default when env is empty string', () => {
44
+ process.env.TEST_VAR = ''
45
+ expect(requireEnv('TEST_VAR', 'fallback')).toBe('fallback')
46
+ })
47
+
48
+ // ============================================================
49
+ // Error cases
50
+ // ============================================================
51
+
52
+ it('throws when env is undefined and no default provided', () => {
53
+ delete process.env.TEST_VAR
54
+ expect(() => requireEnv('TEST_VAR')).toThrow(
55
+ 'TEST_VAR env var must be set'
56
+ )
12
57
  })
13
58
 
14
- it('throws error if env var is not set and no fallback provided', () => {
15
- delete process.env.MISSING_KEY
16
- expect(() => getEnv('MISSING_KEY')).toThrow('Missing env var MISSING_KEY')
59
+ it('throws when env is empty string and no default provided', () => {
60
+ process.env.TEST_VAR = ''
61
+ expect(() => requireEnv('TEST_VAR')).toThrow(
62
+ 'TEST_VAR env var must be set'
63
+ )
17
64
  })
18
- })
65
+ })