alfy 1.1.0 → 2.1.0

package/cleanup.js

@@ -6,14 +6,12 @@ import {execa} from 'execa';
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
-(async () => {
-	try {
-		await execa('alfred-unlink', {
-			preferLocal: true,
-			localDir: __dirname,
-		});
-	} catch (error) {
-		console.error(error);
-		process.exit(1);
-	}
-})();
+try {
+	await execa('alfred-unlink', {
+		preferLocal: true,
+		localDir: __dirname,
+	});
+} catch (error) {
+	console.error(error);
+	process.exit(1);
+}

package/index.d.ts

@@ -1,7 +1,7 @@
-import Conf from 'conf';
-import {Options} from 'got';
+import type Conf from 'conf';
+import {type Options} from 'got';
 
-export interface FetchOptions extends Partial<Options> {
+export type FetchOptions = {
 	/**
 	Number of milliseconds this request should be cached.
 	*/
@@ -11,33 +11,37 @@ export interface FetchOptions extends Partial<Options> {
 	Transform the response before it gets cached.
 	*/
 	readonly transform?: (body: unknown) => unknown;
-}
+} & Partial<Options>;
 
-export interface OutputOptions {
+export type OutputOptions = {
 	/**
 	A script can be set to re-run automatically after some interval.
 
 	The script will only be re-run if the script filter is still active and the user hasn't changed the state of the filter by typing and triggering a re-run. For example, it could be used to update the progress of a particular task:
 	*/
 	readonly rerunInterval?: number;
-}
+};
 
-export interface CacheConfGetOptions {
+// eslint-disable-next-line unicorn/prevent-abbreviations
+export type CacheConfGetOptions = {
 	/**
 	Get the item for the key provided without taking the `maxAge` of the item into account.
 	*/
 	readonly ignoreMaxAge?: boolean;
-}
+};
 
-export interface CacheConfSetOptions {
+// eslint-disable-next-line unicorn/prevent-abbreviations
+export type CacheConfSetOptions = {
 	/**
 	Number of milliseconds the cached value is valid.
 	*/
 	readonly maxAge?: number;
-}
+};
 
-export interface CacheConf<T> extends Conf<T> {
-	isExpired: (key: T) => boolean;
+// TODO: Rename this in the next major version.
+// eslint-disable-next-line unicorn/prevent-abbreviations
+export type CacheConf<T extends Record<string, any> = Record<string, unknown>> = {
+	isExpired: (key: keyof T) => boolean;
 
 	get<Key extends keyof T>(key: Key, options?: CacheConfGetOptions): T[Key];
 	get<Key extends keyof T>(key: Key, defaultValue: Required<T>[Key], options?: CacheConfGetOptions): Required<T>[Key];
@@ -48,7 +52,7 @@ export interface CacheConf<T> extends Conf<T> {
 	set(key: string, value: unknown, options: CacheConfSetOptions): void;
 	set(object: Partial<T>, options: CacheConfSetOptions): void;
 	set<Key extends keyof T>(key: Partial<T> | Key | string, value?: T[Key] | unknown, options?: CacheConfSetOptions): void;
-}
+} & Conf<T>;
 
 /**
 The icon displayed in the result row. Workflows are run from their workflow folder, so you can reference icons stored in your workflow relatively.
@@ -59,17 +63,17 @@ By using `{type: 'fileicon}`, Alfred will get the icon for the specified path.
 
 Finally, by using `{type: 'filetype'}`, you can get the icon of a specific file. For example, `{path: 'public.png'}`.
 */
-export interface IconElement {
+export type IconElement = {
 	readonly path?: string;
 	readonly type?: 'fileicon' | 'filetype';
-}
+};
 
 /**
 The text element defines the text the user will get when copying the selected result row with `⌘C` or displaying large type with `⌘L`.
 
 If these are not defined, you will inherit Alfred's standard behaviour where the argument is copied to the Clipboard or used for Large Type.
 */
-export interface TextElement {
+export type TextElement = {
 	/**
 	User will get when copying the selected result row with `⌘C`.
 	*/
@@ -79,28 +83,28 @@ export interface TextElement {
 	User will get displaying large type with `⌘L`.
 	*/
 	readonly largetype?: string;
-}
+};
 
 /**
 Defines what to change when the modifier key is pressed.
 
 When you release the modifier key, it returns to the original item.
 */
-export interface ModifierKeyItem {
+export type ModifierKeyItem = {
 	readonly valid?: boolean;
 	readonly title?: string;
 	readonly subtitle?: string;
 	readonly arg?: string;
 	readonly icon?: string;
 	readonly variables?: Record<string, string>;
-}
+};
 
 /**
 This element defines the Universal Action items used when actioning the result, and overrides arg being used for actioning.
 
 The action key can take a string or array for simple types, and the content type will automatically be derived by Alfred to file, URL or text.
 */
-export interface ActionElement {
+export type ActionElement = {
 	/**
 	Forward text to Alfred.
 	*/
@@ -120,14 +124,14 @@ export interface ActionElement {
 	Forward some value and let the value type be infered from Alfred.
 	*/
 	readonly auto?: string | string[];
-}
+};
 
 type PossibleModifiers = 'fn' | 'ctrl' | 'opt' | 'cmd' | 'shift';
 
 /**
 Each item describes a result row displayed in Alfred.
 */
-export interface ScriptFilterItem {
+export type ScriptFilterItem = {
 	/**
 	This is a unique identifier for the item which allows help Alfred to learn about this item for subsequent sorting and ordering of the user's actioned results.
 
@@ -289,7 +293,7 @@ export interface ScriptFilterItem {
 	Variables can be passed out of the script filter within a variables object.
 	*/
 	readonly variables?: Record<string, string>;
-}
+};
 
 /**
 Create Alfred workflows with ease
@@ -311,7 +315,7 @@ const items = alfy
 alfy.output(items);
 ```
 */
-export interface Alfy {
+export type Alfy = {
 	/**
 	Return output to Alfred.
 
@@ -433,7 +437,7 @@ export interface Alfy {
 	//=> '🦄'
 	```
 	*/
-	config: Conf<Record<string, unknown>>;
+	config: Conf;
 
 	/**
 	Persist cache data.
@@ -450,7 +454,7 @@ export interface Alfy {
 	//=> '🦄'
 	```
 	*/
-	cache: CacheConf<unknown>;
+	cache: CacheConf;
 
 	/**
 	Get various default system icons.
@@ -542,7 +546,7 @@ export interface Alfy {
 	```
 	*/
 	userConfig: Map<string, string>;
-}
+};
 
 declare const alfy: Alfy;
 

package/index.js

@@ -8,7 +8,7 @@ import loudRejection from 'loud-rejection';
 import cleanStack from 'clean-stack';
 import {getProperty} from 'dot-prop';
 import AlfredConfig from 'alfred-config';
-import updateNotification from './lib/update-notification.js';
+import updateNotification from './lib/update-notification.js'; // eslint-disable-line import/order
 
 const require = createRequire(import.meta.url);
 const CacheConf = require('cache-conf');
@@ -100,6 +100,7 @@ ${process.platform} ${os.release()}
 };
 
 alfy.config = new Conf({
+	projectName: 'alfy',
 	cwd: alfy.alfred.data,
 });
 
@@ -117,11 +118,6 @@ alfy.fetch = async (url, options) => {
 		...options,
 	};
 
-	// TODO: Remove this in 2024.
-	if (options.query) {
-		throw new Error('The `query` option was renamed to `searchParams`.');
-	}
-
 	if (typeof url !== 'string') {
 		throw new TypeError(`Expected \`url\` to be a \`string\`, got \`${typeof url}\``);
 	}
@@ -137,7 +133,7 @@ alfy.fetch = async (url, options) => {
 	delete options.transform;
 	delete options.maxAge;
 
-	const key = rawKey.replace(/\./g, '\\.');
+	const key = rawKey.replaceAll('.', '\\.');
 	const cachedResponse = alfy.cache.get(key, {ignoreMaxAge: true});
 
 	if (cachedResponse && !alfy.cache.isExpired(key)) {

package/init.js

@@ -6,21 +6,18 @@ import {execa} from 'execa';
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
-(async () => {
-	try {
-		await execa('alfred-link', {
-			preferLocal: true,
-			localDir: __dirname,
-		});
-
-		await execa('alfred-config', {
-			preferLocal: true,
-			localDir: __dirname,
-			stdio: 'inherit',
-		});
-	} catch (error) {
-		console.error(error);
-		process.exit(1);
-	}
-})();
+try {
+	await execa('alfred-link', {
+		preferLocal: true,
+		localDir: __dirname,
+	});
 
+	await execa('alfred-config', {
+		preferLocal: true,
+		localDir: __dirname,
+		stdio: 'inherit',
+	});
+} catch (error) {
+	console.error(error);
+	process.exit(1);
+}

package/lib/update-notification.js

@@ -1,9 +1,9 @@
-import {readPackageUp} from 'read-pkg-up';
+import {readPackageUp} from 'read-package-up';
 import alfredNotifier from 'alfred-notifier';
 
 export default async function updateNotification() {
-	const {package: pkg} = await readPackageUp();
-	const alfy = (pkg || {}).alfy || {};
+	const {package: package_} = await readPackageUp();
+	const alfy = package_?.alfy ?? {};
 
 	if (alfy.updateNotification !== false) {
 		alfredNotifier();

package/package.json

@@ -1,18 +1,23 @@
 {
 	"name": "alfy",
-	"version": "1.1.0",
+	"version": "2.1.0",
 	"description": "Create Alfred workflows with ease",
 	"license": "MIT",
 	"repository": "sindresorhus/alfy",
+	"funding": "https://github.com/sponsors/sindresorhus",
 	"type": "module",
-	"exports": "./index.js",
 	"bin": {
 		"run-node": "./run-node.sh",
 		"alfy-init": "./init.js",
 		"alfy-cleanup": "./cleanup.js"
 	},
+	"exports": {
+		"types": "./index.d.ts",
+		"default": "./index.js"
+	},
+	"sideEffects": false,
 	"engines": {
-		"node": ">=14.13.1"
+		"node": ">=18"
 	},
 	"scripts": {
 		"test": "xo && ava && tsd"
@@ -41,22 +46,26 @@
 		"alfred-link": "^0.3.1",
 		"alfred-notifier": "^0.2.3",
 		"cache-conf": "^0.6.0",
-		"clean-stack": "^4.1.0",
-		"conf": "^10.1.1",
-		"dot-prop": "^7.2.0",
-		"execa": "^6.1.0",
-		"got": "^12.0.3",
+		"clean-stack": "^5.2.0",
+		"conf": "^13.0.1",
+		"dot-prop": "^9.0.0",
+		"execa": "^9.3.0",
+		"got": "^14.4.2",
 		"hook-std": "^3.0.0",
 		"loud-rejection": "^2.2.0",
-		"read-pkg-up": "^9.1.0"
+		"read-package-up": "^11.0.0"
 	},
 	"devDependencies": {
-		"ava": "^4.1.0",
-		"delay": "^5.0.0",
-		"nock": "^13.2.4",
-		"tempfile": "^4.0.0",
-		"tsd": "^0.19.1",
-		"typescript": "^4.6.3",
-		"xo": "^0.48.0"
+		"ava": "^6.1.3",
+		"delay": "^6.0.0",
+		"nock": "^13.5.4",
+		"tempfile": "^5.0.0",
+		"tsd": "^0.31.1",
+		"xo": "^0.59.2"
+	},
+	"tsd": {
+		"compilerOptions": {
+			"module": "node16"
+		}
 	}
 }

package/readme.md

@@ -17,7 +17,7 @@
 
 ## Prerequisites
 
-You need [Node.js 14+](https://nodejs.org) and [Alfred 4](https://www.alfredapp.com) with the paid [Powerpack](https://www.alfredapp.com/powerpack/) upgrade.
+You need [Node.js 18+](https://nodejs.org) and [Alfred 4 or later](https://www.alfredapp.com) with the paid [Powerpack](https://www.alfredapp.com/powerpack/) upgrade.
 
 ## Install
 
@@ -103,7 +103,7 @@ By adding `alfy-init` as `postinstall` and `alfy-cleanup` as `preuninstall` scri
 	"author": {
 		"name": "Sindre Sorhus",
 		"email": "sindresorhus@gmail.com",
-		"url": "sindresorhus.com"
+		"url": "https://sindresorhus.com"
 	},
 	"scripts": {
 		"postinstall": "alfy-init",
@@ -323,6 +323,29 @@ alfy.matches('Foo', list, (item, input) => item === input);
 
 Same as `matches()`, but with `alfy.input` as `input`.
 
+If you want to match against multiple items, you must define your own matching function ([as shown here](#item)). Let’s extend the [example from the beginning](#example) to search for a keyword that appears either within the `title` or `body` property or both.
+
+```js
+import alfy from 'alfy';
+
+const data = await alfy.fetch('https://jsonplaceholder.typicode.com/posts');
+
+const items = alfy
+	.inputMatches(
+		data,
+		(item, input) =>
+			item.title?.toLowerCase().includes(input) ||
+			item.body?.toLowerCase().includes(input)
+	)
+	.map((element) => ({
+		title: element.title,
+		subtitle: element.body,
+		arg: element.id,
+	}));
+
+alfy.output(items);
+```
+
 #### error(error)
 
 Display an error or error message in Alfred.