@companion-module/base 1.4.2 → 1.4.3-0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@companion-module/base",
-	"version": "1.4.2",
+	"version": "v1.4.3-0",
 	"type": "commonjs",
 	"main": "dist/index.js",
 	"typings": "dist/index.d.ts",
@@ -24,13 +24,14 @@
 		"CHANGELOG.md",
 		"dist",
 		"generated",
-		"assets"
+		"assets",
+		"vendor"
 	],
 	"dependencies": {
 		"@sentry/node": "^7.63.0",
 		"@sentry/tracing": "^7.63.0",
 		"ajv": "^8.12.0",
-		"debounce-fn": "github:julusian/debounce-fn#4.0.0-maxWaithack.0",
+		"debounce-fn": "link:./vendor/debounce-fn",
 		"ejson": "^2.2.3",
 		"eventemitter3": "^4.0.7",
 		"nanoid": "^3.3.4",

package/vendor/debounce-fn/index.d.ts

@@ -0,0 +1,83 @@
+declare namespace debounceFn {
+	interface Options {
+		/**
+		Time to wait until the `input` function is called.
+
+		@default 0
+		*/
+		readonly wait?: number;
+
+		/**
+		Maximum time to wait until the `input` function is called.
+		Only applies when after is true.
+		Disabled when 0
+
+		@default 0
+		*/
+		readonly maxWait?: number;
+
+		/**
+		Trigger the function on the leading edge of the `wait` interval.
+
+		For example, this can be useful for preventing accidental double-clicks on a "submit" button from firing a second time.
+
+		@default false
+		*/
+		readonly before?: boolean;
+
+		/**
+		Trigger the function on the trailing edge of the `wait` interval.
+
+		@default true
+		*/
+		readonly after?: boolean;
+	}
+
+	interface BeforeOptions extends Options {
+		readonly before: true;
+	}
+
+	interface NoBeforeNoAfterOptions extends Options {
+		readonly after: false;
+		readonly before?: false;
+	}
+
+	interface DebouncedFunction<ArgumentsType extends unknown[], ReturnType> {
+		(...arguments: ArgumentsType): ReturnType;
+		cancel(): void;
+	}
+}
+
+/**
+[Debounce](https://davidwalsh.name/javascript-debounce-function) a function.
+
+@param input - Function to debounce.
+@returns A debounced function that delays calling the `input` function until after `wait` milliseconds have elapsed since the last time the debounced function was called.
+
+It comes with a `.cancel()` method to cancel any scheduled `input` function calls.
+
+@example
+```
+import debounceFn = require('debounce-fn');
+
+window.onresize = debounceFn(() => {
+	// Do something on window resize
+}, {wait: 100});
+```
+*/
+declare function debounceFn<ArgumentsType extends unknown[], ReturnType>(
+	input: (...arguments: ArgumentsType) => ReturnType,
+	options: debounceFn.BeforeOptions
+): debounceFn.DebouncedFunction<ArgumentsType, ReturnType>;
+
+declare function debounceFn<ArgumentsType extends unknown[], ReturnType>(
+	input: (...arguments: ArgumentsType) => ReturnType,
+	options: debounceFn.NoBeforeNoAfterOptions
+): debounceFn.DebouncedFunction<ArgumentsType, undefined>;
+
+declare function debounceFn<ArgumentsType extends unknown[], ReturnType>(
+	input: (...arguments: ArgumentsType) => ReturnType,
+	options?: debounceFn.Options
+): debounceFn.DebouncedFunction<ArgumentsType, ReturnType | undefined>;
+
+export = debounceFn;

package/vendor/debounce-fn/index.js

@@ -0,0 +1,81 @@
+'use strict';
+const mimicFn = require('mimic-fn');
+
+module.exports = (inputFunction, options = {}) => {
+	if (typeof inputFunction !== 'function') {
+		throw new TypeError(`Expected the first argument to be a function, got \`${typeof inputFunction}\``);
+	}
+
+	const {
+		wait = 0,
+		maxWait = 0,
+		before = false,
+		after = true
+	} = options;
+
+	if (!before && !after) {
+		throw new Error('Both `before` and `after` are false, function wouldn\'t be called.');
+	}
+
+	let timeout;
+	let maxTimeout;
+	let result;
+
+	const debouncedFunction = function (...arguments_) {
+		const context = this;
+
+		const later = () => {
+			timeout = undefined;
+
+			if (maxTimeout) {
+				clearTimeout(maxTimeout);
+				maxTimeout = undefined;
+			}
+
+			if (after) {
+				result = inputFunction.apply(context, arguments_);
+			}
+		};
+
+		const maxLater = () => {
+			maxTimeout = undefined;
+
+			if (timeout) {
+				clearTimeout(timeout);
+				timeout = undefined;
+			}
+
+			result = inputFunction.apply(context, arguments_);
+		};
+
+		const shouldCallNow = before && !timeout;
+		clearTimeout(timeout);
+		timeout = setTimeout(later, wait);
+
+		if (maxWait > 0 && !maxTimeout && after) {
+			maxTimeout = setTimeout(maxLater, maxWait);
+		}
+
+		if (shouldCallNow) {
+			result = inputFunction.apply(context, arguments_);
+		}
+
+		return result;
+	};
+
+	mimicFn(debouncedFunction, inputFunction);
+
+	debouncedFunction.cancel = () => {
+		if (timeout) {
+			clearTimeout(timeout);
+			timeout = undefined;
+		}
+
+		if (maxTimeout) {
+			clearTimeout(maxTimeout);
+			maxTimeout = undefined;
+		}
+	};
+
+	return debouncedFunction;
+};

package/vendor/debounce-fn/index.test-d.ts

@@ -0,0 +1,24 @@
+import {expectType, expectError} from 'tsd';
+import debounceFn = require('.');
+
+const stringToBoolean = (string: string) => true;
+
+const options: debounceFn.Options = {};
+const debounced = debounceFn(stringToBoolean);
+expectType<debounceFn.DebouncedFunction<[string], boolean | undefined>>(debounced);
+expectType<boolean | undefined>(debounced('foo'));
+debounced.cancel();
+
+expectType<boolean | undefined>(debounceFn(stringToBoolean)('foo'));
+expectError<boolean>(debounceFn(stringToBoolean)('foo'));
+
+expectType<boolean | undefined>(debounceFn(stringToBoolean, {wait: 20})('foo'));
+expectError<boolean>(debounceFn(stringToBoolean, {wait: 20})('foo'));
+expectType<boolean | undefined>(debounceFn(stringToBoolean, {after: true})('foo'));
+expectError<boolean>(debounceFn(stringToBoolean, {after: true})('foo'));
+
+expectType<boolean>(debounceFn(stringToBoolean, {before: true})('foo'));
+expectType<boolean>(debounceFn(stringToBoolean, {before: true, after: true})('foo'));
+
+expectType<undefined>(debounceFn(stringToBoolean, {after: false})('foo'));
+expectError<boolean>(debounceFn(stringToBoolean, {after: false})('foo'));

package/vendor/debounce-fn/license

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/vendor/debounce-fn/package.json

@@ -0,0 +1,42 @@
+{
+	"name": "debounce-fn",
+	"version": "4.0.0-maxWaithack.0",
+	"description": "Debounce a function",
+	"license": "MIT",
+	"repository": "sindresorhus/debounce-fn",
+	"funding": "https://github.com/sponsors/sindresorhus",
+	"author": {
+		"name": "Sindre Sorhus",
+		"email": "sindresorhus@gmail.com",
+		"url": "https://sindresorhus.com"
+	},
+	"engines": {
+		"node": ">=10"
+	},
+	"scripts": {
+		"test": "xo && ava && tsd"
+	},
+	"files": [
+		"index.js",
+		"index.d.ts"
+	],
+	"keywords": [
+		"debounce",
+		"function",
+		"debouncer",
+		"fn",
+		"func",
+		"throttle",
+		"delay",
+		"invoked"
+	],
+	"dependencies": {
+		"mimic-fn": "^3.0.0"
+	},
+	"devDependencies": {
+		"ava": "^1.4.1",
+		"delay": "^4.2.0",
+		"tsd": "^0.11.0",
+		"xo": "^0.26.1"
+	}
+}

package/vendor/debounce-fn/readme.md

@@ -0,0 +1,64 @@
+# debounce-fn
+
+> [Debounce](https://davidwalsh.name/javascript-debounce-function) a function
+
+## Install
+
+```
+$ npm install debounce-fn
+```
+
+## Usage
+
+```js
+const debounceFn = require('debounce-fn');
+
+window.onresize = debounceFn(() => {
+	// Do something on window resize
+}, {wait: 100});
+```
+
+## API
+
+### debounceFn(input, options?)
+
+Returns a debounced function that delays calling the `input` function until after `wait` milliseconds have elapsed since the last time the debounced function was called.
+
+It comes with a `.cancel()` method to cancel any scheduled `input` function calls.
+
+#### input
+
+Type: `Function`
+
+Function to debounce.
+
+#### options
+
+Type: `object`
+
+##### wait
+
+Type: `number`\
+Default: `0`
+
+Time to wait until the `input` function is called.
+
+##### before
+
+Type: `boolean`\
+Default: `false`
+
+Trigger the function on the leading edge of the `wait` interval.
+
+For example, can be useful for preventing accidental double-clicks on a "submit" button from firing a second time.
+
+##### after
+
+Type: `boolean`\
+Default: `true`
+
+Trigger the function on the trailing edge of the `wait` interval.
+
+## Related
+
+- [p-debounce](https://github.com/sindresorhus/p-debounce) - Debounce promise-returning & async functions

package/vendor/debounce-fn/test.js

@@ -0,0 +1,169 @@
+import test from 'ava';
+import delay from 'delay';
+import debounceFn from '.';
+
+test('debounces a function', async t => {
+	let count = 0;
+
+	const debounced = debounceFn(value => {
+		count++;
+		return value;
+	}, {
+		wait: 20
+	});
+
+	t.is(debounced(1), undefined);
+	t.is(debounced(2), undefined);
+	t.is(debounced(3), undefined);
+
+	await delay(100);
+	t.is(debounced(4), 3);
+	t.is(debounced(5), 3);
+	t.is(debounced(6), 3);
+	t.is(count, 1);
+
+	await delay(200);
+	t.is(count, 2);
+});
+
+test('before:false after:false options', t => {
+	t.throws(() => {
+		debounceFn(() => null, {
+			wait: 20,
+			before: false,
+			after: false
+		});
+	}, {
+		message: 'Both `before` and `after` are false, function wouldn\'t be called.'
+	});
+});
+
+test('before:true after:false options', async t => {
+	let count = 0;
+
+	const debounced = debounceFn(value => {
+		count++;
+		return value;
+	}, {
+		wait: 20,
+		before: true,
+		after: false
+	});
+
+	t.is(debounced(1), 1);
+	t.is(debounced(2), 1);
+	t.is(debounced(3), 1);
+	t.is(count, 1);
+
+	await delay(100);
+	t.is(debounced(4), 4);
+	t.is(debounced(5), 4);
+	t.is(debounced(6), 4);
+	t.is(count, 2);
+
+	await delay(200);
+	t.is(count, 2);
+});
+
+test('before:false after:true options', async t => {
+	let count = 0;
+
+	const debounced = debounceFn(value => {
+		count++;
+		return value;
+	}, {
+		wait: 20,
+		before: false,
+		after: true
+	});
+
+	t.is(debounced(1), undefined);
+	t.is(debounced(2), undefined);
+	t.is(debounced(3), undefined);
+	t.is(count, 0);
+
+	await delay(100);
+	t.is(debounced(4), 3);
+	t.is(debounced(5), 3);
+	t.is(debounced(6), 3);
+	t.is(count, 1);
+
+	await delay(200);
+	t.is(count, 2);
+});
+
+test('before:true after:true options', async t => {
+	let count = 0;
+
+	const debounced = debounceFn(value => {
+		count++;
+		return value;
+	}, {
+		wait: 20,
+		before: true,
+		after: true
+	});
+
+	t.is(debounced(1), 1);
+	t.is(debounced(2), 1);
+	t.is(debounced(3), 1);
+	t.is(count, 1);
+
+	await delay(100);
+	t.is(count, 2);
+	t.is(debounced(4), 4);
+	t.is(debounced(5), 4);
+	t.is(debounced(6), 4);
+	t.is(count, 3);
+
+	await delay(200);
+	t.is(count, 4);
+});
+
+test('.cancel() method', async t => {
+	let count = 0;
+
+	const debounced = debounceFn(value => {
+		count++;
+		return value;
+	}, {
+		wait: 20
+	});
+
+	t.is(debounced(1), undefined);
+	t.is(debounced(2), undefined);
+	t.is(debounced(3), undefined);
+
+	debounced.cancel();
+
+	await delay(100);
+	t.is(debounced(1), undefined);
+	t.is(debounced(2), undefined);
+	t.is(debounced(3), undefined);
+	t.is(count, 0);
+});
+
+test('debounces a function with maxWait', async t => {
+	let count = 0;
+
+	const debounced = debounceFn(value => {
+		count++;
+		return value;
+	}, {
+		wait: 40,
+		maxWait: 50
+	});
+
+	t.is(debounced(1), undefined);
+	await delay(30);
+	t.is(count, 0);
+
+	t.is(debounced(2), undefined);
+	await delay(30);
+	t.is(count, 1);
+
+	t.is(debounced(3), 1);
+
+	await delay(200);
+	t.is(count, 2);
+});