@storm-software/config 1.110.6 → 1.112.0

package/dist/schema.js

@@ -8,13 +8,14 @@ import {
   RegistryConfigSchema,
   RegistryUrlConfigSchema,
   SingleThemeColorConfigSchema,
-  StormConfigSchema,
   WorkspaceAccountConfigSchema,
   WorkspaceBotConfigSchema,
   WorkspaceDirectoryConfigSchema,
-  WorkspaceReleaseConfigSchema
-} from "./chunk-FWJ7T4PW.js";
-import "./chunk-HODJMVAD.js";
+  WorkspaceReleaseConfigSchema,
+  errorConfigSchema,
+  stormWorkspaceConfigSchema
+} from "./chunk-CIOGSYBE.js";
+import "./chunk-JXP4TNRB.js";
 import "./chunk-SHUYVCID.js";
 export {
   ColorConfigMapSchema,
@@ -26,9 +27,10 @@ export {
   RegistryConfigSchema,
   RegistryUrlConfigSchema,
   SingleThemeColorConfigSchema,
-  StormConfigSchema,
   WorkspaceAccountConfigSchema,
   WorkspaceBotConfigSchema,
   WorkspaceDirectoryConfigSchema,
-  WorkspaceReleaseConfigSchema
+  WorkspaceReleaseConfigSchema,
+  errorConfigSchema,
+  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.112.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/presets/base.json

@@ -12,6 +12,9 @@
   "directories": {
     "build": "dist"
   },
+  "error": {
+    "codesFile": "errors/codes.json"
+  },
   "externalPackagePatterns": ["@storm-software/"],
   "registry": {
     "github": "https://npm.pkg.github.com",

package/schemas/storm-workspace.schema.json

@@ -174,6 +174,23 @@
           "additionalProperties": false,
           "description": "The workspace's account config used to store various social media links"
         },
+        "error": {
+          "type": "object",
+          "properties": {
+            "codesFile": {
+              "type": "string",
+              "default": "https://public.storm-cdn.com/brand-banner.png",
+              "description": "The path to the workspace's error codes JSON file"
+            },
+            "url": {
+              "type": "string",
+              "format": "uri",
+              "description": "A URL to a page that looks up the workspace's error messages given a specific error code"
+            }
+          },
+          "additionalProperties": false,
+          "description": "The workspace's error config used during the error process"
+        },
         "mode": {
           "type": "string",
           "enum": ["development", "staging", "production"],
@@ -557,7 +574,14 @@
           "description": "Configuration of each used extension"
         }
       },
-      "required": ["bot", "release", "account", "directories", "colors"],
+      "required": [
+        "bot",
+        "release",
+        "account",
+        "error",
+        "directories",
+        "colors"
+      ],
       "additionalProperties": false,
       "description": "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/src/constants.d.ts

@@ -11,3 +11,4 @@ export declare const STORM_DEFAULT_ACCOUNT_SLACK = "https://join.slack.com/t/sto
 export declare const STORM_DEFAULT_ACCOUNT_MEDIUM = "https://medium.com/storm-software";
 export declare const STORM_DEFAULT_ACCOUNT_GITHUB = "https://github.com/storm-software";
 export declare const STORM_DEFAULT_RELEASE_FOOTER = "\nStorm 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.\n\nJoin us on [Discord](https://discord.gg/MQ6YVzakM5) to chat with the team, receive release notifications, ask questions, and get involved.\n\nIf this sounds interesting, and you would like to help us in creating the next generation of development tools, please reach out on our [website](https://stormsoftware.com/contact) or join our [Slack](https://join.slack.com/t/storm-software/shared_invite/zt-2gsmk04hs-i6yhK_r6urq0dkZYAwq2pA) channel!\n";
+export declare const STORM_DEFAULT_ERROR_CODES_FILE = "errors/codes.json";

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;
@@ -23,6 +23,10 @@ export declare const defineConfig: (input: StormConfigInput) => {
         slack?: string | undefined;
         medium?: string | undefined;
     };
+    error: {
+        codesFile?: string | undefined;
+        url?: string | undefined;
+    };
     directories: {
         cache?: string | undefined;
         data?: string | undefined;
@@ -199,7 +203,7 @@ export declare const defineConfig: (input: StormConfigInput) => {
     packageManager?: "npm" | "yarn" | "pnpm" | "bun" | undefined;
     timezone?: string | undefined;
     locale?: string | undefined;
-    logLevel?: "success" | "info" | "fatal" | "silent" | "error" | "warn" | "debug" | "trace" | "all" | undefined;
+    logLevel?: "success" | "info" | "fatal" | "error" | "silent" | "warn" | "debug" | "trace" | "all" | undefined;
     skipConfigLogging?: boolean | undefined;
     registry?: {
         github?: string | undefined;

package/src/schema.d.ts

@@ -1104,10 +1104,20 @@ export declare const WorkspaceDirectoryConfigSchema: z.ZodObject<{
     log?: string | undefined;
     build?: string | undefined;
 }>;
+export declare const errorConfigSchema: z.ZodObject<{
+    codesFile: z.ZodDefault<z.ZodString>;
+    url: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    codesFile: string;
+    url?: string | undefined;
+}, {
+    codesFile?: string | undefined;
+    url?: string | undefined;
+}>;
 /**
  * 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>;
@@ -1167,6 +1177,16 @@ export declare const StormConfigSchema: z.ZodObject<{
         slack?: string | undefined;
         medium?: string | undefined;
     }>;
+    error: z.ZodObject<{
+        codesFile: z.ZodDefault<z.ZodString>;
+        url: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        codesFile: string;
+        url?: string | undefined;
+    }, {
+        codesFile?: string | undefined;
+        url?: string | undefined;
+    }>;
     mode: z.ZodDefault<z.ZodEnum<["development", "staging", "production"]>>;
     workspaceRoot: z.ZodDefault<z.ZodString>;
     externalPackagePatterns: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
@@ -1960,6 +1980,10 @@ export declare const StormConfigSchema: z.ZodObject<{
         slack: string;
         medium: string;
     };
+    error: {
+        codesFile: string;
+        url?: string | undefined;
+    };
     mode: "development" | "staging" | "production";
     workspaceRoot: string;
     externalPackagePatterns: string[];
@@ -1975,7 +1999,7 @@ export declare const StormConfigSchema: z.ZodObject<{
     packageManager: "npm" | "yarn" | "pnpm" | "bun";
     timezone: string;
     locale: string;
-    logLevel: "success" | "info" | "fatal" | "silent" | "error" | "warn" | "debug" | "trace" | "all";
+    logLevel: "success" | "info" | "fatal" | "error" | "silent" | "warn" | "debug" | "trace" | "all";
     registry: {
         github?: string | undefined;
         npm?: string | undefined;
@@ -2157,6 +2181,10 @@ export declare const StormConfigSchema: z.ZodObject<{
         slack?: string | undefined;
         medium?: string | undefined;
     };
+    error: {
+        codesFile?: string | undefined;
+        url?: string | undefined;
+    };
     directories: {
         cache?: string | undefined;
         data?: string | undefined;
@@ -2333,7 +2361,7 @@ export declare const StormConfigSchema: z.ZodObject<{
     packageManager?: "npm" | "yarn" | "pnpm" | "bun" | undefined;
     timezone?: string | undefined;
     locale?: string | undefined;
-    logLevel?: "success" | "info" | "fatal" | "silent" | "error" | "warn" | "debug" | "trace" | "all" | undefined;
+    logLevel?: "success" | "info" | "fatal" | "error" | "silent" | "warn" | "debug" | "trace" | "all" | undefined;
     skipConfigLogging?: boolean | undefined;
     registry?: {
         github?: string | undefined;

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 {};