@smooai/config 2.0.0

package/dist/config/config.d.mts

@@ -0,0 +1,178 @@
+import { UnionToUpperSnake } from '../utils/index.mjs';
+import { StandardSchemaV1 } from '@standard-schema/spec';
+import { z } from 'zod';
+
+type DeepPartial<T> = T extends object ? {
+    [P in keyof T]?: DeepPartial<T[P]>;
+} : T;
+/**
+ * Symbol used to indicate a string schema type in the configuration.
+ * This is used to distinguish between string configurations and structured configurations.
+ */
+declare const StringSchema: unique symbol;
+type StringSchema = typeof StringSchema;
+declare const BooleanSchema: unique symbol;
+type BooleanSchema = typeof BooleanSchema;
+declare const NumberSchema: unique symbol;
+type NumberSchema = typeof NumberSchema;
+type ConfigSchema<K extends string | number | symbol = string> = Record<K, StringSchema | BooleanSchema | NumberSchema | StandardSchemaV1>;
+type OutputType<E> = E extends StringSchema ? string : E extends BooleanSchema ? boolean : E extends NumberSchema ? number : E extends StandardSchemaV1 ? StandardSchemaV1.InferOutput<E> : never;
+type InputType<E> = E extends StringSchema ? string : E extends BooleanSchema ? boolean : E extends NumberSchema ? number : E extends StandardSchemaV1 ? StandardSchemaV1.InferInput<E> : never;
+type OuputTypeWithDeferFunctions<S extends ConfigSchema, E> = E extends StringSchema ? string | ((config: SchemaOutput<S>) => string) : E extends BooleanSchema ? boolean | ((config: SchemaOutput<S>) => boolean) : E extends NumberSchema ? number | ((config: SchemaOutput<S>) => number) : E extends StandardSchemaV1 ? StandardSchemaV1.InferInput<E> | ((config: SchemaOutput<S>) => DeepPartial<StandardSchemaV1.InferInput<E>>) : never;
+type InputTypeWithDeferFunctions<S extends ConfigSchema, E> = E extends StringSchema ? string | ((config: SchemaInput<S>) => string) : E extends BooleanSchema ? boolean | ((config: SchemaInput<S>) => boolean) : E extends NumberSchema ? number | ((config: SchemaInput<S>) => number) : E extends StandardSchemaV1 ? StandardSchemaV1.InferInput<E> | ((config: SchemaInput<S>) => DeepPartial<StandardSchemaV1.InferInput<E>>) : never;
+type SchemaOutput<T extends ConfigSchema> = {
+    [K in keyof T]?: OutputType<T[K]>;
+};
+type SchemaInput<T extends ConfigSchema> = {
+    [K in keyof T]?: InputType<T[K]>;
+};
+type SchemaOutputWithDeferFunctions<T extends ConfigSchema> = {
+    [K in keyof T]?: OuputTypeWithDeferFunctions<T, T[K]>;
+};
+type SchemaInputWithDeferFunctions<T extends ConfigSchema> = {
+    [K in keyof T]?: InputTypeWithDeferFunctions<T, T[K]>;
+};
+type ZodOutputTypeRecord<T extends ConfigSchema> = {
+    [K in keyof T]: z.ZodType<OutputType<T[K]>>;
+};
+type ZodOutputType<T extends ConfigSchema> = z.ZodObject<ZodOutputTypeRecord<T>>;
+type ZodOutputTypeWithDeferFunctionsRecord<T extends ConfigSchema> = {
+    [K in keyof T]: z.ZodType<OuputTypeWithDeferFunctions<T, T[K]>>;
+};
+type ZodOutputTypeWithDeferFunctions<T extends ConfigSchema> = z.ZodObject<ZodOutputTypeWithDeferFunctionsRecord<T>>;
+type SeralizedConfigSchema<K extends string | number | symbol = string> = Record<K, 'stringSchema' | 'booleanSchema' | 'numberSchema' | any>;
+declare function serializeConfigSchema<T extends ConfigSchema>(configSchema: T): ZodOutputType<T>;
+declare function deserializeConfigSchema<T extends SeralizedConfigSchema>(configSchema: T): ConfigSchema<string>;
+declare function generateConfigSchema<T extends ConfigSchema>(configSchema: T): {
+    object: z.ZodObject<{ -readonly [P in keyof ZodOutputTypeRecord<T>]: ZodOutputTypeRecord<T>[P]; }, z.core.$strip>;
+    objectWithDeferFunctions: z.ZodObject<{ -readonly [P_1 in keyof ZodOutputTypeWithDeferFunctionsRecord<T>]: ZodOutputTypeWithDeferFunctionsRecord<T>[P_1]; }, z.core.$strip>;
+};
+type ParsedConfigGeneric = Record<string, string | ((config: Record<string, any>) => string) | boolean | ((config: Record<string, any>) => boolean) | number | ((config: Record<string, any>) => number) | StandardSchemaV1.InferOutput<StandardSchemaV1> | ((config: Record<string, any>) => StandardSchemaV1.InferOutput<StandardSchemaV1>)>;
+declare function defineConfig<Pub extends ConfigSchema, Sec extends ConfigSchema, FF extends ConfigSchema>({ publicConfigSchema, secretConfigSchema, featureFlagSchema, }: {
+    publicConfigSchema?: Pub | undefined;
+    secretConfigSchema?: Sec | undefined;
+    featureFlagSchema?: FF | undefined;
+}): {
+    AllConfigKeys: ConfigSchema<"ENV" | "IS_LOCAL" | "REGION" | "CLOUD_PROVIDER" | keyof Pub> & Sec & FF extends infer T extends Record<string, any> ? { [K in keyof T as UnionToUpperSnake<K & string>]: K & string; } : never;
+    PublicConfigKeys: ConfigSchema<"ENV" | "IS_LOCAL" | "REGION" | "CLOUD_PROVIDER" | keyof Pub> extends infer T_1 extends Record<string, any> ? { [K_1 in keyof T_1 as UnionToUpperSnake<K_1 & string>]: K_1 & string; } : never;
+    SecretConfigKeys: { [K_2 in keyof Sec as UnionToUpperSnake<K_2 & string>]: K_2 & string; };
+    FeatureFlagKeys: { [K_3 in keyof FF as UnionToUpperSnake<K_3 & string>]: K_3 & string; };
+    serializedAllConfigSchema: ZodOutputType<ConfigSchema<"ENV" | "IS_LOCAL" | "REGION" | "CLOUD_PROVIDER" | keyof Pub | keyof Sec | keyof FF>>;
+    _configTypeInput: SchemaInputWithDeferFunctions<Pub & Sec & FF>;
+    _configTypeOutput: SchemaOutputWithDeferFunctions<{
+        ENV: StringSchema;
+        CLOUD_PROVIDER: StringSchema;
+        REGION: StringSchema;
+        IS_LOCAL: BooleanSchema;
+    } & Pub & Sec & FF>;
+    _configType: SchemaOutput<{
+        ENV: StringSchema;
+        CLOUD_PROVIDER: StringSchema;
+        REGION: StringSchema;
+        IS_LOCAL: BooleanSchema;
+    } & Pub & Sec & FF>;
+    _zodOutputType: ZodOutputType<{
+        ENV: StringSchema;
+        CLOUD_PROVIDER: StringSchema;
+        REGION: StringSchema;
+        IS_LOCAL: BooleanSchema;
+    } & Pub & Sec & FF>;
+    _zodOutputTypeWithDeferFunctions: ZodOutputTypeWithDeferFunctions<{
+        ENV: StringSchema;
+        CLOUD_PROVIDER: StringSchema;
+        REGION: StringSchema;
+        IS_LOCAL: BooleanSchema;
+    } & Pub & Sec & FF>;
+};
+/**
+ * Infers the TypeScript types from a configuration definition.
+ * This utility type extracts the configuration keys and type helpers from a configuration definition created by defineConfig.
+ *
+ * @returns An object containing:
+ *   - AllConfigKeys: Type of all configuration keys
+ *   - PublicConfigKeys: Type of public configuration keys
+ *   - SecretConfigKeys: Type of secret configuration keys
+ *   - FeatureFlagKeys: Type of feature flag keys
+ *   - ConfigTypeInput: Type helper for input configuration
+ *   - ConfigTypeOutput: Type helper for output configuration
+ *   - ConfigType: Type helper for configuration
+ *   - ZodOutputType: Type helper for Zod output
+ *   - ZodOutputTypeWithDeferFunctions: Type helper for Zod output with defer functions
+ *
+ * @example
+ * // Define a configuration
+ * const config = defineConfig({
+ *   publicConfigSchema: {
+ *     apiUrl: StringSchema,
+ *     debugMode: BooleanSchema
+ *   },
+ *   secretConfigSchema: {
+ *     apiKey: StringSchema
+ *   },
+ *   featureFlagSchema: {
+ *     enableNewUI: BooleanSchema
+ *   }
+ * });
+ *
+ * // Infer types from the configuration
+ * type ConfigTypes = InferConfigTypes<typeof config>;
+ *
+ * // Now you can use the inferred types:
+ * type AllKeys = ConfigTypes['AllConfigKeys'];  // { API_URL: 'apiUrl', DEBUG_MODE: 'debugMode', API_KEY: 'apiKey', ENABLE_NEW_UI: 'enableNewUI' }
+ * type PublicKeys = ConfigTypes['PublicConfigKeys'];  // { API_URL: 'apiUrl', DEBUG_MODE: 'debugMode' }
+ * type SecretKeys = ConfigTypes['SecretConfigKeys'];  // { API_KEY: 'apiKey' }
+ * type FeatureFlags = ConfigTypes['FeatureFlagKeys']; // { ENABLE_NEW_UI: 'enableNewUI' }
+ *
+ * // Type helpers for configuration
+ * type InputConfig = ConfigTypes['ConfigTypeInput'];
+ * type OutputConfig = ConfigTypes['ConfigTypeOutput'];
+ * type ConfigType = ConfigTypes['ConfigType'];
+ * type ZodOutput = ConfigTypes['ZodOutputType'];
+ * type ZodOutputWithDefer = ConfigTypes['ZodOutputTypeWithDeferFunctions'];
+ *
+ * @example
+ * // Using with structured configuration
+ * const config = defineConfig({
+ *   publicConfigSchema: {
+ *     database: {
+ *       '~standard': z.object({
+ *         host: z.string(),
+ *         port: z.number()
+ *       })
+ *     }
+ *   }
+ * });
+ *
+ * type ConfigTypes = InferConfigTypes<typeof config>;
+ *
+ * // Type helpers for structured configuration
+ * type InputConfig = ConfigTypes['ConfigTypeInput'];
+ * type OutputConfig = ConfigTypes['ConfigTypeOutput'];
+ * type ConfigType = ConfigTypes['ConfigType'];
+ * type ZodOutput = ConfigTypes['ZodOutputType'];
+ * type ZodOutputWithDefer = ConfigTypes['ZodOutputTypeWithDeferFunctions'];
+ */
+type InferConfigTypes<T> = T extends {
+    AllConfigKeys: infer AK;
+    PublicConfigKeys: infer PK;
+    SecretConfigKeys: infer SK;
+    FeatureFlagKeys: infer FK;
+    serializedAllConfigSchema: infer _SACS;
+    _configType: infer CT;
+    _configTypeInput: infer CIT;
+    _configTypeOutput: infer COT;
+    _zodOutputType: infer ZOT;
+    _zodOutputTypeWithDeferFunctions: infer ZOTDF;
+} ? {
+    AllConfigKeys: AK;
+    PublicConfigKeys: PK;
+    SecretConfigKeys: SK;
+    FeatureFlagKeys: FK;
+    ConfigTypeInput: CIT;
+    ConfigTypeOutput: COT;
+    ConfigType: CT;
+    ZodOutputType: ZOT;
+    ZodOutputTypeWithDeferFunctions: ZOTDF;
+} : never;
+
+export { BooleanSchema, type InferConfigTypes, NumberSchema, type ParsedConfigGeneric, StringSchema, defineConfig, deserializeConfigSchema, generateConfigSchema, serializeConfigSchema };

package/dist/config/config.d.ts

@@ -0,0 +1,178 @@
+import { UnionToUpperSnake } from '../utils/index.js';
+import { StandardSchemaV1 } from '@standard-schema/spec';
+import { z } from 'zod';
+
+type DeepPartial<T> = T extends object ? {
+    [P in keyof T]?: DeepPartial<T[P]>;
+} : T;
+/**
+ * Symbol used to indicate a string schema type in the configuration.
+ * This is used to distinguish between string configurations and structured configurations.
+ */
+declare const StringSchema: unique symbol;
+type StringSchema = typeof StringSchema;
+declare const BooleanSchema: unique symbol;
+type BooleanSchema = typeof BooleanSchema;
+declare const NumberSchema: unique symbol;
+type NumberSchema = typeof NumberSchema;
+type ConfigSchema<K extends string | number | symbol = string> = Record<K, StringSchema | BooleanSchema | NumberSchema | StandardSchemaV1>;
+type OutputType<E> = E extends StringSchema ? string : E extends BooleanSchema ? boolean : E extends NumberSchema ? number : E extends StandardSchemaV1 ? StandardSchemaV1.InferOutput<E> : never;
+type InputType<E> = E extends StringSchema ? string : E extends BooleanSchema ? boolean : E extends NumberSchema ? number : E extends StandardSchemaV1 ? StandardSchemaV1.InferInput<E> : never;
+type OuputTypeWithDeferFunctions<S extends ConfigSchema, E> = E extends StringSchema ? string | ((config: SchemaOutput<S>) => string) : E extends BooleanSchema ? boolean | ((config: SchemaOutput<S>) => boolean) : E extends NumberSchema ? number | ((config: SchemaOutput<S>) => number) : E extends StandardSchemaV1 ? StandardSchemaV1.InferInput<E> | ((config: SchemaOutput<S>) => DeepPartial<StandardSchemaV1.InferInput<E>>) : never;
+type InputTypeWithDeferFunctions<S extends ConfigSchema, E> = E extends StringSchema ? string | ((config: SchemaInput<S>) => string) : E extends BooleanSchema ? boolean | ((config: SchemaInput<S>) => boolean) : E extends NumberSchema ? number | ((config: SchemaInput<S>) => number) : E extends StandardSchemaV1 ? StandardSchemaV1.InferInput<E> | ((config: SchemaInput<S>) => DeepPartial<StandardSchemaV1.InferInput<E>>) : never;
+type SchemaOutput<T extends ConfigSchema> = {
+    [K in keyof T]?: OutputType<T[K]>;
+};
+type SchemaInput<T extends ConfigSchema> = {
+    [K in keyof T]?: InputType<T[K]>;
+};
+type SchemaOutputWithDeferFunctions<T extends ConfigSchema> = {
+    [K in keyof T]?: OuputTypeWithDeferFunctions<T, T[K]>;
+};
+type SchemaInputWithDeferFunctions<T extends ConfigSchema> = {
+    [K in keyof T]?: InputTypeWithDeferFunctions<T, T[K]>;
+};
+type ZodOutputTypeRecord<T extends ConfigSchema> = {
+    [K in keyof T]: z.ZodType<OutputType<T[K]>>;
+};
+type ZodOutputType<T extends ConfigSchema> = z.ZodObject<ZodOutputTypeRecord<T>>;
+type ZodOutputTypeWithDeferFunctionsRecord<T extends ConfigSchema> = {
+    [K in keyof T]: z.ZodType<OuputTypeWithDeferFunctions<T, T[K]>>;
+};
+type ZodOutputTypeWithDeferFunctions<T extends ConfigSchema> = z.ZodObject<ZodOutputTypeWithDeferFunctionsRecord<T>>;
+type SeralizedConfigSchema<K extends string | number | symbol = string> = Record<K, 'stringSchema' | 'booleanSchema' | 'numberSchema' | any>;
+declare function serializeConfigSchema<T extends ConfigSchema>(configSchema: T): ZodOutputType<T>;
+declare function deserializeConfigSchema<T extends SeralizedConfigSchema>(configSchema: T): ConfigSchema<string>;
+declare function generateConfigSchema<T extends ConfigSchema>(configSchema: T): {
+    object: z.ZodObject<{ -readonly [P in keyof ZodOutputTypeRecord<T>]: ZodOutputTypeRecord<T>[P]; }, z.core.$strip>;
+    objectWithDeferFunctions: z.ZodObject<{ -readonly [P_1 in keyof ZodOutputTypeWithDeferFunctionsRecord<T>]: ZodOutputTypeWithDeferFunctionsRecord<T>[P_1]; }, z.core.$strip>;
+};
+type ParsedConfigGeneric = Record<string, string | ((config: Record<string, any>) => string) | boolean | ((config: Record<string, any>) => boolean) | number | ((config: Record<string, any>) => number) | StandardSchemaV1.InferOutput<StandardSchemaV1> | ((config: Record<string, any>) => StandardSchemaV1.InferOutput<StandardSchemaV1>)>;
+declare function defineConfig<Pub extends ConfigSchema, Sec extends ConfigSchema, FF extends ConfigSchema>({ publicConfigSchema, secretConfigSchema, featureFlagSchema, }: {
+    publicConfigSchema?: Pub | undefined;
+    secretConfigSchema?: Sec | undefined;
+    featureFlagSchema?: FF | undefined;
+}): {
+    AllConfigKeys: ConfigSchema<"ENV" | "IS_LOCAL" | "REGION" | "CLOUD_PROVIDER" | keyof Pub> & Sec & FF extends infer T extends Record<string, any> ? { [K in keyof T as UnionToUpperSnake<K & string>]: K & string; } : never;
+    PublicConfigKeys: ConfigSchema<"ENV" | "IS_LOCAL" | "REGION" | "CLOUD_PROVIDER" | keyof Pub> extends infer T_1 extends Record<string, any> ? { [K_1 in keyof T_1 as UnionToUpperSnake<K_1 & string>]: K_1 & string; } : never;
+    SecretConfigKeys: { [K_2 in keyof Sec as UnionToUpperSnake<K_2 & string>]: K_2 & string; };
+    FeatureFlagKeys: { [K_3 in keyof FF as UnionToUpperSnake<K_3 & string>]: K_3 & string; };
+    serializedAllConfigSchema: ZodOutputType<ConfigSchema<"ENV" | "IS_LOCAL" | "REGION" | "CLOUD_PROVIDER" | keyof Pub | keyof Sec | keyof FF>>;
+    _configTypeInput: SchemaInputWithDeferFunctions<Pub & Sec & FF>;
+    _configTypeOutput: SchemaOutputWithDeferFunctions<{
+        ENV: StringSchema;
+        CLOUD_PROVIDER: StringSchema;
+        REGION: StringSchema;
+        IS_LOCAL: BooleanSchema;
+    } & Pub & Sec & FF>;
+    _configType: SchemaOutput<{
+        ENV: StringSchema;
+        CLOUD_PROVIDER: StringSchema;
+        REGION: StringSchema;
+        IS_LOCAL: BooleanSchema;
+    } & Pub & Sec & FF>;
+    _zodOutputType: ZodOutputType<{
+        ENV: StringSchema;
+        CLOUD_PROVIDER: StringSchema;
+        REGION: StringSchema;
+        IS_LOCAL: BooleanSchema;
+    } & Pub & Sec & FF>;
+    _zodOutputTypeWithDeferFunctions: ZodOutputTypeWithDeferFunctions<{
+        ENV: StringSchema;
+        CLOUD_PROVIDER: StringSchema;
+        REGION: StringSchema;
+        IS_LOCAL: BooleanSchema;
+    } & Pub & Sec & FF>;
+};
+/**
+ * Infers the TypeScript types from a configuration definition.
+ * This utility type extracts the configuration keys and type helpers from a configuration definition created by defineConfig.
+ *
+ * @returns An object containing:
+ *   - AllConfigKeys: Type of all configuration keys
+ *   - PublicConfigKeys: Type of public configuration keys
+ *   - SecretConfigKeys: Type of secret configuration keys
+ *   - FeatureFlagKeys: Type of feature flag keys
+ *   - ConfigTypeInput: Type helper for input configuration
+ *   - ConfigTypeOutput: Type helper for output configuration
+ *   - ConfigType: Type helper for configuration
+ *   - ZodOutputType: Type helper for Zod output
+ *   - ZodOutputTypeWithDeferFunctions: Type helper for Zod output with defer functions
+ *
+ * @example
+ * // Define a configuration
+ * const config = defineConfig({
+ *   publicConfigSchema: {
+ *     apiUrl: StringSchema,
+ *     debugMode: BooleanSchema
+ *   },
+ *   secretConfigSchema: {
+ *     apiKey: StringSchema
+ *   },
+ *   featureFlagSchema: {
+ *     enableNewUI: BooleanSchema
+ *   }
+ * });
+ *
+ * // Infer types from the configuration
+ * type ConfigTypes = InferConfigTypes<typeof config>;
+ *
+ * // Now you can use the inferred types:
+ * type AllKeys = ConfigTypes['AllConfigKeys'];  // { API_URL: 'apiUrl', DEBUG_MODE: 'debugMode', API_KEY: 'apiKey', ENABLE_NEW_UI: 'enableNewUI' }
+ * type PublicKeys = ConfigTypes['PublicConfigKeys'];  // { API_URL: 'apiUrl', DEBUG_MODE: 'debugMode' }
+ * type SecretKeys = ConfigTypes['SecretConfigKeys'];  // { API_KEY: 'apiKey' }
+ * type FeatureFlags = ConfigTypes['FeatureFlagKeys']; // { ENABLE_NEW_UI: 'enableNewUI' }
+ *
+ * // Type helpers for configuration
+ * type InputConfig = ConfigTypes['ConfigTypeInput'];
+ * type OutputConfig = ConfigTypes['ConfigTypeOutput'];
+ * type ConfigType = ConfigTypes['ConfigType'];
+ * type ZodOutput = ConfigTypes['ZodOutputType'];
+ * type ZodOutputWithDefer = ConfigTypes['ZodOutputTypeWithDeferFunctions'];
+ *
+ * @example
+ * // Using with structured configuration
+ * const config = defineConfig({
+ *   publicConfigSchema: {
+ *     database: {
+ *       '~standard': z.object({
+ *         host: z.string(),
+ *         port: z.number()
+ *       })
+ *     }
+ *   }
+ * });
+ *
+ * type ConfigTypes = InferConfigTypes<typeof config>;
+ *
+ * // Type helpers for structured configuration
+ * type InputConfig = ConfigTypes['ConfigTypeInput'];
+ * type OutputConfig = ConfigTypes['ConfigTypeOutput'];
+ * type ConfigType = ConfigTypes['ConfigType'];
+ * type ZodOutput = ConfigTypes['ZodOutputType'];
+ * type ZodOutputWithDefer = ConfigTypes['ZodOutputTypeWithDeferFunctions'];
+ */
+type InferConfigTypes<T> = T extends {
+    AllConfigKeys: infer AK;
+    PublicConfigKeys: infer PK;
+    SecretConfigKeys: infer SK;
+    FeatureFlagKeys: infer FK;
+    serializedAllConfigSchema: infer _SACS;
+    _configType: infer CT;
+    _configTypeInput: infer CIT;
+    _configTypeOutput: infer COT;
+    _zodOutputType: infer ZOT;
+    _zodOutputTypeWithDeferFunctions: infer ZOTDF;
+} ? {
+    AllConfigKeys: AK;
+    PublicConfigKeys: PK;
+    SecretConfigKeys: SK;
+    FeatureFlagKeys: FK;
+    ConfigTypeInput: CIT;
+    ConfigTypeOutput: COT;
+    ConfigType: CT;
+    ZodOutputType: ZOT;
+    ZodOutputTypeWithDeferFunctions: ZOTDF;
+} : never;
+
+export { BooleanSchema, type InferConfigTypes, NumberSchema, type ParsedConfigGeneric, StringSchema, defineConfig, deserializeConfigSchema, generateConfigSchema, serializeConfigSchema };