Skip to content

smartcloudsol/flow-backend

Repository files navigation

WP Suite Flow Backend

Public source repository for the WP Suite Flow Backend deployment package.

This repository is intentionally source-available only in part.

What is included in this public repository

This repository contains the public infrastructure definition, deployment contract and deployment-time support code:

  • template.yaml — the source SAM/CloudFormation template
  • wrapper.yaml — wrapper template used by guided deployments
  • SAR-README.md — deployment-focused SAR readme
  • openapi.yaml — public API contract
  • scripts/ — build, packaging, upload and publication scripts
  • src/custom-resource/ — source of the deployment-time custom resource Lambda
  • src/shared/ — shared logger/types used by the custom resource code
  • .artifacts/ — generated deployment artifacts published for installation, including prebuilt/minified runtime bundles and generated deployment templates

What is not included in source form

The main runtime backend sources are not published here in original source form.

That includes, in particular:

  • src/forms-api/
  • src/workflow-dispatcher/
  • src/webhook-dispatcher/
  • src/webhook-trigger-dispatcher/
  • src/email-sender/
  • src/core/

These components are distributed as deployment artifacts through .artifacts/ and S3-hosted release artifacts.

Why the repository is structured this way

The purpose of this public repository is to provide:

  • a reviewable deployment template
  • transparency around custom deployment logic
  • wrapper and API contract files relevant to adopters
  • release scripts and installable artifacts

while keeping selected runtime implementation details proprietary.

Artifact model

The deployable artifacts are generated by scripts/publish-sar.sh and related build scripts.

During publishing:

  • the source template.yaml is transformed into a generated deployment template
  • the generated template is written to .artifacts/template-sar.yaml or .artifacts/template.sar.yaml depending on the release script version
  • prebuilt runtime bundles are placed under .artifacts/
  • those artifacts are uploaded to the release S3 bucket and used by published versions

This repository is therefore intended as a deployment-facing repository, not as the complete internal source tree.

Repository contents intended for public review

The most relevant files for reviewers are:

  • README.md
  • SAR-README.md
  • template.yaml
  • wrapper.yaml
  • openapi.yaml
  • scripts/publish-sar.sh
  • src/custom-resource/handler.ts
  • .artifacts/template-sar.yaml or .artifacts/template.sar.yaml

Building and publishing

Internal development may use additional private source code that is not included here. Public consumers should treat the checked-in .artifacts/ directory as the deployable release representation.

License

See LICENSE for license terms applicable to this repository.

Availability of deployment artifacts does not by itself grant rights beyond the applicable license and service terms.

About

EventBridge-based workflow and form submission backend for WP Suite Flow, deployable into the customer’s AWS account with optional Cognito or IAM API protection.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors