@storm-software/config 1.79.0 → 1.91.1

package/schemas/storm.schema.json

@@ -5,18 +5,28 @@
       "type": "object",
       "properties": {
         "$schema": {
-          "type": "string",
-          "default": "https://cdn.jsdelivr.net/npm/@storm-software/config/schemas/storm.schema.json",
+          "anyOf": [
+            {
+              "anyOf": [
+                {
+                  "not": {}
+                },
+                {
+                  "type": "string",
+                  "default": "https://cdn.jsdelivr.net/npm/@storm-software/config/schemas/storm.schema.json"
+                }
+              ]
+            },
+            {
+              "type": "null"
+            }
+          ],
           "description": "The URL to the JSON schema file that describes the Storm configuration file"
         },
         "extends": {
           "type": "string",
           "description": "The path to a base JSON file to use as a configuration preset file"
         },
-        "isRoot": {
-          "type": "boolean",
-          "description": "A flag indicating if the current configuration is the set in the root of the workspace"
-        },
         "name": {
           "type": "string",
           "description": "The name of the service/package/scope using this configuration"
@@ -72,12 +82,25 @@
           "default": "@storm-software/admin",
           "description": "The owner of the package"
         },
-        "worker": {
-          "type": "string",
-          "default": "Stormie-Bot",
-          "description": "The worker of the package (this is the bot that will be used to perform various tasks)"
+        "bot": {
+          "type": "object",
+          "properties": {
+            "name": {
+              "type": "string",
+              "default": "Stormie-Bot",
+              "description": "The workspace bot user's name (this is the bot that will be used to perform various tasks)"
+            },
+            "email": {
+              "type": "string",
+              "format": "email",
+              "default": "bot@stormsoftware.com",
+              "description": "The email of the workspace bot"
+            }
+          },
+          "additionalProperties": false,
+          "description": "The workspace's bot user's config used to automated various operations tasks"
         },
-        "envName": {
+        "env": {
           "type": "string",
           "enum": ["development", "staging", "production"],
           "default": "production",
@@ -88,10 +111,6 @@
           "default": "",
           "description": "The root directory of the workspace"
         },
-        "packageDirectory": {
-          "type": "string",
-          "description": "The root directory of the package"
-        },
         "externalPackagePatterns": {
           "type": "array",
           "items": {
@@ -105,41 +124,37 @@
           "default": false,
           "description": "Should all known types of workspace caching be skipped?"
         },
-        "cacheDirectory": {
-          "type": "string",
-          "description": "The directory used to store the environment's cached file data"
-        },
-        "dataDirectory": {
-          "type": "string",
-          "description": "The directory used to store the environment's data files"
-        },
-        "configDirectory": {
-          "type": "string",
-          "description": "The directory used to store the environment's configuration files"
-        },
-        "tempDirectory": {
-          "type": "string",
-          "description": "The directory used to store the environment's temp files"
-        },
-        "logDirectory": {
-          "type": "string",
-          "description": "The directory used to store the environment's temp files"
-        },
-        "buildDirectory": {
-          "type": "string",
-          "default": "dist",
-          "description": "The build directory for the workspace"
-        },
-        "outputDirectory": {
-          "type": "string",
-          "default": "node_modules/.storm",
-          "description": "The runtime directory of Storm"
-        },
-        "runtimeVersion": {
-          "type": "string",
-          "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$",
-          "default": "1.0.0",
-          "description": "The global version of the Storm runtime"
+        "directories": {
+          "type": "object",
+          "properties": {
+            "cache": {
+              "type": "string",
+              "description": "The directory used to store the environment's cached file data"
+            },
+            "data": {
+              "type": "string",
+              "description": "The directory used to store the environment's data files"
+            },
+            "config": {
+              "type": "string",
+              "description": "The directory used to store the environment's configuration files"
+            },
+            "temp": {
+              "type": "string",
+              "description": "The directory used to store the environment's temp files"
+            },
+            "log": {
+              "type": "string",
+              "description": "The directory used to store the environment's temp files"
+            },
+            "build": {
+              "type": "string",
+              "default": "dist",
+              "description": "The directory used to store the workspace's distributable files after a build (relative to the workspace root)"
+            }
+          },
+          "additionalProperties": false,
+          "description": "Various directories used by the workspace to store data, cache, and configuration files"
         },
         "packageManager": {
           "type": "string",
@@ -172,21 +187,6 @@
           "default": "info",
           "description": "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`)."
         },
-        "cloudflareAccountId": {
-          "anyOf": [
-            {
-              "type": "string",
-              "minLength": 32,
-              "maxLength": 32,
-              "pattern": "^([0-9a-fA-F]{32})$"
-            },
-            {
-              "type": "null"
-            }
-          ],
-          "default": null,
-          "description": "The default Cloudflare account ID of the workspace"
-        },
         "registry": {
           "type": "object",
           "properties": {
@@ -478,7 +478,7 @@
           "description": "Configuration of each used extension"
         }
       },
-      "required": ["colors"],
+      "required": ["bot", "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

@@ -1,3 +1,4 @@
 export declare const STORM_DEFAULT_DOCS = "https://docs.stormsoftware.com";
 export declare const STORM_DEFAULT_HOMEPAGE = "https://stormsoftware.com";
 export declare const STORM_DEFAULT_LICENSING = "https://license.stormsoftware.com";
+export declare const STORM_DEFAULT_LICENSE = "Apache-2.0";

package/src/define-config.d.ts

@@ -6,6 +6,18 @@ import type { StormConfigInput } from "./types";
  * @returns The config values for the current Storm workspace
  */
 export declare const defineConfig: (input: StormConfigInput) => {
+    bot: {
+        name?: string | undefined;
+        email?: string | undefined;
+    };
+    directories: {
+        cache?: string | undefined;
+        data?: string | undefined;
+        config?: string | undefined;
+        temp?: string | undefined;
+        log?: string | undefined;
+        build?: string | undefined;
+    };
     colors: {
         dark: {
             foreground?: string | undefined;
@@ -153,10 +165,9 @@ export declare const defineConfig: (input: StormConfigInput) => {
         dark?: string | undefined;
         light?: string | undefined;
     }>;
-    $schema?: string | undefined;
-    extends?: string | undefined;
-    isRoot?: boolean | undefined;
     name?: string | undefined;
+    $schema?: string | null | undefined;
+    extends?: string | undefined;
     namespace?: string | undefined;
     organization?: string | undefined;
     repository?: string | undefined;
@@ -167,25 +178,14 @@ export declare const defineConfig: (input: StormConfigInput) => {
     branch?: string | undefined;
     preid?: string | undefined;
     owner?: string | undefined;
-    worker?: string | undefined;
-    envName?: "development" | "staging" | "production" | undefined;
+    env?: "development" | "staging" | "production" | undefined;
     workspaceRoot?: string | undefined;
-    packageDirectory?: string | undefined;
     externalPackagePatterns?: string[] | undefined;
     skipCache?: boolean | undefined;
-    cacheDirectory?: string | undefined;
-    dataDirectory?: string | undefined;
-    configDirectory?: string | undefined;
-    tempDirectory?: string | undefined;
-    logDirectory?: string | undefined;
-    buildDirectory?: string | undefined;
-    outputDirectory?: string | undefined;
-    runtimeVersion?: string | undefined;
     packageManager?: "npm" | "yarn" | "pnpm" | "bun" | undefined;
     timezone?: string | undefined;
     locale?: string | undefined;
     logLevel?: "info" | "fatal" | "silent" | "error" | "warn" | "debug" | "trace" | "all" | undefined;
-    cloudflareAccountId?: string | null | undefined;
     registry?: {
         github?: string | undefined;
         npm?: string | undefined;

package/src/schema.d.ts

@@ -1036,13 +1036,44 @@ export declare const ColorConfigMapSchema: z.ZodUnion<[z.ZodObject<{
         negative?: string | undefined;
     };
 }>]>>]>;
+export declare const WorkspaceBotConfigSchema: z.ZodObject<{
+    name: z.ZodDefault<z.ZodString>;
+    email: z.ZodDefault<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    email: string;
+}, {
+    name?: string | undefined;
+    email?: string | undefined;
+}>;
+export declare const WorkspaceDirectoryConfigSchema: z.ZodObject<{
+    cache: z.ZodOptional<z.ZodString>;
+    data: z.ZodOptional<z.ZodString>;
+    config: z.ZodOptional<z.ZodString>;
+    temp: z.ZodOptional<z.ZodString>;
+    log: z.ZodOptional<z.ZodString>;
+    build: z.ZodDefault<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    build: string;
+    cache?: string | undefined;
+    data?: string | undefined;
+    config?: string | undefined;
+    temp?: string | undefined;
+    log?: string | undefined;
+}, {
+    cache?: string | undefined;
+    data?: string | undefined;
+    config?: string | undefined;
+    temp?: string | undefined;
+    log?: string | undefined;
+    build?: 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<{
-    $schema: z.ZodDefault<z.ZodString>;
+    $schema: z.ZodOptional<z.ZodNullable<z.ZodOptional<z.ZodDefault<z.ZodString>>>>;
     extends: z.ZodOptional<z.ZodString>;
-    isRoot: z.ZodOptional<z.ZodBoolean>;
     name: z.ZodOptional<z.ZodString>;
     namespace: z.ZodOptional<z.ZodString>;
     organization: z.ZodDefault<z.ZodString>;
@@ -1054,25 +1085,46 @@ export declare const StormConfigSchema: z.ZodObject<{
     branch: z.ZodDefault<z.ZodString>;
     preid: z.ZodOptional<z.ZodString>;
     owner: z.ZodDefault<z.ZodString>;
-    worker: z.ZodDefault<z.ZodString>;
-    envName: z.ZodDefault<z.ZodEnum<["development", "staging", "production"]>>;
+    bot: z.ZodObject<{
+        name: z.ZodDefault<z.ZodString>;
+        email: z.ZodDefault<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        email: string;
+    }, {
+        name?: string | undefined;
+        email?: string | undefined;
+    }>;
+    env: z.ZodDefault<z.ZodEnum<["development", "staging", "production"]>>;
     workspaceRoot: z.ZodDefault<z.ZodString>;
-    packageDirectory: z.ZodOptional<z.ZodString>;
     externalPackagePatterns: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
     skipCache: z.ZodDefault<z.ZodBoolean>;
-    cacheDirectory: z.ZodOptional<z.ZodString>;
-    dataDirectory: z.ZodOptional<z.ZodString>;
-    configDirectory: z.ZodOptional<z.ZodString>;
-    tempDirectory: z.ZodOptional<z.ZodString>;
-    logDirectory: z.ZodOptional<z.ZodString>;
-    buildDirectory: z.ZodDefault<z.ZodString>;
-    outputDirectory: z.ZodDefault<z.ZodString>;
-    runtimeVersion: z.ZodDefault<z.ZodString>;
+    directories: z.ZodObject<{
+        cache: z.ZodOptional<z.ZodString>;
+        data: z.ZodOptional<z.ZodString>;
+        config: z.ZodOptional<z.ZodString>;
+        temp: z.ZodOptional<z.ZodString>;
+        log: z.ZodOptional<z.ZodString>;
+        build: z.ZodDefault<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        build: string;
+        cache?: string | undefined;
+        data?: string | undefined;
+        config?: string | undefined;
+        temp?: string | undefined;
+        log?: string | undefined;
+    }, {
+        cache?: string | undefined;
+        data?: string | undefined;
+        config?: string | undefined;
+        temp?: string | undefined;
+        log?: string | undefined;
+        build?: string | undefined;
+    }>;
     packageManager: z.ZodDefault<z.ZodEnum<["npm", "yarn", "pnpm", "bun"]>>;
     timezone: z.ZodDefault<z.ZodString>;
     locale: z.ZodDefault<z.ZodString>;
     logLevel: z.ZodDefault<z.ZodEnum<["silent", "fatal", "error", "warn", "info", "debug", "trace", "all"]>>;
-    cloudflareAccountId: z.ZodDefault<z.ZodNullable<z.ZodString>>;
     registry: z.ZodDefault<z.ZodObject<{
         github: z.ZodOptional<z.ZodString>;
         npm: z.ZodOptional<z.ZodString>;
@@ -1810,7 +1862,6 @@ export declare const StormConfigSchema: z.ZodObject<{
     }>]>>]>]>;
     extensions: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
 }, "strip", z.ZodTypeAny, {
-    $schema: string;
     organization: string;
     license: string;
     homepage: string;
@@ -1818,19 +1869,26 @@ export declare const StormConfigSchema: z.ZodObject<{
     licensing: string;
     branch: string;
     owner: string;
-    worker: string;
-    envName: "development" | "staging" | "production";
+    bot: {
+        name: string;
+        email: string;
+    };
+    env: "development" | "staging" | "production";
     workspaceRoot: string;
     externalPackagePatterns: string[];
     skipCache: boolean;
-    buildDirectory: string;
-    outputDirectory: string;
-    runtimeVersion: string;
+    directories: {
+        build: string;
+        cache?: string | undefined;
+        data?: string | undefined;
+        config?: string | undefined;
+        temp?: string | undefined;
+        log?: string | undefined;
+    };
     packageManager: "npm" | "yarn" | "pnpm" | "bun";
     timezone: string;
     locale: string;
     logLevel: "info" | "fatal" | "silent" | "error" | "warn" | "debug" | "trace" | "all";
-    cloudflareAccountId: string | null;
     registry: {
         github?: string | undefined;
         npm?: string | undefined;
@@ -1987,19 +2045,25 @@ export declare const StormConfigSchema: z.ZodObject<{
         fatal?: string | undefined;
     }>;
     extensions: Record<string, any>;
-    extends?: string | undefined;
-    isRoot?: boolean | undefined;
     name?: string | undefined;
+    $schema?: string | null | undefined;
+    extends?: string | undefined;
     namespace?: string | undefined;
     repository?: string | undefined;
     preid?: string | undefined;
-    packageDirectory?: string | undefined;
-    cacheDirectory?: string | undefined;
-    dataDirectory?: string | undefined;
-    configDirectory?: string | undefined;
-    tempDirectory?: string | undefined;
-    logDirectory?: string | undefined;
 }, {
+    bot: {
+        name?: string | undefined;
+        email?: string | undefined;
+    };
+    directories: {
+        cache?: string | undefined;
+        data?: string | undefined;
+        config?: string | undefined;
+        temp?: string | undefined;
+        log?: string | undefined;
+        build?: string | undefined;
+    };
     colors: {
         dark: {
             foreground?: string | undefined;
@@ -2147,10 +2211,9 @@ export declare const StormConfigSchema: z.ZodObject<{
         dark?: string | undefined;
         light?: string | undefined;
     }>;
-    $schema?: string | undefined;
-    extends?: string | undefined;
-    isRoot?: boolean | undefined;
     name?: string | undefined;
+    $schema?: string | null | undefined;
+    extends?: string | undefined;
     namespace?: string | undefined;
     organization?: string | undefined;
     repository?: string | undefined;
@@ -2161,25 +2224,14 @@ export declare const StormConfigSchema: z.ZodObject<{
     branch?: string | undefined;
     preid?: string | undefined;
     owner?: string | undefined;
-    worker?: string | undefined;
-    envName?: "development" | "staging" | "production" | undefined;
+    env?: "development" | "staging" | "production" | undefined;
     workspaceRoot?: string | undefined;
-    packageDirectory?: string | undefined;
     externalPackagePatterns?: string[] | undefined;
     skipCache?: boolean | undefined;
-    cacheDirectory?: string | undefined;
-    dataDirectory?: string | undefined;
-    configDirectory?: string | undefined;
-    tempDirectory?: string | undefined;
-    logDirectory?: string | undefined;
-    buildDirectory?: string | undefined;
-    outputDirectory?: string | undefined;
-    runtimeVersion?: string | undefined;
     packageManager?: "npm" | "yarn" | "pnpm" | "bun" | undefined;
     timezone?: string | undefined;
     locale?: string | undefined;
     logLevel?: "info" | "fatal" | "silent" | "error" | "warn" | "debug" | "trace" | "all" | undefined;
-    cloudflareAccountId?: string | null | undefined;
     registry?: {
         github?: string | undefined;
         npm?: string | undefined;

package/presets/bun.json

@@ -1,55 +0,0 @@
-{
-  "organization": "storm-software",
-  "owner": "@storm-software/admin",
-  "timezone": "America/New_York",
-  "locale": "en-US",
-  "logLevel": "info",
-  "skipCache": false,
-  "buildDirectory": "dist",
-  "outputDirectory": "node_modules/.storm",
-  "packageManager": "bun",
-  "externalPackagePatterns": ["@storm-software/"],
-  "registry": {
-    "github": "https://npm.pkg.github.com",
-    "npm": "https://registry.npmjs.org",
-    "cargo": "https://crates.io",
-    "cyclone": "https://registry.cyclone-ui.com/components",
-    "container": "https://hub.docker.com"
-  },
-  "colors": {
-    "light": {
-      "background": "#fafafa",
-      "foreground": "#1d1e22",
-      "brand": "#1fb2a6",
-      "alternate": "#db2777",
-      "help": "#5C4EE5",
-      "success": "#087f5b",
-      "info": "#0550ae",
-      "warning": "#e3b341",
-      "danger": "#a40e26",
-      "positive": "#22c55e",
-      "negative": "#dc2626"
-    },
-    "dark": {
-      "background": "#1d1e22",
-      "foreground": "#cbd5e1",
-      "brand": "#1fb2a6",
-      "alternate": "#db2777",
-      "help": "#818cf8",
-      "success": "#12B66A",
-      "info": "#0070E0",
-      "warning": "#f3d371",
-      "danger": "#D8314A",
-      "positive": "#22c55e",
-      "negative": "#dc2626"
-    }
-  },
-  "extensions": {
-    "telemetry": {
-      "fileName": "storm",
-      "fileExtension": "log",
-      "path": "tmp/storm/logs",
-      "stacktrace": true
-    }
-  }
-}

package/presets/pnpm.json

@@ -1,55 +0,0 @@
-{
-  "organization": "storm-software",
-  "owner": "@storm-software/admin",
-  "timezone": "America/New_York",
-  "locale": "en-US",
-  "logLevel": "info",
-  "skipCache": false,
-  "buildDirectory": "dist",
-  "outputDirectory": "node_modules/.storm",
-  "packageManager": "pnpm",
-  "externalPackagePatterns": ["@storm-software/"],
-  "registry": {
-    "github": "https://npm.pkg.github.com",
-    "npm": "https://registry.npmjs.org",
-    "cargo": "https://crates.io",
-    "cyclone": "https://registry.cyclone-ui.com/components",
-    "container": "https://hub.docker.com"
-  },
-  "colors": {
-    "light": {
-      "background": "#fafafa",
-      "foreground": "#1d1e22",
-      "brand": "#1fb2a6",
-      "alternate": "#db2777",
-      "help": "#5C4EE5",
-      "success": "#087f5b",
-      "info": "#0550ae",
-      "warning": "#e3b341",
-      "danger": "#a40e26",
-      "positive": "#22c55e",
-      "negative": "#dc2626"
-    },
-    "dark": {
-      "background": "#1d1e22",
-      "foreground": "#cbd5e1",
-      "brand": "#1fb2a6",
-      "alternate": "#db2777",
-      "help": "#818cf8",
-      "success": "#12B66A",
-      "info": "#0070E0",
-      "warning": "#f3d371",
-      "danger": "#D8314A",
-      "positive": "#22c55e",
-      "negative": "#dc2626"
-    }
-  },
-  "extensions": {
-    "telemetry": {
-      "fileName": "storm",
-      "fileExtension": "log",
-      "path": "tmp/storm/logs",
-      "stacktrace": true
-    }
-  }
-}