First commit

This commit is contained in:
yuto-yuto 2021-07-08 19:05:14 +02:00
parent fb968f27e3
commit ed05952bd1
10 changed files with 2629 additions and 0 deletions

104
.gitignore vendored Normal file
View File

@ -0,0 +1,104 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
# Runtime data
pids
*.pid
*.seed
*.pid.lock
# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov
# Coverage directory used by tools like istanbul
coverage
*.lcov
# nyc test coverage
.nyc_output
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt
# Bower dependency directory (https://bower.io/)
bower_components
# node-waf configuration
.lock-wscript
# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release
# Dependency directories
node_modules/
jspm_packages/
# TypeScript v1 declaration files
typings/
# TypeScript cache
*.tsbuildinfo
# Optional npm cache directory
.npm
# Optional eslint cache
.eslintcache
# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/
# Optional REPL history
.node_repl_history
# Output of 'npm pack'
*.tgz
# Yarn Integrity file
.yarn-integrity
# dotenv environment variables file
.env
.env.test
# parcel-bundler cache (https://parceljs.org/)
.cache
# Next.js build output
.next
# Nuxt.js build / generate output
.nuxt
dist
# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and *not* Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public
# vuepress build output
.vuepress/dist
# Serverless directories
.serverless/
# FuseBox cache
.fusebox/
# DynamoDB Local files
.dynamodb/
# TernJS port file
.tern-port

3
.npmignore Normal file
View File

@ -0,0 +1,3 @@
test
tsconfig.json
index.ts

View File

@ -0,0 +1,29 @@
import isEqual from "fast-deep-equal";
interface KeyValue {
key: unknown;
value: unknown;
}
export class ValueChangeDetector {
private currentValues = new Map<string, unknown>();
public isUpdated(args: KeyValue): boolean {
const current = this.currentValues.get(this.toString(args.key));
if (current === undefined) {
return true;
}
return !isEqual(current, args.value);
}
public update(args: KeyValue): void {
this.currentValues.set(this.toString(args.key), args.value);
}
private toString(object: unknown): string {
if (typeof object === "string") {
return object;
}
return String(object);
}
}

View File

@ -0,0 +1,36 @@
<script type="text/javascript">
RED.nodes.registerType('value-change-detector', {
category: 'function',
color: '#a6bbcf',
defaults: {
name: { value: "" },
key: { value: "", required: true },
value: { value: "", required: true },
},
inputs: 1,
outputs: 1,
icon: "file.png",
label: function () {
return this.name || "value-change-detector";
}
});
</script>
<script type="text/html" data-template-name="value-change-detector">
<div class="form-row">
<label for="node-input-key"><i class="fa fa-tag"></i> Key prop</label>
<input type="text" id="node-input-key" placeholder="payload.key">
</div>
<div class="form-row">
<label for="node-input-value"><i class="fa fa-tag"></i> Value prop</label>
<input type="text" id="node-input-value" placeholder="payload.value">
</div>
<div class="form-row">
<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
<input type="text" id="node-input-name" placeholder="Name">
</div>
</script>
<script type="text/html" data-help-name="value-change-detector">
<p>Send incoming message only when the value changes.</p>
</script>

View File

@ -0,0 +1,20 @@
import * as nodered from "node-red";
import * as yutolity from "yutolity";
import { ValueChangeDetector } from "./ValueChangeDetector";
import { ValueChangeDetectorNodeProperties } from "./ValueChangeDetectorNodeProperties";
export = (RED: nodered.NodeAPI) => {
RED.nodes.registerType("value-change-detector",
function (this: nodered.Node, config: ValueChangeDetectorNodeProperties): void {
RED.nodes.createNode(this, config);
const detector = new ValueChangeDetector();
this.on('input', (msg: any) => {
const targetValue = yutolity.getValueOf(msg.payload, config.key);
this.send(msg);
});
});
}

View File

@ -0,0 +1,6 @@
import * as nodered from "node-red";
export interface ValueChangeDetectorNodeProperties extends nodered.NodeDef {
key: string;
value: string;
}

2285
package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

34
package.json Normal file
View File

@ -0,0 +1,34 @@
{
"name": "value-change-detector",
"version": "1.0.0",
"description": "send message only when the value changes",
"main": "index.js",
"scripts": {
"build": "tsc && cp ./lib/*.html ./dist/",
"clean": "rm -rf ./dist",
"test": "mocha --recursive --require ts-node/register test/*.ts"
},
"keywords": [
"node-red",
"value-change"
],
"author": "yuto-yuto",
"license": "MIT",
"devDependencies": {
"@types/chai": "^4.2.12",
"@types/mocha": "^8.0.3",
"@types/node": "^12.0.0",
"@types/node-red": "^1.1.1",
"@types/sinon": "^9.0.5",
"chai": "^4.2.0",
"mocha": "^8.1.3",
"node-red-node-test-helper": "^0.2.6",
"sinon": "^9.0.3",
"ts-node": "^8.10.2",
"typescript": "^3.9.7"
},
"dependencies": {
"fast-deep-equal": "^3.1.3",
"yutolity": "^1.0.0"
}
}

View File

@ -0,0 +1,43 @@
import "mocha";
import { expect } from "chai";
import { ValueChangeDetector } from "../lib/ValueChangeDetector";
describe("ValueChangeDetector", () => {
let instance: ValueChangeDetector;
beforeEach(() => {
instance = new ValueChangeDetector();
});
describe("isUpdated", () => {
it("should return true for the first time", () => {
const result = instance.isUpdated({ key: 1, value: 1 });
expect(result).to.equal(true);
});
it("should return false when specifying the same data", () => {
const data = { key: "key", value: "value" };
instance.update(data);
const result = instance.isUpdated({ ...data });
expect(result).to.equal(false);
});
it("should return true for different key", () => {
instance.update({ key: "key", value: "value" });
const result = instance.isUpdated({ key: "key2", value: "value" });
expect(result).to.equal(true);
});
it("should convert number to string for key", () => {
instance.update({ key: 1, value: "value" });
const result = instance.isUpdated({ key: "1", value: "value" });
expect(result).to.equal(false);
});
it("should convert object to string for key", () => {
instance.update({ key: { obj: 1 }, value: "value" });
const result = instance.isUpdated({ key: { obj: 1 }, value: "value" });
expect(result).to.equal(false);
});
});
});

69
tsconfig.json Normal file
View File

@ -0,0 +1,69 @@
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig.json to read more about this file */
/* Basic Options */
// "incremental": true, /* Enable incremental compilation */
"target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
"module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
// "lib": [], /* Specify library files to be included in the compilation. */
// "allowJs": true, /* Allow javascript files to be compiled. */
// "checkJs": true, /* Report errors in .js files. */
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
// "declaration": true, /* Generates corresponding '.d.ts' file. */
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
// "sourceMap": true, /* Generates corresponding '.map' file. */
// "outFile": "./", /* Concatenate and emit output to single file. */
"outDir": "./dist", /* Redirect output structure to the directory. */
// "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
// "composite": true, /* Enable project compilation */
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
// "removeComments": true, /* Do not emit comments to output. */
// "noEmit": true, /* Do not emit outputs. */
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
/* Strict Type-Checking Options */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* Enable strict null checks. */
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
/* Additional Checks */
// "noUnusedLocals": true, /* Report errors on unused locals. */
// "noUnusedParameters": true, /* Report errors on unused parameters. */
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
/* Module Resolution Options */
// "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
"typeRoots": [
"node_modules/@types",
"../../node_modules/@types"
], /* List of folders to include type definitions from. */
// "types": [], /* Type declaration files to be included in compilation. */
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
"esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
/* Source Map Options */
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
/* Experimental Options */
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
/* Advanced Options */
"skipLibCheck": true, /* Skip type checking of declaration files. */
"forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
},
"include": [
"lib/**/*",
"test/**/*"
]
}