@xyo-network/module-model 2.50.5 → 2.51.0

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 (8) hide show
  1. package/dist/docs.json +886 -669
  2. package/dist/types/Events/ModuleEventEmitter.d.ts +2 -1
  3. package/dist/types/Events/ModuleEventEmitter.d.ts.map +1 -1
  4. package/dist/types/model/Module.d.ts +3 -3
  5. package/dist/types/model/Module.d.ts.map +1 -1
  6. package/package.json +7 -7
  7. package/src/Events/ModuleEventEmitter.ts +6 -1
  8. package/src/model/Module.ts +3 -3
package/dist/types/Events/ModuleEventEmitter.d.ts CHANGED
@@ -1,6 +1,7 @@
1
1
  import { EventArgs } from './EventArgs';
2
2
  import { EventListener } from './EventListener';
3
+ export type EventEmitterFunc<TResult, TEvent extends string = never, TEventArgs extends EventArgs = EventArgs> = (event: TEvent, handler: EventListener<TEventArgs>) => TResult;
3
4
  export interface ModuleEventEmitter<TEvent extends string = never, TEventArgs extends EventArgs = EventArgs> {
4
- on(event: TEvent, handler: EventListener<TEventArgs>): this;
5
+ on: EventEmitterFunc<this, TEvent, TEventArgs>;
5
6
  }
6
7
  //# sourceMappingURL=ModuleEventEmitter.d.ts.map
package/dist/types/Events/ModuleEventEmitter.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ModuleEventEmitter.d.ts","sourceRoot":"","sources":["../../../src/Events/ModuleEventEmitter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/C,MAAM,WAAW,kBAAkB,CAAC,MAAM,SAAS,MAAM,GAAG,KAAK,EAAE,UAAU,SAAS,SAAS,GAAG,SAAS;IACzG,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,GAAG,IAAI,CAAA;CAC5D"}
1
+ {"version":3,"file":"ModuleEventEmitter.d.ts","sourceRoot":"","sources":["../../../src/Events/ModuleEventEmitter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/C,MAAM,MAAM,gBAAgB,CAAC,OAAO,EAAE,MAAM,SAAS,MAAM,GAAG,KAAK,EAAE,UAAU,SAAS,SAAS,GAAG,SAAS,IAAI,CAC/G,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,KAC/B,OAAO,CAAA;AAEZ,MAAM,WAAW,kBAAkB,CAAC,MAAM,SAAS,MAAM,GAAG,KAAK,EAAE,UAAU,SAAS,SAAS,GAAG,SAAS;IACzG,EAAE,EAAE,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,CAAA;CAC/C"}
package/dist/types/model/Module.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import { XyoPayload } from '@xyo-network/payload-model';
2
2
  import { Promisable } from '@xyo-network/promise';
3
3
  import { ModuleConfig } from '../Config';
4
- import { ModuleQueriedEventEmitter } from '../Events';
4
+ import { ModuleEventEmitter, ModuleQueriedEventEmitter } from '../Events';
5
5
  import { ModuleFilter } from '../ModuleFilter';
6
6
  import { ModuleQueryResult } from '../ModuleQueryResult';
7
7
  import { XyoQueryBoundWitness } from '../Query';
@@ -11,11 +11,11 @@ export interface ModuleResolver {
11
11
  removeResolver: (resolver: ModuleResolver) => this;
12
12
  resolve<T extends Module = Module>(filter?: ModuleFilter): Promisable<T[]>;
13
13
  }
14
- export type Module<TConfig extends ModuleConfig = ModuleConfig> = {
14
+ export type Module<TConfig extends ModuleConfig = ModuleConfig, TModuleEventEmitter extends ModuleEventEmitter | undefined = undefined> = {
15
15
  address: string;
16
16
  config: TConfig;
17
17
  readonly downResolver: ModuleResolver;
18
- on: ModuleQueriedEventEmitter['on'];
18
+ on: TModuleEventEmitter extends ModuleEventEmitter ? ModuleQueriedEventEmitter['on'] | TModuleEventEmitter['on'] : ModuleQueriedEventEmitter['on'];
19
19
  queries: string[];
20
20
  query: <T extends XyoQueryBoundWitness = XyoQueryBoundWitness, TConf extends ModuleConfig = ModuleConfig>(query: T, payloads?: XyoPayload[], queryConfig?: TConf) => Promisable<ModuleQueryResult>;
21
21
  queryable: <T extends XyoQueryBoundWitness = XyoQueryBoundWitness, TConf extends ModuleConfig = ModuleConfig>(query: T, payloads?: XyoPayload[], queryConfig?: TConf) => Promisable<boolean>;
package/dist/types/model/Module.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Module.d.ts","sourceRoot":"","sources":["../../../src/model/Module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAEjD,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AACxC,OAAO,EAAE,yBAAyB,EAAE,MAAM,WAAW,CAAA;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AAE/C,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAA;IAC/C,gBAAgB,EAAE,OAAO,CAAA;IACzB,cAAc,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAA;IAClD,OAAO,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,GAAG,UAAU,CAAC,CAAC,EAAE,CAAC,CAAA;CAC3E;AAED,MAAM,MAAM,MAAM,CAAC,OAAO,SAAS,YAAY,GAAG,YAAY,IAAI;IAChE,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,OAAO,CAAA;IAGf,QAAQ,CAAC,YAAY,EAAE,cAAc,CAAA;IAErC,EAAE,EAAE,yBAAyB,CAAC,IAAI,CAAC,CAAA;IAEnC,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,KAAK,EAAE,CAAC,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,EAAE,KAAK,SAAS,YAAY,GAAG,YAAY,EACtG,KAAK,EAAE,CAAC,EACR,QAAQ,CAAC,EAAE,UAAU,EAAE,EACvB,WAAW,CAAC,EAAE,KAAK,KAChB,UAAU,CAAC,iBAAiB,CAAC,CAAA;IAClC,SAAS,EAAE,CAAC,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,EAAE,KAAK,SAAS,YAAY,GAAG,YAAY,EAC1G,KAAK,EAAE,CAAC,EACR,QAAQ,CAAC,EAAE,UAAU,EAAE,EACvB,WAAW,CAAC,EAAE,KAAK,KAChB,UAAU,CAAC,OAAO,CAAC,CAAA;IAIxB,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAA;CACpC,CAAA"}
1
+ {"version":3,"file":"Module.d.ts","sourceRoot":"","sources":["../../../src/model/Module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAEjD,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AACxC,OAAO,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,MAAM,WAAW,CAAA;AACzE,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AAE/C,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAA;IAC/C,gBAAgB,EAAE,OAAO,CAAA;IACzB,cAAc,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAA;IAClD,OAAO,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,GAAG,UAAU,CAAC,CAAC,EAAE,CAAC,CAAA;CAC3E;AAED,MAAM,MAAM,MAAM,CAAC,OAAO,SAAS,YAAY,GAAG,YAAY,EAAE,mBAAmB,SAAS,kBAAkB,GAAG,SAAS,GAAG,SAAS,IAAI;IACxI,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,OAAO,CAAA;IAGf,QAAQ,CAAC,YAAY,EAAE,cAAc,CAAA;IAErC,EAAE,EAAE,mBAAmB,SAAS,kBAAkB,GAAG,yBAAyB,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC,IAAI,CAAC,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAA;IAElJ,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,KAAK,EAAE,CAAC,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,EAAE,KAAK,SAAS,YAAY,GAAG,YAAY,EACtG,KAAK,EAAE,CAAC,EACR,QAAQ,CAAC,EAAE,UAAU,EAAE,EACvB,WAAW,CAAC,EAAE,KAAK,KAChB,UAAU,CAAC,iBAAiB,CAAC,CAAA;IAClC,SAAS,EAAE,CAAC,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,EAAE,KAAK,SAAS,YAAY,GAAG,YAAY,EAC1G,KAAK,EAAE,CAAC,EACR,QAAQ,CAAC,EAAE,UAAU,EAAE,EACvB,WAAW,CAAC,EAAE,KAAK,KAChB,UAAU,CAAC,OAAO,CAAC,CAAA;IAIxB,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAA;CACpC,CAAA"}
package/package.json CHANGED
@@ -10,14 +10,14 @@
10
10
  "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
11
11
  },
12
12
  "dependencies": {
13
- "@xyo-network/boundwitness-model": "^2.50.5",
14
- "@xyo-network/core": "^2.50.5",
15
- "@xyo-network/payload-model": "^2.50.5",
16
- "@xyo-network/promise": "^2.50.5"
13
+ "@xyo-network/boundwitness-model": "^2.51.0",
14
+ "@xyo-network/core": "^2.51.0",
15
+ "@xyo-network/payload-model": "^2.51.0",
16
+ "@xyo-network/promise": "^2.51.0"
17
17
  },
18
18
  "devDependencies": {
19
- "@xylabs/ts-scripts-yarn3": "^2.16.0-rc.2",
20
- "@xylabs/tsconfig": "^2.16.0-rc.2",
19
+ "@xylabs/ts-scripts-yarn3": "^2.16.0",
20
+ "@xylabs/tsconfig": "^2.16.0",
21
21
  "typescript": "^4.9.5"
22
22
  },
23
23
  "description": "Primary SDK for using XYO Protocol 2.0",
@@ -53,5 +53,5 @@
53
53
  },
54
54
  "sideEffects": false,
55
55
  "types": "dist/types/index.d.ts",
56
- "version": "2.50.5"
56
+ "version": "2.51.0"
57
57
  }
package/src/Events/ModuleEventEmitter.ts CHANGED
@@ -1,6 +1,11 @@
1
1
  import { EventArgs } from './EventArgs'
2
2
  import { EventListener } from './EventListener'
3
3
 
4
+ export type EventEmitterFunc<TResult, TEvent extends string = never, TEventArgs extends EventArgs = EventArgs> = (
5
+ event: TEvent,
6
+ handler: EventListener<TEventArgs>,
7
+ ) => TResult
8
+
4
9
  export interface ModuleEventEmitter<TEvent extends string = never, TEventArgs extends EventArgs = EventArgs> {
5
- on(event: TEvent, handler: EventListener<TEventArgs>): this
10
+ on: EventEmitterFunc<this, TEvent, TEventArgs>
6
11
  }
package/src/model/Module.ts CHANGED
@@ -2,7 +2,7 @@ import { XyoPayload } from '@xyo-network/payload-model'
2
2
  import { Promisable } from '@xyo-network/promise'
3
3
 
4
4
  import { ModuleConfig } from '../Config'
5
- import { ModuleQueriedEventEmitter } from '../Events'
5
+ import { ModuleEventEmitter, ModuleQueriedEventEmitter } from '../Events'
6
6
  import { ModuleFilter } from '../ModuleFilter'
7
7
  import { ModuleQueryResult } from '../ModuleQueryResult'
8
8
  import { XyoQueryBoundWitness } from '../Query'
@@ -14,14 +14,14 @@ export interface ModuleResolver {
14
14
  resolve<T extends Module = Module>(filter?: ModuleFilter): Promisable<T[]>
15
15
  }
16
16
 
17
- export type Module<TConfig extends ModuleConfig = ModuleConfig> = {
17
+ export type Module<TConfig extends ModuleConfig = ModuleConfig, TModuleEventEmitter extends ModuleEventEmitter | undefined = undefined> = {
18
18
  address: string
19
19
  config: TConfig
20
20
 
21
21
  /* The resolver is a 'down' resolver. It can resolve the module or any children (if it is a node for example), that are in the module*/
22
22
  readonly downResolver: ModuleResolver
23
23
 
24
- on: ModuleQueriedEventEmitter['on']
24
+ on: TModuleEventEmitter extends ModuleEventEmitter ? ModuleQueriedEventEmitter['on'] | TModuleEventEmitter['on'] : ModuleQueriedEventEmitter['on']
25
25
 
26
26
  queries: string[]
27
27
  query: <T extends XyoQueryBoundWitness = XyoQueryBoundWitness, TConf extends ModuleConfig = ModuleConfig>(