@nikovirtala/projen-constructs 0.2.1 → 0.2.2

package/node_modules/@mrgrain/jsii-struct-builder/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/node_modules/@mrgrain/jsii-struct-builder/README.md

@@ -0,0 +1,387 @@
+# ![jsii-struct-builder](./images/wordmark-dynamic.svg)
+
+Build jsii structs with ease.
+
+Jsii doesn't support TypeScript [Utility Types](https://www.typescriptlang.org/docs/handbook/utility-types.html) like `Partial` or `Omit`, making it difficult to re-use existing [struct interfaces](https://aws.github.io/jsii/specification/2-type-system/#structs).
+With this package, you can work around that limitation and create brand new struct interfaces based on the jsii specification of any existing structs, their parents, and your custom specification.
+
+From jsii's perspective, these structs are completely new types.
+From a maintainer's perspective, they require the same minimal effort as utility types do.
+Everybody wins!
+
+## Usage
+
+Install with:
+
+```console
+npm install --save-dev @mrgrain/jsii-struct-builder
+```
+
+Or add `@mrgrain/jsii-struct-builder` to the `devDeps` in your project in your `.projenrc.ts` file, and run `npx projen` to install it.
+
+Then add a `new ProjenStruct` in your `.projenrc.ts` file, passing a [TypeScript project](https://projen.io/typescript.html) as the first parameter.
+See the sections below for more usage details.
+
+If you're not using [`projen`](https://projen.io/), see [Use without `projen`](#use-without-projen).
+
+### Requirements
+
+```txt
+Node.js >= 18
+projen >= 0.65.0
+```
+
+### Create from an existing Struct
+
+Use the jsii FQN to mix in an existing struct.
+Use `omit()` to remove any properties you are not interested in.
+
+```ts
+new ProjenStruct(project, { name: 'MyProjectOptions' })
+  .mixin(Struct.fromFqn('projen.typescript.TypeScriptProjectOptions'))
+  .omit('sampleCode', 'projenrcTs', 'projenrcTsOptions');
+```
+
+### Adding new Properties
+
+New properties can be added with a `@jsii/spec` definition.
+Complex types can be used and will be imported using their FQN.
+Any existing properties of the same name will be replaced.
+
+```ts
+new ProjenStruct(project, { name: 'MyProjectOptions' })
+  .mixin(Struct.fromFqn('projen.typescript.TypeScriptProjectOptions'))
+  .add(
+    {
+      name: 'booleanSetting',
+      type: { primitive: jsii.PrimitiveType.Boolean },
+    },
+    {
+      name: 'complexSetting',
+      type: { fqn: 'my_project.SomeEnum' }, // my_project is the "name" in your projen project
+    }
+  );
+```
+
+### Updating existing Properties
+
+Existing properties can be updated.
+The provided partial `@jsii/spec` definition will be deep merged with the existing spec.
+
+A convenience `rename()` method is provided.
+An `update()` of the `name` field has the same effect and can be combined with other updates.
+
+```ts
+new ProjenStruct(project, { name: 'MyProjectOptions'})
+  .mixin(Struct.fromFqn('projen.typescript.TypeScriptProjectOptions'))
+
+  // Update a property
+  .update('typescriptVersion', { optional: false })
+  // Nested values can be updated
+  .update('sampleCode', {
+    docs: {
+        summary: 'New summary',
+        default: 'false',
+      }
+    }
+  )
+
+  // Rename a property
+  .rename('homepage', 'website'})
+  // ...this also does a rename
+  .update('eslint', {
+    name: 'lint',
+    optional: false,
+  });
+```
+
+### Updating multiple properties
+
+A callback function can be passed to `updateEvery()` to update multiple properties at a time.
+
+Use `updateAll()` to uniformly update all properties.
+A convenience `allOptional()` method is provided to make all properties optional.
+
+```js
+new ProjenStruct(project, { name: 'MyProjectOptions'})
+  .mixin(Struct.fromFqn('projen.typescript.TypeScriptProjectOptions'))
+
+  // Use a callback to make conditional updates
+  .updateEvery((property) => {
+    if (!property.optional) {
+      return {
+        docs: {
+          remarks: 'This property is required.',
+        },
+      };
+    }
+    return {};
+  })
+
+  // Apply an update to all properties
+  .updateAll({
+    immutable: true,
+  })
+
+  // Mark all properties as optional
+  .allOptional();
+```
+
+### Replacing properties
+
+Existing properties can be replaced with a new `@jsii/spec` definition.
+If a different `name` is provided, the property is also renamed.
+
+A callback function can be passed to `map()` to map every property to a new `@jsii/spec` definition.
+
+```ts
+new ProjenStruct(project, { name: 'MyProjectOptions' })
+  .mixin(Struct.fromFqn('projen.typescript.TypeScriptProjectOptions'))
+
+  // Replace a property with an entirely new definition
+  .replace('autoApproveOptions', {
+    name: 'autoApproveOptions',
+    type: { fqn: 'my_project.AutoApproveOptions' }, // my_project is the "name" in your projen project
+    docs: {
+      summary: 'Configure the auto-approval workflow.'
+    }
+  })
+
+  // Passing a new name, will also rename the property
+  .replace('autoMergeOptions', {
+    name: 'mergeFlowOptions',
+    type: { fqn: 'my_project.MergeFlowOptions' }, // my_project is the "name" in your projen project
+  })
+
+  // Use a callback to map every property to a new definition
+  .map((property) => {
+    if (property.protected) {
+      return {
+        ...property,
+        protected: false,
+        docs: {
+          custom: {
+            'internal': 'true',
+          }
+        }
+      }
+    }
+    return property;
+  });
+```
+
+### Filter properties
+
+Arbitrary predicate functions can be used to filter properties.
+Only properties that meet the condition are kept.
+
+Use `omit()` and `only()` for easy name based filtering.
+A convenience `withoutDeprecated()` method is also provided.
+
+```ts
+new ProjenStruct(project, { name: 'MyProjectOptions' })
+  .mixin(Struct.fromFqn('projen.typescript.TypeScriptProjectOptions'))
+
+  // Keep properties using arbitrary filters
+  .filter((prop) => !prop.optional)
+
+  // Keep or omit properties by name
+  .only('projenrcTs', 'projenrcTsOptions')
+  .omit('sampleCode')
+
+  // Remove all deprecated properties
+  .withoutDeprecated();
+```
+
+### AWS CDK properties
+
+A common use-case of this project is to expose arbitrary overrides in CDK constructs.
+For example, you may want to provide common AWS Lambda configuration, but allow a consuming user to override any arbitrary property.
+
+To accomplish this, first create the new struct in your `.projenrc.ts` file.
+
+```ts
+import { ProjenStruct, Struct } from '@mrgrain/jsii-struct-builder';
+import { awscdk } from 'projen';
+
+const project = new awscdk.AwsCdkConstructLibrary({
+  // your config - see https://projen.io/awscdk-construct.html
+});
+
+new ProjenStruct(project, { name: 'MyFunctionProps' })
+  .mixin(Struct.fromFqn('aws-cdk-lib.aws_lambda.FunctionProps'))
+  .withoutDeprecated()
+  .allOptional()
+  .omit('code'); // our construct always provides the code
+```
+
+Then use the new struct in your CDK construct.
+
+```ts
+// lib/MyFunction.ts
+import { Code, Function, Runtime } from 'aws-cdk-lib/aws-lambda';
+import { Construct } from 'constructs';
+import { join } from 'path';
+import { MyFunctionProps } from './MyFunctionProps';
+
+export class MyFunction extends Construct {
+  constructor(scope: Construct, id: string, props: MyFunctionProps = {}) {
+    super(scope, id);
+
+    new Function(this, 'Function', {
+      // sensible defaults
+      runtime: Runtime.NODEJS_18_X,
+      handler: 'index.handler',
+      // user provided props
+      ...props,
+      // always force `code` from our construct
+      code: Code.fromAsset(join(__dirname, 'lambda-handler')),
+    });
+  }
+}
+```
+
+### Complex types
+
+More complex jsii types can be used as well. They can be expressed like this:
+
+```ts
+import { PrimitiveType, CollectionKind } from '@jsii/spec';
+import { ProjenStruct, Struct } from '@mrgrain/jsii-struct-builder';
+import { awscdk } from 'projen';
+
+const project = new awscdk.AwsCdkConstructLibrary({
+  // your config - see https://projen.io/awscdk-construct.html
+});
+
+new ProjenStruct(project, {
+  name: 'CustomFargateServiceProps',
+  docs: {
+    summary: 'ecs.FargateServiceProps without taskDefinition and desiredCount',
+    remarks: `We do not want to allow the user to specify a task definition or desired count,
+as this construct is meant to deploy a single service with a single task definition and
+desired count of 1. So we narrow the ecs.FargateServiceProps type to exclude these properties.
+Then we add some custom properties that are specific to our use case.`,
+    custom: {
+      'internal': 'true', // use this if you want to hide the struct from the public API
+    },
+  },
+})
+  .mixin(Struct.fromFqn('aws-cdk-lib.aws_ecs.FargateServiceProps'))
+  .omit('taskDefinition', 'desiredCount')
+  .add({
+    name: 'logMappings',
+    type: {
+      collection: {
+        elementtype: { fqn: 'my_project.LogMapping' }, // my_project is the "name" in your projen project
+        kind: CollectionKind.Array,
+      },
+    },
+    docs: {
+      summary: 'An array of a locally-defined type. The fqn comes from the jsii module name.',
+      remarks: 'This can be looked in the .jsii file like this: `jq -r \'.types[] | select (.name == "LogMapping") | .fqn\' .jsii`',
+    },
+  })
+.add({
+    name: 'agentCpu',
+    type: { primitive: PrimitiveType.Number },
+    optional: true, // an optional property
+    docs: {
+      summary: 'The amount of CPU units to allocate to the agent.', // here is how you format a long description
+      remarks: `1024 CPU units = 1 vCPU.
+This is passed to the Fargate task definition.
+You might need to increase this if you have a lot of logs to process.
+Only some combinations of memory and CPU are valid.`,
+      see: 'https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.TaskDefinition.html#memorymib',
+      default: '512',
+    },
+  })
+.add({
+    name: 'mapToArray',
+    type: {
+      collection: {
+        elementtype: {
+          collection: {
+            elementtype: { fqn: 'aws-cdk-lib.aws_logs.LogGroup' },
+            kind: CollectionKind.Array,
+          }
+        },
+        kind: CollectionKind.Map,
+      },
+    },
+    docs: {
+      summary: 'A map of string to an array of LogGroup objects.'
+    },
+  })
+.add({
+    name: 'mysteryObject',
+    type: { primitive: PrimitiveType.Any },
+    docs: {
+      summary: 'An "any" type object.'
+    },
+})
+```
+
+### Use without projen
+
+It is not required to use _projen_ with this package.
+You can use a renderer directly to create files:
+
+```ts
+const myProps = Struct.empty('@my-scope/my-pkg.MyFunctionProps')
+  .mixin(Struct.fromFqn('aws-cdk-lib.aws_lambda.FunctionProps'))
+  .withoutDeprecated();
+
+const renderer = new TypeScriptRenderer();
+fs.writeFileSync('my-props.ts', renderer.renderStruct(myProps));
+```
+
+### Advanced usage
+
+`Struct` and `ProjenStruct` both share the same interface.
+This allows some advanced applications.
+
+For example you can manipulate the source for re-use:
+
+```ts
+const base = Struct.fromFqn('projen.typescript.TypeScriptProjectOptions');
+base.omit('sampleCode', 'projenrcTs', 'projenrcTsOptions');
+```
+
+Or you can mix in a `ProjenStruct` with another:
+
+```ts
+const foo = new ProjenStruct(project, { name: 'Foo' });
+const bar = new ProjenStruct(project, { name: 'Bar' });
+
+bar.mixin(foo);
+```
+
+You can also use `Struct` and `ProjenStruct` as type of a property:
+
+```ts
+const foo = new ProjenStruct(project, { name: 'Foo' });
+const bar = new ProjenStruct(project, { name: 'Bar' });
+
+foo.add({
+  name: 'barSettings',
+  type: bar,
+});
+```
+
+The default configuration makes assumptions about the new interface that are usually okay.
+For more complex scenarios `fqn`, `filePath` and `importLocations` can be used to influence the rendered output.
+
+```ts
+new JsiiInterface(project, {
+  name: 'MyProjectOptions',
+  fqn: 'my_project.nested.location.MyProjectOptions', // my_project is the "name" in your projen project
+  filePath: 'src/nested/my-project-options.ts',
+  importLocations: {
+    my_project: '../enums',
+  },
+}).add({
+  name: 'complexSetting',
+  type: { fqn: 'my_project.SomeEnum' }, // my_project is the "name" in your projen project
+});
+```

package/node_modules/@mrgrain/jsii-struct-builder/lib/builder/index.d.ts

@@ -0,0 +1 @@
+export * from './struct';

package/node_modules/@mrgrain/jsii-struct-builder/lib/builder/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./struct"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvYnVpbGRlci9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7Ozs7O0FBQUEsMkNBQXlCIiwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0ICogZnJvbSAnLi9zdHJ1Y3QnO1xuIl19