alfy 0.12.3 → 1.1.0

package/cleanup.js

@@ -2,7 +2,7 @@
 import process from 'node:process';
 import {fileURLToPath} from 'node:url';
 import path from 'node:path';
-import execa from 'execa';
+import {execa} from 'execa';
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 

package/index.d.ts

@@ -1,13 +1,7 @@
 import Conf from 'conf';
 import {Options} from 'got';
 
-export interface FetchOptions extends Options {
-	// Deprecated, but left for backwards-compatibility.
-	/**
-	URL search parameters.
-	*/
-	readonly query?: string | Record<string, string | number | boolean | null | undefined> | URLSearchParams | undefined;
-
+export interface FetchOptions extends Partial<Options> {
 	/**
 	Number of milliseconds this request should be cached.
 	*/

package/index.js

@@ -3,10 +3,10 @@ import process from 'node:process';
 import {createRequire} from 'node:module';
 import Conf from 'conf';
 import got from 'got';
-import hookStd from 'hook-std';
+import {hookStderr} from 'hook-std';
 import loudRejection from 'loud-rejection';
 import cleanStack from 'clean-stack';
-import dotProp from 'dot-prop';
+import {getProperty} from 'dot-prop';
 import AlfredConfig from 'alfred-config';
 import updateNotification from './lib/update-notification.js';
 
@@ -50,7 +50,7 @@ alfy.matches = (input, list, item) => {
 
 	return list.filter(listItem => {
 		if (typeof item === 'string') {
-			listItem = dotProp.get(listItem, item);
+			listItem = getProperty(listItem, item);
 		}
 
 		if (typeof listItem === 'string') {
@@ -113,12 +113,13 @@ alfy.cache = new CacheConf({
 
 alfy.fetch = async (url, options) => {
 	options = {
+		resolveBodyOnly: true,
 		...options,
 	};
 
-	// Deprecated, but left for backwards-compatibility.
+	// TODO: Remove this in 2024.
 	if (options.query) {
-		options.searchParams = options.query;
+		throw new Error('The `query` option was renamed to `searchParams`.');
 	}
 
 	if (typeof url !== 'string') {
@@ -130,6 +131,12 @@ alfy.fetch = async (url, options) => {
 	}
 
 	const rawKey = url + JSON.stringify(options);
+
+	// This must be below the cache key generation.
+	const {transform, maxAge} = options;
+	delete options.transform;
+	delete options.maxAge;
+
 	const key = rawKey.replace(/\./g, '\\.');
 	const cachedResponse = alfy.cache.get(key, {ignoreMaxAge: true});
 
@@ -137,9 +144,16 @@ alfy.fetch = async (url, options) => {
 		return cachedResponse;
 	}
 
+	if ('json' in options && options.json === false) {
+		delete options.json;
+		options.responseType = 'text';
+	} else {
+		options.responseType = 'json';
+	}
+
 	let response;
 	try {
-		response = await got(url, options).json();
+		response = await got(url, options);
 	} catch (error) {
 		if (cachedResponse) {
 			return cachedResponse;
@@ -148,10 +162,10 @@ alfy.fetch = async (url, options) => {
 		throw error;
 	}
 
-	const data = options.transform ? options.transform(response) : response;
+	const data = transform ? transform(response) : response;
 
-	if (options.maxAge) {
-		alfy.cache.set(key, data, {maxAge: options.maxAge});
+	if (maxAge) {
+		alfy.cache.set(key, data, {maxAge});
 	}
 
 	return data;
@@ -171,6 +185,6 @@ alfy.icon = {
 
 loudRejection(alfy.error);
 process.on('uncaughtException', alfy.error);
-hookStd.stderr(alfy.error);
+hookStderr(alfy.error);
 
 export default alfy;

package/init.js

@@ -2,7 +2,7 @@
 import process from 'node:process';
 import path from 'node:path';
 import {fileURLToPath} from 'node:url';
-import execa from 'execa';
+import {execa} from 'execa';
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 

package/lib/update-notification.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "alfy",
-	"version": "0.12.3",
+	"version": "1.1.0",
 	"description": "Create Alfred workflows with ease",
 	"license": "MIT",
 	"repository": "sindresorhus/alfy",
@@ -37,26 +37,26 @@
 		"mac"
 	],
 	"dependencies": {
-		"alfred-config": "^0.2.2",
+		"alfred-config": "^0.2.3",
 		"alfred-link": "^0.3.1",
 		"alfred-notifier": "^0.2.3",
 		"cache-conf": "^0.6.0",
 		"clean-stack": "^4.1.0",
-		"conf": "^10.0.1",
-		"dot-prop": "^6.0.1",
-		"execa": "^5.1.1",
-		"got": "^11.8.2",
-		"hook-std": "^2.0.0",
+		"conf": "^10.1.1",
+		"dot-prop": "^7.2.0",
+		"execa": "^6.1.0",
+		"got": "^12.0.3",
+		"hook-std": "^3.0.0",
 		"loud-rejection": "^2.2.0",
-		"read-pkg-up": "^8.0.0"
+		"read-pkg-up": "^9.1.0"
 	},
 	"devDependencies": {
-		"ava": "^3.15.0",
+		"ava": "^4.1.0",
 		"delay": "^5.0.0",
-		"nock": "^13.1.1",
+		"nock": "^13.2.4",
 		"tempfile": "^4.0.0",
-		"tsd": "^0.17.0",
-		"typescript": "^4.3.5",
-		"xo": "^0.43.0"
+		"tsd": "^0.19.1",
+		"typescript": "^4.6.3",
+		"xo": "^0.48.0"
 	}
 }

package/readme.md

@@ -21,8 +21,8 @@ You need [Node.js 14+](https://nodejs.org) and [Alfred 4](https://www.alfredapp.
 
 ## Install
 
-```
-$ npm install alfy
+```sh
+npm install alfy
 ```
 
 ## Usage
@@ -121,8 +121,8 @@ You can remove [these](https://github.com/samverschueren/alfred-link#infoplist)
 
 After publishing your workflow to npm, your users can easily install or update the workflow.
 
-```
-$ npm install --global alfred-unicorn
+```sh
+npm install --global alfred-unicorn
 ```
 
 > Tip: instead of manually updating every workflow yourself, use the [alfred-updater](https://github.com/SamVerschueren/alfred-updater) workflow to do that for you.
@@ -351,7 +351,7 @@ URL to fetch.
 
 Type: `object`
 
-Any of the [`got` options](https://github.com/sindresorhus/got/tree/v11.8.3#api) and the below options.
+Any of the [`got` options](https://github.com/sindresorhus/got/tree/v12.0.3#api) and the below options.
 
 ###### json
 
@@ -366,11 +366,39 @@ Type: `number`
 
 Number of milliseconds this request should be cached.
 
+###### resolveBodyOnly
+
+Type: `boolean`\
+Default: `true`
+
+Whether to resolve with only body or a full response.
+
+```js
+import alfy from 'alfy';
+
+await alfy.fetch('https://api.foo.com');
+//=> {foo: 'bar'}
+
+await alfy.fetch('https://api.foo.com', {
+	resolveBodyOnly: false 
+});
+/*
+{
+	body: {
+		foo: 'bar'
+	},
+	headers: {
+		'content-type': 'application/json'
+	}
+}
+*/
+```
+
 ###### transform
 
 Type: `Function`
 
-Transform the response before it gets cached.
+Transform the response body before it gets cached.
 
 ```js
 import alfy from 'alfy';
@@ -383,6 +411,20 @@ await alfy.fetch('https://api.foo.com', {
 })
 ```
 
+Transform the response.
+
+```js
+import alfy from 'alfy';
+
+await alfy.fetch('https://api.foo.com', {
+	resolveBodyOnly: false,
+	transform: response => {
+		response.body.foo = 'bar';
+		return response;
+	}
+})
+```
+
 You can also return a Promise.
 
 ```js
@@ -639,6 +681,9 @@ Non-synced local preferences are stored within `Alfred.alfredpreferences` under
 - [alfred-amphetamine](https://github.com/demartini/alfred-amphetamine) - Start and end sessions quickly in the Amphetamine app
 - [alfred-ids](https://github.com/rizowski/alfred-ids) - Generate various types of IDs.
 - [alfred-awesome-stars](https://github.com/jopemachine/alfred-awesome-stars) - Search starred GitHub repos through awesome-stars.
+- [alfred-pwgen](https://github.com/olssonm/alfred-password-generator) - Generate random and secure passwords.
+- [alfred-bear](https://github.com/jmeischner/alfred-bear) - Use dynamic templates with the Bear app.
+- [alfred-color-converter](https://github.com/toFrankie/alfred-color-converter) - Convert colors between RGB and Hex.
 
 ## Related