@storm-software/config 1.110.6 → 1.111.0

package/dist/schema.js

@@ -8,12 +8,12 @@ import {
   RegistryConfigSchema,
   RegistryUrlConfigSchema,
   SingleThemeColorConfigSchema,
-  StormConfigSchema,
   WorkspaceAccountConfigSchema,
   WorkspaceBotConfigSchema,
   WorkspaceDirectoryConfigSchema,
-  WorkspaceReleaseConfigSchema
-} from "./chunk-FWJ7T4PW.js";
+  WorkspaceReleaseConfigSchema,
+  stormWorkspaceConfigSchema
+} from "./chunk-C2SK4O44.js";
 import "./chunk-HODJMVAD.js";
 import "./chunk-SHUYVCID.js";
 export {
@@ -26,9 +26,9 @@ export {
   RegistryConfigSchema,
   RegistryUrlConfigSchema,
   SingleThemeColorConfigSchema,
-  StormConfigSchema,
   WorkspaceAccountConfigSchema,
   WorkspaceBotConfigSchema,
   WorkspaceDirectoryConfigSchema,
-  WorkspaceReleaseConfigSchema
+  WorkspaceReleaseConfigSchema,
+  stormWorkspaceConfigSchema
 };

package/dist/types.d.cts

@@ -1,5 +1,5 @@
 import z from 'zod';
-import { DarkThemeColorConfigSchema, LightThemeColorConfigSchema, MultiThemeColorConfigSchema, SingleThemeColorConfigSchema, ColorConfigSchema, ColorConfigMapSchema, StormConfigSchema } from './schema.cjs';
+import { DarkThemeColorConfigSchema, LightThemeColorConfigSchema, MultiThemeColorConfigSchema, SingleThemeColorConfigSchema, ColorConfigSchema, ColorConfigMapSchema, stormWorkspaceConfigSchema } from './schema.cjs';
 
 type DarkThemeColorConfig = z.infer<typeof DarkThemeColorConfigSchema>;
 type DarkThemeColorConfigInput = z.input<typeof DarkThemeColorConfigSchema>;
@@ -13,13 +13,29 @@ type ColorConfig = z.infer<typeof ColorConfigSchema>;
 type ColorConfigInput = z.input<typeof ColorConfigSchema>;
 type ColorConfigMap = z.infer<typeof ColorConfigMapSchema>;
 type ColorConfigMapInput = z.input<typeof ColorConfigMapSchema>;
-type TStormConfig = z.infer<typeof StormConfigSchema>;
-type StormConfigInput = z.input<typeof StormConfigSchema>;
-type StormConfig<TExtensionName extends keyof TStormConfig["extensions"] = keyof TStormConfig["extensions"], TExtensionConfig extends TStormConfig["extensions"][TExtensionName] = TStormConfig["extensions"][TExtensionName]> = TStormConfig & {
-    extensions: (TStormConfig["extensions"] & {
+type TStormWorkspaceConfig = z.infer<typeof stormWorkspaceConfigSchema>;
+type StormWorkspaceConfigInput = z.input<typeof stormWorkspaceConfigSchema>;
+/**
+ * The Storm workspace's configuration object
+ *
+ * @remarks
+ * This type is used to define the configuration object for the entire Storm workspace/monorepo. The value is extracted from the `storm-workspace.json` file in the workspace root and the currently configuration environment variables. The value can be obtained by calling `getWorkspaceConfig()` in `@storm-software/config-tools`.
+ *
+ * @deprecated
+ * This type is deprecated and will be removed in the next major version. Use `StormWorkspaceConfig` instead.
+ */
+type StormConfig<TExtensionName extends keyof TStormWorkspaceConfig["extensions"] = keyof TStormWorkspaceConfig["extensions"], TExtensionConfig extends TStormWorkspaceConfig["extensions"][TExtensionName] = TStormWorkspaceConfig["extensions"][TExtensionName]> = TStormWorkspaceConfig & {
+    extensions: (TStormWorkspaceConfig["extensions"] & {
         [extensionName in TExtensionName]: TExtensionConfig;
     }) | NonNullable<Record<string, any>>;
 };
+/**
+ * The Storm workspace's configuration object
+ *
+ * @remarks
+ * This type is used to define the configuration object for the entire Storm workspace/monorepo. The value is extracted from the `storm-workspace.json` file in the workspace root and the currently configuration environment variables. The value can be obtained by calling `getWorkspaceConfig()` in `@storm-software/config-tools`.
+ */
+type StormWorkspaceConfig<TExtensionName extends keyof TStormWorkspaceConfig["extensions"] = keyof TStormWorkspaceConfig["extensions"], TExtensionConfig extends TStormWorkspaceConfig["extensions"][TExtensionName] = TStormWorkspaceConfig["extensions"][TExtensionName]> = StormConfig<TExtensionName, TExtensionConfig>;
 declare const COLOR_KEYS: string[];
 
-export { COLOR_KEYS, type ColorConfig, type ColorConfigInput, type ColorConfigMap, type ColorConfigMapInput, type DarkThemeColorConfig, type DarkThemeColorConfigInput, type LightThemeColorConfig, type LightThemeColorConfigInput, type MultiThemeColorConfig, type MultiThemeColorConfigInput, type SingleThemeColorConfig, type SingleThemeColorConfigInput, type StormConfig, type StormConfigInput };
+export { COLOR_KEYS, type ColorConfig, type ColorConfigInput, type ColorConfigMap, type ColorConfigMapInput, type DarkThemeColorConfig, type DarkThemeColorConfigInput, type LightThemeColorConfig, type LightThemeColorConfigInput, type MultiThemeColorConfig, type MultiThemeColorConfigInput, type SingleThemeColorConfig, type SingleThemeColorConfigInput, type StormConfig, type StormWorkspaceConfig, type StormWorkspaceConfigInput };

package/dist/types.d.ts

@@ -1,5 +1,5 @@
 import z from 'zod';
-import { DarkThemeColorConfigSchema, LightThemeColorConfigSchema, MultiThemeColorConfigSchema, SingleThemeColorConfigSchema, ColorConfigSchema, ColorConfigMapSchema, StormConfigSchema } from './schema.js';
+import { DarkThemeColorConfigSchema, LightThemeColorConfigSchema, MultiThemeColorConfigSchema, SingleThemeColorConfigSchema, ColorConfigSchema, ColorConfigMapSchema, stormWorkspaceConfigSchema } from './schema.js';
 
 type DarkThemeColorConfig = z.infer<typeof DarkThemeColorConfigSchema>;
 type DarkThemeColorConfigInput = z.input<typeof DarkThemeColorConfigSchema>;
@@ -13,13 +13,29 @@ type ColorConfig = z.infer<typeof ColorConfigSchema>;
 type ColorConfigInput = z.input<typeof ColorConfigSchema>;
 type ColorConfigMap = z.infer<typeof ColorConfigMapSchema>;
 type ColorConfigMapInput = z.input<typeof ColorConfigMapSchema>;
-type TStormConfig = z.infer<typeof StormConfigSchema>;
-type StormConfigInput = z.input<typeof StormConfigSchema>;
-type StormConfig<TExtensionName extends keyof TStormConfig["extensions"] = keyof TStormConfig["extensions"], TExtensionConfig extends TStormConfig["extensions"][TExtensionName] = TStormConfig["extensions"][TExtensionName]> = TStormConfig & {
-    extensions: (TStormConfig["extensions"] & {
+type TStormWorkspaceConfig = z.infer<typeof stormWorkspaceConfigSchema>;
+type StormWorkspaceConfigInput = z.input<typeof stormWorkspaceConfigSchema>;
+/**
+ * The Storm workspace's configuration object
+ *
+ * @remarks
+ * This type is used to define the configuration object for the entire Storm workspace/monorepo. The value is extracted from the `storm-workspace.json` file in the workspace root and the currently configuration environment variables. The value can be obtained by calling `getWorkspaceConfig()` in `@storm-software/config-tools`.
+ *
+ * @deprecated
+ * This type is deprecated and will be removed in the next major version. Use `StormWorkspaceConfig` instead.
+ */
+type StormConfig<TExtensionName extends keyof TStormWorkspaceConfig["extensions"] = keyof TStormWorkspaceConfig["extensions"], TExtensionConfig extends TStormWorkspaceConfig["extensions"][TExtensionName] = TStormWorkspaceConfig["extensions"][TExtensionName]> = TStormWorkspaceConfig & {
+    extensions: (TStormWorkspaceConfig["extensions"] & {
         [extensionName in TExtensionName]: TExtensionConfig;
     }) | NonNullable<Record<string, any>>;
 };
+/**
+ * The Storm workspace's configuration object
+ *
+ * @remarks
+ * This type is used to define the configuration object for the entire Storm workspace/monorepo. The value is extracted from the `storm-workspace.json` file in the workspace root and the currently configuration environment variables. The value can be obtained by calling `getWorkspaceConfig()` in `@storm-software/config-tools`.
+ */
+type StormWorkspaceConfig<TExtensionName extends keyof TStormWorkspaceConfig["extensions"] = keyof TStormWorkspaceConfig["extensions"], TExtensionConfig extends TStormWorkspaceConfig["extensions"][TExtensionName] = TStormWorkspaceConfig["extensions"][TExtensionName]> = StormConfig<TExtensionName, TExtensionConfig>;
 declare const COLOR_KEYS: string[];
 
-export { COLOR_KEYS, type ColorConfig, type ColorConfigInput, type ColorConfigMap, type ColorConfigMapInput, type DarkThemeColorConfig, type DarkThemeColorConfigInput, type LightThemeColorConfig, type LightThemeColorConfigInput, type MultiThemeColorConfig, type MultiThemeColorConfigInput, type SingleThemeColorConfig, type SingleThemeColorConfigInput, type StormConfig, type StormConfigInput };
+export { COLOR_KEYS, type ColorConfig, type ColorConfigInput, type ColorConfigMap, type ColorConfigMapInput, type DarkThemeColorConfig, type DarkThemeColorConfigInput, type LightThemeColorConfig, type LightThemeColorConfigInput, type MultiThemeColorConfig, type MultiThemeColorConfigInput, type SingleThemeColorConfig, type SingleThemeColorConfigInput, type StormConfig, type StormWorkspaceConfig, type StormWorkspaceConfigInput };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storm-software/config",
-  "version": "1.110.6",
+  "version": "1.111.0",
   "type": "module",
   "description": "Configuration management tools and schemas for Storm Software projects, providing a standardized approach to handle project settings and presets.",
   "repository": {

package/src/define-config.d.ts

@@ -1,11 +1,11 @@
-import type { StormConfigInput } from "./types";
+import type { StormWorkspaceConfigInput } from "./types";
 /**
  * Type the config values for the current Storm workspace
  *
  * @param input - The config values for the current Storm workspace
  * @returns The config values for the current Storm workspace
  */
-export declare const defineConfig: (input: StormConfigInput) => {
+export declare const defineConfig: (input: StormWorkspaceConfigInput) => {
     bot: {
         name?: string | undefined;
         email?: string | undefined;

package/src/schema.d.ts

@@ -1107,7 +1107,7 @@ export declare const WorkspaceDirectoryConfigSchema: z.ZodObject<{
 /**
  * Storm Workspace config values used during various dev-ops processes. It represents the config of the entire monorepo.
  */
-export declare const StormConfigSchema: z.ZodObject<{
+export declare const stormWorkspaceConfigSchema: z.ZodObject<{
     $schema: z.ZodOptional<z.ZodNullable<z.ZodOptional<z.ZodDefault<z.ZodString>>>>;
     extends: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
     name: z.ZodOptional<z.ZodString>;

package/src/types.d.ts

@@ -1,5 +1,5 @@
 import type z from "zod";
-import type { ColorConfigMapSchema, ColorConfigSchema, DarkThemeColorConfigSchema, LightThemeColorConfigSchema, MultiThemeColorConfigSchema, SingleThemeColorConfigSchema, StormConfigSchema } from "./schema";
+import type { ColorConfigMapSchema, ColorConfigSchema, DarkThemeColorConfigSchema, LightThemeColorConfigSchema, MultiThemeColorConfigSchema, SingleThemeColorConfigSchema, stormWorkspaceConfigSchema } from "./schema";
 export type DarkThemeColorConfig = z.infer<typeof DarkThemeColorConfigSchema>;
 export type DarkThemeColorConfigInput = z.input<typeof DarkThemeColorConfigSchema>;
 export type LightThemeColorConfig = z.infer<typeof LightThemeColorConfigSchema>;
@@ -12,12 +12,28 @@ export type ColorConfig = z.infer<typeof ColorConfigSchema>;
 export type ColorConfigInput = z.input<typeof ColorConfigSchema>;
 export type ColorConfigMap = z.infer<typeof ColorConfigMapSchema>;
 export type ColorConfigMapInput = z.input<typeof ColorConfigMapSchema>;
-type TStormConfig = z.infer<typeof StormConfigSchema>;
-export type StormConfigInput = z.input<typeof StormConfigSchema>;
-export type StormConfig<TExtensionName extends keyof TStormConfig["extensions"] = keyof TStormConfig["extensions"], TExtensionConfig extends TStormConfig["extensions"][TExtensionName] = TStormConfig["extensions"][TExtensionName]> = TStormConfig & {
-    extensions: (TStormConfig["extensions"] & {
+type TStormWorkspaceConfig = z.infer<typeof stormWorkspaceConfigSchema>;
+export type StormWorkspaceConfigInput = z.input<typeof stormWorkspaceConfigSchema>;
+/**
+ * The Storm workspace's configuration object
+ *
+ * @remarks
+ * This type is used to define the configuration object for the entire Storm workspace/monorepo. The value is extracted from the `storm-workspace.json` file in the workspace root and the currently configuration environment variables. The value can be obtained by calling `getWorkspaceConfig()` in `@storm-software/config-tools`.
+ *
+ * @deprecated
+ * This type is deprecated and will be removed in the next major version. Use `StormWorkspaceConfig` instead.
+ */
+export type StormConfig<TExtensionName extends keyof TStormWorkspaceConfig["extensions"] = keyof TStormWorkspaceConfig["extensions"], TExtensionConfig extends TStormWorkspaceConfig["extensions"][TExtensionName] = TStormWorkspaceConfig["extensions"][TExtensionName]> = TStormWorkspaceConfig & {
+    extensions: (TStormWorkspaceConfig["extensions"] & {
         [extensionName in TExtensionName]: TExtensionConfig;
     }) | NonNullable<Record<string, any>>;
 };
+/**
+ * The Storm workspace's configuration object
+ *
+ * @remarks
+ * This type is used to define the configuration object for the entire Storm workspace/monorepo. The value is extracted from the `storm-workspace.json` file in the workspace root and the currently configuration environment variables. The value can be obtained by calling `getWorkspaceConfig()` in `@storm-software/config-tools`.
+ */
+export type StormWorkspaceConfig<TExtensionName extends keyof TStormWorkspaceConfig["extensions"] = keyof TStormWorkspaceConfig["extensions"], TExtensionConfig extends TStormWorkspaceConfig["extensions"][TExtensionName] = TStormWorkspaceConfig["extensions"][TExtensionName]> = StormConfig<TExtensionName, TExtensionConfig>;
 export declare const COLOR_KEYS: string[];
 export {};