@xylabs/events 4.13.15 → 4.13.17

package/README.md

@@ -1,63 +1,54 @@
-[![logo][]](https://xylabs.com)
-
 # @xylabs/events
 
+[![logo][]](https://xylabs.com)
+
+[![main-build][]][main-build-link]
 [![npm-badge][]][npm-link]
 [![npm-downloads-badge][]][npm-link]
 [![jsdelivr-badge][]][jsdelivr-link]
 [![npm-license-badge][]](LICENSE)
+[![codacy-badge][]][codacy-link]
+[![codeclimate-badge][]][codeclimate-link]
+[![snyk-badge][]][snyk-link]
 [![socket-badge][]][socket-link]
 
-> XY Labs generalized Javascript library 
-
-## Table of Contents
-
--   [Description](#description)
--   [Install](#install)
--   [Maintainers](#maintainers)
--   [License](#license)
--   [Credits](#credits)
-
-## Description
+Version: 4.13.15
 
-Common Javascript code that is used throughout XYO projects that use React.
+Primary SDK for using XYO Protocol 2.0
 
-## Install
-
-Using npm:
-
-```sh
-npm i --save @xylabs/events
-```
+## Documentation
 
-Using yarn:
+Coming Soon!
 
-```sh
-yarn add @xylabs/events
-```
-
-## Documentation
-[Developer Reference](https://xylabs.github.io/sdk-js)
+Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 
 ## Maintainers
 
 -   [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
--   [Joel Carter](https://github.com/JoelBCarter)
 -   [Matt Jones](https://github.com/jonesmac)
+-   [Joel Carter](https://github.com/JoelBCarter)
 -   [Jordan Trouw](https://github.com/jordantrouw)
 
 ## License
 
-See the [LICENSE](LICENSE) file for license details
+> See the [LICENSE](LICENSE) file for license details
 
 ## Credits
 
-[Made with 🔥and ❄️ by XY Labs](https://xylabs.com)
+[Made with 🔥 and ❄️ by XYLabs](https://xylabs.com)
 
 [logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
 
+[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
+[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
 [npm-badge]: https://img.shields.io/npm/v/@xylabs/events.svg
 [npm-link]: https://www.npmjs.com/package/@xylabs/events
+[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
+[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
+[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
+[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
+[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
+[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json
 
 [npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/events
 [npm-license-badge]: https://img.shields.io/npm/l/@xylabs/events

package/dist/neutral/Events/spec/Events.spec.d.ts

@@ -0,0 +1,2 @@
+import '@xylabs/vitest-extended';
+//# sourceMappingURL=Events.spec.d.ts.map

package/dist/neutral/Events/spec/Events.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Events.spec.d.ts","sourceRoot":"","sources":["../../../../src/Events/spec/Events.spec.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAA"}

package/dist/neutral/Events/spec/GenericEvents.spec.d.ts

@@ -0,0 +1,2 @@
+import '@xylabs/vitest-extended';
+//# sourceMappingURL=GenericEvents.spec.d.ts.map

package/dist/neutral/Events/spec/GenericEvents.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GenericEvents.spec.d.ts","sourceRoot":"","sources":["../../../../src/Events/spec/GenericEvents.spec.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAA"}

package/dist/neutral/index.d.ts

@@ -1,108 +1,4 @@
-import { BaseParams, Base } from '@xylabs/base';
-import { EmptyObject } from '@xylabs/object';
-import { Promisable } from '@xylabs/promise';
-
-type EventName = PropertyKey;
-type EventArgs = string | number | object;
-type EventData = {
-    [key: EventName]: EventArgs;
-};
-type EventUnsubscribeFunction = () => void;
-type EventAnyListener<TEventArgs extends EventArgs = EventArgs> = (eventName: EventName, eventData: TEventArgs) => Promisable<void>;
-type EventListener<TEventArgs extends EventArgs = EventArgs> = (eventData: TEventArgs) => Promisable<void>;
-
-interface EventEmitter<T extends EventData> {
-    eventData: T;
-    clearListeners(eventNames: keyof T | (keyof T)[]): void;
-    emit<TEventName extends keyof T>(eventName: TEventName, eventArgs: T[TEventName]): Promise<void>;
-    emitSerial<TEventName extends keyof T>(eventName: TEventName, eventArgs: T[TEventName]): Promise<void>;
-    listenerCount(eventNames: keyof T | (keyof T)[]): number;
-    off<TEventName extends keyof T>(eventNames: TEventName | TEventName[], listener: EventListener<T[TEventName]>): void;
-    offAny(listener: EventAnyListener | Promise<void>): void;
-    on<TEventName extends keyof T>(eventNames: TEventName | TEventName[], listener: EventListener<T[TEventName]>): EventUnsubscribeFunction;
-    onAny(listener: EventAnyListener): EventUnsubscribeFunction;
-    once<TEventName extends keyof T>(eventName: TEventName, listener: EventListener<T[TEventName]>): EventUnsubscribeFunction;
-}
-
-interface BaseEmitterParamsFields {
-}
-type BaseEmitterParams<T extends EmptyObject = EmptyObject> = BaseParams<T & BaseEmitterParamsFields & T>;
-declare class BaseEmitter<TParams extends BaseParams = BaseParams, TEventData extends EventData = EventData> extends Base<TParams> implements EventEmitter<TEventData> {
-    eventData: TEventData;
-    private events;
-    constructor(params: BaseParams<TParams>);
-    clearListeners(eventNames: keyof TEventData | (keyof TEventData)[]): this;
-    emit<TEventName extends keyof TEventData = keyof TEventData, TEventArgs extends TEventData[TEventName] = TEventData[TEventName]>(eventName: TEventName, eventArgs: TEventArgs): Promise<void>;
-    emitSerial<TEventName extends keyof TEventData = keyof TEventData, TEventArgs extends TEventData[TEventName] = TEventData[TEventName]>(eventName: TEventName, eventArgs: TEventArgs): Promise<void>;
-    listenerCount(eventNames: keyof TEventData | (keyof TEventData)[]): number;
-    off<TEventName extends keyof TEventData>(eventNames: TEventName | TEventName[], listener: EventListener<TEventData[TEventName]>): void;
-    offAny(listener: EventAnyListener): void;
-    on<TEventName extends keyof TEventData>(eventNames: TEventName | TEventName[], listener: EventListener<TEventData[TEventName]>): () => void;
-    onAny(listener: EventAnyListener): () => void;
-    once<TEventName extends keyof TEventData>(eventName: TEventName, listener: EventListener<TEventData[TEventName]>): () => void;
-}
-
-/**
-Emittery can collect and log debug information.
-
-To enable this feature set the `DEBUG` environment variable to `emittery` or `*`. Additionally, you can set the static `isDebugEnabled` variable to true
-on the Emittery class, or `myEmitter.debug.enabled` on an instance of it for debugging a single instance.
-
-See API for more information on how debugging works.
-*/
-type DebugLogger = (type: string, debugName: string, eventName?: EventName, eventData?: EventArgs) => void;
-type EventListenerInfo<TEventArgs extends EventArgs = EventArgs> = {
-    filter?: TEventArgs;
-    listener: EventListener<TEventArgs>;
-};
-/**
-Configure debug options of an instance.
-*/
-type DebugOptions = {
-    enabled?: boolean;
-    logger?: DebugLogger;
-    readonly name: string;
-};
-type MetaEventData<TEventData extends EventData> = {
-    listenerAdded: {
-        eventName?: keyof TEventData;
-        listener: EventListener<TEventData[keyof TEventData]> | EventAnyListener<TEventData[keyof TEventData]>;
-    };
-    listenerRemoved: {
-        eventName?: keyof TEventData;
-        listener: EventListener<TEventData[keyof TEventData]> | EventAnyListener<TEventData[keyof TEventData]>;
-    };
-};
-type EventsParams = BaseParams<{
-    readonly debug?: DebugOptions;
-}>;
-declare class Events<TEventData extends EventData = EventData> extends Base<EventsParams> implements EventEmitter<TEventData> {
-    protected static anyMap: WeakMap<object, Set<EventAnyListener>>;
-    protected static eventsMap: WeakMap<object, Map<PropertyKey, Set<EventListenerInfo<EventArgs>>>>;
-    private static canEmitMetaEvents;
-    private static isGlobalDebugEnabled;
-    eventData: TEventData;
-    constructor(params?: EventsParams);
-    static get isDebugEnabled(): boolean;
-    static set isDebugEnabled(newValue: boolean);
-    get debug(): DebugOptions | undefined;
-    clearListeners(eventNames: keyof TEventData | (keyof TEventData)[]): void;
-    emit<TEventName extends keyof TEventData>(eventName: TEventName, eventArgs: TEventData[TEventName]): Promise<void>;
-    emitMetaEvent<TEventName extends keyof MetaEventData<TEventData>>(eventName: TEventName, eventArgs: MetaEventData<TEventData>[TEventName]): Promise<boolean | undefined>;
-    emitSerial<TEventName extends keyof TEventData>(eventName: TEventName, eventArgs: TEventData[TEventName]): Promise<void>;
-    listenerCount(eventNames?: keyof TEventData | (keyof TEventData)[]): number;
-    logIfDebugEnabled<TEventName extends EventName>(type: string, eventName?: TEventName, eventArgs?: EventArgs): void;
-    off<TEventName extends keyof TEventData, TEventListener = EventListener<TEventData[TEventName]>>(eventNames: TEventName | TEventName[], listener: TEventListener): void;
-    offAny(listener: EventAnyListener): void;
-    on<TEventName extends keyof TEventData = keyof TEventData>(eventNames: TEventName | TEventName[], listener: EventListener<TEventData[TEventName]>, filter?: TEventData[TEventName]): () => void;
-    onAny(listener: EventAnyListener): () => void;
-    once<TEventName extends keyof TEventData>(eventName: TEventName, listener: EventListener<TEventData[TEventName]>): () => void;
-    private emitInternal;
-    private emitMetaEventInternal;
-    private getListeners;
-    private safeCallAnyListener;
-    private safeCallListener;
-}
-
-export { BaseEmitter, Events };
-export type { BaseEmitterParams, BaseEmitterParamsFields, DebugLogger, DebugOptions, EventAnyListener, EventArgs, EventData, EventEmitter, EventListener, EventListenerInfo, EventName, EventUnsubscribeFunction, EventsParams, MetaEventData };
+export * from './BaseEmitter.ts';
+export * from './Events/index.ts';
+export * from './model/index.ts';
+//# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/events",
-  "version": "4.13.15",
+  "version": "4.13.17",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -30,19 +30,19 @@
   "source": "./src/index.ts",
   "types": "dist/neutral/index.d.ts",
   "dependencies": {
-    "@xylabs/assert": "^4.13.15",
-    "@xylabs/base": "^4.13.15",
-    "@xylabs/error": "^4.13.15",
-    "@xylabs/forget": "^4.13.15",
-    "@xylabs/object": "^4.13.15",
-    "@xylabs/promise": "^4.13.15",
-    "@xylabs/typeof": "^4.13.15"
+    "@xylabs/assert": "^4.13.17",
+    "@xylabs/base": "^4.13.17",
+    "@xylabs/error": "^4.13.17",
+    "@xylabs/forget": "^4.13.17",
+    "@xylabs/object": "^4.13.17",
+    "@xylabs/promise": "^4.13.17",
+    "@xylabs/typeof": "^4.13.17"
   },
   "devDependencies": {
-    "@xylabs/delay": "^4.13.15",
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.20",
-    "@xylabs/tsconfig": "^7.0.0-rc.20",
-    "@xylabs/vitest-extended": "^4.13.15",
+    "@xylabs/delay": "^4.13.17",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.27",
+    "@xylabs/tsconfig": "^7.0.0-rc.27",
+    "@xylabs/vitest-extended": "^4.13.17",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },

package/build/neutral/index.d.ts

@@ -1,4 +0,0 @@
-export * from './BaseEmitter.ts';
-export * from './Events/index.ts';
-export * from './model/index.ts';
-//# sourceMappingURL=index.d.ts.map