Skip to content

Commit

Permalink
feat(config-tools): Added the config-tools library to support storm c…
Browse files Browse the repository at this point in the history 
…onfiguration
  • Loading branch information
@sullivanpj
sullivanpj committed Dec 2, 2023
1 parent 671aaf5 commit 63f8b9e
Show file tree
Hide file tree
Showing 23 changed files with 3,162 additions and 446 deletions.
371 changes: 371 additions & 0 deletions docs/api-reports/packages/config-tools/api-report.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,371 @@
## API Report File for "@storm-software/config-tools"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { Infer } from "@decs/typeschema";
import { InferIn } from "@decs/typeschema";
import { Schema } from "@decs/typeschema";
import { TypeSchema } from "@decs/typeschema";
import * as z from "zod";

// @public (undocumented)
type ColorConfig = Infer<typeof ColorConfigSchema>;
export { ColorConfig };
export { ColorConfig as ColorConfig_alias_1 };

// @public (undocumented)
type ColorConfigInput = InferIn<typeof ColorConfigSchema>;
export { ColorConfigInput };
export { ColorConfigInput as ColorConfigInput_alias_1 };

// @public
const ColorConfigSchema: z.ZodObject<
{
primary: z.ZodDefault<z.ZodString>;
background: z.ZodDefault<z.ZodString>;
success: z.ZodDefault<z.ZodString>;
info: z.ZodDefault<z.ZodString>;
warning: z.ZodDefault<z.ZodString>;
error: z.ZodDefault<z.ZodString>;
fatal: z.ZodDefault<z.ZodString>;
},
"strip",
z.ZodTypeAny,
{
primary?: string;
background?: string;
success?: string;
info?: string;
warning?: string;
error?: string;
fatal?: string;
},
{
primary?: string;
background?: string;
success?: string;
info?: string;
warning?: string;
error?: string;
fatal?: string;
}
>;
export { ColorConfigSchema };
export { ColorConfigSchema as ColorConfigSchema_alias_1 };

// @public
const createConfigExtension: <TExtensionConfig = any>(
schema: Schema,
extensionName: string
) => Promise<TExtensionConfig>;
export { createConfigExtension };
export { createConfigExtension as createConfigExtension_alias_1 };

// @public
const createStormConfig: <
TModuleName extends string = string,
TModuleConfig = any
>(
schema?: Schema,
moduleName?: TModuleName
) => Promise<StormConfig<TModuleName, TModuleConfig>>;
export { createStormConfig };
export { createStormConfig as createStormConfig_alias_1 };

// @public
const DefaultColorConfig: ColorConfig;
export { DefaultColorConfig };
export { DefaultColorConfig as DefaultColorConfig_alias_1 };
export { DefaultColorConfig as DefaultColorConfig_alias_2 };

// @public
const DefaultStormConfig: Omit<StormConfig, "name">;
export { DefaultStormConfig };
export { DefaultStormConfig as DefaultStormConfig_alias_1 };
export { DefaultStormConfig as DefaultStormConfig_alias_2 };

// @public
const getConfigEnv: () => Partial<StormConfig>;
export { getConfigEnv };
export { getConfigEnv as getConfigEnv_alias_1 };
export { getConfigEnv as getConfigEnv_alias_2 };

// @public
const getConfigFile: () => Promise<Partial<StormConfigInput>>;
export { getConfigFile };
export { getConfigFile as getConfigFile_alias_1 };
export { getConfigFile as getConfigFile_alias_2 };

// @public
const getDefaultConfig: (config?: Partial<StormConfig>) => Promise<StormConfig>;
export { getDefaultConfig };
export { getDefaultConfig as getDefaultConfig_alias_1 };
export { getDefaultConfig as getDefaultConfig_alias_2 };

// @public
const getExtensionEnv: <
TConfig extends Record<string, any> = Record<string, any>
>(
extensionName: string
) => TConfig;
export { getExtensionEnv };
export { getExtensionEnv as getExtensionEnv_alias_1 };
export { getExtensionEnv as getExtensionEnv_alias_2 };

// @public
const setConfigEnv: (config: StormConfig) => void;
export { setConfigEnv };
export { setConfigEnv as setConfigEnv_alias_1 };
export { setConfigEnv as setConfigEnv_alias_2 };

// @public
const setExtensionEnv: <
TConfig extends Record<string, any> = Record<string, any>
>(
extensionName: string,
extension: TConfig
) => void;
export { setExtensionEnv };
export { setExtensionEnv as setExtensionEnv_alias_1 };
export { setExtensionEnv as setExtensionEnv_alias_2 };

// @public (undocumented)
type StormConfig<
TModuleName extends string = string,
TModuleConfig = any
> = TStormConfig & {
modules: Record<string, any> & {
[moduleName in TModuleName]: TModuleConfig;
};
};
export { StormConfig };
export { StormConfig as StormConfig_alias_1 };

// @public (undocumented)
type StormConfigInput = InferIn<typeof StormConfigSchema>;
export { StormConfigInput };
export { StormConfigInput as StormConfigInput_alias_1 };

// @public
const StormConfigSchema: z.ZodObject<
{
name: z.ZodString;
namespace: z.ZodDefault<z.ZodString>;
organization: z.ZodDefault<z.ZodString>;
repository: z.ZodOptional<z.ZodString>;
license: z.ZodDefault<z.ZodString>;
homepage: z.ZodDefault<z.ZodString>;
branch: z.ZodDefault<z.ZodString>;
preMajor: z.ZodDefault<z.ZodBoolean>;
owner: z.ZodDefault<z.ZodString>;
worker: z.ZodDefault<z.ZodString>;
env: z.ZodDefault<z.ZodEnum<["development", "staging", "production"]>>;
ci: z.ZodDefault<z.ZodBoolean>;
workspaceRoot: z.ZodString;
packageDirectory: z.ZodOptional<z.ZodString>;
buildDirectory: z.ZodOptional<z.ZodString>;
runtimeDirectory: z.ZodDefault<z.ZodString>;
runtimeVersion: z.ZodDefault<z.ZodString>;
timezone: z.ZodDefault<z.ZodString>;
locale: z.ZodDefault<z.ZodString>;
configFile: z.ZodDefault<z.ZodNullable<z.ZodString>>;
colors: z.ZodObject<
{
primary: z.ZodDefault<z.ZodString>;
background: z.ZodDefault<z.ZodString>;
success: z.ZodDefault<z.ZodString>;
info: z.ZodDefault<z.ZodString>;
warning: z.ZodDefault<z.ZodString>;
error: z.ZodDefault<z.ZodString>;
fatal: z.ZodDefault<z.ZodString>;
},
"strip",
z.ZodTypeAny,
{
primary?: string;
background?: string;
success?: string;
info?: string;
warning?: string;
error?: string;
fatal?: string;
},
{
primary?: string;
background?: string;
success?: string;
info?: string;
warning?: string;
error?: string;
fatal?: string;
}
>;
extensions: z.ZodRecord<z.ZodString, z.ZodAny>;
},
"strip",
z.ZodTypeAny,
{
name?: string;
namespace?: string;
organization?: string;
repository?: string;
license?: string;
homepage?: string;
branch?: string;
preMajor?: boolean;
owner?: string;
worker?: string;
env?: "development" | "staging" | "production";
ci?: boolean;
workspaceRoot?: string;
packageDirectory?: string;
buildDirectory?: string;
runtimeDirectory?: string;
runtimeVersion?: string;
timezone?: string;
locale?: string;
configFile?: string;
colors?: {
primary?: string;
background?: string;
success?: string;
info?: string;
warning?: string;
error?: string;
fatal?: string;
};
extensions?: Record<string, any>;
},
{
name?: string;
namespace?: string;
organization?: string;
repository?: string;
license?: string;
homepage?: string;
branch?: string;
preMajor?: boolean;
owner?: string;
worker?: string;
env?: "development" | "staging" | "production";
ci?: boolean;
workspaceRoot?: string;
packageDirectory?: string;
buildDirectory?: string;
runtimeDirectory?: string;
runtimeVersion?: string;
timezone?: string;
locale?: string;
configFile?: string;
colors?: {
primary?: string;
background?: string;
success?: string;
info?: string;
warning?: string;
error?: string;
fatal?: string;
};
extensions?: Record<string, any>;
}
>;
export { StormConfigSchema };
export { StormConfigSchema as StormConfigSchema_alias_1 };

// @public (undocumented)
const wrapped_ColorConfig: TypeSchema<
{
primary?: string;
background?: string;
success?: string;
info?: string;
warning?: string;
error?: string;
fatal?: string;
},
{
primary?: string;
background?: string;
success?: string;
info?: string;
warning?: string;
error?: string;
fatal?: string;
}
>;
export { wrapped_ColorConfig };
export { wrapped_ColorConfig as wrapped_ColorConfig_alias_1 };

// @public (undocumented)
const wrapped_StormConfig: TypeSchema<
{
name?: string;
namespace?: string;
organization?: string;
repository?: string;
license?: string;
homepage?: string;
branch?: string;
preMajor?: boolean;
owner?: string;
worker?: string;
env?: "development" | "staging" | "production";
ci?: boolean;
workspaceRoot?: string;
packageDirectory?: string;
buildDirectory?: string;
runtimeDirectory?: string;
runtimeVersion?: string;
timezone?: string;
locale?: string;
configFile?: string;
colors?: {
primary?: string;
background?: string;
success?: string;
info?: string;
warning?: string;
error?: string;
fatal?: string;
};
extensions?: Record<string, any>;
},
{
name?: string;
namespace?: string;
organization?: string;
repository?: string;
license?: string;
homepage?: string;
branch?: string;
preMajor?: boolean;
owner?: string;
worker?: string;
env?: "development" | "staging" | "production";
ci?: boolean;
workspaceRoot?: string;
packageDirectory?: string;
buildDirectory?: string;
runtimeDirectory?: string;
runtimeVersion?: string;
timezone?: string;
locale?: string;
configFile?: string;
colors?: {
primary?: string;
background?: string;
success?: string;
info?: string;
warning?: string;
error?: string;
fatal?: string;
};
extensions?: Record<string, any>;
}
>;
export { wrapped_StormConfig };
export { wrapped_StormConfig as wrapped_StormConfig_alias_1 };

// (No @packageDocumentation comment for this package)
```
Loading

0 comments on commit 63f8b9e

Please sign in to comment.