@stryke/env 0.20.26 → 0.20.34

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.
Files changed (92) hide show
  1. package/CHANGELOG.md +1349 -0
  2. package/README.md +19 -9
  3. package/dist/ci-checks-5v7fZL3R.mjs +2 -0
  4. package/dist/ci-checks-5v7fZL3R.mjs.map +1 -0
  5. package/dist/{ci-checks.d.ts → ci-checks-BFAxtIMg.d.mts} +7 -3
  6. package/dist/ci-checks-BFAxtIMg.d.mts.map +1 -0
  7. package/dist/ci-checks-ByUPPNOk.d.cts +19 -0
  8. package/dist/ci-checks-ByUPPNOk.d.cts.map +1 -0
  9. package/dist/ci-checks-DRWFr2UM.cjs +1 -0
  10. package/dist/ci-checks.cjs +1 -10
  11. package/dist/ci-checks.d.cts +2 -0
  12. package/dist/ci-checks.d.mts +2 -0
  13. package/dist/ci-checks.mjs +1 -1
  14. package/dist/{environment-checks.d.ts → environment-checks-BvXEMk0w.d.mts} +22 -18
  15. package/dist/environment-checks-BvXEMk0w.d.mts.map +1 -0
  16. package/dist/environment-checks-CNP6SBWs.mjs +2 -0
  17. package/dist/environment-checks-CNP6SBWs.mjs.map +1 -0
  18. package/dist/environment-checks-TkDPh8QD.d.cts +59 -0
  19. package/dist/environment-checks-TkDPh8QD.d.cts.map +1 -0
  20. package/dist/environment-checks-ghgIrof1.cjs +1 -0
  21. package/dist/environment-checks.cjs +1 -84
  22. package/dist/environment-checks.d.cts +2 -0
  23. package/dist/environment-checks.d.mts +2 -0
  24. package/dist/environment-checks.mjs +1 -1
  25. package/dist/get-env-paths-CRQWNX3i.cjs +1 -0
  26. package/dist/get-env-paths-DReLbhw5.d.cts +64 -0
  27. package/dist/get-env-paths-DReLbhw5.d.cts.map +1 -0
  28. package/dist/get-env-paths-DUHBXxwb.mjs +2 -0
  29. package/dist/get-env-paths-DUHBXxwb.mjs.map +1 -0
  30. package/dist/get-env-paths-KTCEsWqe.d.mts +64 -0
  31. package/dist/get-env-paths-KTCEsWqe.d.mts.map +1 -0
  32. package/dist/get-env-paths.cjs +1 -58
  33. package/dist/get-env-paths.d.cts +2 -0
  34. package/dist/get-env-paths.d.mts +2 -0
  35. package/dist/get-env-paths.mjs +1 -1
  36. package/dist/index.cjs +1 -82
  37. package/dist/index.d.cts +8 -0
  38. package/dist/index.d.mts +8 -0
  39. package/dist/index.mjs +1 -1
  40. package/dist/join-paths-BMFGURJb.cjs +1 -0
  41. package/dist/join-paths-DoUrclq3.mjs +2 -0
  42. package/dist/join-paths-DoUrclq3.mjs.map +1 -0
  43. package/dist/{load-env.d.ts → load-env-B_Q4iLSZ.d.mts} +11 -6
  44. package/dist/load-env-B_Q4iLSZ.d.mts.map +1 -0
  45. package/dist/load-env-COR_EMlB.cjs +1 -0
  46. package/dist/load-env-DPtGxfd9.d.cts +61 -0
  47. package/dist/load-env-DPtGxfd9.d.cts.map +1 -0
  48. package/dist/load-env-DUjj4KN6.mjs +2 -0
  49. package/dist/load-env-DUjj4KN6.mjs.map +1 -0
  50. package/dist/load-env.cjs +1 -56
  51. package/dist/load-env.d.cts +2 -0
  52. package/dist/load-env.d.mts +2 -0
  53. package/dist/load-env.mjs +1 -1
  54. package/dist/providers-B2d_hJW2.d.mts +13 -0
  55. package/dist/providers-B2d_hJW2.d.mts.map +1 -0
  56. package/dist/providers-B9xVKxf9.cjs +1 -0
  57. package/dist/providers-BUdbSP8f.mjs +2 -0
  58. package/dist/providers-BUdbSP8f.mjs.map +1 -0
  59. package/dist/providers-YKl7K1Ek.d.cts +13 -0
  60. package/dist/providers-YKl7K1Ek.d.cts.map +1 -0
  61. package/dist/providers.cjs +1 -41
  62. package/dist/providers.d.cts +2 -0
  63. package/dist/providers.d.mts +2 -0
  64. package/dist/providers.mjs +1 -1
  65. package/dist/runtime-checks-Bka6c_Kr.d.mts +51 -0
  66. package/dist/runtime-checks-Bka6c_Kr.d.mts.map +1 -0
  67. package/dist/runtime-checks-DGhXcN9g.mjs +2 -0
  68. package/dist/runtime-checks-DGhXcN9g.mjs.map +1 -0
  69. package/dist/runtime-checks-Dc2IKXYE.d.cts +51 -0
  70. package/dist/runtime-checks-Dc2IKXYE.d.cts.map +1 -0
  71. package/dist/runtime-checks-NIf4Bpj9.cjs +1 -0
  72. package/dist/runtime-checks.cjs +1 -24
  73. package/dist/runtime-checks.d.cts +2 -0
  74. package/dist/runtime-checks.d.mts +2 -0
  75. package/dist/runtime-checks.mjs +1 -1
  76. package/dist/types-2O6mBvGZ.cjs +1 -0
  77. package/dist/types-D7S9q0_s.d.mts +8 -0
  78. package/dist/types-D7S9q0_s.d.mts.map +1 -0
  79. package/dist/types-DJpwQAko.d.cts +8 -0
  80. package/dist/types-DJpwQAko.d.cts.map +1 -0
  81. package/dist/types-ULysAnV9.mjs +2 -0
  82. package/dist/types-ULysAnV9.mjs.map +1 -0
  83. package/dist/types.cjs +1 -7
  84. package/dist/types.d.cts +2 -0
  85. package/dist/types.d.mts +2 -0
  86. package/dist/types.mjs +1 -1
  87. package/package.json +35 -159
  88. package/dist/get-env-paths.d.ts +0 -60
  89. package/dist/index.d.ts +0 -15
  90. package/dist/providers.d.ts +0 -9
  91. package/dist/runtime-checks.d.ts +0 -47
  92. package/dist/types.d.ts +0 -4
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stryke/env",
3
- "version": "0.20.26",
3
+ "version": "0.20.34",
4
4
  "type": "module",
5
5
  "description": "A package containing utility functions to handle environment specific processes",
6
6
  "repository": {
@@ -9,171 +9,47 @@
9
9
  "directory": "packages/env"
10
10
  },
11
11
  "private": false,
12
- "dependencies": {
13
- "@dotenvx/dotenvx": "1.35.0",
14
- "@stryke/convert": "^0.6.13",
15
- "@stryke/fs": "^0.33.9",
16
- "@stryke/path": "^0.22.0",
17
- "@stryke/string-format": "^0.12.13",
18
- "defu": "^6.1.4"
19
- },
20
- "devDependencies": { "@types/node": "^24.10.1" },
21
- "publishConfig": { "access": "public" },
22
- "sideEffects": false,
23
- "files": ["dist/**/*"],
24
- "homepage": "https://stormsoftware.com",
25
- "bugs": {
26
- "url": "https://stormsoftware.com/support",
27
- "email": "support@stormsoftware.com"
28
- },
29
- "license": "Apache-2.0",
30
- "keywords": [
31
- "stryke",
32
- "typescript",
33
- "utilities",
34
- "storm-software",
35
- "storm",
36
- "storm-ops",
37
- "cyclone-ui",
38
- "sullivanpj",
39
- "monorepo"
40
- ],
41
- "funding": {
42
- "type": "github",
43
- "url": "https://github.com/sponsors/storm-software"
44
- },
45
- "author": {
46
- "name": "Storm Software",
47
- "email": "contact@stormsoftware.com",
48
- "url": "https://stormsoftware.com"
49
- },
50
- "maintainers": [
51
- {
52
- "name": "Storm Software",
53
- "email": "contact@stormsoftware.com",
54
- "url": "https://stormsoftware.com"
55
- }
56
- ],
57
- "contributors": [
58
- {
59
- "name": "Storm Software",
60
- "email": "contact@stormsoftware.com",
61
- "url": "https://stormsoftware.com"
62
- }
63
- ],
12
+ "main": "./dist/index.cjs",
13
+ "module": "./dist/index.mjs",
64
14
  "exports": {
65
- "./types": {
66
- "import": { "types": "./dist/types.d.ts", "default": "./dist/types.mjs" },
67
- "require": {
68
- "types": "./dist/types.d.ts",
69
- "default": "./dist/types.cjs"
70
- },
71
- "default": { "types": "./dist/types.d.ts", "default": "./dist/types.mjs" }
72
- },
73
- "./runtime-checks": {
74
- "import": {
75
- "types": "./dist/runtime-checks.d.ts",
76
- "default": "./dist/runtime-checks.mjs"
77
- },
78
- "require": {
79
- "types": "./dist/runtime-checks.d.ts",
80
- "default": "./dist/runtime-checks.cjs"
81
- },
82
- "default": {
83
- "types": "./dist/runtime-checks.d.ts",
84
- "default": "./dist/runtime-checks.mjs"
85
- }
86
- },
87
- "./providers": {
88
- "import": {
89
- "types": "./dist/providers.d.ts",
90
- "default": "./dist/providers.mjs"
91
- },
92
- "require": {
93
- "types": "./dist/providers.d.ts",
94
- "default": "./dist/providers.cjs"
95
- },
96
- "default": {
97
- "types": "./dist/providers.d.ts",
98
- "default": "./dist/providers.mjs"
99
- }
100
- },
101
- "./load-env": {
102
- "import": {
103
- "types": "./dist/load-env.d.ts",
104
- "default": "./dist/load-env.mjs"
105
- },
106
- "require": {
107
- "types": "./dist/load-env.d.ts",
108
- "default": "./dist/load-env.cjs"
109
- },
110
- "default": {
111
- "types": "./dist/load-env.d.ts",
112
- "default": "./dist/load-env.mjs"
113
- }
15
+ ".": { "require": "./dist/index.cjs", "import": "./dist/index.mjs" },
16
+ "./ci-checks": {
17
+ "require": "./dist/ci-checks.cjs",
18
+ "import": "./dist/ci-checks.mjs"
114
19
  },
115
- "./index": {
116
- "import": { "types": "./dist/index.d.ts", "default": "./dist/index.mjs" },
117
- "require": {
118
- "types": "./dist/index.d.ts",
119
- "default": "./dist/index.cjs"
120
- },
121
- "default": { "types": "./dist/index.d.ts", "default": "./dist/index.mjs" }
20
+ "./environment-checks": {
21
+ "require": "./dist/environment-checks.cjs",
22
+ "import": "./dist/environment-checks.mjs"
122
23
  },
123
24
  "./get-env-paths": {
124
- "import": {
125
- "types": "./dist/get-env-paths.d.ts",
126
- "default": "./dist/get-env-paths.mjs"
127
- },
128
- "require": {
129
- "types": "./dist/get-env-paths.d.ts",
130
- "default": "./dist/get-env-paths.cjs"
131
- },
132
- "default": {
133
- "types": "./dist/get-env-paths.d.ts",
134
- "default": "./dist/get-env-paths.mjs"
135
- }
25
+ "require": "./dist/get-env-paths.cjs",
26
+ "import": "./dist/get-env-paths.mjs"
136
27
  },
137
- "./environment-checks": {
138
- "import": {
139
- "types": "./dist/environment-checks.d.ts",
140
- "default": "./dist/environment-checks.mjs"
141
- },
142
- "require": {
143
- "types": "./dist/environment-checks.d.ts",
144
- "default": "./dist/environment-checks.cjs"
145
- },
146
- "default": {
147
- "types": "./dist/environment-checks.d.ts",
148
- "default": "./dist/environment-checks.mjs"
149
- }
28
+ "./load-env": {
29
+ "require": "./dist/load-env.cjs",
30
+ "import": "./dist/load-env.mjs"
150
31
  },
151
- "./ci-checks": {
152
- "import": {
153
- "types": "./dist/ci-checks.d.ts",
154
- "default": "./dist/ci-checks.mjs"
155
- },
156
- "require": {
157
- "types": "./dist/ci-checks.d.ts",
158
- "default": "./dist/ci-checks.cjs"
159
- },
160
- "default": {
161
- "types": "./dist/ci-checks.d.ts",
162
- "default": "./dist/ci-checks.mjs"
163
- }
32
+ "./providers": {
33
+ "require": "./dist/providers.cjs",
34
+ "import": "./dist/providers.mjs"
164
35
  },
165
- ".": {
166
- "import": { "types": "./dist/index.d.ts", "default": "./dist/index.mjs" },
167
- "require": {
168
- "types": "./dist/index.d.ts",
169
- "default": "./dist/index.cjs"
170
- },
171
- "default": { "types": "./dist/index.d.ts", "default": "./dist/index.mjs" }
36
+ "./runtime-checks": {
37
+ "require": "./dist/runtime-checks.cjs",
38
+ "import": "./dist/runtime-checks.mjs"
172
39
  },
173
- "./package.json": "./package.json"
40
+ "./types": { "require": "./dist/types.cjs", "import": "./dist/types.mjs" },
41
+ "./*": "./*"
174
42
  },
175
- "main": "./dist/index.cjs",
176
- "module": "./dist/index.mjs",
177
- "types": "./dist/index.d.ts",
178
- "gitHead": "eb28313b3230b7ea654c87586ca07773e2e57f52"
43
+ "types": "./dist/index.d.cts",
44
+ "dependencies": {
45
+ "@dotenvx/dotenvx": "1.35.0",
46
+ "@stryke/convert": "^0.6.21",
47
+ "@stryke/fs": "^0.33.17",
48
+ "@stryke/path": "^0.22.8",
49
+ "@stryke/string-format": "^0.12.21",
50
+ "defu": "^6.1.4"
51
+ },
52
+ "devDependencies": { "@types/node": "^24.10.1", "tsdown": "^0.17.1" },
53
+ "publishConfig": { "access": "public" },
54
+ "gitHead": "e9fb3e13aebac54518fd668cecdd3dd89540d34e"
179
55
  }
@@ -1,60 +0,0 @@
1
- /**
2
- * Options for the `getEnvPaths` function.
3
- */
4
- export interface GetEnvPathsOptions {
5
- /**
6
- * The name of the organization
7
- *
8
- * @defaultValue "storm-software"
9
- */
10
- orgId?: string;
11
- /**
12
- * The name of the specific application to use as a nested folder inside the organization's folder
13
- *
14
- * For example: `~/ ... /storm-software/Log/<appId>`
15
- */
16
- appId?: string;
17
- /**
18
- * The name of the specific application to use as a nested folder inside the organization's folder
19
- *
20
- * When a value is provided, it will use `~/ ... /storm-software/Log/<appId>/<nestedDir>`
21
- *
22
- * @remarks
23
- * If no child is provided, it will use `~/ ... /storm-software/Log/<appId>`
24
- */
25
- nestedDir?: string;
26
- /**
27
- * The suffix to append to the project name.
28
- *
29
- * @remarks
30
- * If `suffix` is `true`, the project name will be suffixed with `"nodejs"`.
31
- *
32
- * @defaultValue false
33
- */
34
- suffix?: string | boolean | null;
35
- /**
36
- * The root directory of the workspace that is used for determining the `cache` and `tmp` paths if they were not already set by other means.
37
- */
38
- workspaceRoot?: string;
39
- }
40
- export interface EnvPaths {
41
- data: string;
42
- config: string;
43
- cache: string;
44
- log: string;
45
- temp: string;
46
- }
47
- /**
48
- * Get paths for storing things like data, config, logs, and cache in the current runtime environment.
49
- *
50
- * @remarks
51
- * On macOS, directories are generally created in `~/Library/Application Support/<name>`.
52
- * On Windows, directories are generally created in `%AppData%/<name>`.
53
- * On Linux, directories are generally created in `~/.config/<name>` - this is determined via the [XDG Base Directory spec](https://specifications.freedesktop.org/basedir-spec/latest/).
54
- *
55
- * If the `STORM_DATA_DIR`, `STORM_CONFIG_DIR`, `STORM_CACHE_DIR`, `STORM_LOG_DIR`, or `STORM_TEMP_DIR` environment variables are set, they will be used instead of the default paths.
56
- *
57
- * @param options - Parameters used to determine the specific paths for the current project/runtime environment
58
- * @returns An object containing the various paths for the runtime environment
59
- */
60
- export declare function getEnvPaths(options?: GetEnvPathsOptions): EnvPaths;
package/dist/index.d.ts DELETED
@@ -1,15 +0,0 @@
1
- /**
2
- * The env library used by Storm Software for building NodeJS applications.
3
- *
4
- * @remarks
5
- * A package containing utility functions to handle environment specific processes
6
- *
7
- * @packageDocumentation
8
- */
9
- export * from "./ci-checks";
10
- export * from "./environment-checks";
11
- export * from "./get-env-paths";
12
- export * from "./load-env";
13
- export * from "./providers";
14
- export * from "./runtime-checks";
15
- export * from "./types";
@@ -1,9 +0,0 @@
1
- export type ProviderName = "" | "appveyor" | "aws_amplify" | "azure_pipelines" | "azure_static" | "appcircle" | "bamboo" | "bitbucket" | "bitrise" | "buddy" | "buildkite" | "circle" | "cirrus" | "cloudflare_pages" | "codebuild" | "codefresh" | "drone" | "drone" | "dsari" | "github_actions" | "gitlab" | "gocd" | "layerci" | "hudson" | "jenkins" | "magnum" | "netlify" | "nevercode" | "render" | "sail" | "semaphore" | "screwdriver" | "shippable" | "solano" | "strider" | "teamcity" | "travis" | "vercel" | "appcenter" | "codesandbox" | "stackblitz" | "stormkit" | "cleavr" | "zeabur" | "codesphere" | "railway" | "deno-deploy" | "firebase_app_hosting";
2
- export interface ProviderInfo {
3
- name: ProviderName;
4
- ci?: boolean;
5
- [meta: string]: any;
6
- }
7
- /** Current provider info */
8
- export declare const providerInfo: ProviderInfo;
9
- export declare const provider: ProviderName;
@@ -1,47 +0,0 @@
1
- export type RuntimeName = "workerd" | "deno" | "netlify" | "node" | "bun" | "edge-light" | "fastly" | "";
2
- export interface RuntimeInfo {
3
- name: RuntimeName;
4
- }
5
- /**
6
- * Indicates if running in Node.js or a Node.js compatible runtime.
7
- *
8
- * **Note:** When running code in Bun and Deno with Node.js compatibility mode, `isNode` flag will be also `true`, indicating running in a Node.js compatible runtime.
9
- *
10
- * Use `runtime === "node"` if you need strict check for Node.js runtime.
11
- */
12
- export declare const isNode: boolean;
13
- /**
14
- * Indicates if running in Bun runtime.
15
- */
16
- export declare const isBun: boolean;
17
- /**
18
- * Indicates if running in Deno runtime.
19
- */
20
- export declare const isDeno: boolean;
21
- /**
22
- * Indicates if running in Fastly runtime.
23
- */
24
- export declare const isFastly: boolean;
25
- /**
26
- * Indicates if running in Netlify runtime.
27
- */
28
- export declare const isNetlify: boolean;
29
- /**
30
- *
31
- * Indicates if running in EdgeLight (Vercel Edge) runtime.
32
- */
33
- export declare const isEdgeLight: boolean;
34
- /**
35
- * Indicates if running in Cloudflare Workers runtime.
36
- */
37
- export declare const isWorkerd: boolean;
38
- /**
39
- * Indicates if the code is running on the server-side
40
- */
41
- export declare const isRuntimeServer: boolean;
42
- /**
43
- * Indicates if the code is running in the browser (and not on the server).
44
- */
45
- export declare const isRuntimeClient: boolean;
46
- export declare const runtimeInfo: RuntimeInfo | undefined;
47
- export declare const runtime: RuntimeName;
package/dist/types.d.ts DELETED
@@ -1,4 +0,0 @@
1
- export declare const ENV_PREFIXES: string[];
2
- export interface DotenvParseOutput {
3
- [name: string]: string | undefined;
4
- }