@storm-software/workspace-tools 1.277.34 → 1.278.4

package/dist/{chunk-PG7GBHUM.mjs → chunk-PYS5P7QE.mjs}

@@ -1,32 +1,410 @@
 import {
-  COLOR_KEYS,
   LogLevel,
-  STORM_DEFAULT_DOCS,
-  STORM_DEFAULT_HOMEPAGE,
-  STORM_DEFAULT_LICENSING,
-  applyDefaultConfig,
   formatLogMessage,
   getLogLevel,
   getLogLevelLabel,
-  getPackageJsonConfig,
-  stormWorkspaceConfigSchema,
   writeTrace,
   writeWarning
-} from "./chunk-SW2AFRXA.mjs";
+} from "./chunk-V44DYGWX.mjs";
 import {
   findWorkspaceRoot
-} from "./chunk-LSF4BHCI.mjs";
+} from "./chunk-M5Z57CUO.mjs";
 import {
   correctPaths,
   joinPaths
 } from "./chunk-U7JFVMCK.mjs";
 
+// ../config/src/schema.ts
+import * as z from "zod";
+
+// ../config/src/constants.ts
+var STORM_DEFAULT_DOCS = "https://docs.stormsoftware.com";
+var STORM_DEFAULT_HOMEPAGE = "https://stormsoftware.com";
+var STORM_DEFAULT_CONTACT = "https://stormsoftware.com/contact";
+var STORM_DEFAULT_LICENSING = "https://stormsoftware.com/license";
+var STORM_DEFAULT_LICENSE = "Apache-2.0";
+var STORM_DEFAULT_SOCIAL_TWITTER = "StormSoftwareHQ";
+var STORM_DEFAULT_SOCIAL_DISCORD = "https://discord.gg/MQ6YVzakM5";
+var STORM_DEFAULT_SOCIAL_TELEGRAM = "https://t.me/storm_software";
+var STORM_DEFAULT_SOCIAL_SLACK = "https://join.slack.com/t/storm-software/shared_invite/zt-2gsmk04hs-i6yhK_r6urq0dkZYAwq2pA";
+var STORM_DEFAULT_SOCIAL_MEDIUM = "https://medium.com/storm-software";
+var STORM_DEFAULT_SOCIAL_GITHUB = "https://github.com/storm-software";
+var STORM_DEFAULT_RELEASE_FOOTER = `
+Storm Software is an open source software development organization with the mission is to make software development more accessible. Our ideal future is one where anyone can create software without years of prior development experience serving as a barrier to entry. We hope to achieve this via LLMs, Generative AI, and intuitive, high-level data modeling/programming languages.
+
+Join us on [Discord](${STORM_DEFAULT_SOCIAL_DISCORD}) to chat with the team, receive release notifications, ask questions, and get involved.
+
+If this sounds interesting, and you would like to help us in creating the next generation of development tools, please reach out on our [website](${STORM_DEFAULT_CONTACT}) or join our [Slack](${STORM_DEFAULT_SOCIAL_SLACK}) channel!
+`;
+var STORM_DEFAULT_ERROR_CODES_FILE = "tools/errors/codes.json";
+
+// ../config/src/schema.ts
+var ColorSchema = z.string().trim().toLowerCase().regex(/^#([0-9a-f]{3}){1,2}$/i).length(7);
+var DarkColorSchema = ColorSchema.default("#151718").describe(
+  "The dark background color of the workspace"
+);
+var LightColorSchema = ColorSchema.default("#cbd5e1").describe(
+  "The light background color of the workspace"
+);
+var BrandColorSchema = ColorSchema.default("#1fb2a6").describe(
+  "The primary brand specific color of the workspace"
+);
+var AlternateColorSchema = ColorSchema.optional().describe(
+  "The alternate brand specific color of the workspace"
+);
+var AccentColorSchema = ColorSchema.optional().describe(
+  "The secondary brand specific color of the workspace"
+);
+var LinkColorSchema = ColorSchema.default("#3fa6ff").describe(
+  "The color used to display hyperlink text"
+);
+var HelpColorSchema = ColorSchema.default("#818cf8").describe(
+  "The second brand specific color of the workspace"
+);
+var SuccessColorSchema = ColorSchema.default("#45b27e").describe(
+  "The success color of the workspace"
+);
+var InfoColorSchema = ColorSchema.default("#38bdf8").describe(
+  "The informational color of the workspace"
+);
+var WarningColorSchema = ColorSchema.default("#f3d371").describe(
+  "The warning color of the workspace"
+);
+var DangerColorSchema = ColorSchema.default("#d8314a").describe(
+  "The danger color of the workspace"
+);
+var FatalColorSchema = ColorSchema.optional().describe(
+  "The fatal color of the workspace"
+);
+var PositiveColorSchema = ColorSchema.default("#4ade80").describe(
+  "The positive number color of the workspace"
+);
+var NegativeColorSchema = ColorSchema.default("#ef4444").describe(
+  "The negative number color of the workspace"
+);
+var GradientStopsSchema = z.array(ColorSchema).optional().describe(
+  "The color stops for the base gradient color pattern used in 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,
+  gradient: GradientStopsSchema
+});
+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,
+  gradient: GradientStopsSchema
+});
+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,
+  gradient: GradientStopsSchema
+});
+var RegistryUrlConfigSchema = z.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.record(
+  z.union([z.literal("base"), 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.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().optional().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().optional().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 WorkspaceSocialsConfigSchema = z.object({
+  twitter: z.string().trim().default(STORM_DEFAULT_SOCIAL_TWITTER).describe("A Twitter/X account associated with the organization/project"),
+  discord: z.string().trim().default(STORM_DEFAULT_SOCIAL_DISCORD).describe("A Discord account associated with the organization/project"),
+  telegram: z.string().trim().default(STORM_DEFAULT_SOCIAL_TELEGRAM).describe("A Telegram account associated with the organization/project"),
+  slack: z.string().trim().default(STORM_DEFAULT_SOCIAL_SLACK).describe("A Slack account associated with the organization/project"),
+  medium: z.string().trim().default(STORM_DEFAULT_SOCIAL_MEDIUM).describe("A Medium account associated with the organization/project"),
+  github: z.string().trim().default(STORM_DEFAULT_SOCIAL_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(STORM_DEFAULT_ERROR_CODES_FILE).describe("The path to the workspace's error codes JSON file"),
+  url: z.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.url().optional().describe("A URL to the organization's logo image"),
+  icon: z.url().optional().describe("A URL to the organization's icon image"),
+  url: z.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://public.storm-cdn.com/schemas/storm-workspace.schema.json"
+  ).describe(
+    "The URL or file path 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.url().optional().describe("The homepage of the workspace"),
+  docs: z.url().optional().describe("The documentation site for the workspace"),
+  portal: z.url().optional().describe("The development portal site for the workspace"),
+  licensing: z.url().optional().describe("The licensing site for the workspace"),
+  contact: z.url().optional().describe("The contact site for the workspace"),
+  support: z.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,
+  socials: WorkspaceSocialsConfigSchema,
+  error: errorConfigSchema,
+  mode: z.string().trim().default("production").describe("The current runtime environment mode for the package"),
+  workspaceRoot: z.string().trim().describe("The root directory of the workspace"),
+  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."
+);
+
+// ../config/src/types.ts
+var COLOR_KEYS = [
+  "dark",
+  "light",
+  "base",
+  "brand",
+  "alternate",
+  "accent",
+  "link",
+  "success",
+  "help",
+  "info",
+  "warning",
+  "danger",
+  "fatal",
+  "positive",
+  "negative"
+];
+
 // ../config-tools/src/create-storm-config.ts
 import defu2 from "defu";
 
 // ../config-tools/src/config-file/get-config-file.ts
 import { loadConfig } from "c12";
 import defu from "defu";
+
+// ../config-tools/src/utilities/get-default-config.ts
+import { existsSync } from "node:fs";
+import { readFile } from "node:fs/promises";
+import { join } from "node:path";
+async function getPackageJsonConfig(root) {
+  let license = STORM_DEFAULT_LICENSE;
+  let homepage = void 0;
+  let support = void 0;
+  let name = void 0;
+  let namespace = void 0;
+  let repository = void 0;
+  const workspaceRoot = findWorkspaceRoot(root);
+  if (existsSync(join(workspaceRoot, "package.json"))) {
+    const file = await readFile(
+      joinPaths(workspaceRoot, "package.json"),
+      "utf8"
+    );
+    if (file) {
+      const packageJson = JSON.parse(file);
+      if (packageJson.name) {
+        name = packageJson.name;
+      }
+      if (packageJson.namespace) {
+        namespace = packageJson.namespace;
+      }
+      if (packageJson.repository) {
+        if (typeof packageJson.repository === "string") {
+          repository = packageJson.repository;
+        } else if (packageJson.repository.url) {
+          repository = packageJson.repository.url;
+        }
+      }
+      if (packageJson.license) {
+        license = packageJson.license;
+      }
+      if (packageJson.homepage) {
+        homepage = packageJson.homepage;
+      }
+      if (packageJson.bugs) {
+        if (typeof packageJson.bugs === "string") {
+          support = packageJson.bugs;
+        } else if (packageJson.bugs.url) {
+          support = packageJson.bugs.url;
+        }
+      }
+    }
+  }
+  return {
+    workspaceRoot,
+    name,
+    namespace,
+    repository,
+    license,
+    homepage,
+    support
+  };
+}
+function applyDefaultConfig(config) {
+  if (!config.support && config.contact) {
+    config.support = config.contact;
+  }
+  if (!config.contact && config.support) {
+    config.contact = config.support;
+  }
+  if (config.homepage) {
+    if (!config.docs) {
+      config.docs = `${config.homepage}/docs`;
+    }
+    if (!config.license) {
+      config.license = `${config.homepage}/license`;
+    }
+    if (!config.support) {
+      config.support = `${config.homepage}/support`;
+    }
+    if (!config.contact) {
+      config.contact = `${config.homepage}/contact`;
+    }
+    if (!config.error?.codesFile || !config?.error?.url) {
+      config.error ??= { codesFile: STORM_DEFAULT_ERROR_CODES_FILE };
+      if (config.homepage) {
+        config.error.url ??= `${config.homepage}/errors`;
+      }
+    }
+  }
+  return config;
+}
+
+// ../config-tools/src/config-file/get-config-file.ts
 var getConfigFileByName = async (fileName, filePath, options = {}) => {
   const workspacePath = filePath || findWorkspaceRoot(filePath);
   const configs = await Promise.all([
@@ -240,6 +618,19 @@ var getThemeColorConfigEnv = (prefix, theme) => {
   return process.env[`${prefix}${themeName}LIGHT_BRAND`] || process.env[`${prefix}${themeName}DARK_BRAND`] ? getMultiThemeColorConfigEnv(prefix + themeName) : getSingleThemeColorConfigEnv(prefix + themeName);
 };
 var getSingleThemeColorConfigEnv = (prefix) => {
+  const gradient = [];
+  if (process.env[`${prefix}GRADIENT_START`] && process.env[`${prefix}GRADIENT_END`]) {
+    gradient.push(
+      process.env[`${prefix}GRADIENT_START`],
+      process.env[`${prefix}GRADIENT_END`]
+    );
+  } else if (process.env[`${prefix}GRADIENT_0`] || process.env[`${prefix}GRADIENT_1`]) {
+    let index = process.env[`${prefix}GRADIENT_0`] ? 0 : 1;
+    while (process.env[`${prefix}GRADIENT_${index}`]) {
+      gradient.push(process.env[`${prefix}GRADIENT_${index}`]);
+      index++;
+    }
+  }
   return {
     dark: process.env[`${prefix}DARK`],
     light: process.env[`${prefix}LIGHT`],
@@ -254,7 +645,8 @@ var getSingleThemeColorConfigEnv = (prefix) => {
     danger: process.env[`${prefix}DANGER`],
     fatal: process.env[`${prefix}FATAL`],
     positive: process.env[`${prefix}POSITIVE`],
-    negative: process.env[`${prefix}NEGATIVE`]
+    negative: process.env[`${prefix}NEGATIVE`],
+    gradient
   };
 };
 var getMultiThemeColorConfigEnv = (prefix) => {
@@ -266,6 +658,19 @@ var getMultiThemeColorConfigEnv = (prefix) => {
   };
 };
 var getBaseThemeColorConfigEnv = (prefix) => {
+  const gradient = [];
+  if (process.env[`${prefix}GRADIENT_START`] && process.env[`${prefix}GRADIENT_END`]) {
+    gradient.push(
+      process.env[`${prefix}GRADIENT_START`],
+      process.env[`${prefix}GRADIENT_END`]
+    );
+  } else if (process.env[`${prefix}GRADIENT_0`] || process.env[`${prefix}GRADIENT_1`]) {
+    let index = process.env[`${prefix}GRADIENT_0`] ? 0 : 1;
+    while (process.env[`${prefix}GRADIENT_${index}`]) {
+      gradient.push(process.env[`${prefix}GRADIENT_${index}`]);
+      index++;
+    }
+  }
   return {
     foreground: process.env[`${prefix}FOREGROUND`],
     background: process.env[`${prefix}BACKGROUND`],
@@ -280,7 +685,8 @@ var getBaseThemeColorConfigEnv = (prefix) => {
     danger: process.env[`${prefix}DANGER`],
     fatal: process.env[`${prefix}FATAL`],
     positive: process.env[`${prefix}POSITIVE`],
-    negative: process.env[`${prefix}NEGATIVE`]
+    negative: process.env[`${prefix}NEGATIVE`],
+    gradient
   };
 };
 
@@ -411,11 +817,12 @@ var setConfigEnv = (config) => {
     process.env[`${prefix}TIMEZONE`] = config.timezone;
     process.env.TZ = config.timezone;
     process.env.DEFAULT_TIMEZONE = config.timezone;
+    process.env.TIMEZONE = config.timezone;
   }
   if (config.locale) {
     process.env[`${prefix}LOCALE`] = config.locale;
-    process.env.LOCALE = config.locale;
     process.env.DEFAULT_LOCALE = config.locale;
+    process.env.LOCALE = config.locale;
     process.env.LANG = config.locale ? `${config.locale.replaceAll("-", "_")}.UTF-8` : "en_US.UTF-8";
   }
   if (config.configFile) {
@@ -576,6 +983,11 @@ var setSingleThemeColorConfigEnv = (prefix, config) => {
   if (config.negative) {
     process.env[`${prefix}NEGATIVE`] = config.negative;
   }
+  if (config.gradient) {
+    for (let i = 0; i < config.gradient.length; i++) {
+      process.env[`${prefix}GRADIENT_${i}`] = config.gradient[i];
+    }
+  }
 };
 var setMultiThemeColorConfigEnv = (prefix, config) => {
   return {
@@ -626,6 +1038,11 @@ var setBaseThemeColorConfigEnv = (prefix, config) => {
   if (config.negative) {
     process.env[`${prefix}NEGATIVE`] = config.negative;
   }
+  if (config.gradient) {
+    for (let i = 0; i < config.gradient.length; i++) {
+      process.env[`${prefix}GRADIENT_${i}`] = config.gradient[i];
+    }
+  }
 };
 
 // ../config-tools/src/create-storm-config.ts
@@ -733,6 +1150,7 @@ var getWorkspaceConfig = (skipLogs = true, options = {}) => {
 };
 
 export {
+  stormWorkspaceConfigSchema,
   getConfig,
   getWorkspaceConfig
 };