@storm-software/terraform-tools 0.1.0

package/packages/build-tools/src/types.d.ts

@@ -0,0 +1,213 @@
+import type Rolldown from "rolldown";
+import type { Plugin } from "rolldown";
+import type { Options } from "tsup";
+import type { Diagnostic, ParsedCommandLine, Program, SourceFile, TransformerFactory } from "typescript";
+import type { BuildOptions as UnbuildOptions, RollupBuildOptions as UnbuildRollupBuildOptions } from "unbuild";
+export interface TsupContext {
+    projectRoot: string;
+    sourceRoot: string;
+    projectName: string;
+    main: string;
+}
+export type BuildOptions = Options;
+export type Entry = string | string[] | Record<string, string>;
+export type GetConfigParams = Omit<TsupGetConfigOptions, "entry" | "assets" | "clean" | "outputPath" | "tsConfig" | "main"> & {
+    entry: Entry;
+    outDir: string;
+    projectRoot: string;
+    workspaceRoot: string;
+    tsconfig: string;
+    shims?: boolean;
+    apiReport?: boolean;
+    docModel?: boolean;
+    tsdocMetadata?: boolean;
+    dtsTsConfig: ParsedCommandLine;
+    getTransform?: (program: Program, diagnostics: Diagnostic[]) => TransformerFactory<SourceFile>;
+};
+export type TsupGetConfigOptions = Omit<TypeScriptBuildOptions, "banner" | "entry"> & {
+    banner?: {
+        js?: string;
+        css?: string;
+    };
+    dtsTsConfig: ParsedCommandLine;
+    entry: Entry;
+};
+export type Platform = "browser" | "node" | "neutral";
+export type FileInputOutput = {
+    input: string;
+    output: string;
+};
+export type AssetGlob = FileInputOutput & {
+    glob: string;
+    ignore?: string[];
+    dot?: boolean;
+};
+export interface AdditionalCLIOptions {
+    projectRoot: string;
+    sourceRoot: string;
+    projectName: string;
+}
+export interface TypeScriptBuildOptions extends AdditionalCLIOptions {
+    additionalEntryPoints?: string[];
+    assets: (AssetGlob | string)[];
+    bundle?: boolean;
+    deleteOutputPath?: boolean;
+    esbuildOptions?: Record<string, any>;
+    esbuildConfig?: string;
+    external?: string[];
+    outputFileName?: string;
+    outputHashing?: "none" | "all";
+    outputPath: string;
+    platform?: "node" | "browser" | "neutral" | "worker";
+    sourcemap?: boolean | "linked" | "inline" | "external" | "both";
+    target?: string;
+    tsConfig: string;
+    watch?: boolean;
+    entry: string;
+    options?: Options;
+    clean?: boolean;
+    debug?: boolean;
+    banner?: string;
+    verbose?: boolean;
+    define?: Record<string, string | undefined | null>;
+    env?: Record<string, string | undefined | null>;
+    apiReport?: boolean;
+    docModel?: boolean;
+    tsdocMetadata?: boolean;
+    includeSrc?: boolean;
+    plugins?: any[];
+    shims?: boolean;
+    splitting?: boolean;
+    treeshake?: boolean;
+    generatePackageJson?: boolean;
+    emitOnAll?: boolean;
+    getConfig: (params: GetConfigParams) => Options;
+    format?: string[];
+    metafile?: boolean;
+    minify?: boolean;
+    skipNativeModulesPlugin?: boolean;
+    useJsxModule?: boolean;
+}
+export type RolldownFormat = "cjs" | "es";
+export declare const RolldownFormat: {
+    COMMONJS: RolldownFormat;
+    ES_MODULE: RolldownFormat;
+};
+export type IsExternal = (source: string, importer: string | undefined, isResolved: boolean) => boolean;
+export type RolldownResolveOptions = Omit<BindingResolveOptions, "alias"> & {
+    alias?: Record<string, string>;
+};
+export interface BindingResolveOptions {
+    alias?: Record<string, string[]>;
+    aliasFields?: string[][];
+    conditionNames?: string[];
+    exportsFields?: string[][];
+    extensions?: string[];
+    mainFields?: string[];
+    mainFiles?: string[];
+    modules?: string[];
+    symlinks?: boolean;
+    tsconfigFilename?: string;
+}
+export interface RenderedModule {
+    readonly code: string | null;
+    originalLength: number;
+    removedExports: string[];
+    renderedExports: string[];
+    renderedLength: number;
+}
+export interface PreRenderedChunk {
+    exports: string[];
+    facadeModuleId: string | null;
+    isDynamicEntry: boolean;
+    isEntry: boolean;
+    isImplicitEntry: boolean;
+    moduleIds: string[];
+    name: string;
+    type: "chunk";
+}
+export interface RenderedChunk extends PreRenderedChunk {
+    dynamicImports: string[];
+    fileName: string;
+    implicitlyLoadedBefore: string[];
+    importedBindings: {
+        [imported: string]: string[];
+    };
+    imports: string[];
+    modules: {
+        [id: string]: RenderedModule;
+    };
+    referencedFiles: string[];
+}
+type InputOption = string | string[] | {
+    [entryAlias: string]: string;
+};
+export interface InputOptions {
+    input?: InputOption;
+    plugins?: Plugin[];
+    external?: IsExternal;
+    resolve?: RolldownResolveOptions;
+    cwd: string;
+    platform: Platform;
+    treeshake: boolean;
+}
+export interface OutputOptions extends Rolldown.OutputOptions {
+    dir?: string;
+    format?: "es";
+    exports?: "default" | "named" | "none" | "auto";
+    sourcemap?: boolean | "inline" | "hidden";
+    banner?: string | ((chunk: RenderedChunk) => string | Promise<string>);
+    footer?: string | ((chunk: RenderedChunk) => string | Promise<string>);
+}
+export interface RolldownBuildOptions extends InputOptions {
+    output?: OutputOptions;
+}
+export type RolldownUserDefinedConfig = string | RolldownBuildOptions | ((config: RolldownBuildOptions) => RolldownBuildOptions | Promise<RolldownBuildOptions>);
+export type RolldownOptions = AdditionalCLIOptions & {
+    clean: boolean;
+    watch: boolean;
+    entry: string;
+    additionalEntryPoints?: string[];
+    assets: (AssetGlob | string)[];
+    generatePackageJson: boolean;
+    includeSrc: boolean;
+    banner?: OutputOptions["banner"];
+    footer?: OutputOptions["footer"];
+    outputPath: string;
+    skipTypeCheck: boolean;
+    verbose: boolean;
+    tsConfig: string;
+    minify: boolean;
+    treeshake: boolean;
+    extractCss: boolean;
+    sourcemap?: OutputOptions["sourcemap"];
+    exports?: OutputOptions["exports"];
+    platform: InputOptions["platform"];
+    resolve: InputOptions["resolve"];
+    external: InputOptions["external"];
+    plugins: Plugin[];
+    rolldownConfig?: RolldownUserDefinedConfig | RolldownUserDefinedConfig[];
+};
+export type DeepPartial<T> = T extends object ? {
+    [P in keyof T]?: DeepPartial<T[P]>;
+} : T;
+export type UnbuildBuildOptions = AdditionalCLIOptions & Omit<UnbuildOptions, "name" | "rootDir" | "entries" | "externals" | "outDir"> & {
+    clean: boolean;
+    watch: boolean;
+    verbose: boolean;
+    minify: boolean;
+    tsLibs: string[];
+    includeSrc: boolean;
+    generatePackageJson: boolean;
+    tsConfig: string;
+    outputPath: string;
+    entry?: string;
+    additionalEntryPoints?: string[];
+    external?: (string | RegExp)[];
+    assets: (AssetGlob | string)[];
+    banner?: OutputOptions["banner"];
+    footer?: OutputOptions["footer"];
+    rollupConfig?: DeepPartial<UnbuildRollupBuildOptions> | string;
+    configPath?: string;
+};
+export {};

package/packages/build-tools/src/utils/apply-default-options.d.ts

@@ -0,0 +1,6 @@
+import type { StormConfig } from "@storm-software/config";
+import type { TypeScriptBuildOptions } from "../../declarations";
+import type { RolldownOptions, UnbuildBuildOptions } from "../types";
+export declare const applyDefaultOptions: (options: Partial<any>, config?: StormConfig) => TypeScriptBuildOptions;
+export declare const applyDefaultRolldownOptions: (options: Partial<RolldownOptions>, config?: StormConfig) => RolldownOptions;
+export declare const applyDefaultUnbuildOptions: (options: Partial<UnbuildBuildOptions>, config?: StormConfig) => UnbuildBuildOptions;

package/packages/build-tools/src/utils/generate-package-json.d.ts

@@ -0,0 +1,7 @@
+import type { ProjectConfiguration, ProjectGraph } from "@nx/devkit";
+import type { StormConfig } from "@storm-software/config";
+import type { TypeScriptBuildOptions } from "../../declarations";
+export declare const generatePackageJson: (config: StormConfig, projectRoot: string, sourceRoot: string, projectName: string, options: TypeScriptBuildOptions) => Promise<Record<string, any>>;
+export declare const formatPackageJson: (config: StormConfig, projectRoot: string, sourceRoot: string, projectName: string, options: Pick<TypeScriptBuildOptions, "tsConfig" | "external" | "generatePackageJson" | "bundle" | "includeSrc">, packageJson: Record<string, any>, projectGraph: ProjectGraph, projectsConfigurations: Record<string, ProjectConfiguration>) => Promise<Record<string, any>>;
+export declare const addWorkspacePackageJsonFields: (config: StormConfig, projectRoot: string, sourceRoot: string, projectName: string, includeSrc: boolean | undefined, packageJson: Record<string, any>) => Record<string, any>;
+export declare const addPackageJsonExports: (sourceRoot: string, packageJson: Record<string, any>) => Promise<Record<string, any>>;

package/packages/build-tools/src/utils/get-entry-points.d.ts

@@ -0,0 +1,3 @@
+import type { TypeScriptBuildOptions } from "../../declarations";
+import type { StormConfig } from "@storm-software/config";
+export declare const getEntryPoints: (config: StormConfig, projectRoot: string, sourceRoot: string, options: TypeScriptBuildOptions) => string[];

package/packages/build-tools/src/utils/get-file-banner.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Get a banner header to display at the top of a file
+ *
+ * @param name - The name to use in the display
+ * @param commentStart - The comment starting token
+ * @returns The banner header
+ */
+export declare const getFileBanner: (name: string, commentStart?: string) => string;

package/packages/build-tools/src/utils/get-project-deps.d.ts

@@ -0,0 +1,5 @@
+import type { ProjectGraph, ProjectGraphExternalNode, ProjectGraphProjectNode } from "@nx/devkit";
+import type { DependentBuildableProjectNode } from "@nx/js/src/utils/buildable-libs-utils.js";
+export declare function getExtraDependencies(projectName: string, graph: ProjectGraph): DependentBuildableProjectNode[];
+export declare function getInternalDependencies(projectName: string, graph: ProjectGraph): ProjectGraphProjectNode[];
+export declare function getExternalDependencies(projectName: string, graph: ProjectGraph): ProjectGraphExternalNode[];

package/packages/build-tools/src/utils/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./out-extension";
+export * from "./run-tsup-build";
+export * from "./apply-default-options";
+export * from "./generate-package-json";
+export * from "./get-project-deps";
+export * from "./get-file-banner";
+export * from "./task-graph";

package/packages/build-tools/src/utils/out-extension.d.ts

@@ -0,0 +1,6 @@
+export declare const outExtension: ({ format }: {
+    format?: string;
+}) => {
+    js: string;
+    dts: string;
+};

package/packages/build-tools/src/utils/run-tsup-build.d.ts

@@ -0,0 +1,3 @@
+import type { StormConfig } from "@storm-software/config";
+import type { TsupContext, TypeScriptBuildOptions } from "../types";
+export declare const runTsupBuild: (context: TsupContext, config: Partial<StormConfig>, options: TypeScriptBuildOptions) => Promise<void>;

package/packages/build-tools/src/utils/task-graph.d.ts

@@ -0,0 +1,6 @@
+import type { NxJsonConfiguration, TaskGraph, ProjectGraph } from "@nx/devkit";
+export declare function getAllWorkspaceTaskGraphs(nxJson: NxJsonConfiguration, projectGraph: ProjectGraph): {
+    taskGraphs: Record<string, TaskGraph>;
+    errors: Record<string, string>;
+};
+export declare function createTaskId(projectId: string, targetId: string, configurationId?: string): string;

package/packages/config/src/define-config.d.ts

@@ -0,0 +1,172 @@
+import type { StormConfigInput } 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) => {
+    colors: {
+        dark: {
+            foreground?: string | undefined;
+            background?: string | undefined;
+            brand?: string | undefined;
+            brand2?: string | undefined;
+            brand3?: string | undefined;
+            accent?: string | undefined;
+            help?: string | undefined;
+            success?: string | undefined;
+            info?: string | undefined;
+            warning?: string | undefined;
+            error?: string | undefined;
+            fatal?: string | undefined;
+        };
+        light: {
+            foreground?: string | undefined;
+            background?: string | undefined;
+            brand?: string | undefined;
+            brand2?: string | undefined;
+            brand3?: string | undefined;
+            accent?: string | undefined;
+            help?: string | undefined;
+            success?: string | undefined;
+            info?: string | undefined;
+            warning?: string | undefined;
+            error?: string | undefined;
+            fatal?: string | undefined;
+        };
+    } | {
+        brand?: string | undefined;
+        brand2?: string | undefined;
+        brand3?: string | undefined;
+        accent?: string | undefined;
+        help?: string | undefined;
+        success?: string | undefined;
+        info?: string | undefined;
+        warning?: string | undefined;
+        error?: string | undefined;
+        fatal?: string | undefined;
+        dark?: string | undefined;
+        light?: string | undefined;
+    } | {
+        base: {
+            dark: {
+                foreground?: string | undefined;
+                background?: string | undefined;
+                brand?: string | undefined;
+                brand2?: string | undefined;
+                brand3?: string | undefined;
+                accent?: string | undefined;
+                help?: string | undefined;
+                success?: string | undefined;
+                info?: string | undefined;
+                warning?: string | undefined;
+                error?: string | undefined;
+                fatal?: string | undefined;
+            };
+            light: {
+                foreground?: string | undefined;
+                background?: string | undefined;
+                brand?: string | undefined;
+                brand2?: string | undefined;
+                brand3?: string | undefined;
+                accent?: string | undefined;
+                help?: string | undefined;
+                success?: string | undefined;
+                info?: string | undefined;
+                warning?: string | undefined;
+                error?: string | undefined;
+                fatal?: string | undefined;
+            };
+        } | {
+            brand?: string | undefined;
+            brand2?: string | undefined;
+            brand3?: string | undefined;
+            accent?: string | undefined;
+            help?: string | undefined;
+            success?: string | undefined;
+            info?: string | undefined;
+            warning?: string | undefined;
+            error?: string | undefined;
+            fatal?: string | undefined;
+            dark?: string | undefined;
+            light?: string | undefined;
+        };
+    } | Record<string, {
+        dark: {
+            foreground?: string | undefined;
+            background?: string | undefined;
+            brand?: string | undefined;
+            brand2?: string | undefined;
+            brand3?: string | undefined;
+            accent?: string | undefined;
+            help?: string | undefined;
+            success?: string | undefined;
+            info?: string | undefined;
+            warning?: string | undefined;
+            error?: string | undefined;
+            fatal?: string | undefined;
+        };
+        light: {
+            foreground?: string | undefined;
+            background?: string | undefined;
+            brand?: string | undefined;
+            brand2?: string | undefined;
+            brand3?: string | undefined;
+            accent?: string | undefined;
+            help?: string | undefined;
+            success?: string | undefined;
+            info?: string | undefined;
+            warning?: string | undefined;
+            error?: string | undefined;
+            fatal?: string | undefined;
+        };
+    } | {
+        brand?: string | undefined;
+        brand2?: string | undefined;
+        brand3?: string | undefined;
+        accent?: string | undefined;
+        help?: string | undefined;
+        success?: string | undefined;
+        info?: string | undefined;
+        warning?: string | undefined;
+        error?: string | undefined;
+        fatal?: string | undefined;
+        dark?: string | undefined;
+        light?: string | undefined;
+    }>;
+    $schema?: string | undefined;
+    extends?: string | undefined;
+    name?: string | undefined;
+    namespace?: string | undefined;
+    organization?: string | undefined;
+    repository?: string | undefined;
+    license?: string | undefined;
+    homepage?: string | undefined;
+    branch?: string | undefined;
+    preid?: string | undefined;
+    owner?: string | undefined;
+    worker?: string | undefined;
+    env?: "development" | "staging" | "production" | undefined;
+    workspaceRoot?: string | undefined;
+    packageDirectory?: string | undefined;
+    externalPackagePatterns?: string[] | undefined;
+    skipCache?: boolean | undefined;
+    cacheDirectory?: 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" | "error" | "fatal" | "silent" | "warn" | "debug" | "trace" | "all" | undefined;
+    cloudflareAccountId?: string | null | undefined;
+    registry?: {
+        github?: string | undefined;
+        npm?: string | undefined;
+        cargo?: string | undefined;
+        cyclone?: string | undefined;
+    } | undefined;
+    configFile?: string | null | undefined;
+    extensions?: Record<string, any> | undefined;
+};

package/packages/config/src/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * The config-schema library used by Storm Software for building TypeScript applications.
+ *
+ * @remarks
+ * A package containing various utilities to support custom workspace configurations
+ *
+ * @packageDocumentation
+ */
+export * from "./schema";
+export * from "./types";
+export * from "./define-config";