@xyo-network/react-embed 2.31.2 → 2.31.5

package/dist/docs.json

@@ -8,39 +8,763 @@
 	"children": [
 		{
 			"id": 1,
+			"name": "XyoEmbedPluginCardProps",
+			"kind": 256,
+			"kindString": "Interface",
+			"flags": {},
+			"children": [
+				{
+					"id": 14,
+					"name": "busy",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isOptional": true
+					},
+					"sources": [
+						{
+							"fileName": "packages/sdk/packages/embed/src/components/embed-card/card/BusyCard.tsx",
+							"line": 13,
+							"character": 2,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/f2f48c724/packages/sdk/packages/embed/src/components/embed-card/card/BusyCard.tsx#L13"
+						}
+					],
+					"type": {
+						"type": "intrinsic",
+						"name": "boolean"
+					},
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "BusyCardProps.busy"
+					}
+				},
+				{
+					"id": 15,
+					"name": "busyMinimum",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isOptional": true
+					},
+					"sources": [
+						{
+							"fileName": "packages/sdk/packages/embed/src/components/embed-card/card/BusyCard.tsx",
+							"line": 14,
+							"character": 2,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/f2f48c724/packages/sdk/packages/embed/src/components/embed-card/card/BusyCard.tsx#L14"
+						}
+					],
+					"type": {
+						"type": "intrinsic",
+						"name": "number"
+					},
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "BusyCardProps.busyMinimum"
+					}
+				},
+				{
+					"id": 16,
+					"name": "busyVariant",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isOptional": true
+					},
+					"sources": [
+						{
+							"fileName": "packages/sdk/packages/embed/src/components/embed-card/card/BusyCard.tsx",
+							"line": 15,
+							"character": 2,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/f2f48c724/packages/sdk/packages/embed/src/components/embed-card/card/BusyCard.tsx#L15"
+						}
+					],
+					"type": {
+						"type": "reference",
+						"name": "BusyVariant",
+						"qualifiedName": "BusyVariant",
+						"package": "@xylabs/react-shared"
+					},
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "BusyCardProps.busyVariant"
+					}
+				},
+				{
+					"id": 17,
+					"name": "busyVariantProps",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isOptional": true
+					},
+					"sources": [
+						{
+							"fileName": "packages/sdk/packages/embed/src/components/embed-card/card/BusyCard.tsx",
+							"line": 16,
+							"character": 2,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/f2f48c724/packages/sdk/packages/embed/src/components/embed-card/card/BusyCard.tsx#L16"
+						}
+					],
+					"type": {
+						"type": "union",
+						"types": [
+							{
+								"type": "reference",
+								"name": "BusyCircularProgressProps",
+								"qualifiedName": "BusyCircularProgressProps",
+								"package": "@xylabs/react-shared"
+							},
+							{
+								"type": "reference",
+								"name": "BusyLinearProgressProps",
+								"qualifiedName": "BusyLinearProgressProps",
+								"package": "@xylabs/react-shared"
+							}
+						]
+					},
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "BusyCardProps.busyVariantProps"
+					}
+				},
+				{
+					"id": 10,
+					"name": "embedPluginConfig",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isOptional": true
+					},
+					"comment": {
+						"summary": [
+							{
+								"kind": "text",
+								"text": "XyoEmbedPlugin component configuration"
+							}
+						]
+					},
+					"sources": [
+						{
+							"fileName": "packages/sdk/packages/embed/src/contexts/XyoEmbedPluginContext/State.ts",
+							"line": 25,
+							"character": 2,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/f2f48c724/packages/sdk/packages/embed/src/contexts/XyoEmbedPluginContext/State.ts#L25"
+						}
+					],
+					"type": {
+						"type": "reference",
+						"name": "XyoPluginConfig"
+					},
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "XyoEmbedPluginProps.embedPluginConfig"
+					}
+				},
+				{
+					"id": 8,
+					"name": "hideElementsConfig",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isOptional": true
+					},
+					"sources": [
+						{
+							"fileName": "packages/sdk/packages/embed/src/types/XyoEmbedPluginProps.ts",
+							"line": 10,
+							"character": 2,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/f2f48c724/packages/sdk/packages/embed/src/types/XyoEmbedPluginProps.ts#L10"
+						}
+					],
+					"type": {
+						"type": "reference",
+						"name": "EmbedPluginVisibilityConfig"
+					},
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "XyoEmbedPluginProps.hideElementsConfig"
+					}
+				},
+				{
+					"id": 11,
+					"name": "huri",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isOptional": true
+					},
+					"comment": {
+						"summary": [],
+						"blockTags": [
+							{
+								"tag": "@deprecated",
+								"content": [
+									{
+										"kind": "text",
+										"text": "use huriPayload"
+									}
+								]
+							}
+						]
+					},
+					"sources": [
+						{
+							"fileName": "packages/sdk/packages/embed/src/contexts/XyoEmbedPluginContext/State.ts",
+							"line": 27,
+							"character": 2,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/f2f48c724/packages/sdk/packages/embed/src/contexts/XyoEmbedPluginContext/State.ts#L27"
+						}
+					],
+					"type": {
+						"type": "intrinsic",
+						"name": "string"
+					},
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "XyoEmbedPluginProps.huri"
+					}
+				},
+				{
+					"id": 5,
+					"name": "huriPayload",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isOptional": true
+					},
+					"sources": [
+						{
+							"fileName": "packages/sdk/packages/embed/src/types/XyoEmbedPluginProps.ts",
+							"line": 8,
+							"character": 2,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/f2f48c724/packages/sdk/packages/embed/src/types/XyoEmbedPluginProps.ts#L8"
+						}
+					],
+					"type": {
+						"type": "union",
+						"types": [
+							{
+								"type": "intrinsic",
+								"name": "string"
+							},
+							{
+								"type": "reflection",
+								"declaration": {
+									"id": 6,
+									"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
+										}
+									]
+								}
+							}
+						]
+					},
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "XyoEmbedPluginProps.huriPayload"
+					}
+				},
+				{
+					"id": 2,
+					"name": "onRefresh",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isOptional": true
+					},
+					"sources": [
+						{
+							"fileName": "packages/sdk/packages/embed/src/types/XyoEmbedPluginProps.ts",
+							"line": 7,
+							"character": 2,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/f2f48c724/packages/sdk/packages/embed/src/types/XyoEmbedPluginProps.ts#L7"
+						}
+					],
+					"type": {
+						"type": "reflection",
+						"declaration": {
+							"id": 3,
+							"name": "__type",
+							"kind": 65536,
+							"kindString": "Type literal",
+							"flags": {},
+							"sources": [
+								{
+									"fileName": "packages/sdk/packages/embed/src/types/XyoEmbedPluginProps.ts",
+									"line": 7,
+									"character": 14,
+									"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/f2f48c724/packages/sdk/packages/embed/src/types/XyoEmbedPluginProps.ts#L7"
+								}
+							],
+							"signatures": [
+								{
+									"id": 4,
+									"name": "__type",
+									"kind": 4096,
+									"kindString": "Call signature",
+									"flags": {},
+									"comment": {
+										"summary": [
+											{
+												"kind": "text",
+												"text": "string for huri to resolve and payload for bypassing huri resolution"
+											}
+										]
+									},
+									"type": {
+										"type": "intrinsic",
+										"name": "void"
+									}
+								}
+							]
+						}
+					},
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "XyoEmbedPluginProps.onRefresh"
+					}
+				},
+				{
+					"id": 9,
+					"name": "plugins",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isOptional": true
+					},
+					"sources": [
+						{
+							"fileName": "packages/sdk/packages/embed/src/contexts/XyoEmbedPluginContext/State.ts",
+							"line": 23,
+							"character": 2,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/f2f48c724/packages/sdk/packages/embed/src/contexts/XyoEmbedPluginContext/State.ts#L23"
+						}
+					],
+					"type": {
+						"type": "array",
+						"elementType": {
+							"type": "reference",
+							"name": "XyoPayloadRenderPlugin"
+						}
+					},
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "XyoEmbedPluginProps.plugins"
+					}
+				},
+				{
+					"id": 12,
+					"name": "refreshTitle",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isOptional": true
+					},
+					"sources": [
+						{
+							"fileName": "packages/sdk/packages/embed/src/contexts/XyoEmbedPluginContext/State.ts",
+							"line": 28,
+							"character": 2,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/f2f48c724/packages/sdk/packages/embed/src/contexts/XyoEmbedPluginContext/State.ts#L28"
+						}
+					],
+					"type": {
+						"type": "intrinsic",
+						"name": "string"
+					},
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "XyoEmbedPluginProps.refreshTitle"
+					}
+				},
+				{
+					"id": 13,
+					"name": "timestampLabel",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isOptional": true
+					},
+					"sources": [
+						{
+							"fileName": "packages/sdk/packages/embed/src/contexts/XyoEmbedPluginContext/State.ts",
+							"line": 29,
+							"character": 2,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/f2f48c724/packages/sdk/packages/embed/src/contexts/XyoEmbedPluginContext/State.ts#L29"
+						}
+					],
+					"type": {
+						"type": "intrinsic",
+						"name": "string"
+					},
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "XyoEmbedPluginProps.timestampLabel"
+					}
+				},
+				{
+					"id": 7,
+					"name": "validateSchema",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isOptional": true
+					},
+					"sources": [
+						{
+							"fileName": "packages/sdk/packages/embed/src/types/XyoEmbedPluginProps.ts",
+							"line": 9,
+							"character": 2,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/f2f48c724/packages/sdk/packages/embed/src/types/XyoEmbedPluginProps.ts#L9"
+						}
+					],
+					"type": {
+						"type": "intrinsic",
+						"name": "boolean"
+					},
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "XyoEmbedPluginProps.validateSchema"
+					}
+				}
+			],
+			"groups": [
+				{
+					"title": "Properties",
+					"children": [
+						14,
+						15,
+						16,
+						17,
+						10,
+						8,
+						11,
+						5,
+						2,
+						9,
+						12,
+						13,
+						7
+					]
+				}
+			],
+			"sources": [
+				{
+					"fileName": "packages/sdk/packages/embed/src/components/embed-card/XyoEmbedPluginCard.tsx",
+					"line": 10,
+					"character": 17,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/f2f48c724/packages/sdk/packages/embed/src/components/embed-card/XyoEmbedPluginCard.tsx#L10"
+				}
+			],
+			"extendedTypes": [
+				{
+					"type": "reference",
+					"name": "WithChildren",
+					"qualifiedName": "WithChildren",
+					"package": "@xylabs/react-shared"
+				},
+				{
+					"type": "reference",
+					"name": "XyoEmbedPluginProps"
+				},
+				{
+					"type": "reference",
+					"name": "BusyCardProps"
+				}
+			]
+		},
+		{
+			"id": 26,
 			"name": "XyoEmbedPlugin",
 			"kind": 64,
 			"kindString": "Function",
 			"flags": {},
 			"sources": [
 				{
-					"fileName": "packages/sdk/packages/embed/src/components/XyoEmbedPlugin.tsx",
-					"line": 9,
+					"fileName": "packages/sdk/packages/embed/src/components/embed-card/XyoEmbedPluginCard.tsx",
+					"line": 61,
 					"character": 13,
-					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/ec6e69a6/packages/sdk/packages/embed/src/components/XyoEmbedPlugin.tsx#L9"
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/f2f48c724/packages/sdk/packages/embed/src/components/embed-card/XyoEmbedPluginCard.tsx#L61"
 				}
 			],
 			"signatures": [
 				{
-					"id": 2,
+					"id": 27,
 					"name": "XyoEmbedPlugin",
 					"kind": 4096,
 					"kindString": "Call signature",
 					"flags": {},
+					"comment": {
+						"summary": [],
+						"blockTags": [
+							{
+								"tag": "@deprecated",
+								"content": [
+									{
+										"kind": "text",
+										"text": "- use XyoEmbedPluginCard and use CardProps instead of FlexBoxProps"
+									}
+								]
+							}
+						]
+					},
 					"parameters": [
 						{
-							"id": 3,
+							"id": 28,
+							"name": "props",
+							"kind": 32768,
+							"kindString": "Parameter",
+							"flags": {},
+							"type": {
+								"type": "reference",
+								"id": 1,
+								"name": "XyoEmbedPluginCardProps"
+							}
+						},
+						{
+							"id": 29,
+							"name": "context",
+							"kind": 32768,
+							"kindString": "Parameter",
+							"flags": {
+								"isOptional": true
+							},
+							"type": {
+								"type": "intrinsic",
+								"name": "any"
+							}
+						}
+					],
+					"type": {
+						"type": "union",
+						"types": [
+							{
+								"type": "literal",
+								"value": null
+							},
+							{
+								"type": "reference",
+								"typeArguments": [
+									{
+										"type": "intrinsic",
+										"name": "any"
+									},
+									{
+										"type": "intrinsic",
+										"name": "any"
+									}
+								],
+								"name": "ReactElement",
+								"qualifiedName": "React.ReactElement",
+								"package": "@types/react"
+							}
+						]
+					}
+				}
+			]
+		},
+		{
+			"id": 18,
+			"name": "XyoEmbedPluginCard",
+			"kind": 64,
+			"kindString": "Function",
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "packages/sdk/packages/embed/src/components/embed-card/XyoEmbedPluginCard.tsx",
+					"line": 12,
+					"character": 13,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/f2f48c724/packages/sdk/packages/embed/src/components/embed-card/XyoEmbedPluginCard.tsx#L12"
+				}
+			],
+			"signatures": [
+				{
+					"id": 19,
+					"name": "XyoEmbedPluginCard",
+					"kind": 4096,
+					"kindString": "Call signature",
+					"flags": {},
+					"parameters": [
+						{
+							"id": 20,
 							"name": "props",
 							"kind": 32768,
 							"kindString": "Parameter",
 							"flags": {},
 							"type": {
 								"type": "reference",
-								"name": "XyoEmbedPluginProps"
+								"id": 1,
+								"name": "XyoEmbedPluginCardProps"
 							}
 						},
 						{
-							"id": 4,
+							"id": 21,
+							"name": "context",
+							"kind": 32768,
+							"kindString": "Parameter",
+							"flags": {
+								"isOptional": true
+							},
+							"type": {
+								"type": "intrinsic",
+								"name": "any"
+							}
+						}
+					],
+					"type": {
+						"type": "union",
+						"types": [
+							{
+								"type": "literal",
+								"value": null
+							},
+							{
+								"type": "reference",
+								"typeArguments": [
+									{
+										"type": "intrinsic",
+										"name": "any"
+									},
+									{
+										"type": "intrinsic",
+										"name": "any"
+									}
+								],
+								"name": "ReactElement",
+								"qualifiedName": "React.ReactElement",
+								"package": "@types/react"
+							}
+						]
+					}
+				}
+			]
+		},
+		{
+			"id": 22,
+			"name": "XyoEmbedPluginCardInner",
+			"kind": 64,
+			"kindString": "Function",
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "packages/sdk/packages/embed/src/components/embed-card/XyoEmbedPluginCard.tsx",
+					"line": 44,
+					"character": 13,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/f2f48c724/packages/sdk/packages/embed/src/components/embed-card/XyoEmbedPluginCard.tsx#L44"
+				}
+			],
+			"signatures": [
+				{
+					"id": 23,
+					"name": "XyoEmbedPluginCardInner",
+					"kind": 4096,
+					"kindString": "Call signature",
+					"flags": {},
+					"parameters": [
+						{
+							"id": 24,
+							"name": "props",
+							"kind": 32768,
+							"kindString": "Parameter",
+							"flags": {},
+							"type": {
+								"type": "reference",
+								"name": "BusyCardProps"
+							}
+						},
+						{
+							"id": 25,
+							"name": "context",
+							"kind": 32768,
+							"kindString": "Parameter",
+							"flags": {
+								"isOptional": true
+							},
+							"type": {
+								"type": "intrinsic",
+								"name": "any"
+							}
+						}
+					],
+					"type": {
+						"type": "union",
+						"types": [
+							{
+								"type": "literal",
+								"value": null
+							},
+							{
+								"type": "reference",
+								"typeArguments": [
+									{
+										"type": "intrinsic",
+										"name": "any"
+									},
+									{
+										"type": "intrinsic",
+										"name": "any"
+									}
+								],
+								"name": "ReactElement",
+								"qualifiedName": "React.ReactElement",
+								"package": "@types/react"
+							}
+						]
+					}
+				}
+			]
+		},
+		{
+			"id": 30,
+			"name": "XyoEmbedPluginInner",
+			"kind": 64,
+			"kindString": "Function",
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "packages/sdk/packages/embed/src/components/XyoEmbedPlugin.tsx",
+					"line": 10,
+					"character": 13,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/f2f48c724/packages/sdk/packages/embed/src/components/XyoEmbedPlugin.tsx#L10"
+				}
+			],
+			"signatures": [
+				{
+					"id": 31,
+					"name": "XyoEmbedPluginInner",
+					"kind": 4096,
+					"kindString": "Call signature",
+					"flags": {},
+					"parameters": [
+						{
+							"id": 32,
+							"name": "props",
+							"kind": 32768,
+							"kindString": "Parameter",
+							"flags": {},
+							"type": {
+								"type": "reference",
+								"typeArguments": [
+									{
+										"type": "reference",
+										"name": "XyoEmbedPluginProps"
+									}
+								],
+								"name": "WithChildren",
+								"qualifiedName": "WithChildren",
+								"package": "@xylabs/react-shared"
+							}
+						},
+						{
+							"id": 33,
 							"name": "context",
 							"kind": 32768,
 							"kindString": "Parameter",
@@ -84,10 +808,19 @@
 	],
 	"groups": [
 		{
-			"title": "Functions",
+			"title": "Interfaces",
 			"children": [
 				1
 			]
+		},
+		{
+			"title": "Functions",
+			"children": [
+				26,
+				18,
+				22,
+				30
+			]
 		}
 	],
 	"sources": [
@@ -95,7 +828,7 @@
 			"fileName": "packages/sdk/packages/embed/src/index.ts",
 			"line": 1,
 			"character": 0,
-			"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/ec6e69a6/packages/sdk/packages/embed/src/index.ts#L1"
+			"url": "https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/f2f48c724/packages/sdk/packages/embed/src/index.ts#L1"
 		}
 	]
 }