@xyo-network/react-event 2.41.37 → 2.41.38

package/README.md

@@ -1,70 +1,13 @@
-[![logo][]][logo-link]
+[![logo][]](https://xyo.network)
 
-# @xyo-network/sdk-xyo-react-js
-
-[![main-build][]][main-build-link]
-[![beta-build][]][beta-build-link]
-[![npm-badge][]][npm-link]
-[![bch-badge][]][bch-link]
-[![codacy-badge][]][codacy-link]
-[![codeclimate-badge][]][codeclimate-link]
-[![snyk-badge][]][snyk-link]
-
-> The XYO Foundation provides this source code available in our efforts to
-> advance the understanding of the XYO Procotol and its possible uses.
-
-## Table of Contents
-
--   [Description](#description)
--   [Install](#install)
--   [Maintainers](#maintainers)
--   [License](#license)
--   [Credits](#credits)
-
-## Description
-
-Common React code that is used throughout XYO projects that use React.
-
-## Install
-
-Using npm:
-
-```sh
-npm i --save @xyo-network/sdk-xyo-react-js
-```
-
-Using yarn:
-
-```sh
-yarn add @xyo-network/sdk-xyo-react-js
-```
-
-## Maintainers
-
--   [Arie Trouw](https://github.com/arietrouw) (<https://arietrouw.com>)
--   [Matt Jones](https://github.com/jonesmac)
+Part of [@xyo-network/sdk-xyo-react](https://www.npmjs.com/package/@xyo-network/sdk-xyo-react)
 
 ## License
 
-See the [LICENSE](LICENSE) file for license details
+> See the [LICENSE](LICENSE) file for license details
 
 ## Credits
 
 [Made with 🔥 and ❄️ by XYO](https://xyo.network)
 
-[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
-[logo-link]: https://xyo.network
-[main-build]: https://github.com/XYOracleNetwork/sdk-xyo-react-js/actions/workflows/build-main.yml/badge.svg
-[main-build-link]: https://github.com/XYOracleNetwork/sdk-xyo-react-js/actions/workflows/build-main.yml
-[beta-build]: https://github.com/XYOracleNetwork/sdk-xyo-react-js/actions/workflows/build-beta.yml/badge.svg
-[beta-build-link]: https://github.com/XYOracleNetwork/sdk-xyo-react-js/actions/workflows/build-beta.yml
-[npm-badge]: https://img.shields.io/npm/v/@xyo-network/sdk-xyo-react.svg
-[npm-link]: https://www.npmjs.com/package/@xyo-network/sdk-xyo-react
-[bch-badge]: https://bettercodehub.com/edge/badge/XYOracleNetwork/sdk-xyo-react-js?branch=main
-[bch-link]: https://bettercodehub.com/results/XYOracleNetwork/sdk-xyo-react-js
-[codacy-badge]: https://app.codacy.com/project/badge/Grade/0c82dd3b33c3494886a30b1c4ff5a8c0
-[codacy-link]: https://www.codacy.com/gh/XYOracleNetwork/sdk-xyo-react-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=XYOracleNetwork/sdk-xyo-react-js&utm_campaign=Badge_Grade
-[codeclimate-badge]: https://api.codeclimate.com/v1/badges/3d9b970fc814bbdd7d8f/maintainability
-[codeclimate-link]: https://codeclimate.com/github/XYOracleNetwork/sdk-xyo-react-js/maintainability
-[snyk-badge]: https://snyk.io/test/github/XYOracleNetwork/sdk-xyo-react-js/badge.svg?targetFile=package.json
-[snyk-link]: https://snyk.io/test/github/XYOracleNetwork/sdk-xyo-react-js?targetFile=package.json
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png

package/dist/docs.json

@@ -14,7 +14,7 @@
 			"flags": {},
 			"children": [
 				{
-					"id": 18,
+					"id": 16,
 					"name": "data",
 					"kind": 1024,
 					"kindString": "Property",
@@ -24,9 +24,9 @@
 					"sources": [
 						{
 							"fileName": "hooks/useXyoEvent.ts",
-							"line": 11,
+							"line": 9,
 							"character": 2,
-							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/a4e86c2ce/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L11"
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/ddb49e92b/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L9"
 						}
 					],
 					"type": {
@@ -36,7 +36,7 @@
 					}
 				},
 				{
-					"id": 16,
+					"id": 17,
 					"name": "noun",
 					"kind": 1024,
 					"kindString": "Property",
@@ -44,9 +44,9 @@
 					"sources": [
 						{
 							"fileName": "hooks/useXyoEvent.ts",
-							"line": 9,
+							"line": 10,
 							"character": 2,
-							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/a4e86c2ce/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L9"
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/ddb49e92b/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L10"
 						}
 					],
 					"type": {
@@ -56,7 +56,7 @@
 					}
 				},
 				{
-					"id": 17,
+					"id": 18,
 					"name": "verb",
 					"kind": 1024,
 					"kindString": "Property",
@@ -64,9 +64,9 @@
 					"sources": [
 						{
 							"fileName": "hooks/useXyoEvent.ts",
-							"line": 10,
+							"line": 11,
 							"character": 2,
-							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/a4e86c2ce/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L10"
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/ddb49e92b/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L11"
 						}
 					],
 					"type": {
@@ -80,9 +80,9 @@
 				{
 					"title": "Properties",
 					"children": [
-						18,
 						16,
-						17
+						17,
+						18
 					]
 				}
 			],
@@ -91,7 +91,7 @@
 					"fileName": "hooks/useXyoEvent.ts",
 					"line": 8,
 					"character": 17,
-					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/a4e86c2ce/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L8"
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/ddb49e92b/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L8"
 				}
 			],
 			"typeParameters": [
@@ -143,7 +143,7 @@
 					"fileName": "hooks/useCustomEvent.ts",
 					"line": 4,
 					"character": 12,
-					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/a4e86c2ce/packages/sdk/packages/event/src/hooks/useCustomEvent.ts#L4"
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/ddb49e92b/packages/sdk/packages/event/src/hooks/useCustomEvent.ts#L4"
 				}
 			],
 			"typeParameters": [
@@ -172,7 +172,7 @@
 							"fileName": "hooks/useCustomEvent.ts",
 							"line": 4,
 							"character": 47,
-							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/a4e86c2ce/packages/sdk/packages/event/src/hooks/useCustomEvent.ts#L4"
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/ddb49e92b/packages/sdk/packages/event/src/hooks/useCustomEvent.ts#L4"
 						}
 					],
 					"signatures": [
@@ -225,7 +225,7 @@
 					"fileName": "hooks/useXyoEvent.ts",
 					"line": 14,
 					"character": 12,
-					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/a4e86c2ce/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L14"
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/ddb49e92b/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L14"
 				}
 			],
 			"typeParameters": [
@@ -278,7 +278,7 @@
 							"fileName": "hooks/useXyoEvent.ts",
 							"line": 14,
 							"character": 91,
-							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/a4e86c2ce/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L14"
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/ddb49e92b/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L14"
 						}
 					],
 					"signatures": [
@@ -357,7 +357,7 @@
 					"fileName": "hooks/useXyoEvent.ts",
 					"line": 5,
 					"character": 12,
-					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/a4e86c2ce/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L5"
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/ddb49e92b/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L5"
 				}
 			],
 			"type": {
@@ -397,7 +397,7 @@
 					"fileName": "hooks/useXyoEvent.ts",
 					"line": 6,
 					"character": 12,
-					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/a4e86c2ce/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L6"
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/ddb49e92b/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L6"
 				}
 			],
 			"type": {
@@ -416,7 +416,7 @@
 					"fileName": "hooks/useCustomEvent.ts",
 					"line": 6,
 					"character": 13,
-					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/a4e86c2ce/packages/sdk/packages/event/src/hooks/useCustomEvent.ts#L6"
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/ddb49e92b/packages/sdk/packages/event/src/hooks/useCustomEvent.ts#L6"
 				}
 			],
 			"signatures": [
@@ -559,7 +559,7 @@
 					"fileName": "hooks/useXyoEvent.ts",
 					"line": 16,
 					"character": 13,
-					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/a4e86c2ce/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L16"
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/ddb49e92b/packages/sdk/packages/event/src/hooks/useXyoEvent.ts#L16"
 				}
 			],
 			"signatures": [
@@ -753,7 +753,7 @@
 			"fileName": "index.ts",
 			"line": 1,
 			"character": 0,
-			"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/a4e86c2ce/packages/sdk/packages/event/src/index.ts#L1"
+			"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/ddb49e92b/packages/sdk/packages/event/src/index.ts#L1"
 		}
 	]
 }

package/dist/types/hooks/useXyoEvent.d.ts

@@ -2,9 +2,9 @@ import { RefObject } from 'react';
 export type XyoEventNoun = 'payload' | 'boundwitness' | 'address' | 'hash' | 'signature';
 export type XyoEventVerb = 'click';
 export interface XyoEvent<TNoun = XyoEventNoun, TVerb = XyoEventVerb, TData = string> {
+    data?: TData;
     noun: TNoun;
     verb: TVerb;
-    data?: TData;
 }
 export type XyoEventDispatch<TNoun = XyoEventNoun, TVerb = XyoEventVerb, TData = string> = (noun: TNoun, verb: TVerb, data?: TData) => boolean | void;
 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>];

package/dist/types/hooks/useXyoEvent.d.ts.map

@@ -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,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"}
+{"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,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"}

package/package.json

@@ -13,7 +13,7 @@
     "@xylabs/assert": "^2.6.16"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "2.12.26"
+    "@xylabs/ts-scripts-yarn3": "2.12.29"
   },
   "peerDependencies": {
     "react": "^18.2.0",
@@ -62,5 +62,5 @@
   },
   "sideEffects": false,
   "types": "dist/types/index.d.ts",
-  "version": "2.41.37"
+  "version": "2.41.38"
 }

package/src/hooks/useXyoEvent.ts

@@ -6,9 +6,9 @@ export type XyoEventNoun = 'payload' | 'boundwitness' | 'address' | 'hash' | 'si
 export type XyoEventVerb = 'click'
 
 export interface XyoEvent<TNoun = XyoEventNoun, TVerb = XyoEventVerb, TData = string> {
+  data?: TData
   noun: TNoun
   verb: TVerb
-  data?: TData
 }
 
 export type XyoEventDispatch<TNoun = XyoEventNoun, TVerb = XyoEventVerb, TData = string> = (noun: TNoun, verb: TVerb, data?: TData) => boolean | void