sphere-customer-export

v2.0.3

Quick and easy way to export your customers from commercetools platform into CSV files, with SFTP support! For more information about how to use this package see README

Latest version published 2 months ago

License: MIT

NPM

GitHub

Package Health Score

57 / 100

security
Security review needed
popularity
Limited
maintenance
Sustainable
community
Limited

Explore Similar Packages

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
2.0.3	\|	09/2024	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.2	\|	11/2018	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.2	\|	02/2016	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.2.1	\|	02/2016	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

Limited

Weekly Downloads (7)

GitHub Stars: 2
Forks: 6
Contributors: 10

Direct Usage Popularity

The npm package sphere-customer-export receives a total of 7 downloads a week. As such, we scored sphere-customer-export popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package sphere-customer-export, we found that it has been starred 2 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: 10
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like sphere-customer-export is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 2
Open PR: 17
Last Release: 2 months ago
Last Commit: 2 months ago

Further analysis of the maintenance status of sphere-customer-export based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that sphere-customer-export 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: >= 8

Age: 9 years
Dependencies: 9 Direct
Versions: 13
Install Size: 55.3 kB
Dist-tags: 1
# of Files: 23
Maintainers: 12
TS Typings: No

sphere-customer-export 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

Customer export

This module allows to export customers to CSV, with SFTP support.

Getting started

$ npm install -g sphere-customer-export

# output help screen
$ customer-export

SFTP

Exported customer can be automatically uploaded to an SFTP server.

When using SFTP you need to provide at least the required --sftp* options:

--sftpCredentials (or --sftpHost, --sftpUsername, --sftpPassword)
--sftpSource
--sftpTarget

CSV Format

Customers exported in CSV are stored in a single file

At the moment you need to provide a --csvTemplate with headers in order to export related fields (see examples).

id,customerNumber

The following headers can be used in the CSV template

id
customerNumber
externalId
firstName
middleName
lastName
email
dateOfbirth
companyName
vatId
defaultShippingAddressId
defaultBillingAddressId
customerGroup
isEmailVerified
addressed.* - eg. id, streetName or additionalStreetInfo

In general you can get access to any property of the customer object. Find a reference in our API documentation.

Note that when at least one addresses header is given the resulting CSV contains a row per address. Otherwise it only contains one row per customer.

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt. More info here

Releasing

Releasing a new version is completely automated using the Grunt task grunt release.

grunt release // patch release
grunt release:minor // minor release
grunt release:major // major release

License

sphere-customer-export dependencies

bluebird csv optimist safe-access sphere-node-sdk sphere-node-utils tmp underscore underscore-mixins

sphere-customer-export development dependencies

coffeelint coveralls grunt grunt-bump grunt-cli grunt-coffeelint grunt-contrib-clean grunt-contrib-coffee grunt-contrib-concat grunt-contrib-watch grunt-shell istanbul jasmine-node sphere-coffeelint

FAQs

What is sphere-customer-export?

Quick and easy way to export your customers from commercetools platform into CSV files, with SFTP support!. Visit Snyk Advisor to see a full health score report for sphere-customer-export, including popularity, security, maintenance & community analysis.

Is sphere-customer-export popular?

The npm package sphere-customer-export receives a total of 7 weekly downloads. As such, sphere-customer-export popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is sphere-customer-export well maintained?

We found indications that sphere-customer-export maintenance is sustainable demonstrating some project activity. We saw a total of 10 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is sphere-customer-export safe to use?

While scanning the latest version of sphere-customer-export, 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 4 November-2024, at 18:24 (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

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (7)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

Customer export

Getting started

SFTP

CSV Format

Contributing

Releasing

License

sphere-customer-export dependencies

sphere-customer-export development dependencies

FAQs

What is sphere-customer-export?

Is sphere-customer-export popular?

Is sphere-customer-export well maintained?

Is sphere-customer-export 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