@codedrifters/configulator 0.0.86 → 0.0.88

package/lib/index.d.mts

@@ -0,0 +1,1311 @@
+import { Component, Project, typescript } from 'projen';
+import { AwsCdkTypeScriptApp } from 'projen/lib/awscdk';
+import { AwsStageType, DeploymentTargetRoleType, AwsEnvironmentType, AWS_STAGE_TYPE } from '@codedrifters/utils';
+import * as spec from '@jsii/spec';
+import { TypeScriptProject as TypeScriptProject$1, TypeScriptAppProject, TypeScriptProjectOptions as TypeScriptProjectOptions$1 } from 'projen/lib/typescript';
+import { ValueOf } from 'type-fest';
+import { NodeProject, UpgradeDependencies, UpgradeDependenciesOptions } from 'projen/lib/javascript';
+import { Component as Component$1, Project as Project$1, Task } from 'projen/lib';
+import { BuildWorkflowOptions, BuildWorkflow } from 'projen/lib/build';
+import { JobStep } from 'projen/lib/github/workflows-model';
+
+/*******************************************************************************
+ *
+ * Git configs for this repo. This venn diagram has a great deal of overlap
+ * with GitHub config options but is not a perfect circle.
+ *
+ ******************************************************************************/
+interface GitBranch {
+    /**
+     * The name of the branch pattern.
+     *
+     * @example "main" or "feature/*"
+     */
+    branch: string;
+    /**
+     * Description for this branch's purpose, used for generated documentation.
+     */
+    description?: Array<string>;
+}
+
+/*******************************************************************************
+ *
+ * AWS Deployment Configuration
+ *
+ * A single deployment target that CDK applications can be deployed into.
+ *
+ ******************************************************************************/
+/**
+ * Represents the configuration for local deployment in AWS.
+ */
+interface AwsLocalDeploymentConfig {
+    /**
+     * The AWS profile (in ~/.aws/config) to use for local deployment.
+     *
+     * @default generated dynamically based role name, account and region
+     */
+    readonly profile?: string;
+    /**
+     * Named Role used to conduct local deployments.
+     *
+     * @default "poweruseraccess"
+     */
+    readonly roleName?: string;
+    /**
+     * The pattern used to identify stacks to deploy in CI deployments.
+     *
+     * @default *-${account}-${region}
+     */
+    readonly stackPattern?: string;
+}
+interface CiDeploymentConfig {
+    /**
+     * The OIDC IAM Role to assume for CI deployments.
+     */
+    readonly roleArn: string;
+    /**
+     * The pattern used to identify stacks to deploy in CI deployments.
+     *
+     * @default *-${account}-${region}
+     */
+    readonly stackPattern?: string;
+}
+/**
+ * Represents a deployment target in AWS, including account and region, and
+ * branches allowed to deploy to this target.
+ */
+interface AwsDeploymentTargetOptions {
+    /**
+     * The account name for the deployment target.
+     */
+    readonly account: string;
+    /**
+     * The AWS region for the deployment target.
+     */
+    readonly region: string;
+    /**
+     * AWS deployment type, such as dev, stage, or prod.
+     *
+     * @default 'dev'
+     */
+    readonly awsStageType?: AwsStageType;
+    /**
+     * Deployment target role: whether this (account, region) is the primary or
+     * secondary deployment target (e.g. primary vs replica region).
+     *
+     * @default 'primary'
+     */
+    readonly deploymentTargetRole?: DeploymentTargetRoleType;
+    /**
+     * AWS environment type, such as primary or secondary.
+     *
+     * @deprecated Use `deploymentTargetRole` instead. This property is maintained for backward compatibility.
+     * @default 'primary'
+     */
+    readonly awsEnvironmentType?: AwsEnvironmentType;
+    /**
+     * The AWS profile to use for this deployment target.
+     *
+     * @default ['main'] when prod release type, ['feature/*'] when dev type
+     */
+    readonly branches?: Array<GitBranch>;
+    /**
+     * Can this deployment target be used for local development?
+     *
+     * @default true for dev environments, false for prod environments
+     */
+    readonly localDeployment?: boolean;
+    /**
+     * Configuration when deploying to this target locally.
+     */
+    readonly localDeploymentConfig?: AwsLocalDeploymentConfig;
+    /**
+     * Can this deployment target be used in CI deployments?
+     *
+     * @default false
+     */
+    readonly ciDeployment?: boolean;
+    readonly ciDeploymentConfig?: CiDeploymentConfig;
+}
+declare class AwsDeploymentTarget extends Component {
+    /**
+     * Static method to discovert targets in a project.
+     */
+    static of(project: AwsCdkTypeScriptApp): Array<AwsDeploymentTarget> | undefined;
+    /**
+     * The account name for the deployment target.
+     */
+    account: string;
+    /**
+     * The AWS region for the deployment target.
+     */
+    region: string;
+    /**'
+     * AWS stage type, such as dev, stage, or prod.
+     *
+     * @default 'dev'
+     */
+    awsStageType: AwsStageType;
+    /**
+     * Deployment target role: whether this (account, region) is the primary or
+     * secondary deployment target (e.g. primary vs replica region).
+     *
+     * @default 'primary'
+     */
+    deploymentTargetRole: DeploymentTargetRoleType;
+    /**
+     * AWS environment type, such as primary or secondary.
+     *
+     * @deprecated Use `deploymentTargetRole` instead. This property is maintained for backward compatibility.
+     * @default 'primary'
+     */
+    awsEnvironmentType: AwsEnvironmentType;
+    /**
+     * The AWS profile to use for this deployment target.
+     *
+     * @default ['main'] when prod release type, ['feature/*'] when dev type
+     */
+    branches: Array<GitBranch>;
+    /**
+     * Can this deployment target be used for local development?
+     *
+     * @default true for dev environments, false for prod environments
+     */
+    localDeployment?: boolean;
+    /**
+     * Configuration when deploying to this target locally.
+     */
+    localDeploymentConfig?: AwsLocalDeploymentConfig;
+    /**
+     * Can this deployment target be used in CI deployments?
+     *
+     * @default false
+     */
+    ciDeployment?: boolean;
+    ciDeploymentConfig?: Required<CiDeploymentConfig>;
+    /**
+     * Configuration for the CDK output directory for this deployment target.
+     */
+    awsDeploymentConfig: AwsDeploymentConfig;
+    constructor(project: AwsCdkTypeScriptApp, options: AwsDeploymentTargetOptions);
+    /*****************************************************************************
+     *
+     * Deploy Tasks
+     *
+     * - If local deploy, add a deploy task.
+     *
+     ****************************************************************************/
+    private configureDeployTask;
+    /*****************************************************************************
+     *
+     * Watch tasks
+     *
+     * - Configure watch task to use the branch name
+     * - configure watch task to use the correct synth output location.
+     *
+     ****************************************************************************/
+    private configureWatchTask;
+}
+
+/*******************************************************************************
+ *
+ * AWS Deployment Configuration
+ *
+ * This component allows configuration of multiple AWS deployment
+ * targets, each with its own account, region, and deployment type
+ * (dev, stage, prod). It supports both local and CI deployments,
+ * with customizable settings for each target.
+ *
+ ******************************************************************************/
+declare class AwsDeploymentConfig extends Component {
+    static of(project: AwsCdkTypeScriptApp): AwsDeploymentConfig | undefined;
+    /**
+     * Environment variables to be injected into all tasks.
+     */
+    readonly env: Record<string, string>;
+    /**
+     * The relative path to the project directory from the root of the project.
+     */
+    readonly projectPath: string;
+    /**
+     * The relative path to the root of the project from the output directory.
+     */
+    readonly rootPath: string;
+    /**
+     * The output directory for the CDK synthesis, from the root directory.
+     */
+    readonly rootCdkOut: string;
+    /**
+     * The output directory for the CDK synthesis.
+     */
+    readonly cdkOut: string;
+    /**
+     * Array of targets for deployment.
+     */
+    readonly awsDeploymentTargets: Array<AwsDeploymentTarget>;
+    constructor(project: AwsCdkTypeScriptApp);
+    /*****************************************************************************
+     *
+     * Target filter helpers
+     *
+     * Return various targets for deployment scripts to use.
+     *
+     ****************************************************************************/
+    /**
+     * @returns All production deployment targets.
+     */
+    get prodTargets(): Array<AwsDeploymentTarget>;
+    get prodTargetsForCI(): Array<AwsDeploymentTarget>;
+    get prodTargetsForLocal(): Array<AwsDeploymentTarget>;
+    /**
+     *
+     * @returns All stage deployment targets.
+     */
+    get stageTargets(): Array<AwsDeploymentTarget>;
+    get stageTargetsForCI(): Array<AwsDeploymentTarget>;
+    get stageTargetsForLocal(): Array<AwsDeploymentTarget>;
+    /**
+     *
+     * @returns All dev deployment targets.
+     */
+    get devTargets(): Array<AwsDeploymentTarget>;
+    get devTargetsForCI(): Array<AwsDeploymentTarget>;
+    get devTargetsForLocal(): Array<AwsDeploymentTarget>;
+    /*****************************************************************************
+     *
+     * Synth Tasks
+     *
+     * - Configure synth task to use the branch name
+     * - Change the output location for easier workflows.
+     *
+     ****************************************************************************/
+    private configureSynthTask;
+    preSynthesize(): void;
+}
+
+/*******************************************************************************
+ *
+ * AWS Organization, Account, and Region Definitions. These shapes are used
+ * when configuring deployment targets that automation can deploy projects into.
+ *
+ ******************************************************************************/
+/**
+ * AWS Region
+ *
+ * Represents an active Region that deployments can be made into.
+ */
+interface AwsRegion {
+    /**
+     * The name of the AWS region.
+     */
+    name: string;
+    /**
+     * The code of the AWS region (e.g., us-east-1).
+     */
+    code: string;
+    /**
+     * Indicates if the region is currently active as a targets for deployments.
+     */
+    active: boolean;
+}
+/**
+ * AWS Account
+ *
+ * Represents an AWS account with its details.
+ */
+interface AwsAccount {
+    /**
+     * The name of the AWS account.
+     */
+    name: string;
+    /**
+     * The ID (account number) of the AWS account.
+     */
+    id: string;
+    /**
+     * The list of active regions available in the AWS account.
+     */
+    regions: Array<AwsRegion>;
+}
+/**
+ * AWS Organization
+ *
+ * Represents one Organization configuration.
+ */
+interface AwsOrganization {
+    /**
+     * The name of the AWS organization.
+     */
+    name: string;
+    /**
+     * The ID of the AWS organization.
+     */
+    id: string;
+    /**
+     * The list of AWS accounts in the organization.
+     */
+    accounts: Array<AwsAccount>;
+}
+
+/**
+ * The FQNs for the base classes and options used by Jsii.
+ *
+ * These are the defaults used by Projen's TypeScriptProject.
+ */
+declare const ProjenBaseFqn: {
+    readonly TYPESCRIPT_PROJECT: "projen.typescript.TypeScriptProject";
+    readonly TYPESCRIPT_PROJECT_OPTIONS: "projen.typescript.TypeScriptProjectOptions";
+};
+interface ClassTypeOptions {
+    /**
+     * The name of the class.
+     *
+     * @example "MyProject"
+     */
+    name: string;
+    /**
+     * The FQN for the base class this class is extending.
+     *
+     * @default ProjenBaseFqn.TYPESCRIPT_PROJECT
+     */
+    baseFqn?: ValueOf<typeof ProjenBaseFqn> | string;
+    /**
+     * The FQN for the options for this class.
+     *
+     * @default ProjenBaseFqn.TYPESCRIPT_PROJECT_OPTIONS
+     */
+    optionsFqn?: ValueOf<typeof ProjenBaseFqn> | string;
+}
+declare class JsiiFaker extends Component {
+    readonly project: TypeScriptProject$1;
+    static of(project: TypeScriptProject$1): JsiiFaker | undefined;
+    private _assemblyName;
+    private _types;
+    constructor(project: TypeScriptProject$1);
+    toJSON: () => {
+        types: {
+            [name: string]: spec.Type;
+        };
+    };
+    addClassType(options: ClassTypeOptions): void;
+}
+
+/**
+ * Predefined minimum release age values in minutes.
+ */
+declare const MIMIMUM_RELEASE_AGE: {
+    ZERO_DAYS: number;
+    ONE_HOUR: number;
+    SIX_HOURS: number;
+    TWELVE_HOURS: number;
+    ONE_DAY: number;
+    TWO_DAYS: number;
+    THREE_DAYS: number;
+    FOUR_DAYS: number;
+    FIVE_DAYS: number;
+    SIX_DAYS: number;
+    ONE_WEEK: number;
+};
+interface PnpmWorkspaceOptions {
+    /**
+     * Filename for the pnpm workspace file. This should probably never change.
+     *
+     * @default "pnpm-workspace.yaml"
+     */
+    readonly fileName?: string;
+    /**
+     * To reduce the risk of installing compromised packages, you can delay the
+     * installation of newly published versions. In most cases, malicious releases
+     * are discovered and removed from the registry within an hour.
+     *
+     * minimumReleaseAge defines the minimum number of minutes that must pass
+     * after a version is published before pnpm will install it. This applies to
+     * all dependencies, including transitive ones.
+     *
+     * Note: this should match depsUpgradeOptions.cooldown in the project config.
+     *
+     * See: https://pnpm.io/settings#minimumreleaseage
+     *
+     * @default MIMIMUM_RELEASE_AGE.ONE_DAY
+     */
+    readonly minimumReleaseAge?: ValueOf<typeof MIMIMUM_RELEASE_AGE>;
+    /**
+     * If you set minimumReleaseAge but need certain dependencies to always
+     * install the newest version immediately, you can list them under
+     * minimumReleaseAgeExclude. The exclusion works by package name and applies
+     * to all versions of that package.
+     *
+     * @default - no exclusions (empty array)
+     *
+     * See: https://pnpm.io/settings#minimumreleaseageexclude
+     */
+    readonly minimumReleaseAgeExclude?: Array<string>;
+    /**
+     * A list of package names that are allowed to execute "preinstall",
+     * "install", and/or "postinstall" scripts during installation. Only the
+     * packages listed in this array will be able to run those lifecycle scripts.
+     * If onlyBuiltDependenciesFile and neverBuiltDependencies are omitted, this
+     * configuration option will default to blocking all install scripts.
+     *
+     * You may restrict allowances to specific versions (and lists of versions
+     * using a disjunction with ||). When versions are specified, only those
+     * versions of the package may run lifecycle scripts:
+     *
+     * See: https://pnpm.io/settings#onlybuiltdependencies
+     *
+     * @default none (empty array)
+     */
+    readonly onlyBuiltDependencies?: Array<string>;
+    /**
+     * A list of package names that are NOT allowed to execute "preinstall",
+     * "install", and/or "postinstall" scripts during installation and will not
+     * warn or ask to be executed.
+     *
+     * This is useful when you want to hide the warning because you know the
+     * lifecycle scripts are not needed.
+     *
+     * https://pnpm.io/settings#ignoredbuiltdependencies
+     *
+     * @default none (empty array)
+     */
+    readonly ignoredBuiltDependencies?: Array<string>;
+    /**
+     * Additional subproject paths to include in the workspace packages array.
+     * These will be combined with any subprojects discovered via projen's
+     * project.subprojects property. Paths should be relative to the project root.
+     *
+     * @default none (empty array)
+     */
+    readonly subprojects?: Array<string>;
+    /**
+     * Catalog of reusable dependency version ranges.
+     *
+     * The catalog allows you to define dependency versions as reusable constants
+     * that can be referenced in package.json files using the catalog: protocol.
+     *
+     * Example:
+     * ```yaml
+     * catalog:
+     *   react: ^18.0.0
+     *   typescript: ^5.0.0
+     * ```
+     *
+     * Then in package.json:
+     * ```json
+     * {
+     *   "dependencies": {
+     *     "react": "catalog:react"
+     *   }
+     * }
+     * ```
+     *
+     * @default undefined (not included in output)
+     *
+     * See: https://pnpm.io/pnpm-workspace_yaml#catalog
+     */
+    readonly defaultCatalog?: {
+        [key: string]: string;
+    };
+    /**
+     * Named catalogs of reusable dependency version ranges.
+     *
+     * Multiple named catalogs with arbitrarily chosen names can be configured under the namedCatalogs key.
+     *
+     * Example:
+     * ```yaml
+     * namedCatalogs:
+     *   frontend:
+     *     react: ^18.0.0
+     *     typescript: ^5.0.0
+     *   backend:
+     *     express: ^4.18.0
+     * ```
+     *
+     * Then in package.json:
+     * ```json
+     * {
+     *   "dependencies": {
+     *     "react": "catalog:frontend/react"
+     *   }
+     * }
+     * ```
+     *
+     * @default undefined (not included in output)
+     *
+     * See: https://pnpm.io/catalogs
+     */
+    readonly namedCatalogs?: {
+        [catalogName: string]: {
+            [dependencyName: string]: string;
+        };
+    };
+}
+declare class PnpmWorkspace extends Component {
+    /**
+     * Get the pnpm workspace component of a project. If it does not exist,
+     * return undefined.
+     *
+     * @param project
+     * @returns
+     */
+    static of(project: Project): PnpmWorkspace | undefined;
+    /**
+     * Filename for the pnpm workspace file.
+     */
+    readonly fileName: string;
+    /**
+     * To reduce the risk of installing compromised packages, you can delay the
+     * installation of newly published versions. In most cases, malicious releases
+     * are discovered and removed from the registry within an hour.
+     *
+     * minimumReleaseAge defines the minimum number of minutes that must pass
+     * after a version is published before pnpm will install it. This applies to
+     * all dependencies, including transitive ones.
+     *
+     * Note: this should match depsUpgradeOptions.cooldown in the project config.
+     *
+     * See: https://pnpm.io/settings#minimumreleaseage
+     */
+    minimumReleaseAge: ValueOf<typeof MIMIMUM_RELEASE_AGE>;
+    /**
+     * If you set minimumReleaseAge but need certain dependencies to always
+     * install the newest version immediately, you can list them under
+     * minimumReleaseAgeExclude. The exclusion works by package name and applies
+     * to all versions of that package.
+     *
+     * See: https://pnpm.io/settings#minimumreleaseageexclude
+     */
+    minimumReleaseAgeExclude: Array<string>;
+    /**
+     * A list of package names that are allowed to execute "preinstall",
+     * "install", and/or "postinstall" scripts during installation. Only the
+     * packages listed in this array will be able to run those lifecycle scripts.
+     * If onlyBuiltDependenciesFile and neverBuiltDependencies are omitted, this
+     * configuration option will default to blocking all install scripts.
+     *
+     * You may restrict allowances to specific versions (and lists of versions
+     * using a disjunction with ||). When versions are specified, only those
+     * versions of the package may run lifecycle scripts:
+     *
+     * See: https://pnpm.io/settings#onlybuiltdependencies
+     */
+    onlyBuiltDependencies: Array<string>;
+    /**
+     * A list of package names that are NOT allowed to execute "preinstall",
+     * "install", and/or "postinstall" scripts during installation and will not
+     * warn or ask to be executed.
+     *
+     * This is useful when you want to hide the warning because you know the
+     * lifecycle scripts are not needed.
+     *
+     * https://pnpm.io/settings#ignoredbuiltdependencies
+     */
+    ignoredBuiltDependencies: Array<string>;
+    /**
+     * Additional subproject paths to include in the workspace packages array.
+     * These will be combined with any subprojects discovered via projen's
+     * project.subprojects property.
+     */
+    subprojects: Array<string>;
+    /**
+     * Default catalog of reusable dependency version ranges.
+     *
+     * The default catalog is used to define dependency versions as reusable constants
+     * that can be referenced in package.json files using the catalog: protocol.
+     *
+     * See:https://pnpm.io/catalogs
+     */
+    defaultCatalog?: {
+        [key: string]: string;
+    };
+    /**
+     * Named catalogs of reusable dependency version ranges.
+     *
+     * Multiple named catalogs with arbitrarily chosen names can be configured under the namedCatalogs key.
+     *
+     * See: https://pnpm.io/catalogs
+     */
+    namedCatalogs?: {
+        [catalogName: string]: {
+            [dependencyName: string]: string;
+        };
+    };
+    constructor(project: Project, options?: PnpmWorkspaceOptions);
+}
+
+/*******************************************************************************
+ *
+ * Reset Task Component
+ *
+ * Adds a "reset" task that deletes all build artifacts produced by the build
+ * process. This includes node_modules, lib, dist, coverage, test-reports,
+ * .turbo, and tsconfig.tsbuildinfo.
+ *
+ ******************************************************************************/
+interface ResetTaskOptions {
+    /**
+     * Custom output directory to delete (overrides tsconfig artifactsDirectory detection).
+     *
+     * @default - detected from typescript project.artifactsDirectory or "lib"
+     */
+    readonly artifactsDirectory?: string;
+    /**
+     * Array of glob patterns for paths to remove.
+     * If empty, the artifactsDirectory will be added automatically.
+     *
+     * @default []
+     */
+    readonly pathsToRemove?: string[];
+    /**
+     * Name of the task to create.
+     *
+     * @default "reset"
+     */
+    readonly taskName?: string;
+}
+declare class ResetTask extends Component {
+    readonly project: Project;
+    /**
+     * Static method to discover reset task in a project.
+     */
+    static of(project: Project): ResetTask | undefined;
+    /**
+     * The output directory to delete (from tsconfig or custom).
+     */
+    readonly artifactsDirectory: string;
+    /**
+     * The final array of paths that will be removed by the reset task.
+     */
+    readonly pathsToRemove: string[];
+    /**
+     * The name of the task that was created.
+     */
+    readonly taskName: string;
+    constructor(project: Project, options?: ResetTaskOptions);
+}
+
+/**
+ * Each of the below options corresponds to a task property found here:
+ *  * https://turborepo.com/docs/reference/configuration#defining-tasks
+ */
+interface TurboRepoTaskOptions {
+    readonly name: string;
+    readonly dependsOn?: Array<string>;
+    readonly env?: Array<string>;
+    readonly passThroughEnv?: Array<string>;
+    readonly outputs?: Array<string>;
+    readonly cache?: boolean;
+    readonly inputs?: Array<string>;
+    readonly outputLogs?: "full" | "hash-only" | "new-only" | "errors-only" | "none";
+    readonly persistent?: boolean;
+    readonly interactive?: boolean;
+}
+declare class TurboRepoTask extends Component$1 {
+    readonly project: Project$1;
+    readonly name: string;
+    dependsOn: Array<string>;
+    readonly env: Array<string>;
+    readonly passThroughEnv: Array<string>;
+    outputs: Array<string>;
+    cache: boolean;
+    inputs: Array<string>;
+    readonly outputLogs: "full" | "hash-only" | "new-only" | "errors-only" | "none";
+    readonly persistent: boolean;
+    readonly interactive: boolean;
+    /**
+     * Include this task in turbo.json output?
+     */
+    isActive: boolean;
+    constructor(project: Project$1, options: TurboRepoTaskOptions);
+    taskConfig(): Record<string, any>;
+}
+
+/*******************************************************************************
+ *
+ * Turbo Repo Config
+ *
+ ******************************************************************************/
+declare const ROOT_TURBO_TASK_NAME = "turbo:build";
+declare const ROOT_CI_TASK_NAME = "build:all";
+interface RemoteCacheOptions {
+    /**
+     * Local profile name to use when fetching the cache endpoint and token.
+     */
+    readonly profileName: string;
+    /**
+     * OIDC role to assume when fetching the cache endpoint and token.
+     */
+    readonly oidcRole: string;
+    /**
+     * Name for the params used to store the cache endpoint.
+     */
+    readonly endpointParamName: string;
+    /**
+     * Name for the params used to store the cache's API token.
+     */
+    readonly tokenParamName: string;
+    /**
+     * team name used in remote cache commands
+     */
+    readonly teamName: string;
+}
+interface TurboRepoOptions {
+    /**
+     * Version of turborepo to use.
+     *
+     * @default: specified in versions file
+     */
+    readonly turboVersion?: string;
+    /**
+     * Extend from the root turbo.json to create specific configuration for a package using Package Configurations.
+     *
+     * The only valid value for extends is ["//"] to inherit configuration from the root turbo.json.
+     * If extends is used in the root turbo.json, it will be ignored.
+     *
+     * https://turbo.build/repo/docs/reference/configuration#extends
+     */
+    readonly extends?: Array<string>;
+    /**
+     * A list of globs that you want to include in all task hashes. If any file matching these globs changes, all tasks will miss cache. Globs are relative to the location of turbo.json.
+     *
+     * By default, all files in source control in the Workspace root are included in the global hash.
+     *
+     * Globs must be in the repository's source control root. Globs outside of the repository aren't supported.
+     *
+     * https://turbo.build/repo/docs/reference/configuration#globaldependencies
+     */
+    readonly globalDependencies?: Array<string>;
+    /**
+     * A list of environment variables that you want to impact the hash of all tasks. Any change to these environment variables will cause all tasks to miss cache.
+     *
+     * For more on wildcard and negation syntax, see the env section.
+     *
+     * https://turbo.build/repo/docs/reference/configuration#globalenv
+     */
+    readonly globalEnv?: Array<string>;
+    /**
+     * A list of environment variables that you want to make available to tasks.
+     * Using this key opts all tasks into Strict
+     * Environment Variable Mode.
+     *
+     * Additionally, Turborepo has a built-in set of global passthrough variables
+     * for common cases, like operating system environment variables. This
+     * includes variables like HOME, PATH, APPDATA, SHELL, PWD, and more. The full
+     * list can be found in the source code.
+     *
+     * Passthrough values do not contribute to hashes for caching
+     *
+     * If you want changes in these variables to cause cache misses, you will need
+     * to include them in env or globalEnv.
+     *
+     * https://turbo.build/repo/docs/reference/configuration#globalpassthroughenv
+     */
+    readonly globalPassThroughEnv?: Array<string>;
+    /**
+     * @default: "stream"
+     *
+     * Select a terminal UI for the repository.
+     *
+     * "tui" allows for viewing each log at once and interacting with the task.
+     * "stream" outputs logs as they come in and is not interactive.
+     *
+     * https://turbo.build/repo/docs/reference/configuration#ui
+     */
+    readonly ui?: "tui" | "stream";
+    /**
+     * @default: false
+     *
+     * Turborepo uses your repository's lockfile to determine caching behavior,
+     * Package Graphs, and more. Because of this, we use the packageManager field
+     * to help you stabilize your Turborepo.
+     *
+     * To help with incremental migration or in situations where you can't use
+     * the packageManager field, you may use
+     * --dangerously-disable-package-manager-check to opt out of this check and
+     * assume the risks of unstable lockfiles producing unpredictable behavior.
+     * When disabled, Turborepo will attempt a best-effort discovery of the
+     * intended package manager meant for the repository.
+     *
+     * https://turbo.build/repo/docs/reference/configuration#dangerouslydisablepackagemanagercheck
+     */
+    readonly dangerouslyDisablePackageManagerCheck?: boolean;
+    /**
+     * @default: ".turbo/cache"
+     *
+     * Specify the filesystem cache directory.
+     *
+     * https://turbo.build/repo/docs/reference/configuration#cachedir
+     */
+    readonly cacheDir?: string;
+    /**
+     * @default: true
+     *
+     * Turborepo runs a background process to pre-calculate some expensive
+     * operations. This standalone process (daemon) is a performance optimization,
+     * and not required for proper functioning of turbo.
+     *
+     * https://turbo.build/repo/docs/reference/configuration#daemon
+     */
+    readonly daemon?: boolean;
+    /**
+     * @default: "strict"
+     *
+     * Turborepo's Environment Modes allow you to control which environment
+     * variables are available to a task at runtime:
+     *
+     *"strict": Filter environment variables to only those that are specified
+     * in the env and globalEnv keys in turbo.json.
+     *
+     * "loose": Allow all environment variables for the process to be available.
+     *
+     * https://turbo.build/repo/docs/reference/configuration#envmode
+     */
+    readonly envMode?: string;
+    /*****************************************************************************
+     *
+     * Cache Settings
+     *
+     ****************************************************************************/
+    /**
+     * Cache settings, if using remote cache.
+     */
+    readonly remoteCacheOptions?: RemoteCacheOptions;
+    /**
+     * Env Args that will bre added to turbo's build:all task
+     *
+     * @default: {}
+     */
+    readonly buildAllTaskEnvVars?: Record<string, string>;
+    /*****************************************************************************
+     *
+     * Tasks - Optionally define a different projen task for one of the lifecycle
+     * steps.
+     *
+     ****************************************************************************/
+    /**
+     * Pre compile task
+     *
+     * @default: "pre-compile"
+     */
+    readonly preCompileTask?: Task;
+    /**
+     * Compile task
+     *
+     * @default: "compile"
+     */
+    readonly compileTask?: Task;
+    /**
+     * Post compile task
+     *
+     * @default: "post-compile"
+     */
+    readonly postCompileTask?: Task;
+    /**
+     * Test task
+     *
+     * @default: "test"
+     */
+    readonly testTask?: Task;
+    /**
+     * Package task
+     *
+     * @default: "package"
+     */
+    readonly packageTask?: Task;
+}
+declare class TurboRepo extends Component$1 {
+    readonly project: NodeProject;
+    /**
+     * Static method to discovert turbo in a project.
+     */
+    static of(project: Project$1): TurboRepo | undefined;
+    static buildWorkflowOptions: (remoteCacheOptions: RemoteCacheOptions) => Partial<BuildWorkflowOptions>;
+    /**
+     * Version of turborepo to use.
+     */
+    readonly turboVersion: string;
+    /**
+     * Extend from the root turbo.json to create specific configuration for a package using Package Configurations.
+     *
+     * The only valid value for extends is ["//"] to inherit configuration from the root turbo.json.
+     * If extends is used in the root turbo.json, it will be ignored.
+     *
+     * https://turbo.build/repo/docs/reference/configuration#extends
+     */
+    readonly extends: Array<string>;
+    /**
+     * A list of globs that you want to include in all task hashes. If any file matching these globs changes, all tasks will miss cache. Globs are relative to the location of turbo.json.
+     *
+     * By default, all files in source control in the Workspace root are included in the global hash.
+     *
+     * Globs must be in the repository's source control root. Globs outside of the repository aren't supported.
+     *
+     * https://turbo.build/repo/docs/reference/configuration#globaldependencies
+     */
+    readonly globalDependencies: Array<string>;
+    /**
+     * A list of environment variables that you want to impact the hash of all tasks. Any change to these environment variables will cause all tasks to miss cache.
+     *
+     * For more on wildcard and negation syntax, see the env section.
+     *
+     * https://turbo.build/repo/docs/reference/configuration#globalenv
+     */
+    readonly globalEnv: Array<string>;
+    /**
+     * A list of environment variables that you want to make available to tasks.
+     * Using this key opts all tasks into Strict
+     * Environment Variable Mode.
+     *
+     * Additionally, Turborepo has a built-in set of global passthrough variables
+     * for common cases, like operating system environment variables. This
+     * includes variables like HOME, PATH, APPDATA, SHELL, PWD, and more. The full
+     * list can be found in the source code.
+     *
+     * Passthrough values do not contribute to hashes for caching
+     *
+     * If you want changes in these variables to cause cache misses, you will need
+     * to include them in env or globalEnv.
+     *
+     * https://turbo.build/repo/docs/reference/configuration#globalpassthroughenv
+     */
+    readonly globalPassThroughEnv: Array<string>;
+    /**
+     * @default: "stream"
+     *
+     * Select a terminal UI for the repository.
+     *
+     * "tui" allows for viewing each log at once and interacting with the task.
+     * "stream" outputs logs as they come in and is not interactive.
+     *
+     * https://turbo.build/repo/docs/reference/configuration#ui
+     */
+    readonly ui: "tui" | "stream";
+    /**
+     * @default: false
+     *
+     * Turborepo uses your repository's lockfile to determine caching behavior,
+     * Package Graphs, and more. Because of this, we use the packageManager field
+     * to help you stabilize your Turborepo.
+     *
+     * To help with incremental migration or in situations where you can't use
+     * the packageManager field, you may use
+     * --dangerously-disable-package-manager-check to opt out of this check and
+     * assume the risks of unstable lockfiles producing unpredictable behavior.
+     * When disabled, Turborepo will attempt a best-effort discovery of the
+     * intended package manager meant for the repository.
+     *
+     * https://turbo.build/repo/docs/reference/configuration#dangerouslydisablepackagemanagercheck
+     */
+    readonly dangerouslyDisablePackageManagerCheck: boolean;
+    /**
+     * @default: ".turbo/cache"
+     *
+     * Specify the filesystem cache directory.
+     *
+     * https://turbo.build/repo/docs/reference/configuration#cachedir
+     */
+    readonly cacheDir: string;
+    /**
+     * @default: true
+     *
+     * Turborepo runs a background process to pre-calculate some expensive
+     * operations. This standalone process (daemon) is a performance optimization,
+     * and not required for proper functioning of turbo.
+     *
+     * https://turbo.build/repo/docs/reference/configuration#daemon
+     */
+    readonly daemon: boolean;
+    /**
+     * @default: "strict"
+     *
+     * Turborepo's Environment Modes allow you to control which environment
+     * variables are available to a task at runtime:
+     *
+     *"strict": Filter environment variables to only those that are specified
+     * in the env and globalEnv keys in turbo.json.
+     *
+     * "loose": Allow all environment variables for the process to be available.
+     *
+     * https://turbo.build/repo/docs/reference/configuration#envmode
+     */
+    readonly envMode: string;
+    /*****************************************************************************
+     *
+     * Cache Settings
+     *
+     ****************************************************************************/
+    /**
+     * Cache settings, if using remote cache.
+     */
+    readonly remoteCacheOptions?: RemoteCacheOptions;
+    /**
+     * is this the root project?
+     */
+    readonly isRootProject: boolean;
+    /**
+     * Turbo's build:all task at the root of the monorepo.
+     *
+     * This is a normal projen task that runs the root turbo task.
+     */
+    readonly buildAllTask?: Task;
+    /**
+     * Main turbo:build task
+     *
+     * This is a special Turbo task
+     */
+    readonly buildTask: TurboRepoTask;
+    /**
+     * pre compile task
+     */
+    readonly preCompileTask?: TurboRepoTask;
+    /**
+     * compile task
+     */
+    readonly compileTask?: TurboRepoTask;
+    /**
+     * post compile task
+     */
+    readonly postCompileTask?: TurboRepoTask;
+    /**
+     * Test task
+     */
+    readonly testTask?: TurboRepoTask;
+    /**
+     * Package task
+     */
+    readonly packageTask?: TurboRepoTask;
+    /**
+     * Sub-Tasks to run
+     */
+    readonly tasks: Array<TurboRepoTask>;
+    /**
+     * Env Args that will bre added to turbo's build:all task
+     */
+    readonly buildAllTaskEnvVars: Record<string, string>;
+    constructor(project: NodeProject, options?: TurboRepoOptions);
+    /**
+     * Add an env var to the global env vars for all tasks.
+     * This will also become an input for the build:all task cache at the root.
+     */
+    addGlobalEnvVar(name: string, value: string): void;
+    activateBranchNameEnvVar(): void;
+    preSynthesize(): void;
+}
+
+/*******************************************************************************
+ *
+ * Monorepo Root Project
+ *
+ * This project should be used as the base project for other projects in a
+ * monorepo. The Monorepo root project generally won't contain any code, but it
+ * will contain configuration for the monorepo, such as package management,
+ * linting, testing, and other project-wide settings.
+ *
+ ******************************************************************************/
+interface IDependencyResolver {
+    resolveDepsAndWritePackageJson(): boolean;
+}
+/**
+ * Configuration options for the monorepo.
+ */
+interface MonorepoProjectOptions extends Omit<TypeScriptProjectOptions$1, "defaultReleaseBranch"> {
+    /**
+     * Turn on Turborepo support.
+     *
+     * @default true
+     */
+    turbo?: boolean;
+    /**
+     * Optionsal options for turborepo config
+     */
+    turboOptions?: TurboRepoOptions;
+    /**
+     * Enable the reset task that deletes all build artifacts.
+     *
+     * @default true
+     */
+    resetTask?: boolean;
+    /**
+     * Options for the reset task.
+     */
+    resetTaskOptions?: ResetTaskOptions;
+    /**
+     * PNPM options for the monorepo.
+     */
+    pnpmOptions?: {
+        /**
+         * The version of PNPM to use in the monorepo.
+         * @default VERSION.PNPM_VERSION
+         * @see {@link src/versions.ts}
+         */
+        version?: string;
+        /**
+         * Optional pnpm options for the monorepo workspace file.
+         */
+        pnpmWorkspaceOptions?: PnpmWorkspaceOptions;
+    };
+    /**
+     * Turn on the upgrade configurator task that will attempt to upgrade the
+     * @codedrifters/configulator package version nightly. This keeps the
+     * project up-to-date with the latest official CodeDrifters configs..
+     *
+     * @default true
+     */
+    readonly upgradeConfigulatorTask?: boolean;
+    /**
+     * Options for the upgrade configurator task.
+     *
+     * @default: daily schedule
+     */
+    readonly upgradeConfigulatorTaskOptions?: UpgradeDependenciesOptions;
+}
+declare class MonorepoProject extends TypeScriptAppProject {
+    /**
+     * Version of PNPM which the whole monorepo should use.
+     */
+    readonly pnpmVersion: string;
+    /**
+     * Optional task that will attempt to upgrade the @codedrifters/configulator
+     * package version nightly. This keeps the project up-to-date with the latest
+     * official CodeDrifters configs.
+     */
+    readonly upgradeConfigulatorTask?: UpgradeDependencies;
+    /**
+     * List of functions to call after dependencies have been installed.
+     */
+    private postInstallDependencies;
+    constructor(userOptions: MonorepoProjectOptions);
+    /**
+     * Allows a sub project to request installation of dependency at the Monorepo root
+     * They must provide a function that is executed after dependencies have been installed
+     * If this function returns true, the install command is run for a second time after all sub project requests have run.
+     * This is used to resolve dependency versions from `*` to a concrete version constraint.
+     */
+    requestInstallDependencies(resolver: IDependencyResolver): void;
+    /**
+     * Hooks into the install dependencies cycle
+     */
+    postSynthesize(): void;
+}
+
+/**
+ * Configuration options for TypeScriptProject.
+ */
+interface TypeScriptProjectOptions extends Omit<typescript.TypeScriptProjectOptions, "defaultReleaseBranch"> {
+    /**
+     * Enable the reset task that deletes all build artifacts.
+     *
+     * @default true
+     */
+    readonly resetTask?: boolean;
+    /**
+     * Options for the reset task.
+     */
+    readonly resetTaskOptions?: ResetTaskOptions;
+}
+declare class TypeScriptProject extends typescript.TypeScriptProject {
+    constructor(userOptions: TypeScriptProjectOptions);
+}
+
+/*******************************************************************************
+ *
+ * Update / customize typescript configs for a project.
+ *
+ * Update typescript paths in tsconfig so we don't have to compile packages to
+ * dist in order to see changes.
+ *
+ ******************************************************************************/
+declare class TypeScriptConfig extends Component {
+    constructor(project: TypeScriptProject$1);
+}
+
+/*******************************************************************************
+ *
+ * Configure VSCode Settings
+ *
+ ******************************************************************************/
+declare class VSCodeConfig extends Component {
+    constructor(project: TypeScriptAppProject);
+}
+
+declare const PROD_DEPLOY_NAME = "prod-deploy";
+interface DeployWorkflowOptions {
+    /**
+     * What type of deploy is this workflow for?
+     *
+     * @default AWS_STAGE_TYPE.DEV
+     */
+    readonly awsStageType?: ValueOf<typeof AWS_STAGE_TYPE>;
+    /**
+     * Optionally feed a list of targets to deploy to.
+     *
+     * @default discovers all targets using stageType
+     */
+    readonly awsDeploymentTargets?: Array<AwsDeploymentTarget>;
+    /**
+     * Existing workflow, useful if we're tacking deployments onto an existing
+     * build workflow
+     */
+    readonly buildWorkflow?: BuildWorkflow;
+    /**
+     * Options for the build workflow, if no build workflow is provided.
+     */
+    readonly buildWorkflowOptions?: Partial<BuildWorkflowOptions>;
+    /**
+     * Projects that should complete deployment before this one starts.
+     */
+    readonly deployAfterTargets?: Array<AwsDeploymentTarget>;
+}
+declare class AwsDeployWorkflow extends Component {
+    project: AwsCdkTypeScriptApp;
+    static of(project: AwsCdkTypeScriptApp, buildWorkflow: BuildWorkflow): AwsDeployWorkflow | undefined;
+    /**
+     * The root project for this deploy workflow. Must be a monorepo project.
+     */
+    private rootProject;
+    /**
+     * What type of deploy is this workflow for?
+     */
+    awsStageType: AwsStageType;
+    /**
+     * AWS environment type, such as primary or secondary.
+     *
+     * @deprecated Use deployment target role terminology elsewhere. This property is maintained for backward compatibility.
+     * @default 'primary' (this is the only type supported currently)
+     */
+    awsEnvironmentType: DeploymentTargetRoleType;
+    /**
+     * The list of targets to deploy to.
+     */
+    readonly awsDeploymentTargets: Array<AwsDeploymentTarget>;
+    /**
+     * Hold the deploy workflow so we can add to it in preSynth
+     */
+    buildWorkflow: BuildWorkflow;
+    /**
+     * Was this workflow created externally?
+     */
+    externalWorkflow: boolean;
+    /**
+     * Projects that should complete deployment before this one starts.
+     */
+    deployAfterTargets: Array<AwsDeploymentTarget>;
+    constructor(project: AwsCdkTypeScriptApp, options?: DeployWorkflowOptions);
+    setupNode: () => Array<JobStep>;
+    setupPnpm: () => Array<JobStep>;
+    /**
+     * Builds a GitHub Actions condition string that checks if the current branch
+     * matches any of the provided branch patterns.
+     *
+     * Handles both exact matches (e.g., "main") and glob patterns (e.g., "feature/*").
+     * Also allows workflow_dispatch (manual runs) to proceed.
+     *
+     * @param branches Array of GitBranch objects with branch patterns
+     * @returns Condition string or empty string if no branches provided
+     */
+    private buildBranchFilterCondition;
+    private deploySteps;
+    preSynthesize(): void;
+}
+
+export { type AwsAccount, AwsDeployWorkflow, AwsDeploymentConfig, type AwsOrganization, type AwsRegion, type ClassTypeOptions, type DeployWorkflowOptions, type GitBranch, type IDependencyResolver, JsiiFaker, MIMIMUM_RELEASE_AGE, MonorepoProject, type MonorepoProjectOptions, PROD_DEPLOY_NAME, PnpmWorkspace, type PnpmWorkspaceOptions, ROOT_CI_TASK_NAME, ROOT_TURBO_TASK_NAME, type RemoteCacheOptions, ResetTask, type ResetTaskOptions, TurboRepo, type TurboRepoOptions, TurboRepoTask, type TurboRepoTaskOptions, TypeScriptConfig, TypeScriptProject, type TypeScriptProjectOptions, VSCodeConfig };