# API Reference ## Constructs ### TypeSafeRestApi A construct for creating an api gateway rest api based on the definition in the OpenAPI spec. #### Initializers ```typescript import { TypeSafeRestApi } from '@aws-prototyping-sdk/type-safe-api' new TypeSafeRestApi(scope: Construct, id: string, props: TypeSafeRestApiProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | TypeSafeRestApiProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* TypeSafeRestApiProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { TypeSafeRestApi } from '@aws-prototyping-sdk/type-safe-api' TypeSafeRestApi.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | api | aws-cdk-lib.aws_apigateway.SpecRestApi | Underlying API Gateway API construct. | | extendedApiSpecification | any | The OpenAPI specification with applied API gateway extensions. | | ipSet | aws-cdk-lib.aws_wafv2.CfnIPSet | Reference to the IP set if created. | | webAcl | aws-cdk-lib.aws_wafv2.CfnWebACL | Reference to the webacl, if created. | | webAclAssociation | aws-cdk-lib.aws_wafv2.CfnWebACLAssociation | Reference to the web acl association if created. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `api`^Required ```typescript public readonly api: SpecRestApi; ``` - *Type:* aws-cdk-lib.aws_apigateway.SpecRestApi Underlying API Gateway API construct. --- ##### `extendedApiSpecification`^Required ```typescript public readonly extendedApiSpecification: any; ``` - *Type:* any The OpenAPI specification with applied API gateway extensions. --- ##### `ipSet`^Optional ```typescript public readonly ipSet: CfnIPSet; ``` - *Type:* aws-cdk-lib.aws_wafv2.CfnIPSet Reference to the IP set if created. --- ##### `webAcl`^Optional ```typescript public readonly webAcl: CfnWebACL; ``` - *Type:* aws-cdk-lib.aws_wafv2.CfnWebACL Reference to the webacl, if created. --- ##### `webAclAssociation`^Optional ```typescript public readonly webAclAssociation: CfnWebACLAssociation; ``` - *Type:* aws-cdk-lib.aws_wafv2.CfnWebACLAssociation Reference to the web acl association if created. --- ## Structs ### ApiGatewayIntegration Represents an api gateway integration. > [https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration.html](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration.html) #### Initializer ```typescript import { ApiGatewayIntegration } from '@aws-prototyping-sdk/type-safe-api' const apiGatewayIntegration: ApiGatewayIntegration = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cacheKeyParameters | string[] | A list of request parameters whose values are to be cached. | | cacheNamespace | string | An API-specific tag group of related cached parameters. | | connectionId | string | The ID of a VpcLink for the private integration. | | connectionType | string | The integration connection type. | | contentHandling | string | Request payload encoding conversion types. | | credentials | string | For AWS IAM role-based credentials, specify the ARN of an appropriate IAM role. | | httpMethod | string | The HTTP method used in the integration request. | | passthroughBehavior | string | Specifies how a request payload of unmapped content type is passed through the integration request without modification. | | requestParameters | {[ key: string ]: string} | Specifies mappings from method request parameters to integration request parameters. | | requestTemplates | {[ key: string ]: string} | Mapping templates for a request payload of specified MIME types. | | responses | {[ key: string ]: ApiGatewayIntegrationResponse} | Defines the method's responses and specifies desired parameter mappings or payload mappings from integration responses to method responses. | | timeoutInMillis | number | Custom timeout between 50 and 29,000 milliseconds. | | tlsConfig | ApiGatewayIntegrationTlsConfig | Specifies the TLS configuration for an integration. | | type | string | The type of integration with the specified backend. | | uri | string | The endpoint URI of the backend. | --- ##### `cacheKeyParameters`^Optional ```typescript public readonly cacheKeyParameters: string[]; ``` - *Type:* string[] A list of request parameters whose values are to be cached. --- ##### `cacheNamespace`^Optional ```typescript public readonly cacheNamespace: string; ``` - *Type:* string An API-specific tag group of related cached parameters. --- ##### `connectionId`^Optional ```typescript public readonly connectionId: string; ``` - *Type:* string The ID of a VpcLink for the private integration. > [https://docs.aws.amazon.com/apigateway/latest/api/API_VpcLink.html](https://docs.aws.amazon.com/apigateway/latest/api/API_VpcLink.html) --- ##### `connectionType`^Optional ```typescript public readonly connectionType: string; ``` - *Type:* string The integration connection type. The valid value is "VPC_LINK" for private integration or "INTERNET", otherwise. --- ##### `contentHandling`^Optional ```typescript public readonly contentHandling: string; ``` - *Type:* string Request payload encoding conversion types. Valid values are 1) CONVERT_TO_TEXT, for converting a binary payload into a base64-encoded string or converting a text payload into a utf-8-encoded string or passing through the text payload natively without modification, and 2) CONVERT_TO_BINARY, for converting a text payload into a base64-decoded blob or passing through a binary payload natively without modification. --- ##### `credentials`^Optional ```typescript public readonly credentials: string; ``` - *Type:* string For AWS IAM role-based credentials, specify the ARN of an appropriate IAM role. If unspecified, credentials default to resource-based permissions that must be added manually to allow the API to access the resource. For more information, see Granting Permissions Using a Resource Policy. Note: When using IAM credentials, make sure that AWS STS Regional endpoints are enabled for the Region where this API is deployed for best performance. --- ##### `httpMethod`^Optional ```typescript public readonly httpMethod: string; ``` - *Type:* string The HTTP method used in the integration request. For Lambda function invocations, the value must be POST. --- ##### `passthroughBehavior`^Optional ```typescript public readonly passthroughBehavior: string; ``` - *Type:* string Specifies how a request payload of unmapped content type is passed through the integration request without modification. Supported values are when_no_templates, when_no_match, and never. > [https://docs.aws.amazon.com/apigateway/latest/api/API_Integration.html#passthroughBehavior](https://docs.aws.amazon.com/apigateway/latest/api/API_Integration.html#passthroughBehavior) --- ##### `requestParameters`^Optional ```typescript public readonly requestParameters: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Specifies mappings from method request parameters to integration request parameters. Supported request parameters are querystring, path, header, and body. > [https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-requestParameters.html](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-requestParameters.html) --- ##### `requestTemplates`^Optional ```typescript public readonly requestTemplates: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Mapping templates for a request payload of specified MIME types. > [https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-requestTemplates.html](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-requestTemplates.html) --- ##### `responses`^Optional ```typescript public readonly responses: {[ key: string ]: ApiGatewayIntegrationResponse}; ``` - *Type:* {[ key: string ]: ApiGatewayIntegrationResponse} Defines the method's responses and specifies desired parameter mappings or payload mappings from integration responses to method responses. > [https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-responses.html](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-responses.html) --- ##### `timeoutInMillis`^Optional ```typescript public readonly timeoutInMillis: number; ``` - *Type:* number Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. --- ##### `tlsConfig`^Optional ```typescript public readonly tlsConfig: ApiGatewayIntegrationTlsConfig; ``` - *Type:* ApiGatewayIntegrationTlsConfig Specifies the TLS configuration for an integration. > [https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-extensions-integration-tls-config.html](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-extensions-integration-tls-config.html) --- ##### `type`^Optional ```typescript public readonly type: string; ``` - *Type:* string The type of integration with the specified backend. > [https://docs.aws.amazon.com/apigateway/latest/api/API_Integration.html#type](https://docs.aws.amazon.com/apigateway/latest/api/API_Integration.html#type) --- ##### `uri`^Optional ```typescript public readonly uri: string; ``` - *Type:* string The endpoint URI of the backend. For integrations of the aws type, this is an ARN value. For the HTTP integration, this is the URL of the HTTP endpoint including the https or http scheme. --- ### ApiGatewayIntegrationResponse API Gateway integration response. > [https://docs.aws.amazon.com/apigateway/latest/api/API_Integration.html](https://docs.aws.amazon.com/apigateway/latest/api/API_Integration.html) #### Initializer ```typescript import { ApiGatewayIntegrationResponse } from '@aws-prototyping-sdk/type-safe-api' const apiGatewayIntegrationResponse: ApiGatewayIntegrationResponse = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | responseParameters | {[ key: string ]: string} | Specifies parameter mappings for the response. | | responseTemplates | {[ key: string ]: string} | Specifies MIME type-specific mapping templates for the response’s payload. | | statusCode | string | HTTP status code for the method response. | | contentHandling | string | Response payload encoding conversion types. | --- ##### `responseParameters`^Required ```typescript public readonly responseParameters: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Specifies parameter mappings for the response. --- ##### `responseTemplates`^Required ```typescript public readonly responseTemplates: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Specifies MIME type-specific mapping templates for the response’s payload. --- ##### `statusCode`^Required ```typescript public readonly statusCode: string; ``` - *Type:* string HTTP status code for the method response. --- ##### `contentHandling`^Optional ```typescript public readonly contentHandling: string; ``` - *Type:* string Response payload encoding conversion types. Valid values are 1) CONVERT_TO_TEXT, for converting a binary payload into a base64-encoded string or converting a text payload into a utf-8-encoded string or passing through the text payload natively without modification, and 2) CONVERT_TO_BINARY, for converting a text payload into a base64-decoded blob or passing through a binary payload natively without modification. --- ### ApiGatewayIntegrationTlsConfig Specifies the TLS configuration for an integration. > [https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-extensions-integration-tls-config.html](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-extensions-integration-tls-config.html) #### Initializer ```typescript import { ApiGatewayIntegrationTlsConfig } from '@aws-prototyping-sdk/type-safe-api' const apiGatewayIntegrationTlsConfig: ApiGatewayIntegrationTlsConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | insecureSkipVerification | boolean | Specifies whether or not API Gateway skips verification that the certificate for an integration endpoint is issued by a supported certificate authority. | --- ##### `insecureSkipVerification`^Optional ```typescript public readonly insecureSkipVerification: boolean; ``` - *Type:* boolean Specifies whether or not API Gateway skips verification that the certificate for an integration endpoint is issued by a supported certificate authority. This isn’t recommended, but it enables you to use certificates that are signed by private certificate authorities, or certificates that are self-signed. If enabled, API Gateway still performs basic certificate validation, which includes checking the certificate's expiration date, hostname, and presence of a root certificate authority. Supported only for HTTP and HTTP_PROXY integrations. --- ### ApiKeyOptions Options for API keys. #### Initializer ```typescript import { ApiKeyOptions } from '@aws-prototyping-sdk/type-safe-api' const apiKeyOptions: ApiKeyOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | source | aws-cdk-lib.aws_apigateway.ApiKeySourceType | Source type for an API key. | | requiredByDefault | boolean | Set to true to require an API key on all operations by default. | --- ##### `source`^Required ```typescript public readonly source: ApiKeySourceType; ``` - *Type:* aws-cdk-lib.aws_apigateway.ApiKeySourceType Source type for an API key. --- ##### `requiredByDefault`^Optional ```typescript public readonly requiredByDefault: boolean; ``` - *Type:* boolean Set to true to require an API key on all operations by default. Only applicable when the source is HEADER. --- ### AuthorizerProps Properties for an authorizer. #### Initializer ```typescript import { AuthorizerProps } from '@aws-prototyping-sdk/type-safe-api' const authorizerProps: AuthorizerProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | authorizationType | aws-cdk-lib.aws_apigateway.AuthorizationType | The type of the authorizer. | | authorizerId | string | The unique identifier for the authorizer. | | authorizationScopes | string[] | Scopes for the authorizer, if any. | --- ##### `authorizationType`^Required ```typescript public readonly authorizationType: AuthorizationType; ``` - *Type:* aws-cdk-lib.aws_apigateway.AuthorizationType The type of the authorizer. --- ##### `authorizerId`^Required ```typescript public readonly authorizerId: string; ``` - *Type:* string The unique identifier for the authorizer. --- ##### `authorizationScopes`^Optional ```typescript public readonly authorizationScopes: string[]; ``` - *Type:* string[] Scopes for the authorizer, if any. --- ### CidrAllowList Representation of a CIDR range. #### Initializer ```typescript import { CidrAllowList } from '@aws-prototyping-sdk/type-safe-api' const cidrAllowList: CidrAllowList = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cidrRanges | string[] | Specify an IPv4 address by using CIDR notation. | | cidrType | string | Type of CIDR range. | --- ##### `cidrRanges`^Required ```typescript public readonly cidrRanges: string[]; ``` - *Type:* string[] Specify an IPv4 address by using CIDR notation. For example: To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32 . To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24 . For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing . Specify an IPv6 address by using CIDR notation. For example: To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128 . To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64 . --- ##### `cidrType`^Required ```typescript public readonly cidrType: string; ``` - *Type:* string Type of CIDR range. --- ### CodeGenerationSourceOptions Options for the source files used for code generation. #### Initializer ```typescript import { CodeGenerationSourceOptions } from '@aws-prototyping-sdk/type-safe-api' const codeGenerationSourceOptions: CodeGenerationSourceOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | specPath | string | Path to the OpenAPI specification. | | smithyJsonModelPath | string | Path to the Smithy json model if applicable. | --- ##### `specPath`^Required ```typescript public readonly specPath: string; ``` - *Type:* string Path to the OpenAPI specification. --- ##### `smithyJsonModelPath`^Optional ```typescript public readonly smithyJsonModelPath: string; ``` - *Type:* string Path to the Smithy json model if applicable. --- ### CognitoAuthorizerProps Properties used to configure a cognito authorizer. #### Initializer ```typescript import { CognitoAuthorizerProps } from '@aws-prototyping-sdk/type-safe-api' const cognitoAuthorizerProps: CognitoAuthorizerProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | authorizerId | string | Unique identifier for this authorizer. | | userPools | aws-cdk-lib.aws_cognito.IUserPool[] | The Cognito user pools associated with this authorizer. | | authorizationScopes | string[] | A list of authorization scopes configured on the method. | --- ##### `authorizerId`^Required ```typescript public readonly authorizerId: string; ``` - *Type:* string Unique identifier for this authorizer. --- ##### `userPools`^Required ```typescript public readonly userPools: IUserPool[]; ``` - *Type:* aws-cdk-lib.aws_cognito.IUserPool[] The Cognito user pools associated with this authorizer. --- ##### `authorizationScopes`^Optional ```typescript public readonly authorizationScopes: string[]; ``` - *Type:* string[] - *Default:* [] A list of authorization scopes configured on the method. When used as the default authorizer, these scopes will be applied to all methods without an authorizer at the integration level. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes) --- ### CustomAuthorizerProps Properties used to configure a custom authorizer. #### Initializer ```typescript import { CustomAuthorizerProps } from '@aws-prototyping-sdk/type-safe-api' const customAuthorizerProps: CustomAuthorizerProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | authorizerId | string | Unique identifier for this authorizer. | | function | aws-cdk-lib.aws_lambda.IFunction | The lambda function used to authorize requests. | | authorizerResultTtlInSeconds | number | The number of seconds during which the authorizer result is cached. | | identitySource | string | The source of the identity in an incoming request. | | type | CustomAuthorizerType | The type of custom authorizer. | --- ##### `authorizerId`^Required ```typescript public readonly authorizerId: string; ``` - *Type:* string Unique identifier for this authorizer. --- ##### `function`^Required ```typescript public readonly function: IFunction; ``` - *Type:* aws-cdk-lib.aws_lambda.IFunction The lambda function used to authorize requests. --- ##### `authorizerResultTtlInSeconds`^Optional ```typescript public readonly authorizerResultTtlInSeconds: number; ``` - *Type:* number - *Default:* 300 The number of seconds during which the authorizer result is cached. --- ##### `identitySource`^Optional ```typescript public readonly identitySource: string; ``` - *Type:* string - *Default:* "method.request.header.Authorization" The source of the identity in an incoming request. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identitysource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identitysource) --- ##### `type`^Optional ```typescript public readonly type: CustomAuthorizerType; ``` - *Type:* CustomAuthorizerType - *Default:* CustomAuthorizerType.TOKEN The type of custom authorizer. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-type) --- ### DocumentationConfiguration Configuration for generated documentation. #### Initializer ```typescript import { DocumentationConfiguration } from '@aws-prototyping-sdk/type-safe-api' const documentationConfiguration: DocumentationConfiguration = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | formats | DocumentationFormat[] | Formats for generated documentation. | | options | GeneratedDocumentationOptions | Options for the generated documentation projects. | --- ##### `formats`^Required ```typescript public readonly formats: DocumentationFormat[]; ``` - *Type:* DocumentationFormat[] Formats for generated documentation. --- ##### `options`^Optional ```typescript public readonly options: GeneratedDocumentationOptions; ``` - *Type:* GeneratedDocumentationOptions Options for the generated documentation projects. Note that only those provided for the specified formats will apply --- ### GeneratedCodeProjects Generated code projects. #### Initializer ```typescript import { GeneratedCodeProjects } from '@aws-prototyping-sdk/type-safe-api' const generatedCodeProjects: GeneratedCodeProjects = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | java | projen.java.JavaProject | Generated java project. | | python | projen.python.PythonProject | Generated python project. | | typescript | projen.typescript.TypeScriptProject | Generated typescript project. | --- ##### `java`^Optional ```typescript public readonly java: JavaProject; ``` - *Type:* projen.java.JavaProject Generated java project. --- ##### `python`^Optional ```typescript public readonly python: PythonProject; ``` - *Type:* projen.python.PythonProject Generated python project. --- ##### `typescript`^Optional ```typescript public readonly typescript: TypeScriptProject; ``` - *Type:* projen.typescript.TypeScriptProject Generated typescript project. --- ### GeneratedDocumentationOptions Options for generated documentation projects. #### Initializer ```typescript import { GeneratedDocumentationOptions } from '@aws-prototyping-sdk/type-safe-api' const generatedDocumentationOptions: GeneratedDocumentationOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | html2 | GeneratedHtml2DocumentationOptions | Generated html2 documentation project options. | | htmlRedoc | GeneratedHtmlRedocDocumentationOptions | Generated html redoc documentation project options. | | markdown | GeneratedMarkdownDocumentationOptions | Generated markdown documentation project options. | | plantuml | GeneratedPlantumlDocumentationOptions | Generated plantuml documentation project options. | --- ##### `html2`^Optional ```typescript public readonly html2: GeneratedHtml2DocumentationOptions; ``` - *Type:* GeneratedHtml2DocumentationOptions Generated html2 documentation project options. --- ##### `htmlRedoc`^Optional ```typescript public readonly htmlRedoc: GeneratedHtmlRedocDocumentationOptions; ``` - *Type:* GeneratedHtmlRedocDocumentationOptions Generated html redoc documentation project options. --- ##### `markdown`^Optional ```typescript public readonly markdown: GeneratedMarkdownDocumentationOptions; ``` - *Type:* GeneratedMarkdownDocumentationOptions Generated markdown documentation project options. --- ##### `plantuml`^Optional ```typescript public readonly plantuml: GeneratedPlantumlDocumentationOptions; ``` - *Type:* GeneratedPlantumlDocumentationOptions Generated plantuml documentation project options. --- ### GeneratedDocumentationProjects Generated documentation project references. #### Initializer ```typescript import { GeneratedDocumentationProjects } from '@aws-prototyping-sdk/type-safe-api' const generatedDocumentationProjects: GeneratedDocumentationProjects = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | html2 | projen.Project | Generated html2 documentation project. | | htmlRedoc | projen.Project | Generated html redoc documentation project. | | markdown | projen.Project | Generated markdown documentation project. | | plantuml | projen.Project | Generated plantuml documentation project. | --- ##### `html2`^Optional ```typescript public readonly html2: Project; ``` - *Type:* projen.Project Generated html2 documentation project. --- ##### `htmlRedoc`^Optional ```typescript public readonly htmlRedoc: Project; ``` - *Type:* projen.Project Generated html redoc documentation project. --- ##### `markdown`^Optional ```typescript public readonly markdown: Project; ``` - *Type:* projen.Project Generated markdown documentation project. --- ##### `plantuml`^Optional ```typescript public readonly plantuml: Project; ``` - *Type:* projen.Project Generated plantuml documentation project. --- ### GeneratedHandlersCodeOptions Options for lambda handler projects for implementing API operations. #### Initializer ```typescript import { GeneratedHandlersCodeOptions } from '@aws-prototyping-sdk/type-safe-api' const generatedHandlersCodeOptions: GeneratedHandlersCodeOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | java | GeneratedJavaHandlersOptions | Options for the java handlers project. | | python | GeneratedPythonHandlersOptions | Options for the python handlers project. | | typescript | GeneratedTypeScriptHandlersOptions | Options for the typescript handlers project. | --- ##### `java`^Optional ```typescript public readonly java: GeneratedJavaHandlersOptions; ``` - *Type:* GeneratedJavaHandlersOptions Options for the java handlers project. These override the default inferred options. --- ##### `python`^Optional ```typescript public readonly python: GeneratedPythonHandlersOptions; ``` - *Type:* GeneratedPythonHandlersOptions Options for the python handlers project. These override the default inferred options. --- ##### `typescript`^Optional ```typescript public readonly typescript: GeneratedTypeScriptHandlersOptions; ``` - *Type:* GeneratedTypeScriptHandlersOptions Options for the typescript handlers project. These override the default inferred options. --- ### GeneratedHtml2DocumentationOptions Options for the html2 documentation project. #### Initializer ```typescript import { GeneratedHtml2DocumentationOptions } from '@aws-prototyping-sdk/type-safe-api' const generatedHtml2DocumentationOptions: GeneratedHtml2DocumentationOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | openApiGeneratorCliConfig | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. | --- ##### `openApiGeneratorCliConfig`^Optional ```typescript public readonly openApiGeneratorCliConfig: OpenApiGeneratorCliConfig; ``` - *Type:* OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. Overrides default values if specified. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) --- ### GeneratedHtmlRedocDocumentationOptions Options for the html redoc documentation project. #### Initializer ```typescript import { GeneratedHtmlRedocDocumentationOptions } from '@aws-prototyping-sdk/type-safe-api' const generatedHtmlRedocDocumentationOptions: GeneratedHtmlRedocDocumentationOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | openApiGeneratorCliConfig | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. | --- ##### `openApiGeneratorCliConfig`^Optional ```typescript public readonly openApiGeneratorCliConfig: OpenApiGeneratorCliConfig; ``` - *Type:* OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. Overrides default values if specified. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) --- ### GeneratedInfrastructureCodeOptions Options for generated infrastructure. #### Initializer ```typescript import { GeneratedInfrastructureCodeOptions } from '@aws-prototyping-sdk/type-safe-api' const generatedInfrastructureCodeOptions: GeneratedInfrastructureCodeOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | java | GeneratedJavaInfrastructureOptions | Options for the generated java infrastructure project. | | python | GeneratedPythonInfrastructureOptions | Options for the generated python infrastructure project. | | typescript | GeneratedTypeScriptInfrastructureOptions | Options for the generated typescript infrastructure project. | --- ##### `java`^Optional ```typescript public readonly java: GeneratedJavaInfrastructureOptions; ``` - *Type:* GeneratedJavaInfrastructureOptions Options for the generated java infrastructure project. These override the default inferred options. --- ##### `python`^Optional ```typescript public readonly python: GeneratedPythonInfrastructureOptions; ``` - *Type:* GeneratedPythonInfrastructureOptions Options for the generated python infrastructure project. These override the default inferred options. --- ##### `typescript`^Optional ```typescript public readonly typescript: GeneratedTypeScriptInfrastructureOptions; ``` - *Type:* GeneratedTypeScriptInfrastructureOptions Options for the generated typescript infrastructure project. These override the default inferred options. --- ### GeneratedJavaHandlersOptions Options for configuring a generated java handlers project. #### Initializer ```typescript import { GeneratedJavaHandlersOptions } from '@aws-prototyping-sdk/type-safe-api' const generatedJavaHandlersOptions: GeneratedJavaHandlersOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | This is the name of your project. | | commitGenerated | boolean | Whether to commit the managed files by default. | | gitIgnoreOptions | projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | projen.GitOptions | Configuration options for git. | | logging | projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | string | The root directory of the project. | | parent | projen.Project | The parent project, if this project is part of a bigger project. | | projenCommand | string | The shell command to use in order to run the projen CLI. | | projenrcJson | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrcJsonOptions | projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | projen.RenovatebotOptions | Options for renovatebot. | | autoApproveOptions | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoMerge | boolean | Enable automatic merging on GitHub. | | autoMergeOptions | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | boolean | Add a `clobber` task which resets the repo to origin. | | devContainer | boolean | Add a VSCode development environment (used for GitHub Codespaces). | | github | boolean | Enable GitHub integration. | | githubOptions | projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | boolean | Add a Gitpod development environment. | | mergify | boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | projen.github.MergifyOptions | Options for mergify. | | projectType | projen.ProjectType | Which type of project this is (library/app). | | projenCredentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projenTokenSecret | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | projen.SampleReadmeProps | The README setup. | | stale | boolean | Auto-close of stale issues and pull request. | | staleOptions | projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | boolean | Enable VSCode integration. | | artifactId | string | The artifactId is generally the name that the project is known by. | | groupId | string | This is generally unique amongst an organization or a project. | | version | string | This is the last piece of the naming puzzle. | | description | string | Description of a project is always good. | | packaging | string | Project packaging format. | | url | string | The URL, like the name, is not required. | | compileOptions | projen.java.MavenCompileOptions | Compile options. | | deps | string[] | List of runtime dependencies for this project. | | distdir | string | Final artifact output directory. | | junit | boolean | Include junit tests. | | junitOptions | projen.java.JunitOptions | junit options. | | packagingOptions | projen.java.MavenPackagingOptions | Packaging options. | | projenrcJava | boolean | Use projenrc in java. | | projenrcJavaOptions | projen.java.ProjenrcOptions | Options related to projenrc in java. | | testDeps | string[] | List of test dependencies for this project. | | sample | boolean | Include sample code and test if the relevant directories don't exist. | | sampleJavaPackage | string | The java package to use for the code sample. | | openApiGeneratorCliConfig | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional ```typescript public readonly gitIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```typescript public readonly gitOptions: GitOptions; ``` - *Type:* projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```typescript public readonly logging: LoggerOptions; ``` - *Type:* projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```typescript public readonly outdir: string; ``` - *Type:* string - *Default:* "." The root directory of the project. Relative to this directory, all files are synthesized. If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects. --- ##### `parent`^Optional ```typescript public readonly parent: Project; ``` - *Type:* projen.Project The parent project, if this project is part of a bigger project. --- ##### `projenCommand`^Optional ```typescript public readonly projenCommand: string; ``` - *Type:* string - *Default:* "npx projen" The shell command to use in order to run the projen CLI. Can be used to customize in special environments. --- ##### `projenrcJson`^Optional ```typescript public readonly projenrcJson: boolean; ``` - *Type:* boolean - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrcJsonOptions`^Optional ```typescript public readonly projenrcJsonOptions: ProjenrcJsonOptions; ``` - *Type:* projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```typescript public readonly renovatebot: boolean; ``` - *Type:* boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```typescript public readonly renovatebotOptions: RenovatebotOptions; ``` - *Type:* projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `autoApproveOptions`^Optional ```typescript public readonly autoApproveOptions: AutoApproveOptions; ``` - *Type:* projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoMerge`^Optional ```typescript public readonly autoMerge: boolean; ``` - *Type:* boolean - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `autoMergeOptions`^Optional ```typescript public readonly autoMergeOptions: AutoMergeOptions; ``` - *Type:* projen.github.AutoMergeOptions - *Default:* see defaults in `AutoMergeOptions` Configure options for automatic merging on GitHub. Has no effect if `github.mergify` or `autoMerge` is set to false. --- ##### `clobber`^Optional ```typescript public readonly clobber: boolean; ``` - *Type:* boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `devContainer`^Optional ```typescript public readonly devContainer: boolean; ``` - *Type:* boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional ```typescript public readonly github: boolean; ``` - *Type:* boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```typescript public readonly githubOptions: GitHubOptions; ``` - *Type:* projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: boolean; ``` - *Type:* boolean - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```typescript public readonly mergify: boolean; ``` - *Type:* boolean - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergifyOptions`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead ```typescript public readonly mergifyOptions: MergifyOptions; ``` - *Type:* projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCredentials`^Optional ```typescript public readonly projenCredentials: GithubCredentials; ``` - *Type:* projen.github.GithubCredentials - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN Choose a method of providing GitHub API access for projen workflows. --- ##### ~~`projenTokenSecret`~~^Optional - *Deprecated:* use `projenCredentials` ```typescript public readonly projenTokenSecret: string; ``` - *Type:* string - *Default:* "PROJEN_GITHUB_TOKEN" The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This token needs to have the `repo`, `workflows` and `packages` scope. --- ##### `readme`^Optional ```typescript public readonly readme: SampleReadmeProps; ``` - *Type:* projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```typescript "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional ```typescript public readonly stale: boolean; ``` - *Type:* boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```typescript public readonly staleOptions: StaleOptions; ``` - *Type:* projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional ```typescript public readonly vscode: boolean; ``` - *Type:* boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `artifactId`^Required ```typescript public readonly artifactId: string; ``` - *Type:* string - *Default:* "my-app" The artifactId is generally the name that the project is known by. Although the groupId is important, people within the group will rarely mention the groupId in discussion (they are often all be the same ID, such as the MojoHaus project groupId: org.codehaus.mojo). It, along with the groupId, creates a key that separates this project from every other project in the world (at least, it should :) ). Along with the groupId, the artifactId fully defines the artifact's living quarters within the repository. In the case of the above project, my-project lives in $M2_REPO/org/codehaus/mojo/my-project. --- ##### `groupId`^Required ```typescript public readonly groupId: string; ``` - *Type:* string - *Default:* "org.acme" This is generally unique amongst an organization or a project. For example, all core Maven artifacts do (well, should) live under the groupId org.apache.maven. Group ID's do not necessarily use the dot notation, for example, the junit project. Note that the dot-notated groupId does not have to correspond to the package structure that the project contains. It is, however, a good practice to follow. When stored within a repository, the group acts much like the Java packaging structure does in an operating system. The dots are replaced by OS specific directory separators (such as '/' in Unix) which becomes a relative directory structure from the base repository. In the example given, the org.codehaus.mojo group lives within the directory $M2_REPO/org/codehaus/mojo. --- ##### `version`^Required ```typescript public readonly version: string; ``` - *Type:* string - *Default:* "0.1.0" This is the last piece of the naming puzzle. groupId:artifactId denotes a single project but they cannot delineate which incarnation of that project we are talking about. Do we want the junit:junit of 2018 (version 4.12), or of 2007 (version 3.8.2)? In short: code changes, those changes should be versioned, and this element keeps those versions in line. It is also used within an artifact's repository to separate versions from each other. my-project version 1.0 files live in the directory structure $M2_REPO/org/codehaus/mojo/my-project/1.0. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined Description of a project is always good. Although this should not replace formal documentation, a quick comment to any readers of the POM is always helpful. --- ##### `packaging`^Optional ```typescript public readonly packaging: string; ``` - *Type:* string - *Default:* "jar" Project packaging format. --- ##### `url`^Optional ```typescript public readonly url: string; ``` - *Type:* string - *Default:* undefined The URL, like the name, is not required. This is a nice gesture for projects users, however, so that they know where the project lives. --- ##### `compileOptions`^Optional ```typescript public readonly compileOptions: MavenCompileOptions; ``` - *Type:* projen.java.MavenCompileOptions - *Default:* defaults Compile options. --- ##### `deps`^Optional ```typescript public readonly deps: string[]; ``` - *Type:* string[] - *Default:* [] List of runtime dependencies for this project. Dependencies use the format: `/@` Additional dependencies can be added via `project.addDependency()`. --- ##### `distdir`^Optional ```typescript public readonly distdir: string; ``` - *Type:* string - *Default:* "dist/java" Final artifact output directory. --- ##### `junit`^Optional ```typescript public readonly junit: boolean; ``` - *Type:* boolean - *Default:* true Include junit tests. --- ##### `junitOptions`^Optional ```typescript public readonly junitOptions: JunitOptions; ``` - *Type:* projen.java.JunitOptions - *Default:* defaults junit options. --- ##### `packagingOptions`^Optional ```typescript public readonly packagingOptions: MavenPackagingOptions; ``` - *Type:* projen.java.MavenPackagingOptions - *Default:* defaults Packaging options. --- ##### `projenrcJava`^Optional ```typescript public readonly projenrcJava: boolean; ``` - *Type:* boolean - *Default:* true Use projenrc in java. This will install `projen` as a java dependency and will add a `synth` task which will compile & execute `main()` from `src/main/java/projenrc.java`. --- ##### `projenrcJavaOptions`^Optional ```typescript public readonly projenrcJavaOptions: ProjenrcOptions; ``` - *Type:* projen.java.ProjenrcOptions - *Default:* default options Options related to projenrc in java. --- ##### `testDeps`^Optional ```typescript public readonly testDeps: string[]; ``` - *Type:* string[] - *Default:* [] List of test dependencies for this project. Dependencies use the format: `/@` Additional dependencies can be added via `project.addTestDependency()`. --- ##### `sample`^Optional ```typescript public readonly sample: boolean; ``` - *Type:* boolean - *Default:* true Include sample code and test if the relevant directories don't exist. --- ##### `sampleJavaPackage`^Optional ```typescript public readonly sampleJavaPackage: string; ``` - *Type:* string - *Default:* "org.acme" The java package to use for the code sample. --- ##### `openApiGeneratorCliConfig`^Optional ```typescript public readonly openApiGeneratorCliConfig: OpenApiGeneratorCliConfig; ``` - *Type:* OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. Overrides default values if specified. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) --- ### GeneratedJavaInfrastructureOptions Options for configuring a generated java infrastructure project. #### Initializer ```typescript import { GeneratedJavaInfrastructureOptions } from '@aws-prototyping-sdk/type-safe-api' const generatedJavaInfrastructureOptions: GeneratedJavaInfrastructureOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | This is the name of your project. | | commitGenerated | boolean | Whether to commit the managed files by default. | | gitIgnoreOptions | projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | projen.GitOptions | Configuration options for git. | | logging | projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | string | The root directory of the project. | | parent | projen.Project | The parent project, if this project is part of a bigger project. | | projenCommand | string | The shell command to use in order to run the projen CLI. | | projenrcJson | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrcJsonOptions | projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | projen.RenovatebotOptions | Options for renovatebot. | | autoApproveOptions | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoMerge | boolean | Enable automatic merging on GitHub. | | autoMergeOptions | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | boolean | Add a `clobber` task which resets the repo to origin. | | devContainer | boolean | Add a VSCode development environment (used for GitHub Codespaces). | | github | boolean | Enable GitHub integration. | | githubOptions | projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | boolean | Add a Gitpod development environment. | | mergify | boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | projen.github.MergifyOptions | Options for mergify. | | projectType | projen.ProjectType | Which type of project this is (library/app). | | projenCredentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projenTokenSecret | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | projen.SampleReadmeProps | The README setup. | | stale | boolean | Auto-close of stale issues and pull request. | | staleOptions | projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | boolean | Enable VSCode integration. | | artifactId | string | The artifactId is generally the name that the project is known by. | | groupId | string | This is generally unique amongst an organization or a project. | | version | string | This is the last piece of the naming puzzle. | | description | string | Description of a project is always good. | | packaging | string | Project packaging format. | | url | string | The URL, like the name, is not required. | | compileOptions | projen.java.MavenCompileOptions | Compile options. | | deps | string[] | List of runtime dependencies for this project. | | distdir | string | Final artifact output directory. | | junit | boolean | Include junit tests. | | junitOptions | projen.java.JunitOptions | junit options. | | packagingOptions | projen.java.MavenPackagingOptions | Packaging options. | | projenrcJava | boolean | Use projenrc in java. | | projenrcJavaOptions | projen.java.ProjenrcOptions | Options related to projenrc in java. | | testDeps | string[] | List of test dependencies for this project. | | sample | boolean | Include sample code and test if the relevant directories don't exist. | | sampleJavaPackage | string | The java package to use for the code sample. | | openApiGeneratorCliConfig | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. | | mockDataOptions | MockResponseDataGenerationOptions | Options for the generated mock response data. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional ```typescript public readonly gitIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```typescript public readonly gitOptions: GitOptions; ``` - *Type:* projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```typescript public readonly logging: LoggerOptions; ``` - *Type:* projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```typescript public readonly outdir: string; ``` - *Type:* string - *Default:* "." The root directory of the project. Relative to this directory, all files are synthesized. If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects. --- ##### `parent`^Optional ```typescript public readonly parent: Project; ``` - *Type:* projen.Project The parent project, if this project is part of a bigger project. --- ##### `projenCommand`^Optional ```typescript public readonly projenCommand: string; ``` - *Type:* string - *Default:* "npx projen" The shell command to use in order to run the projen CLI. Can be used to customize in special environments. --- ##### `projenrcJson`^Optional ```typescript public readonly projenrcJson: boolean; ``` - *Type:* boolean - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrcJsonOptions`^Optional ```typescript public readonly projenrcJsonOptions: ProjenrcJsonOptions; ``` - *Type:* projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```typescript public readonly renovatebot: boolean; ``` - *Type:* boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```typescript public readonly renovatebotOptions: RenovatebotOptions; ``` - *Type:* projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `autoApproveOptions`^Optional ```typescript public readonly autoApproveOptions: AutoApproveOptions; ``` - *Type:* projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoMerge`^Optional ```typescript public readonly autoMerge: boolean; ``` - *Type:* boolean - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `autoMergeOptions`^Optional ```typescript public readonly autoMergeOptions: AutoMergeOptions; ``` - *Type:* projen.github.AutoMergeOptions - *Default:* see defaults in `AutoMergeOptions` Configure options for automatic merging on GitHub. Has no effect if `github.mergify` or `autoMerge` is set to false. --- ##### `clobber`^Optional ```typescript public readonly clobber: boolean; ``` - *Type:* boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `devContainer`^Optional ```typescript public readonly devContainer: boolean; ``` - *Type:* boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional ```typescript public readonly github: boolean; ``` - *Type:* boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```typescript public readonly githubOptions: GitHubOptions; ``` - *Type:* projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: boolean; ``` - *Type:* boolean - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```typescript public readonly mergify: boolean; ``` - *Type:* boolean - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergifyOptions`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead ```typescript public readonly mergifyOptions: MergifyOptions; ``` - *Type:* projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCredentials`^Optional ```typescript public readonly projenCredentials: GithubCredentials; ``` - *Type:* projen.github.GithubCredentials - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN Choose a method of providing GitHub API access for projen workflows. --- ##### ~~`projenTokenSecret`~~^Optional - *Deprecated:* use `projenCredentials` ```typescript public readonly projenTokenSecret: string; ``` - *Type:* string - *Default:* "PROJEN_GITHUB_TOKEN" The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This token needs to have the `repo`, `workflows` and `packages` scope. --- ##### `readme`^Optional ```typescript public readonly readme: SampleReadmeProps; ``` - *Type:* projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```typescript "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional ```typescript public readonly stale: boolean; ``` - *Type:* boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```typescript public readonly staleOptions: StaleOptions; ``` - *Type:* projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional ```typescript public readonly vscode: boolean; ``` - *Type:* boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `artifactId`^Required ```typescript public readonly artifactId: string; ``` - *Type:* string - *Default:* "my-app" The artifactId is generally the name that the project is known by. Although the groupId is important, people within the group will rarely mention the groupId in discussion (they are often all be the same ID, such as the MojoHaus project groupId: org.codehaus.mojo). It, along with the groupId, creates a key that separates this project from every other project in the world (at least, it should :) ). Along with the groupId, the artifactId fully defines the artifact's living quarters within the repository. In the case of the above project, my-project lives in $M2_REPO/org/codehaus/mojo/my-project. --- ##### `groupId`^Required ```typescript public readonly groupId: string; ``` - *Type:* string - *Default:* "org.acme" This is generally unique amongst an organization or a project. For example, all core Maven artifacts do (well, should) live under the groupId org.apache.maven. Group ID's do not necessarily use the dot notation, for example, the junit project. Note that the dot-notated groupId does not have to correspond to the package structure that the project contains. It is, however, a good practice to follow. When stored within a repository, the group acts much like the Java packaging structure does in an operating system. The dots are replaced by OS specific directory separators (such as '/' in Unix) which becomes a relative directory structure from the base repository. In the example given, the org.codehaus.mojo group lives within the directory $M2_REPO/org/codehaus/mojo. --- ##### `version`^Required ```typescript public readonly version: string; ``` - *Type:* string - *Default:* "0.1.0" This is the last piece of the naming puzzle. groupId:artifactId denotes a single project but they cannot delineate which incarnation of that project we are talking about. Do we want the junit:junit of 2018 (version 4.12), or of 2007 (version 3.8.2)? In short: code changes, those changes should be versioned, and this element keeps those versions in line. It is also used within an artifact's repository to separate versions from each other. my-project version 1.0 files live in the directory structure $M2_REPO/org/codehaus/mojo/my-project/1.0. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined Description of a project is always good. Although this should not replace formal documentation, a quick comment to any readers of the POM is always helpful. --- ##### `packaging`^Optional ```typescript public readonly packaging: string; ``` - *Type:* string - *Default:* "jar" Project packaging format. --- ##### `url`^Optional ```typescript public readonly url: string; ``` - *Type:* string - *Default:* undefined The URL, like the name, is not required. This is a nice gesture for projects users, however, so that they know where the project lives. --- ##### `compileOptions`^Optional ```typescript public readonly compileOptions: MavenCompileOptions; ``` - *Type:* projen.java.MavenCompileOptions - *Default:* defaults Compile options. --- ##### `deps`^Optional ```typescript public readonly deps: string[]; ``` - *Type:* string[] - *Default:* [] List of runtime dependencies for this project. Dependencies use the format: `/@` Additional dependencies can be added via `project.addDependency()`. --- ##### `distdir`^Optional ```typescript public readonly distdir: string; ``` - *Type:* string - *Default:* "dist/java" Final artifact output directory. --- ##### `junit`^Optional ```typescript public readonly junit: boolean; ``` - *Type:* boolean - *Default:* true Include junit tests. --- ##### `junitOptions`^Optional ```typescript public readonly junitOptions: JunitOptions; ``` - *Type:* projen.java.JunitOptions - *Default:* defaults junit options. --- ##### `packagingOptions`^Optional ```typescript public readonly packagingOptions: MavenPackagingOptions; ``` - *Type:* projen.java.MavenPackagingOptions - *Default:* defaults Packaging options. --- ##### `projenrcJava`^Optional ```typescript public readonly projenrcJava: boolean; ``` - *Type:* boolean - *Default:* true Use projenrc in java. This will install `projen` as a java dependency and will add a `synth` task which will compile & execute `main()` from `src/main/java/projenrc.java`. --- ##### `projenrcJavaOptions`^Optional ```typescript public readonly projenrcJavaOptions: ProjenrcOptions; ``` - *Type:* projen.java.ProjenrcOptions - *Default:* default options Options related to projenrc in java. --- ##### `testDeps`^Optional ```typescript public readonly testDeps: string[]; ``` - *Type:* string[] - *Default:* [] List of test dependencies for this project. Dependencies use the format: `/@` Additional dependencies can be added via `project.addTestDependency()`. --- ##### `sample`^Optional ```typescript public readonly sample: boolean; ``` - *Type:* boolean - *Default:* true Include sample code and test if the relevant directories don't exist. --- ##### `sampleJavaPackage`^Optional ```typescript public readonly sampleJavaPackage: string; ``` - *Type:* string - *Default:* "org.acme" The java package to use for the code sample. --- ##### `openApiGeneratorCliConfig`^Optional ```typescript public readonly openApiGeneratorCliConfig: OpenApiGeneratorCliConfig; ``` - *Type:* OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. Overrides default values if specified. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) --- ##### `mockDataOptions`^Optional ```typescript public readonly mockDataOptions: MockResponseDataGenerationOptions; ``` - *Type:* MockResponseDataGenerationOptions Options for the generated mock response data. --- ### GeneratedJavaRuntimeOptions Options for configuring a generated java runtime project. #### Initializer ```typescript import { GeneratedJavaRuntimeOptions } from '@aws-prototyping-sdk/type-safe-api' const generatedJavaRuntimeOptions: GeneratedJavaRuntimeOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | This is the name of your project. | | commitGenerated | boolean | Whether to commit the managed files by default. | | gitIgnoreOptions | projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | projen.GitOptions | Configuration options for git. | | logging | projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | string | The root directory of the project. | | parent | projen.Project | The parent project, if this project is part of a bigger project. | | projenCommand | string | The shell command to use in order to run the projen CLI. | | projenrcJson | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrcJsonOptions | projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | projen.RenovatebotOptions | Options for renovatebot. | | autoApproveOptions | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoMerge | boolean | Enable automatic merging on GitHub. | | autoMergeOptions | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | boolean | Add a `clobber` task which resets the repo to origin. | | devContainer | boolean | Add a VSCode development environment (used for GitHub Codespaces). | | github | boolean | Enable GitHub integration. | | githubOptions | projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | boolean | Add a Gitpod development environment. | | mergify | boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | projen.github.MergifyOptions | Options for mergify. | | projectType | projen.ProjectType | Which type of project this is (library/app). | | projenCredentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projenTokenSecret | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | projen.SampleReadmeProps | The README setup. | | stale | boolean | Auto-close of stale issues and pull request. | | staleOptions | projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | boolean | Enable VSCode integration. | | artifactId | string | The artifactId is generally the name that the project is known by. | | groupId | string | This is generally unique amongst an organization or a project. | | version | string | This is the last piece of the naming puzzle. | | description | string | Description of a project is always good. | | packaging | string | Project packaging format. | | url | string | The URL, like the name, is not required. | | compileOptions | projen.java.MavenCompileOptions | Compile options. | | deps | string[] | List of runtime dependencies for this project. | | distdir | string | Final artifact output directory. | | junit | boolean | Include junit tests. | | junitOptions | projen.java.JunitOptions | junit options. | | packagingOptions | projen.java.MavenPackagingOptions | Packaging options. | | projenrcJava | boolean | Use projenrc in java. | | projenrcJavaOptions | projen.java.ProjenrcOptions | Options related to projenrc in java. | | testDeps | string[] | List of test dependencies for this project. | | sample | boolean | Include sample code and test if the relevant directories don't exist. | | sampleJavaPackage | string | The java package to use for the code sample. | | openApiGeneratorCliConfig | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional ```typescript public readonly gitIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```typescript public readonly gitOptions: GitOptions; ``` - *Type:* projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```typescript public readonly logging: LoggerOptions; ``` - *Type:* projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```typescript public readonly outdir: string; ``` - *Type:* string - *Default:* "." The root directory of the project. Relative to this directory, all files are synthesized. If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects. --- ##### `parent`^Optional ```typescript public readonly parent: Project; ``` - *Type:* projen.Project The parent project, if this project is part of a bigger project. --- ##### `projenCommand`^Optional ```typescript public readonly projenCommand: string; ``` - *Type:* string - *Default:* "npx projen" The shell command to use in order to run the projen CLI. Can be used to customize in special environments. --- ##### `projenrcJson`^Optional ```typescript public readonly projenrcJson: boolean; ``` - *Type:* boolean - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrcJsonOptions`^Optional ```typescript public readonly projenrcJsonOptions: ProjenrcJsonOptions; ``` - *Type:* projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```typescript public readonly renovatebot: boolean; ``` - *Type:* boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```typescript public readonly renovatebotOptions: RenovatebotOptions; ``` - *Type:* projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `autoApproveOptions`^Optional ```typescript public readonly autoApproveOptions: AutoApproveOptions; ``` - *Type:* projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoMerge`^Optional ```typescript public readonly autoMerge: boolean; ``` - *Type:* boolean - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `autoMergeOptions`^Optional ```typescript public readonly autoMergeOptions: AutoMergeOptions; ``` - *Type:* projen.github.AutoMergeOptions - *Default:* see defaults in `AutoMergeOptions` Configure options for automatic merging on GitHub. Has no effect if `github.mergify` or `autoMerge` is set to false. --- ##### `clobber`^Optional ```typescript public readonly clobber: boolean; ``` - *Type:* boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `devContainer`^Optional ```typescript public readonly devContainer: boolean; ``` - *Type:* boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional ```typescript public readonly github: boolean; ``` - *Type:* boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```typescript public readonly githubOptions: GitHubOptions; ``` - *Type:* projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: boolean; ``` - *Type:* boolean - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```typescript public readonly mergify: boolean; ``` - *Type:* boolean - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergifyOptions`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead ```typescript public readonly mergifyOptions: MergifyOptions; ``` - *Type:* projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCredentials`^Optional ```typescript public readonly projenCredentials: GithubCredentials; ``` - *Type:* projen.github.GithubCredentials - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN Choose a method of providing GitHub API access for projen workflows. --- ##### ~~`projenTokenSecret`~~^Optional - *Deprecated:* use `projenCredentials` ```typescript public readonly projenTokenSecret: string; ``` - *Type:* string - *Default:* "PROJEN_GITHUB_TOKEN" The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This token needs to have the `repo`, `workflows` and `packages` scope. --- ##### `readme`^Optional ```typescript public readonly readme: SampleReadmeProps; ``` - *Type:* projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```typescript "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional ```typescript public readonly stale: boolean; ``` - *Type:* boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```typescript public readonly staleOptions: StaleOptions; ``` - *Type:* projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional ```typescript public readonly vscode: boolean; ``` - *Type:* boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `artifactId`^Required ```typescript public readonly artifactId: string; ``` - *Type:* string - *Default:* "my-app" The artifactId is generally the name that the project is known by. Although the groupId is important, people within the group will rarely mention the groupId in discussion (they are often all be the same ID, such as the MojoHaus project groupId: org.codehaus.mojo). It, along with the groupId, creates a key that separates this project from every other project in the world (at least, it should :) ). Along with the groupId, the artifactId fully defines the artifact's living quarters within the repository. In the case of the above project, my-project lives in $M2_REPO/org/codehaus/mojo/my-project. --- ##### `groupId`^Required ```typescript public readonly groupId: string; ``` - *Type:* string - *Default:* "org.acme" This is generally unique amongst an organization or a project. For example, all core Maven artifacts do (well, should) live under the groupId org.apache.maven. Group ID's do not necessarily use the dot notation, for example, the junit project. Note that the dot-notated groupId does not have to correspond to the package structure that the project contains. It is, however, a good practice to follow. When stored within a repository, the group acts much like the Java packaging structure does in an operating system. The dots are replaced by OS specific directory separators (such as '/' in Unix) which becomes a relative directory structure from the base repository. In the example given, the org.codehaus.mojo group lives within the directory $M2_REPO/org/codehaus/mojo. --- ##### `version`^Required ```typescript public readonly version: string; ``` - *Type:* string - *Default:* "0.1.0" This is the last piece of the naming puzzle. groupId:artifactId denotes a single project but they cannot delineate which incarnation of that project we are talking about. Do we want the junit:junit of 2018 (version 4.12), or of 2007 (version 3.8.2)? In short: code changes, those changes should be versioned, and this element keeps those versions in line. It is also used within an artifact's repository to separate versions from each other. my-project version 1.0 files live in the directory structure $M2_REPO/org/codehaus/mojo/my-project/1.0. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined Description of a project is always good. Although this should not replace formal documentation, a quick comment to any readers of the POM is always helpful. --- ##### `packaging`^Optional ```typescript public readonly packaging: string; ``` - *Type:* string - *Default:* "jar" Project packaging format. --- ##### `url`^Optional ```typescript public readonly url: string; ``` - *Type:* string - *Default:* undefined The URL, like the name, is not required. This is a nice gesture for projects users, however, so that they know where the project lives. --- ##### `compileOptions`^Optional ```typescript public readonly compileOptions: MavenCompileOptions; ``` - *Type:* projen.java.MavenCompileOptions - *Default:* defaults Compile options. --- ##### `deps`^Optional ```typescript public readonly deps: string[]; ``` - *Type:* string[] - *Default:* [] List of runtime dependencies for this project. Dependencies use the format: `/@` Additional dependencies can be added via `project.addDependency()`. --- ##### `distdir`^Optional ```typescript public readonly distdir: string; ``` - *Type:* string - *Default:* "dist/java" Final artifact output directory. --- ##### `junit`^Optional ```typescript public readonly junit: boolean; ``` - *Type:* boolean - *Default:* true Include junit tests. --- ##### `junitOptions`^Optional ```typescript public readonly junitOptions: JunitOptions; ``` - *Type:* projen.java.JunitOptions - *Default:* defaults junit options. --- ##### `packagingOptions`^Optional ```typescript public readonly packagingOptions: MavenPackagingOptions; ``` - *Type:* projen.java.MavenPackagingOptions - *Default:* defaults Packaging options. --- ##### `projenrcJava`^Optional ```typescript public readonly projenrcJava: boolean; ``` - *Type:* boolean - *Default:* true Use projenrc in java. This will install `projen` as a java dependency and will add a `synth` task which will compile & execute `main()` from `src/main/java/projenrc.java`. --- ##### `projenrcJavaOptions`^Optional ```typescript public readonly projenrcJavaOptions: ProjenrcOptions; ``` - *Type:* projen.java.ProjenrcOptions - *Default:* default options Options related to projenrc in java. --- ##### `testDeps`^Optional ```typescript public readonly testDeps: string[]; ``` - *Type:* string[] - *Default:* [] List of test dependencies for this project. Dependencies use the format: `/@` Additional dependencies can be added via `project.addTestDependency()`. --- ##### `sample`^Optional ```typescript public readonly sample: boolean; ``` - *Type:* boolean - *Default:* true Include sample code and test if the relevant directories don't exist. --- ##### `sampleJavaPackage`^Optional ```typescript public readonly sampleJavaPackage: string; ``` - *Type:* string - *Default:* "org.acme" The java package to use for the code sample. --- ##### `openApiGeneratorCliConfig`^Optional ```typescript public readonly openApiGeneratorCliConfig: OpenApiGeneratorCliConfig; ``` - *Type:* OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. Overrides default values if specified. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) --- ### GeneratedLibraryOptions Options for generated libraries. #### Initializer ```typescript import { GeneratedLibraryOptions } from '@aws-prototyping-sdk/type-safe-api' const generatedLibraryOptions: GeneratedLibraryOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | typescriptReactQueryHooks | GeneratedTypeScriptReactQueryHooksOptions | Options for the generated typescript react-query hooks library. | --- ##### `typescriptReactQueryHooks`^Optional ```typescript public readonly typescriptReactQueryHooks: GeneratedTypeScriptReactQueryHooksOptions; ``` - *Type:* GeneratedTypeScriptReactQueryHooksOptions Options for the generated typescript react-query hooks library. These override the default inferred options. --- ### GeneratedLibraryProjects Generated library projects. #### Initializer ```typescript import { GeneratedLibraryProjects } from '@aws-prototyping-sdk/type-safe-api' const generatedLibraryProjects: GeneratedLibraryProjects = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | typescriptReactQueryHooks | projen.typescript.TypeScriptProject | Generated typescript react-query hooks project. | --- ##### `typescriptReactQueryHooks`^Optional ```typescript public readonly typescriptReactQueryHooks: TypeScriptProject; ``` - *Type:* projen.typescript.TypeScriptProject Generated typescript react-query hooks project. --- ### GeneratedMarkdownDocumentationOptions Options for the markdown documentation project. #### Initializer ```typescript import { GeneratedMarkdownDocumentationOptions } from '@aws-prototyping-sdk/type-safe-api' const generatedMarkdownDocumentationOptions: GeneratedMarkdownDocumentationOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | openApiGeneratorCliConfig | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. | --- ##### `openApiGeneratorCliConfig`^Optional ```typescript public readonly openApiGeneratorCliConfig: OpenApiGeneratorCliConfig; ``` - *Type:* OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. Overrides default values if specified. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) --- ### GeneratedPlantumlDocumentationOptions Options for the plantuml documentation project. #### Initializer ```typescript import { GeneratedPlantumlDocumentationOptions } from '@aws-prototyping-sdk/type-safe-api' const generatedPlantumlDocumentationOptions: GeneratedPlantumlDocumentationOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | openApiGeneratorCliConfig | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. | --- ##### `openApiGeneratorCliConfig`^Optional ```typescript public readonly openApiGeneratorCliConfig: OpenApiGeneratorCliConfig; ``` - *Type:* OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. Overrides default values if specified. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) --- ### GeneratedPythonHandlersOptions Options for configuring a generated python handlers project. #### Initializer ```typescript import { GeneratedPythonHandlersOptions } from '@aws-prototyping-sdk/type-safe-api' const generatedPythonHandlersOptions: GeneratedPythonHandlersOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | This is the name of your project. | | commitGenerated | boolean | Whether to commit the managed files by default. | | gitIgnoreOptions | projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | projen.GitOptions | Configuration options for git. | | logging | projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | string | The root directory of the project. | | parent | projen.Project | The parent project, if this project is part of a bigger project. | | projenCommand | string | The shell command to use in order to run the projen CLI. | | projenrcJson | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrcJsonOptions | projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | projen.RenovatebotOptions | Options for renovatebot. | | autoApproveOptions | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoMerge | boolean | Enable automatic merging on GitHub. | | autoMergeOptions | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | boolean | Add a `clobber` task which resets the repo to origin. | | devContainer | boolean | Add a VSCode development environment (used for GitHub Codespaces). | | github | boolean | Enable GitHub integration. | | githubOptions | projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | boolean | Add a Gitpod development environment. | | mergify | boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | projen.github.MergifyOptions | Options for mergify. | | projectType | projen.ProjectType | Which type of project this is (library/app). | | projenCredentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projenTokenSecret | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | projen.SampleReadmeProps | The README setup. | | stale | boolean | Auto-close of stale issues and pull request. | | staleOptions | projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | boolean | Enable VSCode integration. | | authorEmail | string | Author's e-mail. | | authorName | string | Author's name. | | version | string | Version of the package. | | classifiers | string[] | A list of PyPI trove classifiers that describe the project. | | description | string | A short description of the package. | | homepage | string | A URL to the website of the project. | | license | string | License of this package as an SPDX identifier. | | packageName | string | Package name. | | poetryOptions | projen.python.PoetryPyprojectOptionsWithoutDeps | Additional options to set for poetry if using poetry. | | setupConfig | {[ key: string ]: any} | Additional fields to pass in the setup() function if using setuptools. | | moduleName | string | Name of the python package as used in imports and filenames. | | deps | string[] | List of runtime dependencies for this project. | | devDeps | string[] | List of dev dependencies for this project. | | pip | boolean | Use pip with a requirements.txt file to track project dependencies. | | poetry | boolean | Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing. | | projenrcJs | boolean | Use projenrc in javascript. | | projenrcJsOptions | projen.javascript.ProjenrcOptions | Options related to projenrc in JavaScript. | | projenrcPython | boolean | Use projenrc in Python. | | projenrcPythonOptions | projen.python.ProjenrcOptions | Options related to projenrc in python. | | projenrcTs | boolean | Use projenrc in TypeScript. | | projenrcTsOptions | projen.typescript.ProjenrcTsOptions | Options related to projenrc in TypeScript. | | pytest | boolean | Include pytest tests. | | pytestOptions | projen.python.PytestOptions | pytest options. | | pythonExec | string | Path to the python executable to use. | | sample | boolean | Include sample code and test if the relevant directories don't exist. | | setuptools | boolean | Use setuptools with a setup.py script for packaging and publishing. | | venv | boolean | Use venv to manage a virtual environment for installing dependencies inside. | | venvOptions | projen.python.VenvOptions | Venv options. | | openApiGeneratorCliConfig | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional ```typescript public readonly gitIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```typescript public readonly gitOptions: GitOptions; ``` - *Type:* projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```typescript public readonly logging: LoggerOptions; ``` - *Type:* projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```typescript public readonly outdir: string; ``` - *Type:* string - *Default:* "." The root directory of the project. Relative to this directory, all files are synthesized. If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects. --- ##### `parent`^Optional ```typescript public readonly parent: Project; ``` - *Type:* projen.Project The parent project, if this project is part of a bigger project. --- ##### `projenCommand`^Optional ```typescript public readonly projenCommand: string; ``` - *Type:* string - *Default:* "npx projen" The shell command to use in order to run the projen CLI. Can be used to customize in special environments. --- ##### `projenrcJson`^Optional ```typescript public readonly projenrcJson: boolean; ``` - *Type:* boolean - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrcJsonOptions`^Optional ```typescript public readonly projenrcJsonOptions: ProjenrcJsonOptions; ``` - *Type:* projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```typescript public readonly renovatebot: boolean; ``` - *Type:* boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```typescript public readonly renovatebotOptions: RenovatebotOptions; ``` - *Type:* projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `autoApproveOptions`^Optional ```typescript public readonly autoApproveOptions: AutoApproveOptions; ``` - *Type:* projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoMerge`^Optional ```typescript public readonly autoMerge: boolean; ``` - *Type:* boolean - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `autoMergeOptions`^Optional ```typescript public readonly autoMergeOptions: AutoMergeOptions; ``` - *Type:* projen.github.AutoMergeOptions - *Default:* see defaults in `AutoMergeOptions` Configure options for automatic merging on GitHub. Has no effect if `github.mergify` or `autoMerge` is set to false. --- ##### `clobber`^Optional ```typescript public readonly clobber: boolean; ``` - *Type:* boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `devContainer`^Optional ```typescript public readonly devContainer: boolean; ``` - *Type:* boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional ```typescript public readonly github: boolean; ``` - *Type:* boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```typescript public readonly githubOptions: GitHubOptions; ``` - *Type:* projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: boolean; ``` - *Type:* boolean - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```typescript public readonly mergify: boolean; ``` - *Type:* boolean - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergifyOptions`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead ```typescript public readonly mergifyOptions: MergifyOptions; ``` - *Type:* projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCredentials`^Optional ```typescript public readonly projenCredentials: GithubCredentials; ``` - *Type:* projen.github.GithubCredentials - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN Choose a method of providing GitHub API access for projen workflows. --- ##### ~~`projenTokenSecret`~~^Optional - *Deprecated:* use `projenCredentials` ```typescript public readonly projenTokenSecret: string; ``` - *Type:* string - *Default:* "PROJEN_GITHUB_TOKEN" The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This token needs to have the `repo`, `workflows` and `packages` scope. --- ##### `readme`^Optional ```typescript public readonly readme: SampleReadmeProps; ``` - *Type:* projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```typescript "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional ```typescript public readonly stale: boolean; ``` - *Type:* boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```typescript public readonly staleOptions: StaleOptions; ``` - *Type:* projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional ```typescript public readonly vscode: boolean; ``` - *Type:* boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `authorEmail`^Required ```typescript public readonly authorEmail: string; ``` - *Type:* string - *Default:* $GIT_USER_EMAIL Author's e-mail. --- ##### `authorName`^Required ```typescript public readonly authorName: string; ``` - *Type:* string - *Default:* $GIT_USER_NAME Author's name. --- ##### `version`^Required ```typescript public readonly version: string; ``` - *Type:* string - *Default:* "0.1.0" Version of the package. --- ##### `classifiers`^Optional ```typescript public readonly classifiers: string[]; ``` - *Type:* string[] A list of PyPI trove classifiers that describe the project. > [https://pypi.org/classifiers/](https://pypi.org/classifiers/) --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string A short description of the package. --- ##### `homepage`^Optional ```typescript public readonly homepage: string; ``` - *Type:* string A URL to the website of the project. --- ##### `license`^Optional ```typescript public readonly license: string; ``` - *Type:* string License of this package as an SPDX identifier. --- ##### `packageName`^Optional ```typescript public readonly packageName: string; ``` - *Type:* string Package name. --- ##### `poetryOptions`^Optional ```typescript public readonly poetryOptions: PoetryPyprojectOptionsWithoutDeps; ``` - *Type:* projen.python.PoetryPyprojectOptionsWithoutDeps Additional options to set for poetry if using poetry. --- ##### `setupConfig`^Optional ```typescript public readonly setupConfig: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} Additional fields to pass in the setup() function if using setuptools. --- ##### `moduleName`^Required ```typescript public readonly moduleName: string; ``` - *Type:* string - *Default:* $PYTHON_MODULE_NAME Name of the python package as used in imports and filenames. Must only consist of alphanumeric characters and underscores. --- ##### `deps`^Optional ```typescript public readonly deps: string[]; ``` - *Type:* string[] - *Default:* [] List of runtime dependencies for this project. Dependencies use the format: `@` Additional dependencies can be added via `project.addDependency()`. --- ##### `devDeps`^Optional ```typescript public readonly devDeps: string[]; ``` - *Type:* string[] - *Default:* [] List of dev dependencies for this project. Dependencies use the format: `@` Additional dependencies can be added via `project.addDevDependency()`. --- ##### `pip`^Optional ```typescript public readonly pip: boolean; ``` - *Type:* boolean - *Default:* true, unless poetry is true, then false Use pip with a requirements.txt file to track project dependencies. --- ##### `poetry`^Optional ```typescript public readonly poetry: boolean; ``` - *Type:* boolean - *Default:* false Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing. This feature is incompatible with pip, setuptools, or venv. If you set this option to `true`, then pip, setuptools, and venv must be set to `false`. --- ##### `projenrcJs`^Optional ```typescript public readonly projenrcJs: boolean; ``` - *Type:* boolean - *Default:* false Use projenrc in javascript. This will install `projen` as a JavaScript dependency and add a `synth` task which will run `.projenrc.js`. --- ##### `projenrcJsOptions`^Optional ```typescript public readonly projenrcJsOptions: ProjenrcOptions; ``` - *Type:* projen.javascript.ProjenrcOptions - *Default:* default options Options related to projenrc in JavaScript. --- ##### `projenrcPython`^Optional ```typescript public readonly projenrcPython: boolean; ``` - *Type:* boolean - *Default:* true Use projenrc in Python. This will install `projen` as a Python dependency and add a `synth` task which will run `.projenrc.py`. --- ##### `projenrcPythonOptions`^Optional ```typescript public readonly projenrcPythonOptions: ProjenrcOptions; ``` - *Type:* projen.python.ProjenrcOptions - *Default:* default options Options related to projenrc in python. --- ##### `projenrcTs`^Optional ```typescript public readonly projenrcTs: boolean; ``` - *Type:* boolean - *Default:* false Use projenrc in TypeScript. This will create a tsconfig file (default: `tsconfig.projen.json`) and use `ts-node` in the default task to parse the project source files. --- ##### `projenrcTsOptions`^Optional ```typescript public readonly projenrcTsOptions: ProjenrcTsOptions; ``` - *Type:* projen.typescript.ProjenrcTsOptions - *Default:* default options Options related to projenrc in TypeScript. --- ##### `pytest`^Optional ```typescript public readonly pytest: boolean; ``` - *Type:* boolean - *Default:* true Include pytest tests. --- ##### `pytestOptions`^Optional ```typescript public readonly pytestOptions: PytestOptions; ``` - *Type:* projen.python.PytestOptions - *Default:* defaults pytest options. --- ##### `pythonExec`^Optional ```typescript public readonly pythonExec: string; ``` - *Type:* string - *Default:* "python" Path to the python executable to use. --- ##### `sample`^Optional ```typescript public readonly sample: boolean; ``` - *Type:* boolean - *Default:* true Include sample code and test if the relevant directories don't exist. --- ##### `setuptools`^Optional ```typescript public readonly setuptools: boolean; ``` - *Type:* boolean - *Default:* true, unless poetry is true, then false Use setuptools with a setup.py script for packaging and publishing. --- ##### `venv`^Optional ```typescript public readonly venv: boolean; ``` - *Type:* boolean - *Default:* true, unless poetry is true, then false Use venv to manage a virtual environment for installing dependencies inside. --- ##### `venvOptions`^Optional ```typescript public readonly venvOptions: VenvOptions; ``` - *Type:* projen.python.VenvOptions - *Default:* defaults Venv options. --- ##### `openApiGeneratorCliConfig`^Optional ```typescript public readonly openApiGeneratorCliConfig: OpenApiGeneratorCliConfig; ``` - *Type:* OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. Overrides default values if specified. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) --- ### GeneratedPythonInfrastructureOptions Options for configuring a generated python infrastructure project. #### Initializer ```typescript import { GeneratedPythonInfrastructureOptions } from '@aws-prototyping-sdk/type-safe-api' const generatedPythonInfrastructureOptions: GeneratedPythonInfrastructureOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | This is the name of your project. | | commitGenerated | boolean | Whether to commit the managed files by default. | | gitIgnoreOptions | projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | projen.GitOptions | Configuration options for git. | | logging | projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | string | The root directory of the project. | | parent | projen.Project | The parent project, if this project is part of a bigger project. | | projenCommand | string | The shell command to use in order to run the projen CLI. | | projenrcJson | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrcJsonOptions | projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | projen.RenovatebotOptions | Options for renovatebot. | | autoApproveOptions | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoMerge | boolean | Enable automatic merging on GitHub. | | autoMergeOptions | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | boolean | Add a `clobber` task which resets the repo to origin. | | devContainer | boolean | Add a VSCode development environment (used for GitHub Codespaces). | | github | boolean | Enable GitHub integration. | | githubOptions | projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | boolean | Add a Gitpod development environment. | | mergify | boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | projen.github.MergifyOptions | Options for mergify. | | projectType | projen.ProjectType | Which type of project this is (library/app). | | projenCredentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projenTokenSecret | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | projen.SampleReadmeProps | The README setup. | | stale | boolean | Auto-close of stale issues and pull request. | | staleOptions | projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | boolean | Enable VSCode integration. | | authorEmail | string | Author's e-mail. | | authorName | string | Author's name. | | version | string | Version of the package. | | classifiers | string[] | A list of PyPI trove classifiers that describe the project. | | description | string | A short description of the package. | | homepage | string | A URL to the website of the project. | | license | string | License of this package as an SPDX identifier. | | packageName | string | Package name. | | poetryOptions | projen.python.PoetryPyprojectOptionsWithoutDeps | Additional options to set for poetry if using poetry. | | setupConfig | {[ key: string ]: any} | Additional fields to pass in the setup() function if using setuptools. | | moduleName | string | Name of the python package as used in imports and filenames. | | deps | string[] | List of runtime dependencies for this project. | | devDeps | string[] | List of dev dependencies for this project. | | pip | boolean | Use pip with a requirements.txt file to track project dependencies. | | poetry | boolean | Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing. | | projenrcJs | boolean | Use projenrc in javascript. | | projenrcJsOptions | projen.javascript.ProjenrcOptions | Options related to projenrc in JavaScript. | | projenrcPython | boolean | Use projenrc in Python. | | projenrcPythonOptions | projen.python.ProjenrcOptions | Options related to projenrc in python. | | projenrcTs | boolean | Use projenrc in TypeScript. | | projenrcTsOptions | projen.typescript.ProjenrcTsOptions | Options related to projenrc in TypeScript. | | pytest | boolean | Include pytest tests. | | pytestOptions | projen.python.PytestOptions | pytest options. | | pythonExec | string | Path to the python executable to use. | | sample | boolean | Include sample code and test if the relevant directories don't exist. | | setuptools | boolean | Use setuptools with a setup.py script for packaging and publishing. | | venv | boolean | Use venv to manage a virtual environment for installing dependencies inside. | | venvOptions | projen.python.VenvOptions | Venv options. | | openApiGeneratorCliConfig | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. | | mockDataOptions | MockResponseDataGenerationOptions | Options for the generated mock response data. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional ```typescript public readonly gitIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```typescript public readonly gitOptions: GitOptions; ``` - *Type:* projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```typescript public readonly logging: LoggerOptions; ``` - *Type:* projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```typescript public readonly outdir: string; ``` - *Type:* string - *Default:* "." The root directory of the project. Relative to this directory, all files are synthesized. If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects. --- ##### `parent`^Optional ```typescript public readonly parent: Project; ``` - *Type:* projen.Project The parent project, if this project is part of a bigger project. --- ##### `projenCommand`^Optional ```typescript public readonly projenCommand: string; ``` - *Type:* string - *Default:* "npx projen" The shell command to use in order to run the projen CLI. Can be used to customize in special environments. --- ##### `projenrcJson`^Optional ```typescript public readonly projenrcJson: boolean; ``` - *Type:* boolean - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrcJsonOptions`^Optional ```typescript public readonly projenrcJsonOptions: ProjenrcJsonOptions; ``` - *Type:* projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```typescript public readonly renovatebot: boolean; ``` - *Type:* boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```typescript public readonly renovatebotOptions: RenovatebotOptions; ``` - *Type:* projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `autoApproveOptions`^Optional ```typescript public readonly autoApproveOptions: AutoApproveOptions; ``` - *Type:* projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoMerge`^Optional ```typescript public readonly autoMerge: boolean; ``` - *Type:* boolean - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `autoMergeOptions`^Optional ```typescript public readonly autoMergeOptions: AutoMergeOptions; ``` - *Type:* projen.github.AutoMergeOptions - *Default:* see defaults in `AutoMergeOptions` Configure options for automatic merging on GitHub. Has no effect if `github.mergify` or `autoMerge` is set to false. --- ##### `clobber`^Optional ```typescript public readonly clobber: boolean; ``` - *Type:* boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `devContainer`^Optional ```typescript public readonly devContainer: boolean; ``` - *Type:* boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional ```typescript public readonly github: boolean; ``` - *Type:* boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```typescript public readonly githubOptions: GitHubOptions; ``` - *Type:* projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: boolean; ``` - *Type:* boolean - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```typescript public readonly mergify: boolean; ``` - *Type:* boolean - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergifyOptions`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead ```typescript public readonly mergifyOptions: MergifyOptions; ``` - *Type:* projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCredentials`^Optional ```typescript public readonly projenCredentials: GithubCredentials; ``` - *Type:* projen.github.GithubCredentials - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN Choose a method of providing GitHub API access for projen workflows. --- ##### ~~`projenTokenSecret`~~^Optional - *Deprecated:* use `projenCredentials` ```typescript public readonly projenTokenSecret: string; ``` - *Type:* string - *Default:* "PROJEN_GITHUB_TOKEN" The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This token needs to have the `repo`, `workflows` and `packages` scope. --- ##### `readme`^Optional ```typescript public readonly readme: SampleReadmeProps; ``` - *Type:* projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```typescript "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional ```typescript public readonly stale: boolean; ``` - *Type:* boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```typescript public readonly staleOptions: StaleOptions; ``` - *Type:* projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional ```typescript public readonly vscode: boolean; ``` - *Type:* boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `authorEmail`^Required ```typescript public readonly authorEmail: string; ``` - *Type:* string - *Default:* $GIT_USER_EMAIL Author's e-mail. --- ##### `authorName`^Required ```typescript public readonly authorName: string; ``` - *Type:* string - *Default:* $GIT_USER_NAME Author's name. --- ##### `version`^Required ```typescript public readonly version: string; ``` - *Type:* string - *Default:* "0.1.0" Version of the package. --- ##### `classifiers`^Optional ```typescript public readonly classifiers: string[]; ``` - *Type:* string[] A list of PyPI trove classifiers that describe the project. > [https://pypi.org/classifiers/](https://pypi.org/classifiers/) --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string A short description of the package. --- ##### `homepage`^Optional ```typescript public readonly homepage: string; ``` - *Type:* string A URL to the website of the project. --- ##### `license`^Optional ```typescript public readonly license: string; ``` - *Type:* string License of this package as an SPDX identifier. --- ##### `packageName`^Optional ```typescript public readonly packageName: string; ``` - *Type:* string Package name. --- ##### `poetryOptions`^Optional ```typescript public readonly poetryOptions: PoetryPyprojectOptionsWithoutDeps; ``` - *Type:* projen.python.PoetryPyprojectOptionsWithoutDeps Additional options to set for poetry if using poetry. --- ##### `setupConfig`^Optional ```typescript public readonly setupConfig: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} Additional fields to pass in the setup() function if using setuptools. --- ##### `moduleName`^Required ```typescript public readonly moduleName: string; ``` - *Type:* string - *Default:* $PYTHON_MODULE_NAME Name of the python package as used in imports and filenames. Must only consist of alphanumeric characters and underscores. --- ##### `deps`^Optional ```typescript public readonly deps: string[]; ``` - *Type:* string[] - *Default:* [] List of runtime dependencies for this project. Dependencies use the format: `@` Additional dependencies can be added via `project.addDependency()`. --- ##### `devDeps`^Optional ```typescript public readonly devDeps: string[]; ``` - *Type:* string[] - *Default:* [] List of dev dependencies for this project. Dependencies use the format: `@` Additional dependencies can be added via `project.addDevDependency()`. --- ##### `pip`^Optional ```typescript public readonly pip: boolean; ``` - *Type:* boolean - *Default:* true, unless poetry is true, then false Use pip with a requirements.txt file to track project dependencies. --- ##### `poetry`^Optional ```typescript public readonly poetry: boolean; ``` - *Type:* boolean - *Default:* false Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing. This feature is incompatible with pip, setuptools, or venv. If you set this option to `true`, then pip, setuptools, and venv must be set to `false`. --- ##### `projenrcJs`^Optional ```typescript public readonly projenrcJs: boolean; ``` - *Type:* boolean - *Default:* false Use projenrc in javascript. This will install `projen` as a JavaScript dependency and add a `synth` task which will run `.projenrc.js`. --- ##### `projenrcJsOptions`^Optional ```typescript public readonly projenrcJsOptions: ProjenrcOptions; ``` - *Type:* projen.javascript.ProjenrcOptions - *Default:* default options Options related to projenrc in JavaScript. --- ##### `projenrcPython`^Optional ```typescript public readonly projenrcPython: boolean; ``` - *Type:* boolean - *Default:* true Use projenrc in Python. This will install `projen` as a Python dependency and add a `synth` task which will run `.projenrc.py`. --- ##### `projenrcPythonOptions`^Optional ```typescript public readonly projenrcPythonOptions: ProjenrcOptions; ``` - *Type:* projen.python.ProjenrcOptions - *Default:* default options Options related to projenrc in python. --- ##### `projenrcTs`^Optional ```typescript public readonly projenrcTs: boolean; ``` - *Type:* boolean - *Default:* false Use projenrc in TypeScript. This will create a tsconfig file (default: `tsconfig.projen.json`) and use `ts-node` in the default task to parse the project source files. --- ##### `projenrcTsOptions`^Optional ```typescript public readonly projenrcTsOptions: ProjenrcTsOptions; ``` - *Type:* projen.typescript.ProjenrcTsOptions - *Default:* default options Options related to projenrc in TypeScript. --- ##### `pytest`^Optional ```typescript public readonly pytest: boolean; ``` - *Type:* boolean - *Default:* true Include pytest tests. --- ##### `pytestOptions`^Optional ```typescript public readonly pytestOptions: PytestOptions; ``` - *Type:* projen.python.PytestOptions - *Default:* defaults pytest options. --- ##### `pythonExec`^Optional ```typescript public readonly pythonExec: string; ``` - *Type:* string - *Default:* "python" Path to the python executable to use. --- ##### `sample`^Optional ```typescript public readonly sample: boolean; ``` - *Type:* boolean - *Default:* true Include sample code and test if the relevant directories don't exist. --- ##### `setuptools`^Optional ```typescript public readonly setuptools: boolean; ``` - *Type:* boolean - *Default:* true, unless poetry is true, then false Use setuptools with a setup.py script for packaging and publishing. --- ##### `venv`^Optional ```typescript public readonly venv: boolean; ``` - *Type:* boolean - *Default:* true, unless poetry is true, then false Use venv to manage a virtual environment for installing dependencies inside. --- ##### `venvOptions`^Optional ```typescript public readonly venvOptions: VenvOptions; ``` - *Type:* projen.python.VenvOptions - *Default:* defaults Venv options. --- ##### `openApiGeneratorCliConfig`^Optional ```typescript public readonly openApiGeneratorCliConfig: OpenApiGeneratorCliConfig; ``` - *Type:* OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. Overrides default values if specified. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) --- ##### `mockDataOptions`^Optional ```typescript public readonly mockDataOptions: MockResponseDataGenerationOptions; ``` - *Type:* MockResponseDataGenerationOptions Options for the generated mock response data. --- ### GeneratedPythonRuntimeOptions Options for configuring a generated python runtime project. #### Initializer ```typescript import { GeneratedPythonRuntimeOptions } from '@aws-prototyping-sdk/type-safe-api' const generatedPythonRuntimeOptions: GeneratedPythonRuntimeOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | This is the name of your project. | | commitGenerated | boolean | Whether to commit the managed files by default. | | gitIgnoreOptions | projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | projen.GitOptions | Configuration options for git. | | logging | projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | string | The root directory of the project. | | parent | projen.Project | The parent project, if this project is part of a bigger project. | | projenCommand | string | The shell command to use in order to run the projen CLI. | | projenrcJson | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrcJsonOptions | projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | projen.RenovatebotOptions | Options for renovatebot. | | autoApproveOptions | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoMerge | boolean | Enable automatic merging on GitHub. | | autoMergeOptions | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | boolean | Add a `clobber` task which resets the repo to origin. | | devContainer | boolean | Add a VSCode development environment (used for GitHub Codespaces). | | github | boolean | Enable GitHub integration. | | githubOptions | projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | boolean | Add a Gitpod development environment. | | mergify | boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | projen.github.MergifyOptions | Options for mergify. | | projectType | projen.ProjectType | Which type of project this is (library/app). | | projenCredentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projenTokenSecret | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | projen.SampleReadmeProps | The README setup. | | stale | boolean | Auto-close of stale issues and pull request. | | staleOptions | projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | boolean | Enable VSCode integration. | | authorEmail | string | Author's e-mail. | | authorName | string | Author's name. | | version | string | Version of the package. | | classifiers | string[] | A list of PyPI trove classifiers that describe the project. | | description | string | A short description of the package. | | homepage | string | A URL to the website of the project. | | license | string | License of this package as an SPDX identifier. | | packageName | string | Package name. | | poetryOptions | projen.python.PoetryPyprojectOptionsWithoutDeps | Additional options to set for poetry if using poetry. | | setupConfig | {[ key: string ]: any} | Additional fields to pass in the setup() function if using setuptools. | | moduleName | string | Name of the python package as used in imports and filenames. | | deps | string[] | List of runtime dependencies for this project. | | devDeps | string[] | List of dev dependencies for this project. | | pip | boolean | Use pip with a requirements.txt file to track project dependencies. | | poetry | boolean | Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing. | | projenrcJs | boolean | Use projenrc in javascript. | | projenrcJsOptions | projen.javascript.ProjenrcOptions | Options related to projenrc in JavaScript. | | projenrcPython | boolean | Use projenrc in Python. | | projenrcPythonOptions | projen.python.ProjenrcOptions | Options related to projenrc in python. | | projenrcTs | boolean | Use projenrc in TypeScript. | | projenrcTsOptions | projen.typescript.ProjenrcTsOptions | Options related to projenrc in TypeScript. | | pytest | boolean | Include pytest tests. | | pytestOptions | projen.python.PytestOptions | pytest options. | | pythonExec | string | Path to the python executable to use. | | sample | boolean | Include sample code and test if the relevant directories don't exist. | | setuptools | boolean | Use setuptools with a setup.py script for packaging and publishing. | | venv | boolean | Use venv to manage a virtual environment for installing dependencies inside. | | venvOptions | projen.python.VenvOptions | Venv options. | | openApiGeneratorCliConfig | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional ```typescript public readonly gitIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```typescript public readonly gitOptions: GitOptions; ``` - *Type:* projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```typescript public readonly logging: LoggerOptions; ``` - *Type:* projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```typescript public readonly outdir: string; ``` - *Type:* string - *Default:* "." The root directory of the project. Relative to this directory, all files are synthesized. If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects. --- ##### `parent`^Optional ```typescript public readonly parent: Project; ``` - *Type:* projen.Project The parent project, if this project is part of a bigger project. --- ##### `projenCommand`^Optional ```typescript public readonly projenCommand: string; ``` - *Type:* string - *Default:* "npx projen" The shell command to use in order to run the projen CLI. Can be used to customize in special environments. --- ##### `projenrcJson`^Optional ```typescript public readonly projenrcJson: boolean; ``` - *Type:* boolean - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrcJsonOptions`^Optional ```typescript public readonly projenrcJsonOptions: ProjenrcJsonOptions; ``` - *Type:* projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```typescript public readonly renovatebot: boolean; ``` - *Type:* boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```typescript public readonly renovatebotOptions: RenovatebotOptions; ``` - *Type:* projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `autoApproveOptions`^Optional ```typescript public readonly autoApproveOptions: AutoApproveOptions; ``` - *Type:* projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoMerge`^Optional ```typescript public readonly autoMerge: boolean; ``` - *Type:* boolean - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `autoMergeOptions`^Optional ```typescript public readonly autoMergeOptions: AutoMergeOptions; ``` - *Type:* projen.github.AutoMergeOptions - *Default:* see defaults in `AutoMergeOptions` Configure options for automatic merging on GitHub. Has no effect if `github.mergify` or `autoMerge` is set to false. --- ##### `clobber`^Optional ```typescript public readonly clobber: boolean; ``` - *Type:* boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `devContainer`^Optional ```typescript public readonly devContainer: boolean; ``` - *Type:* boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional ```typescript public readonly github: boolean; ``` - *Type:* boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```typescript public readonly githubOptions: GitHubOptions; ``` - *Type:* projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: boolean; ``` - *Type:* boolean - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```typescript public readonly mergify: boolean; ``` - *Type:* boolean - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergifyOptions`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead ```typescript public readonly mergifyOptions: MergifyOptions; ``` - *Type:* projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCredentials`^Optional ```typescript public readonly projenCredentials: GithubCredentials; ``` - *Type:* projen.github.GithubCredentials - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN Choose a method of providing GitHub API access for projen workflows. --- ##### ~~`projenTokenSecret`~~^Optional - *Deprecated:* use `projenCredentials` ```typescript public readonly projenTokenSecret: string; ``` - *Type:* string - *Default:* "PROJEN_GITHUB_TOKEN" The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This token needs to have the `repo`, `workflows` and `packages` scope. --- ##### `readme`^Optional ```typescript public readonly readme: SampleReadmeProps; ``` - *Type:* projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```typescript "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional ```typescript public readonly stale: boolean; ``` - *Type:* boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```typescript public readonly staleOptions: StaleOptions; ``` - *Type:* projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional ```typescript public readonly vscode: boolean; ``` - *Type:* boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `authorEmail`^Required ```typescript public readonly authorEmail: string; ``` - *Type:* string - *Default:* $GIT_USER_EMAIL Author's e-mail. --- ##### `authorName`^Required ```typescript public readonly authorName: string; ``` - *Type:* string - *Default:* $GIT_USER_NAME Author's name. --- ##### `version`^Required ```typescript public readonly version: string; ``` - *Type:* string - *Default:* "0.1.0" Version of the package. --- ##### `classifiers`^Optional ```typescript public readonly classifiers: string[]; ``` - *Type:* string[] A list of PyPI trove classifiers that describe the project. > [https://pypi.org/classifiers/](https://pypi.org/classifiers/) --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string A short description of the package. --- ##### `homepage`^Optional ```typescript public readonly homepage: string; ``` - *Type:* string A URL to the website of the project. --- ##### `license`^Optional ```typescript public readonly license: string; ``` - *Type:* string License of this package as an SPDX identifier. --- ##### `packageName`^Optional ```typescript public readonly packageName: string; ``` - *Type:* string Package name. --- ##### `poetryOptions`^Optional ```typescript public readonly poetryOptions: PoetryPyprojectOptionsWithoutDeps; ``` - *Type:* projen.python.PoetryPyprojectOptionsWithoutDeps Additional options to set for poetry if using poetry. --- ##### `setupConfig`^Optional ```typescript public readonly setupConfig: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} Additional fields to pass in the setup() function if using setuptools. --- ##### `moduleName`^Required ```typescript public readonly moduleName: string; ``` - *Type:* string - *Default:* $PYTHON_MODULE_NAME Name of the python package as used in imports and filenames. Must only consist of alphanumeric characters and underscores. --- ##### `deps`^Optional ```typescript public readonly deps: string[]; ``` - *Type:* string[] - *Default:* [] List of runtime dependencies for this project. Dependencies use the format: `@` Additional dependencies can be added via `project.addDependency()`. --- ##### `devDeps`^Optional ```typescript public readonly devDeps: string[]; ``` - *Type:* string[] - *Default:* [] List of dev dependencies for this project. Dependencies use the format: `@` Additional dependencies can be added via `project.addDevDependency()`. --- ##### `pip`^Optional ```typescript public readonly pip: boolean; ``` - *Type:* boolean - *Default:* true, unless poetry is true, then false Use pip with a requirements.txt file to track project dependencies. --- ##### `poetry`^Optional ```typescript public readonly poetry: boolean; ``` - *Type:* boolean - *Default:* false Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing. This feature is incompatible with pip, setuptools, or venv. If you set this option to `true`, then pip, setuptools, and venv must be set to `false`. --- ##### `projenrcJs`^Optional ```typescript public readonly projenrcJs: boolean; ``` - *Type:* boolean - *Default:* false Use projenrc in javascript. This will install `projen` as a JavaScript dependency and add a `synth` task which will run `.projenrc.js`. --- ##### `projenrcJsOptions`^Optional ```typescript public readonly projenrcJsOptions: ProjenrcOptions; ``` - *Type:* projen.javascript.ProjenrcOptions - *Default:* default options Options related to projenrc in JavaScript. --- ##### `projenrcPython`^Optional ```typescript public readonly projenrcPython: boolean; ``` - *Type:* boolean - *Default:* true Use projenrc in Python. This will install `projen` as a Python dependency and add a `synth` task which will run `.projenrc.py`. --- ##### `projenrcPythonOptions`^Optional ```typescript public readonly projenrcPythonOptions: ProjenrcOptions; ``` - *Type:* projen.python.ProjenrcOptions - *Default:* default options Options related to projenrc in python. --- ##### `projenrcTs`^Optional ```typescript public readonly projenrcTs: boolean; ``` - *Type:* boolean - *Default:* false Use projenrc in TypeScript. This will create a tsconfig file (default: `tsconfig.projen.json`) and use `ts-node` in the default task to parse the project source files. --- ##### `projenrcTsOptions`^Optional ```typescript public readonly projenrcTsOptions: ProjenrcTsOptions; ``` - *Type:* projen.typescript.ProjenrcTsOptions - *Default:* default options Options related to projenrc in TypeScript. --- ##### `pytest`^Optional ```typescript public readonly pytest: boolean; ``` - *Type:* boolean - *Default:* true Include pytest tests. --- ##### `pytestOptions`^Optional ```typescript public readonly pytestOptions: PytestOptions; ``` - *Type:* projen.python.PytestOptions - *Default:* defaults pytest options. --- ##### `pythonExec`^Optional ```typescript public readonly pythonExec: string; ``` - *Type:* string - *Default:* "python" Path to the python executable to use. --- ##### `sample`^Optional ```typescript public readonly sample: boolean; ``` - *Type:* boolean - *Default:* true Include sample code and test if the relevant directories don't exist. --- ##### `setuptools`^Optional ```typescript public readonly setuptools: boolean; ``` - *Type:* boolean - *Default:* true, unless poetry is true, then false Use setuptools with a setup.py script for packaging and publishing. --- ##### `venv`^Optional ```typescript public readonly venv: boolean; ``` - *Type:* boolean - *Default:* true, unless poetry is true, then false Use venv to manage a virtual environment for installing dependencies inside. --- ##### `venvOptions`^Optional ```typescript public readonly venvOptions: VenvOptions; ``` - *Type:* projen.python.VenvOptions - *Default:* defaults Venv options. --- ##### `openApiGeneratorCliConfig`^Optional ```typescript public readonly openApiGeneratorCliConfig: OpenApiGeneratorCliConfig; ``` - *Type:* OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. Overrides default values if specified. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) --- ### GeneratedRuntimeCodeOptions Options for generated runtimes. #### Initializer ```typescript import { GeneratedRuntimeCodeOptions } from '@aws-prototyping-sdk/type-safe-api' const generatedRuntimeCodeOptions: GeneratedRuntimeCodeOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | java | GeneratedJavaRuntimeOptions | Options for a generated java project. | | python | GeneratedPythonRuntimeOptions | Options for a generated python project. | | typescript | GeneratedTypeScriptRuntimeOptions | Options for a generated typescript project. | --- ##### `java`^Optional ```typescript public readonly java: GeneratedJavaRuntimeOptions; ``` - *Type:* GeneratedJavaRuntimeOptions Options for a generated java project. These override the default inferred options. --- ##### `python`^Optional ```typescript public readonly python: GeneratedPythonRuntimeOptions; ``` - *Type:* GeneratedPythonRuntimeOptions Options for a generated python project. These override the default inferred options. --- ##### `typescript`^Optional ```typescript public readonly typescript: GeneratedTypeScriptRuntimeOptions; ``` - *Type:* GeneratedTypeScriptRuntimeOptions Options for a generated typescript project. These override the default inferred options. --- ### GeneratedTypeScriptHandlersOptions Options for configuring a generated typescript handlers project. #### Initializer ```typescript import { GeneratedTypeScriptHandlersOptions } from '@aws-prototyping-sdk/type-safe-api' const generatedTypeScriptHandlersOptions: GeneratedTypeScriptHandlersOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | This is the name of your project. | | commitGenerated | boolean | Whether to commit the managed files by default. | | gitIgnoreOptions | projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | projen.GitOptions | Configuration options for git. | | logging | projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | string | The root directory of the project. | | parent | projen.Project | The parent project, if this project is part of a bigger project. | | projenCommand | string | The shell command to use in order to run the projen CLI. | | projenrcJson | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrcJsonOptions | projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | projen.RenovatebotOptions | Options for renovatebot. | | autoApproveOptions | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoMerge | boolean | Enable automatic merging on GitHub. | | autoMergeOptions | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | boolean | Add a `clobber` task which resets the repo to origin. | | devContainer | boolean | Add a VSCode development environment (used for GitHub Codespaces). | | github | boolean | Enable GitHub integration. | | githubOptions | projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | boolean | Add a Gitpod development environment. | | mergify | boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | projen.github.MergifyOptions | Options for mergify. | | projectType | projen.ProjectType | Which type of project this is (library/app). | | projenCredentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projenTokenSecret | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | projen.SampleReadmeProps | The README setup. | | stale | boolean | Auto-close of stale issues and pull request. | | staleOptions | projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | boolean | Enable VSCode integration. | | allowLibraryDependencies | boolean | Allow the project to include `peerDependencies` and `bundledDependencies`. | | authorEmail | string | Author's e-mail. | | authorName | string | Author's name. | | authorOrganization | boolean | Is the author an organization. | | authorUrl | string | Author's URL / Website. | | autoDetectBin | boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. | | bin | {[ key: string ]: string} | Binary programs vended with your module. | | bugsEmail | string | The email address to which issues should be reported. | | bugsUrl | string | The url to your project's issue tracker. | | bundledDeps | string[] | List of dependencies to bundle into this module. | | codeArtifactOptions | projen.javascript.CodeArtifactOptions | Options for npm packages using AWS CodeArtifact. | | deps | string[] | Runtime dependencies of this module. | | description | string | The description is just a string that helps people understand the purpose of the package. | | devDeps | string[] | Build dependencies for this module. | | entrypoint | string | Module entrypoint (`main` in `package.json`). | | homepage | string | Package's Homepage / Website. | | keywords | string[] | Keywords to include in `package.json`. | | license | string | License's SPDX identifier. | | licensed | boolean | Indicates if a license should be added. | | maxNodeVersion | string | Minimum node.js version to require via `engines` (inclusive). | | minNodeVersion | string | Minimum Node.js version to require via package.json `engines` (inclusive). | | npmAccess | projen.javascript.NpmAccess | Access level of the npm package. | | npmRegistry | string | The host name of the npm registry to publish to. | | npmRegistryUrl | string | The base URL of the npm package registry. | | npmTokenSecret | string | GitHub secret which contains the NPM token to use when publishing packages. | | packageManager | projen.javascript.NodePackageManager | The Node Package Manager used to execute scripts. | | packageName | string | The "name" in package.json. | | peerDependencyOptions | projen.javascript.PeerDependencyOptions | Options for `peerDeps`. | | peerDeps | string[] | Peer dependencies for this module. | | pnpmVersion | string | The version of PNPM to use if using PNPM as a package manager. | | repository | string | The repository is the location where the actual code for your package lives. | | repositoryDirectory | string | If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. | | scopedPackagesOptions | projen.javascript.ScopedPackagesOptions[] | Options for privately hosted scoped packages. | | scripts | {[ key: string ]: string} | npm scripts to include. | | stability | string | Package's Stability. | | jsiiReleaseVersion | string | Version requirement of `publib` which is used to publish modules to npm. | | majorVersion | number | Major version to release from the default branch. | | minMajorVersion | number | Minimal Major version to release. | | npmDistTag | string | The npmDistTag to use when publishing from the default branch. | | postBuildSteps | projen.github.workflows.JobStep[] | Steps to execute after build as part of the release workflow. | | prerelease | string | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). | | publishDryRun | boolean | Instead of actually publishing to package managers, just print the publishing command. | | publishTasks | boolean | Define publishing tasks that can be executed manually as well as workflows. | | releaseBranches | {[ key: string ]: projen.release.BranchOptions} | Defines additional release branches. | | releaseEveryCommit | boolean | Automatically release new versions every commit to one of branches in `releaseBranches`. | | releaseFailureIssue | boolean | Create a github issue on every failed publishing task. | | releaseFailureIssueLabel | string | The label to apply to issues indicating publish failures. | | releaseSchedule | string | CRON schedule to trigger new releases. | | releaseTagPrefix | string | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. | | releaseTrigger | projen.release.ReleaseTrigger | The release trigger to use. | | releaseWorkflowName | string | The name of the default release workflow. | | releaseWorkflowSetupSteps | projen.github.workflows.JobStep[] | A set of workflow steps to execute in order to setup the workflow container. | | versionrcOptions | {[ key: string ]: any} | Custom configuration used when creating changelog with standard-version package. | | workflowContainerImage | string | Container image to use for GitHub workflows. | | workflowRunsOn | string[] | Github Runner selection labels. | | defaultReleaseBranch | string | The name of the main release branch. | | artifactsDirectory | string | A directory which will contain build artifacts. | | autoApproveUpgrades | boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). | | buildWorkflow | boolean | Define a GitHub workflow for building PRs. | | buildWorkflowTriggers | projen.github.workflows.Triggers | Build workflow triggers. | | bundlerOptions | projen.javascript.BundlerOptions | Options for `Bundler`. | | codeCov | boolean | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. | | codeCovTokenSecret | string | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. | | copyrightOwner | string | License copyright owner. | | copyrightPeriod | string | The copyright years to put in the LICENSE file. | | dependabot | boolean | Use dependabot to handle dependency upgrades. | | dependabotOptions | projen.github.DependabotOptions | Options for dependabot. | | depsUpgrade | boolean | Use github workflows to handle dependency upgrades. | | depsUpgradeOptions | projen.javascript.UpgradeDependenciesOptions | Options for `UpgradeDependencies`. | | gitignore | string[] | Additional entries to .gitignore. | | jest | boolean | Setup jest unit tests. | | jestOptions | projen.javascript.JestOptions | Jest options. | | mutableBuild | boolean | Automatically update files modified during builds to pull-request branches. | | npmignore | string[] | Additional entries to .npmignore. | | npmignoreEnabled | boolean | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. | | npmIgnoreOptions | projen.IgnoreFileOptions | Configuration options for .npmignore file. | | package | boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). | | prettier | boolean | Setup prettier. | | prettierOptions | projen.javascript.PrettierOptions | Prettier options. | | projenDevDependency | boolean | Indicates of "projen" should be installed as a devDependency. | | projenrcJs | boolean | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. | | projenrcJsOptions | projen.javascript.ProjenrcOptions | Options for .projenrc.js. | | projenVersion | string | Version of projen to install. | | pullRequestTemplate | boolean | Include a GitHub pull request template. | | pullRequestTemplateContents | string[] | The contents of the pull request template. | | release | boolean | Add release management to this project. | | releaseToNpm | boolean | Automatically release to npm when new versions are introduced. | | releaseWorkflow | boolean | DEPRECATED: renamed to `release`. | | workflowBootstrapSteps | projen.github.workflows.JobStep[] | Workflow steps to use in order to bootstrap this repo. | | workflowGitIdentity | projen.github.GitIdentity | The git identity to use in workflows. | | workflowNodeVersion | string | The node version to use in GitHub workflows. | | workflowPackageCache | boolean | Enable Node.js package cache in GitHub workflows. | | disableTsconfig | boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). | | disableTsconfigDev | boolean | Do not generate a `tsconfig.dev.json` file. | | docgen | boolean | Docgen by Typedoc. | | docsDirectory | string | Docs directory. | | entrypointTypes | string | The .d.ts file that includes the type declarations for this module. | | eslint | boolean | Setup eslint. | | eslintOptions | projen.javascript.EslintOptions | Eslint options. | | libdir | string | Typescript artifacts output directory. | | projenrcTs | boolean | Use TypeScript for your projenrc file (`.projenrc.ts`). | | projenrcTsOptions | projen.typescript.ProjenrcOptions | Options for .projenrc.ts. | | sampleCode | boolean | Generate one-time sample in `src/` and `test/` if there are no files there. | | srcdir | string | Typescript sources directory. | | testdir | string | Jest tests directory. Tests files should be named `xxx.test.ts`. | | tsconfig | projen.javascript.TypescriptConfigOptions | Custom TSConfig. | | tsconfigDev | projen.javascript.TypescriptConfigOptions | Custom tsconfig options for the development tsconfig.json file (used for testing). | | tsconfigDevFile | string | The name of the development tsconfig.json file. | | typescriptVersion | string | TypeScript version to use. | | openApiGeneratorCliConfig | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. | | handlerEntryPoints | string[] | Globs for lambda handler entry points, used by esbuild. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional ```typescript public readonly gitIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```typescript public readonly gitOptions: GitOptions; ``` - *Type:* projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```typescript public readonly logging: LoggerOptions; ``` - *Type:* projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```typescript public readonly outdir: string; ``` - *Type:* string - *Default:* "." The root directory of the project. Relative to this directory, all files are synthesized. If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects. --- ##### `parent`^Optional ```typescript public readonly parent: Project; ``` - *Type:* projen.Project The parent project, if this project is part of a bigger project. --- ##### `projenCommand`^Optional ```typescript public readonly projenCommand: string; ``` - *Type:* string - *Default:* "npx projen" The shell command to use in order to run the projen CLI. Can be used to customize in special environments. --- ##### `projenrcJson`^Optional ```typescript public readonly projenrcJson: boolean; ``` - *Type:* boolean - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrcJsonOptions`^Optional ```typescript public readonly projenrcJsonOptions: ProjenrcJsonOptions; ``` - *Type:* projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```typescript public readonly renovatebot: boolean; ``` - *Type:* boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```typescript public readonly renovatebotOptions: RenovatebotOptions; ``` - *Type:* projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `autoApproveOptions`^Optional ```typescript public readonly autoApproveOptions: AutoApproveOptions; ``` - *Type:* projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoMerge`^Optional ```typescript public readonly autoMerge: boolean; ``` - *Type:* boolean - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `autoMergeOptions`^Optional ```typescript public readonly autoMergeOptions: AutoMergeOptions; ``` - *Type:* projen.github.AutoMergeOptions - *Default:* see defaults in `AutoMergeOptions` Configure options for automatic merging on GitHub. Has no effect if `github.mergify` or `autoMerge` is set to false. --- ##### `clobber`^Optional ```typescript public readonly clobber: boolean; ``` - *Type:* boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `devContainer`^Optional ```typescript public readonly devContainer: boolean; ``` - *Type:* boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional ```typescript public readonly github: boolean; ``` - *Type:* boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```typescript public readonly githubOptions: GitHubOptions; ``` - *Type:* projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: boolean; ``` - *Type:* boolean - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```typescript public readonly mergify: boolean; ``` - *Type:* boolean - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergifyOptions`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead ```typescript public readonly mergifyOptions: MergifyOptions; ``` - *Type:* projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCredentials`^Optional ```typescript public readonly projenCredentials: GithubCredentials; ``` - *Type:* projen.github.GithubCredentials - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN Choose a method of providing GitHub API access for projen workflows. --- ##### ~~`projenTokenSecret`~~^Optional - *Deprecated:* use `projenCredentials` ```typescript public readonly projenTokenSecret: string; ``` - *Type:* string - *Default:* "PROJEN_GITHUB_TOKEN" The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This token needs to have the `repo`, `workflows` and `packages` scope. --- ##### `readme`^Optional ```typescript public readonly readme: SampleReadmeProps; ``` - *Type:* projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```typescript "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional ```typescript public readonly stale: boolean; ``` - *Type:* boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```typescript public readonly staleOptions: StaleOptions; ``` - *Type:* projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional ```typescript public readonly vscode: boolean; ``` - *Type:* boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `allowLibraryDependencies`^Optional ```typescript public readonly allowLibraryDependencies: boolean; ``` - *Type:* boolean - *Default:* true Allow the project to include `peerDependencies` and `bundledDependencies`. This is normally only allowed for libraries. For apps, there's no meaning for specifying these. --- ##### `authorEmail`^Optional ```typescript public readonly authorEmail: string; ``` - *Type:* string Author's e-mail. --- ##### `authorName`^Optional ```typescript public readonly authorName: string; ``` - *Type:* string Author's name. --- ##### `authorOrganization`^Optional ```typescript public readonly authorOrganization: boolean; ``` - *Type:* boolean Is the author an organization. --- ##### `authorUrl`^Optional ```typescript public readonly authorUrl: string; ``` - *Type:* string Author's URL / Website. --- ##### `autoDetectBin`^Optional ```typescript public readonly autoDetectBin: boolean; ``` - *Type:* boolean - *Default:* true Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. --- ##### `bin`^Optional ```typescript public readonly bin: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Binary programs vended with your module. You can use this option to add/customize how binaries are represented in your `package.json`, but unless `autoDetectBin` is `false`, every executable file under `bin` will automatically be added to this section. --- ##### `bugsEmail`^Optional ```typescript public readonly bugsEmail: string; ``` - *Type:* string The email address to which issues should be reported. --- ##### `bugsUrl`^Optional ```typescript public readonly bugsUrl: string; ``` - *Type:* string The url to your project's issue tracker. --- ##### `bundledDeps`^Optional ```typescript public readonly bundledDeps: string[]; ``` - *Type:* string[] List of dependencies to bundle into this module. These modules will be added both to the `dependencies` section and `bundledDependencies` section of your `package.json`. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `yarn add` or `npm install` in the sense that it will add the module as a dependency to your `package.json` file with the latest version (`^`). You can specify semver requirements in the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and this will be what you `package.json` will eventually include. --- ##### `codeArtifactOptions`^Optional ```typescript public readonly codeArtifactOptions: CodeArtifactOptions; ``` - *Type:* projen.javascript.CodeArtifactOptions - *Default:* undefined Options for npm packages using AWS CodeArtifact. This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact --- ##### `deps`^Optional ```typescript public readonly deps: string[]; ``` - *Type:* string[] - *Default:* [] Runtime dependencies of this module. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `yarn add` or `npm install` in the sense that it will add the module as a dependency to your `package.json` file with the latest version (`^`). You can specify semver requirements in the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and this will be what you `package.json` will eventually include. --- *Example* ```typescript [ 'express', 'lodash', 'foo@^2' ] ``` ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string The description is just a string that helps people understand the purpose of the package. It can be used when searching for packages in a package manager as well. See https://classic.yarnpkg.com/en/docs/package-json/#toc-description --- ##### `devDeps`^Optional ```typescript public readonly devDeps: string[]; ``` - *Type:* string[] - *Default:* [] Build dependencies for this module. These dependencies will only be available in your build environment but will not be fetched when this module is consumed. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `yarn add` or `npm install` in the sense that it will add the module as a dependency to your `package.json` file with the latest version (`^`). You can specify semver requirements in the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and this will be what you `package.json` will eventually include. --- *Example* ```typescript [ 'typescript', '@types/express' ] ``` ##### `entrypoint`^Optional ```typescript public readonly entrypoint: string; ``` - *Type:* string - *Default:* "lib/index.js" Module entrypoint (`main` in `package.json`). Set to an empty string to not include `main` in your package.json --- ##### `homepage`^Optional ```typescript public readonly homepage: string; ``` - *Type:* string Package's Homepage / Website. --- ##### `keywords`^Optional ```typescript public readonly keywords: string[]; ``` - *Type:* string[] Keywords to include in `package.json`. --- ##### `license`^Optional ```typescript public readonly license: string; ``` - *Type:* string - *Default:* "Apache-2.0" License's SPDX identifier. See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses. Use the `licensed` option if you want to no license to be specified. --- ##### `licensed`^Optional ```typescript public readonly licensed: boolean; ``` - *Type:* boolean - *Default:* true Indicates if a license should be added. --- ##### `maxNodeVersion`^Optional ```typescript public readonly maxNodeVersion: string; ``` - *Type:* string - *Default:* no max Minimum node.js version to require via `engines` (inclusive). --- ##### `minNodeVersion`^Optional ```typescript public readonly minNodeVersion: string; ``` - *Type:* string - *Default:* no "engines" specified Minimum Node.js version to require via package.json `engines` (inclusive). --- ##### `npmAccess`^Optional ```typescript public readonly npmAccess: NpmAccess; ``` - *Type:* projen.javascript.NpmAccess - *Default:* for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`. Access level of the npm package. --- ##### ~~`npmRegistry`~~^Optional - *Deprecated:* use `npmRegistryUrl` instead ```typescript public readonly npmRegistry: string; ``` - *Type:* string The host name of the npm registry to publish to. Cannot be set together with `npmRegistryUrl`. --- ##### `npmRegistryUrl`^Optional ```typescript public readonly npmRegistryUrl: string; ``` - *Type:* string - *Default:* "https://registry.npmjs.org" The base URL of the npm package registry. Must be a URL (e.g. start with "https://" or "http://") --- ##### `npmTokenSecret`^Optional ```typescript public readonly npmTokenSecret: string; ``` - *Type:* string - *Default:* "NPM_TOKEN" GitHub secret which contains the NPM token to use when publishing packages. --- ##### `packageManager`^Optional ```typescript public readonly packageManager: NodePackageManager; ``` - *Type:* projen.javascript.NodePackageManager - *Default:* NodePackageManager.YARN The Node Package Manager used to execute scripts. --- ##### `packageName`^Optional ```typescript public readonly packageName: string; ``` - *Type:* string - *Default:* defaults to project name The "name" in package.json. --- ##### `peerDependencyOptions`^Optional ```typescript public readonly peerDependencyOptions: PeerDependencyOptions; ``` - *Type:* projen.javascript.PeerDependencyOptions Options for `peerDeps`. --- ##### `peerDeps`^Optional ```typescript public readonly peerDeps: string[]; ``` - *Type:* string[] - *Default:* [] Peer dependencies for this module. Dependencies listed here are required to be installed (and satisfied) by the _consumer_ of this library. Using peer dependencies allows you to ensure that only a single module of a certain library exists in the `node_modules` tree of your consumers. Note that prior to npm@7, peer dependencies are _not_ automatically installed, which means that adding peer dependencies to a library will be a breaking change for your customers. Unless `peerDependencyOptions.pinnedDevDependency` is disabled (it is enabled by default), projen will automatically add a dev dependency with a pinned version for each peer dependency. This will ensure that you build & test your module against the lowest peer version required. --- ##### `pnpmVersion`^Optional ```typescript public readonly pnpmVersion: string; ``` - *Type:* string - *Default:* "7" The version of PNPM to use if using PNPM as a package manager. --- ##### `repository`^Optional ```typescript public readonly repository: string; ``` - *Type:* string The repository is the location where the actual code for your package lives. See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository --- ##### `repositoryDirectory`^Optional ```typescript public readonly repositoryDirectory: string; ``` - *Type:* string If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. --- ##### `scopedPackagesOptions`^Optional ```typescript public readonly scopedPackagesOptions: ScopedPackagesOptions[]; ``` - *Type:* projen.javascript.ScopedPackagesOptions[] - *Default:* fetch all scoped packages from the public npm registry Options for privately hosted scoped packages. --- ##### ~~`scripts`~~^Optional - *Deprecated:* use `project.addTask()` or `package.setScript()` ```typescript public readonly scripts: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* {} npm scripts to include. If a script has the same name as a standard script, the standard script will be overwritten. Also adds the script as a task. --- ##### `stability`^Optional ```typescript public readonly stability: string; ``` - *Type:* string Package's Stability. --- ##### `jsiiReleaseVersion`^Optional ```typescript public readonly jsiiReleaseVersion: string; ``` - *Type:* string - *Default:* "latest" Version requirement of `publib` which is used to publish modules to npm. --- ##### `majorVersion`^Optional ```typescript public readonly majorVersion: number; ``` - *Type:* number - *Default:* Major version is not enforced. Major version to release from the default branch. If this is specified, we bump the latest version of this major version line. If not specified, we bump the global latest version. --- ##### `minMajorVersion`^Optional ```typescript public readonly minMajorVersion: number; ``` - *Type:* number - *Default:* No minimum version is being enforced Minimal Major version to release. This can be useful to set to 1, as breaking changes before the 1.x major release are not incrementing the major version number. Can not be set together with `majorVersion`. --- ##### `npmDistTag`^Optional ```typescript public readonly npmDistTag: string; ``` - *Type:* string - *Default:* "latest" The npmDistTag to use when publishing from the default branch. To set the npm dist-tag for release branches, set the `npmDistTag` property for each branch. --- ##### `postBuildSteps`^Optional ```typescript public readonly postBuildSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] - *Default:* [] Steps to execute after build as part of the release workflow. --- ##### `prerelease`^Optional ```typescript public readonly prerelease: string; ``` - *Type:* string - *Default:* normal semantic versions Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). --- ##### `publishDryRun`^Optional ```typescript public readonly publishDryRun: boolean; ``` - *Type:* boolean - *Default:* false Instead of actually publishing to package managers, just print the publishing command. --- ##### `publishTasks`^Optional ```typescript public readonly publishTasks: boolean; ``` - *Type:* boolean - *Default:* false Define publishing tasks that can be executed manually as well as workflows. Normally, publishing only happens within automated workflows. Enable this in order to create a publishing task for each publishing activity. --- ##### `releaseBranches`^Optional ```typescript public readonly releaseBranches: {[ key: string ]: BranchOptions}; ``` - *Type:* {[ key: string ]: projen.release.BranchOptions} - *Default:* no additional branches are used for release. you can use `addBranch()` to add additional branches. Defines additional release branches. A workflow will be created for each release branch which will publish releases from commits in this branch. Each release branch _must_ be assigned a major version number which is used to enforce that versions published from that branch always use that major version. If multiple branches are used, the `majorVersion` field must also be provided for the default branch. --- ##### ~~`releaseEveryCommit`~~^Optional - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead ```typescript public readonly releaseEveryCommit: boolean; ``` - *Type:* boolean - *Default:* true Automatically release new versions every commit to one of branches in `releaseBranches`. --- ##### `releaseFailureIssue`^Optional ```typescript public readonly releaseFailureIssue: boolean; ``` - *Type:* boolean - *Default:* false Create a github issue on every failed publishing task. --- ##### `releaseFailureIssueLabel`^Optional ```typescript public readonly releaseFailureIssueLabel: string; ``` - *Type:* string - *Default:* "failed-release" The label to apply to issues indicating publish failures. Only applies if `releaseFailureIssue` is true. --- ##### ~~`releaseSchedule`~~^Optional - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.scheduled()` instead ```typescript public readonly releaseSchedule: string; ``` - *Type:* string - *Default:* no scheduled releases CRON schedule to trigger new releases. --- ##### `releaseTagPrefix`^Optional ```typescript public readonly releaseTagPrefix: string; ``` - *Type:* string - *Default:* "v" Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. Note: this prefix is used to detect the latest tagged version when bumping, so if you change this on a project with an existing version history, you may need to manually tag your latest release with the new prefix. --- ##### `releaseTrigger`^Optional ```typescript public readonly releaseTrigger: ReleaseTrigger; ``` - *Type:* projen.release.ReleaseTrigger - *Default:* Continuous releases (`ReleaseTrigger.continuous()`) The release trigger to use. --- ##### `releaseWorkflowName`^Optional ```typescript public readonly releaseWorkflowName: string; ``` - *Type:* string - *Default:* "Release" The name of the default release workflow. --- ##### `releaseWorkflowSetupSteps`^Optional ```typescript public readonly releaseWorkflowSetupSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] A set of workflow steps to execute in order to setup the workflow container. --- ##### `versionrcOptions`^Optional ```typescript public readonly versionrcOptions: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* standard configuration applicable for GitHub repositories Custom configuration used when creating changelog with standard-version package. Given values either append to default configuration or overwrite values in it. --- ##### `workflowContainerImage`^Optional ```typescript public readonly workflowContainerImage: string; ``` - *Type:* string - *Default:* default image Container image to use for GitHub workflows. --- ##### `workflowRunsOn`^Optional ```typescript public readonly workflowRunsOn: string[]; ``` - *Type:* string[] - *Default:* ["ubuntu-latest"] Github Runner selection labels. --- ##### `defaultReleaseBranch`^Required ```typescript public readonly defaultReleaseBranch: string; ``` - *Type:* string - *Default:* "main" The name of the main release branch. --- ##### `artifactsDirectory`^Optional ```typescript public readonly artifactsDirectory: string; ``` - *Type:* string - *Default:* "dist" A directory which will contain build artifacts. --- ##### `autoApproveUpgrades`^Optional ```typescript public readonly autoApproveUpgrades: boolean; ``` - *Type:* boolean - *Default:* true Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). Throw if set to true but `autoApproveOptions` are not defined. --- ##### `buildWorkflow`^Optional ```typescript public readonly buildWorkflow: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject Define a GitHub workflow for building PRs. --- ##### `buildWorkflowTriggers`^Optional ```typescript public readonly buildWorkflowTriggers: Triggers; ``` - *Type:* projen.github.workflows.Triggers - *Default:* "{ pullRequest: {}, workflowDispatch: {} }" Build workflow triggers. --- ##### `bundlerOptions`^Optional ```typescript public readonly bundlerOptions: BundlerOptions; ``` - *Type:* projen.javascript.BundlerOptions Options for `Bundler`. --- ##### `codeCov`^Optional ```typescript public readonly codeCov: boolean; ``` - *Type:* boolean - *Default:* false Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. --- ##### `codeCovTokenSecret`^Optional ```typescript public readonly codeCovTokenSecret: string; ``` - *Type:* string - *Default:* if this option is not specified, only public repositories are supported Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. --- ##### `copyrightOwner`^Optional ```typescript public readonly copyrightOwner: string; ``` - *Type:* string - *Default:* defaults to the value of authorName or "" if `authorName` is undefined. License copyright owner. --- ##### `copyrightPeriod`^Optional ```typescript public readonly copyrightPeriod: string; ``` - *Type:* string - *Default:* current year The copyright years to put in the LICENSE file. --- ##### `dependabot`^Optional ```typescript public readonly dependabot: boolean; ``` - *Type:* boolean - *Default:* false Use dependabot to handle dependency upgrades. Cannot be used in conjunction with `depsUpgrade`. --- ##### `dependabotOptions`^Optional ```typescript public readonly dependabotOptions: DependabotOptions; ``` - *Type:* projen.github.DependabotOptions - *Default:* default options Options for dependabot. --- ##### `depsUpgrade`^Optional ```typescript public readonly depsUpgrade: boolean; ``` - *Type:* boolean - *Default:* true Use github workflows to handle dependency upgrades. Cannot be used in conjunction with `dependabot`. --- ##### `depsUpgradeOptions`^Optional ```typescript public readonly depsUpgradeOptions: UpgradeDependenciesOptions; ``` - *Type:* projen.javascript.UpgradeDependenciesOptions - *Default:* default options Options for `UpgradeDependencies`. --- ##### `gitignore`^Optional ```typescript public readonly gitignore: string[]; ``` - *Type:* string[] Additional entries to .gitignore. --- ##### `jest`^Optional ```typescript public readonly jest: boolean; ``` - *Type:* boolean - *Default:* true Setup jest unit tests. --- ##### `jestOptions`^Optional ```typescript public readonly jestOptions: JestOptions; ``` - *Type:* projen.javascript.JestOptions - *Default:* default options Jest options. --- ##### `mutableBuild`^Optional ```typescript public readonly mutableBuild: boolean; ``` - *Type:* boolean - *Default:* true Automatically update files modified during builds to pull-request branches. This means that any files synthesized by projen or e.g. test snapshots will always be up-to-date before a PR is merged. Implies that PR builds do not have anti-tamper checks. --- ##### ~~`npmignore`~~^Optional - *Deprecated:* - use `project.addPackageIgnore` ```typescript public readonly npmignore: string[]; ``` - *Type:* string[] Additional entries to .npmignore. --- ##### `npmignoreEnabled`^Optional ```typescript public readonly npmignoreEnabled: boolean; ``` - *Type:* boolean - *Default:* true Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. --- ##### `npmIgnoreOptions`^Optional ```typescript public readonly npmIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .npmignore file. --- ##### `package`^Optional ```typescript public readonly package: boolean; ``` - *Type:* boolean - *Default:* true Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). --- ##### `prettier`^Optional ```typescript public readonly prettier: boolean; ``` - *Type:* boolean - *Default:* false Setup prettier. --- ##### `prettierOptions`^Optional ```typescript public readonly prettierOptions: PrettierOptions; ``` - *Type:* projen.javascript.PrettierOptions - *Default:* default options Prettier options. --- ##### `projenDevDependency`^Optional ```typescript public readonly projenDevDependency: boolean; ``` - *Type:* boolean - *Default:* true Indicates of "projen" should be installed as a devDependency. --- ##### `projenrcJs`^Optional ```typescript public readonly projenrcJs: boolean; ``` - *Type:* boolean - *Default:* true if projenrcJson is false Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. --- ##### `projenrcJsOptions`^Optional ```typescript public readonly projenrcJsOptions: ProjenrcOptions; ``` - *Type:* projen.javascript.ProjenrcOptions - *Default:* default options Options for .projenrc.js. --- ##### `projenVersion`^Optional ```typescript public readonly projenVersion: string; ``` - *Type:* string - *Default:* Defaults to the latest version. Version of projen to install. --- ##### `pullRequestTemplate`^Optional ```typescript public readonly pullRequestTemplate: boolean; ``` - *Type:* boolean - *Default:* true Include a GitHub pull request template. --- ##### `pullRequestTemplateContents`^Optional ```typescript public readonly pullRequestTemplateContents: string[]; ``` - *Type:* string[] - *Default:* default content The contents of the pull request template. --- ##### `release`^Optional ```typescript public readonly release: boolean; ``` - *Type:* boolean - *Default:* true (false for subprojects) Add release management to this project. --- ##### `releaseToNpm`^Optional ```typescript public readonly releaseToNpm: boolean; ``` - *Type:* boolean - *Default:* false Automatically release to npm when new versions are introduced. --- ##### ~~`releaseWorkflow`~~^Optional - *Deprecated:* see `release`. ```typescript public readonly releaseWorkflow: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject DEPRECATED: renamed to `release`. --- ##### `workflowBootstrapSteps`^Optional ```typescript public readonly workflowBootstrapSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] - *Default:* "yarn install --frozen-lockfile && yarn projen" Workflow steps to use in order to bootstrap this repo. --- ##### `workflowGitIdentity`^Optional ```typescript public readonly workflowGitIdentity: GitIdentity; ``` - *Type:* projen.github.GitIdentity - *Default:* GitHub Actions The git identity to use in workflows. --- ##### `workflowNodeVersion`^Optional ```typescript public readonly workflowNodeVersion: string; ``` - *Type:* string - *Default:* same as `minNodeVersion` The node version to use in GitHub workflows. --- ##### `workflowPackageCache`^Optional ```typescript public readonly workflowPackageCache: boolean; ``` - *Type:* boolean - *Default:* false Enable Node.js package cache in GitHub workflows. --- ##### `disableTsconfig`^Optional ```typescript public readonly disableTsconfig: boolean; ``` - *Type:* boolean - *Default:* false Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). --- ##### `disableTsconfigDev`^Optional ```typescript public readonly disableTsconfigDev: boolean; ``` - *Type:* boolean - *Default:* false Do not generate a `tsconfig.dev.json` file. --- ##### `docgen`^Optional ```typescript public readonly docgen: boolean; ``` - *Type:* boolean - *Default:* false Docgen by Typedoc. --- ##### `docsDirectory`^Optional ```typescript public readonly docsDirectory: string; ``` - *Type:* string - *Default:* "docs" Docs directory. --- ##### `entrypointTypes`^Optional ```typescript public readonly entrypointTypes: string; ``` - *Type:* string - *Default:* .d.ts file derived from the project's entrypoint (usually lib/index.d.ts) The .d.ts file that includes the type declarations for this module. --- ##### `eslint`^Optional ```typescript public readonly eslint: boolean; ``` - *Type:* boolean - *Default:* true Setup eslint. --- ##### `eslintOptions`^Optional ```typescript public readonly eslintOptions: EslintOptions; ``` - *Type:* projen.javascript.EslintOptions - *Default:* opinionated default options Eslint options. --- ##### `libdir`^Optional ```typescript public readonly libdir: string; ``` - *Type:* string - *Default:* "lib" Typescript artifacts output directory. --- ##### `projenrcTs`^Optional ```typescript public readonly projenrcTs: boolean; ``` - *Type:* boolean - *Default:* false Use TypeScript for your projenrc file (`.projenrc.ts`). --- ##### `projenrcTsOptions`^Optional ```typescript public readonly projenrcTsOptions: ProjenrcOptions; ``` - *Type:* projen.typescript.ProjenrcOptions Options for .projenrc.ts. --- ##### `sampleCode`^Optional ```typescript public readonly sampleCode: boolean; ``` - *Type:* boolean - *Default:* true Generate one-time sample in `src/` and `test/` if there are no files there. --- ##### `srcdir`^Optional ```typescript public readonly srcdir: string; ``` - *Type:* string - *Default:* "src" Typescript sources directory. --- ##### `testdir`^Optional ```typescript public readonly testdir: string; ``` - *Type:* string - *Default:* "test" Jest tests directory. Tests files should be named `xxx.test.ts`. If this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`), then tests are going to be compiled into `lib/` and executed as javascript. If the test directory is outside of `src`, then we configure jest to compile the code in-memory. --- ##### `tsconfig`^Optional ```typescript public readonly tsconfig: TypescriptConfigOptions; ``` - *Type:* projen.javascript.TypescriptConfigOptions - *Default:* default options Custom TSConfig. --- ##### `tsconfigDev`^Optional ```typescript public readonly tsconfigDev: TypescriptConfigOptions; ``` - *Type:* projen.javascript.TypescriptConfigOptions - *Default:* use the production tsconfig options Custom tsconfig options for the development tsconfig.json file (used for testing). --- ##### `tsconfigDevFile`^Optional ```typescript public readonly tsconfigDevFile: string; ``` - *Type:* string - *Default:* "tsconfig.dev.json" The name of the development tsconfig.json file. --- ##### `typescriptVersion`^Optional ```typescript public readonly typescriptVersion: string; ``` - *Type:* string - *Default:* "latest" TypeScript version to use. NOTE: Typescript is not semantically versioned and should remain on the same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`). --- ##### `openApiGeneratorCliConfig`^Optional ```typescript public readonly openApiGeneratorCliConfig: OpenApiGeneratorCliConfig; ``` - *Type:* OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. Overrides default values if specified. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) --- ##### `handlerEntryPoints`^Optional ```typescript public readonly handlerEntryPoints: string[]; ``` - *Type:* string[] - *Default:* src/*.ts - all files directly under the src directory Globs for lambda handler entry points, used by esbuild. --- ### GeneratedTypeScriptInfrastructureOptions Options for configuring a generated typescript infrastructure project. #### Initializer ```typescript import { GeneratedTypeScriptInfrastructureOptions } from '@aws-prototyping-sdk/type-safe-api' const generatedTypeScriptInfrastructureOptions: GeneratedTypeScriptInfrastructureOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | This is the name of your project. | | commitGenerated | boolean | Whether to commit the managed files by default. | | gitIgnoreOptions | projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | projen.GitOptions | Configuration options for git. | | logging | projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | string | The root directory of the project. | | parent | projen.Project | The parent project, if this project is part of a bigger project. | | projenCommand | string | The shell command to use in order to run the projen CLI. | | projenrcJson | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrcJsonOptions | projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | projen.RenovatebotOptions | Options for renovatebot. | | autoApproveOptions | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoMerge | boolean | Enable automatic merging on GitHub. | | autoMergeOptions | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | boolean | Add a `clobber` task which resets the repo to origin. | | devContainer | boolean | Add a VSCode development environment (used for GitHub Codespaces). | | github | boolean | Enable GitHub integration. | | githubOptions | projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | boolean | Add a Gitpod development environment. | | mergify | boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | projen.github.MergifyOptions | Options for mergify. | | projectType | projen.ProjectType | Which type of project this is (library/app). | | projenCredentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projenTokenSecret | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | projen.SampleReadmeProps | The README setup. | | stale | boolean | Auto-close of stale issues and pull request. | | staleOptions | projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | boolean | Enable VSCode integration. | | allowLibraryDependencies | boolean | Allow the project to include `peerDependencies` and `bundledDependencies`. | | authorEmail | string | Author's e-mail. | | authorName | string | Author's name. | | authorOrganization | boolean | Is the author an organization. | | authorUrl | string | Author's URL / Website. | | autoDetectBin | boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. | | bin | {[ key: string ]: string} | Binary programs vended with your module. | | bugsEmail | string | The email address to which issues should be reported. | | bugsUrl | string | The url to your project's issue tracker. | | bundledDeps | string[] | List of dependencies to bundle into this module. | | codeArtifactOptions | projen.javascript.CodeArtifactOptions | Options for npm packages using AWS CodeArtifact. | | deps | string[] | Runtime dependencies of this module. | | description | string | The description is just a string that helps people understand the purpose of the package. | | devDeps | string[] | Build dependencies for this module. | | entrypoint | string | Module entrypoint (`main` in `package.json`). | | homepage | string | Package's Homepage / Website. | | keywords | string[] | Keywords to include in `package.json`. | | license | string | License's SPDX identifier. | | licensed | boolean | Indicates if a license should be added. | | maxNodeVersion | string | Minimum node.js version to require via `engines` (inclusive). | | minNodeVersion | string | Minimum Node.js version to require via package.json `engines` (inclusive). | | npmAccess | projen.javascript.NpmAccess | Access level of the npm package. | | npmRegistry | string | The host name of the npm registry to publish to. | | npmRegistryUrl | string | The base URL of the npm package registry. | | npmTokenSecret | string | GitHub secret which contains the NPM token to use when publishing packages. | | packageManager | projen.javascript.NodePackageManager | The Node Package Manager used to execute scripts. | | packageName | string | The "name" in package.json. | | peerDependencyOptions | projen.javascript.PeerDependencyOptions | Options for `peerDeps`. | | peerDeps | string[] | Peer dependencies for this module. | | pnpmVersion | string | The version of PNPM to use if using PNPM as a package manager. | | repository | string | The repository is the location where the actual code for your package lives. | | repositoryDirectory | string | If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. | | scopedPackagesOptions | projen.javascript.ScopedPackagesOptions[] | Options for privately hosted scoped packages. | | scripts | {[ key: string ]: string} | npm scripts to include. | | stability | string | Package's Stability. | | jsiiReleaseVersion | string | Version requirement of `publib` which is used to publish modules to npm. | | majorVersion | number | Major version to release from the default branch. | | minMajorVersion | number | Minimal Major version to release. | | npmDistTag | string | The npmDistTag to use when publishing from the default branch. | | postBuildSteps | projen.github.workflows.JobStep[] | Steps to execute after build as part of the release workflow. | | prerelease | string | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). | | publishDryRun | boolean | Instead of actually publishing to package managers, just print the publishing command. | | publishTasks | boolean | Define publishing tasks that can be executed manually as well as workflows. | | releaseBranches | {[ key: string ]: projen.release.BranchOptions} | Defines additional release branches. | | releaseEveryCommit | boolean | Automatically release new versions every commit to one of branches in `releaseBranches`. | | releaseFailureIssue | boolean | Create a github issue on every failed publishing task. | | releaseFailureIssueLabel | string | The label to apply to issues indicating publish failures. | | releaseSchedule | string | CRON schedule to trigger new releases. | | releaseTagPrefix | string | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. | | releaseTrigger | projen.release.ReleaseTrigger | The release trigger to use. | | releaseWorkflowName | string | The name of the default release workflow. | | releaseWorkflowSetupSteps | projen.github.workflows.JobStep[] | A set of workflow steps to execute in order to setup the workflow container. | | versionrcOptions | {[ key: string ]: any} | Custom configuration used when creating changelog with standard-version package. | | workflowContainerImage | string | Container image to use for GitHub workflows. | | workflowRunsOn | string[] | Github Runner selection labels. | | defaultReleaseBranch | string | The name of the main release branch. | | artifactsDirectory | string | A directory which will contain build artifacts. | | autoApproveUpgrades | boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). | | buildWorkflow | boolean | Define a GitHub workflow for building PRs. | | buildWorkflowTriggers | projen.github.workflows.Triggers | Build workflow triggers. | | bundlerOptions | projen.javascript.BundlerOptions | Options for `Bundler`. | | codeCov | boolean | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. | | codeCovTokenSecret | string | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. | | copyrightOwner | string | License copyright owner. | | copyrightPeriod | string | The copyright years to put in the LICENSE file. | | dependabot | boolean | Use dependabot to handle dependency upgrades. | | dependabotOptions | projen.github.DependabotOptions | Options for dependabot. | | depsUpgrade | boolean | Use github workflows to handle dependency upgrades. | | depsUpgradeOptions | projen.javascript.UpgradeDependenciesOptions | Options for `UpgradeDependencies`. | | gitignore | string[] | Additional entries to .gitignore. | | jest | boolean | Setup jest unit tests. | | jestOptions | projen.javascript.JestOptions | Jest options. | | mutableBuild | boolean | Automatically update files modified during builds to pull-request branches. | | npmignore | string[] | Additional entries to .npmignore. | | npmignoreEnabled | boolean | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. | | npmIgnoreOptions | projen.IgnoreFileOptions | Configuration options for .npmignore file. | | package | boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). | | prettier | boolean | Setup prettier. | | prettierOptions | projen.javascript.PrettierOptions | Prettier options. | | projenDevDependency | boolean | Indicates of "projen" should be installed as a devDependency. | | projenrcJs | boolean | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. | | projenrcJsOptions | projen.javascript.ProjenrcOptions | Options for .projenrc.js. | | projenVersion | string | Version of projen to install. | | pullRequestTemplate | boolean | Include a GitHub pull request template. | | pullRequestTemplateContents | string[] | The contents of the pull request template. | | release | boolean | Add release management to this project. | | releaseToNpm | boolean | Automatically release to npm when new versions are introduced. | | releaseWorkflow | boolean | DEPRECATED: renamed to `release`. | | workflowBootstrapSteps | projen.github.workflows.JobStep[] | Workflow steps to use in order to bootstrap this repo. | | workflowGitIdentity | projen.github.GitIdentity | The git identity to use in workflows. | | workflowNodeVersion | string | The node version to use in GitHub workflows. | | workflowPackageCache | boolean | Enable Node.js package cache in GitHub workflows. | | disableTsconfig | boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). | | disableTsconfigDev | boolean | Do not generate a `tsconfig.dev.json` file. | | docgen | boolean | Docgen by Typedoc. | | docsDirectory | string | Docs directory. | | entrypointTypes | string | The .d.ts file that includes the type declarations for this module. | | eslint | boolean | Setup eslint. | | eslintOptions | projen.javascript.EslintOptions | Eslint options. | | libdir | string | Typescript artifacts output directory. | | projenrcTs | boolean | Use TypeScript for your projenrc file (`.projenrc.ts`). | | projenrcTsOptions | projen.typescript.ProjenrcOptions | Options for .projenrc.ts. | | sampleCode | boolean | Generate one-time sample in `src/` and `test/` if there are no files there. | | srcdir | string | Typescript sources directory. | | testdir | string | Jest tests directory. Tests files should be named `xxx.test.ts`. | | tsconfig | projen.javascript.TypescriptConfigOptions | Custom TSConfig. | | tsconfigDev | projen.javascript.TypescriptConfigOptions | Custom tsconfig options for the development tsconfig.json file (used for testing). | | tsconfigDevFile | string | The name of the development tsconfig.json file. | | typescriptVersion | string | TypeScript version to use. | | openApiGeneratorCliConfig | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. | | mockDataOptions | MockResponseDataGenerationOptions | Options for the generated mock response data. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional ```typescript public readonly gitIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```typescript public readonly gitOptions: GitOptions; ``` - *Type:* projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```typescript public readonly logging: LoggerOptions; ``` - *Type:* projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```typescript public readonly outdir: string; ``` - *Type:* string - *Default:* "." The root directory of the project. Relative to this directory, all files are synthesized. If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects. --- ##### `parent`^Optional ```typescript public readonly parent: Project; ``` - *Type:* projen.Project The parent project, if this project is part of a bigger project. --- ##### `projenCommand`^Optional ```typescript public readonly projenCommand: string; ``` - *Type:* string - *Default:* "npx projen" The shell command to use in order to run the projen CLI. Can be used to customize in special environments. --- ##### `projenrcJson`^Optional ```typescript public readonly projenrcJson: boolean; ``` - *Type:* boolean - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrcJsonOptions`^Optional ```typescript public readonly projenrcJsonOptions: ProjenrcJsonOptions; ``` - *Type:* projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```typescript public readonly renovatebot: boolean; ``` - *Type:* boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```typescript public readonly renovatebotOptions: RenovatebotOptions; ``` - *Type:* projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `autoApproveOptions`^Optional ```typescript public readonly autoApproveOptions: AutoApproveOptions; ``` - *Type:* projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoMerge`^Optional ```typescript public readonly autoMerge: boolean; ``` - *Type:* boolean - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `autoMergeOptions`^Optional ```typescript public readonly autoMergeOptions: AutoMergeOptions; ``` - *Type:* projen.github.AutoMergeOptions - *Default:* see defaults in `AutoMergeOptions` Configure options for automatic merging on GitHub. Has no effect if `github.mergify` or `autoMerge` is set to false. --- ##### `clobber`^Optional ```typescript public readonly clobber: boolean; ``` - *Type:* boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `devContainer`^Optional ```typescript public readonly devContainer: boolean; ``` - *Type:* boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional ```typescript public readonly github: boolean; ``` - *Type:* boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```typescript public readonly githubOptions: GitHubOptions; ``` - *Type:* projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: boolean; ``` - *Type:* boolean - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```typescript public readonly mergify: boolean; ``` - *Type:* boolean - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergifyOptions`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead ```typescript public readonly mergifyOptions: MergifyOptions; ``` - *Type:* projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCredentials`^Optional ```typescript public readonly projenCredentials: GithubCredentials; ``` - *Type:* projen.github.GithubCredentials - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN Choose a method of providing GitHub API access for projen workflows. --- ##### ~~`projenTokenSecret`~~^Optional - *Deprecated:* use `projenCredentials` ```typescript public readonly projenTokenSecret: string; ``` - *Type:* string - *Default:* "PROJEN_GITHUB_TOKEN" The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This token needs to have the `repo`, `workflows` and `packages` scope. --- ##### `readme`^Optional ```typescript public readonly readme: SampleReadmeProps; ``` - *Type:* projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```typescript "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional ```typescript public readonly stale: boolean; ``` - *Type:* boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```typescript public readonly staleOptions: StaleOptions; ``` - *Type:* projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional ```typescript public readonly vscode: boolean; ``` - *Type:* boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `allowLibraryDependencies`^Optional ```typescript public readonly allowLibraryDependencies: boolean; ``` - *Type:* boolean - *Default:* true Allow the project to include `peerDependencies` and `bundledDependencies`. This is normally only allowed for libraries. For apps, there's no meaning for specifying these. --- ##### `authorEmail`^Optional ```typescript public readonly authorEmail: string; ``` - *Type:* string Author's e-mail. --- ##### `authorName`^Optional ```typescript public readonly authorName: string; ``` - *Type:* string Author's name. --- ##### `authorOrganization`^Optional ```typescript public readonly authorOrganization: boolean; ``` - *Type:* boolean Is the author an organization. --- ##### `authorUrl`^Optional ```typescript public readonly authorUrl: string; ``` - *Type:* string Author's URL / Website. --- ##### `autoDetectBin`^Optional ```typescript public readonly autoDetectBin: boolean; ``` - *Type:* boolean - *Default:* true Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. --- ##### `bin`^Optional ```typescript public readonly bin: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Binary programs vended with your module. You can use this option to add/customize how binaries are represented in your `package.json`, but unless `autoDetectBin` is `false`, every executable file under `bin` will automatically be added to this section. --- ##### `bugsEmail`^Optional ```typescript public readonly bugsEmail: string; ``` - *Type:* string The email address to which issues should be reported. --- ##### `bugsUrl`^Optional ```typescript public readonly bugsUrl: string; ``` - *Type:* string The url to your project's issue tracker. --- ##### `bundledDeps`^Optional ```typescript public readonly bundledDeps: string[]; ``` - *Type:* string[] List of dependencies to bundle into this module. These modules will be added both to the `dependencies` section and `bundledDependencies` section of your `package.json`. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `yarn add` or `npm install` in the sense that it will add the module as a dependency to your `package.json` file with the latest version (`^`). You can specify semver requirements in the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and this will be what you `package.json` will eventually include. --- ##### `codeArtifactOptions`^Optional ```typescript public readonly codeArtifactOptions: CodeArtifactOptions; ``` - *Type:* projen.javascript.CodeArtifactOptions - *Default:* undefined Options for npm packages using AWS CodeArtifact. This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact --- ##### `deps`^Optional ```typescript public readonly deps: string[]; ``` - *Type:* string[] - *Default:* [] Runtime dependencies of this module. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `yarn add` or `npm install` in the sense that it will add the module as a dependency to your `package.json` file with the latest version (`^`). You can specify semver requirements in the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and this will be what you `package.json` will eventually include. --- *Example* ```typescript [ 'express', 'lodash', 'foo@^2' ] ``` ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string The description is just a string that helps people understand the purpose of the package. It can be used when searching for packages in a package manager as well. See https://classic.yarnpkg.com/en/docs/package-json/#toc-description --- ##### `devDeps`^Optional ```typescript public readonly devDeps: string[]; ``` - *Type:* string[] - *Default:* [] Build dependencies for this module. These dependencies will only be available in your build environment but will not be fetched when this module is consumed. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `yarn add` or `npm install` in the sense that it will add the module as a dependency to your `package.json` file with the latest version (`^`). You can specify semver requirements in the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and this will be what you `package.json` will eventually include. --- *Example* ```typescript [ 'typescript', '@types/express' ] ``` ##### `entrypoint`^Optional ```typescript public readonly entrypoint: string; ``` - *Type:* string - *Default:* "lib/index.js" Module entrypoint (`main` in `package.json`). Set to an empty string to not include `main` in your package.json --- ##### `homepage`^Optional ```typescript public readonly homepage: string; ``` - *Type:* string Package's Homepage / Website. --- ##### `keywords`^Optional ```typescript public readonly keywords: string[]; ``` - *Type:* string[] Keywords to include in `package.json`. --- ##### `license`^Optional ```typescript public readonly license: string; ``` - *Type:* string - *Default:* "Apache-2.0" License's SPDX identifier. See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses. Use the `licensed` option if you want to no license to be specified. --- ##### `licensed`^Optional ```typescript public readonly licensed: boolean; ``` - *Type:* boolean - *Default:* true Indicates if a license should be added. --- ##### `maxNodeVersion`^Optional ```typescript public readonly maxNodeVersion: string; ``` - *Type:* string - *Default:* no max Minimum node.js version to require via `engines` (inclusive). --- ##### `minNodeVersion`^Optional ```typescript public readonly minNodeVersion: string; ``` - *Type:* string - *Default:* no "engines" specified Minimum Node.js version to require via package.json `engines` (inclusive). --- ##### `npmAccess`^Optional ```typescript public readonly npmAccess: NpmAccess; ``` - *Type:* projen.javascript.NpmAccess - *Default:* for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`. Access level of the npm package. --- ##### ~~`npmRegistry`~~^Optional - *Deprecated:* use `npmRegistryUrl` instead ```typescript public readonly npmRegistry: string; ``` - *Type:* string The host name of the npm registry to publish to. Cannot be set together with `npmRegistryUrl`. --- ##### `npmRegistryUrl`^Optional ```typescript public readonly npmRegistryUrl: string; ``` - *Type:* string - *Default:* "https://registry.npmjs.org" The base URL of the npm package registry. Must be a URL (e.g. start with "https://" or "http://") --- ##### `npmTokenSecret`^Optional ```typescript public readonly npmTokenSecret: string; ``` - *Type:* string - *Default:* "NPM_TOKEN" GitHub secret which contains the NPM token to use when publishing packages. --- ##### `packageManager`^Optional ```typescript public readonly packageManager: NodePackageManager; ``` - *Type:* projen.javascript.NodePackageManager - *Default:* NodePackageManager.YARN The Node Package Manager used to execute scripts. --- ##### `packageName`^Optional ```typescript public readonly packageName: string; ``` - *Type:* string - *Default:* defaults to project name The "name" in package.json. --- ##### `peerDependencyOptions`^Optional ```typescript public readonly peerDependencyOptions: PeerDependencyOptions; ``` - *Type:* projen.javascript.PeerDependencyOptions Options for `peerDeps`. --- ##### `peerDeps`^Optional ```typescript public readonly peerDeps: string[]; ``` - *Type:* string[] - *Default:* [] Peer dependencies for this module. Dependencies listed here are required to be installed (and satisfied) by the _consumer_ of this library. Using peer dependencies allows you to ensure that only a single module of a certain library exists in the `node_modules` tree of your consumers. Note that prior to npm@7, peer dependencies are _not_ automatically installed, which means that adding peer dependencies to a library will be a breaking change for your customers. Unless `peerDependencyOptions.pinnedDevDependency` is disabled (it is enabled by default), projen will automatically add a dev dependency with a pinned version for each peer dependency. This will ensure that you build & test your module against the lowest peer version required. --- ##### `pnpmVersion`^Optional ```typescript public readonly pnpmVersion: string; ``` - *Type:* string - *Default:* "7" The version of PNPM to use if using PNPM as a package manager. --- ##### `repository`^Optional ```typescript public readonly repository: string; ``` - *Type:* string The repository is the location where the actual code for your package lives. See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository --- ##### `repositoryDirectory`^Optional ```typescript public readonly repositoryDirectory: string; ``` - *Type:* string If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. --- ##### `scopedPackagesOptions`^Optional ```typescript public readonly scopedPackagesOptions: ScopedPackagesOptions[]; ``` - *Type:* projen.javascript.ScopedPackagesOptions[] - *Default:* fetch all scoped packages from the public npm registry Options for privately hosted scoped packages. --- ##### ~~`scripts`~~^Optional - *Deprecated:* use `project.addTask()` or `package.setScript()` ```typescript public readonly scripts: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* {} npm scripts to include. If a script has the same name as a standard script, the standard script will be overwritten. Also adds the script as a task. --- ##### `stability`^Optional ```typescript public readonly stability: string; ``` - *Type:* string Package's Stability. --- ##### `jsiiReleaseVersion`^Optional ```typescript public readonly jsiiReleaseVersion: string; ``` - *Type:* string - *Default:* "latest" Version requirement of `publib` which is used to publish modules to npm. --- ##### `majorVersion`^Optional ```typescript public readonly majorVersion: number; ``` - *Type:* number - *Default:* Major version is not enforced. Major version to release from the default branch. If this is specified, we bump the latest version of this major version line. If not specified, we bump the global latest version. --- ##### `minMajorVersion`^Optional ```typescript public readonly minMajorVersion: number; ``` - *Type:* number - *Default:* No minimum version is being enforced Minimal Major version to release. This can be useful to set to 1, as breaking changes before the 1.x major release are not incrementing the major version number. Can not be set together with `majorVersion`. --- ##### `npmDistTag`^Optional ```typescript public readonly npmDistTag: string; ``` - *Type:* string - *Default:* "latest" The npmDistTag to use when publishing from the default branch. To set the npm dist-tag for release branches, set the `npmDistTag` property for each branch. --- ##### `postBuildSteps`^Optional ```typescript public readonly postBuildSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] - *Default:* [] Steps to execute after build as part of the release workflow. --- ##### `prerelease`^Optional ```typescript public readonly prerelease: string; ``` - *Type:* string - *Default:* normal semantic versions Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). --- ##### `publishDryRun`^Optional ```typescript public readonly publishDryRun: boolean; ``` - *Type:* boolean - *Default:* false Instead of actually publishing to package managers, just print the publishing command. --- ##### `publishTasks`^Optional ```typescript public readonly publishTasks: boolean; ``` - *Type:* boolean - *Default:* false Define publishing tasks that can be executed manually as well as workflows. Normally, publishing only happens within automated workflows. Enable this in order to create a publishing task for each publishing activity. --- ##### `releaseBranches`^Optional ```typescript public readonly releaseBranches: {[ key: string ]: BranchOptions}; ``` - *Type:* {[ key: string ]: projen.release.BranchOptions} - *Default:* no additional branches are used for release. you can use `addBranch()` to add additional branches. Defines additional release branches. A workflow will be created for each release branch which will publish releases from commits in this branch. Each release branch _must_ be assigned a major version number which is used to enforce that versions published from that branch always use that major version. If multiple branches are used, the `majorVersion` field must also be provided for the default branch. --- ##### ~~`releaseEveryCommit`~~^Optional - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead ```typescript public readonly releaseEveryCommit: boolean; ``` - *Type:* boolean - *Default:* true Automatically release new versions every commit to one of branches in `releaseBranches`. --- ##### `releaseFailureIssue`^Optional ```typescript public readonly releaseFailureIssue: boolean; ``` - *Type:* boolean - *Default:* false Create a github issue on every failed publishing task. --- ##### `releaseFailureIssueLabel`^Optional ```typescript public readonly releaseFailureIssueLabel: string; ``` - *Type:* string - *Default:* "failed-release" The label to apply to issues indicating publish failures. Only applies if `releaseFailureIssue` is true. --- ##### ~~`releaseSchedule`~~^Optional - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.scheduled()` instead ```typescript public readonly releaseSchedule: string; ``` - *Type:* string - *Default:* no scheduled releases CRON schedule to trigger new releases. --- ##### `releaseTagPrefix`^Optional ```typescript public readonly releaseTagPrefix: string; ``` - *Type:* string - *Default:* "v" Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. Note: this prefix is used to detect the latest tagged version when bumping, so if you change this on a project with an existing version history, you may need to manually tag your latest release with the new prefix. --- ##### `releaseTrigger`^Optional ```typescript public readonly releaseTrigger: ReleaseTrigger; ``` - *Type:* projen.release.ReleaseTrigger - *Default:* Continuous releases (`ReleaseTrigger.continuous()`) The release trigger to use. --- ##### `releaseWorkflowName`^Optional ```typescript public readonly releaseWorkflowName: string; ``` - *Type:* string - *Default:* "Release" The name of the default release workflow. --- ##### `releaseWorkflowSetupSteps`^Optional ```typescript public readonly releaseWorkflowSetupSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] A set of workflow steps to execute in order to setup the workflow container. --- ##### `versionrcOptions`^Optional ```typescript public readonly versionrcOptions: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* standard configuration applicable for GitHub repositories Custom configuration used when creating changelog with standard-version package. Given values either append to default configuration or overwrite values in it. --- ##### `workflowContainerImage`^Optional ```typescript public readonly workflowContainerImage: string; ``` - *Type:* string - *Default:* default image Container image to use for GitHub workflows. --- ##### `workflowRunsOn`^Optional ```typescript public readonly workflowRunsOn: string[]; ``` - *Type:* string[] - *Default:* ["ubuntu-latest"] Github Runner selection labels. --- ##### `defaultReleaseBranch`^Required ```typescript public readonly defaultReleaseBranch: string; ``` - *Type:* string - *Default:* "main" The name of the main release branch. --- ##### `artifactsDirectory`^Optional ```typescript public readonly artifactsDirectory: string; ``` - *Type:* string - *Default:* "dist" A directory which will contain build artifacts. --- ##### `autoApproveUpgrades`^Optional ```typescript public readonly autoApproveUpgrades: boolean; ``` - *Type:* boolean - *Default:* true Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). Throw if set to true but `autoApproveOptions` are not defined. --- ##### `buildWorkflow`^Optional ```typescript public readonly buildWorkflow: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject Define a GitHub workflow for building PRs. --- ##### `buildWorkflowTriggers`^Optional ```typescript public readonly buildWorkflowTriggers: Triggers; ``` - *Type:* projen.github.workflows.Triggers - *Default:* "{ pullRequest: {}, workflowDispatch: {} }" Build workflow triggers. --- ##### `bundlerOptions`^Optional ```typescript public readonly bundlerOptions: BundlerOptions; ``` - *Type:* projen.javascript.BundlerOptions Options for `Bundler`. --- ##### `codeCov`^Optional ```typescript public readonly codeCov: boolean; ``` - *Type:* boolean - *Default:* false Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. --- ##### `codeCovTokenSecret`^Optional ```typescript public readonly codeCovTokenSecret: string; ``` - *Type:* string - *Default:* if this option is not specified, only public repositories are supported Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. --- ##### `copyrightOwner`^Optional ```typescript public readonly copyrightOwner: string; ``` - *Type:* string - *Default:* defaults to the value of authorName or "" if `authorName` is undefined. License copyright owner. --- ##### `copyrightPeriod`^Optional ```typescript public readonly copyrightPeriod: string; ``` - *Type:* string - *Default:* current year The copyright years to put in the LICENSE file. --- ##### `dependabot`^Optional ```typescript public readonly dependabot: boolean; ``` - *Type:* boolean - *Default:* false Use dependabot to handle dependency upgrades. Cannot be used in conjunction with `depsUpgrade`. --- ##### `dependabotOptions`^Optional ```typescript public readonly dependabotOptions: DependabotOptions; ``` - *Type:* projen.github.DependabotOptions - *Default:* default options Options for dependabot. --- ##### `depsUpgrade`^Optional ```typescript public readonly depsUpgrade: boolean; ``` - *Type:* boolean - *Default:* true Use github workflows to handle dependency upgrades. Cannot be used in conjunction with `dependabot`. --- ##### `depsUpgradeOptions`^Optional ```typescript public readonly depsUpgradeOptions: UpgradeDependenciesOptions; ``` - *Type:* projen.javascript.UpgradeDependenciesOptions - *Default:* default options Options for `UpgradeDependencies`. --- ##### `gitignore`^Optional ```typescript public readonly gitignore: string[]; ``` - *Type:* string[] Additional entries to .gitignore. --- ##### `jest`^Optional ```typescript public readonly jest: boolean; ``` - *Type:* boolean - *Default:* true Setup jest unit tests. --- ##### `jestOptions`^Optional ```typescript public readonly jestOptions: JestOptions; ``` - *Type:* projen.javascript.JestOptions - *Default:* default options Jest options. --- ##### `mutableBuild`^Optional ```typescript public readonly mutableBuild: boolean; ``` - *Type:* boolean - *Default:* true Automatically update files modified during builds to pull-request branches. This means that any files synthesized by projen or e.g. test snapshots will always be up-to-date before a PR is merged. Implies that PR builds do not have anti-tamper checks. --- ##### ~~`npmignore`~~^Optional - *Deprecated:* - use `project.addPackageIgnore` ```typescript public readonly npmignore: string[]; ``` - *Type:* string[] Additional entries to .npmignore. --- ##### `npmignoreEnabled`^Optional ```typescript public readonly npmignoreEnabled: boolean; ``` - *Type:* boolean - *Default:* true Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. --- ##### `npmIgnoreOptions`^Optional ```typescript public readonly npmIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .npmignore file. --- ##### `package`^Optional ```typescript public readonly package: boolean; ``` - *Type:* boolean - *Default:* true Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). --- ##### `prettier`^Optional ```typescript public readonly prettier: boolean; ``` - *Type:* boolean - *Default:* false Setup prettier. --- ##### `prettierOptions`^Optional ```typescript public readonly prettierOptions: PrettierOptions; ``` - *Type:* projen.javascript.PrettierOptions - *Default:* default options Prettier options. --- ##### `projenDevDependency`^Optional ```typescript public readonly projenDevDependency: boolean; ``` - *Type:* boolean - *Default:* true Indicates of "projen" should be installed as a devDependency. --- ##### `projenrcJs`^Optional ```typescript public readonly projenrcJs: boolean; ``` - *Type:* boolean - *Default:* true if projenrcJson is false Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. --- ##### `projenrcJsOptions`^Optional ```typescript public readonly projenrcJsOptions: ProjenrcOptions; ``` - *Type:* projen.javascript.ProjenrcOptions - *Default:* default options Options for .projenrc.js. --- ##### `projenVersion`^Optional ```typescript public readonly projenVersion: string; ``` - *Type:* string - *Default:* Defaults to the latest version. Version of projen to install. --- ##### `pullRequestTemplate`^Optional ```typescript public readonly pullRequestTemplate: boolean; ``` - *Type:* boolean - *Default:* true Include a GitHub pull request template. --- ##### `pullRequestTemplateContents`^Optional ```typescript public readonly pullRequestTemplateContents: string[]; ``` - *Type:* string[] - *Default:* default content The contents of the pull request template. --- ##### `release`^Optional ```typescript public readonly release: boolean; ``` - *Type:* boolean - *Default:* true (false for subprojects) Add release management to this project. --- ##### `releaseToNpm`^Optional ```typescript public readonly releaseToNpm: boolean; ``` - *Type:* boolean - *Default:* false Automatically release to npm when new versions are introduced. --- ##### ~~`releaseWorkflow`~~^Optional - *Deprecated:* see `release`. ```typescript public readonly releaseWorkflow: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject DEPRECATED: renamed to `release`. --- ##### `workflowBootstrapSteps`^Optional ```typescript public readonly workflowBootstrapSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] - *Default:* "yarn install --frozen-lockfile && yarn projen" Workflow steps to use in order to bootstrap this repo. --- ##### `workflowGitIdentity`^Optional ```typescript public readonly workflowGitIdentity: GitIdentity; ``` - *Type:* projen.github.GitIdentity - *Default:* GitHub Actions The git identity to use in workflows. --- ##### `workflowNodeVersion`^Optional ```typescript public readonly workflowNodeVersion: string; ``` - *Type:* string - *Default:* same as `minNodeVersion` The node version to use in GitHub workflows. --- ##### `workflowPackageCache`^Optional ```typescript public readonly workflowPackageCache: boolean; ``` - *Type:* boolean - *Default:* false Enable Node.js package cache in GitHub workflows. --- ##### `disableTsconfig`^Optional ```typescript public readonly disableTsconfig: boolean; ``` - *Type:* boolean - *Default:* false Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). --- ##### `disableTsconfigDev`^Optional ```typescript public readonly disableTsconfigDev: boolean; ``` - *Type:* boolean - *Default:* false Do not generate a `tsconfig.dev.json` file. --- ##### `docgen`^Optional ```typescript public readonly docgen: boolean; ``` - *Type:* boolean - *Default:* false Docgen by Typedoc. --- ##### `docsDirectory`^Optional ```typescript public readonly docsDirectory: string; ``` - *Type:* string - *Default:* "docs" Docs directory. --- ##### `entrypointTypes`^Optional ```typescript public readonly entrypointTypes: string; ``` - *Type:* string - *Default:* .d.ts file derived from the project's entrypoint (usually lib/index.d.ts) The .d.ts file that includes the type declarations for this module. --- ##### `eslint`^Optional ```typescript public readonly eslint: boolean; ``` - *Type:* boolean - *Default:* true Setup eslint. --- ##### `eslintOptions`^Optional ```typescript public readonly eslintOptions: EslintOptions; ``` - *Type:* projen.javascript.EslintOptions - *Default:* opinionated default options Eslint options. --- ##### `libdir`^Optional ```typescript public readonly libdir: string; ``` - *Type:* string - *Default:* "lib" Typescript artifacts output directory. --- ##### `projenrcTs`^Optional ```typescript public readonly projenrcTs: boolean; ``` - *Type:* boolean - *Default:* false Use TypeScript for your projenrc file (`.projenrc.ts`). --- ##### `projenrcTsOptions`^Optional ```typescript public readonly projenrcTsOptions: ProjenrcOptions; ``` - *Type:* projen.typescript.ProjenrcOptions Options for .projenrc.ts. --- ##### `sampleCode`^Optional ```typescript public readonly sampleCode: boolean; ``` - *Type:* boolean - *Default:* true Generate one-time sample in `src/` and `test/` if there are no files there. --- ##### `srcdir`^Optional ```typescript public readonly srcdir: string; ``` - *Type:* string - *Default:* "src" Typescript sources directory. --- ##### `testdir`^Optional ```typescript public readonly testdir: string; ``` - *Type:* string - *Default:* "test" Jest tests directory. Tests files should be named `xxx.test.ts`. If this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`), then tests are going to be compiled into `lib/` and executed as javascript. If the test directory is outside of `src`, then we configure jest to compile the code in-memory. --- ##### `tsconfig`^Optional ```typescript public readonly tsconfig: TypescriptConfigOptions; ``` - *Type:* projen.javascript.TypescriptConfigOptions - *Default:* default options Custom TSConfig. --- ##### `tsconfigDev`^Optional ```typescript public readonly tsconfigDev: TypescriptConfigOptions; ``` - *Type:* projen.javascript.TypescriptConfigOptions - *Default:* use the production tsconfig options Custom tsconfig options for the development tsconfig.json file (used for testing). --- ##### `tsconfigDevFile`^Optional ```typescript public readonly tsconfigDevFile: string; ``` - *Type:* string - *Default:* "tsconfig.dev.json" The name of the development tsconfig.json file. --- ##### `typescriptVersion`^Optional ```typescript public readonly typescriptVersion: string; ``` - *Type:* string - *Default:* "latest" TypeScript version to use. NOTE: Typescript is not semantically versioned and should remain on the same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`). --- ##### `openApiGeneratorCliConfig`^Optional ```typescript public readonly openApiGeneratorCliConfig: OpenApiGeneratorCliConfig; ``` - *Type:* OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. Overrides default values if specified. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) --- ##### `mockDataOptions`^Optional ```typescript public readonly mockDataOptions: MockResponseDataGenerationOptions; ``` - *Type:* MockResponseDataGenerationOptions Options for the generated mock response data. --- ### GeneratedTypeScriptReactQueryHooksOptions Options for configuring a generated typescript hooks library project. #### Initializer ```typescript import { GeneratedTypeScriptReactQueryHooksOptions } from '@aws-prototyping-sdk/type-safe-api' const generatedTypeScriptReactQueryHooksOptions: GeneratedTypeScriptReactQueryHooksOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | This is the name of your project. | | commitGenerated | boolean | Whether to commit the managed files by default. | | gitIgnoreOptions | projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | projen.GitOptions | Configuration options for git. | | logging | projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | string | The root directory of the project. | | parent | projen.Project | The parent project, if this project is part of a bigger project. | | projenCommand | string | The shell command to use in order to run the projen CLI. | | projenrcJson | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrcJsonOptions | projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | projen.RenovatebotOptions | Options for renovatebot. | | autoApproveOptions | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoMerge | boolean | Enable automatic merging on GitHub. | | autoMergeOptions | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | boolean | Add a `clobber` task which resets the repo to origin. | | devContainer | boolean | Add a VSCode development environment (used for GitHub Codespaces). | | github | boolean | Enable GitHub integration. | | githubOptions | projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | boolean | Add a Gitpod development environment. | | mergify | boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | projen.github.MergifyOptions | Options for mergify. | | projectType | projen.ProjectType | Which type of project this is (library/app). | | projenCredentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projenTokenSecret | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | projen.SampleReadmeProps | The README setup. | | stale | boolean | Auto-close of stale issues and pull request. | | staleOptions | projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | boolean | Enable VSCode integration. | | allowLibraryDependencies | boolean | Allow the project to include `peerDependencies` and `bundledDependencies`. | | authorEmail | string | Author's e-mail. | | authorName | string | Author's name. | | authorOrganization | boolean | Is the author an organization. | | authorUrl | string | Author's URL / Website. | | autoDetectBin | boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. | | bin | {[ key: string ]: string} | Binary programs vended with your module. | | bugsEmail | string | The email address to which issues should be reported. | | bugsUrl | string | The url to your project's issue tracker. | | bundledDeps | string[] | List of dependencies to bundle into this module. | | codeArtifactOptions | projen.javascript.CodeArtifactOptions | Options for npm packages using AWS CodeArtifact. | | deps | string[] | Runtime dependencies of this module. | | description | string | The description is just a string that helps people understand the purpose of the package. | | devDeps | string[] | Build dependencies for this module. | | entrypoint | string | Module entrypoint (`main` in `package.json`). | | homepage | string | Package's Homepage / Website. | | keywords | string[] | Keywords to include in `package.json`. | | license | string | License's SPDX identifier. | | licensed | boolean | Indicates if a license should be added. | | maxNodeVersion | string | Minimum node.js version to require via `engines` (inclusive). | | minNodeVersion | string | Minimum Node.js version to require via package.json `engines` (inclusive). | | npmAccess | projen.javascript.NpmAccess | Access level of the npm package. | | npmRegistry | string | The host name of the npm registry to publish to. | | npmRegistryUrl | string | The base URL of the npm package registry. | | npmTokenSecret | string | GitHub secret which contains the NPM token to use when publishing packages. | | packageManager | projen.javascript.NodePackageManager | The Node Package Manager used to execute scripts. | | packageName | string | The "name" in package.json. | | peerDependencyOptions | projen.javascript.PeerDependencyOptions | Options for `peerDeps`. | | peerDeps | string[] | Peer dependencies for this module. | | pnpmVersion | string | The version of PNPM to use if using PNPM as a package manager. | | repository | string | The repository is the location where the actual code for your package lives. | | repositoryDirectory | string | If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. | | scopedPackagesOptions | projen.javascript.ScopedPackagesOptions[] | Options for privately hosted scoped packages. | | scripts | {[ key: string ]: string} | npm scripts to include. | | stability | string | Package's Stability. | | jsiiReleaseVersion | string | Version requirement of `publib` which is used to publish modules to npm. | | majorVersion | number | Major version to release from the default branch. | | minMajorVersion | number | Minimal Major version to release. | | npmDistTag | string | The npmDistTag to use when publishing from the default branch. | | postBuildSteps | projen.github.workflows.JobStep[] | Steps to execute after build as part of the release workflow. | | prerelease | string | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). | | publishDryRun | boolean | Instead of actually publishing to package managers, just print the publishing command. | | publishTasks | boolean | Define publishing tasks that can be executed manually as well as workflows. | | releaseBranches | {[ key: string ]: projen.release.BranchOptions} | Defines additional release branches. | | releaseEveryCommit | boolean | Automatically release new versions every commit to one of branches in `releaseBranches`. | | releaseFailureIssue | boolean | Create a github issue on every failed publishing task. | | releaseFailureIssueLabel | string | The label to apply to issues indicating publish failures. | | releaseSchedule | string | CRON schedule to trigger new releases. | | releaseTagPrefix | string | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. | | releaseTrigger | projen.release.ReleaseTrigger | The release trigger to use. | | releaseWorkflowName | string | The name of the default release workflow. | | releaseWorkflowSetupSteps | projen.github.workflows.JobStep[] | A set of workflow steps to execute in order to setup the workflow container. | | versionrcOptions | {[ key: string ]: any} | Custom configuration used when creating changelog with standard-version package. | | workflowContainerImage | string | Container image to use for GitHub workflows. | | workflowRunsOn | string[] | Github Runner selection labels. | | defaultReleaseBranch | string | The name of the main release branch. | | artifactsDirectory | string | A directory which will contain build artifacts. | | autoApproveUpgrades | boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). | | buildWorkflow | boolean | Define a GitHub workflow for building PRs. | | buildWorkflowTriggers | projen.github.workflows.Triggers | Build workflow triggers. | | bundlerOptions | projen.javascript.BundlerOptions | Options for `Bundler`. | | codeCov | boolean | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. | | codeCovTokenSecret | string | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. | | copyrightOwner | string | License copyright owner. | | copyrightPeriod | string | The copyright years to put in the LICENSE file. | | dependabot | boolean | Use dependabot to handle dependency upgrades. | | dependabotOptions | projen.github.DependabotOptions | Options for dependabot. | | depsUpgrade | boolean | Use github workflows to handle dependency upgrades. | | depsUpgradeOptions | projen.javascript.UpgradeDependenciesOptions | Options for `UpgradeDependencies`. | | gitignore | string[] | Additional entries to .gitignore. | | jest | boolean | Setup jest unit tests. | | jestOptions | projen.javascript.JestOptions | Jest options. | | mutableBuild | boolean | Automatically update files modified during builds to pull-request branches. | | npmignore | string[] | Additional entries to .npmignore. | | npmignoreEnabled | boolean | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. | | npmIgnoreOptions | projen.IgnoreFileOptions | Configuration options for .npmignore file. | | package | boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). | | prettier | boolean | Setup prettier. | | prettierOptions | projen.javascript.PrettierOptions | Prettier options. | | projenDevDependency | boolean | Indicates of "projen" should be installed as a devDependency. | | projenrcJs | boolean | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. | | projenrcJsOptions | projen.javascript.ProjenrcOptions | Options for .projenrc.js. | | projenVersion | string | Version of projen to install. | | pullRequestTemplate | boolean | Include a GitHub pull request template. | | pullRequestTemplateContents | string[] | The contents of the pull request template. | | release | boolean | Add release management to this project. | | releaseToNpm | boolean | Automatically release to npm when new versions are introduced. | | releaseWorkflow | boolean | DEPRECATED: renamed to `release`. | | workflowBootstrapSteps | projen.github.workflows.JobStep[] | Workflow steps to use in order to bootstrap this repo. | | workflowGitIdentity | projen.github.GitIdentity | The git identity to use in workflows. | | workflowNodeVersion | string | The node version to use in GitHub workflows. | | workflowPackageCache | boolean | Enable Node.js package cache in GitHub workflows. | | disableTsconfig | boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). | | disableTsconfigDev | boolean | Do not generate a `tsconfig.dev.json` file. | | docgen | boolean | Docgen by Typedoc. | | docsDirectory | string | Docs directory. | | entrypointTypes | string | The .d.ts file that includes the type declarations for this module. | | eslint | boolean | Setup eslint. | | eslintOptions | projen.javascript.EslintOptions | Eslint options. | | libdir | string | Typescript artifacts output directory. | | projenrcTs | boolean | Use TypeScript for your projenrc file (`.projenrc.ts`). | | projenrcTsOptions | projen.typescript.ProjenrcOptions | Options for .projenrc.ts. | | sampleCode | boolean | Generate one-time sample in `src/` and `test/` if there are no files there. | | srcdir | string | Typescript sources directory. | | testdir | string | Jest tests directory. Tests files should be named `xxx.test.ts`. | | tsconfig | projen.javascript.TypescriptConfigOptions | Custom TSConfig. | | tsconfigDev | projen.javascript.TypescriptConfigOptions | Custom tsconfig options for the development tsconfig.json file (used for testing). | | tsconfigDevFile | string | The name of the development tsconfig.json file. | | typescriptVersion | string | TypeScript version to use. | | openApiGeneratorCliConfig | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional ```typescript public readonly gitIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```typescript public readonly gitOptions: GitOptions; ``` - *Type:* projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```typescript public readonly logging: LoggerOptions; ``` - *Type:* projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```typescript public readonly outdir: string; ``` - *Type:* string - *Default:* "." The root directory of the project. Relative to this directory, all files are synthesized. If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects. --- ##### `parent`^Optional ```typescript public readonly parent: Project; ``` - *Type:* projen.Project The parent project, if this project is part of a bigger project. --- ##### `projenCommand`^Optional ```typescript public readonly projenCommand: string; ``` - *Type:* string - *Default:* "npx projen" The shell command to use in order to run the projen CLI. Can be used to customize in special environments. --- ##### `projenrcJson`^Optional ```typescript public readonly projenrcJson: boolean; ``` - *Type:* boolean - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrcJsonOptions`^Optional ```typescript public readonly projenrcJsonOptions: ProjenrcJsonOptions; ``` - *Type:* projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```typescript public readonly renovatebot: boolean; ``` - *Type:* boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```typescript public readonly renovatebotOptions: RenovatebotOptions; ``` - *Type:* projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `autoApproveOptions`^Optional ```typescript public readonly autoApproveOptions: AutoApproveOptions; ``` - *Type:* projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoMerge`^Optional ```typescript public readonly autoMerge: boolean; ``` - *Type:* boolean - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `autoMergeOptions`^Optional ```typescript public readonly autoMergeOptions: AutoMergeOptions; ``` - *Type:* projen.github.AutoMergeOptions - *Default:* see defaults in `AutoMergeOptions` Configure options for automatic merging on GitHub. Has no effect if `github.mergify` or `autoMerge` is set to false. --- ##### `clobber`^Optional ```typescript public readonly clobber: boolean; ``` - *Type:* boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `devContainer`^Optional ```typescript public readonly devContainer: boolean; ``` - *Type:* boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional ```typescript public readonly github: boolean; ``` - *Type:* boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```typescript public readonly githubOptions: GitHubOptions; ``` - *Type:* projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: boolean; ``` - *Type:* boolean - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```typescript public readonly mergify: boolean; ``` - *Type:* boolean - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergifyOptions`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead ```typescript public readonly mergifyOptions: MergifyOptions; ``` - *Type:* projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCredentials`^Optional ```typescript public readonly projenCredentials: GithubCredentials; ``` - *Type:* projen.github.GithubCredentials - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN Choose a method of providing GitHub API access for projen workflows. --- ##### ~~`projenTokenSecret`~~^Optional - *Deprecated:* use `projenCredentials` ```typescript public readonly projenTokenSecret: string; ``` - *Type:* string - *Default:* "PROJEN_GITHUB_TOKEN" The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This token needs to have the `repo`, `workflows` and `packages` scope. --- ##### `readme`^Optional ```typescript public readonly readme: SampleReadmeProps; ``` - *Type:* projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```typescript "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional ```typescript public readonly stale: boolean; ``` - *Type:* boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```typescript public readonly staleOptions: StaleOptions; ``` - *Type:* projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional ```typescript public readonly vscode: boolean; ``` - *Type:* boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `allowLibraryDependencies`^Optional ```typescript public readonly allowLibraryDependencies: boolean; ``` - *Type:* boolean - *Default:* true Allow the project to include `peerDependencies` and `bundledDependencies`. This is normally only allowed for libraries. For apps, there's no meaning for specifying these. --- ##### `authorEmail`^Optional ```typescript public readonly authorEmail: string; ``` - *Type:* string Author's e-mail. --- ##### `authorName`^Optional ```typescript public readonly authorName: string; ``` - *Type:* string Author's name. --- ##### `authorOrganization`^Optional ```typescript public readonly authorOrganization: boolean; ``` - *Type:* boolean Is the author an organization. --- ##### `authorUrl`^Optional ```typescript public readonly authorUrl: string; ``` - *Type:* string Author's URL / Website. --- ##### `autoDetectBin`^Optional ```typescript public readonly autoDetectBin: boolean; ``` - *Type:* boolean - *Default:* true Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. --- ##### `bin`^Optional ```typescript public readonly bin: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Binary programs vended with your module. You can use this option to add/customize how binaries are represented in your `package.json`, but unless `autoDetectBin` is `false`, every executable file under `bin` will automatically be added to this section. --- ##### `bugsEmail`^Optional ```typescript public readonly bugsEmail: string; ``` - *Type:* string The email address to which issues should be reported. --- ##### `bugsUrl`^Optional ```typescript public readonly bugsUrl: string; ``` - *Type:* string The url to your project's issue tracker. --- ##### `bundledDeps`^Optional ```typescript public readonly bundledDeps: string[]; ``` - *Type:* string[] List of dependencies to bundle into this module. These modules will be added both to the `dependencies` section and `bundledDependencies` section of your `package.json`. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `yarn add` or `npm install` in the sense that it will add the module as a dependency to your `package.json` file with the latest version (`^`). You can specify semver requirements in the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and this will be what you `package.json` will eventually include. --- ##### `codeArtifactOptions`^Optional ```typescript public readonly codeArtifactOptions: CodeArtifactOptions; ``` - *Type:* projen.javascript.CodeArtifactOptions - *Default:* undefined Options for npm packages using AWS CodeArtifact. This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact --- ##### `deps`^Optional ```typescript public readonly deps: string[]; ``` - *Type:* string[] - *Default:* [] Runtime dependencies of this module. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `yarn add` or `npm install` in the sense that it will add the module as a dependency to your `package.json` file with the latest version (`^`). You can specify semver requirements in the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and this will be what you `package.json` will eventually include. --- *Example* ```typescript [ 'express', 'lodash', 'foo@^2' ] ``` ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string The description is just a string that helps people understand the purpose of the package. It can be used when searching for packages in a package manager as well. See https://classic.yarnpkg.com/en/docs/package-json/#toc-description --- ##### `devDeps`^Optional ```typescript public readonly devDeps: string[]; ``` - *Type:* string[] - *Default:* [] Build dependencies for this module. These dependencies will only be available in your build environment but will not be fetched when this module is consumed. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `yarn add` or `npm install` in the sense that it will add the module as a dependency to your `package.json` file with the latest version (`^`). You can specify semver requirements in the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and this will be what you `package.json` will eventually include. --- *Example* ```typescript [ 'typescript', '@types/express' ] ``` ##### `entrypoint`^Optional ```typescript public readonly entrypoint: string; ``` - *Type:* string - *Default:* "lib/index.js" Module entrypoint (`main` in `package.json`). Set to an empty string to not include `main` in your package.json --- ##### `homepage`^Optional ```typescript public readonly homepage: string; ``` - *Type:* string Package's Homepage / Website. --- ##### `keywords`^Optional ```typescript public readonly keywords: string[]; ``` - *Type:* string[] Keywords to include in `package.json`. --- ##### `license`^Optional ```typescript public readonly license: string; ``` - *Type:* string - *Default:* "Apache-2.0" License's SPDX identifier. See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses. Use the `licensed` option if you want to no license to be specified. --- ##### `licensed`^Optional ```typescript public readonly licensed: boolean; ``` - *Type:* boolean - *Default:* true Indicates if a license should be added. --- ##### `maxNodeVersion`^Optional ```typescript public readonly maxNodeVersion: string; ``` - *Type:* string - *Default:* no max Minimum node.js version to require via `engines` (inclusive). --- ##### `minNodeVersion`^Optional ```typescript public readonly minNodeVersion: string; ``` - *Type:* string - *Default:* no "engines" specified Minimum Node.js version to require via package.json `engines` (inclusive). --- ##### `npmAccess`^Optional ```typescript public readonly npmAccess: NpmAccess; ``` - *Type:* projen.javascript.NpmAccess - *Default:* for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`. Access level of the npm package. --- ##### ~~`npmRegistry`~~^Optional - *Deprecated:* use `npmRegistryUrl` instead ```typescript public readonly npmRegistry: string; ``` - *Type:* string The host name of the npm registry to publish to. Cannot be set together with `npmRegistryUrl`. --- ##### `npmRegistryUrl`^Optional ```typescript public readonly npmRegistryUrl: string; ``` - *Type:* string - *Default:* "https://registry.npmjs.org" The base URL of the npm package registry. Must be a URL (e.g. start with "https://" or "http://") --- ##### `npmTokenSecret`^Optional ```typescript public readonly npmTokenSecret: string; ``` - *Type:* string - *Default:* "NPM_TOKEN" GitHub secret which contains the NPM token to use when publishing packages. --- ##### `packageManager`^Optional ```typescript public readonly packageManager: NodePackageManager; ``` - *Type:* projen.javascript.NodePackageManager - *Default:* NodePackageManager.YARN The Node Package Manager used to execute scripts. --- ##### `packageName`^Optional ```typescript public readonly packageName: string; ``` - *Type:* string - *Default:* defaults to project name The "name" in package.json. --- ##### `peerDependencyOptions`^Optional ```typescript public readonly peerDependencyOptions: PeerDependencyOptions; ``` - *Type:* projen.javascript.PeerDependencyOptions Options for `peerDeps`. --- ##### `peerDeps`^Optional ```typescript public readonly peerDeps: string[]; ``` - *Type:* string[] - *Default:* [] Peer dependencies for this module. Dependencies listed here are required to be installed (and satisfied) by the _consumer_ of this library. Using peer dependencies allows you to ensure that only a single module of a certain library exists in the `node_modules` tree of your consumers. Note that prior to npm@7, peer dependencies are _not_ automatically installed, which means that adding peer dependencies to a library will be a breaking change for your customers. Unless `peerDependencyOptions.pinnedDevDependency` is disabled (it is enabled by default), projen will automatically add a dev dependency with a pinned version for each peer dependency. This will ensure that you build & test your module against the lowest peer version required. --- ##### `pnpmVersion`^Optional ```typescript public readonly pnpmVersion: string; ``` - *Type:* string - *Default:* "7" The version of PNPM to use if using PNPM as a package manager. --- ##### `repository`^Optional ```typescript public readonly repository: string; ``` - *Type:* string The repository is the location where the actual code for your package lives. See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository --- ##### `repositoryDirectory`^Optional ```typescript public readonly repositoryDirectory: string; ``` - *Type:* string If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. --- ##### `scopedPackagesOptions`^Optional ```typescript public readonly scopedPackagesOptions: ScopedPackagesOptions[]; ``` - *Type:* projen.javascript.ScopedPackagesOptions[] - *Default:* fetch all scoped packages from the public npm registry Options for privately hosted scoped packages. --- ##### ~~`scripts`~~^Optional - *Deprecated:* use `project.addTask()` or `package.setScript()` ```typescript public readonly scripts: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* {} npm scripts to include. If a script has the same name as a standard script, the standard script will be overwritten. Also adds the script as a task. --- ##### `stability`^Optional ```typescript public readonly stability: string; ``` - *Type:* string Package's Stability. --- ##### `jsiiReleaseVersion`^Optional ```typescript public readonly jsiiReleaseVersion: string; ``` - *Type:* string - *Default:* "latest" Version requirement of `publib` which is used to publish modules to npm. --- ##### `majorVersion`^Optional ```typescript public readonly majorVersion: number; ``` - *Type:* number - *Default:* Major version is not enforced. Major version to release from the default branch. If this is specified, we bump the latest version of this major version line. If not specified, we bump the global latest version. --- ##### `minMajorVersion`^Optional ```typescript public readonly minMajorVersion: number; ``` - *Type:* number - *Default:* No minimum version is being enforced Minimal Major version to release. This can be useful to set to 1, as breaking changes before the 1.x major release are not incrementing the major version number. Can not be set together with `majorVersion`. --- ##### `npmDistTag`^Optional ```typescript public readonly npmDistTag: string; ``` - *Type:* string - *Default:* "latest" The npmDistTag to use when publishing from the default branch. To set the npm dist-tag for release branches, set the `npmDistTag` property for each branch. --- ##### `postBuildSteps`^Optional ```typescript public readonly postBuildSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] - *Default:* [] Steps to execute after build as part of the release workflow. --- ##### `prerelease`^Optional ```typescript public readonly prerelease: string; ``` - *Type:* string - *Default:* normal semantic versions Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). --- ##### `publishDryRun`^Optional ```typescript public readonly publishDryRun: boolean; ``` - *Type:* boolean - *Default:* false Instead of actually publishing to package managers, just print the publishing command. --- ##### `publishTasks`^Optional ```typescript public readonly publishTasks: boolean; ``` - *Type:* boolean - *Default:* false Define publishing tasks that can be executed manually as well as workflows. Normally, publishing only happens within automated workflows. Enable this in order to create a publishing task for each publishing activity. --- ##### `releaseBranches`^Optional ```typescript public readonly releaseBranches: {[ key: string ]: BranchOptions}; ``` - *Type:* {[ key: string ]: projen.release.BranchOptions} - *Default:* no additional branches are used for release. you can use `addBranch()` to add additional branches. Defines additional release branches. A workflow will be created for each release branch which will publish releases from commits in this branch. Each release branch _must_ be assigned a major version number which is used to enforce that versions published from that branch always use that major version. If multiple branches are used, the `majorVersion` field must also be provided for the default branch. --- ##### ~~`releaseEveryCommit`~~^Optional - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead ```typescript public readonly releaseEveryCommit: boolean; ``` - *Type:* boolean - *Default:* true Automatically release new versions every commit to one of branches in `releaseBranches`. --- ##### `releaseFailureIssue`^Optional ```typescript public readonly releaseFailureIssue: boolean; ``` - *Type:* boolean - *Default:* false Create a github issue on every failed publishing task. --- ##### `releaseFailureIssueLabel`^Optional ```typescript public readonly releaseFailureIssueLabel: string; ``` - *Type:* string - *Default:* "failed-release" The label to apply to issues indicating publish failures. Only applies if `releaseFailureIssue` is true. --- ##### ~~`releaseSchedule`~~^Optional - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.scheduled()` instead ```typescript public readonly releaseSchedule: string; ``` - *Type:* string - *Default:* no scheduled releases CRON schedule to trigger new releases. --- ##### `releaseTagPrefix`^Optional ```typescript public readonly releaseTagPrefix: string; ``` - *Type:* string - *Default:* "v" Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. Note: this prefix is used to detect the latest tagged version when bumping, so if you change this on a project with an existing version history, you may need to manually tag your latest release with the new prefix. --- ##### `releaseTrigger`^Optional ```typescript public readonly releaseTrigger: ReleaseTrigger; ``` - *Type:* projen.release.ReleaseTrigger - *Default:* Continuous releases (`ReleaseTrigger.continuous()`) The release trigger to use. --- ##### `releaseWorkflowName`^Optional ```typescript public readonly releaseWorkflowName: string; ``` - *Type:* string - *Default:* "Release" The name of the default release workflow. --- ##### `releaseWorkflowSetupSteps`^Optional ```typescript public readonly releaseWorkflowSetupSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] A set of workflow steps to execute in order to setup the workflow container. --- ##### `versionrcOptions`^Optional ```typescript public readonly versionrcOptions: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* standard configuration applicable for GitHub repositories Custom configuration used when creating changelog with standard-version package. Given values either append to default configuration or overwrite values in it. --- ##### `workflowContainerImage`^Optional ```typescript public readonly workflowContainerImage: string; ``` - *Type:* string - *Default:* default image Container image to use for GitHub workflows. --- ##### `workflowRunsOn`^Optional ```typescript public readonly workflowRunsOn: string[]; ``` - *Type:* string[] - *Default:* ["ubuntu-latest"] Github Runner selection labels. --- ##### `defaultReleaseBranch`^Required ```typescript public readonly defaultReleaseBranch: string; ``` - *Type:* string - *Default:* "main" The name of the main release branch. --- ##### `artifactsDirectory`^Optional ```typescript public readonly artifactsDirectory: string; ``` - *Type:* string - *Default:* "dist" A directory which will contain build artifacts. --- ##### `autoApproveUpgrades`^Optional ```typescript public readonly autoApproveUpgrades: boolean; ``` - *Type:* boolean - *Default:* true Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). Throw if set to true but `autoApproveOptions` are not defined. --- ##### `buildWorkflow`^Optional ```typescript public readonly buildWorkflow: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject Define a GitHub workflow for building PRs. --- ##### `buildWorkflowTriggers`^Optional ```typescript public readonly buildWorkflowTriggers: Triggers; ``` - *Type:* projen.github.workflows.Triggers - *Default:* "{ pullRequest: {}, workflowDispatch: {} }" Build workflow triggers. --- ##### `bundlerOptions`^Optional ```typescript public readonly bundlerOptions: BundlerOptions; ``` - *Type:* projen.javascript.BundlerOptions Options for `Bundler`. --- ##### `codeCov`^Optional ```typescript public readonly codeCov: boolean; ``` - *Type:* boolean - *Default:* false Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. --- ##### `codeCovTokenSecret`^Optional ```typescript public readonly codeCovTokenSecret: string; ``` - *Type:* string - *Default:* if this option is not specified, only public repositories are supported Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. --- ##### `copyrightOwner`^Optional ```typescript public readonly copyrightOwner: string; ``` - *Type:* string - *Default:* defaults to the value of authorName or "" if `authorName` is undefined. License copyright owner. --- ##### `copyrightPeriod`^Optional ```typescript public readonly copyrightPeriod: string; ``` - *Type:* string - *Default:* current year The copyright years to put in the LICENSE file. --- ##### `dependabot`^Optional ```typescript public readonly dependabot: boolean; ``` - *Type:* boolean - *Default:* false Use dependabot to handle dependency upgrades. Cannot be used in conjunction with `depsUpgrade`. --- ##### `dependabotOptions`^Optional ```typescript public readonly dependabotOptions: DependabotOptions; ``` - *Type:* projen.github.DependabotOptions - *Default:* default options Options for dependabot. --- ##### `depsUpgrade`^Optional ```typescript public readonly depsUpgrade: boolean; ``` - *Type:* boolean - *Default:* true Use github workflows to handle dependency upgrades. Cannot be used in conjunction with `dependabot`. --- ##### `depsUpgradeOptions`^Optional ```typescript public readonly depsUpgradeOptions: UpgradeDependenciesOptions; ``` - *Type:* projen.javascript.UpgradeDependenciesOptions - *Default:* default options Options for `UpgradeDependencies`. --- ##### `gitignore`^Optional ```typescript public readonly gitignore: string[]; ``` - *Type:* string[] Additional entries to .gitignore. --- ##### `jest`^Optional ```typescript public readonly jest: boolean; ``` - *Type:* boolean - *Default:* true Setup jest unit tests. --- ##### `jestOptions`^Optional ```typescript public readonly jestOptions: JestOptions; ``` - *Type:* projen.javascript.JestOptions - *Default:* default options Jest options. --- ##### `mutableBuild`^Optional ```typescript public readonly mutableBuild: boolean; ``` - *Type:* boolean - *Default:* true Automatically update files modified during builds to pull-request branches. This means that any files synthesized by projen or e.g. test snapshots will always be up-to-date before a PR is merged. Implies that PR builds do not have anti-tamper checks. --- ##### ~~`npmignore`~~^Optional - *Deprecated:* - use `project.addPackageIgnore` ```typescript public readonly npmignore: string[]; ``` - *Type:* string[] Additional entries to .npmignore. --- ##### `npmignoreEnabled`^Optional ```typescript public readonly npmignoreEnabled: boolean; ``` - *Type:* boolean - *Default:* true Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. --- ##### `npmIgnoreOptions`^Optional ```typescript public readonly npmIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .npmignore file. --- ##### `package`^Optional ```typescript public readonly package: boolean; ``` - *Type:* boolean - *Default:* true Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). --- ##### `prettier`^Optional ```typescript public readonly prettier: boolean; ``` - *Type:* boolean - *Default:* false Setup prettier. --- ##### `prettierOptions`^Optional ```typescript public readonly prettierOptions: PrettierOptions; ``` - *Type:* projen.javascript.PrettierOptions - *Default:* default options Prettier options. --- ##### `projenDevDependency`^Optional ```typescript public readonly projenDevDependency: boolean; ``` - *Type:* boolean - *Default:* true Indicates of "projen" should be installed as a devDependency. --- ##### `projenrcJs`^Optional ```typescript public readonly projenrcJs: boolean; ``` - *Type:* boolean - *Default:* true if projenrcJson is false Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. --- ##### `projenrcJsOptions`^Optional ```typescript public readonly projenrcJsOptions: ProjenrcOptions; ``` - *Type:* projen.javascript.ProjenrcOptions - *Default:* default options Options for .projenrc.js. --- ##### `projenVersion`^Optional ```typescript public readonly projenVersion: string; ``` - *Type:* string - *Default:* Defaults to the latest version. Version of projen to install. --- ##### `pullRequestTemplate`^Optional ```typescript public readonly pullRequestTemplate: boolean; ``` - *Type:* boolean - *Default:* true Include a GitHub pull request template. --- ##### `pullRequestTemplateContents`^Optional ```typescript public readonly pullRequestTemplateContents: string[]; ``` - *Type:* string[] - *Default:* default content The contents of the pull request template. --- ##### `release`^Optional ```typescript public readonly release: boolean; ``` - *Type:* boolean - *Default:* true (false for subprojects) Add release management to this project. --- ##### `releaseToNpm`^Optional ```typescript public readonly releaseToNpm: boolean; ``` - *Type:* boolean - *Default:* false Automatically release to npm when new versions are introduced. --- ##### ~~`releaseWorkflow`~~^Optional - *Deprecated:* see `release`. ```typescript public readonly releaseWorkflow: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject DEPRECATED: renamed to `release`. --- ##### `workflowBootstrapSteps`^Optional ```typescript public readonly workflowBootstrapSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] - *Default:* "yarn install --frozen-lockfile && yarn projen" Workflow steps to use in order to bootstrap this repo. --- ##### `workflowGitIdentity`^Optional ```typescript public readonly workflowGitIdentity: GitIdentity; ``` - *Type:* projen.github.GitIdentity - *Default:* GitHub Actions The git identity to use in workflows. --- ##### `workflowNodeVersion`^Optional ```typescript public readonly workflowNodeVersion: string; ``` - *Type:* string - *Default:* same as `minNodeVersion` The node version to use in GitHub workflows. --- ##### `workflowPackageCache`^Optional ```typescript public readonly workflowPackageCache: boolean; ``` - *Type:* boolean - *Default:* false Enable Node.js package cache in GitHub workflows. --- ##### `disableTsconfig`^Optional ```typescript public readonly disableTsconfig: boolean; ``` - *Type:* boolean - *Default:* false Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). --- ##### `disableTsconfigDev`^Optional ```typescript public readonly disableTsconfigDev: boolean; ``` - *Type:* boolean - *Default:* false Do not generate a `tsconfig.dev.json` file. --- ##### `docgen`^Optional ```typescript public readonly docgen: boolean; ``` - *Type:* boolean - *Default:* false Docgen by Typedoc. --- ##### `docsDirectory`^Optional ```typescript public readonly docsDirectory: string; ``` - *Type:* string - *Default:* "docs" Docs directory. --- ##### `entrypointTypes`^Optional ```typescript public readonly entrypointTypes: string; ``` - *Type:* string - *Default:* .d.ts file derived from the project's entrypoint (usually lib/index.d.ts) The .d.ts file that includes the type declarations for this module. --- ##### `eslint`^Optional ```typescript public readonly eslint: boolean; ``` - *Type:* boolean - *Default:* true Setup eslint. --- ##### `eslintOptions`^Optional ```typescript public readonly eslintOptions: EslintOptions; ``` - *Type:* projen.javascript.EslintOptions - *Default:* opinionated default options Eslint options. --- ##### `libdir`^Optional ```typescript public readonly libdir: string; ``` - *Type:* string - *Default:* "lib" Typescript artifacts output directory. --- ##### `projenrcTs`^Optional ```typescript public readonly projenrcTs: boolean; ``` - *Type:* boolean - *Default:* false Use TypeScript for your projenrc file (`.projenrc.ts`). --- ##### `projenrcTsOptions`^Optional ```typescript public readonly projenrcTsOptions: ProjenrcOptions; ``` - *Type:* projen.typescript.ProjenrcOptions Options for .projenrc.ts. --- ##### `sampleCode`^Optional ```typescript public readonly sampleCode: boolean; ``` - *Type:* boolean - *Default:* true Generate one-time sample in `src/` and `test/` if there are no files there. --- ##### `srcdir`^Optional ```typescript public readonly srcdir: string; ``` - *Type:* string - *Default:* "src" Typescript sources directory. --- ##### `testdir`^Optional ```typescript public readonly testdir: string; ``` - *Type:* string - *Default:* "test" Jest tests directory. Tests files should be named `xxx.test.ts`. If this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`), then tests are going to be compiled into `lib/` and executed as javascript. If the test directory is outside of `src`, then we configure jest to compile the code in-memory. --- ##### `tsconfig`^Optional ```typescript public readonly tsconfig: TypescriptConfigOptions; ``` - *Type:* projen.javascript.TypescriptConfigOptions - *Default:* default options Custom TSConfig. --- ##### `tsconfigDev`^Optional ```typescript public readonly tsconfigDev: TypescriptConfigOptions; ``` - *Type:* projen.javascript.TypescriptConfigOptions - *Default:* use the production tsconfig options Custom tsconfig options for the development tsconfig.json file (used for testing). --- ##### `tsconfigDevFile`^Optional ```typescript public readonly tsconfigDevFile: string; ``` - *Type:* string - *Default:* "tsconfig.dev.json" The name of the development tsconfig.json file. --- ##### `typescriptVersion`^Optional ```typescript public readonly typescriptVersion: string; ``` - *Type:* string - *Default:* "latest" TypeScript version to use. NOTE: Typescript is not semantically versioned and should remain on the same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`). --- ##### `openApiGeneratorCliConfig`^Optional ```typescript public readonly openApiGeneratorCliConfig: OpenApiGeneratorCliConfig; ``` - *Type:* OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. Overrides default values if specified. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) --- ### GeneratedTypeScriptRuntimeOptions Options for configuring a generated typescript runtime project. #### Initializer ```typescript import { GeneratedTypeScriptRuntimeOptions } from '@aws-prototyping-sdk/type-safe-api' const generatedTypeScriptRuntimeOptions: GeneratedTypeScriptRuntimeOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | This is the name of your project. | | commitGenerated | boolean | Whether to commit the managed files by default. | | gitIgnoreOptions | projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | projen.GitOptions | Configuration options for git. | | logging | projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | string | The root directory of the project. | | parent | projen.Project | The parent project, if this project is part of a bigger project. | | projenCommand | string | The shell command to use in order to run the projen CLI. | | projenrcJson | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrcJsonOptions | projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | projen.RenovatebotOptions | Options for renovatebot. | | autoApproveOptions | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoMerge | boolean | Enable automatic merging on GitHub. | | autoMergeOptions | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | boolean | Add a `clobber` task which resets the repo to origin. | | devContainer | boolean | Add a VSCode development environment (used for GitHub Codespaces). | | github | boolean | Enable GitHub integration. | | githubOptions | projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | boolean | Add a Gitpod development environment. | | mergify | boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | projen.github.MergifyOptions | Options for mergify. | | projectType | projen.ProjectType | Which type of project this is (library/app). | | projenCredentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projenTokenSecret | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | projen.SampleReadmeProps | The README setup. | | stale | boolean | Auto-close of stale issues and pull request. | | staleOptions | projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | boolean | Enable VSCode integration. | | allowLibraryDependencies | boolean | Allow the project to include `peerDependencies` and `bundledDependencies`. | | authorEmail | string | Author's e-mail. | | authorName | string | Author's name. | | authorOrganization | boolean | Is the author an organization. | | authorUrl | string | Author's URL / Website. | | autoDetectBin | boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. | | bin | {[ key: string ]: string} | Binary programs vended with your module. | | bugsEmail | string | The email address to which issues should be reported. | | bugsUrl | string | The url to your project's issue tracker. | | bundledDeps | string[] | List of dependencies to bundle into this module. | | codeArtifactOptions | projen.javascript.CodeArtifactOptions | Options for npm packages using AWS CodeArtifact. | | deps | string[] | Runtime dependencies of this module. | | description | string | The description is just a string that helps people understand the purpose of the package. | | devDeps | string[] | Build dependencies for this module. | | entrypoint | string | Module entrypoint (`main` in `package.json`). | | homepage | string | Package's Homepage / Website. | | keywords | string[] | Keywords to include in `package.json`. | | license | string | License's SPDX identifier. | | licensed | boolean | Indicates if a license should be added. | | maxNodeVersion | string | Minimum node.js version to require via `engines` (inclusive). | | minNodeVersion | string | Minimum Node.js version to require via package.json `engines` (inclusive). | | npmAccess | projen.javascript.NpmAccess | Access level of the npm package. | | npmRegistry | string | The host name of the npm registry to publish to. | | npmRegistryUrl | string | The base URL of the npm package registry. | | npmTokenSecret | string | GitHub secret which contains the NPM token to use when publishing packages. | | packageManager | projen.javascript.NodePackageManager | The Node Package Manager used to execute scripts. | | packageName | string | The "name" in package.json. | | peerDependencyOptions | projen.javascript.PeerDependencyOptions | Options for `peerDeps`. | | peerDeps | string[] | Peer dependencies for this module. | | pnpmVersion | string | The version of PNPM to use if using PNPM as a package manager. | | repository | string | The repository is the location where the actual code for your package lives. | | repositoryDirectory | string | If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. | | scopedPackagesOptions | projen.javascript.ScopedPackagesOptions[] | Options for privately hosted scoped packages. | | scripts | {[ key: string ]: string} | npm scripts to include. | | stability | string | Package's Stability. | | jsiiReleaseVersion | string | Version requirement of `publib` which is used to publish modules to npm. | | majorVersion | number | Major version to release from the default branch. | | minMajorVersion | number | Minimal Major version to release. | | npmDistTag | string | The npmDistTag to use when publishing from the default branch. | | postBuildSteps | projen.github.workflows.JobStep[] | Steps to execute after build as part of the release workflow. | | prerelease | string | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). | | publishDryRun | boolean | Instead of actually publishing to package managers, just print the publishing command. | | publishTasks | boolean | Define publishing tasks that can be executed manually as well as workflows. | | releaseBranches | {[ key: string ]: projen.release.BranchOptions} | Defines additional release branches. | | releaseEveryCommit | boolean | Automatically release new versions every commit to one of branches in `releaseBranches`. | | releaseFailureIssue | boolean | Create a github issue on every failed publishing task. | | releaseFailureIssueLabel | string | The label to apply to issues indicating publish failures. | | releaseSchedule | string | CRON schedule to trigger new releases. | | releaseTagPrefix | string | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. | | releaseTrigger | projen.release.ReleaseTrigger | The release trigger to use. | | releaseWorkflowName | string | The name of the default release workflow. | | releaseWorkflowSetupSteps | projen.github.workflows.JobStep[] | A set of workflow steps to execute in order to setup the workflow container. | | versionrcOptions | {[ key: string ]: any} | Custom configuration used when creating changelog with standard-version package. | | workflowContainerImage | string | Container image to use for GitHub workflows. | | workflowRunsOn | string[] | Github Runner selection labels. | | defaultReleaseBranch | string | The name of the main release branch. | | artifactsDirectory | string | A directory which will contain build artifacts. | | autoApproveUpgrades | boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). | | buildWorkflow | boolean | Define a GitHub workflow for building PRs. | | buildWorkflowTriggers | projen.github.workflows.Triggers | Build workflow triggers. | | bundlerOptions | projen.javascript.BundlerOptions | Options for `Bundler`. | | codeCov | boolean | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. | | codeCovTokenSecret | string | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. | | copyrightOwner | string | License copyright owner. | | copyrightPeriod | string | The copyright years to put in the LICENSE file. | | dependabot | boolean | Use dependabot to handle dependency upgrades. | | dependabotOptions | projen.github.DependabotOptions | Options for dependabot. | | depsUpgrade | boolean | Use github workflows to handle dependency upgrades. | | depsUpgradeOptions | projen.javascript.UpgradeDependenciesOptions | Options for `UpgradeDependencies`. | | gitignore | string[] | Additional entries to .gitignore. | | jest | boolean | Setup jest unit tests. | | jestOptions | projen.javascript.JestOptions | Jest options. | | mutableBuild | boolean | Automatically update files modified during builds to pull-request branches. | | npmignore | string[] | Additional entries to .npmignore. | | npmignoreEnabled | boolean | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. | | npmIgnoreOptions | projen.IgnoreFileOptions | Configuration options for .npmignore file. | | package | boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). | | prettier | boolean | Setup prettier. | | prettierOptions | projen.javascript.PrettierOptions | Prettier options. | | projenDevDependency | boolean | Indicates of "projen" should be installed as a devDependency. | | projenrcJs | boolean | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. | | projenrcJsOptions | projen.javascript.ProjenrcOptions | Options for .projenrc.js. | | projenVersion | string | Version of projen to install. | | pullRequestTemplate | boolean | Include a GitHub pull request template. | | pullRequestTemplateContents | string[] | The contents of the pull request template. | | release | boolean | Add release management to this project. | | releaseToNpm | boolean | Automatically release to npm when new versions are introduced. | | releaseWorkflow | boolean | DEPRECATED: renamed to `release`. | | workflowBootstrapSteps | projen.github.workflows.JobStep[] | Workflow steps to use in order to bootstrap this repo. | | workflowGitIdentity | projen.github.GitIdentity | The git identity to use in workflows. | | workflowNodeVersion | string | The node version to use in GitHub workflows. | | workflowPackageCache | boolean | Enable Node.js package cache in GitHub workflows. | | disableTsconfig | boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). | | disableTsconfigDev | boolean | Do not generate a `tsconfig.dev.json` file. | | docgen | boolean | Docgen by Typedoc. | | docsDirectory | string | Docs directory. | | entrypointTypes | string | The .d.ts file that includes the type declarations for this module. | | eslint | boolean | Setup eslint. | | eslintOptions | projen.javascript.EslintOptions | Eslint options. | | libdir | string | Typescript artifacts output directory. | | projenrcTs | boolean | Use TypeScript for your projenrc file (`.projenrc.ts`). | | projenrcTsOptions | projen.typescript.ProjenrcOptions | Options for .projenrc.ts. | | sampleCode | boolean | Generate one-time sample in `src/` and `test/` if there are no files there. | | srcdir | string | Typescript sources directory. | | testdir | string | Jest tests directory. Tests files should be named `xxx.test.ts`. | | tsconfig | projen.javascript.TypescriptConfigOptions | Custom TSConfig. | | tsconfigDev | projen.javascript.TypescriptConfigOptions | Custom tsconfig options for the development tsconfig.json file (used for testing). | | tsconfigDevFile | string | The name of the development tsconfig.json file. | | typescriptVersion | string | TypeScript version to use. | | openApiGeneratorCliConfig | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional ```typescript public readonly gitIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```typescript public readonly gitOptions: GitOptions; ``` - *Type:* projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```typescript public readonly logging: LoggerOptions; ``` - *Type:* projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```typescript public readonly outdir: string; ``` - *Type:* string - *Default:* "." The root directory of the project. Relative to this directory, all files are synthesized. If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects. --- ##### `parent`^Optional ```typescript public readonly parent: Project; ``` - *Type:* projen.Project The parent project, if this project is part of a bigger project. --- ##### `projenCommand`^Optional ```typescript public readonly projenCommand: string; ``` - *Type:* string - *Default:* "npx projen" The shell command to use in order to run the projen CLI. Can be used to customize in special environments. --- ##### `projenrcJson`^Optional ```typescript public readonly projenrcJson: boolean; ``` - *Type:* boolean - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrcJsonOptions`^Optional ```typescript public readonly projenrcJsonOptions: ProjenrcJsonOptions; ``` - *Type:* projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```typescript public readonly renovatebot: boolean; ``` - *Type:* boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```typescript public readonly renovatebotOptions: RenovatebotOptions; ``` - *Type:* projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `autoApproveOptions`^Optional ```typescript public readonly autoApproveOptions: AutoApproveOptions; ``` - *Type:* projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoMerge`^Optional ```typescript public readonly autoMerge: boolean; ``` - *Type:* boolean - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `autoMergeOptions`^Optional ```typescript public readonly autoMergeOptions: AutoMergeOptions; ``` - *Type:* projen.github.AutoMergeOptions - *Default:* see defaults in `AutoMergeOptions` Configure options for automatic merging on GitHub. Has no effect if `github.mergify` or `autoMerge` is set to false. --- ##### `clobber`^Optional ```typescript public readonly clobber: boolean; ``` - *Type:* boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `devContainer`^Optional ```typescript public readonly devContainer: boolean; ``` - *Type:* boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional ```typescript public readonly github: boolean; ``` - *Type:* boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```typescript public readonly githubOptions: GitHubOptions; ``` - *Type:* projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: boolean; ``` - *Type:* boolean - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```typescript public readonly mergify: boolean; ``` - *Type:* boolean - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergifyOptions`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead ```typescript public readonly mergifyOptions: MergifyOptions; ``` - *Type:* projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCredentials`^Optional ```typescript public readonly projenCredentials: GithubCredentials; ``` - *Type:* projen.github.GithubCredentials - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN Choose a method of providing GitHub API access for projen workflows. --- ##### ~~`projenTokenSecret`~~^Optional - *Deprecated:* use `projenCredentials` ```typescript public readonly projenTokenSecret: string; ``` - *Type:* string - *Default:* "PROJEN_GITHUB_TOKEN" The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This token needs to have the `repo`, `workflows` and `packages` scope. --- ##### `readme`^Optional ```typescript public readonly readme: SampleReadmeProps; ``` - *Type:* projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```typescript "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional ```typescript public readonly stale: boolean; ``` - *Type:* boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```typescript public readonly staleOptions: StaleOptions; ``` - *Type:* projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional ```typescript public readonly vscode: boolean; ``` - *Type:* boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `allowLibraryDependencies`^Optional ```typescript public readonly allowLibraryDependencies: boolean; ``` - *Type:* boolean - *Default:* true Allow the project to include `peerDependencies` and `bundledDependencies`. This is normally only allowed for libraries. For apps, there's no meaning for specifying these. --- ##### `authorEmail`^Optional ```typescript public readonly authorEmail: string; ``` - *Type:* string Author's e-mail. --- ##### `authorName`^Optional ```typescript public readonly authorName: string; ``` - *Type:* string Author's name. --- ##### `authorOrganization`^Optional ```typescript public readonly authorOrganization: boolean; ``` - *Type:* boolean Is the author an organization. --- ##### `authorUrl`^Optional ```typescript public readonly authorUrl: string; ``` - *Type:* string Author's URL / Website. --- ##### `autoDetectBin`^Optional ```typescript public readonly autoDetectBin: boolean; ``` - *Type:* boolean - *Default:* true Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. --- ##### `bin`^Optional ```typescript public readonly bin: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Binary programs vended with your module. You can use this option to add/customize how binaries are represented in your `package.json`, but unless `autoDetectBin` is `false`, every executable file under `bin` will automatically be added to this section. --- ##### `bugsEmail`^Optional ```typescript public readonly bugsEmail: string; ``` - *Type:* string The email address to which issues should be reported. --- ##### `bugsUrl`^Optional ```typescript public readonly bugsUrl: string; ``` - *Type:* string The url to your project's issue tracker. --- ##### `bundledDeps`^Optional ```typescript public readonly bundledDeps: string[]; ``` - *Type:* string[] List of dependencies to bundle into this module. These modules will be added both to the `dependencies` section and `bundledDependencies` section of your `package.json`. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `yarn add` or `npm install` in the sense that it will add the module as a dependency to your `package.json` file with the latest version (`^`). You can specify semver requirements in the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and this will be what you `package.json` will eventually include. --- ##### `codeArtifactOptions`^Optional ```typescript public readonly codeArtifactOptions: CodeArtifactOptions; ``` - *Type:* projen.javascript.CodeArtifactOptions - *Default:* undefined Options for npm packages using AWS CodeArtifact. This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact --- ##### `deps`^Optional ```typescript public readonly deps: string[]; ``` - *Type:* string[] - *Default:* [] Runtime dependencies of this module. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `yarn add` or `npm install` in the sense that it will add the module as a dependency to your `package.json` file with the latest version (`^`). You can specify semver requirements in the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and this will be what you `package.json` will eventually include. --- *Example* ```typescript [ 'express', 'lodash', 'foo@^2' ] ``` ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string The description is just a string that helps people understand the purpose of the package. It can be used when searching for packages in a package manager as well. See https://classic.yarnpkg.com/en/docs/package-json/#toc-description --- ##### `devDeps`^Optional ```typescript public readonly devDeps: string[]; ``` - *Type:* string[] - *Default:* [] Build dependencies for this module. These dependencies will only be available in your build environment but will not be fetched when this module is consumed. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `yarn add` or `npm install` in the sense that it will add the module as a dependency to your `package.json` file with the latest version (`^`). You can specify semver requirements in the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and this will be what you `package.json` will eventually include. --- *Example* ```typescript [ 'typescript', '@types/express' ] ``` ##### `entrypoint`^Optional ```typescript public readonly entrypoint: string; ``` - *Type:* string - *Default:* "lib/index.js" Module entrypoint (`main` in `package.json`). Set to an empty string to not include `main` in your package.json --- ##### `homepage`^Optional ```typescript public readonly homepage: string; ``` - *Type:* string Package's Homepage / Website. --- ##### `keywords`^Optional ```typescript public readonly keywords: string[]; ``` - *Type:* string[] Keywords to include in `package.json`. --- ##### `license`^Optional ```typescript public readonly license: string; ``` - *Type:* string - *Default:* "Apache-2.0" License's SPDX identifier. See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses. Use the `licensed` option if you want to no license to be specified. --- ##### `licensed`^Optional ```typescript public readonly licensed: boolean; ``` - *Type:* boolean - *Default:* true Indicates if a license should be added. --- ##### `maxNodeVersion`^Optional ```typescript public readonly maxNodeVersion: string; ``` - *Type:* string - *Default:* no max Minimum node.js version to require via `engines` (inclusive). --- ##### `minNodeVersion`^Optional ```typescript public readonly minNodeVersion: string; ``` - *Type:* string - *Default:* no "engines" specified Minimum Node.js version to require via package.json `engines` (inclusive). --- ##### `npmAccess`^Optional ```typescript public readonly npmAccess: NpmAccess; ``` - *Type:* projen.javascript.NpmAccess - *Default:* for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`. Access level of the npm package. --- ##### ~~`npmRegistry`~~^Optional - *Deprecated:* use `npmRegistryUrl` instead ```typescript public readonly npmRegistry: string; ``` - *Type:* string The host name of the npm registry to publish to. Cannot be set together with `npmRegistryUrl`. --- ##### `npmRegistryUrl`^Optional ```typescript public readonly npmRegistryUrl: string; ``` - *Type:* string - *Default:* "https://registry.npmjs.org" The base URL of the npm package registry. Must be a URL (e.g. start with "https://" or "http://") --- ##### `npmTokenSecret`^Optional ```typescript public readonly npmTokenSecret: string; ``` - *Type:* string - *Default:* "NPM_TOKEN" GitHub secret which contains the NPM token to use when publishing packages. --- ##### `packageManager`^Optional ```typescript public readonly packageManager: NodePackageManager; ``` - *Type:* projen.javascript.NodePackageManager - *Default:* NodePackageManager.YARN The Node Package Manager used to execute scripts. --- ##### `packageName`^Optional ```typescript public readonly packageName: string; ``` - *Type:* string - *Default:* defaults to project name The "name" in package.json. --- ##### `peerDependencyOptions`^Optional ```typescript public readonly peerDependencyOptions: PeerDependencyOptions; ``` - *Type:* projen.javascript.PeerDependencyOptions Options for `peerDeps`. --- ##### `peerDeps`^Optional ```typescript public readonly peerDeps: string[]; ``` - *Type:* string[] - *Default:* [] Peer dependencies for this module. Dependencies listed here are required to be installed (and satisfied) by the _consumer_ of this library. Using peer dependencies allows you to ensure that only a single module of a certain library exists in the `node_modules` tree of your consumers. Note that prior to npm@7, peer dependencies are _not_ automatically installed, which means that adding peer dependencies to a library will be a breaking change for your customers. Unless `peerDependencyOptions.pinnedDevDependency` is disabled (it is enabled by default), projen will automatically add a dev dependency with a pinned version for each peer dependency. This will ensure that you build & test your module against the lowest peer version required. --- ##### `pnpmVersion`^Optional ```typescript public readonly pnpmVersion: string; ``` - *Type:* string - *Default:* "7" The version of PNPM to use if using PNPM as a package manager. --- ##### `repository`^Optional ```typescript public readonly repository: string; ``` - *Type:* string The repository is the location where the actual code for your package lives. See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository --- ##### `repositoryDirectory`^Optional ```typescript public readonly repositoryDirectory: string; ``` - *Type:* string If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. --- ##### `scopedPackagesOptions`^Optional ```typescript public readonly scopedPackagesOptions: ScopedPackagesOptions[]; ``` - *Type:* projen.javascript.ScopedPackagesOptions[] - *Default:* fetch all scoped packages from the public npm registry Options for privately hosted scoped packages. --- ##### ~~`scripts`~~^Optional - *Deprecated:* use `project.addTask()` or `package.setScript()` ```typescript public readonly scripts: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* {} npm scripts to include. If a script has the same name as a standard script, the standard script will be overwritten. Also adds the script as a task. --- ##### `stability`^Optional ```typescript public readonly stability: string; ``` - *Type:* string Package's Stability. --- ##### `jsiiReleaseVersion`^Optional ```typescript public readonly jsiiReleaseVersion: string; ``` - *Type:* string - *Default:* "latest" Version requirement of `publib` which is used to publish modules to npm. --- ##### `majorVersion`^Optional ```typescript public readonly majorVersion: number; ``` - *Type:* number - *Default:* Major version is not enforced. Major version to release from the default branch. If this is specified, we bump the latest version of this major version line. If not specified, we bump the global latest version. --- ##### `minMajorVersion`^Optional ```typescript public readonly minMajorVersion: number; ``` - *Type:* number - *Default:* No minimum version is being enforced Minimal Major version to release. This can be useful to set to 1, as breaking changes before the 1.x major release are not incrementing the major version number. Can not be set together with `majorVersion`. --- ##### `npmDistTag`^Optional ```typescript public readonly npmDistTag: string; ``` - *Type:* string - *Default:* "latest" The npmDistTag to use when publishing from the default branch. To set the npm dist-tag for release branches, set the `npmDistTag` property for each branch. --- ##### `postBuildSteps`^Optional ```typescript public readonly postBuildSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] - *Default:* [] Steps to execute after build as part of the release workflow. --- ##### `prerelease`^Optional ```typescript public readonly prerelease: string; ``` - *Type:* string - *Default:* normal semantic versions Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). --- ##### `publishDryRun`^Optional ```typescript public readonly publishDryRun: boolean; ``` - *Type:* boolean - *Default:* false Instead of actually publishing to package managers, just print the publishing command. --- ##### `publishTasks`^Optional ```typescript public readonly publishTasks: boolean; ``` - *Type:* boolean - *Default:* false Define publishing tasks that can be executed manually as well as workflows. Normally, publishing only happens within automated workflows. Enable this in order to create a publishing task for each publishing activity. --- ##### `releaseBranches`^Optional ```typescript public readonly releaseBranches: {[ key: string ]: BranchOptions}; ``` - *Type:* {[ key: string ]: projen.release.BranchOptions} - *Default:* no additional branches are used for release. you can use `addBranch()` to add additional branches. Defines additional release branches. A workflow will be created for each release branch which will publish releases from commits in this branch. Each release branch _must_ be assigned a major version number which is used to enforce that versions published from that branch always use that major version. If multiple branches are used, the `majorVersion` field must also be provided for the default branch. --- ##### ~~`releaseEveryCommit`~~^Optional - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead ```typescript public readonly releaseEveryCommit: boolean; ``` - *Type:* boolean - *Default:* true Automatically release new versions every commit to one of branches in `releaseBranches`. --- ##### `releaseFailureIssue`^Optional ```typescript public readonly releaseFailureIssue: boolean; ``` - *Type:* boolean - *Default:* false Create a github issue on every failed publishing task. --- ##### `releaseFailureIssueLabel`^Optional ```typescript public readonly releaseFailureIssueLabel: string; ``` - *Type:* string - *Default:* "failed-release" The label to apply to issues indicating publish failures. Only applies if `releaseFailureIssue` is true. --- ##### ~~`releaseSchedule`~~^Optional - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.scheduled()` instead ```typescript public readonly releaseSchedule: string; ``` - *Type:* string - *Default:* no scheduled releases CRON schedule to trigger new releases. --- ##### `releaseTagPrefix`^Optional ```typescript public readonly releaseTagPrefix: string; ``` - *Type:* string - *Default:* "v" Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. Note: this prefix is used to detect the latest tagged version when bumping, so if you change this on a project with an existing version history, you may need to manually tag your latest release with the new prefix. --- ##### `releaseTrigger`^Optional ```typescript public readonly releaseTrigger: ReleaseTrigger; ``` - *Type:* projen.release.ReleaseTrigger - *Default:* Continuous releases (`ReleaseTrigger.continuous()`) The release trigger to use. --- ##### `releaseWorkflowName`^Optional ```typescript public readonly releaseWorkflowName: string; ``` - *Type:* string - *Default:* "Release" The name of the default release workflow. --- ##### `releaseWorkflowSetupSteps`^Optional ```typescript public readonly releaseWorkflowSetupSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] A set of workflow steps to execute in order to setup the workflow container. --- ##### `versionrcOptions`^Optional ```typescript public readonly versionrcOptions: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* standard configuration applicable for GitHub repositories Custom configuration used when creating changelog with standard-version package. Given values either append to default configuration or overwrite values in it. --- ##### `workflowContainerImage`^Optional ```typescript public readonly workflowContainerImage: string; ``` - *Type:* string - *Default:* default image Container image to use for GitHub workflows. --- ##### `workflowRunsOn`^Optional ```typescript public readonly workflowRunsOn: string[]; ``` - *Type:* string[] - *Default:* ["ubuntu-latest"] Github Runner selection labels. --- ##### `defaultReleaseBranch`^Required ```typescript public readonly defaultReleaseBranch: string; ``` - *Type:* string - *Default:* "main" The name of the main release branch. --- ##### `artifactsDirectory`^Optional ```typescript public readonly artifactsDirectory: string; ``` - *Type:* string - *Default:* "dist" A directory which will contain build artifacts. --- ##### `autoApproveUpgrades`^Optional ```typescript public readonly autoApproveUpgrades: boolean; ``` - *Type:* boolean - *Default:* true Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). Throw if set to true but `autoApproveOptions` are not defined. --- ##### `buildWorkflow`^Optional ```typescript public readonly buildWorkflow: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject Define a GitHub workflow for building PRs. --- ##### `buildWorkflowTriggers`^Optional ```typescript public readonly buildWorkflowTriggers: Triggers; ``` - *Type:* projen.github.workflows.Triggers - *Default:* "{ pullRequest: {}, workflowDispatch: {} }" Build workflow triggers. --- ##### `bundlerOptions`^Optional ```typescript public readonly bundlerOptions: BundlerOptions; ``` - *Type:* projen.javascript.BundlerOptions Options for `Bundler`. --- ##### `codeCov`^Optional ```typescript public readonly codeCov: boolean; ``` - *Type:* boolean - *Default:* false Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. --- ##### `codeCovTokenSecret`^Optional ```typescript public readonly codeCovTokenSecret: string; ``` - *Type:* string - *Default:* if this option is not specified, only public repositories are supported Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. --- ##### `copyrightOwner`^Optional ```typescript public readonly copyrightOwner: string; ``` - *Type:* string - *Default:* defaults to the value of authorName or "" if `authorName` is undefined. License copyright owner. --- ##### `copyrightPeriod`^Optional ```typescript public readonly copyrightPeriod: string; ``` - *Type:* string - *Default:* current year The copyright years to put in the LICENSE file. --- ##### `dependabot`^Optional ```typescript public readonly dependabot: boolean; ``` - *Type:* boolean - *Default:* false Use dependabot to handle dependency upgrades. Cannot be used in conjunction with `depsUpgrade`. --- ##### `dependabotOptions`^Optional ```typescript public readonly dependabotOptions: DependabotOptions; ``` - *Type:* projen.github.DependabotOptions - *Default:* default options Options for dependabot. --- ##### `depsUpgrade`^Optional ```typescript public readonly depsUpgrade: boolean; ``` - *Type:* boolean - *Default:* true Use github workflows to handle dependency upgrades. Cannot be used in conjunction with `dependabot`. --- ##### `depsUpgradeOptions`^Optional ```typescript public readonly depsUpgradeOptions: UpgradeDependenciesOptions; ``` - *Type:* projen.javascript.UpgradeDependenciesOptions - *Default:* default options Options for `UpgradeDependencies`. --- ##### `gitignore`^Optional ```typescript public readonly gitignore: string[]; ``` - *Type:* string[] Additional entries to .gitignore. --- ##### `jest`^Optional ```typescript public readonly jest: boolean; ``` - *Type:* boolean - *Default:* true Setup jest unit tests. --- ##### `jestOptions`^Optional ```typescript public readonly jestOptions: JestOptions; ``` - *Type:* projen.javascript.JestOptions - *Default:* default options Jest options. --- ##### `mutableBuild`^Optional ```typescript public readonly mutableBuild: boolean; ``` - *Type:* boolean - *Default:* true Automatically update files modified during builds to pull-request branches. This means that any files synthesized by projen or e.g. test snapshots will always be up-to-date before a PR is merged. Implies that PR builds do not have anti-tamper checks. --- ##### ~~`npmignore`~~^Optional - *Deprecated:* - use `project.addPackageIgnore` ```typescript public readonly npmignore: string[]; ``` - *Type:* string[] Additional entries to .npmignore. --- ##### `npmignoreEnabled`^Optional ```typescript public readonly npmignoreEnabled: boolean; ``` - *Type:* boolean - *Default:* true Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. --- ##### `npmIgnoreOptions`^Optional ```typescript public readonly npmIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .npmignore file. --- ##### `package`^Optional ```typescript public readonly package: boolean; ``` - *Type:* boolean - *Default:* true Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). --- ##### `prettier`^Optional ```typescript public readonly prettier: boolean; ``` - *Type:* boolean - *Default:* false Setup prettier. --- ##### `prettierOptions`^Optional ```typescript public readonly prettierOptions: PrettierOptions; ``` - *Type:* projen.javascript.PrettierOptions - *Default:* default options Prettier options. --- ##### `projenDevDependency`^Optional ```typescript public readonly projenDevDependency: boolean; ``` - *Type:* boolean - *Default:* true Indicates of "projen" should be installed as a devDependency. --- ##### `projenrcJs`^Optional ```typescript public readonly projenrcJs: boolean; ``` - *Type:* boolean - *Default:* true if projenrcJson is false Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. --- ##### `projenrcJsOptions`^Optional ```typescript public readonly projenrcJsOptions: ProjenrcOptions; ``` - *Type:* projen.javascript.ProjenrcOptions - *Default:* default options Options for .projenrc.js. --- ##### `projenVersion`^Optional ```typescript public readonly projenVersion: string; ``` - *Type:* string - *Default:* Defaults to the latest version. Version of projen to install. --- ##### `pullRequestTemplate`^Optional ```typescript public readonly pullRequestTemplate: boolean; ``` - *Type:* boolean - *Default:* true Include a GitHub pull request template. --- ##### `pullRequestTemplateContents`^Optional ```typescript public readonly pullRequestTemplateContents: string[]; ``` - *Type:* string[] - *Default:* default content The contents of the pull request template. --- ##### `release`^Optional ```typescript public readonly release: boolean; ``` - *Type:* boolean - *Default:* true (false for subprojects) Add release management to this project. --- ##### `releaseToNpm`^Optional ```typescript public readonly releaseToNpm: boolean; ``` - *Type:* boolean - *Default:* false Automatically release to npm when new versions are introduced. --- ##### ~~`releaseWorkflow`~~^Optional - *Deprecated:* see `release`. ```typescript public readonly releaseWorkflow: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject DEPRECATED: renamed to `release`. --- ##### `workflowBootstrapSteps`^Optional ```typescript public readonly workflowBootstrapSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] - *Default:* "yarn install --frozen-lockfile && yarn projen" Workflow steps to use in order to bootstrap this repo. --- ##### `workflowGitIdentity`^Optional ```typescript public readonly workflowGitIdentity: GitIdentity; ``` - *Type:* projen.github.GitIdentity - *Default:* GitHub Actions The git identity to use in workflows. --- ##### `workflowNodeVersion`^Optional ```typescript public readonly workflowNodeVersion: string; ``` - *Type:* string - *Default:* same as `minNodeVersion` The node version to use in GitHub workflows. --- ##### `workflowPackageCache`^Optional ```typescript public readonly workflowPackageCache: boolean; ``` - *Type:* boolean - *Default:* false Enable Node.js package cache in GitHub workflows. --- ##### `disableTsconfig`^Optional ```typescript public readonly disableTsconfig: boolean; ``` - *Type:* boolean - *Default:* false Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). --- ##### `disableTsconfigDev`^Optional ```typescript public readonly disableTsconfigDev: boolean; ``` - *Type:* boolean - *Default:* false Do not generate a `tsconfig.dev.json` file. --- ##### `docgen`^Optional ```typescript public readonly docgen: boolean; ``` - *Type:* boolean - *Default:* false Docgen by Typedoc. --- ##### `docsDirectory`^Optional ```typescript public readonly docsDirectory: string; ``` - *Type:* string - *Default:* "docs" Docs directory. --- ##### `entrypointTypes`^Optional ```typescript public readonly entrypointTypes: string; ``` - *Type:* string - *Default:* .d.ts file derived from the project's entrypoint (usually lib/index.d.ts) The .d.ts file that includes the type declarations for this module. --- ##### `eslint`^Optional ```typescript public readonly eslint: boolean; ``` - *Type:* boolean - *Default:* true Setup eslint. --- ##### `eslintOptions`^Optional ```typescript public readonly eslintOptions: EslintOptions; ``` - *Type:* projen.javascript.EslintOptions - *Default:* opinionated default options Eslint options. --- ##### `libdir`^Optional ```typescript public readonly libdir: string; ``` - *Type:* string - *Default:* "lib" Typescript artifacts output directory. --- ##### `projenrcTs`^Optional ```typescript public readonly projenrcTs: boolean; ``` - *Type:* boolean - *Default:* false Use TypeScript for your projenrc file (`.projenrc.ts`). --- ##### `projenrcTsOptions`^Optional ```typescript public readonly projenrcTsOptions: ProjenrcOptions; ``` - *Type:* projen.typescript.ProjenrcOptions Options for .projenrc.ts. --- ##### `sampleCode`^Optional ```typescript public readonly sampleCode: boolean; ``` - *Type:* boolean - *Default:* true Generate one-time sample in `src/` and `test/` if there are no files there. --- ##### `srcdir`^Optional ```typescript public readonly srcdir: string; ``` - *Type:* string - *Default:* "src" Typescript sources directory. --- ##### `testdir`^Optional ```typescript public readonly testdir: string; ``` - *Type:* string - *Default:* "test" Jest tests directory. Tests files should be named `xxx.test.ts`. If this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`), then tests are going to be compiled into `lib/` and executed as javascript. If the test directory is outside of `src`, then we configure jest to compile the code in-memory. --- ##### `tsconfig`^Optional ```typescript public readonly tsconfig: TypescriptConfigOptions; ``` - *Type:* projen.javascript.TypescriptConfigOptions - *Default:* default options Custom TSConfig. --- ##### `tsconfigDev`^Optional ```typescript public readonly tsconfigDev: TypescriptConfigOptions; ``` - *Type:* projen.javascript.TypescriptConfigOptions - *Default:* use the production tsconfig options Custom tsconfig options for the development tsconfig.json file (used for testing). --- ##### `tsconfigDevFile`^Optional ```typescript public readonly tsconfigDevFile: string; ``` - *Type:* string - *Default:* "tsconfig.dev.json" The name of the development tsconfig.json file. --- ##### `typescriptVersion`^Optional ```typescript public readonly typescriptVersion: string; ``` - *Type:* string - *Default:* "latest" TypeScript version to use. NOTE: Typescript is not semantically versioned and should remain on the same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`). --- ##### `openApiGeneratorCliConfig`^Optional ```typescript public readonly openApiGeneratorCliConfig: OpenApiGeneratorCliConfig; ``` - *Type:* OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. Overrides default values if specified. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) --- ### GeneratedWithOpenApiGeneratorOptions Options for a code project generated with OpenAPI Generator. #### Initializer ```typescript import { GeneratedWithOpenApiGeneratorOptions } from '@aws-prototyping-sdk/type-safe-api' const generatedWithOpenApiGeneratorOptions: GeneratedWithOpenApiGeneratorOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | openApiGeneratorCliConfig | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. | --- ##### `openApiGeneratorCliConfig`^Optional ```typescript public readonly openApiGeneratorCliConfig: OpenApiGeneratorCliConfig; ``` - *Type:* OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. Overrides default values if specified. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) --- ### HandlersConfiguration Configuration for generated lambda handlers. #### Initializer ```typescript import { HandlersConfiguration } from '@aws-prototyping-sdk/type-safe-api' const handlersConfiguration: HandlersConfiguration = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | languages | Language[] | The languages lambda handlers are written in. | | options | GeneratedHandlersCodeOptions | Options for the infrastructure package. | --- ##### `languages`^Required ```typescript public readonly languages: Language[]; ``` - *Type:* Language[] The languages lambda handlers are written in. Specify multiple languages if you wish to implement different operations as AWS Lambda functions in different languages. --- ##### `options`^Optional ```typescript public readonly options: GeneratedHandlersCodeOptions; ``` - *Type:* GeneratedHandlersCodeOptions Options for the infrastructure package. Note that only those provided for the specified language will apply. --- ### InfrastructureConfiguration Configuration for generated infrastructure. #### Initializer ```typescript import { InfrastructureConfiguration } from '@aws-prototyping-sdk/type-safe-api' const infrastructureConfiguration: InfrastructureConfiguration = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | language | Language | The language to generate the type-safe CDK infrastructure in. | | options | GeneratedInfrastructureCodeOptions | Options for the infrastructure package. | --- ##### `language`^Required ```typescript public readonly language: Language; ``` - *Type:* Language The language to generate the type-safe CDK infrastructure in. --- ##### `options`^Optional ```typescript public readonly options: GeneratedInfrastructureCodeOptions; ``` - *Type:* GeneratedInfrastructureCodeOptions Options for the infrastructure package. Note that only those provided for the specified language will apply. --- ### IntegrationGrantProps Properties for granting the API access to invoke the operation. #### Initializer ```typescript import { IntegrationGrantProps } from '@aws-prototyping-sdk/type-safe-api' const integrationGrantProps: IntegrationGrantProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | method | string | The http method of this operation. | | path | string | The path of this operation in the api. | | contentTypes | string[] | Content types accepted by this operation. | | api | aws-cdk-lib.aws_apigateway.SpecRestApi | The api to grant permissions for. | | operationId | string | The ID of the operation for which permissions are being granted. | | scope | constructs.Construct | The scope in which permission resources can be created. | --- ##### `method`^Required ```typescript public readonly method: string; ``` - *Type:* string The http method of this operation. --- ##### `path`^Required ```typescript public readonly path: string; ``` - *Type:* string The path of this operation in the api. --- ##### `contentTypes`^Optional ```typescript public readonly contentTypes: string[]; ``` - *Type:* string[] - *Default:* application/json Content types accepted by this operation. --- ##### `api`^Required ```typescript public readonly api: SpecRestApi; ``` - *Type:* aws-cdk-lib.aws_apigateway.SpecRestApi The api to grant permissions for. --- ##### `operationId`^Required ```typescript public readonly operationId: string; ``` - *Type:* string The ID of the operation for which permissions are being granted. --- ##### `scope`^Required ```typescript public readonly scope: Construct; ``` - *Type:* constructs.Construct The scope in which permission resources can be created. --- ### IntegrationRenderProps Properties for rendering an integration into an API Gateway OpenAPI extension. #### Initializer ```typescript import { IntegrationRenderProps } from '@aws-prototyping-sdk/type-safe-api' const integrationRenderProps: IntegrationRenderProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | method | string | The http method of this operation. | | path | string | The path of this operation in the api. | | contentTypes | string[] | Content types accepted by this operation. | | operationId | string | The ID of the operation being rendered. | | scope | constructs.Construct | The scope in which the integration is being rendered. | | corsOptions | SerializedCorsOptions | Cross Origin Resource Sharing options for the API. | --- ##### `method`^Required ```typescript public readonly method: string; ``` - *Type:* string The http method of this operation. --- ##### `path`^Required ```typescript public readonly path: string; ``` - *Type:* string The path of this operation in the api. --- ##### `contentTypes`^Optional ```typescript public readonly contentTypes: string[]; ``` - *Type:* string[] - *Default:* application/json Content types accepted by this operation. --- ##### `operationId`^Required ```typescript public readonly operationId: string; ``` - *Type:* string The ID of the operation being rendered. --- ##### `scope`^Required ```typescript public readonly scope: Construct; ``` - *Type:* constructs.Construct The scope in which the integration is being rendered. --- ##### `corsOptions`^Optional ```typescript public readonly corsOptions: SerializedCorsOptions; ``` - *Type:* SerializedCorsOptions Cross Origin Resource Sharing options for the API. --- ### LibraryConfiguration Configuration for generated libraries. #### Initializer ```typescript import { LibraryConfiguration } from '@aws-prototyping-sdk/type-safe-api' const libraryConfiguration: LibraryConfiguration = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | libraries | Library[] | The library to generate. | | options | GeneratedLibraryOptions | Options for the generated library package. | --- ##### `libraries`^Required ```typescript public readonly libraries: Library[]; ``` - *Type:* Library[] The library to generate. --- ##### `options`^Optional ```typescript public readonly options: GeneratedLibraryOptions; ``` - *Type:* GeneratedLibraryOptions Options for the generated library package. Note that only options for the specified libraries will apply --- ### ManagedRule #### Initializer ```typescript import { ManagedRule } from '@aws-prototyping-sdk/type-safe-api' const managedRule: ManagedRule = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | The name of the managed rule group. | | vendor | string | The name of the managed rule group vendor. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of the managed rule group. You use this, along with the vendor name, to identify the rule group. --- ##### `vendor`^Required ```typescript public readonly vendor: string; ``` - *Type:* string The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group. --- ### MethodAndPath Structure to contain an API operation's method and path. #### Initializer ```typescript import { MethodAndPath } from '@aws-prototyping-sdk/type-safe-api' const methodAndPath: MethodAndPath = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | method | string | The http method of this operation. | | path | string | The path of this operation in the api. | --- ##### `method`^Required ```typescript public readonly method: string; ``` - *Type:* string The http method of this operation. --- ##### `path`^Required ```typescript public readonly path: string; ``` - *Type:* string The path of this operation in the api. --- ### MockIntegrationResponse Properties for a mock integration response. #### Initializer ```typescript import { MockIntegrationResponse } from '@aws-prototyping-sdk/type-safe-api' const mockIntegrationResponse: MockIntegrationResponse = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | statusCode | number | HTTP response status code. | | body | string | Response body. | --- ##### `statusCode`^Required ```typescript public readonly statusCode: number; ``` - *Type:* number HTTP response status code. --- ##### `body`^Optional ```typescript public readonly body: string; ``` - *Type:* string Response body. --- ### MockResponseDataGenerationOptions Options for generating mock data. #### Initializer ```typescript import { MockResponseDataGenerationOptions } from '@aws-prototyping-sdk/type-safe-api' const mockResponseDataGenerationOptions: MockResponseDataGenerationOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | disable | boolean | Set to true to disable generating mock data. | | locale | string | Locale of generated data. | | maxArrayLength | number | Maximum length of generated arrays. | --- ##### `disable`^Optional ```typescript public readonly disable: boolean; ``` - *Type:* boolean - *Default:* false Set to true to disable generating mock data. --- ##### `locale`^Optional ```typescript public readonly locale: string; ``` - *Type:* string - *Default:* en Locale of generated data. > [https://fakerjs.dev/guide/localization.html#available-locales](https://fakerjs.dev/guide/localization.html#available-locales) --- ##### `maxArrayLength`^Optional ```typescript public readonly maxArrayLength: number; ``` - *Type:* number - *Default:* 3 Maximum length of generated arrays. --- ### MockResponseGenerationOptions Options for generating mock data. #### Initializer ```typescript import { MockResponseGenerationOptions } from '@aws-prototyping-sdk/type-safe-api' const mockResponseGenerationOptions: MockResponseGenerationOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | mockDataOptions | MockResponseDataGenerationOptions | Options for the generated mock response data. | --- ##### `mockDataOptions`^Optional ```typescript public readonly mockDataOptions: MockResponseDataGenerationOptions; ``` - *Type:* MockResponseDataGenerationOptions Options for the generated mock response data. --- ### ModelConfiguration Configuration for modelling the API. #### Initializer ```typescript import { ModelConfiguration } from '@aws-prototyping-sdk/type-safe-api' const modelConfiguration: ModelConfiguration = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | language | ModelLanguage | The language the API model is defined in. | | options | ModelOptions | Options for the API model. | --- ##### `language`^Required ```typescript public readonly language: ModelLanguage; ``` - *Type:* ModelLanguage The language the API model is defined in. --- ##### `options`^Required ```typescript public readonly options: ModelOptions; ``` - *Type:* ModelOptions Options for the API model. --- ### ModelOptions Options for models. #### Initializer ```typescript import { ModelOptions } from '@aws-prototyping-sdk/type-safe-api' const modelOptions: ModelOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | openapi | OpenApiModelOptions | Options for the OpenAPI model - required when model language is OPENAPI. | | smithy | SmithyModelOptions | Options for the Smithy model - required when model language is SMITHY. | --- ##### `openapi`^Optional ```typescript public readonly openapi: OpenApiModelOptions; ``` - *Type:* OpenApiModelOptions Options for the OpenAPI model - required when model language is OPENAPI. --- ##### `smithy`^Optional ```typescript public readonly smithy: SmithyModelOptions; ``` - *Type:* SmithyModelOptions Options for the Smithy model - required when model language is SMITHY. --- ### OpenApiDefinitionOptions Options for the OpenAPI Spec. #### Initializer ```typescript import { OpenApiDefinitionOptions } from '@aws-prototyping-sdk/type-safe-api' const openApiDefinitionOptions: OpenApiDefinitionOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | openApiOptions | OpenApiModelOptions | Options for the openapi model. | | handlerLanguages | Language[] | The languages users have specified for handler projects (if any). | --- ##### `openApiOptions`^Required ```typescript public readonly openApiOptions: OpenApiModelOptions; ``` - *Type:* OpenApiModelOptions Options for the openapi model. --- ##### `handlerLanguages`^Optional ```typescript public readonly handlerLanguages: Language[]; ``` - *Type:* Language[] The languages users have specified for handler projects (if any). --- ### OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) #### Initializer ```typescript import { OpenApiGeneratorCliConfig } from '@aws-prototyping-sdk/type-safe-api' const openApiGeneratorCliConfig: OpenApiGeneratorCliConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | repository | OpenApiGeneratorCliConfigRepository | Maven repository info for fetching the OpenAPI Generator jar. | | storageDir | string | The directory in which OpenAPI Generator jars are cached. | | useDocker | boolean | Use docker instead of your locally installed Java version. | | version | string | OpenAPI Generator version to use. | --- ##### `repository`^Optional ```typescript public readonly repository: OpenApiGeneratorCliConfigRepository; ``` - *Type:* OpenApiGeneratorCliConfigRepository - *Default:* public maven repository Maven repository info for fetching the OpenAPI Generator jar. > [https://github.com/OpenAPITools/openapi-generator-cli#using-custom--private-maven-registry](https://github.com/OpenAPITools/openapi-generator-cli#using-custom--private-maven-registry) --- ##### `storageDir`^Optional ```typescript public readonly storageDir: string; ``` - *Type:* string - *Default:* ~/.open-api-generator-cli The directory in which OpenAPI Generator jars are cached. --- ##### `useDocker`^Optional ```typescript public readonly useDocker: boolean; ``` - *Type:* boolean - *Default:* false Use docker instead of your locally installed Java version. > [https://github.com/OpenAPITools/openapi-generator-cli#use-docker-instead-of-running-java-locally](https://github.com/OpenAPITools/openapi-generator-cli#use-docker-instead-of-running-java-locally) --- ##### `version`^Optional ```typescript public readonly version: string; ``` - *Type:* string - *Default:* 6.3.0 OpenAPI Generator version to use. Edit with caution - using the non-default version may result in broken generated code. --- ### OpenApiGeneratorCliConfigRepository Maven repository info for fetching the OpenAPI Generator jar. > [https://github.com/OpenAPITools/openapi-generator-cli#using-custom--private-maven-registry](https://github.com/OpenAPITools/openapi-generator-cli#using-custom--private-maven-registry) #### Initializer ```typescript import { OpenApiGeneratorCliConfigRepository } from '@aws-prototyping-sdk/type-safe-api' const openApiGeneratorCliConfigRepository: OpenApiGeneratorCliConfigRepository = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | downloadUrl | string | Maven repository URL for downloading the OpenAPI Generator jar. | --- ##### `downloadUrl`^Required ```typescript public readonly downloadUrl: string; ``` - *Type:* string Maven repository URL for downloading the OpenAPI Generator jar. This must specify the full url, and can include placeholders for the groupId, artifactId and versionName. For example: https://private.maven.intern/maven2/${groupId}/${artifactId}/${versionName}/${artifactId}-${versionName}.jar > [https://github.com/OpenAPITools/openapi-generator-cli#using-custom--private-maven-registry](https://github.com/OpenAPITools/openapi-generator-cli#using-custom--private-maven-registry) --- ### OpenApiModelOptions Options for the OpenAPI model. #### Initializer ```typescript import { OpenApiModelOptions } from '@aws-prototyping-sdk/type-safe-api' const openApiModelOptions: OpenApiModelOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | title | string | The title in the OpenAPI specification. | --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string The title in the OpenAPI specification. --- ### OperationDetails Details about an API operation. #### Initializer ```typescript import { OperationDetails } from '@aws-prototyping-sdk/type-safe-api' const operationDetails: OperationDetails = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | method | string | The http method of this operation. | | path | string | The path of this operation in the api. | | contentTypes | string[] | Content types accepted by this operation. | --- ##### `method`^Required ```typescript public readonly method: string; ``` - *Type:* string The http method of this operation. --- ##### `path`^Required ```typescript public readonly path: string; ``` - *Type:* string The path of this operation in the api. --- ##### `contentTypes`^Optional ```typescript public readonly contentTypes: string[]; ``` - *Type:* string[] - *Default:* application/json Content types accepted by this operation. --- ### ProjectCollections Collections of projects managed by type-safe-api. #### Initializer ```typescript import { ProjectCollections } from '@aws-prototyping-sdk/type-safe-api' const projectCollections: ProjectCollections = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | documentation | projen.Project[] | Array of all documentation projects. | | handlers | projen.Project[] | Array of all handler projects. | | infrastructure | projen.Project[] | Array of all infrastructure projects. | | libraries | projen.Project[] | Array of all library projects. | | model | projen.Project[] | Array of all model projects. | | projects | projen.Project[] | Array of all projects managed by type-safe-api. | | runtimes | projen.Project[] | Array of all runtime projects. | --- ##### `documentation`^Required ```typescript public readonly documentation: Project[]; ``` - *Type:* projen.Project[] Array of all documentation projects. --- ##### `handlers`^Required ```typescript public readonly handlers: Project[]; ``` - *Type:* projen.Project[] Array of all handler projects. --- ##### `infrastructure`^Required ```typescript public readonly infrastructure: Project[]; ``` - *Type:* projen.Project[] Array of all infrastructure projects. --- ##### `libraries`^Required ```typescript public readonly libraries: Project[]; ``` - *Type:* projen.Project[] Array of all library projects. --- ##### `model`^Required ```typescript public readonly model: Project[]; ``` - *Type:* projen.Project[] Array of all model projects. --- ##### `projects`^Required ```typescript public readonly projects: Project[]; ``` - *Type:* projen.Project[] Array of all projects managed by type-safe-api. --- ##### `runtimes`^Required ```typescript public readonly runtimes: Project[]; ``` - *Type:* projen.Project[] Array of all runtime projects. --- ### RuntimeConfiguration Configuration for generated runtime projects. #### Initializer ```typescript import { RuntimeConfiguration } from '@aws-prototyping-sdk/type-safe-api' const runtimeConfiguration: RuntimeConfiguration = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | languages | Language[] | The languages that runtime projects will be generated in. | | options | GeneratedRuntimeCodeOptions | Options for the generated runtimes. | --- ##### `languages`^Required ```typescript public readonly languages: Language[]; ``` - *Type:* Language[] The languages that runtime projects will be generated in. These projects can be used to provide type safety for both client and server projects. --- ##### `options`^Optional ```typescript public readonly options: GeneratedRuntimeCodeOptions; ``` - *Type:* GeneratedRuntimeCodeOptions Options for the generated runtimes. Note that only options provided for the specified languages will apply. --- ### SerializedCorsOptions Cross-origin resource sharing options. #### Initializer ```typescript import { SerializedCorsOptions } from '@aws-prototyping-sdk/type-safe-api' const serializedCorsOptions: SerializedCorsOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | allowHeaders | string[] | Headers to allow. | | allowMethods | string[] | HTTP methods to allow. | | allowOrigins | string[] | Origins to allow. | | statusCode | number | HTTP status code to be returned by preflight requests. | --- ##### `allowHeaders`^Required ```typescript public readonly allowHeaders: string[]; ``` - *Type:* string[] Headers to allow. --- ##### `allowMethods`^Required ```typescript public readonly allowMethods: string[]; ``` - *Type:* string[] HTTP methods to allow. --- ##### `allowOrigins`^Required ```typescript public readonly allowOrigins: string[]; ``` - *Type:* string[] Origins to allow. --- ##### `statusCode`^Required ```typescript public readonly statusCode: number; ``` - *Type:* number HTTP status code to be returned by preflight requests. --- ### SmithyBuildOptions Options for the smithy build files. #### Initializer ```typescript import { SmithyBuildOptions } from '@aws-prototyping-sdk/type-safe-api' const smithyBuildOptions: SmithyBuildOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | imports | string[] | List of imports. | | plugins | {[ key: string ]: {[ key: string ]: any}} | Plugins keyed by plugin id. | | additionalSources | string[] | Paths to any additional model files or directories to be used as sources for the smithy build. | | ignoreMissingPlugins | boolean | If a plugin can't be found, Smithy will by default fail the build. | | maven | SmithyMavenConfiguration | Maven configuration for the Smithy build project, used to specify dependencies and repositories in the build.gradle and smithy-build.json files. | | projections | {[ key: string ]: SmithyProjection} | Map of projections name to projection configurations https://awslabs.github.io/smithy/2.0/guides/building-models/build-config.html#projections. | --- ##### `imports`^Optional ```typescript public readonly imports: string[]; ``` - *Type:* string[] List of imports. --- ##### `plugins`^Optional ```typescript public readonly plugins: {[ key: string ]: {[ key: string ]: any}}; ``` - *Type:* {[ key: string ]: {[ key: string ]: any}} Plugins keyed by plugin id. --- ##### `additionalSources`^Optional ```typescript public readonly additionalSources: string[]; ``` - *Type:* string[] Paths to any additional model files or directories to be used as sources for the smithy build. The src/main/smithy directory is always included. Paths must be relative to the model project directory. Absolute paths will be resolved as relative paths. --- ##### `ignoreMissingPlugins`^Optional ```typescript public readonly ignoreMissingPlugins: boolean; ``` - *Type:* boolean - *Default:* no ignoreMissingPlugins set in the smithy-build.json file 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. --- ##### `maven`^Optional ```typescript public readonly maven: SmithyMavenConfiguration; ``` - *Type:* SmithyMavenConfiguration - *Default:* the default configuration required for Smithy to OpenAPI conversion Maven configuration for the Smithy build project, used to specify dependencies and repositories in the build.gradle and smithy-build.json files. --- ##### `projections`^Optional ```typescript public readonly projections: {[ key: string ]: SmithyProjection}; ``` - *Type:* {[ key: string ]: SmithyProjection} - *Default:* no projections Map of projections name to projection configurations https://awslabs.github.io/smithy/2.0/guides/building-models/build-config.html#projections. --- ### SmithyCommon Properties common to smithy plugins and the root smithy build. #### Initializer ```typescript import { SmithyCommon } from '@aws-prototyping-sdk/type-safe-api' const smithyCommon: SmithyCommon = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | imports | string[] | List of imports. | | plugins | {[ key: string ]: {[ key: string ]: any}} | Plugins keyed by plugin id. | --- ##### `imports`^Optional ```typescript public readonly imports: string[]; ``` - *Type:* string[] List of imports. --- ##### `plugins`^Optional ```typescript public readonly plugins: {[ key: string ]: {[ key: string ]: any}}; ``` - *Type:* {[ key: string ]: {[ key: string ]: any}} Plugins keyed by plugin id. --- ### SmithyDefinitionOptions Options for a smithy build project. #### Initializer ```typescript import { SmithyDefinitionOptions } from '@aws-prototyping-sdk/type-safe-api' const smithyDefinitionOptions: SmithyDefinitionOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | smithyOptions | SmithyModelOptions | Smithy engine options. | | handlerLanguages | Language[] | The languages users have specified for handler projects (if any). | --- ##### `smithyOptions`^Required ```typescript public readonly smithyOptions: SmithyModelOptions; ``` - *Type:* SmithyModelOptions Smithy engine options. --- ##### `handlerLanguages`^Optional ```typescript public readonly handlerLanguages: Language[]; ``` - *Type:* Language[] The languages users have specified for handler projects (if any). --- ### SmithyMavenConfiguration Configuration for smithy maven dependencies. #### Initializer ```typescript import { SmithyMavenConfiguration } from '@aws-prototyping-sdk/type-safe-api' const smithyMavenConfiguration: SmithyMavenConfiguration = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | dependencies | string[] | The dependencies used in the build.gradle and smithy-build.json files eg. software.amazon.smithy:smithy-validation-model:1.28.0 The following required dependencies are always added: - software.amazon.smithy:smithy-cli:1.28.0 - software.amazon.smithy:smithy-model:1.28.0 - software.amazon.smithy:smithy-openapi:1.28.0 - software.amazon.smithy:smithy-aws-traits:1.28.0 You can however override the version of these dependencies if required. | | repositoryUrls | string[] | The repository urls used in the build.gradle and smithy-build.json files. | --- ##### `dependencies`^Optional ```typescript public readonly dependencies: string[]; ``` - *Type:* string[] The dependencies used in the build.gradle and smithy-build.json files eg. software.amazon.smithy:smithy-validation-model:1.28.0 The following required dependencies are always added: - software.amazon.smithy:smithy-cli:1.28.0 - software.amazon.smithy:smithy-model:1.28.0 - software.amazon.smithy:smithy-openapi:1.28.0 - software.amazon.smithy:smithy-aws-traits:1.28.0 You can however override the version of these dependencies if required. --- ##### `repositoryUrls`^Optional ```typescript public readonly repositoryUrls: string[]; ``` - *Type:* string[] - *Default:* maven central and maven local The repository urls used in the build.gradle and smithy-build.json files. --- ### SmithyModelOptions Options for a Smithy model. #### Initializer ```typescript import { SmithyModelOptions } from '@aws-prototyping-sdk/type-safe-api' const smithyModelOptions: SmithyModelOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | serviceName | SmithyServiceName | Smithy service name. | | ignoreGradleWrapper | boolean | Set to false if you would like to check in your gradle wrapper. | | ignoreSmithyBuildOutput | boolean | Set to false if you would like to check in your smithy build output or have more fine-grained control over what is checked in, eg if you add other projections to the smithy-build.json file. | | smithyBuildOptions | SmithyBuildOptions | Smithy build options. | --- ##### `serviceName`^Required ```typescript public readonly serviceName: SmithyServiceName; ``` - *Type:* SmithyServiceName Smithy service name. --- ##### `ignoreGradleWrapper`^Optional ```typescript public readonly ignoreGradleWrapper: boolean; ``` - *Type:* boolean - *Default:* true Set to false if you would like to check in your gradle wrapper. Do so if you would like to use a different version of gradle to the one provided by default --- ##### `ignoreSmithyBuildOutput`^Optional ```typescript public readonly ignoreSmithyBuildOutput: boolean; ``` - *Type:* boolean - *Default:* true Set to false if you would like to check in your smithy build output or have more fine-grained control over what is checked in, eg if you add other projections to the smithy-build.json file. --- ##### `smithyBuildOptions`^Optional ```typescript public readonly smithyBuildOptions: SmithyBuildOptions; ``` - *Type:* SmithyBuildOptions Smithy build options. --- ### SmithyProjection A smithy build projection. #### Initializer ```typescript import { SmithyProjection } from '@aws-prototyping-sdk/type-safe-api' const smithyProjection: SmithyProjection = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | imports | string[] | List of imports. | | plugins | {[ key: string ]: {[ key: string ]: any}} | Plugins keyed by plugin id. | | abstract | boolean | Whether or not the projection is abstract. | | transforms | SmithyTransform[] | Transforms to apply to the projection. | --- ##### `imports`^Optional ```typescript public readonly imports: string[]; ``` - *Type:* string[] List of imports. --- ##### `plugins`^Optional ```typescript public readonly plugins: {[ key: string ]: {[ key: string ]: any}}; ``` - *Type:* {[ key: string ]: {[ key: string ]: any}} Plugins keyed by plugin id. --- ##### `abstract`^Optional ```typescript public readonly abstract: boolean; ``` - *Type:* boolean Whether or not the projection is abstract. --- ##### `transforms`^Optional ```typescript public readonly transforms: SmithyTransform[]; ``` - *Type:* SmithyTransform[] Transforms to apply to the projection. --- ### SmithyServiceName Represents a fully qualified name of a Smithy service. > [https://awslabs.github.io/smithy/2.0/spec/service-types.html](https://awslabs.github.io/smithy/2.0/spec/service-types.html) #### Initializer ```typescript import { SmithyServiceName } from '@aws-prototyping-sdk/type-safe-api' const smithyServiceName: SmithyServiceName = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | namespace | string | The service namespace. | | serviceName | string | The service name. | --- ##### `namespace`^Required ```typescript public readonly namespace: string; ``` - *Type:* string The service namespace. Nested namespaces are separated by '.', for example com.company > [https://awslabs.github.io/smithy/2.0/spec/model.html#shape-id](https://awslabs.github.io/smithy/2.0/spec/model.html#shape-id) --- ##### `serviceName`^Required ```typescript public readonly serviceName: string; ``` - *Type:* string The service name. Should be PascalCase, for example HelloService > [https://awslabs.github.io/smithy/2.0/spec/model.html#shape-id](https://awslabs.github.io/smithy/2.0/spec/model.html#shape-id) --- ### SmithyTransform A smithy build transform. #### Initializer ```typescript import { SmithyTransform } from '@aws-prototyping-sdk/type-safe-api' const smithyTransform: SmithyTransform = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | args | {[ key: string ]: any} | Arguments for the transform. | | name | string | Name of the transform. | --- ##### `args`^Required ```typescript public readonly args: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} Arguments for the transform. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name of the transform. --- ### TypeSafeApiIntegration Defines an integration for an individual API operation. #### Initializer ```typescript import { TypeSafeApiIntegration } from '@aws-prototyping-sdk/type-safe-api' const typeSafeApiIntegration: TypeSafeApiIntegration = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | integration | Integration | The integration to service the api operation. | | authorizer | Authorizer | The authorizer to use for this api operation (overrides the default). | | options | TypeSafeApiIntegrationOptions | Options for the integration. | --- ##### `integration`^Required ```typescript public readonly integration: Integration; ``` - *Type:* Integration The integration to service the api operation. --- ##### `authorizer`^Optional ```typescript public readonly authorizer: Authorizer; ``` - *Type:* Authorizer The authorizer to use for this api operation (overrides the default). --- ##### `options`^Optional ```typescript public readonly options: TypeSafeApiIntegrationOptions; ``` - *Type:* TypeSafeApiIntegrationOptions Options for the integration. --- ### TypeSafeApiIntegrationOptions Options for an integration. #### Initializer ```typescript import { TypeSafeApiIntegrationOptions } from '@aws-prototyping-sdk/type-safe-api' const typeSafeApiIntegrationOptions: TypeSafeApiIntegrationOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiKeyRequired | boolean | Require an API key to invoke this operation. | --- ##### `apiKeyRequired`^Optional ```typescript public readonly apiKeyRequired: boolean; ``` - *Type:* boolean - *Default:* false Require an API key to invoke this operation. Overrides the default setting if present. This is only applicable when the API key source is HEADER. --- ### TypeSafeApiModelProjectOptions #### Initializer ```typescript import { TypeSafeApiModelProjectOptions } from '@aws-prototyping-sdk/type-safe-api' const typeSafeApiModelProjectOptions: TypeSafeApiModelProjectOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | This is the name of your project. | | commitGenerated | boolean | Whether to commit the managed files by default. | | gitIgnoreOptions | projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | projen.GitOptions | Configuration options for git. | | logging | projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | string | The root directory of the project. | | parent | projen.Project | The parent project, if this project is part of a bigger project. | | projenCommand | string | The shell command to use in order to run the projen CLI. | | projenrcJson | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrcJsonOptions | projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | projen.RenovatebotOptions | Options for renovatebot. | | modelLanguage | ModelLanguage | Language the model is defined in. | | modelOptions | ModelOptions | Options for the model. | | handlerLanguages | Language[] | The languages users have specified for handler projects (if any). | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional ```typescript public readonly gitIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```typescript public readonly gitOptions: GitOptions; ``` - *Type:* projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```typescript public readonly logging: LoggerOptions; ``` - *Type:* projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```typescript public readonly outdir: string; ``` - *Type:* string - *Default:* "." The root directory of the project. Relative to this directory, all files are synthesized. If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects. --- ##### `parent`^Optional ```typescript public readonly parent: Project; ``` - *Type:* projen.Project The parent project, if this project is part of a bigger project. --- ##### `projenCommand`^Optional ```typescript public readonly projenCommand: string; ``` - *Type:* string - *Default:* "npx projen" The shell command to use in order to run the projen CLI. Can be used to customize in special environments. --- ##### `projenrcJson`^Optional ```typescript public readonly projenrcJson: boolean; ``` - *Type:* boolean - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrcJsonOptions`^Optional ```typescript public readonly projenrcJsonOptions: ProjenrcJsonOptions; ``` - *Type:* projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```typescript public readonly renovatebot: boolean; ``` - *Type:* boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```typescript public readonly renovatebotOptions: RenovatebotOptions; ``` - *Type:* projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `modelLanguage`^Required ```typescript public readonly modelLanguage: ModelLanguage; ``` - *Type:* ModelLanguage Language the model is defined in. --- ##### `modelOptions`^Required ```typescript public readonly modelOptions: ModelOptions; ``` - *Type:* ModelOptions Options for the model. --- ##### `handlerLanguages`^Optional ```typescript public readonly handlerLanguages: Language[]; ``` - *Type:* Language[] The languages users have specified for handler projects (if any). --- ### TypeSafeApiOptions Options required alongside an Open API specification to create API Gateway resources. #### Initializer ```typescript import { TypeSafeApiOptions } from '@aws-prototyping-sdk/type-safe-api' const typeSafeApiOptions: TypeSafeApiOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | integrations | {[ key: string ]: TypeSafeApiIntegration} | A mapping of API operation to its integration. | | operationLookup | {[ key: string ]: OperationDetails} | Details about each operation. | | apiKeyOptions | ApiKeyOptions | Options for API keys. | | corsOptions | aws-cdk-lib.aws_apigateway.CorsOptions | Cross Origin Resource Sharing options for the API. | | defaultAuthorizer | Authorizer | The default authorizer to use for your api. | --- ##### `integrations`^Required ```typescript public readonly integrations: {[ key: string ]: TypeSafeApiIntegration}; ``` - *Type:* {[ key: string ]: TypeSafeApiIntegration} A mapping of API operation to its integration. --- ##### `operationLookup`^Required ```typescript public readonly operationLookup: {[ key: string ]: OperationDetails}; ``` - *Type:* {[ key: string ]: OperationDetails} Details about each operation. --- ##### `apiKeyOptions`^Optional ```typescript public readonly apiKeyOptions: ApiKeyOptions; ``` - *Type:* ApiKeyOptions Options for API keys. --- ##### `corsOptions`^Optional ```typescript public readonly corsOptions: CorsOptions; ``` - *Type:* aws-cdk-lib.aws_apigateway.CorsOptions Cross Origin Resource Sharing options for the API. --- ##### `defaultAuthorizer`^Optional ```typescript public readonly defaultAuthorizer: Authorizer; ``` - *Type:* Authorizer The default authorizer to use for your api. When omitted, no default authorizer is used. Authorizers specified at the integration level will override this for that operation. --- ### TypeSafeApiProjectOptions Options for the TypeSafeApiProject. #### Initializer ```typescript import { TypeSafeApiProjectOptions } from '@aws-prototyping-sdk/type-safe-api' const typeSafeApiProjectOptions: TypeSafeApiProjectOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | This is the name of your project. | | commitGenerated | boolean | Whether to commit the managed files by default. | | gitIgnoreOptions | projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | projen.GitOptions | Configuration options for git. | | logging | projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | string | The root directory of the project. | | parent | projen.Project | The parent project, if this project is part of a bigger project. | | projenCommand | string | The shell command to use in order to run the projen CLI. | | projenrcJson | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrcJsonOptions | projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | projen.RenovatebotOptions | Options for renovatebot. | | infrastructure | InfrastructureConfiguration | Configuration for generated infrastructure. | | model | ModelConfiguration | Configuration for the API model. | | runtime | RuntimeConfiguration | Configuration for generated runtime projects (containing types, clients and server code). | | documentation | DocumentationConfiguration | Configuration for generated documentation. | | handlers | HandlersConfiguration | Configuration for lambda handlers for implementing the API. | | library | LibraryConfiguration | Configuration for generated libraries. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional ```typescript public readonly gitIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```typescript public readonly gitOptions: GitOptions; ``` - *Type:* projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```typescript public readonly logging: LoggerOptions; ``` - *Type:* projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```typescript public readonly outdir: string; ``` - *Type:* string - *Default:* "." The root directory of the project. Relative to this directory, all files are synthesized. If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects. --- ##### `parent`^Optional ```typescript public readonly parent: Project; ``` - *Type:* projen.Project The parent project, if this project is part of a bigger project. --- ##### `projenCommand`^Optional ```typescript public readonly projenCommand: string; ``` - *Type:* string - *Default:* "npx projen" The shell command to use in order to run the projen CLI. Can be used to customize in special environments. --- ##### `projenrcJson`^Optional ```typescript public readonly projenrcJson: boolean; ``` - *Type:* boolean - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrcJsonOptions`^Optional ```typescript public readonly projenrcJsonOptions: ProjenrcJsonOptions; ``` - *Type:* projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```typescript public readonly renovatebot: boolean; ``` - *Type:* boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```typescript public readonly renovatebotOptions: RenovatebotOptions; ``` - *Type:* projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `infrastructure`^Required ```typescript public readonly infrastructure: InfrastructureConfiguration; ``` - *Type:* InfrastructureConfiguration Configuration for generated infrastructure. --- ##### `model`^Required ```typescript public readonly model: ModelConfiguration; ``` - *Type:* ModelConfiguration Configuration for the API model. --- ##### `runtime`^Required ```typescript public readonly runtime: RuntimeConfiguration; ``` - *Type:* RuntimeConfiguration Configuration for generated runtime projects (containing types, clients and server code). --- ##### `documentation`^Optional ```typescript public readonly documentation: DocumentationConfiguration; ``` - *Type:* DocumentationConfiguration Configuration for generated documentation. --- ##### `handlers`^Optional ```typescript public readonly handlers: HandlersConfiguration; ``` - *Type:* HandlersConfiguration Configuration for lambda handlers for implementing the API. --- ##### `library`^Optional ```typescript public readonly library: LibraryConfiguration; ``` - *Type:* LibraryConfiguration Configuration for generated libraries. Libraries are projects which are generated from your model, but are not fully-fledged runtimes, for example react hooks or clients in languages that aren't supported as runtimes. --- ### TypeSafeApiWebAclOptions Configuration for the Web ACL associated with the API. #### Initializer ```typescript import { TypeSafeApiWebAclOptions } from '@aws-prototyping-sdk/type-safe-api' const typeSafeApiWebAclOptions: TypeSafeApiWebAclOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cidrAllowList | CidrAllowList | List of cidr ranges to allow. | | disable | boolean | If set to true, no WebACL will be associated with the API. | | managedRules | ManagedRule[] | List of managed rules to apply to the web acl. | --- ##### `cidrAllowList`^Optional ```typescript public readonly cidrAllowList: CidrAllowList; ``` - *Type:* CidrAllowList - *Default:* undefined List of cidr ranges to allow. --- ##### `disable`^Optional ```typescript public readonly disable: boolean; ``` - *Type:* boolean - *Default:* false If set to true, no WebACL will be associated with the API. You can also use this option if you would like to create your own WebACL and associate it yourself. --- ##### `managedRules`^Optional ```typescript public readonly managedRules: ManagedRule[]; ``` - *Type:* ManagedRule[] - *Default:* [{ vendor: "AWS", name: "AWSManagedRulesCommonRuleSet" }] List of managed rules to apply to the web acl. --- ### TypeSafeRestApiProps Configuration for the TypeSafeRestApi construct. #### Initializer ```typescript import { TypeSafeRestApiProps } from '@aws-prototyping-sdk/type-safe-api' const typeSafeRestApiProps: TypeSafeRestApiProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cloudWatchRole | boolean | Automatically configure an AWS CloudWatch role for API Gateway. | | deploy | boolean | Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes. | | deployOptions | aws-cdk-lib.aws_apigateway.StageOptions | Options for the API Gateway stage that will always point to the latest deployment when `deploy` is enabled. | | description | string | A description of the RestApi construct. | | disableExecuteApiEndpoint | boolean | Specifies whether clients can invoke the API using the default execute-api endpoint. | | domainName | aws-cdk-lib.aws_apigateway.DomainNameOptions | Configure a custom domain name and map it to this API. | | endpointExportName | string | Export name for the CfnOutput containing the API endpoint. | | endpointTypes | aws-cdk-lib.aws_apigateway.EndpointType[] | A list of the endpoint types of the API. | | failOnWarnings | boolean | Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource. | | parameters | {[ key: string ]: string} | Custom header parameters for the request. | | policy | aws-cdk-lib.aws_iam.PolicyDocument | A policy document that contains the permissions for this RestApi. | | restApiName | string | A name for the API Gateway RestApi resource. | | retainDeployments | boolean | Retains old deployment resources when the API changes. | | integrations | {[ key: string ]: TypeSafeApiIntegration} | A mapping of API operation to its integration. | | operationLookup | {[ key: string ]: OperationDetails} | Details about each operation. | | apiKeyOptions | ApiKeyOptions | Options for API keys. | | corsOptions | aws-cdk-lib.aws_apigateway.CorsOptions | Cross Origin Resource Sharing options for the API. | | defaultAuthorizer | Authorizer | The default authorizer to use for your api. | | specPath | string | Path to the JSON open api spec. | | minCompressionSize | aws-cdk-lib.Size | A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API. | | webAclOptions | TypeSafeApiWebAclOptions | Options for the AWS WAF v2 WebACL associated with the api. | --- ##### `cloudWatchRole`^Optional ```typescript public readonly cloudWatchRole: boolean; ``` - *Type:* boolean - *Default:* false if `@aws-cdk/aws-apigateway:disableCloudWatchRole` is enabled, true otherwise Automatically configure an AWS CloudWatch role for API Gateway. --- ##### `deploy`^Optional ```typescript public readonly deploy: boolean; ``` - *Type:* boolean - *Default:* true Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes. Since API Gateway deployments are immutable, When this option is enabled (by default), an AWS::ApiGateway::Deployment resource will automatically created with a logical ID that hashes the API model (methods, resources and options). This means that when the model changes, the logical ID of this CloudFormation resource will change, and a new deployment will be created. If this is set, `latestDeployment` will refer to the `Deployment` object and `deploymentStage` will refer to a `Stage` that points to this deployment. To customize the stage options, use the `deployOptions` property. A CloudFormation Output will also be defined with the root URL endpoint of this REST API. --- ##### `deployOptions`^Optional ```typescript public readonly deployOptions: StageOptions; ``` - *Type:* aws-cdk-lib.aws_apigateway.StageOptions - *Default:* Based on defaults of `StageOptions`. Options for the API Gateway stage that will always point to the latest deployment when `deploy` is enabled. If `deploy` is disabled, this value cannot be set. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* 'Automatically created by the RestApi construct' A description of the RestApi construct. --- ##### `disableExecuteApiEndpoint`^Optional ```typescript public readonly disableExecuteApiEndpoint: boolean; ``` - *Type:* boolean - *Default:* false Specifies whether clients can invoke the API using the default execute-api endpoint. To require that clients use a custom domain name to invoke the API, disable the default endpoint. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) --- ##### `domainName`^Optional ```typescript public readonly domainName: DomainNameOptions; ``` - *Type:* aws-cdk-lib.aws_apigateway.DomainNameOptions - *Default:* no domain name is defined, use `addDomainName` or directly define a `DomainName`. Configure a custom domain name and map it to this API. --- ##### `endpointExportName`^Optional ```typescript public readonly endpointExportName: string; ``` - *Type:* string - *Default:* when no export name is given, output will be created without export Export name for the CfnOutput containing the API endpoint. --- ##### `endpointTypes`^Optional ```typescript public readonly endpointTypes: EndpointType[]; ``` - *Type:* aws-cdk-lib.aws_apigateway.EndpointType[] - *Default:* EndpointType.EDGE A list of the endpoint types of the API. Use this property when creating an API. --- ##### `failOnWarnings`^Optional ```typescript public readonly failOnWarnings: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource. --- ##### `parameters`^Optional ```typescript public readonly parameters: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* No parameters. Custom header parameters for the request. > [https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-rest-api.html](https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-rest-api.html) --- ##### `policy`^Optional ```typescript public readonly policy: PolicyDocument; ``` - *Type:* aws-cdk-lib.aws_iam.PolicyDocument - *Default:* No policy. A policy document that contains the permissions for this RestApi. --- ##### `restApiName`^Optional ```typescript public readonly restApiName: string; ``` - *Type:* string - *Default:* ID of the RestApi construct. A name for the API Gateway RestApi resource. --- ##### `retainDeployments`^Optional ```typescript public readonly retainDeployments: boolean; ``` - *Type:* boolean - *Default:* false Retains old deployment resources when the API changes. This allows manually reverting stages to point to old deployments via the AWS Console. --- ##### `integrations`^Required ```typescript public readonly integrations: {[ key: string ]: TypeSafeApiIntegration}; ``` - *Type:* {[ key: string ]: TypeSafeApiIntegration} A mapping of API operation to its integration. --- ##### `operationLookup`^Required ```typescript public readonly operationLookup: {[ key: string ]: OperationDetails}; ``` - *Type:* {[ key: string ]: OperationDetails} Details about each operation. --- ##### `apiKeyOptions`^Optional ```typescript public readonly apiKeyOptions: ApiKeyOptions; ``` - *Type:* ApiKeyOptions Options for API keys. --- ##### `corsOptions`^Optional ```typescript public readonly corsOptions: CorsOptions; ``` - *Type:* aws-cdk-lib.aws_apigateway.CorsOptions Cross Origin Resource Sharing options for the API. --- ##### `defaultAuthorizer`^Optional ```typescript public readonly defaultAuthorizer: Authorizer; ``` - *Type:* Authorizer The default authorizer to use for your api. When omitted, no default authorizer is used. Authorizers specified at the integration level will override this for that operation. --- ##### `specPath`^Required ```typescript public readonly specPath: string; ``` - *Type:* string Path to the JSON open api spec. --- ##### `minCompressionSize`^Optional ```typescript public readonly minCompressionSize: Size; ``` - *Type:* aws-cdk-lib.Size - *Default:* Compression is disabled. A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size. --- ##### `webAclOptions`^Optional ```typescript public readonly webAclOptions: TypeSafeApiWebAclOptions; ``` - *Type:* TypeSafeApiWebAclOptions Options for the AWS WAF v2 WebACL associated with the api. By default, a Web ACL with the AWS default managed rule set will be associated with the API. These options may disable or override the defaults. --- ## Classes ### Authorizer An authorizer for authorizing API requests. #### Initializers ```typescript import { Authorizer } from '@aws-prototyping-sdk/type-safe-api' new Authorizer(props: AuthorizerProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | AuthorizerProps | *No description.* | --- ##### `props`^Required - *Type:* AuthorizerProps --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | authorizationType | aws-cdk-lib.aws_apigateway.AuthorizationType | The type of the authorizer. | | authorizerId | string | The unique identifier for the authorizer. | | authorizationScopes | string[] | Scopes for the authorizer, if any. | --- ##### `authorizationType`^Required ```typescript public readonly authorizationType: AuthorizationType; ``` - *Type:* aws-cdk-lib.aws_apigateway.AuthorizationType The type of the authorizer. --- ##### `authorizerId`^Required ```typescript public readonly authorizerId: string; ``` - *Type:* string The unique identifier for the authorizer. --- ##### `authorizationScopes`^Optional ```typescript public readonly authorizationScopes: string[]; ``` - *Type:* string[] Scopes for the authorizer, if any. --- ### Authorizers Class used to construct authorizers for use in the OpenApiGatewayLambdaApi construct. #### Initializers ```typescript import { Authorizers } from '@aws-prototyping-sdk/type-safe-api' new Authorizers() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Static Functions | **Name** | **Description** | | --- | --- | | cognito | A Cognito User Pools authorizer. | | custom | A custom authorizer. | | iam | An IAM authorizer which uses AWS signature version 4 to authorize requests. | | none | No authorizer. | --- ##### `cognito` ```typescript import { Authorizers } from '@aws-prototyping-sdk/type-safe-api' Authorizers.cognito(props: CognitoAuthorizerProps) ``` A Cognito User Pools authorizer. ###### `props`^Required - *Type:* CognitoAuthorizerProps --- ##### `custom` ```typescript import { Authorizers } from '@aws-prototyping-sdk/type-safe-api' Authorizers.custom(props: CustomAuthorizerProps) ``` A custom authorizer. ###### `props`^Required - *Type:* CustomAuthorizerProps --- ##### `iam` ```typescript import { Authorizers } from '@aws-prototyping-sdk/type-safe-api' Authorizers.iam() ``` An IAM authorizer which uses AWS signature version 4 to authorize requests. ##### `none` ```typescript import { Authorizers } from '@aws-prototyping-sdk/type-safe-api' Authorizers.none() ``` No authorizer. ### CognitoAuthorizer An authorizer that uses Cognito identity or access tokens. #### Initializers ```typescript import { CognitoAuthorizer } from '@aws-prototyping-sdk/type-safe-api' new CognitoAuthorizer(props: CognitoAuthorizerProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | CognitoAuthorizerProps | *No description.* | --- ##### `props`^Required - *Type:* CognitoAuthorizerProps --- #### Methods | **Name** | **Description** | | --- | --- | | withScopes | Returns this authorizer with scopes applied, intended for usage in individual operations where scopes may differ on a per-operation basis. | --- ##### `withScopes` ```typescript public withScopes(authorizationScopes: string): CognitoAuthorizer ``` Returns this authorizer with scopes applied, intended for usage in individual operations where scopes may differ on a per-operation basis. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes) ###### `authorizationScopes`^Required - *Type:* string the scopes to apply. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | authorizationType | aws-cdk-lib.aws_apigateway.AuthorizationType | The type of the authorizer. | | authorizerId | string | The unique identifier for the authorizer. | | authorizationScopes | string[] | Scopes for the authorizer, if any. | | userPools | aws-cdk-lib.aws_cognito.IUserPool[] | The Cognito user pools associated with this authorizer. | --- ##### `authorizationType`^Required ```typescript public readonly authorizationType: AuthorizationType; ``` - *Type:* aws-cdk-lib.aws_apigateway.AuthorizationType The type of the authorizer. --- ##### `authorizerId`^Required ```typescript public readonly authorizerId: string; ``` - *Type:* string The unique identifier for the authorizer. --- ##### `authorizationScopes`^Optional ```typescript public readonly authorizationScopes: string[]; ``` - *Type:* string[] Scopes for the authorizer, if any. --- ##### `userPools`^Required ```typescript public readonly userPools: IUserPool[]; ``` - *Type:* aws-cdk-lib.aws_cognito.IUserPool[] The Cognito user pools associated with this authorizer. --- ### CustomAuthorizer An authorizer that uses a lambda function to authorize requests. #### Initializers ```typescript import { CustomAuthorizer } from '@aws-prototyping-sdk/type-safe-api' new CustomAuthorizer(props: CustomAuthorizerProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | CustomAuthorizerProps | *No description.* | --- ##### `props`^Required - *Type:* CustomAuthorizerProps --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | authorizationType | aws-cdk-lib.aws_apigateway.AuthorizationType | The type of the authorizer. | | authorizerId | string | The unique identifier for the authorizer. | | authorizationScopes | string[] | Scopes for the authorizer, if any. | | authorizerResultTtlInSeconds | number | The number of seconds during which the authorizer result is cached. | | function | aws-cdk-lib.aws_lambda.IFunction | The lambda function used to authorize requests. | | identitySource | string | The source of the identity in an incoming request. | | type | CustomAuthorizerType | The type of custom authorizer. | --- ##### `authorizationType`^Required ```typescript public readonly authorizationType: AuthorizationType; ``` - *Type:* aws-cdk-lib.aws_apigateway.AuthorizationType The type of the authorizer. --- ##### `authorizerId`^Required ```typescript public readonly authorizerId: string; ``` - *Type:* string The unique identifier for the authorizer. --- ##### `authorizationScopes`^Optional ```typescript public readonly authorizationScopes: string[]; ``` - *Type:* string[] Scopes for the authorizer, if any. --- ##### `authorizerResultTtlInSeconds`^Required ```typescript public readonly authorizerResultTtlInSeconds: number; ``` - *Type:* number The number of seconds during which the authorizer result is cached. --- ##### `function`^Required ```typescript public readonly function: IFunction; ``` - *Type:* aws-cdk-lib.aws_lambda.IFunction The lambda function used to authorize requests. --- ##### `identitySource`^Required ```typescript public readonly identitySource: string; ``` - *Type:* string The source of the identity in an incoming request. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identitysource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identitysource) --- ##### `type`^Required ```typescript public readonly type: CustomAuthorizerType; ``` - *Type:* CustomAuthorizerType The type of custom authorizer. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-type) --- ### IamAuthorizer An IAM authorizer. #### Initializers ```typescript import { IamAuthorizer } from '@aws-prototyping-sdk/type-safe-api' new IamAuthorizer() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | authorizationType | aws-cdk-lib.aws_apigateway.AuthorizationType | The type of the authorizer. | | authorizerId | string | The unique identifier for the authorizer. | | authorizationScopes | string[] | Scopes for the authorizer, if any. | --- ##### `authorizationType`^Required ```typescript public readonly authorizationType: AuthorizationType; ``` - *Type:* aws-cdk-lib.aws_apigateway.AuthorizationType The type of the authorizer. --- ##### `authorizerId`^Required ```typescript public readonly authorizerId: string; ``` - *Type:* string The unique identifier for the authorizer. --- ##### `authorizationScopes`^Optional ```typescript public readonly authorizationScopes: string[]; ``` - *Type:* string[] Scopes for the authorizer, if any. --- ### Integration An integration for an API operation. You can extend this to implement your own integration if you like. #### Initializers ```typescript import { Integration } from '@aws-prototyping-sdk/type-safe-api' new Integration() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | grant | Grant permissions for the API to invoke the integration. | | render | Render the integration into an API Gateway OpenAPI extension. | --- ##### `grant` ```typescript public grant(_props: IntegrationGrantProps): void ``` Grant permissions for the API to invoke the integration. ###### `_props`^Required - *Type:* IntegrationGrantProps --- ##### `render` ```typescript public render(props: IntegrationRenderProps): ApiGatewayIntegration ``` Render the integration into an API Gateway OpenAPI extension. ###### `props`^Required - *Type:* IntegrationRenderProps --- ### Integrations A collection of integrations to connect API operations with a backend to service requests. #### Initializers ```typescript import { Integrations } from '@aws-prototyping-sdk/type-safe-api' new Integrations() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Static Functions | **Name** | **Description** | | --- | --- | | lambda | An integration that invokes a lambda function to service the request. | | mock | An integration that returns a hardcoded response. | --- ##### `lambda` ```typescript import { Integrations } from '@aws-prototyping-sdk/type-safe-api' Integrations.lambda(lambdaFunction: IFunction) ``` An integration that invokes a lambda function to service the request. ###### `lambdaFunction`^Required - *Type:* aws-cdk-lib.aws_lambda.IFunction the function to invoke. --- ##### `mock` ```typescript import { Integrations } from '@aws-prototyping-sdk/type-safe-api' Integrations.mock(response: MockIntegrationResponse) ``` An integration that returns a hardcoded response. ###### `response`^Required - *Type:* MockIntegrationResponse the response to return. --- ### LambdaIntegration A lambda integration. #### Initializers ```typescript import { LambdaIntegration } from '@aws-prototyping-sdk/type-safe-api' new LambdaIntegration(lambdaFunction: IFunction) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | lambdaFunction | aws-cdk-lib.aws_lambda.IFunction | *No description.* | --- ##### `lambdaFunction`^Required - *Type:* aws-cdk-lib.aws_lambda.IFunction --- #### Methods | **Name** | **Description** | | --- | --- | | grant | Grant API Gateway permissions to invoke the lambda. | | render | Render the lambda integration as a snippet of OpenAPI. | --- ##### `grant` ```typescript public grant(__0: IntegrationGrantProps): void ``` Grant API Gateway permissions to invoke the lambda. ###### `__0`^Required - *Type:* IntegrationGrantProps --- ##### `render` ```typescript public render(props: IntegrationRenderProps): ApiGatewayIntegration ``` Render the lambda integration as a snippet of OpenAPI. ###### `props`^Required - *Type:* IntegrationRenderProps --- ### MockIntegration A mock integration to return a hardcoded response. > [https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-mock-integration.html](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-mock-integration.html) #### Initializers ```typescript import { MockIntegration } from '@aws-prototyping-sdk/type-safe-api' new MockIntegration(props: MockIntegrationResponse) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | MockIntegrationResponse | *No description.* | --- ##### `props`^Required - *Type:* MockIntegrationResponse --- #### Methods | **Name** | **Description** | | --- | --- | | grant | Grant permissions for the API to invoke the integration. | | render | Render the integration into an API Gateway OpenAPI extension. | --- ##### `grant` ```typescript public grant(_props: IntegrationGrantProps): void ``` Grant permissions for the API to invoke the integration. ###### `_props`^Required - *Type:* IntegrationGrantProps --- ##### `render` ```typescript public render(props: IntegrationRenderProps): ApiGatewayIntegration ``` Render the integration into an API Gateway OpenAPI extension. ###### `props`^Required - *Type:* IntegrationRenderProps --- ### NoneAuthorizer No authorizer. #### Initializers ```typescript import { NoneAuthorizer } from '@aws-prototyping-sdk/type-safe-api' new NoneAuthorizer() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | authorizationType | aws-cdk-lib.aws_apigateway.AuthorizationType | The type of the authorizer. | | authorizerId | string | The unique identifier for the authorizer. | | authorizationScopes | string[] | Scopes for the authorizer, if any. | --- ##### `authorizationType`^Required ```typescript public readonly authorizationType: AuthorizationType; ``` - *Type:* aws-cdk-lib.aws_apigateway.AuthorizationType The type of the authorizer. --- ##### `authorizerId`^Required ```typescript public readonly authorizerId: string; ``` - *Type:* string The unique identifier for the authorizer. --- ##### `authorizationScopes`^Optional ```typescript public readonly authorizationScopes: string[]; ``` - *Type:* string[] Scopes for the authorizer, if any. --- ### OpenApiDefinition The OpenAPI Spec. #### Initializers ```typescript import { OpenApiDefinition } from '@aws-prototyping-sdk/type-safe-api' new OpenApiDefinition(project: TypeSafeApiModelProject, options: OpenApiDefinitionOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | project | TypeSafeApiModelProject | *No description.* | | options | OpenApiDefinitionOptions | *No description.* | --- ##### `project`^Required - *Type:* TypeSafeApiModelProject --- ##### `options`^Required - *Type:* OpenApiDefinitionOptions --- #### Methods | **Name** | **Description** | | --- | --- | | postSynthesize | Called after synthesis. | | preSynthesize | Called before synthesis. | | synthesize | Synthesizes files to the project output directory. | --- ##### `postSynthesize` ```typescript public postSynthesize(): void ``` Called after synthesis. Order is *not* guaranteed. ##### `preSynthesize` ```typescript public preSynthesize(): void ``` Called before synthesis. ##### `synthesize` ```typescript public synthesize(): void ``` Synthesizes files to the project output directory. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | project | projen.Project | *No description.* | | openApiSpecificationPath | string | Path to the root OpenAPI specification file. | --- ##### `project`^Required ```typescript public readonly project: Project; ``` - *Type:* projen.Project --- ##### `openApiSpecificationPath`^Required ```typescript public readonly openApiSpecificationPath: string; ``` - *Type:* string Path to the root OpenAPI specification file. --- ### SmithyDefinition Creates a project which transforms a Smithy model to OpenAPI. #### Initializers ```typescript import { SmithyDefinition } from '@aws-prototyping-sdk/type-safe-api' new SmithyDefinition(project: TypeSafeApiModelProject, options: SmithyDefinitionOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | project | TypeSafeApiModelProject | *No description.* | | options | SmithyDefinitionOptions | *No description.* | --- ##### `project`^Required - *Type:* TypeSafeApiModelProject --- ##### `options`^Required - *Type:* SmithyDefinitionOptions --- #### Methods | **Name** | **Description** | | --- | --- | | postSynthesize | Called after synthesis. | | preSynthesize | Called before synthesis. | | synthesize | Synthesizes files to the project output directory. | | addDeps | Add maven-style or local file dependencies to the smithy model project. | | addSmithyDeps | Add dependencies on other smithy models, such that their shapes can be imported in this project. | | addSources | Add additional paths to model source files or directories. | --- ##### `postSynthesize` ```typescript public postSynthesize(): void ``` Called after synthesis. Order is *not* guaranteed. ##### `preSynthesize` ```typescript public preSynthesize(): void ``` Called before synthesis. ##### `synthesize` ```typescript public synthesize(): void ``` Synthesizes files to the project output directory. ##### `addDeps` ```typescript public addDeps(deps: string): void ``` Add maven-style or local file dependencies to the smithy model project. ###### `deps`^Required - *Type:* string dependencies to add, eg "software.amazon.smithy:smithy-validation-model:1.27.2" or "file://../some/path/build/lib/my-shapes.jar. --- ##### `addSmithyDeps` ```typescript public addSmithyDeps(deps: SmithyDefinition): void ``` Add dependencies on other smithy models, such that their shapes can be imported in this project. ###### `deps`^Required - *Type:* SmithyDefinition smithy definitions to depend on. --- ##### `addSources` ```typescript public addSources(sources: string): void ``` Add additional paths to model source files or directories. Paths should be relative to the project outdir. Any absolute paths will be resolved as relative paths. ###### `sources`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | project | projen.Project | *No description.* | | gradleProjectName | string | Name of the gradle project. | | openApiSpecificationPath | string | Path to the generated OpenAPI specification, relative to the project outdir. | | smithyJsonModelPath | string | Path to the json Smithy model, relative to the project outdir. | --- ##### `project`^Required ```typescript public readonly project: Project; ``` - *Type:* projen.Project --- ##### `gradleProjectName`^Required ```typescript public readonly gradleProjectName: string; ``` - *Type:* string Name of the gradle project. --- ##### `openApiSpecificationPath`^Required ```typescript public readonly openApiSpecificationPath: string; ``` - *Type:* string Path to the generated OpenAPI specification, relative to the project outdir. --- ##### `smithyJsonModelPath`^Required ```typescript public readonly smithyJsonModelPath: string; ``` - *Type:* string Path to the json Smithy model, relative to the project outdir. --- ### TypeSafeApiModelProject #### Initializers ```typescript import { TypeSafeApiModelProject } from '@aws-prototyping-sdk/type-safe-api' new TypeSafeApiModelProject(options: TypeSafeApiModelProjectOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | options | TypeSafeApiModelProjectOptions | *No description.* | --- ##### `options`^Required - *Type:* TypeSafeApiModelProjectOptions --- #### Methods | **Name** | **Description** | | --- | --- | | addExcludeFromCleanup | Exclude the matching files from pre-synth cleanup. | | addGitIgnore | Adds a .gitignore pattern. | | addPackageIgnore | Exclude these files from the bundled package. | | addTask | Adds a new task to this project. | | addTip | Prints a "tip" message during synthesis. | | annotateGenerated | Consider a set of files as "generated". | | postSynthesize | Called after all components are synthesized. | | preSynthesize | Called before all components are synthesized. | | removeTask | Removes a task from a project. | | runTaskCommand | Returns the shell command to execute in order to run a task. | | synth | Synthesize all project files into `outdir`. | | tryFindFile | Finds a file at the specified relative path within this project and all its subprojects. | | tryFindJsonFile | Finds a json file by name. | | tryFindObjectFile | Finds an object file (like JsonFile, YamlFile, etc.) by name. | | tryRemoveFile | Finds a file at the specified relative path within this project and removes it. | --- ##### `addExcludeFromCleanup` ```typescript public addExcludeFromCleanup(globs: string): void ``` Exclude the matching files from pre-synth cleanup. Can be used when, for example, some source files include the projen marker and we don't want them to be erased during synth. ###### `globs`^Required - *Type:* string The glob patterns to match. --- ##### `addGitIgnore` ```typescript public addGitIgnore(pattern: string): void ``` Adds a .gitignore pattern. ###### `pattern`^Required - *Type:* string The glob pattern to ignore. --- ##### `addPackageIgnore` ```typescript public addPackageIgnore(_pattern: string): void ``` Exclude these files from the bundled package. Implemented by project types based on the packaging mechanism. For example, `NodeProject` delegates this to `.npmignore`. ###### `_pattern`^Required - *Type:* string The glob pattern to exclude. --- ##### `addTask` ```typescript public addTask(name: string, props?: TaskOptions): Task ``` Adds a new task to this project. This will fail if the project already has a task with this name. ###### `name`^Required - *Type:* string The task name to add. --- ###### `props`^Optional - *Type:* projen.TaskOptions Task properties. --- ##### ~~`addTip`~~ ```typescript public addTip(message: string): void ``` Prints a "tip" message during synthesis. ###### `message`^Required - *Type:* string The message. --- ##### `annotateGenerated` ```typescript public annotateGenerated(_glob: string): void ``` Consider a set of files as "generated". This method is implemented by derived classes and used for example, to add git attributes to tell GitHub that certain files are generated. ###### `_glob`^Required - *Type:* string the glob pattern to match (could be a file path). --- ##### `postSynthesize` ```typescript public postSynthesize(): void ``` Called after all components are synthesized. Order is *not* guaranteed. ##### `preSynthesize` ```typescript public preSynthesize(): void ``` Called before all components are synthesized. ##### `removeTask` ```typescript public removeTask(name: string): Task ``` Removes a task from a project. ###### `name`^Required - *Type:* string The name of the task to remove. --- ##### `runTaskCommand` ```typescript public runTaskCommand(task: Task): string ``` Returns the shell command to execute in order to run a task. By default, this is `npx projen@ ` ###### `task`^Required - *Type:* projen.Task The task for which the command is required. --- ##### `synth` ```typescript public synth(): void ``` Synthesize all project files into `outdir`. 1. Call "this.preSynthesize()" 2. Delete all generated files 3. Synthesize all sub-projects 4. Synthesize all components of this project 5. Call "postSynthesize()" for all components of this project 6. Call "this.postSynthesize()" ##### `tryFindFile` ```typescript public tryFindFile(filePath: string): FileBase ``` Finds a file at the specified relative path within this project and all its subprojects. ###### `filePath`^Required - *Type:* string The file path. If this path is relative, it will be resolved from the root of _this_ project. --- ##### ~~`tryFindJsonFile`~~ ```typescript public tryFindJsonFile(filePath: string): JsonFile ``` Finds a json file by name. ###### `filePath`^Required - *Type:* string The file path. --- ##### `tryFindObjectFile` ```typescript public tryFindObjectFile(filePath: string): ObjectFile ``` Finds an object file (like JsonFile, YamlFile, etc.) by name. ###### `filePath`^Required - *Type:* string The file path. --- ##### `tryRemoveFile` ```typescript public tryRemoveFile(filePath: string): FileBase ``` Finds a file at the specified relative path within this project and removes it. ###### `filePath`^Required - *Type:* string The file path. If this path is relative, it will be resolved from the root of _this_ project. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | buildTask | projen.Task | *No description.* | | commitGenerated | boolean | Whether to commit the managed files by default. | | compileTask | projen.Task | *No description.* | | components | projen.Component[] | Returns all the components within this project. | | deps | projen.Dependencies | Project dependencies. | | ejected | boolean | Whether or not the project is being ejected. | | files | projen.FileBase[] | All files in this project. | | gitattributes | projen.GitAttributesFile | The .gitattributes file for this repository. | | gitignore | projen.IgnoreFile | .gitignore. | | logger | projen.Logger | Logging utilities. | | name | string | Project name. | | outdir | string | Absolute output directory of this project. | | packageTask | projen.Task | *No description.* | | postCompileTask | projen.Task | *No description.* | | preCompileTask | projen.Task | *No description.* | | projectBuild | projen.ProjectBuild | Manages the build process of the project. | | projenCommand | string | The command to use in order to run the projen CLI. | | root | projen.Project | The root project. | | subprojects | projen.Project[] | Returns all the subprojects within this project. | | tasks | projen.Tasks | Project tasks. | | testTask | projen.Task | *No description.* | | defaultTask | projen.Task | This is the "default" task, the one that executes "projen". | | initProject | projen.InitProject | The options used when this project is bootstrapped via `projen new`. | | parent | projen.Project | A parent project. | | generateTask | projen.Task | Reference to the task used for generating the final bundled OpenAPI specification. | | parsedSpecFile | string | Name of the final bundled OpenAPI specification. | | openapi | OpenApiDefinition | Reference to the OpenAPI definition component. | | smithy | SmithyDefinition | Reference to the Smithy definition component. | --- ##### `buildTask`^Required ```typescript public readonly buildTask: Task; ``` - *Type:* projen.Task --- ##### `commitGenerated`^Required ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean Whether to commit the managed files by default. --- ##### `compileTask`^Required ```typescript public readonly compileTask: Task; ``` - *Type:* projen.Task --- ##### `components`^Required ```typescript public readonly components: Component[]; ``` - *Type:* projen.Component[] Returns all the components within this project. --- ##### `deps`^Required ```typescript public readonly deps: Dependencies; ``` - *Type:* projen.Dependencies Project dependencies. --- ##### `ejected`^Required ```typescript public readonly ejected: boolean; ``` - *Type:* boolean Whether or not the project is being ejected. --- ##### `files`^Required ```typescript public readonly files: FileBase[]; ``` - *Type:* projen.FileBase[] All files in this project. --- ##### `gitattributes`^Required ```typescript public readonly gitattributes: GitAttributesFile; ``` - *Type:* projen.GitAttributesFile The .gitattributes file for this repository. --- ##### `gitignore`^Required ```typescript public readonly gitignore: IgnoreFile; ``` - *Type:* projen.IgnoreFile .gitignore. --- ##### `logger`^Required ```typescript public readonly logger: Logger; ``` - *Type:* projen.Logger Logging utilities. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Project name. --- ##### `outdir`^Required ```typescript public readonly outdir: string; ``` - *Type:* string Absolute output directory of this project. --- ##### `packageTask`^Required ```typescript public readonly packageTask: Task; ``` - *Type:* projen.Task --- ##### `postCompileTask`^Required ```typescript public readonly postCompileTask: Task; ``` - *Type:* projen.Task --- ##### `preCompileTask`^Required ```typescript public readonly preCompileTask: Task; ``` - *Type:* projen.Task --- ##### `projectBuild`^Required ```typescript public readonly projectBuild: ProjectBuild; ``` - *Type:* projen.ProjectBuild Manages the build process of the project. --- ##### `projenCommand`^Required ```typescript public readonly projenCommand: string; ``` - *Type:* string The command to use in order to run the projen CLI. --- ##### `root`^Required ```typescript public readonly root: Project; ``` - *Type:* projen.Project The root project. --- ##### `subprojects`^Required ```typescript public readonly subprojects: Project[]; ``` - *Type:* projen.Project[] Returns all the subprojects within this project. --- ##### `tasks`^Required ```typescript public readonly tasks: Tasks; ``` - *Type:* projen.Tasks Project tasks. --- ##### `testTask`^Required ```typescript public readonly testTask: Task; ``` - *Type:* projen.Task --- ##### `defaultTask`^Optional ```typescript public readonly defaultTask: Task; ``` - *Type:* projen.Task This is the "default" task, the one that executes "projen". Undefined if the project is being ejected. --- ##### `initProject`^Optional ```typescript public readonly initProject: InitProject; ``` - *Type:* projen.InitProject The options used when this project is bootstrapped via `projen new`. It includes the original set of options passed to the CLI and also the JSII FQN of the project type. --- ##### `parent`^Optional ```typescript public readonly parent: Project; ``` - *Type:* projen.Project A parent project. If undefined, this is the root project. --- ##### `generateTask`^Required ```typescript public readonly generateTask: Task; ``` - *Type:* projen.Task Reference to the task used for generating the final bundled OpenAPI specification. --- ##### `parsedSpecFile`^Required ```typescript public readonly parsedSpecFile: string; ``` - *Type:* string Name of the final bundled OpenAPI specification. --- ##### `openapi`^Optional ```typescript public readonly openapi: OpenApiDefinition; ``` - *Type:* OpenApiDefinition Reference to the OpenAPI definition component. Will be defined if the model language is OpenAPI --- ##### `smithy`^Optional ```typescript public readonly smithy: SmithyDefinition; ``` - *Type:* SmithyDefinition Reference to the Smithy definition component. Will be defined if the model language is Smithy --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_TASK | string | The name of the default task (the task executed when `projen` is run without arguments). | --- ##### `DEFAULT_TASK`^Required ```typescript public readonly DEFAULT_TASK: string; ``` - *Type:* string The name of the default task (the task executed when `projen` is run without arguments). Normally this task should synthesize the project files. --- ### TypeSafeApiProject Project for a type-safe API, defined using Smithy or OpenAPI. Generates a CDK construct to deploy your API, as well as client and server code to help build your API quickly. #### Initializers ```typescript import { TypeSafeApiProject } from '@aws-prototyping-sdk/type-safe-api' new TypeSafeApiProject(options: TypeSafeApiProjectOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | options | TypeSafeApiProjectOptions | *No description.* | --- ##### `options`^Required - *Type:* TypeSafeApiProjectOptions --- #### Methods | **Name** | **Description** | | --- | --- | | addExcludeFromCleanup | Exclude the matching files from pre-synth cleanup. | | addGitIgnore | Adds a .gitignore pattern. | | addPackageIgnore | Exclude these files from the bundled package. | | addTask | Adds a new task to this project. | | addTip | Prints a "tip" message during synthesis. | | annotateGenerated | Consider a set of files as "generated". | | postSynthesize | Called after all components are synthesized. | | preSynthesize | Called before all components are synthesized. | | removeTask | Removes a task from a project. | | runTaskCommand | Returns the shell command to execute in order to run a task. | | synth | Synthesize all project files into `outdir`. | | tryFindFile | Finds a file at the specified relative path within this project and all its subprojects. | | tryFindJsonFile | Finds a json file by name. | | tryFindObjectFile | Finds an object file (like JsonFile, YamlFile, etc.) by name. | | tryRemoveFile | Finds a file at the specified relative path within this project and removes it. | --- ##### `addExcludeFromCleanup` ```typescript public addExcludeFromCleanup(globs: string): void ``` Exclude the matching files from pre-synth cleanup. Can be used when, for example, some source files include the projen marker and we don't want them to be erased during synth. ###### `globs`^Required - *Type:* string The glob patterns to match. --- ##### `addGitIgnore` ```typescript public addGitIgnore(pattern: string): void ``` Adds a .gitignore pattern. ###### `pattern`^Required - *Type:* string The glob pattern to ignore. --- ##### `addPackageIgnore` ```typescript public addPackageIgnore(_pattern: string): void ``` Exclude these files from the bundled package. Implemented by project types based on the packaging mechanism. For example, `NodeProject` delegates this to `.npmignore`. ###### `_pattern`^Required - *Type:* string The glob pattern to exclude. --- ##### `addTask` ```typescript public addTask(name: string, props?: TaskOptions): Task ``` Adds a new task to this project. This will fail if the project already has a task with this name. ###### `name`^Required - *Type:* string The task name to add. --- ###### `props`^Optional - *Type:* projen.TaskOptions Task properties. --- ##### ~~`addTip`~~ ```typescript public addTip(message: string): void ``` Prints a "tip" message during synthesis. ###### `message`^Required - *Type:* string The message. --- ##### `annotateGenerated` ```typescript public annotateGenerated(_glob: string): void ``` Consider a set of files as "generated". This method is implemented by derived classes and used for example, to add git attributes to tell GitHub that certain files are generated. ###### `_glob`^Required - *Type:* string the glob pattern to match (could be a file path). --- ##### `postSynthesize` ```typescript public postSynthesize(): void ``` Called after all components are synthesized. Order is *not* guaranteed. ##### `preSynthesize` ```typescript public preSynthesize(): void ``` Called before all components are synthesized. ##### `removeTask` ```typescript public removeTask(name: string): Task ``` Removes a task from a project. ###### `name`^Required - *Type:* string The name of the task to remove. --- ##### `runTaskCommand` ```typescript public runTaskCommand(task: Task): string ``` Returns the shell command to execute in order to run a task. By default, this is `npx projen@ ` ###### `task`^Required - *Type:* projen.Task The task for which the command is required. --- ##### `synth` ```typescript public synth(): void ``` Synthesize all project files into `outdir`. 1. Call "this.preSynthesize()" 2. Delete all generated files 3. Synthesize all sub-projects 4. Synthesize all components of this project 5. Call "postSynthesize()" for all components of this project 6. Call "this.postSynthesize()" ##### `tryFindFile` ```typescript public tryFindFile(filePath: string): FileBase ``` Finds a file at the specified relative path within this project and all its subprojects. ###### `filePath`^Required - *Type:* string The file path. If this path is relative, it will be resolved from the root of _this_ project. --- ##### ~~`tryFindJsonFile`~~ ```typescript public tryFindJsonFile(filePath: string): JsonFile ``` Finds a json file by name. ###### `filePath`^Required - *Type:* string The file path. --- ##### `tryFindObjectFile` ```typescript public tryFindObjectFile(filePath: string): ObjectFile ``` Finds an object file (like JsonFile, YamlFile, etc.) by name. ###### `filePath`^Required - *Type:* string The file path. --- ##### `tryRemoveFile` ```typescript public tryRemoveFile(filePath: string): FileBase ``` Finds a file at the specified relative path within this project and removes it. ###### `filePath`^Required - *Type:* string The file path. If this path is relative, it will be resolved from the root of _this_ project. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | buildTask | projen.Task | *No description.* | | commitGenerated | boolean | Whether to commit the managed files by default. | | compileTask | projen.Task | *No description.* | | components | projen.Component[] | Returns all the components within this project. | | deps | projen.Dependencies | Project dependencies. | | ejected | boolean | Whether or not the project is being ejected. | | files | projen.FileBase[] | All files in this project. | | gitattributes | projen.GitAttributesFile | The .gitattributes file for this repository. | | gitignore | projen.IgnoreFile | .gitignore. | | logger | projen.Logger | Logging utilities. | | name | string | Project name. | | outdir | string | Absolute output directory of this project. | | packageTask | projen.Task | *No description.* | | postCompileTask | projen.Task | *No description.* | | preCompileTask | projen.Task | *No description.* | | projectBuild | projen.ProjectBuild | Manages the build process of the project. | | projenCommand | string | The command to use in order to run the projen CLI. | | root | projen.Project | The root project. | | subprojects | projen.Project[] | Returns all the subprojects within this project. | | tasks | projen.Tasks | Project tasks. | | testTask | projen.Task | *No description.* | | defaultTask | projen.Task | This is the "default" task, the one that executes "projen". | | initProject | projen.InitProject | The options used when this project is bootstrapped via `projen new`. | | parent | projen.Project | A parent project. | | all | ProjectCollections | Collections of all sub-projects managed by this project. | | documentation | GeneratedDocumentationProjects | Generated documentation projects. | | handlers | GeneratedCodeProjects | Lambda handlers projects. | | infrastructure | GeneratedCodeProjects | Generated infrastructure projects. | | library | GeneratedLibraryProjects | Generated library projects. | | model | TypeSafeApiModelProject | Project for the api model. | | runtime | GeneratedCodeProjects | Generated runtime projects. | --- ##### `buildTask`^Required ```typescript public readonly buildTask: Task; ``` - *Type:* projen.Task --- ##### `commitGenerated`^Required ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean Whether to commit the managed files by default. --- ##### `compileTask`^Required ```typescript public readonly compileTask: Task; ``` - *Type:* projen.Task --- ##### `components`^Required ```typescript public readonly components: Component[]; ``` - *Type:* projen.Component[] Returns all the components within this project. --- ##### `deps`^Required ```typescript public readonly deps: Dependencies; ``` - *Type:* projen.Dependencies Project dependencies. --- ##### `ejected`^Required ```typescript public readonly ejected: boolean; ``` - *Type:* boolean Whether or not the project is being ejected. --- ##### `files`^Required ```typescript public readonly files: FileBase[]; ``` - *Type:* projen.FileBase[] All files in this project. --- ##### `gitattributes`^Required ```typescript public readonly gitattributes: GitAttributesFile; ``` - *Type:* projen.GitAttributesFile The .gitattributes file for this repository. --- ##### `gitignore`^Required ```typescript public readonly gitignore: IgnoreFile; ``` - *Type:* projen.IgnoreFile .gitignore. --- ##### `logger`^Required ```typescript public readonly logger: Logger; ``` - *Type:* projen.Logger Logging utilities. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Project name. --- ##### `outdir`^Required ```typescript public readonly outdir: string; ``` - *Type:* string Absolute output directory of this project. --- ##### `packageTask`^Required ```typescript public readonly packageTask: Task; ``` - *Type:* projen.Task --- ##### `postCompileTask`^Required ```typescript public readonly postCompileTask: Task; ``` - *Type:* projen.Task --- ##### `preCompileTask`^Required ```typescript public readonly preCompileTask: Task; ``` - *Type:* projen.Task --- ##### `projectBuild`^Required ```typescript public readonly projectBuild: ProjectBuild; ``` - *Type:* projen.ProjectBuild Manages the build process of the project. --- ##### `projenCommand`^Required ```typescript public readonly projenCommand: string; ``` - *Type:* string The command to use in order to run the projen CLI. --- ##### `root`^Required ```typescript public readonly root: Project; ``` - *Type:* projen.Project The root project. --- ##### `subprojects`^Required ```typescript public readonly subprojects: Project[]; ``` - *Type:* projen.Project[] Returns all the subprojects within this project. --- ##### `tasks`^Required ```typescript public readonly tasks: Tasks; ``` - *Type:* projen.Tasks Project tasks. --- ##### `testTask`^Required ```typescript public readonly testTask: Task; ``` - *Type:* projen.Task --- ##### `defaultTask`^Optional ```typescript public readonly defaultTask: Task; ``` - *Type:* projen.Task This is the "default" task, the one that executes "projen". Undefined if the project is being ejected. --- ##### `initProject`^Optional ```typescript public readonly initProject: InitProject; ``` - *Type:* projen.InitProject The options used when this project is bootstrapped via `projen new`. It includes the original set of options passed to the CLI and also the JSII FQN of the project type. --- ##### `parent`^Optional ```typescript public readonly parent: Project; ``` - *Type:* projen.Project A parent project. If undefined, this is the root project. --- ##### `all`^Required ```typescript public readonly all: ProjectCollections; ``` - *Type:* ProjectCollections Collections of all sub-projects managed by this project. --- ##### `documentation`^Required ```typescript public readonly documentation: GeneratedDocumentationProjects; ``` - *Type:* GeneratedDocumentationProjects Generated documentation projects. Only the properties corresponding to specified `documentation.formats` will be defined. --- ##### `handlers`^Required ```typescript public readonly handlers: GeneratedCodeProjects; ``` - *Type:* GeneratedCodeProjects Lambda handlers projects. Only the properties corresponding to `handlers.languages` will be defined. --- ##### `infrastructure`^Required ```typescript public readonly infrastructure: GeneratedCodeProjects; ``` - *Type:* GeneratedCodeProjects Generated infrastructure projects. Only the property corresponding to `infrastructure.language` will be defined. --- ##### `library`^Required ```typescript public readonly library: GeneratedLibraryProjects; ``` - *Type:* GeneratedLibraryProjects Generated library projects. Only the properties corresponding to specified `library.libraries` will be defined. --- ##### `model`^Required ```typescript public readonly model: TypeSafeApiModelProject; ``` - *Type:* TypeSafeApiModelProject Project for the api model. --- ##### `runtime`^Required ```typescript public readonly runtime: GeneratedCodeProjects; ``` - *Type:* GeneratedCodeProjects Generated runtime projects. When `runtime.languages` includes the corresponding language, the project can be assumed to be defined. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_TASK | string | The name of the default task (the task executed when `projen` is run without arguments). | --- ##### `DEFAULT_TASK`^Required ```typescript public readonly DEFAULT_TASK: string; ``` - *Type:* string The name of the default task (the task executed when `projen` is run without arguments). Normally this task should synthesize the project files. --- ## Enums ### CustomAuthorizerType The type of custom authorizer. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-type) #### Members | **Name** | **Description** | | --- | --- | | TOKEN | A custom authorizer that uses a Lambda function. | | REQUEST | An authorizer that uses a Lambda function using incoming request parameters. | --- ##### `TOKEN` A custom authorizer that uses a Lambda function. --- ##### `REQUEST` An authorizer that uses a Lambda function using incoming request parameters. --- ### DocumentationFormat Formats for documentation generation. #### Members | **Name** | **Description** | | --- | --- | | HTML_REDOC | HTML Documentation generated by redoc. | | HTML2 | OpenAPI Generator 'html2' documentation. | | MARKDOWN | OpenAPI Generator 'markdown' documentation. | | PLANTUML | OpenAPI Generator 'plantuml' documentation. | --- ##### `HTML_REDOC` HTML Documentation generated by redoc. > [https://github.com/Redocly/redoc](https://github.com/Redocly/redoc) --- ##### `HTML2` OpenAPI Generator 'html2' documentation. > [https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/html2.md](https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/html2.md) --- ##### `MARKDOWN` OpenAPI Generator 'markdown' documentation. > [https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/markdown.md](https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/markdown.md) --- ##### `PLANTUML` OpenAPI Generator 'plantuml' documentation. > [https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/plantuml.md](https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/plantuml.md) --- ### Language Supported languages for runtimes and infrastructure. #### Members | **Name** | **Description** | | --- | --- | | TYPESCRIPT | *No description.* | | PYTHON | *No description.* | | JAVA | *No description.* | --- ##### `TYPESCRIPT` --- ##### `PYTHON` --- ##### `JAVA` --- ### Library Supported libraries for code generation. #### Members | **Name** | **Description** | | --- | --- | | TYPESCRIPT_REACT_QUERY_HOOKS | *No description.* | --- ##### `TYPESCRIPT_REACT_QUERY_HOOKS` --- ### ModelLanguage The model definition language. #### Members | **Name** | **Description** | | --- | --- | | SMITHY | Smithy. | | OPENAPI | OpenAPI. | --- ##### `SMITHY` Smithy. > [https://smithy.io/2.0/](https://smithy.io/2.0/) --- ##### `OPENAPI` OpenAPI. > [https://www.openapis.org/](https://www.openapis.org/) ---