@storm-software/config 1.39.0 → 1.40.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.
Files changed (8) hide show
  1. package/CHANGELOG.md +37 -24
  2. package/README.md +1 -1
  3. package/package.json +1 -1
  4. package/src/constants.d.ts +3 -0
  5. package/src/define-config.d.ts +174 -0
  6. package/src/index.d.ts +12 -0
  7. package/src/schema.d.ts +1915 -0
  8. package/src/types.d.ts +23 -0
package/CHANGELOG.md CHANGED
@@ -1,83 +1,96 @@
1
- ## 1.39.0 (2024-08-04)
1
+ ## 1.40.0 (2024-08-29)
2
2
 
3
3
 
4
4
  ### Features
5
5
 
6
- - **config:** Added the `docs` and `licensing` options to the Storm configuration ([c867efe1](https://github.com/storm-software/storm-ops/commit/c867efe1))
6
+ - **workspace-tools:** Added base entry to package ([b0d3b788](https://github.com/storm-software/storm-ops/commit/b0d3b788))
7
+
8
+ ## 1.39.0 (2024-08-04)
9
+
10
+ ### Features
7
11
 
8
- - **config:** Updated default `brand` color and added proper URLs to file banners ([008e6ef4](https://github.com/storm-software/storm-ops/commit/008e6ef4))
12
+ - **config:** Added the `docs` and `licensing` options to the Storm
13
+ configuration
14
+ ([c867efe1](https://github.com/storm-software/storm-ops/commit/c867efe1))
9
15
 
16
+ - **config:** Updated default `brand` color and added proper URLs to file
17
+ banners
18
+ ([008e6ef4](https://github.com/storm-software/storm-ops/commit/008e6ef4))
10
19
 
11
20
  ### Bug Fixes
12
21
 
13
- - **build-tools:** Resolve issues with logic in `outExtension` utility function ([8cdc691b](https://github.com/storm-software/storm-ops/commit/8cdc691b))
22
+ - **build-tools:** Resolve issues with logic in `outExtension` utility function
23
+ ([8cdc691b](https://github.com/storm-software/storm-ops/commit/8cdc691b))
14
24
 
15
25
  ## 1.38.0 (2024-08-03)
16
26
 
17
-
18
27
  ### Features
19
28
 
20
- - **build-tools:** Add back experimental DTS option to TSUP ([4fe9652b](https://github.com/storm-software/storm-ops/commit/4fe9652b))
29
+ - **build-tools:** Add back experimental DTS option to TSUP
30
+ ([4fe9652b](https://github.com/storm-software/storm-ops/commit/4fe9652b))
21
31
 
22
32
  ## 1.37.0 (2024-08-03)
23
33
 
24
-
25
34
  ### Features
26
35
 
27
- - **build-tools:** Add tsup build's rollup helpers ([27ecd4e6](https://github.com/storm-software/storm-ops/commit/27ecd4e6))
36
+ - **build-tools:** Add tsup build's rollup helpers
37
+ ([27ecd4e6](https://github.com/storm-software/storm-ops/commit/27ecd4e6))
28
38
 
29
39
  ## 1.36.0 (2024-08-02)
30
40
 
31
-
32
41
  ### Features
33
42
 
34
- - **build-tools:** Added back the export statements to unbuild configuration ([5fb63682](https://github.com/storm-software/storm-ops/commit/5fb63682))
43
+ - **build-tools:** Added back the export statements to unbuild configuration
44
+ ([5fb63682](https://github.com/storm-software/storm-ops/commit/5fb63682))
35
45
 
36
46
  ## 1.35.0 (2024-08-02)
37
47
 
38
-
39
48
  ### Features
40
49
 
41
- - **config:** Removed the `ci` option from config and enabled better caching ([2456c216](https://github.com/storm-software/storm-ops/commit/2456c216))
50
+ - **config:** Removed the `ci` option from config and enabled better caching
51
+ ([2456c216](https://github.com/storm-software/storm-ops/commit/2456c216))
42
52
 
43
- - **build-tools:** Populate the distribution's package.json with `exports` based on project structure ([cf0eed52](https://github.com/storm-software/storm-ops/commit/cf0eed52))
53
+ - **build-tools:** Populate the distribution's package.json with `exports` based
54
+ on project structure
55
+ ([cf0eed52](https://github.com/storm-software/storm-ops/commit/cf0eed52))
44
56
 
45
57
  ## 1.34.1 (2024-07-31)
46
58
 
47
-
48
59
  ### Bug Fixes
49
60
 
50
- - **build-tools:** Remove unused plugin from unbuild ([ad8a5991](https://github.com/storm-software/storm-ops/commit/ad8a5991))
61
+ - **build-tools:** Remove unused plugin from unbuild
62
+ ([ad8a5991](https://github.com/storm-software/storm-ops/commit/ad8a5991))
51
63
 
52
64
  ## 1.34.0 (2024-07-31)
53
65
 
54
-
55
66
  ### Features
56
67
 
57
- - **create-storm-workspace:** Configure workspace to include GitHub ([eea71de7](https://github.com/storm-software/storm-ops/commit/eea71de7))
68
+ - **create-storm-workspace:** Configure workspace to include GitHub
69
+ ([eea71de7](https://github.com/storm-software/storm-ops/commit/eea71de7))
58
70
 
59
71
  ## 1.33.0 (2024-07-30)
60
72
 
61
-
62
73
  ### Features
63
74
 
64
- - **eslint:** Added the header plugin ([cc0cbbea](https://github.com/storm-software/storm-ops/commit/cc0cbbea))
75
+ - **eslint:** Added the header plugin
76
+ ([cc0cbbea](https://github.com/storm-software/storm-ops/commit/cc0cbbea))
65
77
 
66
- - **eslint:** Removed invalid JSON configuration from package ([2622ee7e](https://github.com/storm-software/storm-ops/commit/2622ee7e))
78
+ - **eslint:** Removed invalid JSON configuration from package
79
+ ([2622ee7e](https://github.com/storm-software/storm-ops/commit/2622ee7e))
67
80
 
68
81
  ## 1.32.0 (2024-07-29)
69
82
 
70
-
71
83
  ### Features
72
84
 
73
- - **build-tools:** Update unbuild process to use the `tsconfck` package ([d0e4dbf6](https://github.com/storm-software/storm-ops/commit/d0e4dbf6))
85
+ - **build-tools:** Update unbuild process to use the `tsconfck` package
86
+ ([d0e4dbf6](https://github.com/storm-software/storm-ops/commit/d0e4dbf6))
74
87
 
75
88
  ## 1.31.0 (2024-07-29)
76
89
 
77
-
78
90
  ### Features
79
91
 
80
- - **config:** Added the `brand2` and `brand3` color tokens ([58705631](https://github.com/storm-software/storm-ops/commit/58705631))
92
+ - **config:** Added the `brand2` and `brand3` color tokens
93
+ ([58705631](https://github.com/storm-software/storm-ops/commit/58705631))
81
94
 
82
95
  ## 1.30.0 (2024-07-19)
83
96
 
package/README.md CHANGED
@@ -21,7 +21,7 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages
21
21
 
22
22
  <h3 align="center">💻 Visit <a href="https://stormsoftware.com" target="_blank">stormsoftware.com</a> to stay up to date with this developer</h3><br />
23
23
 
24
- [![Version](https://img.shields.io/badge/version-1.38.0-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
24
+ [![Version](https://img.shields.io/badge/version-1.39.0-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
25
25
 
26
26
  <!-- prettier-ignore-start -->
27
27
  <!-- markdownlint-disable -->
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@storm-software/config",
3
- "version": "1.39.0",
3
+ "version": "1.40.0",
4
4
  "description": "⚡The Storm-Ops monorepo contains utility applications, tools, and various libraries to create modern and scalable web applications.",
5
5
  "repository": {
6
6
  "type": "github",
package/src/constants.d.ts ADDED
@@ -0,0 +1,3 @@
1
+ export declare const STORM_DEFAULT_DOCS = "https://docs.stormsoftware.com";
2
+ export declare const STORM_DEFAULT_HOMEPAGE = "https://stormsoftware.com";
3
+ export declare const STORM_DEFAULT_LICENSING = "https://license.stormsoftware.com";
package/src/define-config.d.ts ADDED
@@ -0,0 +1,174 @@
1
+ import type { StormConfigInput } from "./types";
2
+ /**
3
+ * Type the config values for the current Storm workspace
4
+ *
5
+ * @param input - The config values for the current Storm workspace
6
+ * @returns The config values for the current Storm workspace
7
+ */
8
+ export declare const defineConfig: (input: StormConfigInput) => {
9
+ colors: {
10
+ dark: {
11
+ foreground?: string | undefined;
12
+ background?: string | undefined;
13
+ brand?: string | undefined;
14
+ brand2?: string | undefined;
15
+ brand3?: string | undefined;
16
+ accent?: string | undefined;
17
+ help?: string | undefined;
18
+ success?: string | undefined;
19
+ info?: string | undefined;
20
+ warning?: string | undefined;
21
+ error?: string | undefined;
22
+ fatal?: string | undefined;
23
+ };
24
+ light: {
25
+ foreground?: string | undefined;
26
+ background?: string | undefined;
27
+ brand?: string | undefined;
28
+ brand2?: string | undefined;
29
+ brand3?: string | undefined;
30
+ accent?: string | undefined;
31
+ help?: string | undefined;
32
+ success?: string | undefined;
33
+ info?: string | undefined;
34
+ warning?: string | undefined;
35
+ error?: string | undefined;
36
+ fatal?: string | undefined;
37
+ };
38
+ } | {
39
+ brand?: string | undefined;
40
+ brand2?: string | undefined;
41
+ brand3?: string | undefined;
42
+ accent?: string | undefined;
43
+ help?: string | undefined;
44
+ success?: string | undefined;
45
+ info?: string | undefined;
46
+ warning?: string | undefined;
47
+ error?: string | undefined;
48
+ fatal?: string | undefined;
49
+ dark?: string | undefined;
50
+ light?: string | undefined;
51
+ } | {
52
+ base: {
53
+ dark: {
54
+ foreground?: string | undefined;
55
+ background?: string | undefined;
56
+ brand?: string | undefined;
57
+ brand2?: string | undefined;
58
+ brand3?: string | undefined;
59
+ accent?: string | undefined;
60
+ help?: string | undefined;
61
+ success?: string | undefined;
62
+ info?: string | undefined;
63
+ warning?: string | undefined;
64
+ error?: string | undefined;
65
+ fatal?: string | undefined;
66
+ };
67
+ light: {
68
+ foreground?: string | undefined;
69
+ background?: string | undefined;
70
+ brand?: string | undefined;
71
+ brand2?: string | undefined;
72
+ brand3?: string | undefined;
73
+ accent?: string | undefined;
74
+ help?: string | undefined;
75
+ success?: string | undefined;
76
+ info?: string | undefined;
77
+ warning?: string | undefined;
78
+ error?: string | undefined;
79
+ fatal?: string | undefined;
80
+ };
81
+ } | {
82
+ brand?: string | undefined;
83
+ brand2?: string | undefined;
84
+ brand3?: string | undefined;
85
+ accent?: string | undefined;
86
+ help?: string | undefined;
87
+ success?: string | undefined;
88
+ info?: string | undefined;
89
+ warning?: string | undefined;
90
+ error?: string | undefined;
91
+ fatal?: string | undefined;
92
+ dark?: string | undefined;
93
+ light?: string | undefined;
94
+ };
95
+ } | Record<string, {
96
+ dark: {
97
+ foreground?: string | undefined;
98
+ background?: string | undefined;
99
+ brand?: string | undefined;
100
+ brand2?: string | undefined;
101
+ brand3?: string | undefined;
102
+ accent?: string | undefined;
103
+ help?: string | undefined;
104
+ success?: string | undefined;
105
+ info?: string | undefined;
106
+ warning?: string | undefined;
107
+ error?: string | undefined;
108
+ fatal?: string | undefined;
109
+ };
110
+ light: {
111
+ foreground?: string | undefined;
112
+ background?: string | undefined;
113
+ brand?: string | undefined;
114
+ brand2?: string | undefined;
115
+ brand3?: string | undefined;
116
+ accent?: string | undefined;
117
+ help?: string | undefined;
118
+ success?: string | undefined;
119
+ info?: string | undefined;
120
+ warning?: string | undefined;
121
+ error?: string | undefined;
122
+ fatal?: string | undefined;
123
+ };
124
+ } | {
125
+ brand?: string | undefined;
126
+ brand2?: string | undefined;
127
+ brand3?: string | undefined;
128
+ accent?: string | undefined;
129
+ help?: string | undefined;
130
+ success?: string | undefined;
131
+ info?: string | undefined;
132
+ warning?: string | undefined;
133
+ error?: string | undefined;
134
+ fatal?: string | undefined;
135
+ dark?: string | undefined;
136
+ light?: string | undefined;
137
+ }>;
138
+ $schema?: string | undefined;
139
+ extends?: string | undefined;
140
+ name?: string | undefined;
141
+ namespace?: string | undefined;
142
+ organization?: string | undefined;
143
+ repository?: string | undefined;
144
+ license?: string | undefined;
145
+ homepage?: string | undefined;
146
+ docs?: string | undefined;
147
+ licensing?: string | undefined;
148
+ branch?: string | undefined;
149
+ preid?: string | undefined;
150
+ owner?: string | undefined;
151
+ worker?: string | undefined;
152
+ env?: "development" | "staging" | "production" | undefined;
153
+ workspaceRoot?: string | undefined;
154
+ packageDirectory?: string | undefined;
155
+ externalPackagePatterns?: string[] | undefined;
156
+ skipCache?: boolean | undefined;
157
+ cacheDirectory?: string | undefined;
158
+ buildDirectory?: string | undefined;
159
+ outputDirectory?: string | undefined;
160
+ runtimeVersion?: string | undefined;
161
+ packageManager?: "npm" | "yarn" | "pnpm" | "bun" | undefined;
162
+ timezone?: string | undefined;
163
+ locale?: string | undefined;
164
+ logLevel?: "info" | "error" | "fatal" | "silent" | "warn" | "debug" | "trace" | "all" | undefined;
165
+ cloudflareAccountId?: string | null | undefined;
166
+ registry?: {
167
+ github?: string | undefined;
168
+ npm?: string | undefined;
169
+ cargo?: string | undefined;
170
+ cyclone?: string | undefined;
171
+ } | undefined;
172
+ configFile?: string | null | undefined;
173
+ extensions?: Record<string, any> | undefined;
174
+ };
package/src/index.d.ts ADDED
@@ -0,0 +1,12 @@
1
+ /**
2
+ * The config-schema library used by Storm Software for building TypeScript applications.
3
+ *
4
+ * @remarks
5
+ * A package containing various utilities to support custom workspace configurations
6
+ *
7
+ * @packageDocumentation
8
+ */
9
+ export * from "./constants";
10
+ export * from "./define-config";
11
+ export * from "./schema";
12
+ export * from "./types";