asljs-eventful 0.4.6 → 0.4.9

package/README.md

@@ -13,8 +13,48 @@ npm install asljs-eventful
 
 NPM Package: [asljs-eventful](https://www.npmjs.com/package/asljs-eventful)
 
+## Public Exports
+
+The package-root export surface includes:
+
+- `eventful`
+- `EventfulBase`
+- `isEventfulLike`
+- `asEventfulLike`
+- `ListenerError`
+- TypeScript types including `EventfulLike`, `EventName`, `EventMap`,
+  `Eventful`, `EventfulFactory`, `EventfulOptions`, `Listener`, and `TraceFn`
+
 ## Usage
 
+### Special Behavior
+
+`eventful` is not only an object enhancer. The package-level `eventful`
+function also acts as a global emitter for lifecycle and error events.
+
+If you change lifecycle, tracing, or listener-error behavior, then preserve
+that package-level emitter contract.
+
+### Stable Behavior
+
+These behaviors are part of the supported contract, not just current examples:
+
+- `eventful` adds `on`, `once`, `off`, `emit`, `emitAsync`, and `has`
+- `eventful` also acts as a package-level global emitter
+- strict mode propagates listener errors
+- non-strict mode isolates listener failures through the configured error path
+- `ListenerError` protects against recursive failures in global error handling
+
+### Preferred Patterns
+
+- If you are enhancing a plain object, then use `eventful(target)`.
+- If you are enhancing an existing class instance and cannot change
+  inheritance, then call `eventful(this)` in the constructor.
+- If you control a new class hierarchy and event support is part of the type
+  design, then extend `EventfulBase`.
+- If you are writing TypeScript and want typed listener signatures, then
+  declare an event map and use the exported `Eventful<...>` types.
+
 ### Basic (JavaScript)
 
 Adding events to an object, add listeners, and emit events:
@@ -320,4 +360,10 @@ console.log(obj.has('e')); // false
 
 MIT License. See [LICENSE](LICENSE.md) for details.
 
+## Related Packages
+
+- If you need property change tracking, see `asljs-observable`.
+- If you need DOM binding built on observable state, see
+  `asljs-data-binding`.
+
 [#1]: https://github.com/AlexandriteSoftware/asljs

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { eventful } from './eventful.js';
+export { type EventfulLike, isEventfulLike, asEventfulLike, } from './eventful-like.js';
+export { EventfulBase } from './eventful-base.js';
+export { type EventName, type EventMap, type Eventful, type EventfulFactory, type EventfulOptions, type Listener, ListenerError, type TraceFn } from './types.js';

package/dist/index.js

@@ -0,0 +1,4 @@
+export { eventful } from './eventful.js';
+export { isEventfulLike, asEventfulLike, } from './eventful-like.js';
+export { EventfulBase } from './eventful-base.js';
+export { ListenerError } from './types.js';

package/package.json

@@ -1,11 +1,9 @@
 {
   "name": "asljs-eventful",
-  "version": "0.4.6",
+  "version": "0.4.9",
   "description": "Lightweight event helper adding on/off/emit to any object.",
   "files": [
     "dist/**",
-    "eventful.js",
-    "eventful.d.ts",
     "README.md",
     "LICENSE.md"
   ],
@@ -25,12 +23,12 @@
   "license": "MIT",
   "author": "\"Alex Netkachov\" <alex.netkachov@gmail.com>",
   "type": "module",
-  "main": "eventful.js",
-  "types": "eventful.d.ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "exports": {
     ".": {
-      "types": "./eventful.d.ts",
-      "default": "./eventful.js"
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
     }
   },
   "directories": {
@@ -40,14 +38,16 @@
     "clean": "node ../toolkit.js clean-dist",
     "build": "npx tsc -p tsconfig.build.json",
     "build:test": "npx tsc -p tsconfig.test.json",
+    "typecheck": "npx tsc -p tsconfig.build.json --noEmit",
     "lint": "npx eslint .",
     "lint:fix": "npx eslint . --fix",
     "guard:clean-git": "node ../toolkit.js ensure-clean-working-folder",
     "prepack": "npm run clean && npm run build",
-    "prepublishOnly": "npm run guard:clean-git && npm run prepack",
+    "prepublishOnly": "npm run prepack",
     "postpublish": "node ../toolkit.js tag-commit-with-release-id",
     "test": "npm run build:test && node --test dist/*.test.js",
     "test:watch": "npm run build:test && node --watch --test dist/*.test.js",
-    "coverage": "npm run build:test && NODE_V8_COVERAGE=.coverage node --test dist/*.test.js && node -e \"console.log('Coverage in .coverage (use c8/istanbul if you want reports)')\""
+    "coverage": "npm run build:test && NODE_V8_COVERAGE=.coverage node --test dist/*.test.js && node -e \"console.log('Coverage in .coverage (use c8/istanbul if you want reports)')\"",
+    "release:patch": "node ../toolkit.js release-patch"
   }
 }

package/eventful.d.ts

@@ -1,24 +0,0 @@
-export {
-  eventful,
-  isEventfulLike,
-  asEventfulLike
-} from './dist/eventful.js';
-
-export {
-  EventfulBase
-} from './dist/eventful-base.js';
-
-export type {
-  EventfulLike
-} from './dist/eventful-like.js';
-
-export {
-  type EventName,
-  type EventMap,
-  type Eventful,
-  type EventfulFactory,
-  type EventfulOptions,
-  type Listener,
-  ListenerError,
-  type TraceFn
-} from './dist/types.js';

package/eventful.js

@@ -1,13 +0,0 @@
-export {
-    eventful,
-    isEventfulLike,
-    asEventfulLike,
-  } from './dist/eventful.js';
-
-export {
-    EventfulBase,
-  } from './dist/eventful-base.js';
-
-export {
-    ListenerError
-  } from './dist/types.js';