projen 0.71.13 → 0.71.15

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

@@ -1,103 +0,0 @@
-/**
- * IPAM subnet configuration
- */
-export interface DockerComposeNetworkIpamSubnetConfig {
-    /**
-     * Subnet in CIDR format that represents a network segment
-     * @default - value is not provided
-     */
-    readonly subnet?: string;
-}
-/**
- * IPAM configuration
- */
-export interface DockerComposeNetworkIpamConfig {
-    /**
-     * Driver to use for custom IPAM config.
-     * @default - value is not provided
-     */
-    readonly driver?: string;
-    /**
-     * A list with zero or more config blocks specifying custom IPAM configuration.
-     * @default - value is not provided
-     */
-    readonly config?: DockerComposeNetworkIpamSubnetConfig[];
-}
-/**
- * Network configuration
- */
-export interface DockerComposeNetworkConfig {
-    /**
-     * Driver to use for the network
-     * @default - value is not provided
-     */
-    readonly driver?: string;
-    /**
-     * Options for the configured driver. Those options are driver-dependent - consult the driver’s documentation for more information
-     * @default - value is not provided
-     */
-    readonly driverOpts?: object;
-    /**
-     * Set to true to indicate that the network is a bridge network.
-     * @default - unset
-     */
-    readonly bridge?: boolean;
-    /**
-     * Set to true to indicate that the network is an overlay network.
-     * @default - unset
-     */
-    readonly overlay?: boolean;
-    /**
-     * Set to true to indicate that the network is externally created.
-     * @default - unset, indicating that docker-compose creates the network
-     */
-    readonly external?: boolean;
-    /**
-     * Set to true to indicate that standalone containers can attach to this network, in addition to services.
-     * @default - unset
-     */
-    readonly attachable?: boolean;
-    /**
-     * Specify custom IPAM config.
-     * @default - unset
-     */
-    readonly ipam?: DockerComposeNetworkIpamConfig;
-    /**
-     * Set to true to indicate that you want to create an externally isolated overlay network
-     * @default - unset
-     */
-    readonly internal?: boolean;
-    /**
-     * Attach labels to the network
-     * @default - unset
-     */
-    readonly labels?: string[];
-    /**
-     * Name of the network for when the network name isn't going to work in YAML.
-     * @default - unset, indicating that docker-compose creates networks as usual
-     */
-    readonly name?: string;
-}
-/**
- * Network binding information.
- */
-export interface IDockerComposeNetworkBinding {
-    /**
-     * Binds the requested network to the docker-compose network configuration and
-     * provide mounting instructions for synthesis.
-     * @param networkConfig the network configuration
-     * @returns the service name
-     */
-    bind(networkConfig: IDockerComposeNetworkConfig): string;
-}
-/**
- * Storage for network configuration.
- */
-export interface IDockerComposeNetworkConfig {
-    /**
-     * Add network configuration to the repository.
-     * @param networkName
-     * @param configuration
-     */
-    addNetworkConfiguration(networkName: string, configuration: DockerComposeNetworkConfig): void;
-}

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

@@ -1,44 +0,0 @@
-/**
- * Options for port mappings.
- */
-export interface DockerComposePortMappingOptions {
-    /**
-     * Port mapping protocol.
-     * @default DockerComposeProtocol.TCP
-     */
-    readonly protocol?: DockerComposeProtocol;
-}
-/**
- * A service port mapping
- */
-export interface DockerComposeServicePort {
-    /**
-     * Published port number
-     */
-    readonly published: number;
-    /**
-     * Target port number
-     */
-    readonly target: number;
-    /**
-     * Network protocol
-     */
-    readonly protocol: DockerComposeProtocol;
-    /**
-     * Port mapping mode.
-     */
-    readonly mode: string;
-}
-/**
- * Network protocol for port mapping
- */
-export declare enum DockerComposeProtocol {
-    /**
-     * TCP protocol
-     */
-    TCP = "tcp",
-    /**
-     * UDP protocol
-     */
-    UDP = "udp"
-}

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

@@ -1,2 +0,0 @@
-import { DockerComposeService } from "./docker-compose-service";
-export declare function renderDockerComposeFile(serviceDescriptions: Record<string, DockerComposeService>, version: string): object;

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

@@ -1,155 +0,0 @@
-import { DockerComposeBuild } from "./docker-compose";
-import { IDockerComposeNetworkBinding } from "./docker-compose-network";
-import { DockerComposePortMappingOptions, DockerComposeServicePort } from "./docker-compose-port";
-import { IDockerComposeVolumeBinding } from "./docker-compose-volume";
-/**
- * An interface providing the name of a docker compose service.
- */
-export interface IDockerComposeServiceName {
-    /**
-     * The name of the docker compose service.
-     */
-    readonly serviceName: string;
-}
-/**
- * A docker-compose service.
- */
-export declare class DockerComposeService implements IDockerComposeServiceName {
-    /**
-     * Name of the service.
-     */
-    readonly serviceName: string;
-    /**
-     * Docker image.
-     */
-    readonly image?: string;
-    /**
-     * Docker image build instructions.
-     */
-    readonly imageBuild?: DockerComposeBuild;
-    /**
-     * Command to run in the container.
-     */
-    readonly command?: string[];
-    /**
-     * Entrypoint to run in the container.
-     */
-    readonly entrypoint?: string[];
-    /**
-     * Other services that this service depends on.
-     */
-    readonly dependsOn: IDockerComposeServiceName[];
-    /**
-     * Volumes mounted in the container.
-     */
-    readonly volumes: IDockerComposeVolumeBinding[];
-    /**
-     * Networks mounted in the container.
-     */
-    readonly networks: IDockerComposeNetworkBinding[];
-    /**
-     * Published ports.
-     */
-    readonly ports: DockerComposeServicePort[];
-    /**
-     * Environment variables.
-     */
-    readonly environment: Record<string, string>;
-    /**
-     * Attached labels.
-     */
-    readonly labels: Record<string, string>;
-    constructor(serviceName: string, serviceDescription: DockerComposeServiceDescription);
-    /**
-     * Add a port mapping
-     * @param publishedPort Published port number
-     * @param targetPort Container's port number
-     * @param options Port mapping options
-     */
-    addPort(publishedPort: number, targetPort: number, options?: DockerComposePortMappingOptions): void;
-    /**
-     * Add an environment variable
-     * @param name environment variable name
-     * @param value value of the environment variable
-     */
-    addEnvironment(name: string, value: string): void;
-    /**
-     * Make the service depend on another service.
-     * @param serviceName
-     */
-    addDependsOn(serviceName: IDockerComposeServiceName): void;
-    /**
-     * Add a volume to the service.
-     * @param volume
-     */
-    addVolume(volume: IDockerComposeVolumeBinding): void;
-    /**
-     * Add a network to the service.
-     * @param network
-     */
-    addNetwork(network: IDockerComposeNetworkBinding): void;
-    /**
-     * Add a label
-     * @param name environment variable name
-     * @param value value of the environment variable
-     */
-    addLabel(name: string, value: string): void;
-}
-/**
- * Description of a docker-compose.yml service.
- */
-export interface DockerComposeServiceDescription {
-    /**
-     * Use a docker image.
-     * Note: You must specify either `build` or `image` key.
-     * @see imageBuild
-     */
-    readonly image?: string;
-    /**
-     * Build a docker image.
-     * Note: You must specify either `imageBuild` or `image` key.
-     * @see image
-     */
-    readonly imageBuild?: DockerComposeBuild;
-    /**
-     * Provide a command to the docker container.
-     * @default - use the container's default command
-     */
-    readonly command?: string[];
-    /**
-     * Entrypoint to run in the container.
-     */
-    readonly entrypoint?: string[];
-    /**
-     * Names of other services this service depends on.
-     * @default - no dependencies
-     */
-    readonly dependsOn?: IDockerComposeServiceName[];
-    /**
-     * Mount some volumes into the service.
-     * Use one of the following to create volumes:
-     * @see DockerCompose.bindVolume() to mount a host path
-     * @see DockerCompose.namedVolume() to create & mount a named volume
-     */
-    readonly volumes?: IDockerComposeVolumeBinding[];
-    /**
-     * Add some networks to the service.
-     * @see DockerCompose.network() to create & mount a named network
-     */
-    readonly networks?: IDockerComposeNetworkBinding[];
-    /**
-     * Map some ports.
-     * @default - no ports are mapped
-     */
-    readonly ports?: DockerComposeServicePort[];
-    /**
-     * Add environment variables.
-     * @default - no environment variables are provided
-     */
-    readonly environment?: Record<string, string>;
-    /**
-     * Add labels.
-     * @default - no labels are provided
-     */
-    readonly labels?: Record<string, string>;
-}

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

@@ -1,64 +0,0 @@
-/**
- * Volume configuration
- */
-export interface DockerComposeVolumeConfig {
-    /**
-     * Driver to use for the volume
-     * @default - value is not provided
-     */
-    readonly driver?: string;
-    /**
-     * Options to provide to the driver.
-     */
-    readonly driverOpts?: Record<string, string>;
-    /**
-     * Set to true to indicate that the volume is externally created.
-     * @default - unset, indicating that docker-compose creates the volume
-     */
-    readonly external?: boolean;
-    /**
-     * Name of the volume for when the volume name isn't going to work in YAML.
-     * @default - unset, indicating that docker-compose creates volumes as usual
-     */
-    readonly name?: string;
-}
-/**
- * Volume binding information.
- */
-export interface IDockerComposeVolumeBinding {
-    /**
-     * Binds the requested volume to the docker-compose volume configuration and
-     * provide mounting instructions for synthesis.
-     * @param volumeConfig the volume configuration
-     * @returns mounting instructions for the service.
-     */
-    bind(volumeConfig: IDockerComposeVolumeConfig): DockerComposeVolumeMount;
-}
-/**
- * Storage for volume configuration.
- */
-export interface IDockerComposeVolumeConfig {
-    /**
-     * Add volume configuration to the repository.
-     * @param volumeName
-     * @param configuration
-     */
-    addVolumeConfiguration(volumeName: string, configuration: DockerComposeVolumeConfig): void;
-}
-/**
- * Service volume mounting information.
- */
-export interface DockerComposeVolumeMount {
-    /**
-     * Type of volume.
-     */
-    readonly type: string;
-    /**
-     * Volume source
-     */
-    readonly source: string;
-    /**
-     * Volume target
-     */
-    readonly target: string;
-}

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

@@ -1,99 +0,0 @@
-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

@@ -1,5 +0,0 @@
-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

@@ -1,120 +0,0 @@
-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 absolute path of this file.
-     */
-    readonly absolutePath: string;
-    private _changed?;
-    private shouldAddMarker;
-    /**
-     * The projen marker, used to identify files as projen-generated.
-     *
-     * Value is undefined if the project is being ejected.
-     */
-    get marker(): string | undefined;
-    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

@@ -1,26 +0,0 @@
-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

@@ -1,28 +0,0 @@
-/**
- * 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

@@ -1,44 +0,0 @@
-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);
-}