@storm-software/config 1.73.0 → 1.74.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/CHANGELOG.md CHANGED
@@ -1,8 +1,15 @@
1
+ ## 1.74.0 (2024-12-18)
2
+
3
+ ### Features
4
+
5
+ - **storm-ops:** Improved descriptions and markdown across monorepo ([aec89c79](https://github.com/storm-software/storm-ops/commit/aec89c79))
6
+
1
7
  ## 1.73.0 (2024-12-01)
2
8
 
3
9
  ### Features
4
10
 
5
- - **storm-ops:** Added `lint-sherif` script to the CI workflow ([906e0c2b](https://github.com/storm-software/storm-ops/commit/906e0c2b))
11
+ - **storm-ops:** Added `lint-sherif` script to the CI workflow
12
+ ([906e0c2b](https://github.com/storm-software/storm-ops/commit/906e0c2b))
6
13
 
7
14
  ## 1.72.0 (2024-11-30)
8
15
 
package/README.md CHANGED
@@ -40,6 +40,7 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages
40
40
 
41
41
  <!-- START doctoc -->
42
42
  <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
43
+
43
44
  ## Table of Contents
44
45
 
45
46
  - [Storm Configuration Package](#storm-configuration-package)
@@ -74,29 +75,49 @@ workspace configuration used by the Storm Software organization.
74
75
  Below is a list of the available configuration values that can be set through
75
76
  environment variables:
76
77
 
77
- | Name | Description | Default |
78
- | ----------------------- | -------------------------------------------------------------------------------------- | --------------------------- |
79
- | STORM_COLOR_BACKGROUND | The workspace's background theme color | `#1d232a` |
80
- | STORM_COLOR_DANGER | The workspace's danger theme color | `#990000` |
81
- | STORM_COLOR_FATAL | The workspace's fatal theme color | `#7d1a1a` |
82
- | STORM_COLOR_INFO | The workspace's info theme color | `#0ea5e9` |
83
- | STORM_COLOR_BRAND | The workspace's primary theme color | `#1fb2a6` |
84
- | STORM_COLOR_SUCCESS | The workspace's success theme color | `#087f5b` |
85
- | STORM_COLOR_WARNING | The workspace's warning theme color | `#fcc419` |
86
- | STORM_COLOR_HELP | The workspace's help theme color | `#818cf8` |
87
- | STORM_COLOR_POSITIVE | The workspace's positive theme color | `#22c55e` |
88
- | STORM_COLOR_NEGATIVE | The workspace's negative theme color | `#dc2626` |
89
- | STORM_ENV | The current runtime environment of the package | "production" |
90
- | STORM_HOMEPAGE | The homepage URL for the workspace | <https://stormsoftware.com> |
91
- | STORM_LICENSE | The license used by the workspace | "Apache License 2.0" |
92
- | STORM_LOCALE | The default locale of the workspace | "en-US" |
93
- | STORM_LOG_LEVEL | The current maximum level of messages to write to the logs | "info" |
94
- | STORM_ORGANIZATION | The organization of the workspace | "storm-software" |
95
- | STORM_REPOSITORY | The repo URL of the workspace (i.e. GitHub URL) |
96
- | STORM_RUNTIME_DIRECTORY | The default directory of the storm runtime for storage/generation | "node_modules/.storm" |
97
- | STORM_RUNTIME_VERSION | The global version of the Storm runtime | "1.0.0" |
98
- | STORM_TIMEZONE | The default timezone of the workspace | "America/New_York" |
99
- | STORM_BOT | The worker of the package (this is the bot that will be used to perform various tasks) | "stormie-bot" |
78
+ | Name | Description | Default |
79
+ | ------------------------------- | ---------------------------------------------- | --------------------------- |
80
+ | STORM_COLOR_BACKGROUND | The workspace's background theme color | `#1d1e22` |
81
+ | STORM_COLOR_FOREGROUND | The workspace's foreground theme color | `#f4f4f5` |
82
+ | STORM_COLOR_BRAND | The workspace's primary brand specific color | `#1fb2a6` |
83
+ | STORM_COLOR_ALTERNATE | The workspace's alternate brand specific color | `null` |
84
+ | STORM_COLOR_ACCENT | The workspace's secondary brand specific color | `null` |
85
+ | STORM_COLOR_LINK | The color used to display hyperlink text | `null` |
86
+ | STORM_COLOR_HELP | The workspace's help theme color | `#8256D0` |
87
+ | STORM_COLOR_SUCCESS | The workspace's success theme color | `#12B66A` |
88
+ | STORM_COLOR_INFO | The workspace's informational theme color | `#0070E0` |
89
+ | STORM_COLOR_WARNING | The workspace's warning theme color | `#fcc419` |
90
+ | STORM_COLOR_DANGER | The workspace's danger theme color | `#D8314A` |
91
+ | STORM_COLOR_FATAL | The workspace's fatal theme color | `null` |
92
+ | STORM_COLOR_POSITIVE | The workspace's positive number color | `#4ade80` |
93
+ | STORM_COLOR_NEGATIVE | The workspace's negative number color | `#ef4444` |
94
+ | STORM_LOG_LEVEL | The logging level for the workspace | "info" |
95
+ | STORM_NAME | The name of the package | `null` |
96
+ | STORM_NAMESPACE | The namespace of the package | `null` |
97
+ | STORM_OWNER | The owner of the workspace | `null` |
98
+ | STORM_WORKER | The worker of the workspace | "stormie-bot" |
99
+ | STORM_ORGANIZATION | The organization of the workspace | "storm-software" |
100
+ | STORM_PACKAGE_MANAGER | The package manager used in the workspace | "pnpm" |
101
+ | STORM_LICENSE | The license of the workspace | "Apache-2.0" |
102
+ | STORM_HOMEPAGE | The homepage of the workspace | <https://stormsoftware.com> |
103
+ | STORM_DOCS | The documentation URL of the workspace | `null` |
104
+ | STORM_LICENSING | The licensing information of the workspace | `null` |
105
+ | STORM_TIMEZONE | The timezone of the workspace | "America/New_York" |
106
+ | STORM_LOCALE | The locale of the workspace | "en-US" |
107
+ | STORM_CONFIG_FILE | The path to the configuration file | `null` |
108
+ | STORM_WORKSPACE_ROOT | The root directory of the workspace | `null` |
109
+ | STORM_PACKAGE_DIRECTORY | The directory where packages are stored | `null` |
110
+ | STORM_BUILD_DIRECTORY | The directory where build artifacts are stored | "dist" |
111
+ | STORM_SKIP_CACHE | Whether to skip caching | `false` |
112
+ | STORM_CACHE_DIRECTORY | The directory where cache is stored | "node_modules/.cache/storm" |
113
+ | STORM_RUNTIME_VERSION | The runtime version used in the workspace | `null` |
114
+ | STORM_OUTPUT_DIRECTORY | The directory where output files are stored | `null` |
115
+ | STORM_ENV | The environment of the workspace | "production" |
116
+ | STORM_REPOSITORY | The repository URL of the workspace | `null` |
117
+ | STORM_BRANCH | The branch of the repository | "main" |
118
+ | STORM_PRE_ID | The pre-release identifier | `null` |
119
+ | STORM_EXTERNAL_PACKAGE_PATTERNS | The patterns for external packages | `[]` |
120
+ | STORM_CLOUDFLARE_ACCOUNT_ID | The Cloudflare account ID | `null` |
100
121
 
101
122
  ## Installing
102
123
 
package/index.cjs CHANGED
@@ -4049,7 +4049,12 @@ var StormConfigSchema = z.object({
4049
4049
  extends: z.string().trim().optional().describe(
4050
4050
  "The path to a base JSON file to use as a configuration preset file"
4051
4051
  ),
4052
- name: z.string().trim().toLowerCase().optional().describe("The name of the package"),
4052
+ isRoot: z.boolean().optional().describe(
4053
+ "A flag indicating if the current configuration is the set in the root of the workspace"
4054
+ ),
4055
+ name: z.string().trim().toLowerCase().optional().describe(
4056
+ "The name of the service/package/scope using this configuration"
4057
+ ),
4053
4058
  namespace: z.string().trim().toLowerCase().optional().describe("The namespace of the package"),
4054
4059
  organization: z.string().trim().default("storm-software").describe("The organization of the workspace"),
4055
4060
  repository: z.string().trim().url().optional().describe("The repo URL of the workspace (i.e. GitHub)"),
@@ -4059,7 +4064,7 @@ var StormConfigSchema = z.object({
4059
4064
  licensing: z.string().trim().url().default(STORM_DEFAULT_LICENSING).describe("The base licensing site for the workspace"),
4060
4065
  branch: z.string().trim().default("main").describe("The branch of the workspace"),
4061
4066
  preid: z.string().optional().describe("A tag specifying the version pre-release identifier"),
4062
- owner: z.string().trim().default("@storm-software/development").describe("The owner of the package"),
4067
+ owner: z.string().trim().default("@storm-software/admin").describe("The owner of the package"),
4063
4068
  worker: z.string().trim().default("Stormie-Bot").describe(
4064
4069
  "The worker of the package (this is the bot that will be used to perform various tasks)"
4065
4070
  ),
@@ -4070,7 +4075,15 @@ var StormConfigSchema = z.object({
4070
4075
  "The build will use these package patterns to determine if they should be external to the bundle"
4071
4076
  ),
4072
4077
  skipCache: z.boolean().default(false).describe("Should all known types of workspace caching be skipped?"),
4073
- cacheDirectory: z.string().trim().default("node_modules/.cache/storm").describe("The directory used to store the workspace's cached file data"),
4078
+ cacheDirectory: z.string().trim().optional().describe(
4079
+ "The directory used to store the environment's cached file data"
4080
+ ),
4081
+ dataDirectory: z.string().trim().optional().describe("The directory used to store the environment's data files"),
4082
+ configDirectory: z.string().trim().optional().describe(
4083
+ "The directory used to store the environment's configuration files"
4084
+ ),
4085
+ tempDirectory: z.string().trim().optional().describe("The directory used to store the environment's temp files"),
4086
+ logDirectory: z.string().trim().optional().describe("The directory used to store the environment's temp files"),
4074
4087
  buildDirectory: z.string().trim().default("dist").describe("The build directory for the workspace"),
4075
4088
  outputDirectory: z.string().trim().default("node_modules/.storm").describe("The runtime directory of Storm"),
4076
4089
  runtimeVersion: z.string().trim().regex(
@@ -4088,7 +4101,7 @@ var StormConfigSchema = z.object({
4088
4101
  "debug",
4089
4102
  "trace",
4090
4103
  "all"
4091
- ]).default("debug").describe(
4104
+ ]).default("info").describe(
4092
4105
  "The log level used to filter out lower priority log messages. If not provided, this is defaulted using the `environment` config value (if `environment` is set to `production` then `level` is `error`, else `level` is `debug`)."
4093
4106
  ),
4094
4107
  cloudflareAccountId: z.string().trim().toLowerCase().length(32).regex(/^([0-9a-fA-F]{32})$/i).nullable().default(null).describe("The default Cloudflare account ID of the workspace"),
package/index.js CHANGED
@@ -4011,7 +4011,12 @@ var StormConfigSchema = z.object({
4011
4011
  extends: z.string().trim().optional().describe(
4012
4012
  "The path to a base JSON file to use as a configuration preset file"
4013
4013
  ),
4014
- name: z.string().trim().toLowerCase().optional().describe("The name of the package"),
4014
+ isRoot: z.boolean().optional().describe(
4015
+ "A flag indicating if the current configuration is the set in the root of the workspace"
4016
+ ),
4017
+ name: z.string().trim().toLowerCase().optional().describe(
4018
+ "The name of the service/package/scope using this configuration"
4019
+ ),
4015
4020
  namespace: z.string().trim().toLowerCase().optional().describe("The namespace of the package"),
4016
4021
  organization: z.string().trim().default("storm-software").describe("The organization of the workspace"),
4017
4022
  repository: z.string().trim().url().optional().describe("The repo URL of the workspace (i.e. GitHub)"),
@@ -4021,7 +4026,7 @@ var StormConfigSchema = z.object({
4021
4026
  licensing: z.string().trim().url().default(STORM_DEFAULT_LICENSING).describe("The base licensing site for the workspace"),
4022
4027
  branch: z.string().trim().default("main").describe("The branch of the workspace"),
4023
4028
  preid: z.string().optional().describe("A tag specifying the version pre-release identifier"),
4024
- owner: z.string().trim().default("@storm-software/development").describe("The owner of the package"),
4029
+ owner: z.string().trim().default("@storm-software/admin").describe("The owner of the package"),
4025
4030
  worker: z.string().trim().default("Stormie-Bot").describe(
4026
4031
  "The worker of the package (this is the bot that will be used to perform various tasks)"
4027
4032
  ),
@@ -4032,7 +4037,15 @@ var StormConfigSchema = z.object({
4032
4037
  "The build will use these package patterns to determine if they should be external to the bundle"
4033
4038
  ),
4034
4039
  skipCache: z.boolean().default(false).describe("Should all known types of workspace caching be skipped?"),
4035
- cacheDirectory: z.string().trim().default("node_modules/.cache/storm").describe("The directory used to store the workspace's cached file data"),
4040
+ cacheDirectory: z.string().trim().optional().describe(
4041
+ "The directory used to store the environment's cached file data"
4042
+ ),
4043
+ dataDirectory: z.string().trim().optional().describe("The directory used to store the environment's data files"),
4044
+ configDirectory: z.string().trim().optional().describe(
4045
+ "The directory used to store the environment's configuration files"
4046
+ ),
4047
+ tempDirectory: z.string().trim().optional().describe("The directory used to store the environment's temp files"),
4048
+ logDirectory: z.string().trim().optional().describe("The directory used to store the environment's temp files"),
4036
4049
  buildDirectory: z.string().trim().default("dist").describe("The build directory for the workspace"),
4037
4050
  outputDirectory: z.string().trim().default("node_modules/.storm").describe("The runtime directory of Storm"),
4038
4051
  runtimeVersion: z.string().trim().regex(
@@ -4050,7 +4063,7 @@ var StormConfigSchema = z.object({
4050
4063
  "debug",
4051
4064
  "trace",
4052
4065
  "all"
4053
- ]).default("debug").describe(
4066
+ ]).default("info").describe(
4054
4067
  "The log level used to filter out lower priority log messages. If not provided, this is defaulted using the `environment` config value (if `environment` is set to `production` then `level` is `error`, else `level` is `debug`)."
4055
4068
  ),
4056
4069
  cloudflareAccountId: z.string().trim().toLowerCase().length(32).regex(/^([0-9a-fA-F]{32})$/i).nullable().default(null).describe("The default Cloudflare account ID of the workspace"),
package/meta.cjs.json CHANGED
@@ -16,7 +16,7 @@
16
16
  "format": "esm"
17
17
  },
18
18
  "packages/config/src/schema.ts": {
19
- "bytes": 10999,
19
+ "bytes": 11821,
20
20
  "imports": [
21
21
  {
22
22
  "path": "node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/index.mjs",
@@ -82,13 +82,13 @@
82
82
  "bytesInOutput": 116969
83
83
  },
84
84
  "packages/config/src/schema.ts": {
85
- "bytesInOutput": 9143
85
+ "bytesInOutput": 9790
86
86
  },
87
87
  "packages/config/src/types.ts": {
88
88
  "bytesInOutput": 197
89
89
  }
90
90
  },
91
- "bytes": 128399
91
+ "bytes": 129046
92
92
  }
93
93
  }
94
94
  }
package/meta.esm.json CHANGED
@@ -16,7 +16,7 @@
16
16
  "format": "esm"
17
17
  },
18
18
  "packages/config/src/schema.ts": {
19
- "bytes": 10999,
19
+ "bytes": 11821,
20
20
  "imports": [
21
21
  {
22
22
  "path": "node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/index.mjs",
@@ -97,13 +97,13 @@
97
97
  "bytesInOutput": 116969
98
98
  },
99
99
  "packages/config/src/schema.ts": {
100
- "bytesInOutput": 9143
100
+ "bytesInOutput": 9790
101
101
  },
102
102
  "packages/config/src/types.ts": {
103
103
  "bytesInOutput": 197
104
104
  }
105
105
  },
106
- "bytes": 127096
106
+ "bytes": 127743
107
107
  }
108
108
  }
109
109
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@storm-software/config",
3
- "version": "1.73.0",
4
- "description": "⚡The Storm-Ops monorepo contains utility applications, tools, and various libraries to create modern and scalable web applications.",
3
+ "version": "1.74.0",
4
+ "description": "Configuration management tools and schemas for Storm Software projects, providing a standardized approach to handle project settings and presets.",
5
5
  "repository": {
6
6
  "type": "github",
7
7
  "url": "https://github.com/storm-software/storm-ops",
package/presets/base.json CHANGED
@@ -1,11 +1,10 @@
1
1
  {
2
2
  "organization": "storm-software",
3
- "owner": "@storm-software/development",
3
+ "owner": "@storm-software/admin",
4
4
  "timezone": "America/New_York",
5
5
  "locale": "en-US",
6
6
  "logLevel": "info",
7
7
  "skipCache": false,
8
- "cacheDirectory": "node_modules/.cache/storm",
9
8
  "buildDirectory": "dist",
10
9
  "outputDirectory": "node_modules/.storm",
11
10
  "packageManager": "pnpm",
@@ -13,9 +13,13 @@
13
13
  "type": "string",
14
14
  "description": "The path to a base JSON file to use as a configuration preset file"
15
15
  },
16
+ "isRoot": {
17
+ "type": "boolean",
18
+ "description": "A flag indicating if the current configuration is the set in the root of the workspace"
19
+ },
16
20
  "name": {
17
21
  "type": "string",
18
- "description": "The name of the package"
22
+ "description": "The name of the service/package/scope using this configuration"
19
23
  },
20
24
  "namespace": {
21
25
  "type": "string",
@@ -65,7 +69,7 @@
65
69
  },
66
70
  "owner": {
67
71
  "type": "string",
68
- "default": "@storm-software/development",
72
+ "default": "@storm-software/admin",
69
73
  "description": "The owner of the package"
70
74
  },
71
75
  "worker": {
@@ -103,8 +107,23 @@
103
107
  },
104
108
  "cacheDirectory": {
105
109
  "type": "string",
106
- "default": "node_modules/.cache/storm",
107
- "description": "The directory used to store the workspace's cached file data"
110
+ "description": "The directory used to store the environment's cached file data"
111
+ },
112
+ "dataDirectory": {
113
+ "type": "string",
114
+ "description": "The directory used to store the environment's data files"
115
+ },
116
+ "configDirectory": {
117
+ "type": "string",
118
+ "description": "The directory used to store the environment's configuration files"
119
+ },
120
+ "tempDirectory": {
121
+ "type": "string",
122
+ "description": "The directory used to store the environment's temp files"
123
+ },
124
+ "logDirectory": {
125
+ "type": "string",
126
+ "description": "The directory used to store the environment's temp files"
108
127
  },
109
128
  "buildDirectory": {
110
129
  "type": "string",
@@ -155,6 +155,7 @@ export declare const defineConfig: (input: StormConfigInput) => {
155
155
  }>;
156
156
  $schema?: string | undefined;
157
157
  extends?: string | undefined;
158
+ isRoot?: boolean | undefined;
158
159
  name?: string | undefined;
159
160
  namespace?: string | undefined;
160
161
  organization?: string | undefined;
@@ -173,6 +174,10 @@ export declare const defineConfig: (input: StormConfigInput) => {
173
174
  externalPackagePatterns?: string[] | undefined;
174
175
  skipCache?: boolean | undefined;
175
176
  cacheDirectory?: string | undefined;
177
+ dataDirectory?: string | undefined;
178
+ configDirectory?: string | undefined;
179
+ tempDirectory?: string | undefined;
180
+ logDirectory?: string | undefined;
176
181
  buildDirectory?: string | undefined;
177
182
  outputDirectory?: string | undefined;
178
183
  runtimeVersion?: string | undefined;
package/src/schema.d.ts CHANGED
@@ -1042,6 +1042,7 @@ export declare const ColorConfigMapSchema: z.ZodUnion<[z.ZodObject<{
1042
1042
  export declare const StormConfigSchema: z.ZodObject<{
1043
1043
  $schema: z.ZodDefault<z.ZodString>;
1044
1044
  extends: z.ZodOptional<z.ZodString>;
1045
+ isRoot: z.ZodOptional<z.ZodBoolean>;
1045
1046
  name: z.ZodOptional<z.ZodString>;
1046
1047
  namespace: z.ZodOptional<z.ZodString>;
1047
1048
  organization: z.ZodDefault<z.ZodString>;
@@ -1059,7 +1060,11 @@ export declare const StormConfigSchema: z.ZodObject<{
1059
1060
  packageDirectory: z.ZodOptional<z.ZodString>;
1060
1061
  externalPackagePatterns: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
1061
1062
  skipCache: z.ZodDefault<z.ZodBoolean>;
1062
- cacheDirectory: z.ZodDefault<z.ZodString>;
1063
+ cacheDirectory: z.ZodOptional<z.ZodString>;
1064
+ dataDirectory: z.ZodOptional<z.ZodString>;
1065
+ configDirectory: z.ZodOptional<z.ZodString>;
1066
+ tempDirectory: z.ZodOptional<z.ZodString>;
1067
+ logDirectory: z.ZodOptional<z.ZodString>;
1063
1068
  buildDirectory: z.ZodDefault<z.ZodString>;
1064
1069
  outputDirectory: z.ZodDefault<z.ZodString>;
1065
1070
  runtimeVersion: z.ZodDefault<z.ZodString>;
@@ -1818,7 +1823,6 @@ export declare const StormConfigSchema: z.ZodObject<{
1818
1823
  workspaceRoot: string;
1819
1824
  externalPackagePatterns: string[];
1820
1825
  skipCache: boolean;
1821
- cacheDirectory: string;
1822
1826
  buildDirectory: string;
1823
1827
  outputDirectory: string;
1824
1828
  runtimeVersion: string;
@@ -1984,11 +1988,17 @@ export declare const StormConfigSchema: z.ZodObject<{
1984
1988
  }>;
1985
1989
  extensions: Record<string, any>;
1986
1990
  extends?: string | undefined;
1991
+ isRoot?: boolean | undefined;
1987
1992
  name?: string | undefined;
1988
1993
  namespace?: string | undefined;
1989
1994
  repository?: string | undefined;
1990
1995
  preid?: string | undefined;
1991
1996
  packageDirectory?: string | undefined;
1997
+ cacheDirectory?: string | undefined;
1998
+ dataDirectory?: string | undefined;
1999
+ configDirectory?: string | undefined;
2000
+ tempDirectory?: string | undefined;
2001
+ logDirectory?: string | undefined;
1992
2002
  }, {
1993
2003
  colors: {
1994
2004
  dark: {
@@ -2139,6 +2149,7 @@ export declare const StormConfigSchema: z.ZodObject<{
2139
2149
  }>;
2140
2150
  $schema?: string | undefined;
2141
2151
  extends?: string | undefined;
2152
+ isRoot?: boolean | undefined;
2142
2153
  name?: string | undefined;
2143
2154
  namespace?: string | undefined;
2144
2155
  organization?: string | undefined;
@@ -2157,6 +2168,10 @@ export declare const StormConfigSchema: z.ZodObject<{
2157
2168
  externalPackagePatterns?: string[] | undefined;
2158
2169
  skipCache?: boolean | undefined;
2159
2170
  cacheDirectory?: string | undefined;
2171
+ dataDirectory?: string | undefined;
2172
+ configDirectory?: string | undefined;
2173
+ tempDirectory?: string | undefined;
2174
+ logDirectory?: string | undefined;
2160
2175
  buildDirectory?: string | undefined;
2161
2176
  outputDirectory?: string | undefined;
2162
2177
  runtimeVersion?: string | undefined;