node-backpack 0.0.4

package/.gitattributes

@@ -0,0 +1,23 @@
+# ~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen".
+
+*.snap linguist-generated
+/.eslintrc.json linguist-generated
+/.gitattributes linguist-generated
+/.github/pull_request_template.md linguist-generated
+/.github/workflows/auto-approve.yml linguist-generated
+/.github/workflows/build.yml linguist-generated
+/.github/workflows/pull-request-lint.yml linguist-generated
+/.github/workflows/release.yml linguist-generated
+/.github/workflows/upgrade-main.yml linguist-generated
+/.gitignore linguist-generated
+/.mergify.yml linguist-generated
+/.npmignore linguist-generated
+/.projen/** linguist-generated
+/.projen/deps.json linguist-generated
+/.projen/files.json linguist-generated
+/.projen/tasks.json linguist-generated
+/LICENSE linguist-generated
+/package.json linguist-generated
+/tsconfig.dev.json linguist-generated
+/tsconfig.json linguist-generated
+/yarn.lock linguist-generated

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,4 @@
+## Code of Conduct
+This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
+For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
+opensource-codeofconduct@amazon.com with any additional questions or comments.

package/CONTRIBUTING.md

@@ -0,0 +1,59 @@
+# Contributing Guidelines
+
+Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
+documentation, we greatly value feedback and contributions from our community.
+
+Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
+information to effectively respond to your bug report or contribution.
+
+
+## Reporting Bugs/Feature Requests
+
+We welcome you to use the GitHub issue tracker to report bugs or suggest features.
+
+When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already
+reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
+
+* A reproducible test case or series of steps
+* The version of our code being used
+* Any modifications you've made relevant to the bug
+* Anything unusual about your environment or deployment
+
+
+## Contributing via Pull Requests
+Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
+
+1. You are working against the latest source on the *main* branch.
+2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
+3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
+
+To send us a pull request, please:
+
+1. Fork the repository.
+2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
+3. Ensure local tests pass.
+4. Commit to your fork using clear commit messages.
+5. Send us a pull request, answering any default questions in the pull request interface.
+6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
+
+GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
+[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
+
+
+## Finding contributions to work on
+Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
+
+
+## Code of Conduct
+This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
+For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
+opensource-codeofconduct@amazon.com with any additional questions or comments.
+
+
+## Security issue notifications
+If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
+
+
+## Licensing
+
+See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.

package/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/NOTICE

@@ -0,0 +1 @@
+Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

package/README.md

@@ -0,0 +1,160 @@
+# node-backpack
+
+You can use this tool to help create bundled packages with minimal dependencies and appropriate license attributions.
+
+## Why
+
+When shipping nodejs applications, there is currently no easy way to ensure your users are
+consuming the exact dependency closure your package was tested against.
+
+This is because many libraries define their dependencies with a range, rather than a fixed version.
+NPM has provided an install time lock file called [shrinkwrap](https://docs.npmjs.com/cli/v8/commands/npm-shrinkwrap)
+to help mitigate this, however, this file is only respected by NPM itself, and not by other package managers such as Yarn.
+
+## What
+
+This package wires up several popular tools to offer a simpler entrypoint for
+creating self-contained nodejs packages.
+
+The resulting packages are still npm installable packages, but you can use this tool to
+replace the entrypoints you specify with a bundled version of them, embedding their dependencies inline.
+Note that embedding dependencies means you are effectively redistributing third-party software.
+This could have licensing implications, and it is your responsibility to provide proper
+and typically requires proper attribution of the bundled dependencies,
+while validating their licenses allow such redistribution.
+
+You can use this tool to help achieve the following tasks:
+
+- Bundle the entrypoints inside the package.
+
+  > Currently done with [esbuild](https://esbuild.github.io), but is subject to change.
+
+- Validate and create THIRD_PARTY_LICENCES file with third-party attributions for packages with declared licensing information.
+
+  > Currently done with [license-checker](https://www.npmjs.com/package/license-checker), but is subject to change.
+
+- Detect circular imports that are exhibited in your package, or in your dependency closure.
+
+  > Currently done with [madge](https://www.npmjs.com/package/madge), but is subject to change.
+  > This is necessary because circular imports mess up the declaration order of types in the bundled file.
+
+### Disclaimer
+
+Features of this package rely on the dependencies' declared licensing information, and the fulsomeness of
+the generated attribution is dependent on the dependencies’ declarations.
+This tool is not a substitute for your code attribution processes, but you can use it to help
+streamline attribution items for dependencies that have license declarations.
+The user of this package remains responsible for complying to their dependencies' licensing requirements,
+including any attribution obligations.
+
+We strongly recommend that you check all of your code into source control, and follow your ordinary code attribution processes.
+
+## Alternative Approaches
+
+We considered two other alternatives before eventually going down this route:
+
+### Bundled Dependencies
+
+Aside from a shrinkwrap file, NPM also offers a feature called `bundledDependencies`
+to vendor in your dependencies inside the `node_modules` directory of your package.
+
+> See [bundledDependencies](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#bundleddependencies)
+
+While this approach seems to be supported across all package managers, that won't be
+the case for Yarn 2.x and above, or more concretely,
+for the [Plug'n'Play](https://yarnpkg.com/features/pnp) feature.
+
+> See [dont use bundled dependencies](https://yarnpkg.com/getting-started/migration#dont-use-bundledependencies)
+
+### Static Binaries
+
+Another option would have been to produce platform specific static binaries that embed both
+dependencies as well as a node runtime.
+
+This approach is valid, but really depends on the use case. For example if you need your package
+to still be installable by npm, it doesn't really fit. Also, it's not relevant for libraries,
+only CLI applications.
+
+## How
+
+Run the tool from the root directory of your package.
+
+```console
+$ node-backpack --help
+Usage: node-backpack COMMAND
+
+Commands:
+  node-backpack validate  Validate the package is ready for bundling
+  node-backpack write     Write the bundled version of the project to a temp
+                        directory
+  node-backpack pack      Write the bundle and create the tarball
+
+Options:
+  --entrypoint       List of entrypoints to bundle                       [array]
+  --external         Packages in this list will be excluded from the bundle and
+                     added as dependencies (example: fsevents:optional)
+                                                           [array] [default: []]
+  --allowed-license  List of valid licenses                [array] [default: []]
+  --resource         List of resources that need to be explicitly copied to the
+                     bundle (example:
+                     node_modules/proxy-agent/contextify.js:bin/contextify.js)
+                                                           [array] [default: []]
+  --dont-attribute   Dependencies matching this regular expressions wont be
+                     added to the notice file                           [string]
+  --test             Validation command to sanity test the bundle after its
+                     created                                            [string]
+  --help             Show help                                         [boolean]
+  --version          Show version number                               [boolean]
+```
+
+You can also use the programmatic access:
+
+```ts
+import { Bundle } from 'node-backpack';
+
+const bundle = new Bundle({
+  packageDir: process.cwd(),
+  allowedLicenses: ['Apache-2.0', 'MIT'],
+});
+
+bundle.pack();
+```
+
+### Integrate with your build process
+
+We recommend to integrate this tool in the following way:
+
+1. Add a `node-backpack validate` command as a post compile step.
+2. Set your packaging command to `node-backpack pack`.
+
+This way, you can validate local dev builds not to break any functionality needed for bundling.
+In addition, developers can run `node-backpack validate --fix` to automatically fix any (fixable) violations
+and commit that to source control.
+
+For example, if a dependency is added but the attribution file has not been re-generated,
+you can use `node-backpack validate` to catch this, and regenerate it with `node-backpack validate --fix`.
+
+## Take into account
+
+By default, the tool will use the `main` directive of the `package.json` as
+the entrypoint. This will help you ensure that all top level exports of the
+package are preserved.
+
+Deep imports such as `const plugins = require('your-package/lib/plugins')` are considered
+private and should not be used by your consumers. However, if you absolutely have to
+preserve those as well, you should pass custom multiple entry-points for each deep import.
+Note that this will balloon up the package size significantly.
+
+If you are bundling a CLI application that also has top level exports, we suggest to extract
+the CLI functionality into a function, and add this function as an export to `index.js`.
+
+> See [aws-cdk](https://github.com/aws/aws-cdk/blob/master/packages/aws-cdk/bin/cdk.ts) as an example.
+
+## Security
+
+See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
+
+## License
+
+This project is licensed under the Apache-2.0 License.
+

package/bin/node-backpack

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require('../lib/cli.js');

package/lib/api/_attributions.d.ts

@@ -0,0 +1,64 @@
+import type { Package } from './bundle';
+import { ViolationsReport } from './violation';
+/**
+ * Properties for `Attributions`.
+ */
+export interface AttributionsProps {
+    /**
+     * The package root directory.
+     */
+    readonly packageDir: string;
+    /**
+     * The name of the package.
+     */
+    readonly packageName: string;
+    /**
+     * Package dependencies.
+     */
+    readonly dependencies: Package[];
+    /**
+     * The parent directory underwhich all dependencies live.
+     */
+    readonly dependenciesRoot: string;
+    /**
+     * Path to the notice file to created / validated.
+     */
+    readonly filePath: string;
+    /**
+     * List of allowed licenses.
+     *
+     */
+    readonly allowedLicenses: string[];
+    /**
+     * Dependencies matching this pattern will be excluded from attribution.
+     *
+     * @default - no exclusions.
+     */
+    readonly exclude?: string;
+}
+/**
+ * `Attributions` represents an attributions file containing third-party license information.
+ */
+export declare class Attributions {
+    private readonly packageDir;
+    private readonly packageName;
+    private readonly dependencies;
+    private readonly allowedLicenses;
+    private readonly dependenciesRoot;
+    private readonly filePath;
+    private readonly attributions;
+    private readonly content;
+    constructor(props: AttributionsProps);
+    /**
+     * Validate the current notice file.
+     *
+     * This method never throws. The Caller is responsible for inspecting the report returned and act accordinagly.
+     */
+    validate(): ViolationsReport;
+    /**
+     * Flush the generated notice file to disk.
+     */
+    flush(): void;
+    private render;
+    private generateAttributions;
+}