Gathering detailed insights and metrics for @beforeyoubid/serverless-step-functions-offline
Gathering detailed insights and metrics for @beforeyoubid/serverless-step-functions-offline
Emulate step functions locally when developing your Serverless project
Installations
npm install @beforeyoubid/serverless-step-functions-offlineDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Node Version
14.17.0
NPM Version
6.14.13
Releases
7
Languages
2
TypeScript
JavaScript
TypeScript (99.44%)
JavaScript (0.56%)
Developer
beforeyoubid
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
1 Stars
230 Commits
2 Forks
1 Watchers
10 Branches
1 Contributors
Updated on Aug 07, 2022
Maintainers
8
Package Meta Information
Latest Version
3.0.3
Package Id
@beforeyoubid/serverless-step-functions-offline@3.0.3
Unpacked Size
136.37 kB
Size
41.39 kB
File Count
14
NPM Version
6.14.13
Node Version
14.17.0
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dev Dependencies
22
@babel/cli@babel/core@babel/plugin-proposal-class-properties@babel/preset-env@babel/preset-typescript@types/jest@types/node@types/serverless@typescript-eslint/eslint-plugin@typescript-eslint/parserasl-typesbabel-plugin-add-module-exportseslinteslint-config-prettiereslint-plugin-prettierjestjest-junitpre-commitprettierserverlessts-nodetypescript
serverless-step-functions-offline 
Documentation
Install
Using NPM:
1npm install @beforeyoubid/serverless-step-functions-offline --save-dev
or Yarn:
1yarn add @beforeyoubid/serverless-step-functions-offline --dev
Setup
Add the plugin to your serverless.yml:
1# serverless.yml 2 3plugins: 4 - '@beforeyoubid/serverless-step-functions-offline'
To verify that the plugin works, run this in your command line:
1sls step-functions-offline
It should rise an error like that:
Serverless plugin "serverless-step-functions-offline" initialization errored: Please add ENV_VARIABLES to section "custom"
Requirements
This plugin works only with serverless-step-functions.
You must have this plugin installed and correctly specified statemachine definition using Amazon States Language.
Example of statemachine definition you can see here.
Usage
After all steps are done, need to add to section custom in serverless.yml the key stepFunctionsOffline with properties stateName: name of lambda function.
For example:
1service: ServerlessStepPlugin 2frameworkVersion: ">=1.13.0 <2.0.0" 3plugins: 4 - '@beforeyoubid/serverless-step-functions-offline' 5 6# ... 7 8custom: 9 stepFunctionsOffline: 10 FirstLambda: firstLambda #(v2.0) 11 # ... 12 # ... 13 SecondLambda: secondLambda #(v2.0) 14 15functions: 16 firstLambda: 17 handler: firstLambda/index.handler 18 name: TheFirstLambda 19 secondLambda: 20 handler: secondLambda/index.handler 21 name: TheSecondLambda 22stepFunctions: 23 stateMachines: 24 foo: 25 definition: 26 Comment: "An example of the Amazon States Language using wait states" 27 StartAt: FirstLambda 28 States: 29 FirstLambda: 30 Type: Task 31 Resource: arn:aws:lambda:eu-west-1:123456789:function:TheFirstLambda 32 Next: SecondLambda 33 SecondLambda: 34 Type: Task 35 Resource: arn:aws:lambda:eu-west-1:123456789:function:TheSecondLambda 36 End: true
Where:
StepOneis the name of step in state machinefirstLambdais the name of function in section functions
Run Plugin
1sls step-functions-offline --stateMachine={{name}} --event={{path to event file}}
name: name of state machine in section state functions. In example above it'sfoo.event: input values for execution in JSON format (optional)
If you want to know where you are (in offline mode or not) you can use env variable STEP_IS_OFFLINE.
By default process.env.STEP_IS_OFFLINE = true.
What does plugin support?
| States | Support |
|---|---|
| Task | Supports Retry but at this moment does not support fields Catch, TimeoutSeconds, HeartbeatSeconds |
| Choice | All comparison operators except: And, Not, Or |
| Wait | All following fields: Seconds, SecondsPath, Timestamp, TimestampPath |
| Parallel | Only Branches |
| Map | Supports Iterator and the following fields: ItemsPath, ResultsPath, Parameters |
| Pass | Result, ResultPath |
| Fail | Cause, Error |
| Succeed |
Usage with serverless-webpack
The plugin integrates very well with serverless-webpack.
Add the plugins serverless-webpack to your serverless.yml file and make sure that serverless-webpack
precedes serverless-step-functions-offline as the order is important:
1 plugins: 2 ... 3 - serverless-webpack 4 ... 5 - '@beforeyoubid/serverless-step-functions-offline' 6 ...
TODOs
- Support context object
- Improve performance
- Fixing bugs
- Support Pass, Fail, Succeed
- Integration with serverless-webpack
- Support Map
- Support field Retry
- Support field Catch
- Add unit tests - to make plugin stable (next step)
- Support other languages except node.js
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
no dangerous workflow patterns detected
Reason
SAST tool detected: CodeQL
Details
- Info: SAST configuration detected: CodeQL
- Warn: no pull requests merged into dev branch
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/codeql-analysis.yml:1
- Info: no jobLevel write permissions found
Reason
Found 0/30 approved changesets -- score normalized to 0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/beforeyoubid/serverless-step-functions-offline/codeql-analysis.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/beforeyoubid/serverless-step-functions-offline/codeql-analysis.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:53: update your workflow using https://app.stepsecurity.io/secureworkflow/beforeyoubid/serverless-step-functions-offline/codeql-analysis.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/beforeyoubid/serverless-step-functions-offline/codeql-analysis.yml/main?enable=pin
- Info: 0 out of 4 GitHub-owned GitHubAction dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
31 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
- Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx
- Warn: Project is vulnerable to: GHSA-jr5f-v2jv-69x6
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-h452-7996-h45h
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
- Warn: Project is vulnerable to: GHSA-mhxj-85r3-2x55
- Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
- Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
- Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
- Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-wc69-rhjr-hc9g
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-9p95-fxvg-qgq2
- Warn: Project is vulnerable to: GHSA-9w5j-4mwv-2wj8
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-cf4h-3jhx-xvhq
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
- Warn: Project is vulnerable to: GHSA-776f-qx25-q3cc
Score
3.4
/10
Last Scanned on 2025-07-07
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More