@storm-software/config 1.123.0 → 1.123.1

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 # Changelog for Storm Ops - Config
 
+## [1.123.0](https://github.com/storm-software/storm-ops/releases/tag/config%401.123.0) (2025-06-20)
+
+### Features
+
+- **config:** Export `OrganizationConfig` type definitions
+  ([1789efc81](https://github.com/storm-software/storm-ops/commit/1789efc81))
+- **config:** Added the `organization` sub-node configuration object
+  ([1550346b8](https://github.com/storm-software/storm-ops/commit/1550346b8))
+
+### Miscellaneous
+
+- **monorepo:** Regenerate README markdown files
+  ([0bdc8a84e](https://github.com/storm-software/storm-ops/commit/0bdc8a84e))
+
 ## [1.122.8](https://github.com/storm-software/storm-ops/releases/tag/config%401.122.8) (2025-06-18)
 
 ### Miscellaneous

package/dist/{chunk-2ZLWK5GA.js → chunk-CLVZKFJ2.js}

@@ -11,7 +11,7 @@ import {
 } from "./chunk-X3RNGA5B.js";
 
 // src/schema.ts
-import z from "zod";
+import * as z from "zod/v4";
 var DarkColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7).default("#1d1e22").describe("The dark background color of the workspace");
 var LightColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7).default("#f4f4f5").describe("The light background color of the workspace");
 var BrandColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7).default("#1fb2a6").describe("The primary brand specific color of the workspace");
@@ -227,7 +227,7 @@ var stormWorkspaceConfigSchema = z.object({
   colors: ColorConfigSchema.or(ColorConfigMapSchema).describe(
     "Storm theme config values used for styling various package elements"
   ),
-  extensions: z.record(z.any()).optional().default({}).describe("Configuration of each used extension")
+  extensions: z.record(z.string(), z.any()).optional().default({}).describe("Configuration of each used extension")
 }).describe(
   "Storm Workspace config values used during various dev-ops processes. This type is a combination of the StormPackageConfig and StormProject types. It represents the config of the entire monorepo."
 );

package/dist/chunk-SYFXBAOJ.cjs

@@ -0,0 +1,252 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } else { var newObj = {}; if (obj != null) { for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { newObj[key] = obj[key]; } } } newObj.default = obj; return newObj; } }
+
+
+
+
+
+
+
+
+
+var _chunkHPEJ52UXcjs = require('./chunk-HPEJ52UX.cjs');
+
+// src/schema.ts
+var _v4 = require('zod/v4'); var z = _interopRequireWildcard(_v4);
+var DarkColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7).default("#1d1e22").describe("The dark background color of the workspace");
+var LightColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7).default("#f4f4f5").describe("The light background color of the workspace");
+var BrandColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7).default("#1fb2a6").describe("The primary brand specific color of the workspace");
+var AlternateColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7).optional().describe("The alternate brand specific color of the workspace");
+var AccentColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7).optional().describe("The secondary brand specific color of the workspace");
+var LinkColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7).optional().describe("The color used to display hyperlink text");
+var HelpColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7).default("#8256D0").describe("The second brand specific color of the workspace");
+var SuccessColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7).default("#12B66A").describe("The success color of the workspace");
+var InfoColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7).default("#0070E0").describe("The informational color of the workspace");
+var WarningColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7).default("#fcc419").describe("The warning color of the workspace");
+var DangerColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7).default("#D8314A").describe("The danger color of the workspace");
+var FatalColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7).optional().describe("The fatal color of the workspace");
+var PositiveColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7).default("#4ade80").describe("The positive number color of the workspace");
+var NegativeColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7).default("#ef4444").describe("The negative number color of the workspace");
+var DarkThemeColorConfigSchema = z.object({
+  foreground: LightColorSchema,
+  background: DarkColorSchema,
+  brand: BrandColorSchema,
+  alternate: AlternateColorSchema,
+  accent: AccentColorSchema,
+  link: LinkColorSchema,
+  help: HelpColorSchema,
+  success: SuccessColorSchema,
+  info: InfoColorSchema,
+  warning: WarningColorSchema,
+  danger: DangerColorSchema,
+  fatal: FatalColorSchema,
+  positive: PositiveColorSchema,
+  negative: NegativeColorSchema
+});
+var LightThemeColorConfigSchema = z.object({
+  foreground: DarkColorSchema,
+  background: LightColorSchema,
+  brand: BrandColorSchema,
+  alternate: AlternateColorSchema,
+  accent: AccentColorSchema,
+  link: LinkColorSchema,
+  help: HelpColorSchema,
+  success: SuccessColorSchema,
+  info: InfoColorSchema,
+  warning: WarningColorSchema,
+  danger: DangerColorSchema,
+  fatal: FatalColorSchema,
+  positive: PositiveColorSchema,
+  negative: NegativeColorSchema
+});
+var MultiThemeColorConfigSchema = z.object({
+  dark: DarkThemeColorConfigSchema,
+  light: LightThemeColorConfigSchema
+});
+var SingleThemeColorConfigSchema = z.object({
+  dark: DarkColorSchema,
+  light: LightColorSchema,
+  brand: BrandColorSchema,
+  alternate: AlternateColorSchema,
+  accent: AccentColorSchema,
+  link: LinkColorSchema,
+  help: HelpColorSchema,
+  success: SuccessColorSchema,
+  info: InfoColorSchema,
+  warning: WarningColorSchema,
+  danger: DangerColorSchema,
+  fatal: FatalColorSchema,
+  positive: PositiveColorSchema,
+  negative: NegativeColorSchema
+});
+var RegistryUrlConfigSchema = z.string().trim().toLowerCase().url().optional().describe("A remote registry URL used to publish distributable packages");
+var RegistryConfigSchema = z.object({
+  github: RegistryUrlConfigSchema,
+  npm: RegistryUrlConfigSchema,
+  cargo: RegistryUrlConfigSchema,
+  cyclone: RegistryUrlConfigSchema,
+  container: RegistryUrlConfigSchema
+}).default({}).describe("A list of remote registry URLs used by Storm Software");
+var ColorConfigSchema = SingleThemeColorConfigSchema.or(
+  MultiThemeColorConfigSchema
+).describe("Colors used for various workspace elements");
+var ColorConfigMapSchema = z.union([
+  z.object({ base: ColorConfigSchema }),
+  z.record(z.string(), ColorConfigSchema)
+]);
+var ExtendsItemSchema = z.string().trim().describe(
+  "The path to a base config file to use as a configuration preset file. Documentation can be found at https://github.com/unjs/c12#extending-configuration."
+);
+var ExtendsSchema = ExtendsItemSchema.or(
+  z.array(ExtendsItemSchema)
+).describe(
+  "The path to a base config file to use as a configuration preset file. Documentation can be found at https://github.com/unjs/c12#extending-configuration."
+);
+var WorkspaceBotConfigSchema = z.object({
+  name: z.string().trim().default("stormie-bot").describe(
+    "The workspace bot user's name (this is the bot that will be used to perform various tasks)"
+  ),
+  email: z.string().trim().email().default("bot@stormsoftware.com").describe("The email of the workspace bot")
+}).describe(
+  "The workspace's bot user's config used to automated various operations tasks"
+);
+var WorkspaceReleaseConfigSchema = z.object({
+  banner: z.string().trim().default(_chunkHPEJ52UXcjs.STORM_DEFAULT_RELEASE_BANNER).describe(
+    "A URL to a banner image used to display the workspace's release"
+  ),
+  header: z.string().trim().optional().describe(
+    "A header message appended to the start of the workspace's release notes"
+  ),
+  footer: z.string().trim().default(_chunkHPEJ52UXcjs.STORM_DEFAULT_RELEASE_FOOTER).describe(
+    "A footer message appended to the end of the workspace's release notes"
+  )
+}).describe("The workspace's release config used during the release process");
+var WorkspaceAccountConfigSchema = z.object({
+  twitter: z.string().trim().default(_chunkHPEJ52UXcjs.STORM_DEFAULT_ACCOUNT_TWITTER).describe("A Twitter/X account associated with the organization/project"),
+  discord: z.string().trim().default(_chunkHPEJ52UXcjs.STORM_DEFAULT_ACCOUNT_DISCORD).describe("A Discord account associated with the organization/project"),
+  telegram: z.string().trim().default(_chunkHPEJ52UXcjs.STORM_DEFAULT_ACCOUNT_TELEGRAM).describe("A Telegram account associated with the organization/project"),
+  slack: z.string().trim().default(_chunkHPEJ52UXcjs.STORM_DEFAULT_ACCOUNT_SLACK).describe("A Slack account associated with the organization/project"),
+  medium: z.string().trim().default(_chunkHPEJ52UXcjs.STORM_DEFAULT_ACCOUNT_MEDIUM).describe("A Medium account associated with the organization/project"),
+  github: z.string().trim().default(_chunkHPEJ52UXcjs.STORM_DEFAULT_ACCOUNT_GITHUB).describe("A GitHub account associated with the organization/project")
+}).describe(
+  "The workspace's account config used to store various social media links"
+);
+var WorkspaceDirectoryConfigSchema = z.object({
+  cache: z.string().trim().optional().describe(
+    "The directory used to store the environment's cached file data"
+  ),
+  data: z.string().trim().optional().describe("The directory used to store the environment's data files"),
+  config: z.string().trim().optional().describe(
+    "The directory used to store the environment's configuration files"
+  ),
+  temp: z.string().trim().optional().describe("The directory used to store the environment's temp files"),
+  log: z.string().trim().optional().describe("The directory used to store the environment's temp files"),
+  build: z.string().trim().default("dist").describe(
+    "The directory used to store the workspace's distributable files after a build (relative to the workspace root)"
+  )
+}).describe(
+  "Various directories used by the workspace to store data, cache, and configuration files"
+);
+var errorConfigSchema = z.object({
+  codesFile: z.string().trim().default(_chunkHPEJ52UXcjs.STORM_DEFAULT_ERROR_CODES_FILE).describe("The path to the workspace's error codes JSON file"),
+  url: z.string().trim().url().optional().describe(
+    "A URL to a page that looks up the workspace's error messages given a specific error code"
+  )
+}).describe("The workspace's error config used during the error process");
+var organizationConfigSchema = z.object({
+  name: z.string().trim().describe("The name of the organization"),
+  description: z.string().trim().optional().describe("A description of the organization"),
+  logo: z.string().trim().url().optional().describe("A URL to the organization's logo image"),
+  icon: z.string().trim().url().optional().describe("A URL to the organization's icon image"),
+  url: z.string().trim().url().optional().describe(
+    "A URL to a page that provides more information about the organization"
+  )
+}).describe("The workspace's organization details");
+var stormWorkspaceConfigSchema = z.object({
+  $schema: z.string().trim().default(
+    "https://cdn.jsdelivr.net/npm/@storm-software/config/schemas/storm-workspace.schema.json"
+  ).optional().nullish().describe(
+    "The URL to the JSON schema file that describes the Storm configuration file"
+  ),
+  extends: ExtendsSchema.optional(),
+  name: z.string().trim().toLowerCase().optional().describe(
+    "The name of the service/package/scope using this configuration"
+  ),
+  namespace: z.string().trim().toLowerCase().optional().describe("The namespace of the package"),
+  organization: organizationConfigSchema.or(z.string().trim().describe("The organization of the workspace")).optional().describe(
+    "The organization of the workspace. This can be a string or an object containing the organization's details"
+  ),
+  repository: z.string().trim().optional().describe("The repo URL of the workspace (i.e. GitHub)"),
+  license: z.string().trim().default("Apache-2.0").describe("The license type of the package"),
+  homepage: z.string().trim().url().optional().describe("The homepage of the workspace"),
+  docs: z.string().trim().url().optional().describe("The documentation site for the workspace"),
+  portal: z.string().trim().url().optional().describe("The development portal site for the workspace"),
+  licensing: z.string().trim().url().optional().describe("The licensing site for the workspace"),
+  contact: z.string().trim().url().optional().describe("The contact site for the workspace"),
+  support: z.string().trim().url().optional().describe(
+    "The support site for the workspace. If not provided, this is defaulted to the `contact` config value"
+  ),
+  branch: z.string().trim().default("main").describe("The branch of the workspace"),
+  preid: z.string().optional().describe("A tag specifying the version pre-release identifier"),
+  owner: z.string().trim().default("@storm-software/admin").describe("The owner of the package"),
+  bot: WorkspaceBotConfigSchema,
+  release: WorkspaceReleaseConfigSchema,
+  account: WorkspaceAccountConfigSchema,
+  error: errorConfigSchema,
+  mode: z.enum(["development", "staging", "production"]).default("production").describe("The current runtime environment mode for the package"),
+  workspaceRoot: z.string().trim().describe("The root directory of the workspace"),
+  externalPackagePatterns: z.array(z.string()).default([]).describe(
+    "The build will use these package patterns to determine if they should be external to the bundle"
+  ),
+  skipCache: z.boolean().default(false).describe("Should all known types of workspace caching be skipped?"),
+  directories: WorkspaceDirectoryConfigSchema,
+  packageManager: z.enum(["npm", "yarn", "pnpm", "bun"]).default("npm").describe(
+    "The JavaScript/TypeScript package manager used by the repository"
+  ),
+  timezone: z.string().trim().default("America/New_York").describe("The default timezone of the workspace"),
+  locale: z.string().trim().default("en-US").describe("The default locale of the workspace"),
+  logLevel: z.enum([
+    "silent",
+    "fatal",
+    "error",
+    "warn",
+    "success",
+    "info",
+    "debug",
+    "trace",
+    "all"
+  ]).default("info").describe(
+    "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`)."
+  ),
+  skipConfigLogging: z.boolean().optional().describe(
+    "Should the logging of the current Storm Workspace configuration be skipped?"
+  ),
+  registry: RegistryConfigSchema,
+  configFile: z.string().trim().nullable().default(null).describe(
+    "The filepath of the Storm config. When this field is null, no config file was found in the current workspace."
+  ),
+  colors: ColorConfigSchema.or(ColorConfigMapSchema).describe(
+    "Storm theme config values used for styling various package elements"
+  ),
+  extensions: z.record(z.string(), z.any()).optional().default({}).describe("Configuration of each used extension")
+}).describe(
+  "Storm Workspace config values used during various dev-ops processes. This type is a combination of the StormPackageConfig and StormProject types. It represents the config of the entire monorepo."
+);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+exports.DarkThemeColorConfigSchema = DarkThemeColorConfigSchema; exports.LightThemeColorConfigSchema = LightThemeColorConfigSchema; exports.MultiThemeColorConfigSchema = MultiThemeColorConfigSchema; exports.SingleThemeColorConfigSchema = SingleThemeColorConfigSchema; exports.RegistryUrlConfigSchema = RegistryUrlConfigSchema; exports.RegistryConfigSchema = RegistryConfigSchema; exports.ColorConfigSchema = ColorConfigSchema; exports.ColorConfigMapSchema = ColorConfigMapSchema; exports.ExtendsSchema = ExtendsSchema; exports.WorkspaceBotConfigSchema = WorkspaceBotConfigSchema; exports.WorkspaceReleaseConfigSchema = WorkspaceReleaseConfigSchema; exports.WorkspaceAccountConfigSchema = WorkspaceAccountConfigSchema; exports.WorkspaceDirectoryConfigSchema = WorkspaceDirectoryConfigSchema; exports.errorConfigSchema = errorConfigSchema; exports.organizationConfigSchema = organizationConfigSchema; exports.stormWorkspaceConfigSchema = stormWorkspaceConfigSchema;

package/dist/define-config.d.cts

@@ -1,5 +1,5 @@
 import { StormWorkspaceConfigInput } from './types.cjs';
-import 'zod';
+import 'zod/v4';
 import './schema.cjs';
 
 /**
@@ -19,12 +19,12 @@ declare const defineConfig: (input: StormWorkspaceConfigInput) => {
         footer?: string | undefined;
     };
     account: {
-        github?: string | undefined;
         twitter?: string | undefined;
         discord?: string | undefined;
         telegram?: string | undefined;
         slack?: string | undefined;
         medium?: string | undefined;
+        github?: string | undefined;
     };
     error: {
         codesFile?: string | undefined;
@@ -40,6 +40,21 @@ declare const defineConfig: (input: StormWorkspaceConfigInput) => {
         build?: string | undefined;
     };
     colors: {
+        dark?: string | undefined;
+        light?: string | undefined;
+        brand?: string | undefined;
+        alternate?: string | undefined;
+        accent?: string | undefined;
+        link?: string | undefined;
+        help?: string | undefined;
+        success?: string | undefined;
+        info?: string | undefined;
+        warning?: string | undefined;
+        danger?: string | undefined;
+        fatal?: string | undefined;
+        positive?: string | undefined;
+        negative?: string | undefined;
+    } | {
         dark: {
             foreground?: string | undefined;
             background?: string | undefined;
@@ -72,7 +87,9 @@ declare const defineConfig: (input: StormWorkspaceConfigInput) => {
             positive?: string | undefined;
             negative?: string | undefined;
         };
-    } | {
+    } | Record<string, {
+        dark?: string | undefined;
+        light?: string | undefined;
         brand?: string | undefined;
         alternate?: string | undefined;
         accent?: string | undefined;
@@ -85,43 +102,10 @@ declare const defineConfig: (input: StormWorkspaceConfigInput) => {
         fatal?: string | undefined;
         positive?: string | undefined;
         negative?: string | undefined;
-        dark?: string | undefined;
-        light?: string | undefined;
     } | {
-        base: {
-            dark: {
-                foreground?: string | undefined;
-                background?: string | undefined;
-                brand?: string | undefined;
-                alternate?: string | undefined;
-                accent?: string | undefined;
-                link?: string | undefined;
-                help?: string | undefined;
-                success?: string | undefined;
-                info?: string | undefined;
-                warning?: string | undefined;
-                danger?: string | undefined;
-                fatal?: string | undefined;
-                positive?: string | undefined;
-                negative?: string | undefined;
-            };
-            light: {
-                foreground?: string | undefined;
-                background?: string | undefined;
-                brand?: string | undefined;
-                alternate?: string | undefined;
-                accent?: string | undefined;
-                link?: string | undefined;
-                help?: string | undefined;
-                success?: string | undefined;
-                info?: string | undefined;
-                warning?: string | undefined;
-                danger?: string | undefined;
-                fatal?: string | undefined;
-                positive?: string | undefined;
-                negative?: string | undefined;
-            };
-        } | {
+        dark: {
+            foreground?: string | undefined;
+            background?: string | undefined;
             brand?: string | undefined;
             alternate?: string | undefined;
             accent?: string | undefined;
@@ -134,11 +118,8 @@ declare const defineConfig: (input: StormWorkspaceConfigInput) => {
             fatal?: string | undefined;
             positive?: string | undefined;
             negative?: string | undefined;
-            dark?: string | undefined;
-            light?: string | undefined;
         };
-    } | Record<string, {
-        dark: {
+        light: {
             foreground?: string | undefined;
             background?: string | undefined;
             brand?: string | undefined;
@@ -154,9 +135,10 @@ declare const defineConfig: (input: StormWorkspaceConfigInput) => {
             positive?: string | undefined;
             negative?: string | undefined;
         };
-        light: {
-            foreground?: string | undefined;
-            background?: string | undefined;
+    }> | {
+        base: {
+            dark?: string | undefined;
+            light?: string | undefined;
             brand?: string | undefined;
             alternate?: string | undefined;
             accent?: string | undefined;
@@ -169,33 +151,51 @@ declare const defineConfig: (input: StormWorkspaceConfigInput) => {
             fatal?: string | undefined;
             positive?: string | undefined;
             negative?: string | undefined;
+        } | {
+            dark: {
+                foreground?: string | undefined;
+                background?: string | undefined;
+                brand?: string | undefined;
+                alternate?: string | undefined;
+                accent?: string | undefined;
+                link?: string | undefined;
+                help?: string | undefined;
+                success?: string | undefined;
+                info?: string | undefined;
+                warning?: string | undefined;
+                danger?: string | undefined;
+                fatal?: string | undefined;
+                positive?: string | undefined;
+                negative?: string | undefined;
+            };
+            light: {
+                foreground?: string | undefined;
+                background?: string | undefined;
+                brand?: string | undefined;
+                alternate?: string | undefined;
+                accent?: string | undefined;
+                link?: string | undefined;
+                help?: string | undefined;
+                success?: string | undefined;
+                info?: string | undefined;
+                warning?: string | undefined;
+                danger?: string | undefined;
+                fatal?: string | undefined;
+                positive?: string | undefined;
+                negative?: string | undefined;
+            };
         };
-    } | {
-        brand?: string | undefined;
-        alternate?: string | undefined;
-        accent?: string | undefined;
-        link?: string | undefined;
-        help?: string | undefined;
-        success?: string | undefined;
-        info?: string | undefined;
-        warning?: string | undefined;
-        danger?: string | undefined;
-        fatal?: string | undefined;
-        positive?: string | undefined;
-        negative?: string | undefined;
-        dark?: string | undefined;
-        light?: string | undefined;
-    }>;
-    name?: string | undefined;
+    };
     $schema?: string | null | undefined;
     extends?: string | string[] | undefined;
+    name?: string | undefined;
     namespace?: string | undefined;
     organization?: string | {
         name: string;
-        url?: string | undefined;
         description?: string | undefined;
         logo?: string | undefined;
         icon?: string | undefined;
+        url?: string | undefined;
     } | undefined;
     repository?: string | undefined;
     license?: string | undefined;
@@ -214,7 +214,7 @@ declare const defineConfig: (input: StormWorkspaceConfigInput) => {
     packageManager?: "npm" | "yarn" | "pnpm" | "bun" | undefined;
     timezone?: string | undefined;
     locale?: string | undefined;
-    logLevel?: "success" | "info" | "fatal" | "error" | "silent" | "warn" | "debug" | "trace" | "all" | undefined;
+    logLevel?: "error" | "success" | "silent" | "fatal" | "warn" | "info" | "debug" | "trace" | "all" | undefined;
     skipConfigLogging?: boolean | undefined;
     registry?: {
         github?: string | undefined;