@codedrifters/configulator 0.0.196 → 0.0.198

package/lib/index.d.mts

@@ -1799,6 +1799,15 @@ declare const VERSION: {
      * Version of Projen to use.
      */
     readonly PROJEN_VERSION: "0.99.48";
+    /**
+     * Version of sharp to pin for StarlightProject (required peer for
+     * Starlight's image optimization pipeline).
+     */
+    readonly SHARP_VERSION: "0.34.5";
+    /**
+     * Version of @astrojs/starlight to pin for StarlightProject scaffolding.
+     */
+    readonly STARLIGHT_VERSION: "0.38.3";
     /**
      * What version of the turborepo library should we use?
      */
@@ -2462,88 +2471,6 @@ declare class AwsDeployWorkflow extends Component {
     preSynthesize(): void;
 }
 
-/**
- * Configuration options for AwsCdkProject.
- *
- * AwsCdkProject must be parented to a `MonorepoProject` — the constructor
- * throws otherwise. Configulator assumes a single-package repo is still a
- * monorepo (with one workspace) so all conventions hold uniformly.
- */
-interface AwsCdkProjectOptions extends Omit<awscdk.AwsCdkTypeScriptAppOptions, "defaultReleaseBranch"> {
-    /**
-     * AWS deployment targets (dev / stage / prod accounts and regions). Each
-     * entry creates an `AwsDeploymentTarget` component on the project.
-     */
-    readonly deploymentTargets?: Array<AwsDeploymentTargetOptions>;
-    /**
-     * AWS deploy workflows. If omitted, one workflow is auto-generated per
-     * unique `awsStageType` present in `deploymentTargets`. Each auto-generated
-     * workflow renders to its own `.github/workflows/*.yml` file.
-     *
-     * Pass an empty array (`[]`) to opt out of auto-derivation entirely without
-     * supplying any workflows of your own — the array is truthy and short-circuits
-     * the default. Useful when you intend to attach deploy jobs to an existing
-     * build workflow yourself.
-     */
-    readonly deployWorkflows?: Array<DeployWorkflowOptions>;
-    /**
-     * Optional shared `BuildWorkflow` to attach all auto-derived deploy jobs to.
-     * When set, every workflow generated from `deploymentTargets` re-uses this
-     * build workflow instead of creating its own. Default behavior (omit) is one
-     * separate yml file per stage type.
-     *
-     * Distinct from `buildWorkflow: boolean` inherited from
-     * `AwsCdkTypeScriptAppOptions`, which toggles whether the projen-managed
-     * build workflow is generated at all.
-     */
-    readonly sharedBuildWorkflow?: BuildWorkflow;
-    /**
-     * Test runner to use.
-     *
-     * @default TestRunner.JEST
-     */
-    readonly testRunner?: TestRunner;
-    /**
-     * Options for Vitest (only used when testRunner is 'vitest').
-     */
-    readonly vitestOptions?: VitestOptions;
-    /**
-     * Enable the reset task that deletes all build artifacts.
-     *
-     * @default true
-     */
-    readonly resetTask?: boolean;
-    /**
-     * Options for the reset task.
-     */
-    readonly resetTaskOptions?: ResetTaskOptions;
-    /**
-     * AI agent configuration (Cursor, Claude Code rules). Opt-in per project;
-     * not inherited from the parent `MonorepoProject`.
-     *
-     * @default false
-     */
-    readonly agentConfig?: AgentConfigOptions | boolean;
-}
-/**
- * AWS CDK TypeScript application with CodeDrifters conventions baked in.
- *
- * Always creates an `AwsDeploymentConfig` component (even with zero deployment
- * targets) so the `synth` task is consistently rewritten to emit into
- * `dist/<project-path>/cdk.out`. This is intentional and not opt-out: it
- * funnels every package's CDK output into one root-level `dist/` tree so
- * GitHub Actions workflows can pass artifacts between jobs uniformly.
- */
-declare class AwsCdkProject extends awscdk.AwsCdkTypeScriptApp {
-    constructor(userOptions: AwsCdkProjectOptions);
-    /**
-     * Add an AWS deployment target to this project after construction. The
-     * target is registered on the existing `AwsDeploymentConfig` and immediately
-     * available for `AwsDeployWorkflow` consumption.
-     */
-    addDeploymentTarget(options: AwsDeploymentTargetOptions): AwsDeploymentTarget;
-}
-
 /**
  * Each of the below options corresponds to a task property found here:
  *  * https://turborepo.com/docs/reference/configuration#defining-tasks
@@ -3150,6 +3077,140 @@ declare class MonorepoProject extends TypeScriptAppProject {
     postSynthesize(): void;
 }
 
+/**
+ * Default branch-delete patterns that trigger the teardown workflow.
+ */
+declare const DEFAULT_TEARDOWN_BRANCH_PATTERNS: ReadonlyArray<string>;
+/**
+ * Options for {@link AwsTeardownWorkflow}.
+ */
+interface AwsTeardownWorkflowOptions {
+    /**
+     * Targets to scan for orphaned CloudFormation stacks.
+     */
+    readonly awsDestructionTargets: Array<AwsDeploymentTarget>;
+    /**
+     * Name of the tag containing the repo name. Used to find CloudFormation
+     * stacks associated with this repo.
+     */
+    readonly repoTagName: string;
+    /**
+     * Name of the tag containing the stage type (e.g. dev, stage, prod).
+     */
+    readonly stageTypeTagName: string;
+    /**
+     * Name of the tag containing the environment type (e.g. primary, secondary).
+     */
+    readonly environmentTypeTagName: string;
+    /**
+     * Name of the tag where branch names are stored. Used to determine if a
+     * stack is orphaned (no matching branch).
+     */
+    readonly branchNameTagName: string;
+    /**
+     * Branch patterns whose deletion triggers the teardown workflow.
+     *
+     * @default ["feat/*", "fix/*", "feature/*"]
+     */
+    readonly deleteBranchPatterns?: Array<string>;
+}
+/**
+ * Scheduled GitHub Actions workflow that tears down orphaned CloudFormation
+ * stacks whose associated branch no longer exists.
+ */
+declare class AwsTeardownWorkflow extends Component {
+    rootProject: MonorepoProject;
+    constructor(rootProject: MonorepoProject, options: AwsTeardownWorkflowOptions);
+}
+
+/**
+ * Configuration options for AwsCdkProject.
+ *
+ * AwsCdkProject must be parented to a `MonorepoProject` — the constructor
+ * throws otherwise. Configulator assumes a single-package repo is still a
+ * monorepo (with one workspace) so all conventions hold uniformly.
+ */
+interface AwsCdkProjectOptions extends Omit<awscdk.AwsCdkTypeScriptAppOptions, "defaultReleaseBranch"> {
+    /**
+     * AWS deployment targets (dev / stage / prod accounts and regions). Each
+     * entry creates an `AwsDeploymentTarget` component on the project.
+     */
+    readonly deploymentTargets?: Array<AwsDeploymentTargetOptions>;
+    /**
+     * AWS deploy workflows. If omitted, one workflow is auto-generated per
+     * unique `awsStageType` present in `deploymentTargets`. Each auto-generated
+     * workflow renders to its own `.github/workflows/*.yml` file.
+     *
+     * Pass an empty array (`[]`) to opt out of auto-derivation entirely without
+     * supplying any workflows of your own — the array is truthy and short-circuits
+     * the default. Useful when you intend to attach deploy jobs to an existing
+     * build workflow yourself.
+     */
+    readonly deployWorkflows?: Array<DeployWorkflowOptions>;
+    /**
+     * Optional shared `BuildWorkflow` to attach all auto-derived deploy jobs to.
+     * When set, every workflow generated from `deploymentTargets` re-uses this
+     * build workflow instead of creating its own. Default behavior (omit) is one
+     * separate yml file per stage type.
+     *
+     * Distinct from `buildWorkflow: boolean` inherited from
+     * `AwsCdkTypeScriptAppOptions`, which toggles whether the projen-managed
+     * build workflow is generated at all.
+     */
+    readonly sharedBuildWorkflow?: BuildWorkflow;
+    /**
+     * Test runner to use.
+     *
+     * @default TestRunner.JEST
+     */
+    readonly testRunner?: TestRunner;
+    /**
+     * Options for Vitest (only used when testRunner is 'vitest').
+     */
+    readonly vitestOptions?: VitestOptions;
+    /**
+     * Enable the reset task that deletes all build artifacts.
+     *
+     * @default true
+     */
+    readonly resetTask?: boolean;
+    /**
+     * Options for the reset task.
+     */
+    readonly resetTaskOptions?: ResetTaskOptions;
+    /**
+     * AI agent configuration (Cursor, Claude Code rules). Opt-in per project;
+     * not inherited from the parent `MonorepoProject`.
+     *
+     * @default false
+     */
+    readonly agentConfig?: AgentConfigOptions | boolean;
+    /**
+     * Scheduled teardown workflow options. When provided, an `AwsTeardownWorkflow`
+     * is attached to the parent `MonorepoProject` that periodically deletes
+     * orphaned CloudFormation stacks whose branch no longer exists.
+     */
+    readonly teardownWorkflow?: AwsTeardownWorkflowOptions;
+}
+/**
+ * AWS CDK TypeScript application with CodeDrifters conventions baked in.
+ *
+ * Always creates an `AwsDeploymentConfig` component (even with zero deployment
+ * targets) so the `synth` task is consistently rewritten to emit into
+ * `dist/<project-path>/cdk.out`. This is intentional and not opt-out: it
+ * funnels every package's CDK output into one root-level `dist/` tree so
+ * GitHub Actions workflows can pass artifacts between jobs uniformly.
+ */
+declare class AwsCdkProject extends awscdk.AwsCdkTypeScriptApp {
+    constructor(userOptions: AwsCdkProjectOptions);
+    /**
+     * Add an AWS deployment target to this project after construction. The
+     * target is registered on the existing `AwsDeploymentConfig` and immediately
+     * available for `AwsDeployWorkflow` consumption.
+     */
+    addDeploymentTarget(options: AwsDeploymentTargetOptions): AwsDeploymentTarget;
+}
+
 /**
  * Provides structured project metadata consumed by AgentConfig, skills,
  * and other configulator features at synthesis time.
@@ -3184,6 +3245,113 @@ declare class ProjectMetadata extends Component {
     private autoDetectRepository;
 }
 
+/**
+ * A single Starlight social icon link.
+ */
+interface StarlightSocialLink {
+    readonly icon: string;
+    readonly label: string;
+    readonly href: string;
+}
+/**
+ * Starlight logo configuration.
+ */
+interface StarlightLogo {
+    readonly src: string;
+    readonly alt?: string;
+}
+/**
+ * Starlight edit-link configuration.
+ */
+interface StarlightEditLink {
+    readonly baseUrl: string;
+}
+/**
+ * Sidebar item accepted by Starlight's `sidebar` config. Covers the four
+ * common shapes: link, group with nested items, autogenerated group, and
+ * internal slug reference.
+ */
+type StarlightSidebarItem = {
+    readonly label: string;
+    readonly link: string;
+    readonly badge?: string | {
+        readonly text: string;
+        readonly variant?: string;
+    };
+} | {
+    readonly label: string;
+    readonly items: ReadonlyArray<StarlightSidebarItem>;
+} | {
+    readonly label: string;
+    readonly autogenerate: {
+        readonly directory: string;
+        readonly collapsed?: boolean;
+    };
+} | {
+    readonly label: string;
+    readonly slug: string;
+};
+/**
+ * Configuration options for StarlightProject.
+ */
+interface StarlightProjectOptions extends AstroProjectOptions {
+    /**
+     * Starlight site title (required).
+     */
+    readonly starlightTitle: string;
+    /**
+     * Starlight site description.
+     */
+    readonly starlightDescription?: string;
+    /**
+     * Social links rendered in the Starlight header.
+     */
+    readonly social?: ReadonlyArray<StarlightSocialLink>;
+    /**
+     * Sidebar config (passed through verbatim). When omitted, Starlight
+     * autogenerates the sidebar from the `src/content/docs/` tree.
+     */
+    readonly sidebar?: ReadonlyArray<StarlightSidebarItem>;
+    /**
+     * Custom CSS files loaded by Starlight.
+     */
+    readonly customCss?: ReadonlyArray<string>;
+    /**
+     * Site logo displayed in the Starlight header.
+     */
+    readonly logo?: StarlightLogo;
+    /**
+     * "Edit this page" link configuration.
+     */
+    readonly editLink?: StarlightEditLink;
+    /**
+     * @astrojs/starlight package version.
+     *
+     * @default VERSION.STARLIGHT_VERSION
+     */
+    readonly starlightVersion?: string;
+    /**
+     * sharp package version (required peer for Starlight's image pipeline).
+     *
+     * @default VERSION.SHARP_VERSION
+     */
+    readonly sharpVersion?: string;
+    /**
+     * Emit sample Starlight content (`src/content/docs/index.mdx`,
+     * `src/content/config.ts`).
+     *
+     * @default false
+     */
+    readonly sampleContent?: boolean;
+}
+/**
+ * Docs site scaffolded on top of {@link AstroProject} using the
+ * Starlight Astro integration.
+ */
+declare class StarlightProject extends AstroProject {
+    constructor(userOptions: StarlightProjectOptions);
+}
+
 /*******************************************************************************
  *
  * Update / customize typescript configs for a project.
@@ -3218,4 +3386,4 @@ declare const COMPLETE_JOB_ID = "complete";
  */
 declare function addBuildCompleteJob(buildWorkflow: BuildWorkflow): void;
 
-export { AGENT_MODEL, AGENT_PLATFORM, AGENT_RULE_SCOPE, AgentConfig, type AgentConfigOptions, type AgentModel, type AgentPlatform, type AgentPlatformOverrides, type AgentProcedure, type AgentRule, type AgentRuleBundle, type AgentRuleScope, type AgentSkill, type AgentSubAgent, type AgentSubAgentPlatformOverrides, type ApproveMergeUpgradeOptions, AstroConfig, type AstroConfigOptions, type AstroIntegrationSpec, AstroOutput, AstroProject, type AstroProjectOptions, type AwsAccount, AwsCdkProject, type AwsCdkProjectOptions, AwsDeployWorkflow, AwsDeploymentConfig, AwsDeploymentTarget, type AwsDeploymentTargetOptions, type AwsLocalDeploymentConfig, type AwsOrganization, type AwsRegion, BUILT_IN_BUNDLES, CLAUDE_RULE_TARGET, COMPLETE_JOB_ID, type CiDeploymentConfig, type ClassTypeOptions, type ClaudeAutoModeConfig, type ClaudeHookAction, type ClaudeHookEntry, type ClaudeHooksConfig, type ClaudePermissionsConfig, type ClaudeRuleTarget, type ClaudeSandboxConfig, type ClaudeSettingsConfig, type CopilotHandoff, type CursorHookAction, type CursorHooksConfig, type CursorSettingsConfig, DEFAULT_PRIORITY_LABELS, DEFAULT_STATUS_LABELS, DEFAULT_TYPE_LABELS, type DeployWorkflowOptions, type DeploymentMetadata, type GitBranch, type GitHubBoardMetadata, type GitHubProjectMetadata, type GitHubSprintMetadata, type IDependencyResolver, JsiiFaker, type LabelDefinition, MCP_TRANSPORT, MERGE_METHODS, MIMIMUM_RELEASE_AGE, MINIMUM_RELEASE_AGE, type McpServerConfig, type McpTransport, type MergeMethod, MonorepoProject, type MonorepoProjectOptions, type OrganizationMetadata, PROD_DEPLOY_NAME, PnpmWorkspace, type PnpmWorkspaceOptions, ProjectMetadata, type ProjectMetadataOptions, ROOT_CI_TASK_NAME, ROOT_TURBO_TASK_NAME, type RemoteCacheOptions, type RepositoryMetadata, ResetTask, type ResetTaskOptions, type ResolvedProjectMetadata, type SlackMetadata, type SyncLabelsOptions, type TemplateResolveResult, TestRunner, TurboRepo, type TurboRepoOptions, TurboRepoTask, type TurboRepoTaskOptions, TypeScriptConfig, TypeScriptProject, type TypeScriptProjectOptions, VERSION, VERSION_KEYS_SKIP, VERSION_NPM_PACKAGES, VSCodeConfig, type VersionKey, Vitest, type VitestConfigOptions, type VitestOptions, addApproveMergeUpgradeWorkflow, addBuildCompleteJob, addSyncLabelsWorkflow, awsCdkBundle, baseBundle, getLatestEligibleVersion, githubWorkflowBundle, jestBundle, meetingAnalysisBundle, orchestratorBundle, pnpmBundle, projenBundle, resolveModelAlias, resolveTemplateVariables, slackBundle, turborepoBundle, typescriptBundle, vitestBundle };
+export { AGENT_MODEL, AGENT_PLATFORM, AGENT_RULE_SCOPE, AgentConfig, type AgentConfigOptions, type AgentModel, type AgentPlatform, type AgentPlatformOverrides, type AgentProcedure, type AgentRule, type AgentRuleBundle, type AgentRuleScope, type AgentSkill, type AgentSubAgent, type AgentSubAgentPlatformOverrides, type ApproveMergeUpgradeOptions, AstroConfig, type AstroConfigOptions, type AstroIntegrationSpec, AstroOutput, AstroProject, type AstroProjectOptions, type AwsAccount, AwsCdkProject, type AwsCdkProjectOptions, AwsDeployWorkflow, AwsDeploymentConfig, AwsDeploymentTarget, type AwsDeploymentTargetOptions, type AwsLocalDeploymentConfig, type AwsOrganization, type AwsRegion, AwsTeardownWorkflow, type AwsTeardownWorkflowOptions, BUILT_IN_BUNDLES, CLAUDE_RULE_TARGET, COMPLETE_JOB_ID, type CiDeploymentConfig, type ClassTypeOptions, type ClaudeAutoModeConfig, type ClaudeHookAction, type ClaudeHookEntry, type ClaudeHooksConfig, type ClaudePermissionsConfig, type ClaudeRuleTarget, type ClaudeSandboxConfig, type ClaudeSettingsConfig, type CopilotHandoff, type CursorHookAction, type CursorHooksConfig, type CursorSettingsConfig, DEFAULT_PRIORITY_LABELS, DEFAULT_STATUS_LABELS, DEFAULT_TEARDOWN_BRANCH_PATTERNS, DEFAULT_TYPE_LABELS, type DeployWorkflowOptions, type DeploymentMetadata, type GitBranch, type GitHubBoardMetadata, type GitHubProjectMetadata, type GitHubSprintMetadata, type IDependencyResolver, JsiiFaker, type LabelDefinition, MCP_TRANSPORT, MERGE_METHODS, MIMIMUM_RELEASE_AGE, MINIMUM_RELEASE_AGE, type McpServerConfig, type McpTransport, type MergeMethod, MonorepoProject, type MonorepoProjectOptions, type OrganizationMetadata, PROD_DEPLOY_NAME, PnpmWorkspace, type PnpmWorkspaceOptions, ProjectMetadata, type ProjectMetadataOptions, ROOT_CI_TASK_NAME, ROOT_TURBO_TASK_NAME, type RemoteCacheOptions, type RepositoryMetadata, ResetTask, type ResetTaskOptions, type ResolvedProjectMetadata, type SlackMetadata, type StarlightEditLink, type StarlightLogo, StarlightProject, type StarlightProjectOptions, type StarlightSidebarItem, type StarlightSocialLink, type SyncLabelsOptions, type TemplateResolveResult, TestRunner, TurboRepo, type TurboRepoOptions, TurboRepoTask, type TurboRepoTaskOptions, TypeScriptConfig, TypeScriptProject, type TypeScriptProjectOptions, VERSION, VERSION_KEYS_SKIP, VERSION_NPM_PACKAGES, VSCodeConfig, type VersionKey, Vitest, type VitestConfigOptions, type VitestOptions, addApproveMergeUpgradeWorkflow, addBuildCompleteJob, addSyncLabelsWorkflow, awsCdkBundle, baseBundle, getLatestEligibleVersion, githubWorkflowBundle, jestBundle, meetingAnalysisBundle, orchestratorBundle, pnpmBundle, projenBundle, resolveModelAlias, resolveTemplateVariables, slackBundle, turborepoBundle, typescriptBundle, vitestBundle };