projen 0.71.13 → 0.71.15

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

@@ -1,3 +0,0 @@
-export * from "./circleci";
-export * from "./constant";
-export * from "./model";

package/lib/.types-compat/ts3.9/lib/circleci/model.d.ts

@@ -1,260 +0,0 @@
-/**
- * Used to represent objects with a dynamic key.
- * Dynamic are marked with `<>` in configuration reference like '<workflow_name>' and '<job_name>'
- * This field is required for objects with dynamic keys.
- */
-interface INamed {
-    /** name of dynamic key **/
-    readonly identifier: string;
-}
-/**
- * Used for orchestrating all jobs. Each workflow consists of the workflow name as a key and a map as a value.
- * A name should be unique within the current config.yml.
- * The top-level keys for the Workflows configuration are version and jobs.
- * @see https://circleci.com/docs/2.0/configuration-reference/#workflows
- */
-export interface Workflow extends INamed {
-    readonly jobs?: WorkflowJob[];
-    readonly triggers?: Triggers[];
-    /** when is too dynamic to be casted to interfaces. Check Docu as reference
-     * @see https://circleci.com/docs/2.0/configuration-reference/#logic-statement-examples
-     */
-    readonly when?: any;
-}
-/**
- * A job may have a type of approval indicating it must be manually approved before downstream jobs may proceed
- * @see https://circleci.com/docs/2.0/configuration-reference/#type
- */
-export declare enum JobType {
-    APPROVAL = "approval"
-}
-/**
- * The resource_class feature allows configuring CPU and RAM resources for each job.
- * Different resource classes are available for different executors, as described in the tables below.
- * @see https://circleci.com/docs/2.0/configuration-reference/#resourceclass
- */
-export declare enum ResourceClass {
-    SMALL = "small",
-    MEDIUM = "medium",
-    MEDIUM_PLUS = "medium+",
-    LARGE_X = "xlarge",
-    LARGE_2X = "2xlarge",
-    LARGE_2X_PLUS = "2xlarge+"
-}
-/**
- * Specify when to enable or disable the step.
- * @see https://circleci.com/docs/2.0/configuration-reference/#steps
- */
-export declare enum JobWhen {
-    ALWAYS = "always",
-    ON_SUCCESS = "on_success",
-    ON_FAIL = "on_fail"
-}
-/**
- * Pipeline parameter types
- * @see https://circleci.com/docs/2.0/reusing-config#parameter-syntax
- */
-export declare enum PipelineParameterType {
-    STRING = "string",
-    BOOLEAN = "boolean",
-    INTEGER = "integer",
-    ENUM = "enum"
-}
-/**
- * A Workflow is comprised of one or more uniquely named jobs. Jobs are specified in the jobs map,
- * see Sample 2.0 config.yml for two examples of a job map.
- * The name of the job is the key in the map, and the value is a map describing the job.
- * @see https://circleci.com/docs/2.0/configuration-reference/#jobs
- */
-export interface Job extends INamed {
-}
-/**
- * A Job is part of Workflow. A Job can be created with {@link Job} or it can be provided by the orb
- * @see https://circleci.com/docs/2.0/configuration-reference/#jobs-in-workflow
- */
-export interface WorkflowJob extends INamed {
-    /** A list of jobs that must succeed for the job to start. */
-    readonly requires?: string[];
-    /** A replacement for the job name. Useful when calling a job multiple times */
-    readonly name?: string;
-    /** The name of the context(s). The initial default name is org-global. Each context name must be unique. */
-    readonly context?: string[];
-    /** A job may have a type of approval indicating it must be manually approved before downstream jobs may proceed. */
-    readonly type?: JobType;
-    /** Job Filters can have the key branches or tags */
-    readonly filters?: Filter;
-    readonly matrix?: Matrix;
-    /** Parameters passed to job when referencing a job from orb */
-    readonly orbParameters?: Record<string, string | number | boolean>;
-}
-/**
- * Parameters are declared by name under a job, command, or executor.
- * @see https://circleci.com/docs/2.0/reusing-config#using-the-parameters-declaration
- */
-export interface PipelineParameter {
-    /** Used to generate documentation for your orb. */
-    readonly description?: string;
-    /** The parameter type, required. */
-    readonly type: PipelineParameterType;
-    /** The default value for the parameter. If not present, the parameter is implied to be required. */
-    readonly default?: string | number | boolean;
-}
-/**
- * The matrix stanza allows you to run a parameterized job multiple times with different arguments.
- * @see https://circleci.com/docs/2.0/configuration-reference/#matrix-requires-version-21
- */
-export interface Matrix {
-    /** A map of parameter names to every value the job should be called with */
-    readonly parameters?: Record<string, string[] | number[]>;
-    /** An alias for the matrix, usable from another job’s requires stanza. Defaults to the name of the job being executed */
-    readonly alias?: string;
-}
-/**
- * Specifies which triggers will cause this workflow to be executed.
- * Default behavior is to trigger the workflow when pushing to a branch.
- * @see https://circleci.com/docs/2.0/configuration-reference/#triggers
- */
-export interface Triggers {
-    readonly schedule?: Schedule;
-}
-/**
- *  A workflow may have a schedule indicating it runs at a certain time.
- *  @see https://circleci.com/docs/2.0/configuration-reference/#schedule
- */
-export interface Schedule {
-    /** The cron key is defined using POSIX crontab syntax. */
-    readonly cron?: string;
-    readonly filters: Filter;
-}
-/**
- * The branches key controls whether the current branch should have a schedule trigger created for it,
- * where current branch is the branch containing the config.yml file with the trigger stanza.
- * That is, a push on the main branch will only schedule a workflow for the main branch.
- *
- * Branches can have the keys only and ignore which either map to a single string naming a branch.
- * You may also use regular expressions to match against branches by enclosing them with /’s, or map to a list of such strings.
- * Regular expressions must match the entire string.
- *
- * Any branches that match only will run the job.
- * Any branches that match ignore will not run the job.
- * If neither only nor ignore are specified then all branches will run the job.
- * If both only and ignore are specified the only is considered before ignore.
- * @see https://circleci.com/docs/2.0/configuration-reference/#filters
- */
-export interface Filter {
-    readonly branches?: FilterConfig;
-    readonly tags?: FilterConfig;
-}
-/**
- * set an inclusive or exclusive filter
- * @see https://circleci.com/docs/2.0/configuration-reference/#filters
- */
-export interface FilterConfig {
-    /** Either a single branch specifier, or a list of branch specifiers */
-    readonly only?: string[];
-    /** Either a single branch specifier, or a list of branch specifiers */
-    readonly ignore?: string[];
-}
-/**
- * Each job consists of the job’s name as a key and a map as a value. A name should be case insensitive unique within a current jobs list.
- * @see https://circleci.com/docs/2.0/configuration-reference/#job_name
- */
-export interface Job {
-    readonly docker?: Docker[];
-    readonly machine?: Machine;
-    readonly macos?: Macos;
-    /** Shell to use for execution command in all steps. Can be overridden by shell in each step */
-    readonly shell?: string;
-    /** Parameters for making a job explicitly configurable in a workflow. */
-    readonly parameters?: Record<string, PipelineParameter>;
-    /** no type support here, for syntax {@see https://circleci.com/docs/2.0/configuration-reference/#steps} */
-    readonly steps?: any[];
-    /** In which directory to run the steps. Will be interpreted as an absolute path. Default: `~/project` */
-    readonly workingDirectory?: string;
-    /** Number of parallel instances of this job to run (default: 1) */
-    readonly parallelism?: number;
-    /** A map of environment variable names and values. */
-    readonly environment?: Record<string, string | number | boolean>;
-    /** {@link ResourceClass} */
-    readonly resourceClass?: ResourceClass | string;
-}
-/**
- * Options for docker executor
- * @see https://circleci.com/docs/2.0/configuration-reference/#docker
- */
-export interface Docker {
-    /** The name of a custom docker image to use */
-    readonly image: string;
-    /** The name the container is reachable by. By default, container services are accessible through localhost */
-    readonly name?: string;
-    /** The command used as executable when launching the container */
-    readonly entrypoint?: string[];
-    /** The command used as pid 1 (or args for entrypoint) when launching the container */
-    readonly command?: string[];
-    /** Which user to run commands as within the Docker container */
-    readonly user?: string;
-    /** A map of environment variable names and values */
-    readonly environment?: Record<string, string | number | boolean>;
-    /** Authentication for registries using standard docker login credentials */
-    readonly auth?: Record<string, string>;
-    /** Authentication for AWS Elastic Container Registry (ECR) */
-    readonly awsAuth?: Record<string, string>;
-}
-export interface Machine {
-    /**
-     * The VM image to use.
-     * @see https://circleci.com/docs/2.0/configuration-reference/#available-machine-images
-     */
-    readonly image: string;
-    /** enable docker layer caching
-     * @see https://circleci.com/docs/2.0/configuration-reference/#available-machine-images
-     */
-    readonly dockerLayerCaching?: string;
-}
-/**
- * CircleCI supports running jobs on macOS, to allow you to build, test,
- * and deploy apps for macOS, iOS, tvOS and watchOS. To run a job in a macOS virtual machine,
- * you must add the macos key to the top-level configuration for the job and specify
- * the version of Xcode you would like to use.
- * @see https://circleci.com/docs/2.0/configuration-reference/#macos
- */
-export interface Macos {
-    /** The version of Xcode that is installed on the virtual machine */
-    readonly xcode: string;
-}
-/**
- * Execution steps for Job
- * @see https://circleci.com/docs/2.0/configuration-reference/#steps
- */
-export interface StepRun {
-    readonly run?: Run;
-}
-/**
- * Used for invoking all command-line programs, taking either a map of configuration values,
- * or, when called in its short-form, a string that will be used as both the command and name.
- * Run commands are executed using non-login shells by default,
- * so you must explicitly source any dotfiles as part of the command.
- *
- * Not used because type incompatible types in steps array
- *
- * @see https://circleci.com/docs/2.0/configuration-reference/#run
- */
-export interface Run {
-    /** Command to run via the shell */
-    readonly command: string;
-    /** Title of the step to be shown in the CircleCI UI (default: full command) */
-    readonly name?: string;
-    /** Shell to use for execution command */
-    readonly shell?: string;
-    /** Additional environmental variables, locally scoped to command */
-    readonly environment?: string;
-    /** Whether this step should run in the background (default: false) */
-    readonly background?: string;
-    /** In which directory to run this step. Will be interpreted relative to the working_directory of the job). (default: .) */
-    readonly workingDirectory?: string;
-    /** Elapsed time the command can run without output such as “20m”, “1.25h”, “5s”. The default is 10 minutes */
-    readonly noOutputTimeout?: string;
-    /** Specify when to enable or disable the step. */
-    readonly when?: JobWhen | string;
-}
-export {};

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

@@ -1,2 +0,0 @@
-export declare const FILE_MANIFEST: string;
-export declare function cleanup(dir: string, newFiles: string[], exclude: string[]): void;

package/lib/.types-compat/ts3.9/lib/cli/cmds/new.d.ts

@@ -1,9 +0,0 @@
-import * as yargs from "yargs";
-declare class Command implements yargs.CommandModule {
-    readonly command = "new [PROJECT-TYPE-NAME] [OPTIONS]";
-    readonly describe = "Creates a new projen project";
-    builder(args: yargs.Argv): yargs.Argv<{}>;
-    handler(args: any): Promise<void>;
-}
-declare const _default: Command;
-export default _default;

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

@@ -1 +0,0 @@
-export {};

package/lib/.types-compat/ts3.9/lib/cli/macros.d.ts

@@ -1 +0,0 @@
-export declare function tryProcessMacro(cwd: string, macro: string): string | undefined;

package/lib/.types-compat/ts3.9/lib/cli/synth.d.ts

@@ -1,19 +0,0 @@
-import { TaskRuntime } from "../task-runtime";
-export interface SynthOptions {
-    /**
-     * Execute post synthesis commands.
-     * @default true
-     */
-    readonly post?: boolean;
-    /**
-     * Start watching .projenrc.js and re-synth when changed.
-     * @default false
-     */
-    readonly watch?: boolean;
-    /**
-     * The name of the .projenrc.js file  to use instead of the default.
-     * @default ".projenrc.js"
-     */
-    readonly rcfile?: string;
-}
-export declare function synth(runtime: TaskRuntime, options: SynthOptions): Promise<void>;

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

@@ -1,7 +0,0 @@
-import * as yargs from "yargs";
-import { TaskRuntime } from "../task-runtime";
-/**
- * Reads .projen/tasks.json and adds CLI commands for all tasks.
- * @param ya yargs
- */
-export declare function discoverTaskCommands(runtime: TaskRuntime, ya: yargs.Argv): void;

package/lib/.types-compat/ts3.9/lib/cli/util.d.ts

@@ -1,19 +0,0 @@
-/**
- * Installs the npm module (through `npm install`) to node_modules under `projectDir`.
- * @param spec The npm package spec (e.g. `foo@^1.2` or `foo@/var/folders/8k/qcw0ls5pv_ph0000gn/T/projen-RYurCw/pkg.tgz`)
- * @returns The installed package name (e.g. `@foo/bar`)
- */
-export declare function installPackage(baseDir: string, spec: string): string;
-/**
- * Render a command to install an npm package.
- *
- * Engine checks are ignorred at this point so that the module can be installed
- * regardless of the environment. This was needed to unblock the upgrade of the
- * minimum node version of projen, but also okay generally because engine checks
- * will be performed later and for all eternety.
- *
- * @param dir Base directory
- * @param module The module to install (e.g. foo@^1.2)
- * @returns The string that includes the install command ("npm install ...")
- */
-export declare function renderInstallCommand(dir: string, module: string): string;

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

@@ -1,5 +0,0 @@
-import { Component } from "./component";
-import { Project } from "./project";
-export declare class Clobber extends Component {
-    constructor(project: Project);
-}

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

@@ -1,5 +0,0 @@
-export declare const PROJEN_RC = ".projenrc.js";
-export declare const PROJEN_DIR = ".projen";
-export declare const PROJEN_MARKER: string;
-export declare const IS_TEST_RUN: boolean;
-export declare const PROJEN_VERSION: any;

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

@@ -1,20 +0,0 @@
-import { Project } from "./project";
-/**
- * Represents a project component.
- */
-export declare class Component {
-    readonly project: Project;
-    constructor(project: Project);
-    /**
-     * Called before synthesis.
-     */
-    preSynthesize(): void;
-    /**
-     * Synthesizes files to the project output directory.
-     */
-    synthesize(): void;
-    /**
-     * Called after synthesis. Order is *not* guaranteed.
-     */
-    postSynthesize(): void;
-}

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

@@ -1,160 +0,0 @@
-import { Component } from "./component";
-import { Project } from "./project";
-/**
- * The `Dependencies` component is responsible to track the list of dependencies
- * a project has, and then used by project types as the model for rendering
- * project-specific dependency manifests such as the dependencies section
- * `package.json` files.
- *
- * To add a dependency you can use a project-type specific API such as
- * `nodeProject.addDeps()` or use the generic API of `project.deps`:
- */
-export declare class Dependencies extends Component {
-    /**
-     * The project-relative path of the deps manifest file.
-     */
-    static readonly MANIFEST_FILE: string;
-    /**
-     * Returns the coordinates of a dependency spec.
-     *
-     * Given `foo@^3.4.0` returns `{ name: "foo", version: "^3.4.0" }`.
-     * Given `bar@npm:@bar/legacy` returns `{ name: "bar", version: "npm:@bar/legacy" }`.
-     */
-    static parseDependency(spec: string): DependencyCoordinates;
-    private readonly _deps;
-    /**
-     * Adds a dependencies component to the project.
-     * @param project The parent project
-     */
-    constructor(project: Project);
-    /**
-     * A copy of all dependencies recorded for this project.
-     *
-     * The list is sorted by type->name->version
-     */
-    get all(): Dependency[];
-    /**
-     * Returns a dependency by name.
-     *
-     * Fails if there is no dependency defined by that name or if `type` is not
-     * provided and there is more then one dependency type for this dependency.
-     *
-     * @param name The name of the dependency
-     * @param type The dependency type. If this dependency is defined only for a
-     * single type, this argument can be omitted.
-     *
-     * @returns a copy (cannot be modified)
-     */
-    getDependency(name: string, type?: DependencyType): Dependency;
-    /**
-     * Returns a dependency by name.
-     *
-     * Returns `undefined` if there is no dependency defined by that name or if
-     * `type` is not provided and there is more then one dependency type for this
-     * dependency.
-     *
-     * @param name The name of the dependency
-     * @param type The dependency type. If this dependency is defined only for a
-     * single type, this argument can be omitted.
-     *
-     * @returns a copy (cannot be modified) or undefined if there is no match
-     */
-    tryGetDependency(name: string, type?: DependencyType): Dependency | undefined;
-    /**
-     * Adds a dependency to this project.
-     * @param spec The dependency spec in the format `MODULE[@VERSION]` where
-     * `MODULE` is the package-manager-specific module name and `VERSION` is an
-     * optional semantic version requirement (e.g. `^3.4.0`).
-     * @param type The type of the dependency.
-     */
-    addDependency(spec: string, type: DependencyType, metadata?: {
-        [key: string]: any;
-    }): Dependency;
-    /**
-     * Removes a dependency.
-     * @param name The name of the module to remove (without the version)
-     * @param type The dependency type. This is only required if there the
-     * dependency is defined for multiple types.
-     */
-    removeDependency(name: string, type?: DependencyType): void;
-    private tryGetDependencyIndex;
-    private toJson;
-}
-export interface DepsManifest {
-    /**
-     * All dependencies of this module.
-     */
-    readonly dependencies: Dependency[];
-}
-/**
- * Coordinates of the dependency (name and version).
- */
-export interface DependencyCoordinates {
-    /**
-     * The package manager name of the dependency (e.g. `leftpad` for npm).
-     *
-     * NOTE: For package managers that use complex coordinates (like Maven), we
-     * will codify it into a string somehow.
-     */
-    readonly name: string;
-    /**
-     * Semantic version version requirement.
-     *
-     * @default - requirement is managed by the package manager (e.g. npm/yarn).
-     */
-    readonly version?: string;
-}
-/**
- * Represents a project dependency.
- */
-export interface Dependency extends DependencyCoordinates {
-    /**
-     * Which type of dependency this is (runtime, build-time, etc).
-     */
-    readonly type: DependencyType;
-    /**
-     * Additional JSON metadata associated with the dependency (package manager
-     * specific).
-     * @default {}
-     */
-    readonly metadata?: {
-        [key: string]: any;
-    };
-}
-/**
- * Type of dependency.
- */
-export declare enum DependencyType {
-    /**
-     * The dependency is required for the program/library during runtime.
-     */
-    RUNTIME = "runtime",
-    /**
-     * The dependency is required at runtime but expected to be installed by the
-     * consumer.
-     */
-    PEER = "peer",
-    /**
-     * The dependency is bundled and shipped with the module, so consumers are not
-     * required to install it.
-     */
-    BUNDLED = "bundled",
-    /**
-     * The dependency is required to run the `build` task.
-     */
-    BUILD = "build",
-    /**
-     * The dependency is required to run the `test` task.
-     */
-    TEST = "test",
-    /**
-     * The dependency is required for development (e.g. IDE plugins).
-     */
-    DEVENV = "devenv",
-    /**
-     * Transient dependency that needs to be overwritten.
-     *
-     * Available for Node packages
-     */
-    OVERRIDE = "override"
-}

package/lib/.types-compat/ts3.9/lib/dev-env.d.ts

@@ -1,80 +0,0 @@
-import { Task } from "./task";
-/**
- * Base options for configuring a container-based development environment.
- */
-export interface DevEnvironmentOptions {
-    /**
-     * A Docker image or Dockerfile for the container.
-     */
-    readonly dockerImage?: DevEnvironmentDockerImage;
-    /**
-     * An array of tasks that should be run when the container starts.
-     */
-    readonly tasks?: Task[];
-    /**
-     * An array of ports that should be exposed from the container.
-     */
-    readonly ports?: string[];
-    /**
-     * An array of extension IDs that specify the extensions that should be
-     * installed inside the container when it is created.
-     */
-    readonly vscodeExtensions?: string[];
-}
-/**
- * Options for specifying the Docker image of the container.
- */
-export declare class DevEnvironmentDockerImage {
-    /**
-     * A publicly available Docker image.
-     * @example 'ubuntu:latest'
-     * @param image a Docker image
-     */
-    static fromImage(image: string): DevEnvironmentDockerImage;
-    /**
-     * The relative path of a Dockerfile that defines the container contents.
-     * @example '.gitpod.Docker'
-     * @param dockerFile a relative path
-     */
-    static fromFile(dockerFile: string): DevEnvironmentDockerImage;
-    /**
-     * A publicly available Docker image.
-     */
-    readonly image?: string;
-    /**
-     * The relative path of a Dockerfile that defines the container contents.
-     */
-    readonly dockerFile?: string;
-    private constructor();
-}
-/**
- * Abstract interface for container-based development environments, such as
- * Gitpod and GitHub Codespaces.
- */
-export interface IDevEnvironment {
-    /**
-     * Add a custom Docker image or Dockerfile for the container.
-     *
-     * @param image The Docker image
-     */
-    addDockerImage(image: DevEnvironmentDockerImage): void;
-    /**
-     * Adds tasks to run when the container starts.
-     *
-     * @param tasks The new tasks
-     */
-    addTasks(...tasks: Task[]): void;
-    /**
-     * Adds ports that should be exposed (forwarded) from the container.
-     *
-     * @param ports The new ports
-     */
-    addPorts(...ports: string[]): void;
-    /**
-     * Adds a list of VSCode extensions that should be automatically installed
-     * in the container.
-     *
-     * @param extensions The extension IDs
-     */
-    addVscodeExtensions(...extensions: string[]): void;
-}