@storm-software/config 1.115.0 → 1.116.0

package/src/types.ts

@@ -0,0 +1,96 @@
+import type z from "zod";
+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>;
+export type LightThemeColorConfigInput = z.input<
+  typeof LightThemeColorConfigSchema
+>;
+
+export type MultiThemeColorConfig = z.infer<typeof MultiThemeColorConfigSchema>;
+export type MultiThemeColorConfigInput = z.input<
+  typeof MultiThemeColorConfigSchema
+>;
+
+export type SingleThemeColorConfig = z.infer<
+  typeof SingleThemeColorConfigSchema
+>;
+export type SingleThemeColorConfigInput = z.input<
+  typeof SingleThemeColorConfigSchema
+>;
+
+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 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 const COLOR_KEYS = [
+  "dark",
+  "light",
+  "base",
+  "brand",
+  "alternate",
+  "accent",
+  "link",
+  "success",
+  "help",
+  "info",
+  "warning",
+  "danger",
+  "fatal",
+  "positive",
+  "negative"
+];

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "rootDir": "../..",
+    "target": "ESNext",
+    "module": "ESNext",
+    "lib": ["ESNext"],
+    "skipLibCheck": true,
+    "skipDefaultLibCheck": true,
+    "moduleResolution": "Bundler",
+    "moduleDetection": "force",
+    "types": ["node"]
+  },
+  "include": ["src/**/*.ts", "bin/**/*.ts", "tsup.config.ts"],
+  "exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"]
+}

package/tsconfig.spec.json

@@ -0,0 +1,14 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "module": "commonjs",
+    "types": ["jest", "node"]
+  },
+  "include": [
+    "jest.config.ts",
+    "src/**/*.test.ts",
+    "src/**/*.spec.ts",
+    "src/**/*.d.ts"
+  ]
+}

package/tsup.config.ts

@@ -0,0 +1,18 @@
+import { defineConfig } from "tsup";
+
+export default defineConfig([
+  {
+    name: "config",
+    target: "esnext",
+    entryPoints: ["./src/*.ts"],
+    format: ["cjs", "esm"],
+    outDir: "dist",
+    platform: "neutral",
+    splitting: true,
+    clean: false,
+    dts: true,
+    sourcemap: false,
+    tsconfig: "./tsconfig.json",
+    shims: true,
+  },
+]);

package/src/constants.d.ts

@@ -1,14 +0,0 @@
-export declare const STORM_DEFAULT_DOCS = "https://docs.stormsoftware.com";
-export declare const STORM_DEFAULT_HOMEPAGE = "https://stormsoftware.com";
-export declare const STORM_DEFAULT_CONTACT = "https://stormsoftware.com/contact";
-export declare const STORM_DEFAULT_LICENSING = "https://license.stormsoftware.com";
-export declare const STORM_DEFAULT_LICENSE = "Apache-2.0";
-export declare const STORM_DEFAULT_RELEASE_BANNER = "https://public.storm-cdn.com/brand-banner.png";
-export declare const STORM_DEFAULT_ACCOUNT_TWITTER = "StormSoftwareHQ";
-export declare const STORM_DEFAULT_ACCOUNT_DISCORD = "https://discord.gg/MQ6YVzakM5";
-export declare const STORM_DEFAULT_ACCOUNT_TELEGRAM = "https://t.me/storm_software";
-export declare const STORM_DEFAULT_ACCOUNT_SLACK = "https://join.slack.com/t/storm-software/shared_invite/zt-2gsmk04hs-i6yhK_r6urq0dkZYAwq2pA";
-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 = "tools/errors/codes.json";

package/src/define-config.d.ts

@@ -1,217 +0,0 @@
-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: StormWorkspaceConfigInput) => {
-    bot: {
-        name?: string | undefined;
-        email?: string | undefined;
-    };
-    release: {
-        banner?: string | undefined;
-        header?: string | undefined;
-        footer?: string | undefined;
-    };
-    account: {
-        github?: string | undefined;
-        twitter?: string | undefined;
-        discord?: string | undefined;
-        telegram?: string | undefined;
-        slack?: string | undefined;
-        medium?: string | undefined;
-    };
-    error: {
-        codesFile?: string | undefined;
-        url?: string | undefined;
-    };
-    workspaceRoot: string;
-    directories: {
-        cache?: string | undefined;
-        data?: string | undefined;
-        config?: string | undefined;
-        temp?: string | undefined;
-        log?: string | undefined;
-        build?: string | undefined;
-    };
-    colors: {
-        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;
-    } | {
-        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;
-            };
-        } | {
-            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;
-        };
-    } | Record<string, {
-        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;
-    namespace?: string | undefined;
-    organization?: string | undefined;
-    repository?: string | undefined;
-    license?: string | undefined;
-    homepage?: string | undefined;
-    docs?: string | undefined;
-    licensing?: string | undefined;
-    contact?: string | undefined;
-    branch?: string | undefined;
-    preid?: string | undefined;
-    owner?: string | undefined;
-    mode?: "development" | "staging" | "production" | undefined;
-    externalPackagePatterns?: string[] | undefined;
-    skipCache?: boolean | undefined;
-    packageManager?: "npm" | "yarn" | "pnpm" | "bun" | undefined;
-    timezone?: string | undefined;
-    locale?: string | undefined;
-    logLevel?: "success" | "info" | "fatal" | "error" | "silent" | "warn" | "debug" | "trace" | "all" | undefined;
-    skipConfigLogging?: boolean | undefined;
-    registry?: {
-        github?: string | undefined;
-        npm?: string | undefined;
-        cargo?: string | undefined;
-        cyclone?: string | undefined;
-        container?: string | undefined;
-    } | undefined;
-    configFile?: string | null | undefined;
-    extensions?: Record<string, any> | undefined;
-};