Add TypeScript definitions (#138)

Author: jopemachine

index.d.ts

@@ -8,7 +8,7 @@ const cleanStack = require('clean-stack');
 const dotProp = require('dot-prop');
 const CacheConf = require('cache-conf');
 const AlfredConfig = require('alfred-config');
-const updateNotification = require('./lib/update-notification');
+const updateNotification = require('./lib/update-notification.js');
 
 const alfy = module.exports;
 

index.js

@@ -0,0 +1,34 @@
+/* eslint-disable @typescript-eslint/no-confusing-void-expression */
+
+import {expectType} from 'tsd';
+import alfy, {ScriptFilterItem} from './index.js';
+
+const mockItems: ScriptFilterItem[] = [
+	{
+		title: 'Unicorn'
+	},
+	{
+		title: 'Rainbow'
+	}
+];
+
+expectType<void>(alfy.output(mockItems));
+
+expectType<string[]>(alfy.matches('Corn', ['foo', 'unicorn']));
+
+expectType<ScriptFilterItem[]>(alfy.matches('Unicorn', mockItems, 'title'));
+
+expectType<string[]>(alfy.inputMatches(['foo', 'unicorn']));
+
+expectType<ScriptFilterItem[]>(alfy.inputMatches(mockItems, 'title'));
+
+expectType<void>(alfy.error(new Error('some error')));
+
+expectType<void>(alfy.log('some message'));
+
+expectType<Promise<any>>(alfy.fetch('https://foo.bar', {
+	transform: body => {
+		body.foo = 'bar';
+		return body;
+	}
+}));

index.test-d.ts

@@ -13,10 +13,11 @@
 		"node": ">=10"
 	},
 	"scripts": {
-		"test": "xo && ava"
+		"test": "xo && ava && tsd"
 	},
 	"files": [
 		"index.js",
+		"index.d.ts",
 		"init.js",
 		"cleanup.js",
 		"run-node.sh",
@@ -53,6 +54,8 @@
 		"delay": "^4.3.0",
 		"nock": "^13.1.0",
 		"tempfile": "^3.0.0",
-		"xo": "^0.24.0"
+		"tsd": "^0.17.0",
+		"typescript": "^4.3.5",
+		"xo": "^0.39.1"
 	}
 }

package.json

@@ -1,7 +1,7 @@
 import test from 'ava';
 import delay from 'delay';
 import tempfile from 'tempfile';
-import {alfy as createAlfy} from './_utils';
+import {alfy as createAlfy} from './_utils.js';
 
 test('no cache', t => {
 	const alfy = createAlfy();

test/cache.js

@@ -2,7 +2,7 @@ import test from 'ava';
 import nock from 'nock';
 import delay from 'delay';
 import tempfile from 'tempfile';
-import {alfy as createAlfy} from './_utils';
+import {alfy as createAlfy} from './_utils.js';
 
 const URL = 'https://foo.bar';
 

test/fetch.js

@@ -1,6 +1,6 @@
 import test from 'ava';
 import hookStd from 'hook-std';
-import {alfy} from './_utils';
+import {alfy} from './_utils.js';
 
 const alfyInstance = alfy();
 

test/test.js

@@ -1,6 +1,6 @@
 import path from 'path';
 import test from 'ava';
-import {alfy as createAlfy} from './_utils';
+import {alfy as createAlfy} from './_utils.js';
 
 test('read user config', t => {
 	const alfy = createAlfy({