npm - @ffflorian/windows-shortcut-maker - Versions diffs - 2.3.0 → 2.3.1 - Mend

@ffflorian/windows-shortcut-maker 2.3.0 → 2.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (11) hide show

package/README.md +12 -17
package/{index.js → dist/cjs/index.js} +7 -12
package/dist/cjs/index.js.map +1 -0
package/dist/cjs/package.json +3 -0
package/dist/mjs/index.d.ts +24 -0
package/dist/mjs/index.js +65 -0
package/dist/mjs/index.js.map +1 -0
package/dist/mjs/package.json +3 -0
package/package.json +17 -12
package/index.js.map +0 -1
/package/{index.d.ts → dist/cjs/index.d.ts} +0 -0

package/README.md CHANGED Viewed

@@ -13,15 +13,18 @@ This module uses a Windows VBScript file to get native access to the operational
 - Supports all Windows NT 4.0 (and beyond) systems.
 - The module is extremely small and provides access to the entire API.
-### Installation:
+## Prerequisites
-```
-$ npm install @ffflorian/windows-shortcut-maker
-# or
-$ yarn add @ffflorian/windows-shortcut-maker
-```
+- [Node.js](https://nodejs.org) >= 14
+- npm (preinstalled) or [yarn](https://classic.yarnpkg.com) < 2
+## Installation
+ℹ️ This is a hybrid [CommonJS](https://nodejs.org/docs/latest/api/modules.html#modules-commonjs-modules) / [ESM](https://nodejs.org/api/esm.html#introduction) module.
+Run `yarn global add @ffflorian/windows-shortcut-maker` or `npm i -g @ffflorian/windows-shortcut-maker`
-## Basic usage:
+## Basic usage
 ```ts
 // Requires the Windows Shortcut Maker module
@@ -51,9 +54,9 @@ try {
 }
 ```
-# Documentation
+## Documentation
-## `make(options)`
+### `make(options)`
 > Returns `void` after asynchronously executing the wrapped script which makes the Windows API calls or throws an `Error` if no valid `filepath` parameter property was previously specified.
@@ -84,11 +87,3 @@ try {
 > Returns `void` after synchronously executing the wrapped script which makes the Windows API calls or throws an `Error` if no valid `filepath` parameter property was previously specified.
 >
 > The API is the same as `makeSync()`
-# License
-This project exists under the [GPL-3.0 license](LICENSE).
-# Development
-1. Add support for making internet shortcuts.

package/{index.js → dist/cjs/index.js} RENAMED Viewed

@@ -1,9 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.make = exports.makeSync = void 0;
-const child_process_1 = require("child_process");
-const fs = require("fs");
-const path = require("path");
+import { spawn, spawnSync } from 'node:child_process';
+import fs from 'node:fs';
+import path from 'node:path';
 function mergeOptions(options) {
     const rawName = path.basename(options.filepath).replace(/(.*)\..*$/, '$1');
     const defaultOptions = {
@@ -53,18 +50,16 @@ function buildArgs(options) {
         options.linkHotkey,
     ];
 }
-function makeSync(options) {
+export function makeSync(options) {
     const checkedOptions = prepare(options);
-    (0, child_process_1.spawnSync)('wscript', buildArgs(checkedOptions));
+    spawnSync('wscript', buildArgs(checkedOptions));
 }
-exports.makeSync = makeSync;
-function make(options) {
+export function make(options) {
     const checkedOptions = prepare(options);
     return new Promise((resolve, reject) => {
-        (0, child_process_1.spawn)('wscript', buildArgs(checkedOptions))
+        spawn('wscript', buildArgs(checkedOptions))
             .on('error', reject)
             .on('exit', () => resolve());
     });
 }
-exports.make = make;
 //# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAE,SAAS,EAAC,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAyB7B,SAAS,YAAY,CAAC,OAAwB;IAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IAC3E,MAAM,cAAc,GAAG;QACrB,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,KAAK,EAAE,KAAK;QACZ,QAAQ,EAAE,EAAE;QACZ,OAAO,EAAE,EAAE;QACX,eAAe,EAAE,OAAO;QACxB,YAAY,EAAE,EAAE;QAChB,UAAU,EAAE,EAAE;QACd,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,QAAQ,EAAE,OAAO;QACjB,cAAc,EAAE,CAAC;KAClB,CAAC;IACF,uCACK,cAAc,GACd,OAAO,EACV;AACJ,CAAC;AAED,SAAS,OAAO,CAAC,OAAiC;IAChD,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;QAC/B,OAAO,GAAG,EAAC,QAAQ,EAAE,OAAO,EAAC,CAAC;KAC/B;IACD,MAAM,cAAc,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAE7C,IAAI,CAAC,cAAc,CAAC,KAAK,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE;QACpE,MAAM,IAAI,KAAK,CAAC,wBAAwB,cAAc,CAAC,QAAQ,kBAAkB,CAAC,CAAC;KACpF;IAED,IAAI,cAAc,CAAC,YAAY,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE;QACxD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,YAAY,CAAC,EAAE;YAC/C,MAAM,IAAI,KAAK,CAAC,6BAA6B,cAAc,CAAC,YAAY,kBAAkB,CAAC,CAAC;SAC7F;QACD,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC,WAAW,EAAE,EAAE;YAC5D,MAAM,IAAI,KAAK,CAAC,6BAA6B,cAAc,CAAC,YAAY,sBAAsB,CAAC,CAAC;SACjG;KACF;IAED,OAAO,cAAc,CAAC;AACxB,CAAC;AAED,SAAS,SAAS,CAAC,OAAkC;IACnD,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,2BAA2B,CAAC,CAAC;IACrE,OAAO;QACL,UAAU;QACV,OAAO,CAAC,QAAQ;QAChB,OAAO,CAAC,YAAY;QACpB,OAAO,CAAC,QAAQ;QAChB,OAAO,CAAC,QAAQ;QAChB,OAAO,CAAC,eAAe;QACvB,OAAO,CAAC,OAAO;QACf,OAAO,CAAC,QAAQ;QAChB,OAAO,CAAC,cAAc,CAAC,QAAQ,EAAE;QACjC,OAAO,CAAC,UAAU;KACnB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,OAAiC;IACxD,MAAM,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACxC,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC;AAClD,CAAC;AAED,MAAM,UAAU,IAAI,CAAC,OAAiC;IACpD,MAAM,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACxC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,KAAK,CAAC,SAAS,EAAE,SAAS,CAAC,cAAc,CAAC,CAAC;aACxC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC;aACnB,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/cjs/package.json ADDED Viewed

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/dist/mjs/index.d.ts ADDED Viewed

@@ -0,0 +1,24 @@
+export interface ShortcutOptions {
+    /** the absolute path including the name of which file should the module make a shortcut (required). */
+    filepath: string;
+    /** create the shortcut even if the original file cannot be found. */
+    force?: boolean;
+    /** the arguments passed to the original file when the new shortcut is executed. */
+    linkArgs?: string;
+    /** the absolute path in which folder the original file should start executing. */
+    linkCwd?: string;
+    /** the description message shown when the cursor stands over the new shortcut without clicking it. */
+    linkDescription?: string;
+    /** the folder where to save the link (default is the current user's desktop) */
+    linkFilepath?: string;
+    /** the key combination that is going to trigger the new shortcut execution. (e.g. `'ALT+CTRL+F'`) */
+    linkHotkey?: string;
+    /** the absolute path to an `.ico` extension image used as the icon for the new shortcut. */
+    linkIcon?: string;
+    /** the name given for the new shortcut file which obeys the same name rules as a regular file does. */
+    linkName?: string;
+    /** the initial window mode adopted by the original file when executed. (e.g. `3` is maximized, `4` is normal and `7` is minimized) */
+    linkWindowMode?: number;
+}
+export declare function makeSync(options: ShortcutOptions | string): void;
+export declare function make(options: ShortcutOptions | string): Promise<void>;

package/dist/mjs/index.js ADDED Viewed

@@ -0,0 +1,65 @@
+import { spawn, spawnSync } from 'node:child_process';
+import fs from 'node:fs';
+import path from 'node:path';
+function mergeOptions(options) {
+    const rawName = path.basename(options.filepath).replace(/(.*)\..*$/, '$1');
+    const defaultOptions = {
+        filepath: options.filepath,
+        force: false,
+        linkArgs: '',
+        linkCwd: '',
+        linkDescription: rawName,
+        linkFilepath: '',
+        linkHotkey: '',
+        linkIcon: options.filepath,
+        linkName: rawName,
+        linkWindowMode: 4,
+    };
+    return Object.assign(Object.assign({}, defaultOptions), options);
+}
+function prepare(options) {
+    if (typeof options === 'string') {
+        options = { filepath: options };
+    }
+    const checkedOptions = mergeOptions(options);
+    if (!checkedOptions.force && !fs.existsSync(checkedOptions.filepath)) {
+        throw new Error(`Specified file path "${checkedOptions.filepath}" does not exist`);
+    }
+    if (checkedOptions.linkFilepath && !checkedOptions.force) {
+        if (!fs.existsSync(checkedOptions.linkFilepath)) {
+            throw new Error(`Specified link file path "${checkedOptions.linkFilepath}" does not exist`);
+        }
+        if (!fs.lstatSync(checkedOptions.linkFilepath).isDirectory()) {
+            throw new Error(`Specified link file path "${checkedOptions.linkFilepath}" is not a directory`);
+        }
+    }
+    return checkedOptions;
+}
+function buildArgs(options) {
+    const scriptPath = path.join(__dirname, '../scripts/createLink.vbs');
+    return [
+        scriptPath,
+        options.filepath,
+        options.linkFilepath,
+        options.linkName,
+        options.linkArgs,
+        options.linkDescription,
+        options.linkCwd,
+        options.linkIcon,
+        options.linkWindowMode.toString(),
+        options.linkHotkey,
+    ];
+}
+export function makeSync(options) {
+    const checkedOptions = prepare(options);
+    spawnSync('wscript', buildArgs(checkedOptions));
+}
+export function make(options) {
+    const checkedOptions = prepare(options);
+    return new Promise((resolve, reject) => {
+        spawn('wscript', buildArgs(checkedOptions))
+            .on('error', reject)
+            .on('exit', () => resolve());
+    });
+}
+//# sourceMappingURL=index.js.map

package/dist/mjs/index.js.map ADDED Viewed

@@ -0,0 +1 @@

package/dist/mjs/package.json ADDED Viewed

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/package.json CHANGED Viewed

@@ -9,12 +9,16 @@
     "typescript": "5.0.4"
   },
   "engines": {
-    "node": ">= 10.9"
+    "node": ">= 14.16"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/mjs/index.js",
+      "require": "./dist/cjs/index.js"
+    }
   },
   "files": [
-    "index.d.ts",
-    "index.js",
-    "index.js.map",
+    "dist",
     "scripts"
   ],
   "keywords": [
@@ -27,18 +31,19 @@
     "url"
   ],
   "license": "GPL-3.0",
-  "main": "index.js",
+  "main": "dist/cjs/index.js",
+  "module": "dist/mjs/index.js",
   "name": "@ffflorian/windows-shortcut-maker",
-  "publishConfig": {
-    "directory": "flattened"
-  },
   "repository": "https://github.com/ffflorian/node-packages/tree/main/packages/windows-shortcut-maker",
   "scripts": {
-    "build": "tsc",
+    "build": "yarn build:cjs && yarn build:mjs && yarn generate:packagejson",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:mjs": "tsc -p tsconfig.json",
     "clean": "rimraf dist",
     "dist": "yarn clean && yarn build",
-    "flatten": "node ../publish-flat/dist/cli.js -o flattened",
-    "postversion": "node ../publish-flat/dist/cli-copy.js -o flattened/package.json version"
+    "generate:packagejson": "../../bin/generate-hybrid-package-json.sh"
   },
-  "version": "2.3.0"
+  "type": "module",
+  "version": "2.3.1",
+  "gitHead": "fee6dde4396255259028c1c723a95b9f6ec5b281"
 }

package/index.js.map DELETED Viewed

@@ -1 +0,0 @@

- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,iDAA+C;AAC/C,yBAAyB;AACzB,6BAA6B;AAyB7B,SAAS,YAAY,CAAC,OAAwB;IAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IAC3E,MAAM,cAAc,GAAG;QACrB,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,KAAK,EAAE,KAAK;QACZ,QAAQ,EAAE,EAAE;QACZ,OAAO,EAAE,EAAE;QACX,eAAe,EAAE,OAAO;QACxB,YAAY,EAAE,EAAE;QAChB,UAAU,EAAE,EAAE;QACd,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,QAAQ,EAAE,OAAO;QACjB,cAAc,EAAE,CAAC;KAClB,CAAC;IACF,uCACK,cAAc,GACd,OAAO,EACV;AACJ,CAAC;AAED,SAAS,OAAO,CAAC,OAAiC;IAChD,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;QAC/B,OAAO,GAAG,EAAC,QAAQ,EAAE,OAAO,EAAC,CAAC;KAC/B;IACD,MAAM,cAAc,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAE7C,IAAI,CAAC,cAAc,CAAC,KAAK,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE;QACpE,MAAM,IAAI,KAAK,CAAC,wBAAwB,cAAc,CAAC,QAAQ,kBAAkB,CAAC,CAAC;KACpF;IAED,IAAI,cAAc,CAAC,YAAY,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE;QACxD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,YAAY,CAAC,EAAE;YAC/C,MAAM,IAAI,KAAK,CAAC,6BAA6B,cAAc,CAAC,YAAY,kBAAkB,CAAC,CAAC;SAC7F;QACD,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC,WAAW,EAAE,EAAE;YAC5D,MAAM,IAAI,KAAK,CAAC,6BAA6B,cAAc,CAAC,YAAY,sBAAsB,CAAC,CAAC;SACjG;KACF;IAED,OAAO,cAAc,CAAC;AACxB,CAAC;AAED,SAAS,SAAS,CAAC,OAAkC;IACnD,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,2BAA2B,CAAC,CAAC;IACrE,OAAO;QACL,UAAU;QACV,OAAO,CAAC,QAAQ;QAChB,OAAO,CAAC,YAAY;QACpB,OAAO,CAAC,QAAQ;QAChB,OAAO,CAAC,QAAQ;QAChB,OAAO,CAAC,eAAe;QACvB,OAAO,CAAC,OAAO;QACf,OAAO,CAAC,QAAQ;QAChB,OAAO,CAAC,cAAc,CAAC,QAAQ,EAAE;QACjC,OAAO,CAAC,UAAU;KACnB,CAAC;AACJ,CAAC;AAED,SAAgB,QAAQ,CAAC,OAAiC;IACxD,MAAM,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACxC,IAAA,yBAAS,EAAC,SAAS,EAAE,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC;AAClD,CAAC;AAHD,4BAGC;AAED,SAAgB,IAAI,CAAC,OAAiC;IACpD,MAAM,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACxC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,IAAA,qBAAK,EAAC,SAAS,EAAE,SAAS,CAAC,cAAc,CAAC,CAAC;aACxC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC;aACnB,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;AACL,CAAC;AAPD,oBAOC"}

/package/{index.d.ts → dist/cjs/index.d.ts} RENAMED Viewed

File without changes