projen 0.70.2 → 0.70.4

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

@@ -0,0 +1,156 @@
+import { Component } from "../component";
+import { MavenRepository } from "../java";
+import { Project } from "../project";
+type Transform = {
+    name: string;
+    args: Record<string, any>;
+};
+type SmithyCommon = {
+    imports?: string[];
+    plugins?: PluginsType;
+};
+type PluginValue = {
+    service?: string;
+    [key: string]: any;
+};
+export type ProjectionValue = SmithyCommon & {
+    abstract?: boolean;
+    transforms?: Transform[];
+};
+export type ProjectionKey = string;
+export type ProjectionsType = Record<ProjectionKey, ProjectionValue>;
+export type PluginKey = string;
+export type PluginsType = Record<PluginKey, PluginValue>;
+/**
+ * Maven repository definition for a smithy build file
+ */
+export type SmithyMavenRepository = Partial<MavenRepository> & Pick<MavenRepository, "url">;
+export interface SmithyMavenConfig {
+    /**
+     * List of smithy dependencies, for example ["software.amazon.smithy:smithy-cli:1.27.2"]
+     */
+    readonly dependencies: string[];
+    /**
+     * List of maven repositories for smithy dependencies
+     */
+    readonly repositories: SmithyMavenRepository[];
+}
+/**
+ * Options for `SmithyBuild`
+ */
+export interface SmithyBuildOptions extends SmithyCommon {
+    /**
+     * Defines the version of smithy-build.
+     * @default "1.0"
+     */
+    readonly version?: string;
+    /**
+     * Specifies a location where smithy projections are written.
+     * @default - no output directory
+     */
+    readonly outputDirectory?: string;
+    /**
+     * Map of projections name to projection configurations
+     * https://awslabs.github.io/smithy/1.0/guides/building-models/build-config.html#projections
+     * @default - no projections
+     */
+    readonly projections?: ProjectionsType;
+    /**
+     * If a plugin can't be found, Smithy will by default fail the build.
+     * This setting can be set to true to allow the build to progress
+     * even if a plugin can't be found on the classpath.
+     *
+     * @default - no ignoreMissingPlugins set in the smithy-build.json file
+     */
+    readonly ignoreMissingPlugins?: boolean;
+    /**
+     * Maven configuration, used to declare dependencies for the smithy vs-code plugin
+     * @see https://github.com/awslabs/smithy-vscode/blob/main/README.md#authoring-a-model
+     * @default - no maven configuration set in the smithy-build.json file
+     */
+    readonly maven?: SmithyMavenConfig;
+}
+/**
+ * Smithy build configuration options
+ */
+export declare class SmithyBuild extends Component {
+    /**
+     * Defines the version of smithy-build.
+     * @default "1.0"
+     */
+    readonly version: string;
+    /**
+     * Specifies a location where smithy projections are written.
+     * @default - no output directory
+     */
+    readonly outputDirectory?: string;
+    /**
+     * List of imports relative to the location of smithy-build.json file.
+     * @default no imports
+     */
+    private _imports?;
+    /**
+     * If a plugin can't be found, Smithy will by default fail the build.
+     * This setting can be set to true to allow the build to progress
+     * even if a plugin can't be found on the classpath.
+     *
+     * @default - no ignoreMissingPlugins set in the smithy-build.json file
+     */
+    readonly ignoreMissingPlugins?: boolean;
+    /**
+     * Map of projections name to projection configurations
+     * https://awslabs.github.io/smithy/1.0/guides/building-models/build-config.html#projections
+     * @default - no projections
+     */
+    private _projections?;
+    /**
+     * Map of plugin name to plugin configurations
+     * https://awslabs.github.io/smithy/1.0/guides/building-models/build-config.html#plugins
+     * @default - no plugins
+     */
+    private _plugins?;
+    /**
+     * Maven configuration for the Smithy vs-code extension
+     * https://github.com/awslabs/smithy-vscode/blob/main/README.md#authoring-a-model
+     */
+    private _maven?;
+    private readonly manifest;
+    constructor(project: Project, options?: SmithyBuildOptions);
+    /**
+     * Get configured projections
+     */
+    get projections(): {
+        [x: string]: ProjectionValue;
+    } | undefined;
+    /**
+     * Get configured imports
+     */
+    get imports(): string[] | undefined;
+    /**
+     * Get configured plugins
+     */
+    get plugins(): {
+        [x: string]: PluginValue;
+    } | undefined;
+    /**
+     * Add a smithy build import
+     */
+    addImport(imp: string): void;
+    /**
+     * Add smithy build projections
+     */
+    addProjections(projections: ProjectionsType): void;
+    /**
+     * Add smithy build plugins
+     */
+    addPlugins(plugins: PluginsType): void;
+    /**
+     * Add maven dependencies to the smithy build for the vs-code plugin
+     */
+    addMavenDependencies(...dependencies: string[]): void;
+    /**
+     * Add maven repositories to the smithy build for the vs-code plugin
+     */
+    addMavenRepositories(...repositories: SmithyMavenRepository[]): void;
+}
+export {};

package/lib/.types-compat/ts3.9/lib/source-code.d.ts

@@ -0,0 +1,46 @@
+import { Component } from "./component";
+import { Project } from "./project";
+/**
+ * Options for `SourceCodeFile`.
+ */
+export interface SourceCodeOptions {
+    /**
+     * Indentation size.
+     * @default 2
+     */
+    readonly indent?: number;
+    /**
+     * Whether the generated file should be readonly.
+     *
+     * @default true
+     */
+    readonly readonly?: boolean;
+}
+/**
+ * Represents a source file.
+ */
+export declare class SourceCode extends Component {
+    readonly filePath: string;
+    private readonly file;
+    private indentLevel;
+    private readonly indent;
+    constructor(project: Project, filePath: string, options?: SourceCodeOptions);
+    get marker(): string | undefined;
+    /**
+     * Emit a line of code.
+     * @param code The contents, if not specified, just adds a newline
+     */
+    line(code?: string): void;
+    /**
+     * Opens a code block and increases the indentation level.
+     *
+     * @param code The code before the block starts (e.g. `export class {`).
+     */
+    open(code?: string): void;
+    /**
+     * Decreases the indentation level and closes a code block.
+     *
+     * @param code The code after the block is closed (e.g. `}`).
+     */
+    close(code?: string): void;
+}

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

@@ -0,0 +1,130 @@
+/**
+ * Schema for `tasks.json`.
+ */
+export interface TasksManifest {
+    /**
+     * All tasks available for this project.
+     */
+    readonly tasks?: {
+        [name: string]: TaskSpec;
+    };
+    /**
+     * Environment for all tasks.
+     */
+    readonly env?: {
+        [name: string]: string;
+    };
+}
+export interface TaskCommonOptions {
+    /**
+     * The description of this build command.
+     * @default - the task name
+     */
+    readonly description?: string;
+    /**
+     * Defines environment variables for the execution of this task.
+     * Values in this map will be evaluated in a shell, so you can do stuff like `$(echo "foo")`.
+     * @default {}
+     */
+    readonly env?: {
+        [name: string]: string;
+    };
+    /**
+     * A set of environment variables that must be defined in order to execute
+     * this task. Task execution will fail if one of these is not defined.
+     */
+    readonly requiredEnv?: string[];
+    /**
+     * A shell command which determines if the this task should be executed. If
+     * the program exits with a zero exit code, steps will be executed. A non-zero
+     * code means that task will be skipped.
+     */
+    readonly condition?: string;
+    /**
+     * The working directory for all steps in this task (unless overridden by the
+     * step).
+     *
+     * @default - process.cwd()
+     */
+    readonly cwd?: string;
+}
+/**
+ * Specification of a single task.
+ */
+export interface TaskSpec extends TaskCommonOptions {
+    /**
+     * Task name.
+     */
+    readonly name: string;
+    /**
+     * Task steps.
+     */
+    readonly steps?: TaskStep[];
+}
+/**
+ * Options for task steps.
+ */
+export interface TaskStepOptions {
+    /**
+     * Step name
+     *
+     * @default - no name
+     */
+    readonly name?: string;
+    /**
+     * The working directory for this step.
+     *
+     * @default - determined by the task
+     */
+    readonly cwd?: string;
+    /**
+     * Should this step receive args passed to the task.
+     *
+     * If `true`, args are passed through at the end of the `exec` shell command.\
+     * The position of the args can be changed by including the marker `$@` inside the command string.
+     *
+     * If the step spawns a subtask, args are passed to the subtask.
+     * The subtask must define steps receiving args for this to have any effect.
+     *
+     * @example task.exec("echo Hello $@ World!", { receiveArgs: true });
+     *
+     * @default false
+     */
+    readonly receiveArgs?: boolean;
+}
+/**
+ * A single step within a task. The step could either be  the execution of a
+ * shell command or execution of a sub-task, by name.
+ */
+export interface TaskStep extends TaskStepOptions {
+    /**
+     * Shell command to execute
+     *
+     * @default - don't execute a shell command
+     */
+    readonly exec?: string;
+    /**
+     * Subtask to execute
+     *
+     * @default - don't spawn a subtask
+     */
+    readonly spawn?: string;
+    /**
+     * Print a message.
+     * @default - don't say anything
+     */
+    readonly say?: string;
+    /**
+     * The name of a built-in task to execute.
+     *
+     * Built-in tasks are node.js programs baked into the projen module and as
+     * component runtime helpers.
+     *
+     * The name is a path relative to the projen lib/ directory (without the .task.js extension).
+     * For example, if your built in builtin task is under `src/release/resolve-version.task.ts`,
+     * then this would be `release/resolve-version`.
+     *
+     * @default - do not execute a builtin task
+     */
+    readonly builtin?: string;
+}

package/lib/.types-compat/ts3.9/lib/task-runtime.d.ts

@@ -0,0 +1,32 @@
+import { TasksManifest, TaskSpec } from "./task-model";
+/**
+ * The runtime component of the tasks engine.
+ */
+export declare class TaskRuntime {
+    /**
+     * The project-relative path of the tasks manifest file.
+     */
+    static readonly MANIFEST_FILE: string;
+    /**
+     * The contents of tasks.json
+     */
+    readonly manifest: TasksManifest;
+    /**
+     * The root directory of the project and the cwd for executing tasks.
+     */
+    readonly workdir: string;
+    constructor(workdir: string);
+    /**
+     * The tasks in this project.
+     */
+    get tasks(): TaskSpec[];
+    /**
+     * Find a task by name, or `undefined` if not found.
+     */
+    tryFindTask(name: string): TaskSpec | undefined;
+    /**
+     * Runs the task.
+     * @param name The task name.
+     */
+    runTask(name: string, parents?: string[], args?: Array<string | number>): void;
+}

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

@@ -0,0 +1,129 @@
+import { TaskCommonOptions, TaskSpec, TaskStep, TaskStepOptions } from "./task-model";
+export interface TaskOptions extends TaskCommonOptions {
+    /**
+     * Shell command to execute as the first command of the task.
+     * @default - add steps using `task.exec(command)` or `task.spawn(subtask)`
+     */
+    readonly exec?: string;
+    /**
+     * List of task steps to run.
+     */
+    readonly steps?: TaskStep[];
+    /**
+     * Should the provided `exec` shell command receive args passed to the task.
+     * @see {@link TaskStepOptions.receiveArgs}
+     *
+     * @default false
+     */
+    readonly receiveArgs?: boolean;
+}
+/**
+ * A task that can be performed on the project. Modeled as a series of shell
+ * commands and subtasks.
+ */
+export declare class Task {
+    /**
+     * Task name.
+     */
+    readonly name: string;
+    /**
+     * A command to execute which determines if the task should be skipped. If it
+     * returns a zero exit code, the task will not be executed.
+     */
+    readonly condition?: string;
+    private readonly _steps;
+    private readonly _env;
+    private readonly cwd?;
+    private readonly requiredEnv?;
+    private _locked;
+    private _description?;
+    constructor(name: string, props?: TaskOptions);
+    /**
+     * Forbid additional changes to this task.
+     */
+    lock(): void;
+    /**
+     * Returns the description of this task.
+     */
+    get description(): string | undefined;
+    /**
+     * Sets the description of this task.
+     */
+    set description(desc: string | undefined);
+    /**
+     * Reset the task so it no longer has any commands.
+     * @param command the first command to add to the task after it was cleared.
+     */
+    reset(command?: string, options?: TaskStepOptions): void;
+    /**
+     * Executes a shell command
+     * @param command Shell command
+     * @param options Options
+     */
+    exec(command: string, options?: TaskStepOptions): void;
+    /**
+     * Execute a builtin task.
+     *
+     * Builtin tasks are programs bundled as part of projen itself and used as
+     * helpers for various components.
+     *
+     * In the future we should support built-in tasks from external modules.
+     *
+     * @param name The name of the builtin task to execute (e.g.
+     * `release/resolve-version`).
+     */
+    builtin(name: string): void;
+    /**
+     * Say something.
+     * @param message Your message
+     * @param options Options
+     */
+    say(message: string, options?: TaskStepOptions): void;
+    /**
+     * Adds a command at the beginning of the task.
+     * @param shell The command to add.
+     *
+     * @deprecated use `prependExec()`
+     */
+    prepend(shell: string, options?: TaskStepOptions): void;
+    /**
+     * Spawns a sub-task.
+     * @param subtask The subtask to execute.
+     */
+    spawn(subtask: Task, options?: TaskStepOptions): void;
+    /**
+     * Adds a command at the beginning of the task.
+     * @param shell The command to add.
+     */
+    prependExec(shell: string, options?: TaskStepOptions): void;
+    /**
+     * Adds a spawn instruction at the beginning of the task.
+     * @param subtask The subtask to execute.
+     */
+    prependSpawn(subtask: Task, options?: TaskStepOptions): void;
+    /**
+     * Says something at the beginning of the task.
+     * @param message Your message
+     */
+    prependSay(message: string, options?: TaskStepOptions): void;
+    /**
+     * Adds an environment variable to this task.
+     * @param name The name of the variable
+     * @param value The value. If the value is surrounded by `$()`, we will
+     * evaluate it within a subshell and use the result as the value of the
+     * environment variable.
+     */
+    env(name: string, value: string): void;
+    /**
+     * Returns an immutable copy of all the step specifications of the task.
+     */
+    get steps(): TaskStep[];
+    /**
+     * Renders a task spec into the manifest.
+     *
+     * @internal
+     */
+    _renderSpec(): TaskSpec;
+    private assertUnlocked;
+    private addEnv;
+}

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

@@ -0,0 +1,51 @@
+import { Component } from "./component";
+import { Project } from "./project";
+import { Task, TaskOptions } from "./task";
+/**
+ * Defines project tasks.
+ *
+ * Tasks extend the projen CLI by adding subcommands to it. Task definitions are
+ * synthesized into `.projen/tasks.json`.
+ */
+export declare class Tasks extends Component {
+    private readonly _tasks;
+    private readonly _env;
+    constructor(project: Project);
+    /**
+     * All tasks.
+     */
+    get all(): Task[];
+    /**
+     * Adds a task to a project.
+     * @param name The name of the task
+     * @param options Task options.
+     */
+    addTask(name: string, options?: TaskOptions): Task;
+    /**
+     * Removes a task from a project.
+     *
+     * @param name The name of the task to remove.
+     *
+     * @returns The `Task` that was removed, otherwise `undefined`.
+     */
+    removeTask(name: string): undefined | Task;
+    /**
+     * Adds global environment.
+     * @param name Environment variable name
+     * @param value Value
+     */
+    addEnvironment(name: string, value: string): void;
+    /**
+     * Returns a copy of the currently global environment for this project.
+     */
+    get env(): {
+        [key: string]: string;
+    };
+    /**
+     * Finds a task by name. Returns `undefined` if the task cannot be found.
+     * @param name The name of the task
+     */
+    tryFind(name: string): undefined | Task;
+    synthesize(): void;
+    private renderTasks;
+}

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

@@ -0,0 +1,18 @@
+import { Project } from "./project";
+import { SnapshotOptions } from "./util/synth";
+/**
+ * A Testing static class with a .synth helper for getting a snapshots of construct outputs.
+ * Useful for snapshot testing with Jest.
+ *
+ * @example `expect(Testing.synth(someProject)).toMatchSnapshot()`
+ */
+export declare class Testing {
+    /**
+     * Produces a simple JS object that represents the contents of the projects with field names being file paths.
+     * @param project the project to produce a snapshot for
+     * @return { [filename:string]: any }
+     */
+    static synth(project: Project, options?: SnapshotOptions): Record<string, any>;
+    private constructor();
+}
+export { SnapshotOptions } from "./util/synth";

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

@@ -0,0 +1,33 @@
+import { FileBase, FileBaseOptions, IResolver } from "./file";
+import { Project } from "./project";
+/**
+ * Options for `TextFile`.
+ */
+export interface TextFileOptions extends FileBaseOptions {
+    /**
+     * The contents of the text file. You can use `addLine()` to append lines.
+     *
+     * @default [] empty file
+     */
+    readonly lines?: string[];
+}
+/**
+ * A text file.
+ */
+export declare class TextFile extends FileBase {
+    private readonly lines;
+    /**
+     * Defines a text file.
+     *
+     * @param project The project
+     * @param filePath File path
+     * @param options Options
+     */
+    constructor(project: Project, filePath: string, options?: TextFileOptions);
+    /**
+     * Adds a line to the text file.
+     * @param line the line to add (can use tokens)
+     */
+    addLine(line: string): void;
+    protected synthesizeContent(_: IResolver): string | undefined;
+}

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

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

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

@@ -0,0 +1,4 @@
+export * from "./projenrc";
+export * from "./projenrc-ts";
+export * from "./typescript";
+export * from "./typescript-typedoc";

package/lib/.types-compat/ts3.9/lib/typescript/projenrc-ts.d.ts

@@ -0,0 +1,43 @@
+import { TypescriptConfig } from "../javascript";
+import { Project } from "../project";
+import { ProjenrcFile } from "../projenrc";
+export interface ProjenrcTsOptions {
+    /**
+     * The name of the projenrc file.
+     * @default ".projenrc.ts"
+     */
+    readonly filename?: string;
+    /**
+     * A directory tree that may contain *.ts files that can be referenced from
+     * your projenrc typescript file.
+     *
+     * @default "projenrc"
+     */
+    readonly projenCodeDir?: string;
+    /**
+     * The name of the tsconfig file that will be used by ts-node
+     * when compiling projen source files.
+     *
+     * @default "tsconfig.projen.json"
+     */
+    readonly tsconfigFileName?: string;
+}
+/**
+ * A projenrc file written in TypeScript
+ *
+ * This component can be instantiated in any type of project
+ * and has no expectations around the project's main language.
+ *
+ * Requires that `npx` is available.
+ */
+export declare class ProjenrcTs extends ProjenrcFile {
+    /**
+     * TypeScript configuration file used to compile projen source files
+     */
+    readonly tsconfig: TypescriptConfig;
+    readonly filePath: string;
+    private readonly _projenCodeDir;
+    constructor(project: Project, options?: ProjenrcTsOptions);
+    preSynthesize(): void;
+    private generateProjenrc;
+}

package/lib/.types-compat/ts3.9/lib/typescript/projenrc.d.ts

@@ -0,0 +1,27 @@
+import { ProjenrcFile } from "../projenrc";
+import { TypeScriptProject } from "../typescript";
+export interface ProjenrcOptions {
+    /**
+     * The name of the projenrc file.
+     * @default ".projenrc.ts"
+     */
+    readonly filename?: string;
+    /**
+     * A directory tree that may contain *.ts files that can be referenced from
+     * your projenrc typescript file.
+     *
+     * @default "projenrc"
+     */
+    readonly projenCodeDir?: string;
+}
+/**
+ * Sets up a typescript project to use TypeScript for projenrc.
+ */
+export declare class Projenrc extends ProjenrcFile {
+    readonly filePath: string;
+    private readonly _projenCodeDir;
+    private readonly _tsProject;
+    constructor(project: TypeScriptProject, options?: ProjenrcOptions);
+    preSynthesize(): void;
+    private generateProjenrc;
+}