wallpaper-lockscreen 0.0.4

package/index.d.ts

@@ -0,0 +1,104 @@
+export interface GetOptions {
+	/**
+	__macOS only.__
+
+	The screen to get the wallpaper from.
+
+	Values: `all`, `main`, or the index of a screen from `.screens()`.
+
+	@default 'main'
+	*/
+	readonly screen?: 'all' | 'main' | number;
+}
+
+export interface SetOptions {
+	/**
+	__macOS only.__
+
+	The screen to set the wallpaper on.
+
+	Values: `all`, `main`, or the index of a screen from `.screens()`.
+
+	*On Linux and Windows it's hard-coded to `main`.*
+
+	@default 'all'
+	*/
+	readonly screen?: 'all' | 'main' | number;
+
+	/**
+	__macOS only.__
+
+	Scaling method. Values: `auto` `fill` `fit` `stretch` `center`.
+
+	@default 'auto'
+	*/
+	readonly scale?: 'auto' | 'fill' | 'fit' | 'stretch' | 'center';
+}
+
+/**
+Get the path to the wallpaper image currently set.
+
+@returns The path of the current desktop wallpaper.
+
+@example
+```
+import {getWallpaper} from 'wallpaper';
+
+await getWallpaper();
+//=> '/Users/sindresorhus/unicorn.jpg'
+```
+*/
+export function getWallpaper(options?: GetOptions): Promise<string>;
+
+/**
+Set a new wallpaper.
+
+@param imagePath - The path to the image to set as the desktop wallpaper.
+
+@example
+```
+import {setWallpaper} from 'wallpaper';
+
+await setWallpaper('unicorn.jpg');
+```
+*/
+export function setWallpaper(
+	imagePath: string,
+	options?: SetOptions
+): Promise<void>;
+
+/**
+__macOS only.__
+
+@returns The available screens.
+
+@example
+```
+import {screens} from 'wallpaper';
+
+await screens();
+//=> ['Color LCD']
+```
+*/
+export function screens(): Promise<string[]>;
+
+/**
+__macOS only.__
+
+Set a solid color.
+
+@param color - The color to set as a RGB Hex value. For example, `000000` for black.
+
+@example
+```
+import {setSolidColorWallpaper} from 'wallpaper';
+
+await setSolidColorWallpaper('000000');
+```
+*/
+export function setSolidColorWallpaper(
+	rgbHexColor: string,
+	options?: SetOptions
+): Promise<void>;
+
+export function setLockscreen(imagePath: string): Promise<void>;

package/index.js

@@ -0,0 +1,15 @@
+import process from 'node:process';
+import * as macos from './source/macos.js';
+import * as linux from './source/linux/index.js';
+import * as windows from './source/windows.js';
+
+let wallpaper;
+if (process.platform === 'darwin') {
+	wallpaper = macos;
+} else if (process.platform === 'win32') {
+	wallpaper = windows;
+} else {
+	wallpaper = linux;
+}
+
+export const {getWallpaper, setWallpaper, setSolidColorWallpaper, screens, setLockscreen} = wallpaper;

package/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/package.json

@@ -0,0 +1,44 @@
+{
+	"name": "wallpaper-lockscreen",
+	"version": "0.0.4",
+	"description": "Manage the desktop wallpaper and lockscreen",
+	"license": "MIT",
+	"repository": "cihantaylan/wallpaper-lockscreen",
+	"author": {
+		"name": "Cihan TAYLAN",
+		"email": "cihantaylan@cihantaylan.com",
+		"url": "https://cihantaylan.com"
+	},
+	"type": "module",
+	"exports": "./index.js",
+	"engines": {
+		"node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+	},
+	"scripts": {
+		"test": "xo --fix && xo && ava && tsd"
+	},
+	"files": [
+		"index.js",
+		"index.d.ts",
+		"source"
+	],
+	"keywords": [
+		"macos",
+		"linux",
+		"windows",
+		"wallpaper",
+		"desktop",
+		"background",
+		"image",
+		"picture",
+		"photo"
+	],
+	"devDependencies": {
+		"ava": "^4.0.1",
+		"tsd": "^0.19.1",
+		"xo": "^0.47.0"
+	},
+	"ava": {
+		"serial": true
+	}
+}

package/readme.md

@@ -0,0 +1,140 @@
+#### Forked from https://www.npmjs.com/package/wallpaper
+
+# wallpaper
+
+> Get or set the desktop wallpaper
+
+Works on macOS 10.14.4+, Linux, and Windows 10+.
+
+_Maintainer needed for the Linux part of the code. No new Linux-related changes will be accepted until someone with good Linux knowledge volunteers._
+
+## Install
+
+```sh
+npm install wallpaper
+```
+
+## Usage
+
+```js
+import { getWallpaper, setWallpaper } from "wallpaper";
+
+await setWallpaper("unicorn.jpg");
+
+await getWallpaper();
+//=> '/Users/sindresorhus/unicorn.jpg'
+```
+
+## API
+
+### getWallpaper(options?)
+
+Returns a `Promise<string>` with the path of the current desktop wallpaper.
+
+#### options
+
+Type: `object`
+
+##### screen _(macOS only)_
+
+Type: `string | number`\
+Values: `'all'`, `'main'`, or the index of a screen from `.screens()`\
+Default: `'main'`
+
+The screen to get the wallpaper from.
+
+If you set `'all'` then `getWallpaper()` will return a `Promise<string[]>`.
+
+### setWallpaper(imagePath, options?)
+
+Returns a `Promise`.
+
+#### imagePath
+
+Type: `string`
+
+The path to the image to set as the desktop wallpaper.
+
+#### options
+
+Type: `object`
+
+##### screen _(macOS only)_
+
+Type: `string | number`\
+Values: `'all'`, `'main'`, or the index of a screen from `.screens()`
+Default: `'all'`
+
+The screen to set the wallpaper on.
+
+_On Linux and Windows it's hard-coded to `'main'`._
+
+##### scale _(macOS only)_
+
+Type: `string`\
+Values: `'auto' | 'fill' | 'fit' | 'stretch' | 'center'`\
+Default: `'auto'`
+
+Scaling method.
+
+### setSolidColorWallpaper(color, options?) _(macOS only)_
+
+Returns a `Promise`.
+
+#### color
+
+Type: `string`
+
+The color to set as a RGB Hex value. For example, `000000` for black.
+
+#### options
+
+Type: `object`
+
+##### screen
+
+Type: `string | number`\
+Values: `'all'`, `'main'`, or the index of a screen from `.screens()`
+Default: `'all'`
+
+The screen to set the wallpaper on.
+
+```js
+import { setSolidColorWallpaper } from "wallpaper";
+
+await setSolidColorWallpaper("000000");
+```
+
+### screens() _(macOS only)_
+
+Returns a `Promise<string[]>` with the available screens.
+
+```js
+import { screens } from "wallpaper";
+
+await screens();
+//=> ['Color LCD']
+```
+
+## FAQ
+
+#### How can I set a website as a static wallpaper?
+
+If you only need a static snapshot of the website, you can use [`capture-website`](https://github.com/sindresorhus/capture-website) and then pass the result to this package. You can make it semi-dynamic, by capturing the website snapshot every 10 seconds, for example.
+
+#### How can I set a website, video, or WebGL as a dynamic wallpaper?
+
+You cannot use this package to set a dynamic wallpaper.
+
+On macOS, check out [Plash](https://github.com/sindresorhus/Plash), which lets you set any website as your wallpaper. The website could contain a fullscreen video, WebGL, slideshow, animated, etc.
+
+You can also do this with Electron on macOS and Linux by using [`new BrowserWindow({type: 'desktop'})`](https://www.electronjs.org/docs/latest/api/browser-window#new-browserwindowoptions).
+
+On Windows, you can use [Wallpaper Engine](https://wallpaperengine.io). It's available on Steam, HumbleBundle, and Green Man Gaming for around 4 USD.
+
+## Related
+
+- [wallpaper-cli](https://github.com/sindresorhus/wallpaper-cli) - CLI for this module
+- [macos-wallpaper](https://github.com/sindresorhus/macos-wallpaper) - macOS binary used in this module
+- [win-wallpaper](https://github.com/sindresorhus/win-wallpaper) - Windows binary used in this module
+- [trash](https://github.com/sindresorhus/trash) - Move files and directories to the trash

package/source/linux/background-managers/cinnamon.js

@@ -0,0 +1,33 @@
+import {commandExists, execFile, hasLine} from '../util.js';
+
+export async function isAvailable() {
+	if (!await commandExists('gsettings')) {
+		return false;
+	}
+
+	try {
+		const {stdout} = await execFile('gsettings', ['list-schemas']);
+		return hasLine(stdout, 'org.cinnamon.desktop.background');
+	} catch {
+		return false;
+	}
+}
+
+export async function get() {
+	const {stdout} = await execFile('gsettings', [
+		'get',
+		'org.cinnamon.desktop.background',
+		'picture-uri',
+	]);
+
+	return stdout.trim().slice(8, -1);
+}
+
+export async function set(imagePath) {
+	await execFile('gsettings', [
+		'set',
+		'org.cinnamon.desktop.background',
+		'picture-uri',
+		`file://${imagePath}`,
+	]);
+}

package/source/linux/background-managers/dconf.js

@@ -0,0 +1,22 @@
+import {commandExists, execFile} from '../util.js';
+
+export async function isAvailable() {
+	return commandExists('dconf');
+}
+
+export async function get() {
+	const {stdout} = await execFile('dconf', [
+		'read',
+		'/org/mate/desktop/background/picture-filename',
+	]);
+
+	return stdout.trim().slice(1, -1);
+}
+
+export async function set(imagePath) {
+	await execFile('dconf', [
+		'write',
+		'/org/mate/desktop/background/picture-filename',
+		`"${imagePath}"`,
+	]);
+}

package/source/linux/background-managers/dcop.js

@@ -0,0 +1,14 @@
+import {commandExists, execFile} from '../util.js';
+
+export async function isAvailable() {
+	return commandExists('dcop');
+}
+
+export async function set(imagePath) {
+	await execFile('dcop', [
+		'kdesktop',
+		'KBackgroundIface',
+		'setWallpaper',
+		`${imagePath} 1`,
+	]);
+}

package/source/linux/background-managers/feh.js

@@ -0,0 +1,9 @@
+import {commandExists, execFile} from '../util.js';
+
+export async function isAvailable() {
+	return commandExists('feh');
+}
+
+export async function set(imagePath) {
+	await execFile('feh', ['--bg-fill', imagePath]);
+}

package/source/linux/background-managers/gconftool-2.js

@@ -0,0 +1,15 @@
+import {commandExists, execFile} from '../util.js';
+
+export async function isAvailable() {
+	return commandExists('gconftool-2');
+}
+
+export async function set(imagePath) {
+	await execFile('gconftool-2', [
+		'--set',
+		'/desktop/gnome/background/picture_filename',
+		'--type',
+		'string',
+		imagePath,
+	]);
+}

package/source/linux/background-managers/gnome.js

@@ -0,0 +1,24 @@
+import {commandExists, execFile} from '../util.js';
+
+export async function isAvailable() {
+	return commandExists('gsettings');
+}
+
+export async function get() {
+	const {stdout} = await execFile('gsettings', [
+		'get',
+		'org.gnome.desktop.background',
+		'picture-uri',
+	]);
+
+	return stdout.trim().slice(8, -1);
+}
+
+export async function set(imagePath) {
+	await execFile('gsettings', [
+		'set',
+		'org.gnome.desktop.background',
+		'picture-uri',
+		`file://${imagePath}`,
+	]);
+}

package/source/linux/background-managers/index.js

@@ -0,0 +1,12 @@
+export * as cinnamon from './cinnamon.js';
+export * as dconf from './dconf.js';
+export * as dcop from './dcop.js';
+export * as feh from './feh.js';
+export * as gconftool2 from './gconftool-2.js';
+export * as gnome from './gnome.js';
+export * as mate from './mate.js';
+export * as nitrogen from './nitrogen.js';
+export * as pcmanfm from './pcmanfm.js';
+export * as qdbus from './qdbus.js';
+export * as setroot from './setroot.js';
+export * as xfconfquery from './xfconf-query.js';

package/source/linux/background-managers/mate.js

@@ -0,0 +1,33 @@
+import {commandExists, execFile, hasLine} from '../util.js';
+
+export async function isAvailable() {
+	if (!await commandExists('gsettings')) {
+		return false;
+	}
+
+	try {
+		const {stdout} = await execFile('gsettings', ['list-schemas']);
+		return hasLine(stdout, 'org.mate.background');
+	} catch {
+		return false;
+	}
+}
+
+export async function get() {
+	const {stdout} = await execFile('gsettings', [
+		'get',
+		'org.mate.background',
+		'picture-filename',
+	]);
+
+	return stdout.trim().slice(1, -1);
+}
+
+export async function set(imagePath) {
+	await execFile('gsettings', [
+		'set',
+		'org.mate.background',
+		'picture-filename',
+		imagePath,
+	]);
+}

package/source/linux/background-managers/nitrogen.js

@@ -0,0 +1,23 @@
+import path from 'node:path';
+import os from 'node:os';
+import {commandExists, execFile, readFile} from '../util.js';
+
+const homeDirectory = os.homedir();
+
+export async function isAvailable() {
+	return commandExists('nitrogen');
+}
+
+export async function get() {
+	const configFile = path.join(homeDirectory, '.config/nitrogen/bg-saved.cfg');
+	const config = await readFile(configFile, 'utf8');
+	return config.trim().split('\n').find(line => line.startsWith('file=')).replace('file=', '');
+}
+
+export async function set(imagePath) {
+	await execFile('nitrogen', [
+		'--set-zoom-fill',
+		'--save',
+		imagePath,
+	]);
+}

package/source/linux/background-managers/pcmanfm.js

@@ -0,0 +1,9 @@
+import {commandExists, execFile} from '../util.js';
+
+export async function isAvailable() {
+	return commandExists('pcmanfm');
+}
+
+export async function set(imagePath) {
+	await execFile('pcmanfm', ['--set-wallpaper', imagePath]);
+}

package/source/linux/background-managers/qdbus.js

@@ -0,0 +1,22 @@
+import {commandExists, execFile} from '../util.js';
+
+export async function isAvailable() {
+	return commandExists('qdbus');
+}
+
+export async function set(imagePath) {
+	await execFile('qdbus', [
+		'org.kde.plasmashell',
+		'/PlasmaShell',
+		'org.kde.PlasmaShell.evaluateScript',
+		`
+		var allDesktops = desktops();
+		for (var i = 0; i < allDesktops.length; i++) {
+			var desktop = allDesktops[i];
+			desktop.wallpaperPlugin = 'org.kde.image';
+			desktop.currentConfigGroup = ['Wallpaper', 'org.kde.image', 'General'];
+			desktop.writeConfig('Image', 'file://${imagePath}');
+		}
+		`,
+	]);
+}

package/source/linux/background-managers/setroot.js

@@ -0,0 +1,9 @@
+import {commandExists, execFile} from '../util.js';
+
+export async function isAvailable() {
+	return commandExists('setroot');
+}
+
+export async function set(imagePath) {
+	await execFile('setroot', [imagePath]);
+}

package/source/linux/background-managers/xfconf-query.js

@@ -0,0 +1,16 @@
+import {commandExists, execFile} from '../util.js';
+
+export async function isAvailable() {
+	return commandExists('xfconf-query');
+}
+
+export async function set(imagePath) {
+	await execFile('xfconf-query', [
+		'--channel',
+		'xfce4-desktop',
+		'--property',
+		'/backdrop/screen0/monitor0/image-path',
+		'--set',
+		`${imagePath}`,
+	]);
+}

package/source/linux/index.js

@@ -0,0 +1,94 @@
+import path from 'node:path';
+import * as managers from './background-managers/index.js';
+
+let availableApps;
+
+async function setAvailableApps() {
+	availableApps = [];
+
+	const promises = Object.values(managers).map(async manager => {
+		if (await manager.isAvailable()) {
+			availableApps.push(manager);
+		}
+	});
+
+	await Promise.all(promises);
+}
+
+export async function getWallpaper() {
+	if (!availableApps) {
+		await setAvailableApps();
+		return getWallpaper();
+	}
+
+	const wallpapersVoted = new Map();
+	const promises = availableApps.map(async app => {
+		if (typeof app.get !== 'function') {
+			return;
+		}
+
+		const imagePath = await app.get();
+
+		if (typeof imagePath !== 'undefined') {
+			if (!wallpapersVoted.get(imagePath)) {
+				wallpapersVoted.set(imagePath, 0);
+			}
+
+			wallpapersVoted.set(imagePath, wallpapersVoted.get(imagePath) + 1);
+		}
+	});
+
+	await Promise.all(promises.map(promise => promise.catch(() => {})));
+
+	let wallpaperMostVoted;
+	let wallpaperMostVotedCount;
+
+	for (const [wallpaper] of wallpapersVoted) {
+		if (!wallpaperMostVoted || wallpaperMostVoted[wallpaper] > wallpaperMostVotedCount) {
+			wallpaperMostVoted = wallpaper;
+			wallpaperMostVotedCount = wallpaperMostVoted[wallpaper];
+		}
+	}
+
+	return wallpaperMostVoted;
+}
+
+export async function setWallpaper(imagePath) {
+	if (typeof imagePath !== 'string') {
+		throw new TypeError('Expected a string');
+	}
+
+	if (!availableApps) {
+		await setAvailableApps();
+		await setWallpaper(imagePath);
+		return;
+	}
+
+	const promises = availableApps.map(async app => {
+		if (typeof app.set === 'function') {
+			await app.set(path.resolve(imagePath));
+		}
+	});
+
+	await Promise.allSettled(promises);
+}
+
+export async function setLockscreen(imagePath) {
+	if (typeof imagePath !== 'string') {
+		throw new TypeError('Expected a string');
+	}
+
+	if (!availableApps) {
+		await setAvailableApps();
+		await setWallpaper(imagePath);
+		return;
+	}
+
+	const promises = availableApps.map(async app => {
+		if (typeof app.set === 'function') {
+			await app.set(path.resolve(imagePath));
+		}
+	});
+
+	await Promise.allSettled(promises);
+}

package/source/linux/util.js

@@ -0,0 +1,28 @@
+import {promisify} from 'node:util';
+import childProcess from 'node:child_process';
+import {promises as fsPromises} from 'node:fs';
+
+export const execFile = promisify(childProcess.execFile);
+export const exec = promisify(childProcess.exec);
+
+export async function commandExists(command) {
+	// `which` all commands and expect stdout to return a positive
+	try {
+		let {stdout} = await execFile('which', ['-a', command]);
+		stdout = stdout.trim();
+
+		if (!stdout) {
+			return false;
+		}
+
+		return true;
+	} catch {
+		return false;
+	}
+}
+
+export function hasLine(string, lineToFind) {
+	return string.split('\n').find(line => line.trim() === lineToFind);
+}
+
+export const {readFile} = fsPromises;

package/source/macos.js

@@ -0,0 +1,71 @@
+import childProcess from 'node:child_process';
+import path from 'node:path';
+import {fileURLToPath} from 'node:url';
+import {promisify} from 'node:util';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const execFile = promisify(childProcess.execFile);
+
+// Binary source → https://github.com/sindresorhus/macos-wallpaper
+const binary = path.join(__dirname, 'macos-wallpaper');
+
+export async function getWallpaper({screen = 'main'} = {}) {
+	let {stdout} = await execFile(binary, ['get', '--screen', screen]);
+	stdout = stdout.trim();
+
+	if (screen === 'all') {
+		return stdout.split('\n');
+	}
+
+	return stdout;
+}
+
+export async function setWallpaper(imagePath, {screen = 'all', scale = 'auto'} = {}) {
+	if (typeof imagePath !== 'string') {
+		throw new TypeError('Expected a string');
+	}
+
+	const arguments_ = [
+		'set',
+		path.resolve(imagePath),
+		'--screen',
+		screen,
+		'--scale',
+		scale,
+	];
+
+	await execFile(binary, arguments_);
+}
+
+export async function setSolidColorWallpaper(color, {screen = 'all'} = {}) {
+	if (typeof color !== 'string') {
+		throw new TypeError('Expected a string');
+	}
+
+	const arguments_ = [
+		'set-solid-color',
+		color,
+		'--screen',
+		screen,
+	];
+
+	await execFile(binary, arguments_);
+}
+
+export async function screens() {
+	const {stdout} = await execFile(binary, ['screens']);
+	return stdout.trim().split('\n').map(line => line.replace(/^\d+ - /, ''));
+}
+
+export async function setLockscreen(imagePath) {
+	if (typeof imagePath !== 'string') {
+		throw new TypeError('Expected a string');
+	}
+
+	const arguments_ = [
+		'set',
+		path.resolve(imagePath),
+	];
+
+	await execFile(binary, arguments_);
+}

package/source/windows.js

@@ -0,0 +1,32 @@
+import childProcess from 'node:child_process';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { promisify } from 'node:util';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const execFile = promisify(childProcess.execFile);
+
+// Binary source → https://github.com/sindresorhus/win-wallpaper
+const binary = path.join(__dirname, 'windows-wallpaper.exe');
+const binaryForLockscreen = path.join(__dirname, 'windows-lockscreen.exe');
+
+export async function getWallpaper() {
+	const { stdout } = await execFile(binary);
+	return stdout.trim();
+}
+
+export async function setWallpaper(imagePath) {
+	if (typeof imagePath !== 'string') {
+		throw new TypeError('Expected a string');
+	}
+
+	await execFile(binary, [path.resolve(imagePath)]);
+}
+
+export async function setLockscreen(imagePath) {
+	if (typeof imagePath !== 'string') {
+		throw new TypeError('Expected a string');
+	}
+
+	await execFile(binaryForLockscreen, [path.resolve(imagePath)]);
+}