@suss/contract-serverless 0.3.2-0

package/LICENSE

@@ -0,0 +1,205 @@
+                                 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 please. Also add information on
+      how to contact you by electronic and paper mail.
+
+      If the program does not interact with users remotely through a computer
+      network, then your name and employer's name (e.g., your institution)
+      is sufficient to fill in the "name of copyright owner" field. Feel
+      free to omit the "name of employer" line if you are in no way affiliated
+      with any institution.
+
+      Copyright 2026 Nimbus Cloud AI LLC
+
+      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/README.md

@@ -0,0 +1,77 @@
+# @suss/contract-serverless
+
+Generate suss `BehavioralSummary[]` from a [Serverless Framework](https://www.serverless.com/framework/docs) service file. A `serverless.yml` deploys working Lambdas, and before this reader existed suss saw none of them: no deployable unit, no environment contract, no event wiring.
+
+## What this package is
+
+The framework compiles a service file into one CloudFormation stack. Each function becomes a Lambda, each event becomes the resource that triggers it, and the `resources:` block is copied in as written. So this reader restates the service in SAM's form and hands that to [`@suss/contract-cloudformation`](../cloudformation/), rather than growing a second set of summary builders that would drift from it. A queue wired in a serverless.yml and the same queue wired in a SAM template come out as the same summary.
+
+| Service file | What it becomes |
+|---|---|
+| `provider.runtime`, `provider.environment` | SAM `Globals.Function`: defaults every function inherits, with `globals` provenance on each inherited variable |
+| `functions.<name>` | one Lambda, keyed by the name it is written under, with `handler` pointing at the code that runs it |
+| `events[].httpApi` | an API Gateway v2 route |
+| `events[].http` | an API Gateway v1 (REST) route |
+| `events[].sqs` | a queue consumer, channelled on the queue the ARN points at |
+| `events[].sns` | a topic subscription |
+| `events[].schedule` | a scheduled invocation, with `enabled: false` for a rule that deploys switched off |
+| `events[].eventBridge` | a rule, reduced to the detail-types it routes, or a schedule |
+| `resources.Resources` | raw CloudFormation, variables resolved, read as its own document |
+
+## Variables
+
+`${self:...}` points at a path inside the same document, so it resolves here, fallback and all. Every other source (`env:`, `opt:`, `cf:`, `ssm:`, `param:`, `file(...)`, and whatever a plugin registers) refers to a value that a deploy supplies, so the reader keeps the reference as a symbolic token instead of resolving it, guessing at it, or dropping it: an `sqs` event whose ARN is `${env:AUDIT_QUEUE_ARN}` gets the channel `env:AUDIT_QUEUE_ARN`. The token says which binding would ground the boundary, where a null would only say that the wiring is specified somewhere else.
+
+A fallback resolves only for a `self:` reference, where the document states both sides. `${opt:region, 'us-east-1'}` stays symbolic, because the document does not state which way an invocation went.
+
+The framework resolves its variables across the whole document before it compiles anything, so the `resources:` block goes through the same resolver: a table written `TableName: ${self:custom.tableName}` is a name by the time CloudFormation sees it, not the reference text. One reference is left exactly as written there: the one whose source is not the framework's. `Fn::Sub` writes `${AWS::Region}` in the same syntax, and rewriting it would turn an intrinsic that the document meant into a token that nothing resolves.
+
+## Two documents, one service
+
+The functions block and the `resources:` block deploy into a single stack, so a logical id means the same thing in both and a queue declared under `resources:` is the queue an `sqs` event points at. They have different provenance labels, built the way a nested stack's label is: `serverless:services/orders/serverless.yml` and `serverless:services/orders/serverless.yml#resources`. A reader can tell which block declared what, and the flow walk still scopes both to one service, since it scopes on the part before the `#`. The label says where the service file lives in the repository, so a monorepo full of services keeps them apart.
+
+## Minimal usage
+
+```ts
+import { serverlessFileToSummaries } from "@suss/contract-serverless";
+import fs from "node:fs";
+
+// The path may name the service file or the directory holding it.
+const summaries = serverlessFileToSummaries("serverless.yml");
+fs.writeFileSync("provider.json", JSON.stringify(summaries, null, 2));
+```
+
+From the CLI:
+
+```sh
+suss contract --from serverless serverless.yml -o service.json
+```
+
+## What it abstains on, and says so
+
+Each of these writes a line to stderr giving the function, the block, and what stopped the read, so wiring that nobody read is never mistaken for wiring that nobody wrote. Pass `onUnread` to collect them instead.
+
+- **Plugins.** A service that loads plugins is reported once. A plugin can add, rename, or rewrite functions and events, and what it declares is not in the document.
+- **A service file that is a program.** The reader recognizes a `serverless.ts` or `serverless.js` and reports it: a program declares the service, and a reader does not run one to find out what it says. When a directory has a parseable service file alongside one of these, the reader reads the parseable one, the way the framework prefers it. A path with no service file at all is an error, since the caller pointed at it.
+- **Event kinds outside the list above.** `kinesis`, `stream`, `alb`, `websocket`, `cognitoUserPool`, and the rest are reported, not dropped.
+- **A route whose method or path a deploy supplies.** A path such as `/${env:PREFIX}/orders` describes no route this document states, and a token substituted into a path would pair with a route nobody wrote. The rest of the function's events still read.
+- **A handler the document does not state.** The function is skipped: nothing says which code runs it.
+
+## Limitations (v0)
+
+- **Code scope is the service directory.** The framework packages the whole service into every function's artifact unless `package.individually` narrows it per function, which this reader does not read. A service that sets it gets a scope wider than what deploys.
+- **`provider.region` is read and left symbolic.** No boundary keys on a region today.
+- **Cross-block routing is not composed.** An EventBridge rule declared under `resources:` that targets a queue an `sqs` event drains does not lend the consumer its subject, the way it would inside one CloudFormation template. Each block is read as its own document.
+- **`stage` and multi-stage overrides are not applied.** A value that differs per stage comes out as whatever the document states, with no stage bound.
+
+## Where it fits in suss
+
+Depends on `@suss/contract-cloudformation` (which owns every summary builder this reader reaches), `@suss/manifest-aws` (for the CloudFormation intrinsic tags the `resources:` block uses), `@suss/behavioral-ir`, and `yaml`.
+
+## Coverage
+
+![coverage](../../../.github/badges/coverage-contract-serverless.svg)
+
+## License
+
+Licensed under Apache 2.0. See [LICENSE](../../../LICENSE).