@xyo-network/react-event 2.40.18 → 2.40.20

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 (12) hide show
  1. package/README.md +1 -1
  2. package/dist/cjs/hooks/useCustomEvent.d.ts +1 -1
  3. package/dist/cjs/hooks/useCustomEvent.d.ts.map +1 -1
  4. package/dist/cjs/hooks/useXyoEvent.d.ts +3 -3
  5. package/dist/cjs/hooks/useXyoEvent.d.ts.map +1 -1
  6. package/dist/docs.json +17 -13
  7. package/dist/esm/hooks/useCustomEvent.d.ts +1 -1
  8. package/dist/esm/hooks/useCustomEvent.d.ts.map +1 -1
  9. package/dist/esm/hooks/useXyoEvent.d.ts +3 -3
  10. package/dist/esm/hooks/useXyoEvent.d.ts.map +1 -1
  11. package/package.json +1 -1
  12. package/src/hooks/useXyoEvent.ts +1 -1
package/README.md CHANGED
@@ -23,7 +23,7 @@
23
23
 
24
24
  ## Description
25
25
 
26
- Common React code that is used throughtout XYO projects that use React.
26
+ Common React code that is used throughout XYO projects that use React.
27
27
 
28
28
  ## Install
29
29
 
package/dist/cjs/hooks/useCustomEvent.d.ts CHANGED
@@ -1,4 +1,4 @@
1
1
  import { RefObject } from 'react';
2
- export declare type CustomEventDispatch<T = unknown> = (detail: T) => boolean | void;
2
+ export type CustomEventDispatch<T = unknown> = (detail: T) => boolean | void;
3
3
  export declare const useCustomEvent: <TElement extends HTMLElement, TDetail = unknown>(type: string, listener?: CustomEventDispatch<TDetail> | undefined, customRef?: RefObject<TElement> | undefined) => [RefObject<TElement>, CustomEventDispatch<TDetail>];
4
4
  //# sourceMappingURL=useCustomEvent.d.ts.map
package/dist/cjs/hooks/useCustomEvent.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"useCustomEvent.d.ts","sourceRoot":"","sources":["../../../src/hooks/useCustomEvent.ts"],"names":[],"mappings":"AACA,OAAO,EAAa,SAAS,EAAa,MAAM,OAAO,CAAA;AAEvD,oBAAY,mBAAmB,CAAC,CAAC,GAAG,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,OAAO,GAAG,IAAI,CAAA;AAE5E,eAAO,MAAM,cAAc,0DACnB,MAAM,0JAqCb,CAAA"}
1
+ {"version":3,"file":"useCustomEvent.d.ts","sourceRoot":"","sources":["../../../src/hooks/useCustomEvent.ts"],"names":[],"mappings":"AACA,OAAO,EAAa,SAAS,EAAa,MAAM,OAAO,CAAA;AAEvD,MAAM,MAAM,mBAAmB,CAAC,CAAC,GAAG,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,OAAO,GAAG,IAAI,CAAA;AAE5E,eAAO,MAAM,cAAc,0DACnB,MAAM,0JAqCb,CAAA"}
package/dist/cjs/hooks/useXyoEvent.d.ts CHANGED
@@ -1,11 +1,11 @@
1
1
  import { RefObject } from 'react';
2
- export declare type XyoEventNoun = 'payload' | 'boundwitness' | 'address' | 'hash';
3
- export declare type XyoEventVerb = 'click';
2
+ export type XyoEventNoun = 'payload' | 'boundwitness' | 'address' | 'hash' | 'signature';
3
+ export type XyoEventVerb = 'click';
4
4
  export interface XyoEvent<TNoun = XyoEventNoun, TVerb = XyoEventVerb, TData = string> {
5
5
  noun: TNoun;
6
6
  verb: TVerb;
7
7
  data?: TData;
8
8
  }
9
- export declare type XyoEventDispatch<TNoun = XyoEventNoun, TVerb = XyoEventVerb, TData = string> = (noun: TNoun, verb: TVerb, data?: TData) => boolean | void;
9
+ export type XyoEventDispatch<TNoun = XyoEventNoun, TVerb = XyoEventVerb, TData = string> = (noun: TNoun, verb: TVerb, data?: TData) => boolean | void;
10
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>];
11
11
  //# sourceMappingURL=useXyoEvent.d.ts.map
package/dist/cjs/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,oBAAY,YAAY,GAAG,SAAS,GAAG,cAAc,GAAG,SAAS,GAAG,MAAM,CAAA;AAC1E,oBAAY,YAAY,GAAG,OAAO,CAAA;AAElC,MAAM,WAAW,QAAQ,CAAC,KAAK,GAAG,YAAY,EAAE,KAAK,GAAG,YAAY,EAAE,KAAK,GAAG,MAAM;IAClF,IAAI,EAAE,KAAK,CAAA;IACX,IAAI,EAAE,KAAK,CAAA;IACX,IAAI,CAAC,EAAE,KAAK,CAAA;CACb;AAED,oBAAY,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,CAAA;AACxF,MAAM,MAAM,YAAY,GAAG,OAAO,CAAA;AAElC,MAAM,WAAW,QAAQ,CAAC,KAAK,GAAG,YAAY,EAAE,KAAK,GAAG,YAAY,EAAE,KAAK,GAAG,MAAM;IAClF,IAAI,EAAE,KAAK,CAAA;IACX,IAAI,EAAE,KAAK,CAAA;IACX,IAAI,CAAC,EAAE,KAAK,CAAA;CACb;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"}
package/dist/docs.json CHANGED
@@ -26,7 +26,7 @@
26
26
  "fileName": "hooks/useXyoEvent.ts",
27
27
  "line": 11,
28
28
  "character": 2,
29
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/9e5ee781e3/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L11"
29
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/cdae639b/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L11"
30
30
  }
31
31
  ],
32
32
  "type": {
@@ -46,7 +46,7 @@
46
46
  "fileName": "hooks/useXyoEvent.ts",
47
47
  "line": 9,
48
48
  "character": 2,
49
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/9e5ee781e3/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L9"
49
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/cdae639b/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L9"
50
50
  }
51
51
  ],
52
52
  "type": {
@@ -66,7 +66,7 @@
66
66
  "fileName": "hooks/useXyoEvent.ts",
67
67
  "line": 10,
68
68
  "character": 2,
69
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/9e5ee781e3/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L10"
69
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/cdae639b/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L10"
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/9e5ee781e3/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L8"
94
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/cdae639b/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/9e5ee781e3/packages/sdk/packages/event/src/hooks/useCustomEvent.ts#L4"
146
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/cdae639b/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/9e5ee781e3/packages/sdk/packages/event/src/hooks/useCustomEvent.ts#L4"
175
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/cdae639b/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/9e5ee781e3/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L14"
228
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/cdae639b/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/9e5ee781e3/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L14"
281
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/cdae639b/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/9e5ee781e3/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L5"
360
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/cdae639b/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L5"
361
361
  }
362
362
  ],
363
363
  "type": {
@@ -378,6 +378,10 @@
378
378
  {
379
379
  "type": "literal",
380
380
  "value": "hash"
381
+ },
382
+ {
383
+ "type": "literal",
384
+ "value": "signature"
381
385
  }
382
386
  ]
383
387
  }
@@ -393,7 +397,7 @@
393
397
  "fileName": "hooks/useXyoEvent.ts",
394
398
  "line": 6,
395
399
  "character": 12,
396
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/9e5ee781e3/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L6"
400
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/cdae639b/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L6"
397
401
  }
398
402
  ],
399
403
  "type": {
@@ -412,7 +416,7 @@
412
416
  "fileName": "hooks/useCustomEvent.ts",
413
417
  "line": 6,
414
418
  "character": 13,
415
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/9e5ee781e3/packages/sdk/packages/event/src/hooks/useCustomEvent.ts#L6"
419
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/cdae639b/packages/sdk/packages/event/src/hooks/useCustomEvent.ts#L6"
416
420
  }
417
421
  ],
418
422
  "signatures": [
@@ -555,7 +559,7 @@
555
559
  "fileName": "hooks/useXyoEvent.ts",
556
560
  "line": 16,
557
561
  "character": 13,
558
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/9e5ee781e3/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L16"
562
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/cdae639b/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L16"
559
563
  }
560
564
  ],
561
565
  "signatures": [
@@ -749,7 +753,7 @@
749
753
  "fileName": "index.ts",
750
754
  "line": 1,
751
755
  "character": 0,
752
- "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/9e5ee781e3/packages/sdk/packages/event/src/index.ts#L1"
756
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/cdae639b/packages/sdk/packages/event/src/index.ts#L1"
753
757
  }
754
758
  ]
755
759
  }
package/dist/esm/hooks/useCustomEvent.d.ts CHANGED
@@ -1,4 +1,4 @@
1
1
  import { RefObject } from 'react';
2
- export declare type CustomEventDispatch<T = unknown> = (detail: T) => boolean | void;
2
+ export type CustomEventDispatch<T = unknown> = (detail: T) => boolean | void;
3
3
  export declare const useCustomEvent: <TElement extends HTMLElement, TDetail = unknown>(type: string, listener?: CustomEventDispatch<TDetail> | undefined, customRef?: RefObject<TElement> | undefined) => [RefObject<TElement>, CustomEventDispatch<TDetail>];
4
4
  //# sourceMappingURL=useCustomEvent.d.ts.map
package/dist/esm/hooks/useCustomEvent.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"useCustomEvent.d.ts","sourceRoot":"","sources":["../../../src/hooks/useCustomEvent.ts"],"names":[],"mappings":"AACA,OAAO,EAAa,SAAS,EAAa,MAAM,OAAO,CAAA;AAEvD,oBAAY,mBAAmB,CAAC,CAAC,GAAG,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,OAAO,GAAG,IAAI,CAAA;AAE5E,eAAO,MAAM,cAAc,0DACnB,MAAM,0JAqCb,CAAA"}
1
+ {"version":3,"file":"useCustomEvent.d.ts","sourceRoot":"","sources":["../../../src/hooks/useCustomEvent.ts"],"names":[],"mappings":"AACA,OAAO,EAAa,SAAS,EAAa,MAAM,OAAO,CAAA;AAEvD,MAAM,MAAM,mBAAmB,CAAC,CAAC,GAAG,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,OAAO,GAAG,IAAI,CAAA;AAE5E,eAAO,MAAM,cAAc,0DACnB,MAAM,0JAqCb,CAAA"}
package/dist/esm/hooks/useXyoEvent.d.ts CHANGED
@@ -1,11 +1,11 @@
1
1
  import { RefObject } from 'react';
2
- export declare type XyoEventNoun = 'payload' | 'boundwitness' | 'address' | 'hash';
3
- export declare type XyoEventVerb = 'click';
2
+ export type XyoEventNoun = 'payload' | 'boundwitness' | 'address' | 'hash' | 'signature';
3
+ export type XyoEventVerb = 'click';
4
4
  export interface XyoEvent<TNoun = XyoEventNoun, TVerb = XyoEventVerb, TData = string> {
5
5
  noun: TNoun;
6
6
  verb: TVerb;
7
7
  data?: TData;
8
8
  }
9
- export declare type XyoEventDispatch<TNoun = XyoEventNoun, TVerb = XyoEventVerb, TData = string> = (noun: TNoun, verb: TVerb, data?: TData) => boolean | void;
9
+ export type XyoEventDispatch<TNoun = XyoEventNoun, TVerb = XyoEventVerb, TData = string> = (noun: TNoun, verb: TVerb, data?: TData) => boolean | void;
10
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>];
11
11
  //# sourceMappingURL=useXyoEvent.d.ts.map
package/dist/esm/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,oBAAY,YAAY,GAAG,SAAS,GAAG,cAAc,GAAG,SAAS,GAAG,MAAM,CAAA;AAC1E,oBAAY,YAAY,GAAG,OAAO,CAAA;AAElC,MAAM,WAAW,QAAQ,CAAC,KAAK,GAAG,YAAY,EAAE,KAAK,GAAG,YAAY,EAAE,KAAK,GAAG,MAAM;IAClF,IAAI,EAAE,KAAK,CAAA;IACX,IAAI,EAAE,KAAK,CAAA;IACX,IAAI,CAAC,EAAE,KAAK,CAAA;CACb;AAED,oBAAY,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,CAAA;AACxF,MAAM,MAAM,YAAY,GAAG,OAAO,CAAA;AAElC,MAAM,WAAW,QAAQ,CAAC,KAAK,GAAG,YAAY,EAAE,KAAK,GAAG,YAAY,EAAE,KAAK,GAAG,MAAM;IAClF,IAAI,EAAE,KAAK,CAAA;IACX,IAAI,EAAE,KAAK,CAAA;IACX,IAAI,CAAC,EAAE,KAAK,CAAA;CACb;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"}
package/package.json CHANGED
@@ -59,5 +59,5 @@
59
59
  },
60
60
  "sideEffects": false,
61
61
  "types": "dist/esm/index.d.ts",
62
- "version": "2.40.18"
62
+ "version": "2.40.20"
63
63
  }
package/src/hooks/useXyoEvent.ts CHANGED
@@ -2,7 +2,7 @@ import { RefObject } from 'react'
2
2
 
3
3
  import { useCustomEvent } from './useCustomEvent'
4
4
 
5
- export type XyoEventNoun = 'payload' | 'boundwitness' | 'address' | 'hash'
5
+ export type XyoEventNoun = 'payload' | 'boundwitness' | 'address' | 'hash' | 'signature'
6
6
  export type XyoEventVerb = 'click'
7
7
 
8
8
  export interface XyoEvent<TNoun = XyoEventNoun, TVerb = XyoEventVerb, TData = string> {