npmpackage.info

Gathering detailed insights and metrics for hashdo-web

hashdo-web

Expose #Do functionality through a web API.

0.1.94

Apache-2.0

JavaScript

51.56 kB

49,337 1.7

Installations

npm install hashdo-web

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=0.12.0

Node Version

10.5.0

NPM Version

6.1.0 Score

33.9

Supply Chain

80.1

Quality

68.9

Maintenance

Vulnerability

License

Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

View all 3 contributors

Languages

JavaScript

JavaScript (100%)

Developer

UXFoundry

Download Statistics

Total Downloads

49,337

Last Day

Last Week

Last Month

263

Last Year

1,537

GitHub Statistics

78 Commits

4 Watching

1 Branches

3 Contributors

Maintainers

Package Meta Information

Latest Version

0.1.94

Package Id

hashdo-web@0.1.94

Unpacked Size

51.56 kB

Size

18.80 kB

File Count

NPM Version

6.1.0

Node Version

10.5.0

Total Downloads

Cumulative downloads

Total Downloads

49,337

Last day

-83.3%

Compared to previous day

Last week

-68.1%

Compared to previous week

Last month

2,822.2%

263

Compared to previous month

Last year

-21.7%

1,537

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

async body-parser connect-timeout cors express hashdo hpp lodash request safe-json-parse serve-favicon

Dev Dependencies

del gulp gulp-bump gulp-doxx gulp-jsbeautifier gulp-jshint gulp-load-plugins gulp-watch jshint jshint-stylish

Versions

#Do Web

Expose #Do functionality through a web API.

Getting Started

Step 1

Install #Do into your project using NPM.

npm install hashdo-web --save

Step 2

Require it in your code.

var hdweb = require('hashdo-web');

Step 3

Setup any plugins you may want to use

1// Use MongoDB instead of default in-memory development database.
2hdweb.hashdo.db = require('hashdo-db-mongo');

Step 4

Initialise the web server.

1var baseUrl = 'https://myawesomesite.com';
2var firebaseUrl = 'https://myawesomesite.firebaseio.com';
3var port = 8080;
4var cardsDir = './node_modules';
5
6hdweb.init(baseUrl, firebaseUrl, port, cardsDir);

Step 5

Setup your own routes and/or middleware.

1hdweb.express.get('/', function (req, res) {
2  res.redirect('http://myawesomesite.com');
3});

Step 6

Start the web server.

1hdweb.start(function () {
2  console.log('#Do web server is ready to go!');
3});

Routes

The following routes are created to access #Do functionality through HTTP calls.

API

GET /api/count

Retrieve the number of cards that have been loaded in JSON format.

GET /api/cards?q=&page=

Retrieve the details for cards that have been loaded in JSON format. Parameter q can be used to provide a filter for card names. Parameter page will return the list of card on the requested page number. A maximum of 20 cards will be displayed per page.

GET /api/card?pack=&card=

Retrieve the details for a specific card. Parameter pack refers to the pack name the card belongs to. Parameter card is the card name.

POST /api/card/state/save

Allows saving card state directly from the client. This is called from client code using card.state.save which is available when clientStateSupport is enabled for your card.

POST /api/card/analytics

Allows sending analytics data directly from the client. This is called from client code using card.analytics.record which is available when clientAnalyticsSupport is enabled for your card.

Web Hook

POST /webhook/:pack/:card

Can be called to update a card's state from an external system. The body data must be JSON and will be passed into your card's webHook function for processing.

Cards

POST /:pack/:card

Secures any body data (secure card inputs) and responds with a token that can be used to decrypt that data. The body data must be JSON and will typically be any card inputs that need to be protected.

GET /:pack/:card

Gets card HTML (including inline JavaScript and CSS) for a specific card. URL query parameters are used for card inputs. token can be used to pass in any secured inputs.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

SAST

Determines if the project uses static code analysis.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

77 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-wrw9-m778-g6mc
Warn: Project is vulnerable to: GHSA-pp7h-53gx-mx7r
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-832h-xg76-4gv6
Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-4vmm-mhcq-4x9j
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-rq8g-5pc5-wrhr
Warn: Project is vulnerable to: GHSA-9vvw-cc9w-f27h
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-hr2v-3952-633q
Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-xf7w-r453-m56c
Warn: Project is vulnerable to: GHSA-jcpv-g9rr-qxrc
Warn: Project is vulnerable to: GHSA-44pw-h2cw-w3vq
Warn: Project is vulnerable to: GHSA-jp4x-w63m-7wgm
Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-4hpf-3wq7-5rpr
Warn: Project is vulnerable to: GHSA-f522-ffg8-j8r6
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-282f-qqgm-c34q
Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
Warn: Project is vulnerable to: GHSA-fvqr-27wr-82fm
Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574
Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-vfvf-mqq8-rwqc
Warn: Project is vulnerable to: GHSA-7px7-7xjx-hxm8
Warn: Project is vulnerable to: GHSA-x5pg-88wf-qq4p
Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj
Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-hxm2-r34f-qmc5
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-w9mr-4mfr-499f
Warn: Project is vulnerable to: GHSA-265q-28rp-chq5
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
Warn: Project is vulnerable to: GHSA-gqgv-6jq5-jjj9
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-6g33-f262-xjp4
Warn: Project is vulnerable to: GHSA-7xfp-9c55-5vqj
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
Warn: Project is vulnerable to: GHSA-2m39-62fm-q8r3
Warn: Project is vulnerable to: GHSA-mf6x-7mm4-x2g7
Warn: Project is vulnerable to: GHSA-gfjr-3jmm-4g9v
Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-qhv9-728r-6jqg
Warn: Project is vulnerable to: GHSA-g7q5-pjjr-gqvp
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-xc7v-wxcw-j472
Warn: Project is vulnerable to: GHSA-34r7-q49f-h37c
Warn: Project is vulnerable to: GHSA-c9f4-xj24-8jqx

Score

1.7

/10

Last Scanned on 2025-01-27

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