projen 0.70.2 → 0.70.4

package/lib/.types-compat/ts3.9/lib/awscdk/cdk-config.d.ts

@@ -0,0 +1,122 @@
+import { Component } from "../component";
+import { JsonFile } from "../json";
+import { Project } from "../project";
+/**
+ * Common options for `cdk.json`.
+ */
+export interface CdkConfigCommonOptions {
+    /**
+     * Additional context to include in `cdk.json`.
+     *
+     * @default - no additional context
+     */
+    readonly context?: {
+        [key: string]: any;
+    };
+    /**
+     * Include all feature flags in cdk.json
+     *
+     * @default true
+     */
+    readonly featureFlags?: boolean;
+    /**
+     * To protect you against unintended changes that affect your security posture,
+     * the AWS CDK Toolkit prompts you to approve security-related changes before deploying them.
+     *
+     * @default ApprovalLevel.BROADENING
+     */
+    readonly requireApproval?: ApprovalLevel;
+    /**
+     * cdk.out directory.
+     *
+     * @default "cdk.out"
+     */
+    readonly cdkout?: string;
+    /**
+     * A command to execute before synthesis. This command will be called when
+     * running `cdk synth` or when `cdk watch` identifies a change in your source
+     * code before redeployment.
+     *
+     * @default - no build command
+     */
+    readonly buildCommand?: string;
+    /**
+     * Glob patterns to include in `cdk watch`.
+     *
+     * @default []
+     */
+    readonly watchIncludes?: string[];
+    /**
+     * Glob patterns to exclude from `cdk watch`.
+     *
+     * @default []
+     */
+    readonly watchExcludes?: string[];
+}
+/**
+ * Options for `CdkJson`.
+ */
+export interface CdkConfigOptions extends CdkConfigCommonOptions {
+    /**
+     * The command line to execute in order to synthesize the CDK application
+     * (language specific).
+     */
+    readonly app: string;
+}
+/**
+ * Represents cdk.json file.
+ */
+export declare class CdkConfig extends Component {
+    /**
+     * Represents the JSON file.
+     */
+    readonly json: JsonFile;
+    /**
+     * Name of the cdk.out directory.
+     */
+    readonly cdkout: string;
+    /**
+     * List of glob patterns to be included by CDK.
+     */
+    private readonly _include;
+    /**
+     * List of glob patterns to be excluded by CDK.
+     */
+    private readonly _exclude;
+    constructor(project: Project, options: CdkConfigOptions);
+    /**
+     * Add includes to `cdk.json`.
+     * @param patterns The includes to add.
+     */
+    addIncludes(...patterns: string[]): void;
+    /**
+     * Add excludes to `cdk.json`.
+     * @param patterns The excludes to add.
+     */
+    addExcludes(...patterns: string[]): void;
+    /**
+     * List of glob patterns to be included by CDK.
+     */
+    get include(): string[];
+    /**
+     * List of glob patterns to be excluded by CDK.
+     */
+    get exclude(): string[];
+}
+/**
+ * Which approval is required when deploying CDK apps.
+ */
+export declare enum ApprovalLevel {
+    /**
+     * Approval is never required
+     */
+    NEVER = "never",
+    /**
+     * Requires approval on any IAM or security-group-related change
+     */
+    ANY_CHANGE = "any-change",
+    /**
+     * Requires approval when IAM statements or traffic rules are added; removals don't require approval
+     */
+    BROADENING = "broadening"
+}

package/lib/.types-compat/ts3.9/lib/awscdk/cdk-tasks.d.ts

@@ -0,0 +1,33 @@
+import { Component } from "../component";
+import { Project } from "../project";
+import { Task } from "../task";
+/**
+ * Adds standard AWS CDK tasks to your project.
+ */
+export declare class CdkTasks extends Component {
+    /**
+     * Synthesizes your app.
+     */
+    readonly synth: Task;
+    /**
+     * Synthesizes your app and suppresses stdout.
+     */
+    readonly synthSilent: Task;
+    /**
+     * Deploys your app.
+     */
+    readonly deploy: Task;
+    /**
+     * Destroys all the stacks.
+     */
+    readonly destroy: Task;
+    /**
+     * Diff against production.
+     */
+    readonly diff: Task;
+    /**
+     * Watch task.
+     */
+    readonly watch: Task;
+    constructor(project: Project);
+}

package/lib/.types-compat/ts3.9/lib/awscdk/index.d.ts

@@ -0,0 +1,14 @@
+export * from "./auto-discover";
+export * from "./awscdk-app-java";
+export * from "./awscdk-app-py";
+export * from "./awscdk-app-ts";
+export * from "./awscdk-construct";
+export * from "./awscdk-deps";
+export * from "./awscdk-deps-java";
+export * from "./awscdk-deps-js";
+export * from "./awscdk-deps-py";
+export * from "./cdk-config";
+export * from "./cdk-tasks";
+export * from "./integration-test";
+export * from "./lambda-function";
+export * from "./lambda-extension";

package/lib/.types-compat/ts3.9/lib/awscdk/integration-test.d.ts

@@ -0,0 +1,46 @@
+import { AwsCdkDeps } from "./awscdk-deps";
+import { IntegrationTestBase, IntegrationTestBaseOptions } from "../cdk";
+import { Project } from "../project";
+import { Task } from "../task";
+export interface IntegrationTestCommonOptions {
+    /**
+     * Destroy the test app after a successful deployment. If disabled, leaves the
+     * app deployed in the dev account.
+     * @default true
+     */
+    readonly destroyAfterDeploy?: boolean;
+    /**
+     * Enables path metadata, adding `aws:cdk:path`, with the defining construct's
+     * path, to the CloudFormation metadata for each synthesized resource.
+     * @default false
+     */
+    readonly pathMetadata?: boolean;
+}
+/**
+ * Options for `IntegrationTest`.
+ */
+export interface IntegrationTestOptions extends IntegrationTestCommonOptions, IntegrationTestBaseOptions {
+    /**
+     * A list of stacks within the integration test to deploy/destroy.
+     * @default ["**"]
+     */
+    readonly stacks?: string[];
+    /**
+     * AWS CDK dependency manager.
+     */
+    readonly cdkDeps: AwsCdkDeps;
+}
+/**
+ * Cloud integration tests.
+ */
+export declare class IntegrationTest extends IntegrationTestBase {
+    /**
+     * Destroy the integration test resources
+     */
+    readonly destroyTask: Task;
+    /**
+     * The watch task.
+     */
+    readonly watchTask: Task;
+    constructor(project: Project, options: IntegrationTestOptions);
+}

package/lib/.types-compat/ts3.9/lib/awscdk/internal.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Feature flags as of v1.130.0
+ */
+export declare const FEATURE_FLAGS: string[];
+/**
+ * Suffix for AWS Lambda handlers.
+ */
+export declare const TYPESCRIPT_LAMBDA_EXT = ".lambda.ts";
+/**
+ * Suffix for AWS Edge Lambda handlers.
+ */
+export declare const TYPESCRIPT_EDGE_LAMBDA_EXT = ".edge-lambda.ts";
+/**
+ * Suffix for AWS Lambda Extensions.
+ */
+export declare const TYPESCRIPT_LAMBDA_EXTENSION_EXT = ".lambda-extension.ts";
+/**
+ * Converts the given path string to posix if it wasn't already.
+ */
+export declare function convertToPosixPath(p: string): string;

package/lib/.types-compat/ts3.9/lib/awscdk/lambda-extension.d.ts

@@ -0,0 +1,68 @@
+import { AwsCdkDeps } from "./awscdk-deps";
+import { LambdaRuntime } from "./lambda-function";
+import { Component } from "../component";
+import { BundlingOptions } from "../javascript";
+import { Project } from "../project";
+/**
+ * Common options for creating lambda extensions.
+ */
+export interface LambdaExtensionCommonOptions {
+    /**
+     * The extension's compatible runtimes.
+     */
+    readonly compatibleRuntimes?: LambdaRuntime[];
+    /**
+     * Bundling options for this AWS Lambda extension.
+     *
+     * If not specified the default bundling options specified for the project
+     * `Bundler` instance will be used.
+     *
+     * @default - defaults
+     */
+    readonly bundlingOptions?: BundlingOptions;
+}
+/**
+ * Options for creating lambda extensions.
+ */
+export interface LambdaExtensionOptions extends LambdaExtensionCommonOptions {
+    /**
+     * Name of the extension
+     *
+     * @default - Derived from the entrypoint filename.
+     */
+    readonly name?: string;
+    /**
+     * A path from the project root directory to a TypeScript file which contains
+     * the AWS Lambda extension entrypoint (stand-alone script).
+     *
+     * This is relative to the root directory of the project.
+     *
+     * @example "src/subdir/foo.lambda-extension.ts"
+     */
+    readonly entrypoint: string;
+    /**
+     * AWS CDK dependency manager.
+     */
+    readonly cdkDeps: AwsCdkDeps;
+    /**
+     * The name of the generated TypeScript source file. This file should also be
+     * under the source tree.
+     *
+     * @default - The name of the entrypoint file, with the `-layer-version.ts`
+     * suffix instead of `.lambda-extension.ts`.
+     */
+    readonly constructFile?: string;
+    /**
+     * The name of the generated `lambda.LayerVersion` subclass.
+     *
+     * @default - A pascal cased version of the name of the entrypoint file, with
+     * the extension `LayerVersion` (e.g. `AppConfigLayerVersion`).
+     */
+    readonly constructName?: string;
+}
+/**
+ * Create a Lambda Extension
+ */
+export declare class LambdaExtension extends Component {
+    constructor(project: Project, options: LambdaExtensionOptions);
+}

package/lib/.types-compat/ts3.9/lib/awscdk/lambda-function.d.ts

@@ -0,0 +1,171 @@
+import { AwsCdkDeps } from "./awscdk-deps";
+import { Component } from "../component";
+import { BundlingOptions } from "../javascript";
+import { Project } from "../project";
+/**
+ * Common options for `LambdaFunction`. Applies to all functions in
+ * auto-discovery.
+ */
+export interface LambdaFunctionCommonOptions {
+    /**
+     * The node.js version to target.
+     *
+     * @default Runtime.NODEJS_16_X
+     */
+    readonly runtime?: LambdaRuntime;
+    /**
+     * Bundling options for this AWS Lambda function.
+     *
+     * If not specified the default bundling options specified for the project
+     * `Bundler` instance will be used.
+     *
+     * @default - defaults
+     */
+    readonly bundlingOptions?: BundlingOptions;
+    /**
+     * Whether to automatically reuse TCP connections when working with the AWS
+     * SDK for JavaScript.
+     *
+     * This sets the `AWS_NODEJS_CONNECTION_REUSE_ENABLED` environment variable
+     * to `1`.
+     *
+     * Not applicable when `edgeLambda` is set to `true` because environment
+     * variables are not supported in Lambda@Edge.
+     *
+     * @see https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/node-reusing-connections.html
+     *
+     * @default true
+     */
+    readonly awsSdkConnectionReuse?: boolean;
+    /**
+     * Whether to create a `cloudfront.experimental.EdgeFunction` instead
+     * of a `lambda.Function`.
+     *
+     * @default false
+     */
+    readonly edgeLambda?: boolean;
+}
+/**
+ * Options for `Function`.
+ */
+export interface LambdaFunctionOptions extends LambdaFunctionCommonOptions {
+    /**
+     * A path from the project root directory to a TypeScript file which contains
+     * the AWS Lambda handler entrypoint (exports a `handler` function).
+     *
+     * This is relative to the root directory of the project.
+     *
+     * @example "src/subdir/foo.lambda.ts"
+     */
+    readonly entrypoint: string;
+    /**
+     * The name of the generated TypeScript source file. This file should also be
+     * under the source tree.
+     *
+     * @default - The name of the entrypoint file, with the `-function.ts` suffix
+     * instead of `.lambda.ts`.
+     */
+    readonly constructFile?: string;
+    /**
+     * The name of the generated `lambda.Function` subclass.
+     *
+     * @default - A pascal cased version of the name of the entrypoint file, with
+     * the extension `Function` (e.g. `ResizeImageFunction`).
+     */
+    readonly constructName?: string;
+    /**
+     * AWS CDK dependency manager.
+     */
+    readonly cdkDeps: AwsCdkDeps;
+}
+/**
+ * Generates a pre-bundled AWS Lambda function construct from handler code.
+ *
+ * To use this, create an AWS Lambda handler file under your source tree with
+ * the `.lambda.ts` extension and add a `LambdaFunction` component to your
+ * typescript project pointing to this entrypoint.
+ *
+ * This will add a task to your "compile" step which will use `esbuild` to
+ * bundle the handler code into the build directory. It will also generate a
+ * file `src/foo-function.ts` with a custom AWS construct called `FooFunction`
+ * which extends `@aws-cdk/aws-lambda.Function` which is bound to the bundled
+ * handle through an asset.
+ *
+ * @example
+ *
+ * new LambdaFunction(myProject, {
+ *   srcdir: myProject.srcdir,
+ *   entrypoint: 'src/foo.lambda.ts',
+ * });
+ */
+export declare class LambdaFunction extends Component {
+    /**
+     * Defines a pre-bundled AWS Lambda function construct from handler code.
+     *
+     * @param project The project to use
+     * @param options Options
+     */
+    constructor(project: Project, options: LambdaFunctionOptions);
+}
+/**
+ * Options for the AWS Lambda function runtime
+ */
+export interface LambdaRuntimeOptions {
+    /**
+     * Packages that are considered externals by default when bundling
+     *
+     * @default ['@aws-sdk/*']
+     */
+    readonly defaultExternals?: string[];
+}
+/**
+ * The runtime for the AWS Lambda function.
+ */
+export declare class LambdaRuntime {
+    /**
+     * The Node.js runtime to use
+     */
+    readonly functionRuntime: string;
+    /**
+     * The esbuild setting to use.
+     */
+    readonly esbuildTarget: string;
+    /**
+     * Node.js 10.x
+     * @deprecated NodeJS10 has been deprecated
+     */
+    static readonly NODEJS_10_X: LambdaRuntime;
+    /**
+     * Node.js 12.x
+     * @deprecated NodeJS12 has been deprecated
+     */
+    static readonly NODEJS_12_X: LambdaRuntime;
+    /**
+     * Node.js 14.x
+     * @deprecated NodeJS14 has been deprecated
+     */
+    static readonly NODEJS_14_X: LambdaRuntime;
+    /**
+     * Node.js 16.x
+     */
+    static readonly NODEJS_16_X: LambdaRuntime;
+    /**
+     * Node.js 18.x
+     */
+    static readonly NODEJS_18_X: LambdaRuntime;
+    readonly esbuildPlatform = "node";
+    readonly defaultExternals: string[];
+    constructor(
+    /**
+     * The Node.js runtime to use
+     */
+    functionRuntime: string, 
+    /**
+     * The esbuild setting to use.
+     */
+    esbuildTarget: string, 
+    /**
+     * Options for this runtime.
+     */
+    options?: LambdaRuntimeOptions);
+}

package/lib/.types-compat/ts3.9/lib/build/build-workflow.d.ts

@@ -0,0 +1,180 @@
+import { Task } from "..";
+import { Component } from "../component";
+import { GitIdentity } from "../github";
+import { Job, JobPermissions, JobStep, Tools, Triggers } from "../github/workflows-model";
+import { Project } from "../project";
+export interface BuildWorkflowOptions {
+    /**
+     * The task to execute in order to build the project.
+     */
+    readonly buildTask: Task;
+    /**
+     * A name of a directory that includes build artifacts.
+     */
+    readonly artifactsDirectory: string;
+    /**
+     * The container image to use for builds.
+     * @default - the default workflow container
+     */
+    readonly containerImage?: string;
+    /**
+     * Automatically update files modified during builds to pull-request branches.
+     * This means that any files synthesized by projen or e.g. test snapshots will
+     * always be up-to-date before a PR is merged.
+     *
+     * Implies that PR builds do not have anti-tamper checks.
+     *
+     * This is enabled by default only if `githubTokenSecret` is set. Otherwise it
+     * is disabled, which implies that file changes that happen during build will
+     * not be pushed back to the branch.
+     *
+     * @default true
+     */
+    readonly mutableBuild?: boolean;
+    /**
+     * Steps to execute before the build.
+     * @default []
+     */
+    readonly preBuildSteps?: JobStep[];
+    /**
+     * Steps to execute after build.
+     * @default []
+     */
+    readonly postBuildSteps?: JobStep[];
+    /**
+     * Git identity to use for the workflow.
+     * @default - default identity
+     */
+    readonly gitIdentity?: GitIdentity;
+    /**
+     * Build environment variables.
+     * @default {}
+     */
+    readonly env?: {
+        [key: string]: string;
+    };
+    /**
+     * Github Runner selection labels
+     * @default ["ubuntu-latest"]
+     */
+    readonly runsOn?: string[];
+    /**
+     * Build workflow triggers
+     * @default "{ pullRequest: {}, workflowDispatch: {} }"
+     */
+    readonly workflowTriggers?: Triggers;
+    /**
+     * Permissions granted to the build job
+     * To limit job permissions for `contents`, the desired permissions have to be explicitly set, e.g.: `{ contents: JobPermission.NONE }`
+     * @default `{ contents: JobPermission.WRITE }`
+     */
+    readonly permissions?: JobPermissions;
+}
+export declare class BuildWorkflow extends Component {
+    private readonly postBuildSteps;
+    private readonly preBuildSteps;
+    private readonly gitIdentity;
+    private readonly buildTask;
+    private readonly github;
+    private readonly workflow;
+    private readonly artifactsDirectory;
+    private readonly defaultRunners;
+    private readonly _postBuildJobs;
+    constructor(project: Project, options: BuildWorkflowOptions);
+    private addBuildJob;
+    /**
+     * Returns a list of job IDs that are part of the build.
+     */
+    get buildJobIds(): string[];
+    /**
+     * Adds steps that are executed after the build.
+     * @param steps The job steps
+     */
+    addPostBuildSteps(...steps: JobStep[]): void;
+    /**
+     * Adds another job to the build workflow which is executed after the build
+     * job succeeded.
+     *
+     * Jobs are executed _only_ if the build did NOT self mutate. If the build
+     * self-mutate, the branch will either be updated or the build will fail (in
+     * forks), so there is no point in executing the post-build job.
+     *
+     * @param id The id of the new job
+     * @param job The job specification
+     */
+    addPostBuildJob(id: string, job: Job): void;
+    /**
+     * Run a task as a job within the build workflow which is executed after the
+     * build job succeeded.
+     *
+     * The job will have access to build artifacts and will install project
+     * dependencies in order to be able to run any commands used in the tasks.
+     *
+     * Jobs are executed _only_ if the build did NOT self mutate. If the build
+     * self-mutate, the branch will either be updated or the build will fail (in
+     * forks), so there is no point in executing the post-build job.
+     *
+     * @param options Specify tools and other options
+     */
+    addPostBuildJobTask(task: Task, options?: AddPostBuildJobTaskOptions): void;
+    /**
+     * Run a sequence of commands as a job within the build workflow which is
+     * executed after the build job succeeded.
+     *
+     * Jobs are executed _only_ if the build did NOT self mutate. If the build
+     * self-mutate, the branch will either be updated or the build will fail (in
+     * forks), so there is no point in executing the post-build job.
+     *
+     * @param options Specify tools and other options
+     */
+    addPostBuildJobCommands(id: string, commands: string[], options?: AddPostBuildJobCommandsOptions): void;
+    private addSelfMutationJob;
+    /**
+     * Called (lazily) during synth to render the build job steps.
+     */
+    private renderBuildSteps;
+}
+/**
+ * Options for `BuildWorkflow.addPostBuildJobTask`
+ */
+export interface AddPostBuildJobTaskOptions {
+    /**
+     * Tools that should be installed before the task is run.
+     */
+    readonly tools?: Tools;
+    /**
+     * Github Runner selection labels
+     * @default ["ubuntu-latest"]
+     */
+    readonly runsOn?: string[];
+}
+/**
+ * Options for `BuildWorkflow.addPostBuildJobCommands`
+ */
+export interface AddPostBuildJobCommandsOptions {
+    /**
+     * Tools that should be installed before the commands are run.
+     */
+    readonly tools?: Tools;
+    /**
+     * Check out the repository at the pull request branch before commands are
+     * run.
+     *
+     * @default false
+     */
+    readonly checkoutRepo?: boolean;
+    /**
+     * Install project dependencies before running commands. `checkoutRepo` must
+     * also be set to true.
+     *
+     * Currently only supported for `NodeProject`.
+     *
+     * @default false
+     */
+    readonly installDeps?: boolean;
+    /**
+     * Github Runner selection labels
+     * @default ["ubuntu-latest"]
+     */
+    readonly runsOn?: string[];
+}

package/lib/.types-compat/ts3.9/lib/build/index.d.ts

@@ -0,0 +1 @@
+export * from "./build-workflow";