projen 0.71.13 → 0.71.15

package/lib/.types-compat/ts3.9/lib/gitlab/configuration.d.ts

@@ -1,170 +0,0 @@
-import { Artifacts, Cache, Default, Image, Include, Job, Retry, Service, VariableConfig, Workflow } from "./configuration-model";
-import { Component } from "../component";
-import { Project } from "../project";
-import { YamlFile } from "../yaml";
-/**
- * Options for `CiConfiguration`.
- */
-export interface CiConfigurationOptions {
-    /**
-     * Default settings for the CI Configuration. Jobs that do not define one or more of the listed keywords use the value defined in the default section.
-     */
-    readonly default?: Default;
-    /**
-     * A special job used to upload static sites to Gitlab pages. Requires a `public/` directory
-     * with `artifacts.path` pointing to it.
-     */
-    readonly pages?: Job;
-    /**
-     * Used to control pipeline behavior.
-     */
-    readonly workflow?: Workflow;
-    /**
-     * Groups jobs into stages. All jobs in one stage must complete before next stage is
-     * executed. If no stages are specified. Defaults to ['build', 'test', 'deploy'].
-     */
-    readonly stages?: string[];
-    /**
-     * Global variables that are passed to jobs.
-     * If the job already has that variable defined, the job-level variable takes precedence.
-     */
-    readonly variables?: Record<string, any>;
-    /**
-     * An initial set of jobs to add to the configuration.
-     */
-    readonly jobs?: Record<string, Job>;
-}
-/**
- * CI for GitLab.
- * A CI is a configurable automated process made up of one or more stages/jobs.
- * @see https://docs.gitlab.com/ee/ci/yaml/
- */
-export declare class CiConfiguration extends Component {
-    /**
-     * The project the configuration belongs to.
-     */
-    readonly project: Project;
-    /**
-     * The name of the configuration.
-     */
-    readonly name: string;
-    /**
-     * Path to CI file generated by the configuration.
-     */
-    readonly path: string;
-    /**
-     * The workflow YAML file.
-     */
-    readonly file: YamlFile;
-    /**
-     * Defines default scripts that should run *after* all jobs. Can be overriden by the job level `afterScript`.
-     */
-    readonly defaultAfterScript: string[];
-    /**
-     * Default list of files and directories that should be attached to the job if it succeeds. Artifacts are sent to Gitlab where they can be downloaded.
-     */
-    readonly defaultArtifacts?: Artifacts;
-    /**
-     * Defines default scripts that should run *before* all jobs. Can be overriden by the job level `afterScript`.
-     */
-    readonly defaultBeforeScript: string[];
-    /**
-     * A default list of files and directories to cache between jobs. You can only use paths that are in the local working copy.
-     */
-    readonly defaultCache?: Cache;
-    /**
-     * Specifies the default docker image to use globally for all jobs.
-     */
-    readonly defaultImage?: Image;
-    /**
-     * The default behavior for whether a job should be canceled when a newer pipeline starts before the job completes (Default: false).
-     */
-    readonly defaultInterruptible?: boolean;
-    /**
-     * How many times a job is retried if it fails. If not defined, defaults to 0 and jobs do not retry.
-     */
-    readonly defaultRetry?: Retry;
-    /**
-     * A default list of additional Docker images to run scripts in. The service image is linked to the image specified in the  image parameter.
-     */
-    private defaultServices;
-    /**
-     * Used to select a specific runner from the list of all runners that are available for the project.
-     */
-    readonly defaultTags: string[];
-    /**
-     * A default timeout job written in natural language (Ex. one hour, 3600 seconds, 60 minutes).
-     */
-    readonly defaultTimeout?: string;
-    /**
-     * Can be `Include` or `Include[]`. Each `Include` will be a string, or an
-     * object with properties for the method if including external YAML file. The external
-     * content will be fetched, included and evaluated along the `.gitlab-ci.yml`.
-     */
-    private include;
-    /**
-     * A special job used to upload static sites to Gitlab pages. Requires a `public/` directory
-     * with `artifacts.path` pointing to it.
-     */
-    readonly pages?: Job;
-    /**
-     * Groups jobs into stages. All jobs in one stage must complete before next stage is
-     * executed. Defaults to ['build', 'test', 'deploy'].
-     */
-    readonly stages: string[];
-    /**
-     * Global variables that are passed to jobs.
-     * If the job already has that variable defined, the job-level variable takes precedence.
-     */
-    readonly variables: Record<string, number | VariableConfig | string>;
-    /**
-     * Used to control pipeline behavior.
-     */
-    readonly workflow?: Workflow;
-    /**
-     * The jobs in the CI configuration.
-     */
-    readonly jobs: Record<string, Job>;
-    constructor(project: Project, name: string, options?: CiConfigurationOptions);
-    /**
-     * Add additional yml/yaml files to the CI includes
-     * @param includes The includes to add.
-     */
-    addIncludes(...includes: Include[]): void;
-    /**
-     * Throw an error if the provided Include is invalid.
-     * @see https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/config/external/mapper.rb
-     * @param include the Include to validate.
-     */
-    private assertIsValidInclude;
-    /**
-     * Check if the equality of Includes.
-     * @see https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/config/external/mapper.rb
-     * @param x First include to compare.
-     * @param y Second include to compare.
-     * @returns Whether the includes are equal.
-     */
-    private areEqualIncludes;
-    /**
-     * Add additional services.
-     * @param services The services to add.
-     */
-    addServices(...services: Service[]): void;
-    /**
-     * Add a globally defined variable to the CI configuration.
-     * @param variables The variables to add.
-     */
-    addGlobalVariables(variables: Record<string, any>): void;
-    /**
-     * Add stages to the CI configuration if not already present.
-     * @param stages stages to add.
-     */
-    addStages(...stages: string[]): void;
-    /**
-     * Add jobs and their stages to the CI configuration.
-     * @param jobs Jobs to add.
-     */
-    addJobs(jobs: Record<string, Job>): void;
-    private renderCI;
-    private renderDefault;
-}

package/lib/.types-compat/ts3.9/lib/gitlab/gitlab-configuration.d.ts

@@ -1,19 +0,0 @@
-import { CiConfigurationOptions } from ".";
-import { CiConfiguration } from "./configuration";
-import { NestedConfiguration } from "./nested-configuration";
-import { Project } from "../project";
-/**
- * A GitLab CI for the main `.gitlab-ci.yml` file.
- */
-export declare class GitlabConfiguration extends CiConfiguration {
-    readonly nestedTemplates: Record<string, NestedConfiguration>;
-    constructor(project: Project, options?: CiConfigurationOptions);
-    /**
-     * Creates and adds nested templates to the includes of the main CI.
-     * Additionally adds their stages to the main CI if they are not already present.
-     * You can futher customize nested templates through the `nestedTemplates` property.
-     * E.g. gitlabConfig.nestedTemplates['templateName']?.addStages('stageName')
-     * @param config a record the names and configuraitons of the templates.
-     */
-    createNestedTemplates(config: Record<string, CiConfigurationOptions>): void;
-}

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

@@ -1,4 +0,0 @@
-export * from "./configuration";
-export * from "./configuration-model";
-export * from "./gitlab-configuration";
-export * from "./nested-configuration";

package/lib/.types-compat/ts3.9/lib/gitlab/nested-configuration.d.ts

@@ -1,11 +0,0 @@
-import { CiConfigurationOptions } from ".";
-import { CiConfiguration } from "./configuration";
-import { GitlabConfiguration } from "./gitlab-configuration";
-import { Project } from "../project";
-/**
- * A GitLab CI for templates that are created and included in the `.gitlab-ci.yml` file.
- */
-export declare class NestedConfiguration extends CiConfiguration {
-    readonly parent: GitlabConfiguration;
-    constructor(project: Project, parent: GitlabConfiguration, name: string, options?: CiConfigurationOptions);
-}

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

@@ -1,301 +0,0 @@
-import { Component } from "./component";
-import { IDevEnvironment, DevEnvironmentOptions, DevEnvironmentDockerImage } from "./dev-env";
-import { Project } from "./project";
-import { Task } from "./task";
-/**
- * https://www.gitpod.io/docs/configuration/
- * https://www.gitpod.io/docs/config-start-tasks/
- * https://www.gitpod.io/docs/prebuilds/#configure-the-github-app
- * https://www.gitpod.io/docs/vscode-extensions/
- */
-/**
- * Configure how the terminal should be opened relative to the previous task.
- */
-export declare enum GitpodOpenMode {
-    /**
-     * Opens in the same tab group right after the previous tab
-     */
-    TAB_AFTER = "tab-after",
-    /**
-     * Opens in the same tab group left before the previous tab
-     */
-    TAB_BEFORE = "tab-before",
-    /**
-     * Splits and adds the terminal to the right
-     */
-    SPLIT_RIGHT = "split-right",
-    /**
-     * Splits and adds the terminal to the left
-     */
-    SPLIT_LEFT = "split-left",
-    /**
-     * Splits and adds the terminal to the top
-     */
-    SPLIT_TOP = "split-top",
-    /**
-     * Splits and adds the terminal to the bottom
-     */
-    SPLIT_BOTTOM = "split-bottom"
-}
-/**
- * Configure where in the IDE the terminal should be opened.
- */
-export declare enum GitpodOpenIn {
-    /**
-     * the bottom panel (default)
-     */
-    BOTTOM = "bottom",
-    /**
-     * the left panel
-     */
-    LEFT = "left",
-    /**
-     * the right panel
-     */
-    RIGHT = "right",
-    /**
-     * the main editor area
-     */
-    MAIN = "main"
-}
-/**
- * Configure options for a task to be run when opening a Gitpod
- * workspace (e.g. running tests, or starting a dev server).
- *
- * Start Mode         | Execution
- * Fresh Workspace    | before && init && command
- * Restart Workspace  | before && command
- * Snapshot           | before && command
- * Prebuild           | before && init && prebuild
- */
-export interface GitpodTask {
-    /**
-     * Required. The shell command to run
-     */
-    readonly command: string;
-    /**
-     * A name for this task.
-     * @default - task names are omitted when blank
-     */
-    readonly name?: string;
-    /**
-     * You can configure how the terminal should be opened relative to the previous task.
-     * @default GitpodOpenMode.TAB_AFTER
-     */
-    readonly openMode?: GitpodOpenMode;
-    /**
-     * You can configure where in the IDE the terminal should be opened
-     * @default GitpodOpenIn.BOTTOM
-     */
-    readonly openIn?: GitpodOpenIn;
-    /**
-     * In case you need to run something even before init, that is a requirement for both init and command,
-     * you can use the before property.
-     * @default
-     */
-    readonly before?: string;
-    /**
-     * The init property can be used to specify shell commands that should only be executed after a workspace
-     * was freshly cloned and needs to be initialized somehow. Such tasks are usually builds or downloading
-     * dependencies. Anything you only want to do once but not when you restart a workspace or start a snapshot.
-     * @default
-     */
-    readonly init?: string;
-    /**
-     * The optional prebuild command will be executed during prebuilds. It is meant to run additional long running
-     * processes that could be useful, e.g. running test suites.
-     * @default
-     */
-    readonly prebuild?: string;
-}
-/**
- * What to do when a service on a port is detected.
- */
-export declare enum GitpodOnOpen {
-    /**
-     * Open a new browser tab
-     */
-    OPEN_BROWSER = "open-browser",
-    /**
-     * Open a preview on the right side of the IDE
-     */
-    OPEN_PREVIEW = "open-preview",
-    /**
-     * Show a notification asking the user what to do (default)
-     */
-    NOTIFY = "notify",
-    /**
-     * Do nothing.
-     */
-    IGNORE = "ignore"
-}
-/**
- * Whether the port visibility should be private or public
- */
-export declare enum GitpodPortVisibility {
-    /**
-     * Allows everyone with the port URL to access the port (default)
-     */
-    PUBLIC = "public",
-    /**
-     * Only allows users with workspace access to access the port
-     */
-    PRIVATE = "private"
-}
-/**
- * Options for an exposed port on Gitpod
- */
-export interface GitpodPort {
-    /**
-     * A port that should be exposed (forwarded) from the container.
-     *
-     * @example "8080"
-     */
-    readonly port?: string;
-    /**
-     * What to do when a service on a port is detected.
-     *
-     * @default GitpodOnOpen.NOTIFY
-     */
-    readonly onOpen?: GitpodOnOpen;
-    /**
-     * Whether the port visibility should be private or public.
-     *
-     * @default GitpodPortVisibility.PUBLIC
-     */
-    readonly visibility?: GitpodPortVisibility;
-}
-/**
- * Configure the Gitpod App for prebuilds.
- * Currently only GitHub is supported.
- * @see https://www.gitpod.io/docs/prebuilds/
- */
-export interface GitpodPrebuilds {
-    /**
-     * Enable for the master/default branch
-     * @default true
-     */
-    readonly master?: boolean;
-    /**
-     * Enable for all branches in this repo
-     * @default false
-     */
-    readonly branches?: boolean;
-    /**
-     * Enable for pull requests coming from this repo
-     * @default true
-     */
-    readonly pullRequests?: boolean;
-    /**
-     * Enable for pull requests coming from forks
-     * @default false
-     */
-    readonly pullRequestsFromForks?: boolean;
-    /**
-     * Add a check to pull requests
-     * @default true
-     */
-    readonly addCheck?: boolean;
-    /**
-     * Add a "Review in Gitpod" button as a comment to pull requests
-     * @default false
-     */
-    readonly addComment?: boolean;
-    /**
-     * Add a "Review in Gitpod" button to the pull request's description
-     * @default false
-     */
-    readonly addBadge?: boolean;
-    /**
-     * Add a label once the prebuild is ready to pull requests
-     * @default false
-     */
-    readonly addLabel?: boolean;
-}
-/**
- * Constructor options for the Gitpod component.
- *
- * By default, Gitpod uses the 'gitpod/workspace-full' docker image.
- * @see https://github.com/gitpod-io/workspace-images/blob/master/full/Dockerfile
- *
- * By default, all tasks will be run in parallel. To run the tasks in sequence,
- * create a new task and specify the other tasks as subtasks.
- */
-export interface GitpodOptions extends DevEnvironmentOptions {
-    /**
-     * Optional Gitpod's Github App integration for prebuilds
-     * If this is not set and Gitpod's Github App is installed, then Gitpod will apply
-     * these defaults: https://www.gitpod.io/docs/prebuilds/#configure-the-github-app
-     * @default undefined
-     */
-    readonly prebuilds?: GitpodPrebuilds;
-}
-/**
- * The Gitpod component which emits .gitpod.yml
- */
-export declare class Gitpod extends Component implements IDevEnvironment {
-    private dockerImage;
-    private prebuilds;
-    private readonly tasks;
-    private readonly ports;
-    private readonly vscodeExtensions;
-    /**
-     * Direct access to the gitpod configuration (escape hatch)
-     */
-    readonly config: any;
-    constructor(project: Project, options?: GitpodOptions);
-    /**
-     * Add a custom Docker image or Dockerfile for the container.
-     *
-     * @param image The Docker image
-     */
-    addDockerImage(image: DevEnvironmentDockerImage): void;
-    /**
-     * Add tasks to run when gitpod starts.
-     *
-     * By default, all tasks will be run in parallel. To run tasks in sequence,
-     * create a new `Task` and specify the other tasks as subtasks.
-     *
-     * @param tasks The new tasks
-     */
-    addTasks(...tasks: Task[]): void;
-    /**
-     * Add a prebuilds configuration for the Gitpod App
-     * @param config The configuration
-     */
-    addPrebuilds(config: GitpodPrebuilds): void;
-    /**
-     * Add a task with more granular options.
-     *
-     * By default, all tasks will be run in parallel. To run tasks in sequence,
-     * create a new `Task` and set the other tasks as subtasks.
-     *
-     * @param options The task parameters
-     */
-    addCustomTask(options: GitpodTask): void;
-    /**
-     * Add ports that should be exposed (forwarded) from the container.
-     *
-     * @param ports The new ports
-     */
-    addPorts(...ports: string[]): void;
-    /**
-     * Add a list of VSCode extensions that should be automatically installed
-     * in the container.
-     *
-     * These must be in the format defined in the Open VSX registry.
-     * @example 'scala-lang.scala@0.3.9:O5XmjwY5Gz+0oDZAmqneJw=='
-     * @see https://www.gitpod.io/docs/vscode-extensions/
-     *
-     * @param extensions The extension IDs
-     */
-    addVscodeExtensions(...extensions: GitpodCodeExtensionId[]): void;
-    private renderDockerImage;
-    private renderPrebuilds;
-}
-/**
- * VS Code extensions as defined in the Open VSX registry
- * Example: `scala-lang.scala@0.3.9:O5XmjwY5Gz+0oDZAmqneJw==`
- */
-type GitpodCodeExtensionId = string;
-export {};

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

@@ -1,59 +0,0 @@
-import { FileBase, IResolver } from "./file";
-import { Project } from "./project";
-export interface IgnoreFileOptions {
-    /**
-     * Filter out comment lines?
-     *
-     * @default true
-     */
-    readonly filterCommentLines?: boolean;
-    /**
-     * Filter out blank/empty lines?
-     *
-     * @default true
-     */
-    readonly filterEmptyLines?: boolean;
-}
-export declare class IgnoreFile extends FileBase {
-    private readonly _patterns;
-    readonly filterCommentLines: boolean;
-    readonly filterEmptyLines: boolean;
-    /**
-     *
-     * @param project The project to tie this file to.
-     * @param filePath - the relative path in the project to put the file
-     * @param minify - whether comments/blank lines should be filtered
-     */
-    constructor(project: Project, filePath: string, options?: IgnoreFileOptions);
-    /**
-     * Add ignore patterns. Files that match this pattern will be ignored. If the
-     * pattern starts with a negation mark `!`, files that match will _not_ be
-     * ignored.
-     *
-     * Comment lines (start with `#`) and blank lines ("") are filtered by default
-     * but can be included using options specified when instantiating the component.
-     *
-     * @param patterns Ignore patterns.
-     */
-    addPatterns(...patterns: string[]): void;
-    private normalizePatterns;
-    /**
-     * Removes patterns previously added from the ignore file.
-     *
-     * If `addPattern()` is called after this, the pattern will be added again.
-     *
-     * @param patterns patters to remove.
-     */
-    removePatterns(...patterns: string[]): void;
-    /**
-     * Ignore the files that match these patterns.
-     * @param patterns The patterns to match.
-     */
-    exclude(...patterns: string[]): void;
-    /**
-     * Always include the specified file patterns.
-     * @param patterns Patterns to include in git commits.
-     */
-    include(...patterns: string[]): void;
-    protected synthesizeContent(resolver: IResolver): string | undefined;
-}

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

@@ -1,51 +0,0 @@
-export * from "./component";
-export * from "./dev-env";
-export * from "./dependencies";
-export * from "./docker-compose";
-export * from "./file";
-export * from "./gitattributes";
-export * from "./gitpod";
-export * from "./ignore-file";
-export * from "./ini";
-export * from "./json";
-export * from "./json-patch";
-export * from "./logger";
-export * from "./license";
-export * from "./makefile";
-export * from "./object-file";
-export * from "./option-hints";
-export * from "./project";
-export * from "./project-build";
-export * from "./projects";
-export * from "./projenrc";
-export * from "./projenrc-json";
-export * from "./readme";
-export * from "./renovatebot";
-export * from "./sample-file";
-export * from "./semver";
-export * from "./source-code";
-export * from "./task";
-export * from "./tasks";
-export * from "./task-model";
-export * from "./task-runtime";
-export * from "./testing";
-export * from "./textfile";
-export * from "./toml";
-export * from "./version";
-export * from "./yaml";
-export * from "./xmlfile";
-export * as web from "./web";
-export * as github from "./github";
-export * as gitlab from "./gitlab";
-export * as circleci from "./circleci";
-export * as vscode from "./vscode";
-export * as java from "./java";
-export * as python from "./python";
-export * as typescript from "./typescript";
-export * as javascript from "./javascript";
-export * as release from "./release";
-export * as awscdk from "./awscdk";
-export * as cdk8s from "./cdk8s";
-export * as cdktf from "./cdktf";
-export * as cdk from "./cdk";
-export * as build from "./build";

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

@@ -1,15 +0,0 @@
-import { IResolver } from "./file";
-import { ObjectFile, ObjectFileOptions } from "./object-file";
-import { Project } from "./project";
-/**
- * Options for `IniFile`.
- */
-export interface IniFileOptions extends ObjectFileOptions {
-}
-/**
- * Represents an INI file.
- */
-export declare class IniFile extends ObjectFile {
-    constructor(project: Project, filePath: string, options: IniFileOptions);
-    protected synthesizeContent(resolver: IResolver): string | undefined;
-}