@segment/facade

# facade

[![CircleCI](https://circleci.com/gh/segmentio/facade.svg?style=shield&circle-token=82b4b760c18fa8d1e41191230a808f2139d0a3f4)](https://circleci.com/gh/segmentio/facade)
[![Codecov](https://img.shields.io/codecov/c/github/segmentio/facade/master.svg?maxAge=2592000)](https://codecov.io/gh/segmentio/facade)

Facade provides common fields for analytics integrations. Wraps the Segment.io
API for use on the server or client.

## Documentation

See auto-generated documentation at [facade.segment.com](http://facade.segment.com/).

## Contributing

Make a pull request as usual. Be sure to update documentation if appropriate.
If you've updated the JSDoc for any of the functions, please run:

```
$ make docs
```

Include resulting changes to the `docs/` directory in your pull request.
Include them in a separate commit, so that your actual code/doc changes are
easy to distinguish.

## License

Released under the [MIT license](License.md).


[ci-link]: https://travis-ci.org/segmentio/facade
[ci-1.x-badge]: https://travis-ci.org/segmentio/facade.png?branch=1.x
[ci-2.x-badge]: https://travis-ci.org/segmentio/facade.png?branch=master


Providing common fields for analytics integrations. 

Providing common fields for analytics integrations

cjradek

segment-admin

segmentio

achille-roussel

aghotikar

alistairbarrell

amaloney

amillet89

andrius-segment

andyguwc

ariel_segment

av-segment

bgamwell

bradenbecker

bsneed

celine-segment

cfree

cholt002

csayuso

dan.lasky

danieljackins

dominicbarnes

drew-thompson

eesegment

eric.rogner

erikdw

fhalim-segment

gilomer

hjoonpm

hmorgan94

james9446

jeremy.parker

jeremylarkin

jfabre-segment

jinapark

jon.anderson-at-segment.com

kdharaiya

kelcook

kellylu

khamidou-segment

khinkalilover

kiara.daswani

kyliepedersen

larryatsegment

lbrink

leifdreizler

lew-gordon

marcelopv

marinhero

markzegarelli

masira

mericsson

mpriyad25

n2parko

nickaguilar

niveda.balananthan

nlsun

parsa-segment

peter.walker

pmcanseco-segment

pooyaj

prayansh-segmentt

priscilla.giatti

reneewang

rexatsegment

sahilp

sam.tapia

scruwys1

segment-jsingh

segment-seth

shivpoojan-segment

smidges

stacy.song

steve_at_segment

tyson_segment

uditmehta

valerieernst

vikramkumar19

vikrant-segment

ynguyen

peterdemartini

simpixelated

forgetfulfellow

jalexy12

pmunin

teganduong

ricardo.rossi

chenxiangzhang

rajulvadera

salolivares

lpediredla

psankaranarayana

sachinwathore

krousseau

oscb

sudojatin

hema-segment

seghungtran

jyim008

(Experimental) An ambiguous license classifier was found.

What is an ambiguous license classifier?

Ambiguous License Classifier

Source files are encoded using a non-standard text encoding.

What is bad text encoding?

Bad text encoding

Package version is not a valid semantic version (semver).

What is bad semver?

Bad semver

Package has dependencies with an invalid semantic version. This could be a sign of beta, low quality, or unmaintained dependencies.

What is bad dependency semver?

Bad dependency semver

Source files contain bidirectional unicode control characters. This could indicate a Trojan source supply chain attack. See: trojansource.codes for more information.

What are bidirectional unicode control characters?

Bidirectional unicode control characters

This package has multiple bin scripts with the same name.  This can cause non-deterministic behavior when installing or could be a sign of a supply chain attack

What is bin script confusion?

Bin script confusion

Semantic versions published out of chronological order.

What is a chronological version anomaly?

Chronological version anomaly

Project maintainer's SSH key has been compromised.

What is a compromised SSH key?

Compromised SSH key

(Experimental) Copyleft license information was found

What do I need to know about license files?

Copyleft License

Contains a Critical Common Vulnerability and Exposure (CVE).

What is a critical CVE?

Title

Critical CVE

Contains a high severity Common Vulnerability and Exposure (CVE).

What is a CVE?

High CVE

Uses debug, reflection and dynamic code execution features.

What is debug access?

Debug access

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

What is a deprecated package?

Deprecated

(Experimental) Contains a known deprecated SPDX license exception.

What is a deprecated SPDX exception?

Deprecated SPDX exception

(Experimental) License is deprecated which may have legal implications regarding the package's use.

What is a deprecated license?

Deprecated license

Package name is similar to other popular packages and may not be the package you want.

What is a typosquat?

Possible typosquat attack

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

What is dynamic require?

Dynamic require

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

What is an empty package?

Empty package

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

What is environment variable access?

Environment variable access

(Experimental) Something was found which is explicitly marked as unlicensed

Explicitly Unlicensed Item

Package optionally loads a dependency which is not specified within any of the package.json dependency fields. It may inadvertently be importing dependencies specified by other packages.

What are extraneous dependencies?

Name

Extraneous dependency

Contains a dependency which resolves to a file. This can obfuscate analysis and serves no useful purpose.

What are file dependencies?

File dependency

Accesses the file system, and could potentially read sensitive data.

What is filesystem access?

Filesystem access

Package has a dependency with a floating version range.  This can cause issues if the dependency publishes a new major version.

What are floating dependencies?

Floating dependency

Contains a dependency which resolves to a remote git URL. Dependencies fetched from git URLs are not immutable can be used to inject untrusted code or reduce the likelihood of a reproducible install.

What are git dependencies?

Git dependency

Contains a dependency which resolves to a GitHub URL. Dependencies fetched from GitHub specifiers are not immutable can be used to inject untrusted code or reduce the likelihood of a reproducible install.

What are GitHub dependencies?

GitHub dependency

AI has identified unusual behaviors that may pose a security risk.

What is an AI detected anomaly?

AI detected anomaly

AI has identified this package as malware. This is a strong signal that the package may be malicious.

What is AI detected malware?

AI detected potential malware

AI has determined that this package may contain potential security issues or vulnerabilities.

What are AI detected security risks?

AI detected security risk

Contains native code which could be a vector to obscure malicious code, and generally decrease the likelihood of reproducible or reliable installs.

What's wrong with native code?

Native code

Contains high entropy strings. This could be a sign of encrypted data, leaked secrets or obfuscated code.

What are high entropy strings?

High entropy strings

Contains unicode homoglyphs which can be used in supply chain confusion attacks.

What are unicode homoglyphs?

Unicode homoglyphs

Contains a dependency which resolves to a remote HTTP URL which could be used to inject untrusted code and reduce overall package reliability.

What are http dependencies?

HTTP dependency

@segment/facade

facade

Documentation

Contributing

License

Related posts

The Alarming NVD Backlog: Over 50% of Known Exploited Vulnerabilities Await Analysis

The Push to Ban Ransom Payments Is Gaining Momentum