@webpod/ps 0.0.0-beta.0 → 0.0.0-beta.10

package/README.md

@@ -7,7 +7,7 @@
 * [x] CJS and ESM package entry points
 * [x] `table-parser` replaced with `@webpod/ingrid` to handle some issues: [neekey/ps#76](https://github.com/neekey/ps/issues/76), [neekey/ps#62](https://github.com/neekey/ps/issues/62), [neekey/table-parser#11](https://github.com/neekey/table-parser/issues/11), [neekey/table-parser#18](https://github.com/neekey/table-parser/issues/18)
 * [x] Provides promisified responses
-* [ ] Brings sync API
+* [x] Brings sync API
 * [x] Builds a process tree
 
 ## Install
@@ -44,6 +44,9 @@ lookup({pid: 12345}, (err, list) => {
     console.log('No such process found!')
   }
 })
+
+// or syncronously
+const _list = lookup.sync({pid: 12345})
 ```
 
 Define a query opts to filter the results by `command` and/or `arguments` predicates:
@@ -109,6 +112,9 @@ const children = await tree({pid: 123, recursive: true})
   {pid: 130, ppid: 125},
 ] 
 */
+
+// or syncronously
+const list = tree.sync({pid: 123, recursive: true}) 
 ```
 
 ### kill()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webpod/ps",
-  "version": "0.0.0-beta.0",
+  "version": "0.0.0-beta.10",
   "description": "A process lookup utility",
   "publishConfig": {
     "access": "public"
@@ -24,7 +24,8 @@
     "test": "concurrently 'npm:test:*'",
     "test:lint": "eslint -c src/test/lint/.eslintrc.json src",
     "test:unit": "c8 -r lcov -r text -o target/coverage -x src/scripts -x src/test -x target node --loader ts-node/esm --experimental-specifier-resolution=node src/scripts/test.mjs",
-    "test:legacy": "node ./node_modules/mocha/bin/mocha -t 0 -R spec src/test/legacy/test.cjs"
+    "test:legacy": "node ./node_modules/mocha/bin/mocha -t 0 -R spec src/test/legacy/test.cjs",
+    "publish:draft": "npm run build && npm publish --no-git-tag-version"
   },
   "files": [
     "target/cjs",
@@ -38,25 +39,25 @@
     "pid"
   ],
   "dependencies": {
-    "@webpod/ingrid": "^0.0.0-beta.1",
-    "zurk": "^0.0.32"
+    "@webpod/ingrid": "^0.0.0-beta.3",
+    "zurk": "^0.6.0"
   },
   "devDependencies": {
-    "@types/node": "^20.11.30",
-    "c8": "^9.1.0",
-    "concurrently": "^8.2.2",
-    "esbuild": "^0.20.2",
-    "esbuild-node-externals": "^1.13.0",
-    "esbuild-plugin-entry-chunks": "^0.1.11",
+    "@types/node": "^22.7.6",
+    "c8": "^10.1.2",
+    "concurrently": "^9.0.1",
+    "esbuild": "^0.24.0",
+    "esbuild-node-externals": "^1.15.0",
+    "esbuild-plugin-entry-chunks": "^0.1.15",
     "eslint": "^8.57.0",
     "eslint-config-qiwi": "^2.1.3",
     "fast-glob": "^3.3.2",
     "minimist": "^1.2.8",
-    "mocha": "^10.3.0",
-    "sinon": "^17.0.1",
+    "mocha": "^10.7.3",
+    "sinon": "^18.0.1",
     "ts-node": "^10.9.2",
-    "typedoc": "^0.25.12",
-    "typescript": "^5.4.3"
+    "typedoc": "^0.26.10",
+    "typescript": "^5.6.3"
   },
   "repository": {
     "type": "git",

package/target/cjs/index.cjs

@@ -53,47 +53,56 @@ __export(ts_exports, {
   default: () => ts_default,
   kill: () => kill,
   lookup: () => lookup,
-  tree: () => tree
+  lookupSync: () => lookupSync,
+  tree: () => tree,
+  treeSync: () => treeSync
 });
 module.exports = __toCommonJS(ts_exports);
 
 // src/main/ts/ps.ts
 var import_node_process = __toESM(require("node:process"), 1);
 var import_node_fs = __toESM(require("node:fs"), 1);
+var import_node_os = require("node:os");
 var import_ingrid = require("@webpod/ingrid");
 var import_spawn = require("zurk/spawn");
-var import_node_os = require("node:os");
 var EOL = /(\r\n)|(\n\r)|\n|\r/;
 var IS_WIN = import_node_process.default.platform === "win32";
 var isBin = (f) => {
-  if (f === "")
-    return false;
-  if (!f.includes("/"))
-    return true;
-  if (!import_node_fs.default.existsSync(f))
-    return false;
+  if (f === "") return false;
+  if (!f.includes("/")) return true;
+  if (!import_node_fs.default.existsSync(f)) return false;
   const stat = import_node_fs.default.lstatSync(f);
   return stat.isFile() || stat.isSymbolicLink();
 };
-var lookup = (query = {}, cb = noop) => {
-  const { promise, resolve, reject } = makeDeferred();
+var lookup = (query = {}, cb = noop) => _lookup({ query, cb, sync: false });
+var lookupSync = (query = {}, cb = noop) => _lookup({ query, cb, sync: true });
+lookup.sync = lookupSync;
+var _lookup = ({
+  query = {},
+  cb = noop,
+  sync = false
+}) => {
+  const pFactory = sync ? makePseudoDeferred.bind(null, []) : makeDeferred;
+  const { promise, resolve, reject } = pFactory();
   const { psargs = ["-lx"] } = query;
-  const args = typeof psargs === "string" ? psargs.split(/\s+/) : psargs;
+  const args = Array.isArray(psargs) ? psargs : psargs.split(/\s+/);
   const extract = IS_WIN ? extractWmic : identity;
+  let result = [];
   const callback = (err, { stdout }) => {
     if (err) {
       reject(err);
       cb(err);
       return;
     }
-    const list = parseProcessList(extract(stdout), query);
-    resolve(list);
-    cb(null, list);
+    result = parseProcessList(extract(stdout), query);
+    resolve(result);
+    cb(null, result);
   };
   const ctx = IS_WIN ? {
     cmd: "cmd",
     input: "wmic process get ProcessId,ParentProcessId,CommandLine \n",
     callback,
+    sync,
     run(cb2) {
       cb2();
     }
@@ -103,10 +112,11 @@ var lookup = (query = {}, cb = noop) => {
     run(cb2) {
       cb2();
     },
+    sync,
     callback
   };
   (0, import_spawn.exec)(ctx);
-  return promise;
+  return Object.assign(promise, result);
 };
 var parseProcessList = (output, query = {}) => {
   const processList = parseGrid(output.trim());
@@ -134,20 +144,38 @@ var pickTree = (list, pid, recursive = false) => {
     ...children.flatMap((p) => recursive ? pickTree(list, p.pid, true) : [])
   ];
 };
-var tree = (_0, ..._1) => __async(void 0, [_0, ..._1], function* (opts, cb = noop) {
+var _tree = ({
+  cb = noop,
+  opts,
+  sync = false
+}) => {
   if (typeof opts === "string" || typeof opts === "number") {
-    return tree({ pid: opts }, cb);
+    return _tree({ opts: { pid: opts }, cb, sync });
   }
-  try {
+  const onError = (err) => cb(err);
+  const onData = (all) => {
+    if (opts === void 0) return all;
     const { pid, recursive = false } = opts;
-    const list = pickTree(yield lookup(), pid, recursive);
+    const list = pickTree(all, pid, recursive);
     cb(null, list);
     return list;
+  };
+  try {
+    const all = _lookup({ sync });
+    return sync ? onData(all) : all.then(onData, (err) => {
+      onError(err);
+      throw err;
+    });
   } catch (err) {
-    cb(err);
-    throw err;
+    onError(err);
+    return Promise.reject(err);
   }
+};
+var tree = (opts, cb) => __async(void 0, null, function* () {
+  return _tree({ opts, cb });
 });
+var treeSync = (opts, cb) => _tree({ opts, cb, sync: true });
+tree.sync = treeSync;
 var kill = (pid, opts, next) => {
   if (typeof opts == "function") {
     return kill(pid, void 0, opts);
@@ -171,8 +199,7 @@ var kill = (pid, opts, next) => {
   let checkTimeoutTimer;
   let checkIsTimeout = false;
   const checkKilled = (finishCallback) => lookup({ pid }, (err, list = []) => {
-    if (checkIsTimeout)
-      return;
+    if (checkIsTimeout) return;
     if (err) {
       clearTimeout(checkTimeoutTimer);
       reject(err);
@@ -230,15 +257,26 @@ var makeDeferred = () => {
   });
   return { resolve, reject, promise };
 };
+var makePseudoDeferred = (r = {}) => {
+  return {
+    promise: r,
+    resolve: identity,
+    reject(e) {
+      throw e;
+    }
+  };
+};
 var noop = () => {
 };
 var identity = (v) => v;
 
 // src/main/ts/index.ts
-var ts_default = { lookup, kill, tree };
+var ts_default = { kill, lookup, lookupSync, tree, treeSync };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   kill,
   lookup,
-  tree
+  lookupSync,
+  tree,
+  treeSync
 });

package/target/dts/index.d.ts

@@ -1,8 +1,16 @@
-export type * from './ps.ts';
-export { kill, lookup, tree } from './ps.ts';
+export type * from './ps.js';
+export { kill, lookup, lookupSync, tree, treeSync } from './ps.js';
 declare const _default: {
-    lookup: (query?: import("./ps.ts").TPsLookupQuery, cb?: import("./ps.ts").TPsLookupCallback) => Promise<import("./ps.ts").TPsLookupEntry[]>;
-    kill: (pid: string | number, opts?: string | number | import("./ps.ts").TPsKillOptions | import("./ps.ts").TPsNext | undefined, next?: import("./ps.ts").TPsNext | undefined) => Promise<void>;
-    tree: (opts: string | number | import("./ps.ts").TPsTreeOpts, cb?: import("./ps.ts").TPsLookupCallback) => Promise<import("./ps.ts").TPsLookupEntry[]>;
+    kill: (pid: string | number, opts?: import("./ps.js").TPsNext | import("./ps.js").TPsKillOptions | import("./ps.js").TPsKillOptions["signal"], next?: import("./ps.js").TPsNext) => Promise<void>;
+    lookup: {
+        (query?: import("./ps.js").TPsLookupQuery, cb?: import("./ps.js").TPsLookupCallback): Promise<import("./ps.js").TPsLookupEntry[]>;
+        sync: (query?: import("./ps.js").TPsLookupQuery, cb?: import("./ps.js").TPsLookupCallback) => import("./ps.js").TPsLookupEntry[];
+    };
+    lookupSync: (query?: import("./ps.js").TPsLookupQuery, cb?: import("./ps.js").TPsLookupCallback) => import("./ps.js").TPsLookupEntry[];
+    tree: {
+        (opts?: string | number | import("./ps.js").TPsTreeOpts | undefined, cb?: import("./ps.js").TPsLookupCallback): Promise<import("./ps.js").TPsLookupEntry[]>;
+        sync: (opts?: string | number | import("./ps.js").TPsTreeOpts | undefined, cb?: import("./ps.js").TPsLookupCallback) => import("./ps.js").TPsLookupEntry[];
+    };
+    treeSync: (opts?: string | number | import("./ps.js").TPsTreeOpts | undefined, cb?: import("./ps.js").TPsLookupCallback) => import("./ps.js").TPsLookupEntry[];
 };
 export default _default;

package/target/dts/ps.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
 import { TIngridResponse } from '@webpod/ingrid';
 export type TPsLookupCallback = (err: any, processList?: TPsLookupEntry[]) => void;
 export type TPsLookupEntry = {
@@ -26,12 +25,28 @@ export type TPsNext = (err?: any, data?: any) => void;
  * @param {String} query.command RegExp String
  * @param {String} query.arguments RegExp String
  * @param {String|String[]} query.psargs
- * @param {Function} cb
+ * @param {Function} [cb]
+ * @param {Object=null} cb.err
+ * @param {TPsLookupEntry[]} cb.processList
+ * @return {Promise<TPsLookupEntry[]>}
+ */
+export declare const lookup: {
+    (query?: TPsLookupQuery, cb?: TPsLookupCallback): Promise<TPsLookupEntry[]>;
+    sync: (query?: TPsLookupQuery, cb?: TPsLookupCallback) => TPsLookupEntry[];
+};
+/**
+ * Looks up the process list synchronously
+ * @param query
+ * @param {String|String[]} query.pid
+ * @param {String} query.command RegExp String
+ * @param {String} query.arguments RegExp String
+ * @param {String|String[]} query.psargs
+ * @param {Function} [cb]
  * @param {Object=null} cb.err
  * @param {Object[]} cb.processList
- * @return {Object}
+ * @return {TPsLookupEntry[]}
  */
-export declare const lookup: (query?: TPsLookupQuery, cb?: TPsLookupCallback) => Promise<TPsLookupEntry[]>;
+export declare const lookupSync: (query?: TPsLookupQuery, cb?: TPsLookupCallback) => TPsLookupEntry[];
 export declare const parseProcessList: (output: string, query?: TPsLookupQuery) => TPsLookupEntry[];
 export declare const extractWmic: (stdout: string) => string;
 export type TPsTreeOpts = {
@@ -39,7 +54,11 @@ export type TPsTreeOpts = {
     recursive?: boolean;
 };
 export declare const pickTree: (list: TPsLookupEntry[], pid: string | number, recursive?: boolean) => TPsLookupEntry[];
-export declare const tree: (opts: string | number | TPsTreeOpts, cb?: TPsLookupCallback) => Promise<TPsLookupEntry[]>;
+export declare const tree: {
+    (opts?: string | number | TPsTreeOpts | undefined, cb?: TPsLookupCallback): Promise<TPsLookupEntry[]>;
+    sync: (opts?: string | number | TPsTreeOpts | undefined, cb?: TPsLookupCallback) => TPsLookupEntry[];
+};
+export declare const treeSync: (opts?: string | number | TPsTreeOpts | undefined, cb?: TPsLookupCallback) => TPsLookupEntry[];
 /**
  * Kill process
  * @param pid
@@ -48,14 +67,7 @@ export declare const tree: (opts: string | number | TPsTreeOpts, cb?: TPsLookupC
  * @param {number} opts.timeout
  * @param next
  */
-export declare const kill: (pid: string | number, opts?: TPsNext | TPsKillOptions | TPsKillOptions['signal'], next?: TPsNext) => Promise<void>;
+export declare const kill: (pid: string | number, opts?: TPsNext | TPsKillOptions | TPsKillOptions["signal"], next?: TPsNext) => Promise<void>;
 export declare const parseGrid: (output: string) => TPsLookupEntry[];
 export declare const formatOutput: (data: TIngridResponse) => TPsLookupEntry[];
 export type PromiseResolve<T = any> = (value?: T | PromiseLike<T>) => void;
-export declare const makeDeferred: <T = any, E = any>() => {
-    promise: Promise<T>;
-    resolve: PromiseResolve<T>;
-    reject: PromiseResolve<E>;
-};
-export declare const noop: () => void;
-export declare const identity: <T>(v: T) => T;

package/target/esm/index.mjs

@@ -1,40 +1,47 @@
 // src/main/ts/ps.ts
 import process from "node:process";
 import fs from "node:fs";
+import { EOL as SystemEOL } from "node:os";
 import { parse } from "@webpod/ingrid";
 import { exec } from "zurk/spawn";
-import { EOL as SystemEOL } from "node:os";
 var EOL = /(\r\n)|(\n\r)|\n|\r/;
 var IS_WIN = process.platform === "win32";
 var isBin = (f) => {
-  if (f === "")
-    return false;
-  if (!f.includes("/"))
-    return true;
-  if (!fs.existsSync(f))
-    return false;
+  if (f === "") return false;
+  if (!f.includes("/")) return true;
+  if (!fs.existsSync(f)) return false;
   const stat = fs.lstatSync(f);
   return stat.isFile() || stat.isSymbolicLink();
 };
-var lookup = (query = {}, cb = noop) => {
-  const { promise, resolve, reject } = makeDeferred();
+var lookup = (query = {}, cb = noop) => _lookup({ query, cb, sync: false });
+var lookupSync = (query = {}, cb = noop) => _lookup({ query, cb, sync: true });
+lookup.sync = lookupSync;
+var _lookup = ({
+  query = {},
+  cb = noop,
+  sync = false
+}) => {
+  const pFactory = sync ? makePseudoDeferred.bind(null, []) : makeDeferred;
+  const { promise, resolve, reject } = pFactory();
   const { psargs = ["-lx"] } = query;
-  const args = typeof psargs === "string" ? psargs.split(/\s+/) : psargs;
+  const args = Array.isArray(psargs) ? psargs : psargs.split(/\s+/);
   const extract = IS_WIN ? extractWmic : identity;
+  let result = [];
   const callback = (err, { stdout }) => {
     if (err) {
       reject(err);
       cb(err);
       return;
     }
-    const list = parseProcessList(extract(stdout), query);
-    resolve(list);
-    cb(null, list);
+    result = parseProcessList(extract(stdout), query);
+    resolve(result);
+    cb(null, result);
   };
   const ctx = IS_WIN ? {
     cmd: "cmd",
     input: "wmic process get ProcessId,ParentProcessId,CommandLine \n",
     callback,
+    sync,
     run(cb2) {
       cb2();
     }
@@ -44,10 +51,11 @@ var lookup = (query = {}, cb = noop) => {
     run(cb2) {
       cb2();
     },
+    sync,
     callback
   };
   exec(ctx);
-  return promise;
+  return Object.assign(promise, result);
 };
 var parseProcessList = (output, query = {}) => {
   const processList = parseGrid(output.trim());
@@ -75,20 +83,36 @@ var pickTree = (list, pid, recursive = false) => {
     ...children.flatMap((p) => recursive ? pickTree(list, p.pid, true) : [])
   ];
 };
-var tree = async (opts, cb = noop) => {
+var _tree = ({
+  cb = noop,
+  opts,
+  sync = false
+}) => {
   if (typeof opts === "string" || typeof opts === "number") {
-    return tree({ pid: opts }, cb);
+    return _tree({ opts: { pid: opts }, cb, sync });
   }
-  try {
+  const onError = (err) => cb(err);
+  const onData = (all) => {
+    if (opts === void 0) return all;
     const { pid, recursive = false } = opts;
-    const list = pickTree(await lookup(), pid, recursive);
+    const list = pickTree(all, pid, recursive);
     cb(null, list);
     return list;
+  };
+  try {
+    const all = _lookup({ sync });
+    return sync ? onData(all) : all.then(onData, (err) => {
+      onError(err);
+      throw err;
+    });
   } catch (err) {
-    cb(err);
-    throw err;
+    onError(err);
+    return Promise.reject(err);
   }
 };
+var tree = async (opts, cb) => _tree({ opts, cb });
+var treeSync = (opts, cb) => _tree({ opts, cb, sync: true });
+tree.sync = treeSync;
 var kill = (pid, opts, next) => {
   if (typeof opts == "function") {
     return kill(pid, void 0, opts);
@@ -112,8 +136,7 @@ var kill = (pid, opts, next) => {
   let checkTimeoutTimer;
   let checkIsTimeout = false;
   const checkKilled = (finishCallback) => lookup({ pid }, (err, list = []) => {
-    if (checkIsTimeout)
-      return;
+    if (checkIsTimeout) return;
     if (err) {
       clearTimeout(checkTimeoutTimer);
       reject(err);
@@ -170,15 +193,26 @@ var makeDeferred = () => {
   });
   return { resolve, reject, promise };
 };
+var makePseudoDeferred = (r = {}) => {
+  return {
+    promise: r,
+    resolve: identity,
+    reject(e) {
+      throw e;
+    }
+  };
+};
 var noop = () => {
 };
 var identity = (v) => v;
 
 // src/main/ts/index.ts
-var ts_default = { lookup, kill, tree };
+var ts_default = { kill, lookup, lookupSync, tree, treeSync };
 export {
   ts_default as default,
   kill,
   lookup,
-  tree
+  lookupSync,
+  tree,
+  treeSync
 };

package/target/dts/foo.d.ts

@@ -1 +0,0 @@
-export declare const foo: () => undefined;