serverless-apikey-output

v0.1.0

A serverless plugin to output api key values

NPM

README

GitHub

MIT

Latest version published 1 year ago

    npm install serverless-apikey-output

We couldn't find any similar packages Browse all packages

Package Health Score

46 / 100

Popularity
Limited
Maintenance
Inactive
Security
No known security issues
Community
Limited

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Secure Your Project

Find & fix vulnerable dependencies and insecure code

Popularity

Limited

Weekly Downloads (82)

Dependents: 0
GitHub Stars: 0
Forks: 0
Contributors: 1

Direct Usage Popularity

The npm package serverless-apikey-output receives a total of 82 downloads a week. As such, we scored serverless-apikey-output popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package serverless-apikey-output, we found that it has been starred ? times, and that 0 other projects in the ecosystem are dependent on it.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Security

No known security issues

Security and license risk for significant versions

All Versions

Popular

Version

Release Date

0.1.0

09/2020

Direct Vulnerabilities

Popular

0.1.0

Indirect Vulnerabilities

Popular

0.1.0

License Risk

Popular

0.1.0

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like serverless-apikey-output is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

    # Install the Snyk CLI and test your project
npm i snyk -g && snyk test serverless-apikey-output

Fix it in your project with Snyk!

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 0
Open PR: 0
Last Release: 1 year ago
Last Commit: 1 year ago

Further analysis of the maintenance status of serverless-apikey-output based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for serverless-apikey-output is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 1
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like serverless-apikey-output is missing a Code of Conduct.

Embed Package Health Score Badge

Package

Node.js Compatibility: not defined

Age: 1 year
Dependencies: 2 Direct
Versions: 2
Install Size: 26.5 kB
Dist-tags: 1
# of Files: 12
Maintainers: 1
TS Typings: Yes

serverless-apikey-output has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Serverless Api Key Output Plugin

A serverless plugin to store an API Key and it's value from your AWS CloudFormation Stack in a JSON file.

Warning!

Do not commit an API Key to your repo!

Usage

Install

$ npm install serverless-apikey-output

$ yarn add serverless-apikey-output

Configuration

plugins:
  - serverless-apikey-output

custom:
  output:
    keys: #optional: the default is to export all api keys
      - MyApiKeyName # this is the apikey "name" -- not to be confused with the cloudformation logicalId
    file: .build/stack.json # optional: the default path is '.serverless-apikey-output/${self:provider.stage}.keys.json'

Example

The plugin works by listing all resources of type "AWS::ApiGateway::ApiKey" after deployment, so it will pick up any created API Key.

Serverless.yml

service: apikey-example
provider:
  name: aws
  runtime: nodejs12.x
  apiKeys:
    - myapikey
    - ${self:provider.stage}-test-key

plugins:
  - serverless-apikey-output

functions:
  test:
    handler: handler.test
    events:
      - https:
          path: test
          method: get

custom:
  apiKeyOutput:
    keys:
      - ${self:provider.stage}-test-key # only export one of the two keys created
    file: test-keys/${self:provider.stage}.keys.json

Output Sample

[
    {
        "id": "<Physical APIKey Id>",
        "value": "<Api Key Value>",
        "name": "dev-test-key",
        "enabled": true,
        "createdDate": "2020-09-15T07:24:38.000Z",
        "lastUpdatedDate": "2020-09-15T07:24:38.000Z",
        "stageKeys": [
            "<ApiGatewayId>/dev"
        ],
        "tags": {
            "STAGE": "dev"
        }
    }
]

serverless-apikey-output dependencies

ramda shelljs

FAQs

What is serverless-apikey-output?

A serverless plugin to output api key values. Visit Snyk Advisor to see a full health score report for serverless-apikey-output, including popularity, security, maintenance & community analysis.

Is serverless-apikey-output popular?

The npm package serverless-apikey-output receives a total of 82 weekly downloads. As such, serverless-apikey-output popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is serverless-apikey-output well maintained?

We found indications that serverless-apikey-output is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is serverless-apikey-output safe to use?

The npm package serverless-apikey-output was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 14 January-2022, at 07:17 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Secure Your Project

Weekly Downloads (82)

Direct Usage Popularity

Security and license risk for significant versions

Version

Release Date

Direct Vulnerabilities

Indirect Vulnerabilities

License Risk

Commit Frequency

Embed Package Health Score Badge

Readme

Serverless Api Key Output Plugin

Warning!

Usage

Install

Configuration

Example

Serverless.yml

Output Sample

serverless-apikey-output dependencies

FAQs

What is serverless-apikey-output?

Is serverless-apikey-output popular?

Is serverless-apikey-output well maintained?

Is serverless-apikey-output safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues