@things-factory/attachment-base

v7.0.1-alpha.34

Server-side module for handling upload attachment. S3 Bucket and local folder attachment. For more information about how to use this package see README

Latest version published 2 days ago

License: MIT

NPM

GitHub

Package Health Score

60 / 100

security
Security review needed
popularity
Small
maintenance
Sustainable
community
Limited

Security

Security review needed

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

Security and license risk for significant versions

All Versions

Version			Vulnerabilities	License Risk
7.0.1-alpha.34	\|	04/2024	0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.3.452	\|	04/2024	0 C 0 H 0 M 0 L	0 H 0 M 0 L
6.2.147	\|	04/2024	0 C 0 H 0 M 0 L	0 H 0 M 0 L
5.0.15	\|	09/2022	0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.2.12	\|	04/2022	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (2,876)

GitHub Stars: 5
Forks: 1
Contributors: 20

Direct Usage Popularity

The npm package @things-factory/attachment-base receives a total of 2,876 downloads a week. As such, we scored @things-factory/attachment-base popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package @things-factory/attachment-base, we found that it has been starred 5 times.

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

Community

Limited

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

With more than 10 contributors for the @things-factory/attachment-base repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like @things-factory/attachment-base is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 45
Open PR: 0
Last Release: 2 days ago
Last Commit: 3 years ago

Further analysis of the maintenance status of @things-factory/attachment-base based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that @things-factory/attachment-base demonstrates a positive version release cadence with at least one new version released in the past 3 months.

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

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

Package

Node.js Compatibility: not defined

Age: 5 years
Dependencies: 10 Direct
Versions: 728
Install Size: 1.02 MB
Dist-tags: 1
# of Files: 74
Maintainers: 10
TS Typings: No

@things-factory/attachment-base 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

Creating S3 Bucket and Access Key Pair

In my opinion, it is better to have unique s3 bucket and aws permissions for each project. This document is for initial s3 configuration of the project you will be using.

1. Creating S3 Bucket

create-s3-bucket Go to AWS Console for S3 Service

create-s3-bucket Create a bucket for your project. Fill name, region and other are default configuration.

2. Add User

add-user Move to AWS Console for IAM and select 'Access Management - Users' And Click 'Add Users'

add-user Set User name and check for 'Access Key' as credential type.

Policy for accessing S3 bucket

create-policy We need to create a policy for accessing s3 bucket you've made before. Select 3rd one in 'Set permissions' section. And click 'Create Policy', It'll open new tab of your browser.

create-policy Click JSON tab and edit for yours.

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": "s3:*",
            "Resource": [
                "arn:aws:s3:::my-project-attachments",
                "arn:aws:s3:::my-project-attachments/*"
            ]
        }
    ]
}

create-policy Set Name for the last step and finish creating the policy.

Assign the policy to user

add-user Now you can find new policy with 'refresh icon' button. Check the new one and go next.

add-user Finally, you can get access key pair.

@things-factory/attachment-base dependencies

@aws-sdk/client-s3 @aws-sdk/lib-storage @aws-sdk/s3-presigned-post @azure/storage-blob @koa/multer @things-factory/auth-base @things-factory/env @things-factory/shell mime multer

FAQs

What is @things-factory/attachment-base?

Server-side module for handling upload attachment. S3 Bucket and local folder attachment. Visit Snyk Advisor to see a full health score report for @things-factory/attachment-base, including popularity, security, maintenance & community analysis.

Is @things-factory/attachment-base popular?

The npm package @things-factory/attachment-base receives a total of 2,876 weekly downloads. As such, @things-factory/attachment-base popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @things-factory/attachment-base well maintained?

We found indications that @things-factory/attachment-base maintenance is sustainable demonstrating some project activity. We saw a total of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @things-factory/attachment-base safe to use?

While scanning the latest version of @things-factory/attachment-base, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 18 April-2024, at 02:07 (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