3 |
17 | {{>_footer}}
18 |
--------------------------------------------------------------------------------
/template/_N01.html:
--------------------------------------------------------------------------------
1 |
4 |
5 |
15 |
16 | | Time | 7 |Event | 8 |User | 9 |Message | 10 |Module | 11 |Version | 12 |
|---|
Node Names
2 |Requirements
3 |Nodes SHOULD use unique names. 4 | The tool will check the names for each node in your package against other packages already published to the catalog and highlight any duplicates.
5 |Reason
6 |A user cannot install two different nodes that use the same name.
7 |Reference
8 |https://nodered.org/docs/creating-nodes/packaging#packagejson
9 | 10 | -------------------------------------------------------------------------------- /template/search.html: -------------------------------------------------------------------------------- 1 | {{>_header}} 2 |
3 | {{>_gistlist}}
4 |
5 | {{>_footer}}
6 |
17 |
--------------------------------------------------------------------------------
/template/_P08.html:
--------------------------------------------------------------------------------
1 | Similar Names
2 |Requirements
3 |The package should use a unique name. 4 | The tool will check for packages of the same name with a different scope and these may be highlighted to the user.
5 |Reason
6 |Packages should use unique names. When a package is abandoned and another developer updates it and publishes a fork under their own scope, this will help users to identify that they are similar packages. The README should be clear when a package is a fork and what the changes are.
7 |Reference
8 | 9 | -------------------------------------------------------------------------------- /template/_collectionbox.html: -------------------------------------------------------------------------------- 1 |{{name}}
4 |{{summary}}
5 | 11 | 12 |Package.json must contain a Repository or Bugs URL or Email
2 |Requirement
3 |The package.json file MUST contain either a repository object or a bugs object.
4 | If bugs is specified then either a URL or an email address can by supplied.
Reason
6 |This is so that users can report bugs and request support when using the package.
7 |Reference
8 |https://docs.npmjs.com/cli/v7/configuring-npm/package-json#bugs
9 | 10 | -------------------------------------------------------------------------------- /template/_gistbox.html: -------------------------------------------------------------------------------- 1 |{{description}}
3 |{{summary}}
4 | 10 | 11 | {{>_gistboxTools}} 12 |Bad Packages
2 |Requirements
3 |The tool will check that any packages with known incompatibilities to Node-RED core are not used in the dependency tree.
4 |Reason
5 |As of Oct 2021 there has only been one package that caused an issue, (agent-base <6.0.0). However this facility allows us to expand this list should the need arise in the future.
6 |Reference
7 |https://github.com/node-red/node-red-dev-cli/blob/main/src/badpackages.json
8 | 9 | -------------------------------------------------------------------------------- /template/user.html: -------------------------------------------------------------------------------- 1 | {{>_header}} 2 |
3 |
11 |
4 | {{#user.avatar_url}}
{{/user.avatar_url}}
5 | {{^user.avatar_url}}{{/user.avatar_url}}
6 |
9 |
10 |
12 | {{#query}}{{>_gistlist}}{{/query}}
13 |
14 | {{>_footer}}
15 |
--------------------------------------------------------------------------------
/tasks/refresh-gist.js:
--------------------------------------------------------------------------------
1 | const db = require('../lib/db')
2 | const gists = require('../lib/gists')
3 |
4 | const id = process.argv[2]
5 |
6 | if (!id) {
7 | console.log('Usage: node refresh-gist.js
3 | {{#iconFA}}
9 | {{/iconFA}}
4 | {{#iconUrl}}{{/iconUrl}}
5 |
{{name}}
6 | {{#hasOutputs}}{{/hasOutputs}}
7 | {{#hasInputs}}{{/hasInputs}}
8 | Examples
2 |Requirements
3 |The package SHOULD include example flows that demonstrate each node. 4 | The tool will check the examples folder (and any nested folders) for json flow files. It will then iterate over these files and look at the nodes used in the flows to ensure that all nodes declared in the package are used in an example at least once. Config nodes are excluded from the check.
5 |Reason
6 |Examples are an excellent way for users to understand how to use a node.
7 |Reference
8 |https://nodered.org/docs/creating-nodes/examples
9 | 10 | -------------------------------------------------------------------------------- /routes/admin.js: -------------------------------------------------------------------------------- 1 | const express = require('express') 2 | const mustache = require('mustache') 3 | 4 | const events = require('../lib/events') 5 | const templates = require('../lib/templates') 6 | 7 | const app = express() 8 | app.get('/admin/log', async function (req, res) { 9 | const context = {} 10 | context.sessionuser = req.session.user 11 | try { 12 | context.events = await events.get() 13 | res.send(mustache.render(templates.events, context, templates.partials)) 14 | } catch (err) { 15 | console.log(err) 16 | context.err = err 17 | context.events = [] 18 | res.send(mustache.render(templates.events, context, templates.partials)) 19 | } 20 | }) 21 | 22 | module.exports = app 23 | -------------------------------------------------------------------------------- /template/_nodebox.html: -------------------------------------------------------------------------------- 1 |{{name}}
3 |{{description}}
4 | 12 | 13 | {{>_gistboxTools}} 14 |Minimum Node-RED version
2 |Requirements
3 |Within the node-red section of the package.json file the developer SHOULD indicate the minimum supported version. This must satisfy at least one of the current latest or maintenance tagged releases.
eg
5 |"node-red" : {
6 | "version": ">=2.0.0",
7 | }Reason
9 |This is so that users can identify nodes that rely on new features in latest versions of Node-RED.
10 |Reference
11 |https://nodered.org/docs/creating-nodes/packaging#packagejson
12 | 13 | -------------------------------------------------------------------------------- /template/_P05.html: -------------------------------------------------------------------------------- 1 |Node-RED Keyword
2 |Requirements
3 |The package.json must contain the keyword node-red eg
"keywords": [ "node-red" ],Reason
6 |This identifies the package as a Node-RED module rather than a more generic node package.
7 |Without this keyword set, it will not be listed on the Flow Library, but it will still be npm installable.
8 |
9 | If the module is not yet ready for wider use by the Node-RED community, you should not include the keyword.
10 |
Reference
12 |https://nodered.org/docs/creating-nodes/packaging#packagejson
13 | 14 | -------------------------------------------------------------------------------- /tasks/update-one.js: -------------------------------------------------------------------------------- 1 | const db = require('../lib/db') 2 | const npmModules = require('../lib/modules') 3 | const npmNodes = require('../lib/nodes') 4 | const name = process.argv[2] 5 | 6 | if (!name) { 7 | console.log('Usage: node update-one.jsLicense
2 |Requirement
3 |The package.json MUST contain a key of license that specifies the type of license used, this can be either an open source license or your own proprietary license. The value should be either a recognised SPDX ID or refer to a filename within the package for a custom license.
Reason
5 |The package must specify a license so that users can have confidence they are permitted to use it and understand any restrictions on its use.
6 |Reference
7 |https://docs.npmjs.com/cli/v7/configuring-npm/package-json#license
8 | -------------------------------------------------------------------------------- /template/_gistboxTools.html: -------------------------------------------------------------------------------- 1 | {{#showTools}} 2 |
3 |
4 | {{#ownedCollection}}
5 |
6 |
7 | {{/ownedCollection}}
8 | {{^ownedCollection}}
9 |
10 | {{/ownedCollection}}
11 |
12 | {{/showTools}}
13 |
--------------------------------------------------------------------------------
/default-settings.js:
--------------------------------------------------------------------------------
1 | var path = require('path');
2 |
3 | var settings = {
4 | port: 8080,
5 | github: {
6 | clientId: "",
7 | secret: "",
8 | authCallback: "http://localhost:8080/login/callback",
9 | accessToken: ""
10 | },
11 | mongo: {
12 | url: 'mongodb://mongo/flows'
13 | },
14 | session: {
15 | key: 'nr.sid',
16 | secret: 'giraffe'
17 | },
18 | admins: ["knolleary","dceejay"],
19 | mastodon: {
20 | url: '',
21 | token: ''
22 | },
23 | slack: {
24 | webhook: ''
25 | },
26 | modules: {
27 | block: []
28 | },
29 | aws: {
30 | iconBucket: "",
31 | accessKeyId: "",
32 | secretAccessKey: "",
33 | region: ""
34 | }
35 | };
36 |
37 | module.exports = settings;
--------------------------------------------------------------------------------
/template/_P07.html:
--------------------------------------------------------------------------------
1 | Minimum Node.js version
2 |Requirements
3 |Within the engines section of the package.json file you SHOULD declare the minimum version of Node that your package works on.
4 | This SHOULD satisfy the current minimum supported version of the latest Node-RED release.
6 | {
7 | "engines": {
8 | "node": ">=12.0.0"
9 | }
10 | }Reason
12 |Node-RED has supported multiple versions of Node in its history and some of these have become end of life, this helps users identify if a node will run on their installation.
13 |Reference
14 |https://docs.npmjs.com/cli/v7/configuring-npm/package-json#engines
15 | -------------------------------------------------------------------------------- /.github/scripts/generate-catalog.sh: -------------------------------------------------------------------------------- 1 | echo "Generating catalogue" 2 | node ./flow-library/tasks/generate_catalog.js > ./catalogue.nodered.org/catalogue.json.new 3 | if [ $? -ne 0 ]; then 4 | exit 5 | fi 6 | 7 | node ./flow-library/.github/scripts/compare-catalogs.js 8 | RC=$? 9 | echo RC=$RC 10 | if [ $RC -eq 0 ]; then 11 | echo "Nothing to do" 12 | exit 13 | fi 14 | 15 | echo "Updating catalogue" 16 | cd catalogue.nodered.org 17 | mv catalogue.json.new catalogue.json 18 | echo "Node-RED community node module catalogue" > index.html 19 | echo "Updated: " >> index.html 20 | date >> index.html 21 | git config --global user.name "node-red-flow-library" 22 | git config --global user.email "node-red-flow-library@users.noreply.github.com" 23 | git add catalogue.json index.html 24 | git commit -m "Update catalogue" 25 | git push origin master -------------------------------------------------------------------------------- /template/_gistitems.html: -------------------------------------------------------------------------------- 1 | {{#things}} 2 | {{#isNode}}{{>_nodebox}}{{/isNode}} 3 | {{#isFlow}}{{>_gistbox}}{{/isFlow}} 4 | {{#isCollection}}{{>_collectionbox}}{{/isCollection}} 5 | {{/things}} 6 | {{^things}} 7 |
Number of Dependencies
2 |Requirements
3 |The tool will check the number of dependencies in the package.json and warn if there are more than six. 4 | devDependencies are not counted.
5 |Reason
6 |95% of all published Node-RED modules had less than six dependencies when tested (Oct 2021).
7 | Occasionally packages include a large number of unused dependencies, including the node-red package itself!
8 | This isn't meant to be a hard limit, just a warning to check that everything in your dependencies list is indeed needed. Some packages may have
9 | a legitimate reason to have a lot of dependencies and this can be noted in the README
Reference
11 |https://docs.npmjs.com/cli/v7/configuring-npm/package-json#dependencies
12 | 13 | -------------------------------------------------------------------------------- /lib/templates.js: -------------------------------------------------------------------------------- 1 | const fs = require('fs') 2 | const path = require('path') 3 | 4 | const mustache = require('mustache') 5 | 6 | const renderTemplates = {} 7 | const partialTemplates = {} 8 | const templateDir = path.join(__dirname, '..', 'template') 9 | 10 | fs.readdir(templateDir, function (_, files) { 11 | files.forEach(function (fn) { 12 | if (/.html$/.test(fn)) { 13 | const partname = fn.substring(0, fn.length - 5) 14 | fs.readFile(path.join(templateDir, fn), 'utf8', function (_, data) { 15 | if (fn[0] === '_') { 16 | partialTemplates[partname] = data 17 | } else { 18 | mustache.parse(data) 19 | renderTemplates[partname] = data 20 | } 21 | }) 22 | } 23 | }) 24 | }) 25 | 26 | renderTemplates.partials = partialTemplates 27 | module.exports = renderTemplates 28 | -------------------------------------------------------------------------------- /template/_collectionNavBox.html: -------------------------------------------------------------------------------- 1 | {{#collection}} 2 | 10 | {{/collection}} 11 | -------------------------------------------------------------------------------- /template/_rateTools.html: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /template/_D03.html: -------------------------------------------------------------------------------- 1 |Out of Date Dependencies
2 |Requirements
3 |The tool will check the dependencies listed in the package.json and if there is a newer version that does not satisfy the stated version it will flag a warning. 4 | For example if your dependencies are:
5 |{ "acme" : "~1.0.0"}And the latest version of acme is 1.1.3 then this will not warn as the latest version will be installed when the package is added to node-red. 7 | However if acme is at 2.0.0 it would flag a warning.
8 |Reason
9 |Packages are often updated to include security fixes so users should be able to use the newest version available. 10 | When your package needs to use an older version this should be noted in the README
11 |Reference
12 |https://docs.npmjs.com/cli/v7/configuring-npm/package-json#dependencies
13 | 14 | -------------------------------------------------------------------------------- /template/categories.html: -------------------------------------------------------------------------------- 1 | {{>_header}} 2 | 3 |
4 |
22 |
26 |
27 | {{>_footer}}
28 |
--------------------------------------------------------------------------------
/template/_P02.html:
--------------------------------------------------------------------------------
1 |
5 | {{#message}}
6 |
7 |
14 | {{/message}}
15 | {{ #isAdmin }}
16 |
17 | {{/isAdmin}}
18 |
20 | {{{ category.description }}}
19 |- {{#categories}}{{>_categoryBox}}{{/categories}}
Check package name in repository is the same name as the package.json
2 |Requirement
3 |The name field in the package.json SHOULD match the name field in the package.json hosted within the repository specified in the package.json.
4 |Reason
5 |This is to check for forked nodes where the publisher has forked an original repo and published the node under a new name but not updated the repo to point to their own new copy. This can result in authors of the original node getting issues raised against their repository for a downstream fork.
6 |Note
7 |This test may fail when you are validating a local copy of the package and it has not yet been published, or when the code has not been published in a repository.
8 |Where code is part of a mono-repo you should use the directory key within repository to point to the path where the package.json is located.
Reference
10 |https://docs.npmjs.com/cli/v7/configuring-npm/package-json#name
11 | 12 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: PublishUpdatedCatalog 2 | 3 | on: 4 | workflow_dispatch: 5 | schedule: 6 | - cron: '*/30 * * * *' 7 | jobs: 8 | generate: 9 | name: 'Update Flow Library Catalogue' 10 | runs-on: ubuntu-latest 11 | steps: 12 | - name: Check out flow-library repository 13 | uses: actions/checkout@v2 14 | with: 15 | path: 'flow-library' 16 | - name: Check out catalogue.nodered.org repository 17 | uses: actions/checkout@v2 18 | with: 19 | repository: 'node-red/catalogue.nodered.org' 20 | path: 'catalogue.nodered.org' 21 | token: ${{ secrets.FLOW_LIBRARY_PAT }} 22 | ref: 'master' 23 | - uses: actions/setup-node@v1 24 | with: 25 | node-version: '18' 26 | - name: npm install 27 | run: | 28 | cd flow-library 29 | npm install --only=production 30 | - name: Run update 31 | env: 32 | NR_MONGO_URL: ${{ secrets.NR_MONGO_URL }} 33 | FLOW_ENV: PRODUCTION 34 | run: ./flow-library/.github/scripts/generate-catalog.sh 35 | 36 | -------------------------------------------------------------------------------- /template/category.html: -------------------------------------------------------------------------------- 1 | {{>_header}} 2 | 3 |
4 |
22 |
5 | {{#message}}
6 |
7 |
14 | {{/message}}
15 |
21 | {{ category.name }}
16 | {{ #isAdmin }} 17 | 18 | {{/isAdmin}} 19 |{{{ category.description }}}
20 |
23 | {{#query}}{{>_gistlist}}{{/query}}
24 |
25 |
29 |
30 | {{>_footer}}
31 |
--------------------------------------------------------------------------------
/template/_P04.html:
--------------------------------------------------------------------------------
1 | Naming
2 |Requirements
3 |New packages published to npm after 1st December 2021 should use a scoped name, they may then use any value in their package name eg @devname/acme-node-red
Packages first published before this date can use unscoped names, however when the package name starts with node-red (or nodered then it MUST use node-red-contrib
The following names would be allowed:
6 | node-red-contrib-acme
7 | nodered-contrib-acme
8 | acme-nodered
The following would not be allowed:
10 | node-red-acme
11 | nodered-acme
Reason
13 |Initially the contrib formatting was used to distinguish 3rd party nodes from core nodes created by the project. 14 | As the number of nodes has grown the namespace has become more cluttered, a move to scoped names will allow for cleaner naming of nodes by service providers. 15 | Scoped names also allow for a developer to fork an abandoned node and publish a new version with the same pacakge name but within their scope. This makes it clearer to users where multiple packages exist.
16 |Reference
17 |https://nodered.org/docs/creating-nodes/packaging#naming
18 | 19 | -------------------------------------------------------------------------------- /lib/aws.js: -------------------------------------------------------------------------------- 1 | const fs = require('fs') 2 | 3 | const AWS = require('aws-sdk') 4 | 5 | const settings = require('../config') 6 | 7 | AWS.config.update(settings.aws) 8 | 9 | const s3 = new AWS.S3({ apiVersion: '2006-03-01' }) 10 | 11 | async function upload (pathToFile, fileName) { 12 | return new Promise((resolve, reject) => { 13 | const uploadParams = { Bucket: settings.aws.iconBucket, Key: '', Body: '' } 14 | 15 | if (/\.svg$/i.test(pathToFile)) { 16 | uploadParams.ContentType = 'image/svg+xml' 17 | } else if (/\.png$/i.test(pathToFile)) { 18 | uploadParams.ContentType = 'image/png' 19 | } else if (/\.jpg/i.test(pathToFile)) { 20 | uploadParams.ContentType = 'image/jpeg' 21 | } else if (/\.gif/i.test(pathToFile)) { 22 | uploadParams.ContentType = 'image/gif' 23 | } 24 | 25 | const fileStream = fs.createReadStream(pathToFile) 26 | fileStream.on('error', function (err) { 27 | reject(err) 28 | }) 29 | uploadParams.Body = fileStream 30 | uploadParams.Key = fileName 31 | s3.upload(uploadParams, function (err, data) { 32 | if (err) { 33 | reject(err) 34 | } if (data) { 35 | resolve(data.Location) 36 | } 37 | }) 38 | }) 39 | } 40 | 41 | module.exports = { 42 | upload 43 | } 44 | -------------------------------------------------------------------------------- /routes/api.js: -------------------------------------------------------------------------------- 1 | const express = require('express') 2 | 3 | const npmNodes = require('../lib/nodes') 4 | const view = require('../lib/view') 5 | 6 | const app = express() 7 | 8 | /** 9 | * get flows and nodes that match query params 10 | */ 11 | app.get('/api/v1/search', async function (req, res) { 12 | const result = await view.getForQuery(req.query) 13 | res.json(result) 14 | }) 15 | 16 | app.get('/api/types/:type', async function (req, res) { 17 | try { 18 | const typeMap = await npmNodes.findTypes([req.params.type]) 19 | res.json(typeMap[req.params.type] || (npmNodes.CORE_NODES[req.params.type] ? ['@node-red/nodes'] : [])) 20 | } catch (err) { 21 | console.log(err) 22 | res.send(400) 23 | } 24 | }) 25 | app.post('/api/types', async function (req, res) { 26 | const typeList = req.body.types || [] 27 | 28 | const result = {} 29 | 30 | if (Array.isArray(typeList)) { 31 | const typeMap = await npmNodes.findTypes(typeList) 32 | typeList.forEach(function (t) { 33 | if (typeMap[t]) { 34 | result[t] = typeMap[t] 35 | } else if (npmNodes.CORE_NODES[t]) { 36 | result[t] = ['@node-red/nodes'] 37 | } else { 38 | result[t] = [] 39 | } 40 | }) 41 | res.json(result) 42 | } else { 43 | res.end(400) 44 | } 45 | }) 46 | module.exports = app 47 | -------------------------------------------------------------------------------- /template/index.html: -------------------------------------------------------------------------------- 1 | {{>_header}} 2 | {{^sessionuser}} 3 |
4 |
16 | {{/sessionuser}}
17 |
18 | {{#nodes}}
19 |
5 |
15 |
6 |
11 |
7 |
10 | Node-RED Library
8 |Find new nodes, share your flows and see what other people have done with Node-RED.
9 |
12 |
13 |
14 |
20 |
21 | {{>_gistlist}}
22 |
23 | {{/nodes}}
24 |
25 | {{#flows}}
26 | Recent nodes
see more ({{count}})
27 |
28 | {{>_gistlist}}
29 |
30 | {{/flows}}
31 |
32 |
33 | {{#collections}}
34 | Recent flows
see more ({{count}})
35 |
36 | {{>_gistlist}}
37 |
38 | {{/collections}}
39 |
40 | {{>_footer}}
41 |
--------------------------------------------------------------------------------
/template/_nodelist.html:
--------------------------------------------------------------------------------
1 |
2 | Recent collections
see more ({{count}})
3 |
12 |
4 |
11 |
5 |
6 |
7 |
8 |
9 |
10 |
13 |
18 |
19 |
57 |
--------------------------------------------------------------------------------
/tasks/generate_catalog.js:
--------------------------------------------------------------------------------
1 | const db = require('../lib/db')
2 | const viewster = require('../lib/view')
3 |
4 | ;(async function () {
5 | await db.init()
6 | try {
7 | const things = await viewster.get({ type: 'node' }, null, {
8 | _id: 1,
9 | updated_at: 1,
10 | 'dist-tags.latest': 1,
11 | official: 1,
12 | description: 1,
13 | keywords: 1,
14 | types: 1,
15 | categories: 1,
16 | downloads: 1,
17 | deprecated: 1
18 | })
19 | const modules = things.map(function (t) {
20 | return {
21 | id: t._id,
22 | version: t['dist-tags'].latest,
23 | description: t.description,
24 | updated_at: t.updated_at,
25 | types: t.types,
26 | keywords: t.keywords,
27 | categories: t.categories,
28 | url: 'https://flows.nodered.org/node/' + t._id,
29 | downloads: t.downloads,
30 | deprecated: t.deprecated || undefined
31 | }
32 | })
33 |
34 | console.log('{')
35 | console.log(' "name": "Node-RED Community catalogue",')
36 | console.log(' "updated_at": "' + (new Date()).toISOString() + '",')
37 | console.log(' "modules":')
38 | console.log(JSON.stringify(modules))
39 | console.log('}')
40 | } catch (err) {
41 | console.log(err)
42 | process.exitCode = 1
43 | } finally {
44 | await db.close()
45 | }
46 | })()
47 |
--------------------------------------------------------------------------------
/template/_rulemodal.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
14 |
17 | - {{#nodes}}{{>_nodebox}}{{/nodes}}
15 |
5 |
10 |
11 |
12 |
57 |
--------------------------------------------------------------------------------
/template/_tagTools.html:
--------------------------------------------------------------------------------
1 | {{#owned}}
2 |
3 |
49 | {{/owned}}
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "node-red-flows",
3 | "version": "0.2.0",
4 | "scripts": {
5 | "test": "mocha test/**/*_spec.js --exit",
6 | "start": "node app.js",
7 | "nodemon": "nodemon --ext js,html --inspect=0.0.0.0:5858 --ignore data/ ./app.js",
8 | "dev": "npm run nodemon",
9 | "docker": "docker-compose -f docker-compose.yml up --build"
10 | },
11 | "dependencies": {
12 | "acorn": "8.12.1",
13 | "acorn-walk": "8.3.4",
14 | "aws-sdk": "2.1691.0",
15 | "body-parser": "1.20.3",
16 | "dompurify": "3.1.7",
17 | "connect-mongo": "5.1.0",
18 | "cookie-parser": "1.4.7",
19 | "csurf": "1.11.0",
20 | "express": "4.21.1",
21 | "express-rate-limit": "7.4.1",
22 | "express-session": "1.18.1",
23 | "fs-extra": "11.2.0",
24 | "jsdom": "25.0.1",
25 | "marked": "14.1.2",
26 | "mastodon": "1.2.2",
27 | "mongodb": "6.9.0",
28 | "mustache": "4.2.0",
29 | "node-red-dev": "^0.1.6",
30 | "oauth": "0.10.0",
31 | "request": "2.88.2",
32 | "serve-static": "1.16.2",
33 | "tar": "7.4.3",
34 | "uuid": "10.0.0",
35 | "validate-npm-package-name": "5.0.0"
36 | },
37 | "devDependencies": {
38 | "eslint": "^8.48.0",
39 | "eslint-config-standard": "^17.1.0",
40 | "eslint-plugin-import": "^2.28.1",
41 | "eslint-plugin-n": "^16.0.2",
42 | "eslint-plugin-no-only-tests": "^3.1.0",
43 | "eslint-plugin-promise": "^6.1.1",
44 | "mocha": "8.2.1",
45 | "nodemon": "2.0.20",
46 | "should": "13.2.3",
47 | "sinon": "9.2.1",
48 | "vanilla-cookieconsent": "^2.8.8"
49 | },
50 | "engines": {
51 | "node": "18"
52 | }
53 | }
54 |
--------------------------------------------------------------------------------
/lib/users.js:
--------------------------------------------------------------------------------
1 | const db = require('./db')
2 | const github = require('./github')
3 |
4 | function extractGitHubInfo (data) {
5 | return {
6 | _id: data.login,
7 | login: data.login,
8 | avatar_url: data.avatar_url,
9 | name: data.name,
10 | bio: data.bio,
11 | html_url: data.html_url,
12 | etag: data.etag
13 | }
14 | }
15 |
16 | async function ensureExists (login, userData) {
17 | const user = await db.users.findOne({ _id: login })
18 | if (user) {
19 | return
20 | }
21 | if (!userData) {
22 | userData = await github.getUser(login)
23 | }
24 | const userRecord = extractGitHubInfo(userData)
25 | userRecord.npm_verified = false
26 | await db.users.insertOne(userRecord)
27 | }
28 |
29 | async function refreshUserGitHub (login) {
30 | const user = await db.users.findOne({ _id: login })
31 | if (user) {
32 | const data = await github.getUser(login)
33 | const userRecord = extractGitHubInfo(data)
34 | return update(userRecord)
35 | }
36 | throw new Error('User not found')
37 | }
38 |
39 | async function get (login) {
40 | return db.users.findOne({ _id: login })
41 | }
42 | function update (user) {
43 | return db.users.updateOne(
44 | { _id: user._id },
45 | { $set: user }
46 | )
47 | }
48 |
49 | async function checkAllExist (userList) {
50 | const docs = await db.users.find({ _id: { $in: userList } }, { projection: { _id: 1 } }).toArray()
51 | const matched = {}
52 | userList.forEach(u => { matched[u] = true })
53 | docs.forEach(d => {
54 | delete matched[d._id]
55 | })
56 | return Object.keys(matched)
57 | }
58 | module.exports = {
59 | get,
60 | ensureExists,
61 | update,
62 | refreshUserGitHub,
63 | checkAllExist
64 | }
65 |
--------------------------------------------------------------------------------
/lib/db.js:
--------------------------------------------------------------------------------
1 | const { MongoClient } = require('mongodb')
2 |
3 | const settings = require('../config')
4 |
5 | const api = {
6 | init
7 | }
8 |
9 | async function init () {
10 | const collections = ['flows', 'nodes', 'users', 'tags', 'events', 'ratings', 'categories']
11 | const client = new MongoClient(settings.mongo.url)
12 | await client.connect()
13 | const db = client.db()
14 | await db.command({ ping: 1 })
15 |
16 | api.close = async function () {
17 | return client.close()
18 | }
19 |
20 | collections.forEach(col => {
21 | api[col] = db[col] = db.collection(col)
22 | })
23 | await db.flows.createIndex({ updated_at: -1 })
24 | await db.flows.createIndex({ keywords: 1 })
25 | await db.flows.createIndex({ 'maintainers.name': 1 })
26 | await db.flows.createIndex({ npmOwners: 1 })
27 | await db.flows.createIndex({ gitOwners: 1 })
28 | await db.flows.createIndex({ 'rating.score': -1, 'rating.count': -1 })
29 | await db.flows.createIndex({ 'downloads.week': -1 })
30 |
31 | await db.ratings.createIndex({ module: 1 })
32 | await db.ratings.createIndex({ user: 1, module: 1 })
33 | }
34 |
35 | // if (process.env.FLOW_ENV !== "PRODUCTION") {
36 | // collections.forEach(col => {
37 | // var collection = db[col];
38 | // for (var x in collection) {
39 | // if (typeof collection[x] === 'function' && !/^_/.test(x)) {
40 | // db[col]["__"+x] = db[col][x];
41 | // let origFunc = db[col][x];
42 | // let signature = col+"."+x;
43 | // db[col][x] = function() {
44 | // console.log(" ",signature);//arguments[0]);
45 | // return origFunc.apply(db[col],arguments);
46 | // }
47 | // }
48 | // }
49 | // })
50 | // }
51 |
52 | module.exports = api
53 |
--------------------------------------------------------------------------------
/template/add.html:
--------------------------------------------------------------------------------
1 | {{>_header}}
2 |
3 |
30 |
54 | {{>_footer}}
55 |
--------------------------------------------------------------------------------
/template/gistShare.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 | {{#versions}}
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 | {{/versions}}
20 |
21 | {{#pageTitle}}
22 |
4 |
5 |
9 |
19 |
29 | Node
6 |Find out how nodes are listed on the library and how you can get yours included.
7 | 8 |
56 | {{>_cookies}}
57 | {{>_toolbar}}
58 |
--------------------------------------------------------------------------------
/lib/scorecard.js:
--------------------------------------------------------------------------------
1 | const crypto = require('crypto')
2 |
3 | const fs = require('fs-extra')
4 | const nodereddev = require('node-red-dev')
5 |
6 | const events = require('./events')
7 | const npmNodes = require('./nodes')
8 |
9 | function scorecard (packagename, version, nodePath) {
10 | const fileid = crypto.randomBytes(4).toString('hex')
11 | console.log('Running scorecard', packagename, version, nodePath)
12 | try {
13 | const pkg = fs.readJsonSync(nodePath + '/package.json')
14 | console.log(' - Scorecard package.json:', pkg.name, pkg.version)
15 | } catch (err) {
16 | console.log(' - Error checking packaging:', err)
17 | }
18 | nodereddev.run(['validate', '-p', nodePath, '-o', `${nodePath}/../${fileid}.json`, '-e', 'true'])
19 | // eslint-disable-next-line n/no-extraneous-require
20 | .then(require('@oclif/command/flush'))
21 | .then(() => {
22 | const card = fs.readJsonSync(`${nodePath}/../${fileid}.json`)
23 | return npmNodes.update(packagename, { scorecard: card }).then(() => card)
24 | }).then((card) => {
25 | // fs.removeSync(nodePath+'/../..');
26 | let message = 'Result: '
27 |
28 | const keys = Object.keys(card)
29 | keys.sort(function (A, B) {
30 | if (A[0] !== B[0]) {
31 | // Reverse order of the groups - P, N, D
32 | return B.localeCompare(A)
33 | } else {
34 | // Numerical order within the group
35 | return A.substring(1).localeCompare(B.substring(1))
36 | }
37 | })
38 |
39 | for (const rule of keys) {
40 | if (rule !== 'package') {
41 | const result = card[rule]
42 | if (result.test) {
43 | message += ':white_check_mark: '
44 | } else {
45 | if (['P01', 'P04', 'P05', 'D02'].includes(rule)) {
46 | message += ':x: '
47 | } else {
48 | message += ':warning: '
49 | }
50 | }
51 | }
52 | }
53 | events.add({
54 | action: 'scorecard_added',
55 | module: packagename,
56 | version,
57 | message
58 | })
59 | return null
60 | })
61 | .catch((error) => {
62 | console.log(error.message)
63 | events.add({
64 | action: 'scorecard_failed',
65 | module: packagename,
66 | version,
67 | message: error.message
68 | })
69 | // fs.removeSync(nodePath+'/../..');
70 | })
71 | }
72 |
73 | module.exports = {
74 | scorecard
75 | }
76 |
--------------------------------------------------------------------------------
/public/images/spin.svg:
--------------------------------------------------------------------------------
1 |
25 |
42 |
--------------------------------------------------------------------------------
/template/_cookies.html:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/template/_footer.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
42 |
50 |
51 |
52 |
--------------------------------------------------------------------------------
/template/userSettings.html:
--------------------------------------------------------------------------------
1 | {{>_header}}
2 |
4 |
32 |
5 |
7 | Node-RED: Low-code programming for event-driven applications.
6 |
8 |
15 | -
9 |
- GitHub 10 |
- npm 11 |
- Documentation 12 |
- APIs 13 |
16 |
23 |
31 | -
17 |
- Flow Library 18 |
- About 19 |
- Code of Conduct 20 |
- Community 21 |
33 |
41 |
34 | 
35 |
36 |
35 |
37 |
40 | Copyright OpenJS Foundation and Node-RED contributors. All rights reserved. The OpenJS Foundation has registered trademarks and uses trademarks. For a list of trademarks of the OpenJS Foundation, please see our Trademark Policy and Trademark List. Trademarks and logos not indicated on the list of OpenJS Foundation trademarks are trademarks™ or registered® trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them.
38 |The OpenJS Foundation | Terms of Use | Privacy Policy | OpenJS Foundation Bylaws | Trademark Policy | Trademark List | Cookie Policy | Cookie Settings
39 |
3 |
11 |
26 |
27 |
28 |
70 |
84 |
85 | {{>_footer}}
86 |
--------------------------------------------------------------------------------
/lib/events.js:
--------------------------------------------------------------------------------
1 | const request = require('request')
2 |
3 | const settings = require('../config')
4 |
5 | const db = require('./db')
6 |
7 | const icons = {
8 | module_report: ':warning: Report submitted: ',
9 | update: ':rocket: Updated: ',
10 | refresh_requested: ':mag: Refresh requested: ',
11 | error: ':boom: Error: ',
12 | reject: ':-1: Rejected module: ',
13 | remove: ':wastebasket: Removed module: ',
14 | started: ':coffee: Flow Library restarted',
15 | scorecard_added: ':clipboard: Scorecard: ',
16 | scorecard_failed: ':warning: Scorecard failed: '
17 | }
18 | const colors = {
19 | module_report: 'warning',
20 | update: 'good',
21 | refresh_requested: 'good',
22 | error: 'danger',
23 | reject: 'danger',
24 | remove: 'danger',
25 | scorecard_added: 'good',
26 | scorecard_failed: 'danger'
27 |
28 | }
29 |
30 | async function addEvent (event) {
31 | event.ts = Date.now()
32 | // console.log(JSON.stringify(event));
33 | try {
34 | await db.events.insertOne(event)
35 | } catch (err) {
36 | console.error('Error adding event', err.toString())
37 | }
38 | if (settings.slack && settings.slack.webhook) {
39 | try {
40 | let msg = icons[event.action] || ''
41 |
42 | if (event.module) {
43 | if (event.action === 'scorecard_added') {
44 | msg += '
4 | {{#user.avatar_url}}{{/user.avatar_url}}
5 | {{^user.avatar_url}}{{/user.avatar_url}}
6 |
9 |
10 |
3 |