projen 0.70.2 → 0.70.4

package/lib/.types-compat/ts3.9/lib/cdk/auto-discover-base.d.ts

@@ -0,0 +1,45 @@
+import { Component } from "../component";
+import { Project } from "../project";
+/**
+ * Options for `AutoDiscoverBase`
+ */
+export interface AutoDiscoverBaseOptions {
+    /**
+     * Locate files with the given extension.
+     *
+     * @example ".integ.ts"
+     */
+    readonly extension: string;
+    /**
+     * Locate entrypoints in the given project directory.
+     *
+     * @example "test"
+     */
+    readonly projectdir: string;
+}
+/**
+ * Base class for auto-discovering and creating project subcomponents.
+ */
+export declare abstract class AutoDiscoverBase extends Component {
+    /**
+     * Auto-discovered entry points with paths relative to the project
+     * directory.
+     */
+    readonly entrypoints: string[];
+    constructor(project: Project, options: AutoDiscoverBaseOptions);
+}
+/**
+ * Options for `IntegrationTestAutoDiscoverBase`
+ */
+export interface IntegrationTestAutoDiscoverBaseOptions {
+    /**
+     * Test source tree.
+     */
+    readonly testdir: string;
+}
+/**
+ * Base class for locating integration tests in the project's test tree.
+ */
+export declare class IntegrationTestAutoDiscoverBase extends AutoDiscoverBase {
+    constructor(project: Project, options: IntegrationTestAutoDiscoverBaseOptions);
+}

package/lib/.types-compat/ts3.9/lib/cdk/construct-lib.d.ts

@@ -0,0 +1,38 @@
+import { JsiiProject, JsiiProjectOptions } from "./jsii-project";
+export interface ConstructLibraryOptions extends JsiiProjectOptions {
+    /**
+     * Libraries will be picked up by the construct catalog when they are
+     * published to npm as jsii modules and will be published under:
+     *
+     *     https://awscdk.io/packages/[@SCOPE/]PACKAGE@VERSION
+     *
+     * The catalog will also post a tweet to https://twitter.com/awscdkio with the
+     * package name, description and the above link. You can disable these tweets
+     * through `{ announce: false }`.
+     *
+     * You can also add a Twitter handle through `{ twitter: 'xx' }` which will be
+     * mentioned in the tweet.
+     *
+     * @see https://github.com/construct-catalog/catalog
+     *
+     * @default - new version will be announced
+     */
+    readonly catalog?: Catalog;
+}
+export interface Catalog {
+    /**
+     * Twitter account to @mention in announcement tweet.
+     */
+    readonly twitter?: string;
+    /**
+     * Should we announce new versions?
+     * @default true
+     */
+    readonly announce?: boolean;
+}
+/**
+ * A multi-language library for CDK constructs.
+ */
+export declare abstract class ConstructLibrary extends JsiiProject {
+    constructor(options: ConstructLibraryOptions);
+}

package/lib/.types-compat/ts3.9/lib/cdk/consts.d.ts

@@ -0,0 +1,6 @@
+import { Tools } from "../github/workflows-model";
+export type JsiiPacmakTarget = "js" | "go" | "java" | "python" | "dotnet";
+/**
+ * GitHub workflow job steps for setting up the tools required for various JSII targets.
+ */
+export declare const JSII_TOOLCHAIN: Record<JsiiPacmakTarget, Tools>;

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

@@ -0,0 +1,5 @@
+export * from "./construct-lib";
+export * from "./jsii-docgen";
+export * from "./jsii-project";
+export * from "./integration-test-base";
+export * from "./auto-discover-base";

package/lib/.types-compat/ts3.9/lib/cdk/integration-test-base.d.ts

@@ -0,0 +1,53 @@
+import { Component } from "../component";
+import { Project } from "../project";
+import { Task } from "../task";
+/**
+ * Options for IntegrationTest
+ */
+export interface IntegrationTestBaseOptions {
+    /**
+     * Name of the integration test
+     * @default - Derived from the entrypoint filename.
+     */
+    readonly name?: string;
+    /**
+     * A path from the project root directory to a TypeScript file which contains
+     * the integration test app.
+     *
+     * This is relative to the root directory of the project.
+     *
+     * @example "test/subdir/foo.integ.ts"
+     */
+    readonly entrypoint: string;
+    /**
+     * The path of the tsconfig.json file to use when running integration test cdk apps.
+     */
+    readonly tsconfigPath: string;
+}
+export declare abstract class IntegrationTestBase extends Component {
+    /**
+     * Deploy the integration test and update the snapshot upon success.
+     */
+    readonly deployTask: Task;
+    /**
+     * Synthesizes the integration test and compares against a local copy (runs during build).
+     */
+    readonly assertTask: Task;
+    /**
+     * Just update snapshot (without deployment).
+     */
+    readonly snapshotTask: Task;
+    /**
+     * Temporary directory for each integration test.
+     */
+    protected readonly tmpDir: string;
+    /**
+     * Snapshot output directory.
+     */
+    protected readonly snapshotDir: string;
+    /**
+     * Integration test name.
+     */
+    protected readonly name: string;
+    constructor(project: Project, options: IntegrationTestBaseOptions);
+}

package/lib/.types-compat/ts3.9/lib/cdk/internal.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Suffix for integration tests.
+ */
+export declare const TYPESCRIPT_INTEG_EXT = ".integ.ts";

package/lib/.types-compat/ts3.9/lib/cdk/jsii-docgen.d.ts

@@ -0,0 +1,20 @@
+import { JsiiProject } from "./jsii-project";
+/**
+ * Options for `JsiiDocgen`
+ */
+export interface JsiiDocgenOptions {
+    /**
+     * File path for generated docs.
+     * @default "API.md"
+     */
+    readonly filePath?: string;
+}
+/**
+ * Creates a markdown file based on the jsii manifest:
+ * - Adds a `docgen` script to package.json
+ * - Runs `jsii-docgen` after compilation
+ * - Enforces that markdown file is checked in
+ */
+export declare class JsiiDocgen {
+    constructor(project: JsiiProject, options?: JsiiDocgenOptions);
+}

package/lib/.types-compat/ts3.9/lib/cdk/jsii-project.d.ts

@@ -0,0 +1,153 @@
+import { Eslint } from "../javascript";
+import { GoPublishOptions, MavenPublishOptions, NugetPublishOptions, PyPiPublishOptions } from "../release";
+import { TypeScriptProject, TypeScriptProjectOptions } from "../typescript";
+export interface JsiiProjectOptions extends TypeScriptProjectOptions {
+    /**
+     * @default "."
+     */
+    readonly rootdir?: string;
+    /**
+     * Git repository URL.
+     * @default $GIT_REMOTE
+     */
+    readonly repositoryUrl: string;
+    /**
+     * The name of the library author.
+     * @default $GIT_USER_NAME
+     */
+    readonly author: string;
+    /**
+     * Email or URL of the library author.
+     * @default $GIT_USER_EMAIL
+     */
+    readonly authorAddress: string;
+    /**
+     * Publish to maven
+     * @default - no publishing
+     */
+    readonly publishToMaven?: JsiiJavaTarget;
+    /**
+     * Publish to pypi
+     * @default - no publishing
+     */
+    readonly publishToPypi?: JsiiPythonTarget;
+    /**
+     * Publish Go bindings to a git repository.
+     * @default - no publishing
+     */
+    readonly publishToGo?: JsiiGoTarget;
+    /**
+     * @deprecated use `publishToPyPi`
+     */
+    readonly python?: JsiiPythonTarget;
+    /**
+     * Publish to NuGet
+     * @default - no publishing
+     */
+    readonly publishToNuget?: JsiiDotNetTarget;
+    /**
+     * @deprecated use `publishToNuget`
+     */
+    readonly dotnet?: JsiiDotNetTarget;
+    /**
+     * Automatically run API compatibility test against the latest version published to npm after compilation.
+     *
+     * - You can manually run compatibility tests using `yarn compat` if this feature is disabled.
+     * - You can ignore compatibility failures by adding lines to a ".compatignore" file.
+     *
+     * @default false
+     */
+    readonly compat?: boolean;
+    /**
+     * Name of the ignore file for API compatibility tests.
+     *
+     * @default ".compatignore"
+     */
+    readonly compatIgnore?: string;
+    /**
+     * Accepts a list of glob patterns. Files matching any of those patterns will be excluded from the TypeScript compiler input.
+     *
+     * By default, jsii will include all *.ts files (except .d.ts files) in the TypeScript compiler input.
+     * This can be problematic for example when the package's build or test procedure generates .ts files
+     * that cannot be compiled with jsii's compiler settings.
+     */
+    readonly excludeTypescript?: string[];
+    /**
+     * File path for generated docs.
+     * @default "API.md"
+     */
+    readonly docgenFilePath?: string;
+    /**
+     * Emit a compressed version of the assembly
+     * @default false
+     */
+    readonly compressAssembly?: boolean;
+    /**
+     * Version of the jsii compiler to use.
+     *
+     * Set to "*" if you want to manually manage the version of jsii in your
+     * project by managing updates to `package.json` on your own.
+     *
+     * NOTE: The jsii compiler releases since 5.0.0 are not semantically versioned
+     * and should remain on the same minor, so we recommend using a `~` dependency
+     * (e.g. `~5.0.0`).
+     *
+     * @default "1.x"
+     */
+    readonly jsiiVersion?: string;
+}
+export declare enum Stability {
+    EXPERIMENTAL = "experimental",
+    STABLE = "stable",
+    DEPRECATED = "deprecated"
+}
+export interface JsiiJavaTarget extends MavenPublishOptions {
+    readonly javaPackage: string;
+    readonly mavenGroupId: string;
+    readonly mavenArtifactId: string;
+}
+export interface JsiiPythonTarget extends PyPiPublishOptions {
+    readonly distName: string;
+    readonly module: string;
+}
+export interface JsiiDotNetTarget extends NugetPublishOptions {
+    readonly dotNetNamespace: string;
+    readonly packageId: string;
+    readonly iconUrl?: string;
+}
+/**
+ * Go target configuration
+ */
+export interface JsiiGoTarget extends GoPublishOptions {
+    /**
+     * The name of the target go module.
+     *
+     * @example github.com/owner/repo
+     * @example github.com/owner/repo/subdir
+     */
+    readonly moduleName: string;
+    /**
+     * The name of the go package.
+     *
+     * @default - derived from the module name
+     */
+    readonly packageName?: string;
+}
+/**
+ * Multi-language jsii library project
+ *
+ * @pjid jsii
+ */
+export declare class JsiiProject extends TypeScriptProject {
+    readonly eslint?: Eslint;
+    private readonly packageAllTask;
+    constructor(options: JsiiProjectOptions);
+    /**
+     * Adds a target language to the build workflow and creates a package task.
+     * @param language
+     * @returns
+     */
+    private addPackagingTarget;
+    private addPackagingTask;
+    private pacmakForLanguage;
+}

package/lib/.types-compat/ts3.9/lib/cdk8s/auto-discover.d.ts

@@ -0,0 +1,33 @@
+import { IntegrationTestAutoDiscoverBase, IntegrationTestAutoDiscoverBaseOptions } from "../cdk";
+import { Component } from "../component";
+import { Project } from "../project";
+/**
+ * Options for `AutoDiscover`.
+ */
+export interface AutoDiscoverOptions extends IntegrationTestAutoDiscoverOptions {
+    /**
+     * Automatically discover integration tests
+     *
+     * @default true
+     */
+    readonly integrationTestAutoDiscover?: boolean;
+}
+/**
+ * Automatically discovers and creates `IntegrationTest`s from entry points
+ * found in the test tree.
+ */
+export declare class AutoDiscover extends Component {
+    constructor(project: Project, options: AutoDiscoverOptions);
+}
+export interface IntegrationTestAutoDiscoverOptions extends IntegrationTestAutoDiscoverBaseOptions {
+    /**
+     * Path to the tsconfig file to use for integration tests.
+     */
+    readonly tsconfigPath: string;
+}
+/**
+ * Discovers and creates integration tests from files in the test root.
+ */
+export declare class IntegrationTestAutoDiscover extends IntegrationTestAutoDiscoverBase {
+    constructor(project: Project, options: IntegrationTestAutoDiscoverOptions);
+}

package/lib/.types-compat/ts3.9/lib/cdk8s/cdk8s-app-py.d.ts

@@ -0,0 +1,39 @@
+import { Cdk8sDeps, Cdk8sDepsCommonOptions } from "./cdk8s-deps";
+import { PythonProject, PythonProjectOptions } from "../python/python-project";
+/**
+ * Options for `Cdk8sPythonApp`
+ */
+export interface Cdk8sPythonOptions extends PythonProjectOptions, Cdk8sDepsCommonOptions {
+    /**
+     * Import a specific Kubernetes spec version.
+     *
+     * @default - Use the cdk8s default
+     */
+    readonly k8sSpecVersion?: string;
+    /**
+     * Import additional specs
+     *
+     * @default - no additional specs imported
+     */
+    readonly cdk8sImports?: string[];
+    /**
+     * The CDK8s app's entrypoint
+     *
+     * @default "app.py"
+     */
+    readonly appEntrypoint?: string;
+}
+/**
+ * CDK8s app in Python
+ *
+ *
+ * @pjid cdk8s-app-py
+ */
+export declare class Cdk8sPythonApp extends PythonProject {
+    /**
+     * The CDK8s app entrypoint
+     */
+    readonly appEntrypoint: string;
+    readonly cdk8sDeps: Cdk8sDeps;
+    constructor(options: Cdk8sPythonOptions);
+}

package/lib/.types-compat/ts3.9/lib/cdk8s/cdk8s-app-ts.d.ts

@@ -0,0 +1,45 @@
+import { Cdk8sDeps, Cdk8sDepsCommonOptions } from "./cdk8s-deps";
+import { TypeScriptAppProject, TypeScriptProjectOptions } from "../typescript";
+export interface Cdk8sTypeScriptAppOptions extends TypeScriptProjectOptions, Cdk8sDepsCommonOptions {
+    /**
+     * Import a specific Kubernetes spec version.
+     *
+     * @default - Use the cdk8s default
+     */
+    readonly k8sSpecVersion?: string;
+    /**
+     * Import additional specs
+     *
+     * @default - no additional specs imported
+     */
+    readonly cdk8sImports?: string[];
+    /**
+     * The CDK8s app's entrypoint (relative to the source directory, which is
+     * "src" by default).
+     *
+     * @default "main.ts"
+     */
+    readonly appEntrypoint?: string;
+    /**
+     * Automatically adds an `cdk8s.IntegrationTest` for each `.integ.ts` app
+     * in your test directory. If this is disabled, you can manually add an
+     * `cdk8s.AutoDiscover` component to your project.
+     *
+     * @default true
+     */
+    readonly integrationTestAutoDiscover?: boolean;
+}
+/**
+ * CDK8s app in TypeScript
+ *
+ *
+ * @pjid cdk8s-app-ts
+ */
+export declare class Cdk8sTypeScriptApp extends TypeScriptAppProject {
+    /**
+     * The CDK8s app entrypoint
+     */
+    readonly appEntrypoint: string;
+    readonly cdk8sDeps: Cdk8sDeps;
+    constructor(options: Cdk8sTypeScriptAppOptions);
+}

package/lib/.types-compat/ts3.9/lib/cdk8s/cdk8s-construct.d.ts

@@ -0,0 +1,71 @@
+import { ConstructLibrary, ConstructLibraryOptions } from "../cdk";
+export interface ConstructLibraryCdk8sOptions extends ConstructLibraryOptions {
+    /**
+     * Minimum target version this library is tested against.
+     *
+     * @default "1.4.10"
+     * @featured
+     */
+    readonly cdk8sVersion: string;
+    /**
+     * constructs verion
+     *
+     * @default "3.3.196"
+     */
+    readonly constructsVersion?: string;
+    /**
+     * Use pinned version instead of caret version for CDK8s.
+     *
+     * You can use this to prevent yarn to mix versions for your CDK8s package and to prevent auto-updates.
+     * If you use experimental features this will let you define the moment you include breaking changes.
+     *
+     * @default false
+     */
+    readonly cdk8sVersionPinning?: boolean;
+    /**
+     * Use pinned version instead of caret version for constructs.
+     *
+     * You can use this to prevent yarn to mix versions for your consructs package and to prevent auto-updates.
+     * If you use experimental features this will let you define the moment you include breaking changes.
+     *
+     * @default false
+     */
+    readonly constructsVersionPinning?: boolean;
+    /**
+     * Use pinned version instead of caret version for cdk8s-plus-17.
+     *
+     * You can use this to prevent yarn to mix versions for your CDK8s package and to prevent auto-updates.
+     * If you use experimental features this will let you define the moment you include breaking changes.
+     *
+     * @default false
+     */
+    readonly cdk8sPlusVersionPinning?: boolean;
+    /**
+     * Automatically adds an `cdk8s.IntegrationTest` for each `.integ.ts` app
+     * in your test directory. If this is disabled, you can manually add an
+     * `cdk8s.AutoDiscover` component to your project.
+     *
+     * @default true
+     */
+    readonly integrationTestAutoDiscover?: boolean;
+}
+/**
+ * CDK8s construct library project
+ *
+ * A multi-language (jsii) construct library which vends constructs designed to
+ * use within the CDK for Kubernetes (CDK8s), with a friendly workflow and
+ * automatic publishing to the construct catalog.
+ *
+ * @pjid cdk8s-construct
+ */
+export declare class ConstructLibraryCdk8s extends ConstructLibrary {
+    /**
+     * The CDK8s version this app is using.
+     */
+    readonly cdk8sVersion: string;
+    /**
+     * The constructs version this app is using.
+     */
+    readonly constructsVersion: string;
+    constructor(options: ConstructLibraryCdk8sOptions);
+}

package/lib/.types-compat/ts3.9/lib/cdk8s/cdk8s-deps-js.d.ts

@@ -0,0 +1,4 @@
+import { Cdk8sDeps, Cdk8sPackageNames } from "./cdk8s-deps";
+export declare class Cdk8sDepsJs extends Cdk8sDeps {
+    protected packageNames(): Cdk8sPackageNames;
+}

package/lib/.types-compat/ts3.9/lib/cdk8s/cdk8s-deps-py.d.ts

@@ -0,0 +1,4 @@
+import { Cdk8sDeps, Cdk8sPackageNames } from "./cdk8s-deps";
+export declare class Cdk8sDepsPy extends Cdk8sDeps {
+    protected packageNames(): Cdk8sPackageNames;
+}

package/lib/.types-compat/ts3.9/lib/cdk8s/cdk8s-deps.d.ts

@@ -0,0 +1,144 @@
+import { Component } from "../component";
+import { DependencyType } from "../dependencies";
+import { Project } from "../project";
+/**
+ * Options for `Cdk8sDeps`
+ */
+export interface Cdk8sDepsCommonOptions {
+    /**
+     * Minumum version of the cdk8s to depend on.
+     *
+     * @default "2.3.33"
+     */
+    readonly cdk8sVersion: string;
+    /**
+     * Minumum version of the cdk8s-cli to depend on.
+     *
+     * @default "2.0.28"
+     */
+    readonly cdk8sCliVersion?: string;
+    /**
+     * Minimum version of the `constructs` library to depend on.
+     *
+     * @default "10.1.42"
+     */
+    readonly constructsVersion?: string;
+    /**
+     * Use pinned version instead of caret version for cdk8s.
+     *
+     * You can use this to prevent yarn to mix versions for your CDK8s package and to prevent auto-updates.
+     * If you use experimental features this will let you define the moment you include breaking changes.
+     *
+     * @default false
+     */
+    readonly cdk8sVersionPinning?: boolean;
+    /**
+     * Use pinned version instead of caret version for cdk8s-cli.
+     *
+     * You can use this to prevent yarn to mix versions for your CDK8s package and to prevent auto-updates.
+     * If you use experimental features this will let you define the moment you include breaking changes.
+     *
+     * @default false
+     */
+    readonly cdk8sCliVersionPinning?: boolean;
+    /**
+     * Use pinned version instead of caret version for constructs.
+     *
+     * You can use this to prevent yarn to mix versions for your consructs package and to prevent auto-updates.
+     * If you use experimental features this will let you define the moment you include breaking changes.
+     *
+     * @default false
+     */
+    readonly constructsVersionPinning?: boolean;
+    /**
+     * Include cdk8s-plus
+     *
+     * @default true
+     */
+    readonly cdk8sPlus?: boolean;
+    /**
+     * The cdk8s-plus library depends of Kubernetes minor version
+     * For example, cdk8s-plus-22 targets kubernetes version 1.22.0
+     * cdk8s-plus-21 targets kubernetes version 1.21.0
+     *
+     * @default 22
+     */
+    readonly k8sMinorVersion?: number;
+    /**
+     * Minumum version of the cdk8s-plus-XX to depend on.
+     *
+     * @default "2.0.0-rc.26"
+     */
+    readonly cdk8sPlusVersion?: string;
+    /**
+     * Use pinned version instead of caret version for cdk8s-plus-17.
+     *
+     * You can use this to prevent yarn to mix versions for your CDK8s package and to prevent auto-updates.
+     * If you use experimental features this will let you define the moment you include breaking changes.
+     *
+     * @default false
+     */
+    readonly cdk8sPlusVersionPinning?: boolean;
+}
+export interface Cdk8sDepsOptions extends Cdk8sDepsCommonOptions {
+    /**
+     * The type of dependency to use for runtime CDK8s and `constructs` modules.
+     *
+     * For libraries, use peer dependencies and for apps use runtime dependencies.
+     */
+    readonly dependencyType: DependencyType;
+    /**
+     * Add cdk8s-cli only to Node projects
+     *
+     * @default false
+     */
+    readonly cdk8sCliDependency: boolean;
+}
+export interface Cdk8sPackageNames {
+    /**
+     * Fully qualified name of the core framework package
+     */
+    readonly cdk8s: string;
+    /**
+     * Fully qualified name of the client package.
+     * Used only on Node projects
+     */
+    readonly cdk8sClient?: string;
+    /**
+     * Fully qualified name of the constructs library package
+     */
+    readonly constructs: string;
+    /**
+     * Fully qualified name of the cdk9s-plus-XX library package
+     */
+    readonly cdk8sPlus: string;
+}
+/**
+ * Manages dependencies on the CDK8s.
+ */
+export declare abstract class Cdk8sDeps extends Component {
+    /**
+     * The dependency requirement for CDK8s.
+     */
+    readonly cdk8sVersion: string;
+    /**
+     * The minimum version of the CDK8s (e.g. `2.0.0`)
+     */
+    readonly cdk8sMinimumVersion: string;
+    /**
+     * The major version of the CDK8s (e.g. 1, 2, ...)
+     */
+    readonly cdk8sMajorVersion: number;
+    private readonly dependencyType;
+    private readonly _packageNames;
+    constructor(project: Project, options: Cdk8sDepsOptions);
+    /**
+     * Return a configuration object with information about package naming in various languages
+     */
+    protected abstract packageNames(): Cdk8sPackageNames;
+    private getVersionRequirement;
+    private addCdk8sPlusDependency;
+    private addClientDependency;
+    private addFrameworkDependency;
+    private addConstructsDependency;
+}

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

@@ -0,0 +1,7 @@
+export * from "./auto-discover";
+export * from "./cdk8s-app-py";
+export * from "./cdk8s-app-ts";
+export * from "./cdk8s-construct";
+export * from "./integration-test";
+export * from "./cdk8s-deps";
+export * from "./cdk8s-deps-py";