fsevents 2.0.6 → 2.1.2

package/LICENSE

@@ -1,7 +1,7 @@
 MIT License
 -----------
 
-Copyright (C) 2010-2019 by Philipp Dunkel, Ben Noordhuis, Elan Shankar
+Copyright (C) 2010-2019 by Philipp Dunkel, Ben Noordhuis, Elan Shankar, Paul Miller
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -11,6 +11,8 @@ uses fsevents, check out [Chokidar](https://github.com/paulmillr/chokidar).
 
 ## Installation
 
+Supports only **Node.js v8.16 and higher**.
+
 ```sh
 npm install fsevents
 ```
@@ -28,13 +30,15 @@ stop(); // To end observation
 The callback passed as the second parameter to `.watch` get's called whenever the operating system detects a
 a change in the file system. It takes three arguments:
 
-`(path: String, flags: Number, id: String) => {}`
+###### `fsevents.watch(dirname: string, (path: string, flags: number, id: string) => void): () => Promise<undefined>`
+
+ * `path: string` - the item in the filesystem that have been changed
+ * `flags: number` - a numeric value describing what the change was
+ * `id: string` - an unique-id identifying this specific event
 
- * `path` - the item in the filesystem that have been changed
- * `flags` - a numeric value describing what the change was
- * `id` - an unique-id identifying this specific event
+ Returns closer callback which when called returns a Promise resolving when the watcher process has been shut down.
 
-###### `fsevents.getInfo(path, flags, id): FsEventInfo => {}`
+###### `fsevents.getInfo(path: string, flags: number, id: string): FsEventInfo`
 
 The `getInfo` function takes the `path`, `flags` and `id` arguments and converts those parameters into a structure
 that is easier to digest to determine what the change was.
@@ -43,7 +47,7 @@ The `FsEventsInfo` has the following shape:
 
 ```js
 /**
- * @typedef {'created'|'modified'|'deleted'|'moved'|'root-changed'|'unknown'} FsEventsEvent
+ * @typedef {'created'|'modified'|'deleted'|'moved'|'root-changed'|'cloned'|'unknown'} FsEventsEvent
  * @typedef {'file'|'directory'|'symlink'} FsEventsType
  */
 {
@@ -60,8 +64,14 @@ The `FsEventsInfo` has the following shape:
 }
 ```
 
+## Engine compatibility
+
+- v2 supports node 8.16+
+- v1.2.8 supports node 6+
+- v1.2.7 supports node 4+
+
 ## License
 
-The MIT License Copyright (C) 2010-2018 by Philipp Dunkel, Ben Noordhuis, Elan Shankar — see LICENSE file.
+The MIT License Copyright (C) 2010-2019 by Philipp Dunkel, Ben Noordhuis, Elan Shankar, Paul Miller — see LICENSE file.
 
 Visit our [GitHub page](https://github.com/fsevents/fsevents) and [NPM Page](https://npmjs.org/package/fsevents)

package/fsevents.d.ts

@@ -0,0 +1,55 @@
+declare type Event =
+    | 'created'
+    | 'cloned'
+    | 'modified'
+    | 'deleted'
+    | 'moved'
+    | 'root-changed'
+    | 'unknown';
+declare type Type = 'file' | 'directory' | 'symlink';
+declare type FileChanges = {
+    inode: boolean;
+    finder: boolean;
+    access: boolean;
+    xattrs: boolean;
+};
+declare type Info = {
+    event: Event;
+    path: string;
+    type: Type;
+    changes: FileChanges;
+    flags: number;
+};
+declare type WatchHandler = (path: string, flags: number, id: string) => void;
+export declare function watch(
+    path: string,
+    handler: WatchHandler,
+): () => Promise<void>;
+export declare function getInfo(path: string, flags: number): Info;
+export declare const constants: {
+    None: 0x00000000;
+    MustScanSubDirs: 0x00000001;
+    UserDropped: 0x00000002;
+    KernelDropped: 0x00000004;
+    EventIdsWrapped: 0x00000008;
+    HistoryDone: 0x00000010;
+    RootChanged: 0x00000020;
+    Mount: 0x00000040;
+    Unmount: 0x00000080;
+    ItemCreated: 0x00000100;
+    ItemRemoved: 0x00000200;
+    ItemInodeMetaMod: 0x00000400;
+    ItemRenamed: 0x00000800;
+    ItemModified: 0x00001000;
+    ItemFinderInfoMod: 0x00002000;
+    ItemChangeOwner: 0x00004000;
+    ItemXattrMod: 0x00008000;
+    ItemIsFile: 0x00010000;
+    ItemIsDir: 0x00020000;
+    ItemIsSymlink: 0x00040000;
+    ItemIsHardlink: 0x00100000;
+    ItemIsLastHardlink: 0x00200000;
+    OwnEvent: 0x00080000;
+    ItemCloned: 0x00400000;
+};
+export {}

package/fsevents.js

@@ -1,7 +1,7 @@
 /*
-** © 2018 by Philipp Dunkel, Ben Noordhuis, Elan Shankar
-** Licensed under MIT License.
-*/
+ ** © 2018 by Philipp Dunkel, Ben Noordhuis, Elan Shankar, Paul Miller
+ ** Licensed under MIT License.
+ */
 
 /* jshint node:true */
 'use strict';
@@ -11,23 +11,31 @@ if (process.platform !== 'darwin') {
 }
 
 const Native = require('./fsevents.node');
-const con = Native.constants;
+const events = Native.constants;
 
 function watch(path, handler) {
-  if ('string' !== typeof path) throw new TypeError(`argument 1 must be a string and not a ${typeof path}`);
-  if ('function' !== typeof handler) throw new TypeError(`argument 2 must be a function and not a ${typeof handler}`);
+  if (typeof path !== 'string') {
+    throw new TypeError(`fsevents argument 1 must be a string and not a ${typeof path}`);
+  }
+  if (typeof handler !== 'function') {
+    throw new TypeError(`fsevents argument 2 must be a function and not a ${typeof handler}`);
+  }
 
   let instance = Native.start(path, handler);
   if (!instance) throw new Error(`could not watch: ${path}`);
   return () => {
-    const result = instance ? Promise.resolve(instance).then(Native.stop) : null;
-    instance = null;
+    const result = instance
+      ? Promise.resolve(instance).then(Native.stop)
+      : Promise.resolve(undefined);
+    instance = undefined;
     return result;
   };
 }
+
 function getInfo(path, flags) {
   return {
-    path, flags,
+    path,
+    flags,
     event: getEventType(flags),
     type: getFileType(flags),
     changes: getFileChanges(flags)
@@ -35,28 +43,35 @@ function getInfo(path, flags) {
 }
 
 function getFileType(flags) {
-  if (con.kFSEventStreamEventFlagItemIsFile & flags) return 'file';
-  if (con.kFSEventStreamEventFlagItemIsDir & flags) return 'directory';
-  if (con.kFSEventStreamEventFlagItemIsSymlink & flags) return 'symlink';
+  if (events.ItemIsFile & flags) return 'file';
+  if (events.ItemIsDir & flags) return 'directory';
+  if (events.ItemIsSymlink & flags) return 'symlink';
+}
+function anyIsTrue(obj) {
+  for (let key in obj) {
+    if (obj[key]) return true;
+  }
+  return false;
 }
 function getEventType(flags) {
-  if (con.kFSEventStreamEventFlagItemRemoved & flags) return 'deleted';
-  if (con.kFSEventStreamEventFlagItemRenamed & flags) return 'moved';
-  if (con.kFSEventStreamEventFlagItemCreated & flags) return 'created';
-  if (con.kFSEventStreamEventFlagItemModified & flags) return 'modified';
-  if (con.kFSEventStreamEventFlagRootChanged & flags) return 'root-changed';
-
+  if (events.ItemRemoved & flags) return 'deleted';
+  if (events.ItemRenamed & flags) return 'moved';
+  if (events.ItemCreated & flags) return 'created';
+  if (events.ItemModified & flags) return 'modified';
+  if (events.RootChanged & flags) return 'root-changed';
+  if (events.ItemCloned & flags) return 'cloned';
+  if (anyIsTrue(flags)) return 'modified';
   return 'unknown';
 }
 function getFileChanges(flags) {
   return {
-    inode: !!(con.kFSEventStreamEventFlagItemInodeMetaMod & flags),
-    finder: !!(con.kFSEventStreamEventFlagItemFinderInfoMod & flags),
-    access: !!(con.kFSEventStreamEventFlagItemChangeOwner & flags),
-    xattrs: !!(con.kFSEventStreamEventFlagItemXattrMod & flags)
+    inode: !!(events.ItemInodeMetaMod & flags),
+    finder: !!(events.ItemFinderInfoMod & flags),
+    access: !!(events.ItemChangeOwner & flags),
+    xattrs: !!(events.ItemXattrMod & flags)
   };
 }
 
 exports.watch = watch;
 exports.getInfo = getInfo;
-exports.constants = con;
+exports.constants = events;

package/package.json

@@ -1,18 +1,25 @@
 {
   "name": "fsevents",
-  "version": "2.0.6",
-  "description": "Native Access to Mac OS-X FSEvents",
+  "version": "2.1.2",
+  "description": "Native Access to MacOS FSEvents",
   "main": "fsevents.js",
+  "types": "fsevents.d.ts",
   "os": [
     "darwin"
   ],
+  "files": [
+    "fsevents.d.ts",
+    "fsevents.js",
+    "fsevents.node"
+  ],
   "engines": {
     "node": "^8.16.0 || ^10.6.0 || >=11.0.0"
   },
   "scripts": {
     "clean": "node-gyp clean && rm -f fsevents.node",
+    "build": "node-gyp clean && rm -f fsevents.node && node-gyp rebuild && node-gyp clean",
     "test": "/bin/bash ./test.sh 2>/dev/null",
-    "prepublishOnly": "node-gyp clean && rm -f fsevents.node && node-gyp rebuild && node-gyp clean"
+    "prepublishOnly": "npm run build"
   },
   "repository": {
     "type": "git",
@@ -38,12 +45,15 @@
     {
       "name": "Miroslav Bajtoš",
       "email": "mbajtoss@gmail.com"
+    },
+    {
+      "name": "Paul Miller",
+      "url": "https://paulmillr.com"
     }
   ],
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/fsevents/fsevents/issues"
   },
-  "homepage": "https://github.com/fsevents/fsevents",
-  "devDependencies": {}
+  "homepage": "https://github.com/fsevents/fsevents"
 }