@xyo-network/react-api 2.32.0-rc.9 → 2.32.0

package/dist/docs.json

@@ -26,7 +26,7 @@
 							"fileName": "packages/sdk/packages/api/src/components/ApiErrorAlert.tsx",
 							"line": 5,
 							"character": 2,
-							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/98da10b5/packages/sdk/packages/api/src/components/ApiErrorAlert.tsx#L5"
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/bde02cc8/packages/sdk/packages/api/src/components/ApiErrorAlert.tsx#L5"
 						}
 					],
 					"type": {
@@ -60,7 +60,7 @@
 					"fileName": "packages/sdk/packages/api/src/components/ApiErrorAlert.tsx",
 					"line": 4,
 					"character": 17,
-					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/98da10b5/packages/sdk/packages/api/src/components/ApiErrorAlert.tsx#L4"
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/bde02cc8/packages/sdk/packages/api/src/components/ApiErrorAlert.tsx#L4"
 				}
 			],
 			"extendedTypes": [
@@ -72,6 +72,52 @@
 				}
 			]
 		},
+		{
+			"id": 405,
+			"name": "FetchHuriHashOptions",
+			"kind": 256,
+			"kindString": "Interface",
+			"flags": {},
+			"children": [
+				{
+					"id": 406,
+					"name": "changeActiveNetwork",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isOptional": true
+					},
+					"sources": [
+						{
+							"fileName": "packages/sdk/packages/api/src/hooks/lib/FetchHuriHashOptions.ts",
+							"line": 2,
+							"character": 2,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/bde02cc8/packages/sdk/packages/api/src/hooks/lib/FetchHuriHashOptions.ts#L2"
+						}
+					],
+					"type": {
+						"type": "intrinsic",
+						"name": "boolean"
+					}
+				}
+			],
+			"groups": [
+				{
+					"title": "Properties",
+					"children": [
+						406
+					]
+				}
+			],
+			"sources": [
+				{
+					"fileName": "packages/sdk/packages/api/src/hooks/lib/FetchHuriHashOptions.ts",
+					"line": 1,
+					"character": 17,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/bde02cc8/packages/sdk/packages/api/src/hooks/lib/FetchHuriHashOptions.ts#L1"
+				}
+			]
+		},
 		{
 			"id": 400,
 			"name": "HandleItemDetailLoadingProps",
@@ -90,7 +136,7 @@
 							"fileName": "packages/sdk/packages/api/src/components/ResultLoader.tsx",
 							"line": 7,
 							"character": 2,
-							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/98da10b5/packages/sdk/packages/api/src/components/ResultLoader.tsx#L7"
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/bde02cc8/packages/sdk/packages/api/src/components/ResultLoader.tsx#L7"
 						}
 					],
 					"type": {
@@ -136,7 +182,7 @@
 							"fileName": "packages/sdk/packages/api/src/components/ResultLoader.tsx",
 							"line": 8,
 							"character": 2,
-							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/98da10b5/packages/sdk/packages/api/src/components/ResultLoader.tsx#L8"
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/bde02cc8/packages/sdk/packages/api/src/components/ResultLoader.tsx#L8"
 						}
 					],
 					"type": {
@@ -155,7 +201,7 @@
 							"fileName": "packages/sdk/packages/api/src/components/ResultLoader.tsx",
 							"line": 9,
 							"character": 2,
-							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/98da10b5/packages/sdk/packages/api/src/components/ResultLoader.tsx#L9"
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/bde02cc8/packages/sdk/packages/api/src/components/ResultLoader.tsx#L9"
 						}
 					],
 					"type": {
@@ -189,7 +235,7 @@
 					"fileName": "packages/sdk/packages/api/src/components/ResultLoader.tsx",
 					"line": 6,
 					"character": 17,
-					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/98da10b5/packages/sdk/packages/api/src/components/ResultLoader.tsx#L6"
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/bde02cc8/packages/sdk/packages/api/src/components/ResultLoader.tsx#L6"
 				}
 			],
 			"typeParameters": [
@@ -4074,7 +4120,7 @@
 							"fileName": "packages/sdk/packages/api/src/components/JsonRouteWrapper/JsonRouteWrapper.tsx",
 							"line": 15,
 							"character": 2,
-							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/98da10b5/packages/sdk/packages/api/src/components/JsonRouteWrapper/JsonRouteWrapper.tsx#L15"
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/bde02cc8/packages/sdk/packages/api/src/components/JsonRouteWrapper/JsonRouteWrapper.tsx#L15"
 						}
 					],
 					"type": {
@@ -4090,7 +4136,7 @@
 									"fileName": "packages/sdk/packages/api/src/components/JsonRouteWrapper/JsonRouteWrapper.tsx",
 									"line": 15,
 									"character": 12,
-									"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/98da10b5/packages/sdk/packages/api/src/components/JsonRouteWrapper/JsonRouteWrapper.tsx#L15"
+									"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/bde02cc8/packages/sdk/packages/api/src/components/JsonRouteWrapper/JsonRouteWrapper.tsx#L15"
 								}
 							],
 							"signatures": [
@@ -8368,7 +8414,7 @@
 							"fileName": "packages/sdk/packages/api/src/components/JsonRouteWrapper/JsonRouteWrapper.tsx",
 							"line": 18,
 							"character": 2,
-							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/98da10b5/packages/sdk/packages/api/src/components/JsonRouteWrapper/JsonRouteWrapper.tsx#L18"
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/bde02cc8/packages/sdk/packages/api/src/components/JsonRouteWrapper/JsonRouteWrapper.tsx#L18"
 						}
 					],
 					"type": {
@@ -13257,7 +13303,7 @@
 							"fileName": "packages/sdk/packages/api/src/components/JsonRouteWrapper/JsonRouteWrapper.tsx",
 							"line": 16,
 							"character": 2,
-							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/98da10b5/packages/sdk/packages/api/src/components/JsonRouteWrapper/JsonRouteWrapper.tsx#L16"
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/bde02cc8/packages/sdk/packages/api/src/components/JsonRouteWrapper/JsonRouteWrapper.tsx#L16"
 						}
 					],
 					"type": {
@@ -13278,7 +13324,7 @@
 							"fileName": "packages/sdk/packages/api/src/components/JsonRouteWrapper/JsonRouteWrapper.tsx",
 							"line": 17,
 							"character": 2,
-							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/98da10b5/packages/sdk/packages/api/src/components/JsonRouteWrapper/JsonRouteWrapper.tsx#L17"
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/bde02cc8/packages/sdk/packages/api/src/components/JsonRouteWrapper/JsonRouteWrapper.tsx#L17"
 						}
 					],
 					"type": {
@@ -18702,7 +18748,7 @@
 					"fileName": "packages/sdk/packages/api/src/components/JsonRouteWrapper/JsonRouteWrapper.tsx",
 					"line": 14,
 					"character": 17,
-					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/98da10b5/packages/sdk/packages/api/src/components/JsonRouteWrapper/JsonRouteWrapper.tsx#L14"
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/bde02cc8/packages/sdk/packages/api/src/components/JsonRouteWrapper/JsonRouteWrapper.tsx#L14"
 				}
 			],
 			"extendedTypes": [
@@ -18714,6 +18760,86 @@
 				}
 			]
 		},
+		{
+			"id": 413,
+			"name": "UseHuriOrHash",
+			"kind": 4194304,
+			"kindString": "Type alias",
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "packages/sdk/packages/api/src/hooks/ResolvePayloadArgs.ts",
+					"line": 6,
+					"character": 12,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/bde02cc8/packages/sdk/packages/api/src/hooks/ResolvePayloadArgs.ts#L6"
+				}
+			],
+			"type": {
+				"type": "tuple",
+				"elements": [
+					{
+						"type": "rest",
+						"elementType": {
+							"type": "reference",
+							"id": 412,
+							"name": "UsePayload"
+						}
+					},
+					{
+						"type": "optional",
+						"elementType": {
+							"type": "intrinsic",
+							"name": "boolean"
+						}
+					}
+				]
+			}
+		},
+		{
+			"id": 412,
+			"name": "UsePayload",
+			"kind": 4194304,
+			"kindString": "Type alias",
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "packages/sdk/packages/api/src/hooks/ResolvePayloadArgs.ts",
+					"line": 4,
+					"character": 12,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/bde02cc8/packages/sdk/packages/api/src/hooks/ResolvePayloadArgs.ts#L4"
+				}
+			],
+			"type": {
+				"type": "tuple",
+				"elements": [
+					{
+						"type": "optional",
+						"elementType": {
+							"type": "reference",
+							"name": "XyoPayload",
+							"qualifiedName": "XyoPayload",
+							"package": "@xyo-network/payload"
+						}
+					},
+					{
+						"type": "optional",
+						"elementType": {
+							"type": "intrinsic",
+							"name": "boolean"
+						}
+					},
+					{
+						"type": "optional",
+						"elementType": {
+							"type": "reference",
+							"name": "XyoApiError",
+							"qualifiedName": "XyoApiError",
+							"package": "@xyo-network/api"
+						}
+					}
+				]
+			}
+		},
 		{
 			"id": 3,
 			"name": "ApiErrorAlert",
@@ -18725,7 +18851,7 @@
 					"fileName": "packages/sdk/packages/api/src/components/ApiErrorAlert.tsx",
 					"line": 8,
 					"character": 6,
-					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/98da10b5/packages/sdk/packages/api/src/components/ApiErrorAlert.tsx#L8"
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/bde02cc8/packages/sdk/packages/api/src/components/ApiErrorAlert.tsx#L8"
 				}
 			],
 			"signatures": [
@@ -18801,7 +18927,7 @@
 					"fileName": "packages/sdk/packages/api/src/components/JsonRouteWrapper/JsonApiButton.tsx",
 					"line": 4,
 					"character": 13,
-					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/98da10b5/packages/sdk/packages/api/src/components/JsonRouteWrapper/JsonApiButton.tsx#L4"
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/bde02cc8/packages/sdk/packages/api/src/components/JsonRouteWrapper/JsonApiButton.tsx#L4"
 				}
 			],
 			"signatures": [
@@ -18878,7 +19004,7 @@
 					"fileName": "packages/sdk/packages/api/src/components/JsonRouteWrapper/JsonRouteWrapper.tsx",
 					"line": 21,
 					"character": 13,
-					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/98da10b5/packages/sdk/packages/api/src/components/JsonRouteWrapper/JsonRouteWrapper.tsx#L21"
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/bde02cc8/packages/sdk/packages/api/src/components/JsonRouteWrapper/JsonRouteWrapper.tsx#L21"
 				}
 			],
 			"signatures": [
@@ -18954,7 +19080,7 @@
 					"fileName": "packages/sdk/packages/api/src/components/ResultLoader.tsx",
 					"line": 12,
 					"character": 16,
-					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/98da10b5/packages/sdk/packages/api/src/components/ResultLoader.tsx#L12"
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/bde02cc8/packages/sdk/packages/api/src/components/ResultLoader.tsx#L12"
 				}
 			],
 			"signatures": [
@@ -19010,6 +19136,427 @@
 					}
 				}
 			]
+		},
+		{
+			"id": 407,
+			"name": "findHuriNetwork",
+			"kind": 64,
+			"kindString": "Function",
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "packages/sdk/packages/api/src/hooks/lib/findHuriNetwork.ts",
+					"line": 4,
+					"character": 13,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/bde02cc8/packages/sdk/packages/api/src/hooks/lib/findHuriNetwork.ts#L4"
+				}
+			],
+			"signatures": [
+				{
+					"id": 408,
+					"name": "findHuriNetwork",
+					"kind": 4096,
+					"kindString": "Call signature",
+					"flags": {},
+					"parameters": [
+						{
+							"id": 409,
+							"name": "huriInstance",
+							"kind": 32768,
+							"kindString": "Parameter",
+							"flags": {},
+							"type": {
+								"type": "reference",
+								"typeArguments": [
+									{
+										"type": "reflection",
+										"declaration": {
+											"id": 410,
+											"name": "__type",
+											"kind": 65536,
+											"kindString": "Type literal",
+											"flags": {},
+											"sources": [
+												{
+													"fileName": "node_modules/@xyo-network/payload/dist/esm/models/Base.d.ts",
+													"line": 7,
+													"character": 107
+												}
+											]
+										}
+									}
+								],
+								"name": "Huri",
+								"qualifiedName": "Huri",
+								"package": "@xyo-network/payload"
+							}
+						},
+						{
+							"id": 411,
+							"name": "networks",
+							"kind": 32768,
+							"kindString": "Parameter",
+							"flags": {
+								"isOptional": true
+							},
+							"type": {
+								"type": "array",
+								"elementType": {
+									"type": "reference",
+									"name": "XyoNetworkPayload",
+									"qualifiedName": "XyoNetworkPayload",
+									"package": "@xyo-network/network"
+								}
+							}
+						}
+					],
+					"type": {
+						"type": "union",
+						"types": [
+							{
+								"type": "intrinsic",
+								"name": "undefined"
+							},
+							{
+								"type": "reference",
+								"name": "XyoNetworkPayload",
+								"qualifiedName": "XyoNetworkPayload",
+								"package": "@xyo-network/network"
+							}
+						]
+					}
+				}
+			]
+		},
+		{
+			"id": 414,
+			"name": "useHuriHash",
+			"kind": 64,
+			"kindString": "Function",
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "packages/sdk/packages/api/src/hooks/useHuriHash.tsx",
+					"line": 12,
+					"character": 6,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/bde02cc8/packages/sdk/packages/api/src/hooks/useHuriHash.tsx#L12"
+				}
+			],
+			"signatures": [
+				{
+					"id": 415,
+					"name": "useHuriHash",
+					"kind": 4096,
+					"kindString": "Call signature",
+					"flags": {},
+					"comment": {
+						"summary": [
+							{
+								"kind": "text",
+								"text": "Resolve a hash or a huri regardless of network"
+							}
+						]
+					},
+					"parameters": [
+						{
+							"id": 416,
+							"name": "huriOrHash",
+							"kind": 32768,
+							"kindString": "Parameter",
+							"flags": {
+								"isOptional": true
+							},
+							"type": {
+								"type": "union",
+								"types": [
+									{
+										"type": "intrinsic",
+										"name": "string"
+									},
+									{
+										"type": "reference",
+										"typeArguments": [
+											{
+												"type": "reflection",
+												"declaration": {
+													"id": 417,
+													"name": "__type",
+													"kind": 65536,
+													"kindString": "Type literal",
+													"flags": {},
+													"sources": [
+														{
+															"fileName": "node_modules/@xyo-network/payload/dist/esm/models/Base.d.ts",
+															"line": 7,
+															"character": 107
+														}
+													]
+												}
+											}
+										],
+										"name": "Huri",
+										"qualifiedName": "Huri",
+										"package": "@xyo-network/payload"
+									}
+								]
+							}
+						},
+						{
+							"id": 418,
+							"name": "huriUri",
+							"kind": 32768,
+							"kindString": "Parameter",
+							"flags": {
+								"isOptional": true
+							},
+							"type": {
+								"type": "intrinsic",
+								"name": "string"
+							}
+						},
+						{
+							"id": 419,
+							"name": "options",
+							"kind": 32768,
+							"kindString": "Parameter",
+							"flags": {
+								"isOptional": true
+							},
+							"type": {
+								"type": "reference",
+								"id": 405,
+								"name": "FetchHuriHashOptions"
+							}
+						}
+					],
+					"type": {
+						"type": "tuple",
+						"elements": [
+							{
+								"type": "optional",
+								"elementType": {
+									"type": "reflection",
+									"declaration": {
+										"id": 420,
+										"name": "__type",
+										"kind": 65536,
+										"kindString": "Type literal",
+										"flags": {},
+										"sources": [
+											{
+												"fileName": "node_modules/@xyo-network/payload/dist/esm/models/Base.d.ts",
+												"line": 7,
+												"character": 107
+											}
+										]
+									}
+								}
+							},
+							{
+								"type": "optional",
+								"elementType": {
+									"type": "intrinsic",
+									"name": "boolean"
+								}
+							},
+							{
+								"type": "optional",
+								"elementType": {
+									"type": "reference",
+									"typeArguments": [
+										{
+											"type": "intrinsic",
+											"name": "any"
+										},
+										{
+											"type": "intrinsic",
+											"name": "any"
+										}
+									],
+									"name": "XyoApiError",
+									"qualifiedName": "XyoApiError",
+									"package": "@xyo-network/api"
+								}
+							},
+							{
+								"type": "optional",
+								"elementType": {
+									"type": "intrinsic",
+									"name": "boolean"
+								}
+							}
+						]
+					}
+				}
+			]
+		},
+		{
+			"id": 421,
+			"name": "useLoadPayload",
+			"kind": 64,
+			"kindString": "Function",
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "packages/sdk/packages/api/src/hooks/useLoadPayload.tsx",
+					"line": 10,
+					"character": 13,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/bde02cc8/packages/sdk/packages/api/src/hooks/useLoadPayload.tsx#L10"
+				}
+			],
+			"signatures": [
+				{
+					"id": 422,
+					"name": "useLoadPayload",
+					"kind": 4096,
+					"kindString": "Call signature",
+					"flags": {},
+					"parameters": [
+						{
+							"id": 423,
+							"name": "hash",
+							"kind": 32768,
+							"kindString": "Parameter",
+							"flags": {
+								"isOptional": true
+							},
+							"type": {
+								"type": "intrinsic",
+								"name": "string"
+							}
+						}
+					],
+					"type": {
+						"type": "reference",
+						"id": 412,
+						"name": "UsePayload"
+					}
+				}
+			]
+		},
+		{
+			"id": 424,
+			"name": "useResolveHuri",
+			"kind": 64,
+			"kindString": "Function",
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "packages/sdk/packages/api/src/hooks/useResolveHuri.tsx",
+					"line": 10,
+					"character": 6,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/bde02cc8/packages/sdk/packages/api/src/hooks/useResolveHuri.tsx#L10"
+				}
+			],
+			"signatures": [
+				{
+					"id": 425,
+					"name": "useResolveHuri",
+					"kind": 4096,
+					"kindString": "Call signature",
+					"flags": {},
+					"parameters": [
+						{
+							"id": 426,
+							"name": "huriUri",
+							"kind": 32768,
+							"kindString": "Parameter",
+							"flags": {
+								"isOptional": true
+							},
+							"type": {
+								"type": "intrinsic",
+								"name": "string"
+							}
+						},
+						{
+							"id": 427,
+							"name": "dependentNotFound",
+							"kind": 32768,
+							"kindString": "Parameter",
+							"flags": {
+								"isOptional": true
+							},
+							"type": {
+								"type": "intrinsic",
+								"name": "boolean"
+							}
+						},
+						{
+							"id": 428,
+							"name": "options",
+							"kind": 32768,
+							"kindString": "Parameter",
+							"flags": {
+								"isOptional": true
+							},
+							"type": {
+								"type": "reference",
+								"id": 405,
+								"name": "FetchHuriHashOptions"
+							}
+						}
+					],
+					"type": {
+						"type": "tuple",
+						"elements": [
+							{
+								"type": "optional",
+								"elementType": {
+									"type": "reflection",
+									"declaration": {
+										"id": 429,
+										"name": "__type",
+										"kind": 65536,
+										"kindString": "Type literal",
+										"flags": {},
+										"sources": [
+											{
+												"fileName": "node_modules/@xyo-network/payload/dist/esm/models/Base.d.ts",
+												"line": 7,
+												"character": 107
+											}
+										]
+									}
+								}
+							},
+							{
+								"type": "optional",
+								"elementType": {
+									"type": "intrinsic",
+									"name": "boolean"
+								}
+							},
+							{
+								"type": "optional",
+								"elementType": {
+									"type": "reference",
+									"typeArguments": [
+										{
+											"type": "intrinsic",
+											"name": "any"
+										},
+										{
+											"type": "intrinsic",
+											"name": "any"
+										}
+									],
+									"name": "XyoApiError",
+									"qualifiedName": "XyoApiError",
+									"package": "@xyo-network/api"
+								}
+							},
+							{
+								"type": "optional",
+								"elementType": {
+									"type": "intrinsic",
+									"name": "boolean"
+								}
+							}
+						]
+					}
+				}
+			]
 		}
 	],
 	"groups": [
@@ -19017,17 +19564,29 @@
 			"title": "Interfaces",
 			"children": [
 				1,
+				405,
 				400,
 				11
 			]
 		},
+		{
+			"title": "Type Aliases",
+			"children": [
+				413,
+				412
+			]
+		},
 		{
 			"title": "Functions",
 			"children": [
 				3,
 				7,
 				392,
-				396
+				396,
+				407,
+				414,
+				421,
+				424
 			]
 		}
 	],
@@ -19036,7 +19595,7 @@
 			"fileName": "packages/sdk/packages/api/src/index.ts",
 			"line": 1,
 			"character": 0,
-			"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/98da10b5/packages/sdk/packages/api/src/index.ts#L1"
+			"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/bde02cc8/packages/sdk/packages/api/src/index.ts#L1"
 		}
 	]
 }