projen 0.70.2 → 0.70.4

package/lib/.types-compat/ts3.9/lib/docker-compose/docker-compose.d.ts

@@ -0,0 +1,99 @@
+import { DockerComposeNetworkConfig, IDockerComposeNetworkBinding } from "./docker-compose-network";
+import { DockerComposePortMappingOptions, DockerComposeServicePort } from "./docker-compose-port";
+import { DockerComposeService, DockerComposeServiceDescription, IDockerComposeServiceName } from "./docker-compose-service";
+import { DockerComposeVolumeConfig, IDockerComposeVolumeBinding } from "./docker-compose-volume";
+import { Component } from "../component";
+import { Project } from "../project";
+/**
+ * Props for DockerCompose.
+ */
+export interface DockerComposeProps {
+    /**
+     * A name to add to the docker-compose.yml filename.
+     * @example 'myname' yields 'docker-compose.myname.yml'
+     * @default - no name is added
+     */
+    readonly nameSuffix?: string;
+    /**
+     * Docker Compose schema version do be used
+     * @default 3.3
+     */
+    readonly schemaVersion?: string;
+    /**
+     * Service descriptions.
+     */
+    readonly services?: Record<string, DockerComposeServiceDescription>;
+}
+/**
+ * Create a docker-compose YAML file.
+ */
+export declare class DockerCompose extends Component {
+    /**
+     * Depends on a service name.
+     */
+    static serviceName(serviceName: string): IDockerComposeServiceName;
+    /**
+     * Create a port mapping.
+     * @param publishedPort Published port number
+     * @param targetPort Container's port number
+     * @param options Port mapping options
+     */
+    static portMapping(publishedPort: number, targetPort: number, options?: DockerComposePortMappingOptions): DockerComposeServicePort;
+    /**
+     * Create a bind volume that binds a host path to the target path in the container.
+     * @param sourcePath Host path name
+     * @param targetPath Target path name
+     */
+    static bindVolume(sourcePath: string, targetPath: string): IDockerComposeVolumeBinding;
+    /**
+     * Create a named volume and mount it to the target path. If you use this
+     * named volume in several services, the volume will be shared. In this
+     * case, the volume configuration of the first-provided options are used.
+     *
+     * @param volumeName Name of the volume
+     * @param targetPath Target path
+     * @param options volume configuration (default: docker compose defaults)
+     */
+    static namedVolume(volumeName: string, targetPath: string, options?: DockerComposeVolumeConfig): IDockerComposeVolumeBinding;
+    /**
+     * Create a named network and mount it to the target path. If you use this
+     * named network in several services, the network will be shared. In this
+     * case, the network configuration of the first-provided options are used.
+     *
+     * @param networkName Name of the network
+     * @param options network configuration
+     */
+    static network(networkName: string, options?: DockerComposeNetworkConfig): IDockerComposeNetworkBinding;
+    private readonly services;
+    private readonly version;
+    constructor(project: Project, props?: DockerComposeProps);
+    /**
+     * Add a service to the docker-compose file.
+     * @param serviceName name of the service
+     * @param description a service description
+     */
+    addService(serviceName: string, description: DockerComposeServiceDescription): DockerComposeService;
+    /**
+     * @internal
+     */
+    _synthesizeDockerCompose(): object;
+}
+/**
+ * Build arguments for creating a docker image.
+ */
+export interface DockerComposeBuild {
+    /**
+     * Docker build context directory.
+     */
+    readonly context: string;
+    /**
+     * A dockerfile to build from.
+     * @default "Dockerfile"
+     */
+    readonly dockerfile?: string;
+    /**
+     * Build args.
+     * @default - none are provided
+     */
+    readonly args?: Record<string, string>;
+}

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

@@ -0,0 +1,5 @@
+export * from "./docker-compose-port";
+export * from "./docker-compose-service";
+export * from "./docker-compose-volume";
+export * from "./docker-compose-network";
+export * from "./docker-compose";

package/lib/.types-compat/ts3.9/lib/file.d.ts

@@ -0,0 +1,119 @@
+import { Component } from "./component";
+import { Project } from "./project";
+export interface FileBaseOptions {
+    /**
+     * Indicates whether this file should be committed to git or ignored. By
+     * default, all generated files are committed and anti-tamper is used to
+     * protect against manual modifications.
+     *
+     * @default true
+     */
+    readonly committed?: boolean;
+    /**
+     * Update the project's .gitignore file
+     * @default true
+     */
+    readonly editGitignore?: boolean;
+    /**
+     * Whether the generated file should be readonly.
+     *
+     * @default true
+     */
+    readonly readonly?: boolean;
+    /**
+     * Whether the generated file should be marked as executable.
+     *
+     * @default false
+     */
+    readonly executable?: boolean;
+    /**
+     * Adds the projen marker to the file.
+     *
+     * @default - marker will be included as long as the project is not ejected
+     */
+    readonly marker?: boolean;
+}
+export declare abstract class FileBase extends Component {
+    /**
+     * The file path, relative to the project root.
+     */
+    readonly path: string;
+    /**
+     * Indicates if the file should be read-only or read-write.
+     */
+    readonly: boolean;
+    /**
+     * Indicates if the file should be marked as executable
+     */
+    executable: boolean;
+    /**
+     * The projen marker, used to identify files as projen-generated.
+     *
+     * Value is undefined if the project is being ejected.
+     */
+    readonly marker: string | undefined;
+    /**
+     * The absolute path of this file.
+     */
+    readonly absolutePath: string;
+    private _changed?;
+    constructor(project: Project, filePath: string, options?: FileBaseOptions);
+    /**
+     * Implemented by derived classes and returns the contents of the file to
+     * emit.
+     * @param resolver Call `resolver.resolve(obj)` on any objects in order to
+     * resolve token functions.
+     * @returns the content to synthesize or undefined to skip the file
+     */
+    protected abstract synthesizeContent(resolver: IResolver): string | undefined;
+    /**
+     * Writes the file to the project's output directory
+     */
+    synthesize(): void;
+    /**
+     * For debugging, check whether a file was incorrectly generated with
+     * or without the projen marker. The projen marker does not *need* to be
+     * included on projen-generated files, but it's recommended since it signals
+     * that it probably should not be edited directly.
+     */
+    private checkForProjenMarker;
+    /**
+     * Indicates if the file has been changed during synthesis. This property is
+     * only available in `postSynthesize()` hooks. If this is `undefined`, the
+     * file has not been synthesized yet.
+     */
+    get changed(): boolean | undefined;
+}
+/**
+ * API for resolving tokens when synthesizing file content.
+ */
+export interface IResolver {
+    /**
+     * Given a value (object/string/array/whatever, looks up any functions inside
+     * the object and returns an object where all functions are called.
+     * @param value The value to resolve
+     * @package options Resolve options
+     */
+    resolve(value: any, options?: ResolveOptions): any;
+}
+/**
+ * Resolve options.
+ */
+export interface ResolveOptions {
+    /**
+     * Omits empty arrays and objects.
+     * @default false
+     */
+    readonly omitEmpty?: boolean;
+    /**
+     * Context arguments.
+     * @default []
+     */
+    readonly args?: any[];
+}
+export interface IResolvable {
+    /**
+     * Resolves and returns content.
+     */
+    toJSON(): any;
+}

package/lib/.types-compat/ts3.9/lib/gitattributes.d.ts

@@ -0,0 +1,26 @@
+import { IResolver, FileBase } from "./file";
+import { Project } from "./project";
+/**
+ * Assign attributes to file names in a git repository.
+ *
+ * @see https://git-scm.com/docs/gitattributes
+ */
+export declare class GitAttributesFile extends FileBase {
+    private readonly attributes;
+    constructor(project: Project);
+    /**
+     * Maps a set of attributes to a set of files.
+     * @param glob Glob pattern to match files in the repo
+     * @param attributes Attributes to assign to these files.
+     */
+    addAttributes(glob: string, ...attributes: string[]): void;
+    /**
+     * Add attributes necessary to mark these files as stored in LFS
+     */
+    addLfsPattern(glob: string): void;
+    /**
+     * Whether the current gitattributes file has any LFS patterns
+     */
+    get hasLfsPatterns(): boolean;
+    protected synthesizeContent(_: IResolver): string | undefined;
+}

package/lib/.types-compat/ts3.9/lib/github/actions-provider.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Manage the versions used for GitHub Actions used in steps
+ */
+export declare class GitHubActionsProvider {
+    private actions;
+    /**
+     * Define an override for a given action.
+     *
+     * Specify the action name without a version to override all usages of the action.
+     * You can also override a specific action version, by providing the version string.
+     * Specific overrides take precedence over overrides without a version.
+     *
+     * If an override for the same action name is set multiple times, the last override is used.
+     *
+     * @example
+     * // Force any use of `actions/checkout` to use a pin a specific commit
+     * project.github.actions.set("actions/checkout", "actions/checkout@aaaaaa");
+     *
+     * // But pin usage of `v3` to a different commit
+     * project.github.actions.set("actions/checkout@v3", "actions/checkout@ffffff");
+     */
+    set(action: string, override: string): void;
+    /**
+     * Resolve an action name to the version that should be used,
+     * taking into account any overrides.
+     */
+    get(action: string): string;
+}

package/lib/.types-compat/ts3.9/lib/github/auto-approve.d.ts

@@ -0,0 +1,44 @@
+import { GitHub } from "./github";
+import { Component } from "../component";
+/**
+ * Options for 'AutoApprove'
+ */
+export interface AutoApproveOptions {
+    /**
+     * Only pull requests authored by these Github usernames will be auto-approved.
+     * @default ['github-bot']
+     */
+    readonly allowedUsernames?: string[];
+    /**
+     * Only pull requests with this label will be auto-approved.
+     * @default 'auto-approve'
+     */
+    readonly label?: string;
+    /**
+     * A GitHub secret name which contains a GitHub Access Token
+     * with write permissions for the `pull_request` scope.
+     *
+     * This token is used to approve pull requests.
+     *
+     * Github forbids an identity to approve its own pull request.
+     * If your project produces automated pull requests using the Github default token -
+     * {@link https://docs.github.com/en/actions/reference/authentication-in-a-workflow `GITHUB_TOKEN` }
+     * - that you would like auto approved, such as when using the `depsUpgrade` property in
+     * `NodeProjectOptions`, then you must use a different token here.
+     *
+     * @default "GITHUB_TOKEN"
+     */
+    readonly secret?: string;
+    /**
+     * Github Runner selection labels
+     * @default ["ubuntu-latest"]
+     */
+    readonly runsOn?: string[];
+}
+/**
+ * Auto approve pull requests that meet a criteria
+ */
+export declare class AutoApprove extends Component {
+    readonly label: string;
+    constructor(github: GitHub, options?: AutoApproveOptions);
+}

package/lib/.types-compat/ts3.9/lib/github/auto-merge.d.ts

@@ -0,0 +1,41 @@
+import { GitHub } from "./github";
+import { Component } from "../component";
+export interface AutoMergeOptions {
+    /**
+     * Number of approved code reviews.
+     * @default 1
+     */
+    readonly approvedReviews?: number;
+    /**
+     * List of labels that will prevent auto-merging.
+     * @default ['do-not-merge']
+     */
+    readonly blockingLabels?: string[];
+}
+/**
+ * Sets up mergify to merging approved pull requests.
+ *
+ * If `buildJob` is specified, the specified GitHub workflow job ID is required
+ * to succeed in order for the PR to be merged.
+ *
+ * `approvedReviews` specified the number of code review approvals required for
+ * the PR to be merged.
+ */
+export declare class AutoMerge extends Component {
+    private readonly lazyConditions;
+    constructor(github: GitHub, options?: AutoMergeOptions);
+    /**
+     * Adds conditions to the auto merge rule.
+     * @param conditions The conditions to add (mergify syntax)
+     */
+    addConditions(...conditions: string[]): void;
+    /**
+     * Adds conditions that will be rendered only during synthesis.
+     * @param later The later
+     */
+    addConditionsLater(later: IAddConditionsLater): void;
+    private renderConditions;
+}
+export interface IAddConditionsLater {
+    render(): string[];
+}

package/lib/.types-compat/ts3.9/lib/github/constants.d.ts

@@ -0,0 +1,20 @@
+import { GitIdentity } from ".";
+/**
+ * Name of the artifact produced by the build job. Its contains the entire
+ * working directory.
+ */
+export declare const BUILD_ARTIFACT_NAME = "build-artifact";
+/**
+ * Represents the github-actions user.
+ *
+ * Use this when you need to perform a commit as part of your workflow.
+ */
+export declare const DEFAULT_GITHUB_ACTIONS_USER: GitIdentity;
+/**
+ * Name of the permission back up file to include in the build artifact
+ * to work around a GitHub Action bug that does not preserve file mode
+ * permissions across upload and download actions.
+ *
+ * See {@link https://github.com/actions/upload-artifact/issues/38}
+ */
+export declare const PERMISSION_BACKUP_FILE = "permissions-backup.acl";

package/lib/.types-compat/ts3.9/lib/github/dependabot.d.ts

@@ -0,0 +1,247 @@
+import { GitHub } from "./github";
+import { Component } from "../component";
+export interface DependabotOptions {
+    /**
+     * How often to check for new versions and raise pull requests.
+     *
+     * @default ScheduleInterval.DAILY
+     */
+    readonly scheduleInterval?: DependabotScheduleInterval;
+    /**
+     * The strategy to use when edits manifest and lock files.
+     *
+     * @default VersioningStrategy.LOCKFILE_ONLY The default is to only update the
+     * lock file because package.json is controlled by projen and any outside
+     * updates will fail the build.
+     */
+    readonly versioningStrategy?: VersioningStrategy;
+    /**
+     * You can use the `ignore` option to customize which dependencies are updated.
+     * The ignore option supports the following options.
+     * @default []
+     */
+    readonly ignore?: DependabotIgnore[];
+    /**
+     * Ignores updates to `projen`.
+     *
+     * This is required since projen updates may cause changes in committed files
+     * and anti-tamper checks will fail.
+     *
+     * Projen upgrades are covered through the `ProjenUpgrade` class.
+     *
+     * @default true
+     */
+    readonly ignoreProjen?: boolean;
+    /**
+     * List of labels to apply to the created PR's.
+     */
+    readonly labels?: string[];
+    /**
+     * Map of package registries to use
+     * @default - use public registries
+     */
+    readonly registries?: {
+        [name: string]: DependabotRegistry;
+    };
+}
+/**
+ * Use to add private registry support for dependabot
+ * @see https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#configuration-options-for-private-registries
+ */
+export interface DependabotRegistry {
+    /**
+     * Registry type e.g. 'npm-registry' or 'docker-registry'
+     */
+    readonly type: DependabotRegistryType;
+    /**
+     * Url for the registry e.g. 'https://npm.pkg.github.com' or 'registry.hub.docker.com'
+     */
+    readonly url: string;
+    /**
+     * The username that Dependabot uses to access the registry
+     * @default - do not authenticate
+     */
+    readonly username?: string;
+    /**
+     * A reference to a Dependabot secret containing the password for the specified user
+     * @default undefined
+     */
+    readonly password?: string;
+    /**
+     * A reference to a Dependabot secret containing an access key for this registry
+     * @default undefined
+     */
+    readonly key?: string;
+    /**
+     * Secret token for dependabot access e.g. '${{ secrets.DEPENDABOT_PACKAGE_TOKEN }}'
+     * @default undefined
+     */
+    readonly token?: string;
+    /**
+     * For registries with type: python-index, if the boolean value is true, pip
+     * esolves dependencies by using the specified URL rather than the base URL of
+     * the Python Package Index (by default https://pypi.org/simple)
+     * @default undefined
+     */
+    readonly replacesBase?: boolean;
+    /**
+     * Used with the hex-organization registry type.
+     * @see https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#hex-organization
+     * @default undefined
+     */
+    readonly organization?: string;
+}
+/**
+ * Each configuration type requires you to provide particular settings.
+ * Some types allow more than one way to connect
+ * @see https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#configuration-options-for-private-registries
+ */
+export declare enum DependabotRegistryType {
+    /**
+     * The composer-repository type supports username and password.
+     * @see https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#composer-repository
+     */
+    COMPOSER_REGISTRY = "composer-registry",
+    /**
+     * The docker-registry type supports username and password.
+     * The docker-registry type can also be used to pull from Amazon ECR using static AWS credentials
+     * @see https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#docker-registry
+     */
+    DOCKER_REGISTRY = "docker-registry",
+    /**
+     * The git type supports username and password
+     * @see https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#git
+     */
+    GIT = "git",
+    /**
+     * The hex-organization type supports organization and key
+     * @see https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#hex-organization
+     */
+    HEX_ORGANIZATION = "hex-organization",
+    /**
+     * The maven-repository type supports username and password, or token
+     * @see https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#maven-repository
+     */
+    MAVEN_REPOSITORY = "maven-repository",
+    /**
+     * The npm-registry type supports username and password, or token
+     * @see https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#npm-registry
+     */
+    NPM_REGISTRY = "npm-registry",
+    /**
+     * The nuget-feed type supports username and password, or token
+     * @see https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#nuget-feed
+     */
+    NUGET_FEED = "nuget-feed",
+    /**
+     * The python-index type supports username and password, or token
+     * @see https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#python-index
+     */
+    PYTHON_INDEX = "python-index",
+    /**
+     * The rubygems-server type supports username and password, or token
+     * @see https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#rubygems-server
+     */
+    RUBYGEMS_SERVER = "rubygems-server",
+    /**
+     * The terraform-registry type supports a token
+     * @see https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#terraform-registry
+     */
+    TERRAFORM_REGISTRY = "terraform-registry"
+}
+/**
+ * You can use the `ignore` option to customize which dependencies are updated.
+ * The ignore option supports the following options.
+ */
+export interface DependabotIgnore {
+    /**
+     * Use to ignore updates for dependencies with matching names, optionally
+     * using `*` to match zero or more characters.
+     *
+     * For Java dependencies, the format of the dependency-name attribute is:
+     * `groupId:artifactId`, for example: `org.kohsuke:github-api`.
+     */
+    readonly dependencyName: string;
+    /**
+     * Use to ignore specific versions or ranges of versions. If you want to
+     * define a range, use the standard pattern for the package manager (for
+     * example: `^1.0.0` for npm, or `~> 2.0` for Bundler).
+     */
+    readonly versions?: string[];
+}
+/**
+ * How often to check for new versions and raise pull requests for version
+ * updates.
+ */
+export declare enum DependabotScheduleInterval {
+    /**
+     * Runs on every weekday, Monday to Friday.
+     */
+    DAILY = "daily",
+    /**
+     * Runs once each week. By default, this is on Monday.
+     */
+    WEEKLY = "weekly",
+    /**
+     * Runs once each month. This is on the first day of the month.
+     */
+    MONTHLY = "monthly"
+}
+/**
+ * The strategy to use when edits manifest and lock files.
+ */
+export declare enum VersioningStrategy {
+    /**
+     * Only create pull requests to update lockfiles updates. Ignore any new
+     * versions that would require package manifest changes.
+     */
+    LOCKFILE_ONLY = "lockfile-only",
+    /**
+     * - For apps, the version requirements are increased.
+     * - For libraries, the range of versions is widened.
+     */
+    AUTO = "auto",
+    /**
+     * Relax the version requirement to include both the new and old version, when
+     * possible.
+     */
+    WIDEN = "widen",
+    /**
+     * Always increase the version requirement to match the new version.
+     */
+    INCREASE = "increase",
+    /**
+     * Increase the version requirement only when required by the new version.
+     */
+    INCREASE_IF_NECESSARY = "increase-if-necessary"
+}
+/**
+ * Defines dependabot configuration for node projects.
+ *
+ * Since module versions are managed in projen, the versioning strategy will be
+ * configured to "lockfile-only" which means that only updates that can be done
+ * on the lockfile itself will be proposed.
+ */
+export declare class Dependabot extends Component {
+    /**
+     * The raw dependabot configuration.
+     * @see https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates
+     */
+    readonly config: any;
+    /**
+     * Whether or not projen is also upgraded in this config,
+     */
+    readonly ignoresProjen: boolean;
+    private readonly ignore;
+    constructor(github: GitHub, options?: DependabotOptions);
+    /**
+     * Ignores a dependency from automatic updates.
+     *
+     * @param dependencyName Use to ignore updates for dependencies with matching
+     * names, optionally using `*` to match zero or more characters.
+     * @param versions Use to ignore specific versions or ranges of versions. If
+     * you want to define a range, use the standard pattern for the package
+     * manager (for example: `^1.0.0` for npm, or `~> 2.0` for Bundler).
+     */
+    addIgnore(dependencyName: string, ...versions: string[]): void;
+}