@xyo-network/react-event 2.47.0 → 2.47.2

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 (5) hide show
  1. package/dist/docs.json +27 -17
  2. package/dist/types/hooks/useXyoEvent.d.ts +2 -2
  3. package/dist/types/hooks/useXyoEvent.d.ts.map +1 -1
  4. package/package.json +1 -1
  5. package/src/hooks/useXyoEvent.ts +1 -1
package/dist/docs.json CHANGED
@@ -26,7 +26,7 @@
26
26
  "fileName": "hooks/useXyoEvent.ts",
27
27
  "line": 9,
28
28
  "character": 2,
29
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/09eba1e53/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L9"
29
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/5cc7e2220/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L9"
30
30
  }
31
31
  ],
32
32
  "type": {
@@ -46,7 +46,7 @@
46
46
  "fileName": "hooks/useXyoEvent.ts",
47
47
  "line": 10,
48
48
  "character": 2,
49
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/09eba1e53/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L10"
49
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/5cc7e2220/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L10"
50
50
  }
51
51
  ],
52
52
  "type": {
@@ -66,7 +66,7 @@
66
66
  "fileName": "hooks/useXyoEvent.ts",
67
67
  "line": 11,
68
68
  "character": 2,
69
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/09eba1e53/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L11"
69
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/5cc7e2220/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L11"
70
70
  }
71
71
  ],
72
72
  "type": {
@@ -91,7 +91,7 @@
91
91
  "fileName": "hooks/useXyoEvent.ts",
92
92
  "line": 8,
93
93
  "character": 17,
94
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/09eba1e53/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L8"
94
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/5cc7e2220/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L8"
95
95
  }
96
96
  ],
97
97
  "typeParameters": [
@@ -143,7 +143,7 @@
143
143
  "fileName": "hooks/useCustomEvent.ts",
144
144
  "line": 4,
145
145
  "character": 12,
146
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/09eba1e53/packages/sdk/packages/event/src/hooks/useCustomEvent.ts#L4"
146
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/5cc7e2220/packages/sdk/packages/event/src/hooks/useCustomEvent.ts#L4"
147
147
  }
148
148
  ],
149
149
  "typeParameters": [
@@ -172,7 +172,7 @@
172
172
  "fileName": "hooks/useCustomEvent.ts",
173
173
  "line": 4,
174
174
  "character": 47,
175
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/09eba1e53/packages/sdk/packages/event/src/hooks/useCustomEvent.ts#L4"
175
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/5cc7e2220/packages/sdk/packages/event/src/hooks/useCustomEvent.ts#L4"
176
176
  }
177
177
  ],
178
178
  "signatures": [
@@ -225,7 +225,7 @@
225
225
  "fileName": "hooks/useXyoEvent.ts",
226
226
  "line": 14,
227
227
  "character": 12,
228
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/09eba1e53/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L14"
228
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/5cc7e2220/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L14"
229
229
  }
230
230
  ],
231
231
  "typeParameters": [
@@ -278,7 +278,7 @@
278
278
  "fileName": "hooks/useXyoEvent.ts",
279
279
  "line": 14,
280
280
  "character": 91,
281
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/09eba1e53/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L14"
281
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/5cc7e2220/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L14"
282
282
  }
283
283
  ],
284
284
  "signatures": [
@@ -357,7 +357,7 @@
357
357
  "fileName": "hooks/useXyoEvent.ts",
358
358
  "line": 5,
359
359
  "character": 12,
360
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/09eba1e53/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L5"
360
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/5cc7e2220/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L5"
361
361
  }
362
362
  ],
363
363
  "type": {
@@ -401,12 +401,21 @@
401
401
  "fileName": "hooks/useXyoEvent.ts",
402
402
  "line": 6,
403
403
  "character": 12,
404
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/09eba1e53/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L6"
404
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/5cc7e2220/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L6"
405
405
  }
406
406
  ],
407
407
  "type": {
408
- "type": "literal",
409
- "value": "click"
408
+ "type": "union",
409
+ "types": [
410
+ {
411
+ "type": "literal",
412
+ "value": "click"
413
+ },
414
+ {
415
+ "type": "literal",
416
+ "value": "favorite"
417
+ }
418
+ ]
410
419
  }
411
420
  },
412
421
  {
@@ -420,7 +429,7 @@
420
429
  "fileName": "hooks/useCustomEvent.ts",
421
430
  "line": 6,
422
431
  "character": 13,
423
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/09eba1e53/packages/sdk/packages/event/src/hooks/useCustomEvent.ts#L6"
432
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/5cc7e2220/packages/sdk/packages/event/src/hooks/useCustomEvent.ts#L6"
424
433
  }
425
434
  ],
426
435
  "signatures": [
@@ -556,7 +565,7 @@
556
565
  "fileName": "hooks/useXyoEvent.ts",
557
566
  "line": 16,
558
567
  "character": 13,
559
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/09eba1e53/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L16"
568
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/5cc7e2220/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L16"
560
569
  }
561
570
  ],
562
571
  "signatures": [
@@ -599,8 +608,9 @@
599
608
  "kindString": "Type parameter",
600
609
  "flags": {},
601
610
  "default": {
602
- "type": "literal",
603
- "value": "click"
611
+ "type": "reference",
612
+ "id": 14,
613
+ "name": "XyoEventVerb"
604
614
  }
605
615
  },
606
616
  {
@@ -743,7 +753,7 @@
743
753
  "fileName": "index.ts",
744
754
  "line": 1,
745
755
  "character": 0,
746
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/09eba1e53/packages/sdk/packages/event/src/index.ts#L1"
756
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/5cc7e2220/packages/sdk/packages/event/src/index.ts#L1"
747
757
  }
748
758
  ]
749
759
  }
package/dist/types/hooks/useXyoEvent.d.ts CHANGED
@@ -1,11 +1,11 @@
1
1
  import { RefObject } from 'react';
2
2
  export type XyoEventNoun = 'payload' | 'boundwitness' | 'address' | 'hash' | 'signature' | 'schema';
3
- export type XyoEventVerb = 'click';
3
+ export type XyoEventVerb = 'click' | 'favorite';
4
4
  export interface XyoEvent<TNoun = XyoEventNoun, TVerb = XyoEventVerb, TData = string> {
5
5
  data?: TData;
6
6
  noun: TNoun;
7
7
  verb: TVerb;
8
8
  }
9
9
  export type XyoEventDispatch<TNoun = XyoEventNoun, TVerb = XyoEventVerb, TData = string> = (noun: TNoun, verb: TVerb, data?: TData) => boolean | void;
10
- export declare const useXyoEvent: <T extends HTMLElement, TNoun = XyoEventNoun, TVerb = "click", TData = string>(listener?: XyoEventDispatch<TNoun, TVerb, TData> | undefined, sharableRef?: RefObject<T> | undefined) => [RefObject<T>, XyoEventDispatch<TNoun, TVerb, TData>];
10
+ export declare const useXyoEvent: <T extends HTMLElement, TNoun = XyoEventNoun, TVerb = XyoEventVerb, TData = string>(listener?: XyoEventDispatch<TNoun, TVerb, TData> | undefined, sharableRef?: RefObject<T> | undefined) => [RefObject<T>, XyoEventDispatch<TNoun, TVerb, TData>];
11
11
  //# sourceMappingURL=useXyoEvent.d.ts.map
package/dist/types/hooks/useXyoEvent.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"useXyoEvent.d.ts","sourceRoot":"","sources":["../../../src/hooks/useXyoEvent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAIjC,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,cAAc,GAAG,SAAS,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,CAAA;AACnG,MAAM,MAAM,YAAY,GAAG,OAAO,CAAA;AAElC,MAAM,WAAW,QAAQ,CAAC,KAAK,GAAG,YAAY,EAAE,KAAK,GAAG,YAAY,EAAE,KAAK,GAAG,MAAM;IAClF,IAAI,CAAC,EAAE,KAAK,CAAA;IACZ,IAAI,EAAE,KAAK,CAAA;IACX,IAAI,EAAE,KAAK,CAAA;CACZ;AAED,MAAM,MAAM,gBAAgB,CAAC,KAAK,GAAG,YAAY,EAAE,KAAK,GAAG,YAAY,EAAE,KAAK,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,KAAK,KAAK,OAAO,GAAG,IAAI,CAAA;AAErJ,eAAO,MAAM,WAAW,+OAkBvB,CAAA"}
1
+ {"version":3,"file":"useXyoEvent.d.ts","sourceRoot":"","sources":["../../../src/hooks/useXyoEvent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAIjC,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,cAAc,GAAG,SAAS,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,CAAA;AACnG,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,UAAU,CAAA;AAE/C,MAAM,WAAW,QAAQ,CAAC,KAAK,GAAG,YAAY,EAAE,KAAK,GAAG,YAAY,EAAE,KAAK,GAAG,MAAM;IAClF,IAAI,CAAC,EAAE,KAAK,CAAA;IACZ,IAAI,EAAE,KAAK,CAAA;IACX,IAAI,EAAE,KAAK,CAAA;CACZ;AAED,MAAM,MAAM,gBAAgB,CAAC,KAAK,GAAG,YAAY,EAAE,KAAK,GAAG,YAAY,EAAE,KAAK,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,KAAK,KAAK,OAAO,GAAG,IAAI,CAAA;AAErJ,eAAO,MAAM,WAAW,oPAkBvB,CAAA"}
package/package.json CHANGED
@@ -62,5 +62,5 @@
62
62
  },
63
63
  "sideEffects": false,
64
64
  "types": "dist/types/index.d.ts",
65
- "version": "2.47.0"
65
+ "version": "2.47.2"
66
66
  }
package/src/hooks/useXyoEvent.ts CHANGED
@@ -3,7 +3,7 @@ import { RefObject } from 'react'
3
3
  import { useCustomEvent } from './useCustomEvent'
4
4
 
5
5
  export type XyoEventNoun = 'payload' | 'boundwitness' | 'address' | 'hash' | 'signature' | 'schema'
6
- export type XyoEventVerb = 'click'
6
+ export type XyoEventVerb = 'click' | 'favorite'
7
7
 
8
8
  export interface XyoEvent<TNoun = XyoEventNoun, TVerb = XyoEventVerb, TData = string> {
9
9
  data?: TData