@xyo-network/value-payload-plugin 2.75.0 → 2.75.2

package/dist/docs.json

@@ -0,0 +1,760 @@
+{
+	"id": 0,
+	"name": "@xyo-network/value-payload-plugin",
+	"variant": "project",
+	"kind": 1,
+	"flags": {},
+	"children": [
+		{
+			"id": 26,
+			"name": "default",
+			"variant": "reference",
+			"kind": 8388608,
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "plugins/packages/payload/packages/value/src/index.ts",
+					"line": 10,
+					"character": 0,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/value/src/index.ts#L10"
+				}
+			],
+			"target": 1
+		},
+		{
+			"id": 8,
+			"name": "JsonArray",
+			"variant": "declaration",
+			"kind": 4194304,
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "plugins/packages/payload/packages/value/src/Payload.ts",
+					"line": 8,
+					"character": 12,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/value/src/Payload.ts#L8"
+				}
+			],
+			"type": {
+				"type": "array",
+				"elementType": {
+					"type": "reference",
+					"target": 3,
+					"name": "JsonValue",
+					"package": "@xyo-network/value-payload-plugin"
+				}
+			}
+		},
+		{
+			"id": 4,
+			"name": "JsonObject",
+			"variant": "declaration",
+			"kind": 4194304,
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "plugins/packages/payload/packages/value/src/Payload.ts",
+					"line": 7,
+					"character": 12,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/value/src/Payload.ts#L7"
+				}
+			],
+			"type": {
+				"type": "reflection",
+				"declaration": {
+					"id": 5,
+					"name": "__type",
+					"variant": "declaration",
+					"kind": 65536,
+					"flags": {},
+					"sources": [
+						{
+							"fileName": "plugins/packages/payload/packages/value/src/Payload.ts",
+							"line": 7,
+							"character": 25,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/value/src/Payload.ts#L7"
+						}
+					],
+					"indexSignature": {
+						"id": 6,
+						"name": "__index",
+						"variant": "signature",
+						"kind": 8192,
+						"flags": {},
+						"sources": [
+							{
+								"fileName": "plugins/packages/payload/packages/value/src/Payload.ts",
+								"line": 7,
+								"character": 27,
+								"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/value/src/Payload.ts#L7"
+							}
+						],
+						"parameters": [
+							{
+								"id": 7,
+								"name": "key",
+								"variant": "param",
+								"kind": 32768,
+								"flags": {},
+								"type": {
+									"type": "intrinsic",
+									"name": "string"
+								}
+							}
+						],
+						"type": {
+							"type": "reference",
+							"target": 3,
+							"name": "JsonValue",
+							"package": "@xyo-network/value-payload-plugin"
+						}
+					}
+				}
+			}
+		},
+		{
+			"id": 3,
+			"name": "JsonValue",
+			"variant": "declaration",
+			"kind": 4194304,
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "plugins/packages/payload/packages/value/src/Payload.ts",
+					"line": 6,
+					"character": 12,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/value/src/Payload.ts#L6"
+				}
+			],
+			"type": {
+				"type": "union",
+				"types": [
+					{
+						"type": "intrinsic",
+						"name": "string"
+					},
+					{
+						"type": "intrinsic",
+						"name": "number"
+					},
+					{
+						"type": "intrinsic",
+						"name": "boolean"
+					},
+					{
+						"type": "literal",
+						"value": null
+					},
+					{
+						"type": "reference",
+						"target": 4,
+						"name": "JsonObject",
+						"package": "@xyo-network/value-payload-plugin"
+					},
+					{
+						"type": "reference",
+						"target": 8,
+						"name": "JsonArray",
+						"package": "@xyo-network/value-payload-plugin"
+					}
+				]
+			}
+		},
+		{
+			"id": 9,
+			"name": "Value",
+			"variant": "declaration",
+			"kind": 4194304,
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "plugins/packages/payload/packages/value/src/Payload.ts",
+					"line": 10,
+					"character": 12,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/value/src/Payload.ts#L10"
+				}
+			],
+			"typeParameters": [
+				{
+					"id": 13,
+					"name": "T",
+					"variant": "typeParam",
+					"kind": 131072,
+					"flags": {},
+					"type": {
+						"type": "reference",
+						"target": 3,
+						"name": "JsonValue",
+						"package": "@xyo-network/value-payload-plugin"
+					},
+					"default": {
+						"type": "reference",
+						"target": 3,
+						"name": "JsonValue",
+						"package": "@xyo-network/value-payload-plugin"
+					}
+				}
+			],
+			"type": {
+				"type": "reference",
+				"target": {
+					"sourceFileName": "../../../../../protocol/packages/payload/packages/model/src/Payload.ts",
+					"qualifiedName": "Payload"
+				},
+				"typeArguments": [
+					{
+						"type": "reflection",
+						"declaration": {
+							"id": 10,
+							"name": "__type",
+							"variant": "declaration",
+							"kind": 65536,
+							"flags": {},
+							"children": [
+								{
+									"id": 11,
+									"name": "schema",
+									"variant": "declaration",
+									"kind": 1024,
+									"flags": {},
+									"sources": [
+										{
+											"fileName": "plugins/packages/payload/packages/value/src/Payload.ts",
+											"line": 11,
+											"character": 2,
+											"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/value/src/Payload.ts#L11"
+										}
+									],
+									"type": {
+										"type": "reference",
+										"target": 22,
+										"name": "ValueSchema",
+										"package": "@xyo-network/value-payload-plugin"
+									}
+								},
+								{
+									"id": 12,
+									"name": "value",
+									"variant": "declaration",
+									"kind": 1024,
+									"flags": {},
+									"sources": [
+										{
+											"fileName": "plugins/packages/payload/packages/value/src/Payload.ts",
+											"line": 12,
+											"character": 2,
+											"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/value/src/Payload.ts#L12"
+										}
+									],
+									"type": {
+										"type": "reference",
+										"target": -1,
+										"name": "T",
+										"refersToTypeParameter": true
+									}
+								}
+							],
+							"groups": [
+								{
+									"title": "Properties",
+									"children": [
+										11,
+										12
+									]
+								}
+							],
+							"sources": [
+								{
+									"fileName": "plugins/packages/payload/packages/value/src/Payload.ts",
+									"line": 10,
+									"character": 61,
+									"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/value/src/Payload.ts#L10"
+								}
+							]
+						}
+					}
+				],
+				"name": "Payload",
+				"package": "@xyo-network/payload-model"
+			}
+		},
+		{
+			"id": 23,
+			"name": "ValueSchema",
+			"variant": "declaration",
+			"kind": 4194304,
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "plugins/packages/payload/packages/value/src/Schema.ts",
+					"line": 1,
+					"character": 12,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/value/src/Schema.ts#L1"
+				},
+				{
+					"fileName": "plugins/packages/payload/packages/value/src/Schema.ts",
+					"line": 2,
+					"character": 13,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/value/src/Schema.ts#L2"
+				}
+			],
+			"type": {
+				"type": "literal",
+				"value": "network.xyo.value"
+			}
+		},
+		{
+			"id": 22,
+			"name": "ValueSchema",
+			"variant": "declaration",
+			"kind": 32,
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "plugins/packages/payload/packages/value/src/Schema.ts",
+					"line": 1,
+					"character": 12,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/value/src/Schema.ts#L1"
+				},
+				{
+					"fileName": "plugins/packages/payload/packages/value/src/Schema.ts",
+					"line": 2,
+					"character": 13,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/value/src/Schema.ts#L2"
+				}
+			],
+			"type": {
+				"type": "literal",
+				"value": "network.xyo.value"
+			}
+		},
+		{
+			"id": 1,
+			"name": "ValuePayloadPlugin",
+			"variant": "declaration",
+			"kind": 64,
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "plugins/packages/payload/packages/value/src/Plugin.ts",
+					"line": 7,
+					"character": 13,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/value/src/Plugin.ts#L7"
+				}
+			],
+			"signatures": [
+				{
+					"id": 2,
+					"name": "ValuePayloadPlugin",
+					"variant": "signature",
+					"kind": 4096,
+					"flags": {},
+					"sources": [
+						{
+							"fileName": "plugins/packages/payload/packages/value/src/Plugin.ts",
+							"line": 7,
+							"character": 34,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/value/src/Plugin.ts#L7"
+						}
+					],
+					"type": {
+						"type": "reference",
+						"target": {
+							"sourceFileName": "../../../../../sdk/packages/payload-plugin/src/Plugin.ts",
+							"qualifiedName": "PayloadPlugin"
+						},
+						"typeArguments": [
+							{
+								"type": "reference",
+								"target": 9,
+								"name": "Value",
+								"package": "@xyo-network/value-payload-plugin"
+							}
+						],
+						"name": "PayloadPlugin",
+						"package": "@xyo-network/payload-plugin"
+					}
+				}
+			]
+		},
+		{
+			"id": 14,
+			"name": "isValuePayload",
+			"variant": "declaration",
+			"kind": 64,
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "plugins/packages/payload/packages/value/src/Payload.ts",
+					"line": 15,
+					"character": 13,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/value/src/Payload.ts#L15"
+				}
+			],
+			"signatures": [
+				{
+					"id": 15,
+					"name": "isValuePayload",
+					"variant": "signature",
+					"kind": 4096,
+					"flags": {},
+					"sources": [
+						{
+							"fileName": "protocol/packages/payload/packages/model/dist/node/isPayloadOfSchemaType.d.ts",
+							"line": 4,
+							"character": 58
+						}
+					],
+					"parameters": [
+						{
+							"id": 16,
+							"name": "x",
+							"variant": "param",
+							"kind": 32768,
+							"flags": {},
+							"type": {
+								"type": "intersection",
+								"types": [
+									{
+										"type": "reflection",
+										"declaration": {
+											"id": 17,
+											"name": "__type",
+											"variant": "declaration",
+											"kind": 65536,
+											"flags": {},
+											"children": [
+												{
+													"id": 18,
+													"name": "schema",
+													"variant": "declaration",
+													"kind": 1024,
+													"flags": {},
+													"sources": [
+														{
+															"fileName": "protocol/packages/payload/packages/model/dist/node/Payload.d.ts",
+															"line": 23,
+															"character": 4
+														}
+													],
+													"type": {
+														"type": "intrinsic",
+														"name": "string"
+													}
+												}
+											],
+											"groups": [
+												{
+													"title": "Properties",
+													"children": [
+														18
+													]
+												}
+											],
+											"sources": [
+												{
+													"fileName": "protocol/packages/payload/packages/model/dist/node/Payload.d.ts",
+													"line": 22,
+													"character": 68
+												}
+											]
+										}
+									},
+									{
+										"type": "reference",
+										"target": {
+											"sourceFileName": "../../../../../protocol/packages/payload/packages/model/src/Payload.ts",
+											"qualifiedName": "PayloadFields"
+										},
+										"name": "PayloadFields",
+										"package": "@xyo-network/payload-model"
+									}
+								]
+							}
+						}
+					],
+					"type": {
+						"type": "predicate",
+						"name": "x",
+						"asserts": false,
+						"targetType": {
+							"type": "intersection",
+							"types": [
+								{
+									"type": "reference",
+									"target": {
+										"sourceFileName": "../../../../../protocol/packages/payload/packages/model/src/Payload.ts",
+										"qualifiedName": "SchemaFields"
+									},
+									"name": "SchemaFields",
+									"package": "@xyo-network/payload-model"
+								},
+								{
+									"type": "reference",
+									"target": {
+										"sourceFileName": "../../../../../protocol/packages/payload/packages/model/src/Payload.ts",
+										"qualifiedName": "PayloadFields"
+									},
+									"name": "PayloadFields",
+									"package": "@xyo-network/payload-model"
+								},
+								{
+									"type": "reflection",
+									"declaration": {
+										"id": 19,
+										"name": "__type",
+										"variant": "declaration",
+										"kind": 65536,
+										"flags": {},
+										"children": [
+											{
+												"id": 20,
+												"name": "schema",
+												"variant": "declaration",
+												"kind": 1024,
+												"flags": {},
+												"sources": [
+													{
+														"fileName": "plugins/packages/payload/packages/value/src/Payload.ts",
+														"line": 11,
+														"character": 2,
+														"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/value/src/Payload.ts#L11"
+													}
+												],
+												"type": {
+													"type": "literal",
+													"value": "network.xyo.value"
+												}
+											},
+											{
+												"id": 21,
+												"name": "value",
+												"variant": "declaration",
+												"kind": 1024,
+												"flags": {},
+												"sources": [
+													{
+														"fileName": "plugins/packages/payload/packages/value/src/Payload.ts",
+														"line": 12,
+														"character": 2,
+														"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/value/src/Payload.ts#L12"
+													}
+												],
+												"type": {
+													"type": "reference",
+													"target": 3,
+													"name": "JsonValue",
+													"package": "@xyo-network/value-payload-plugin"
+												}
+											}
+										],
+										"groups": [
+											{
+												"title": "Properties",
+												"children": [
+													20,
+													21
+												]
+											}
+										],
+										"sources": [
+											{
+												"fileName": "plugins/packages/payload/packages/value/src/Payload.ts",
+												"line": 10,
+												"character": 61,
+												"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/value/src/Payload.ts#L10"
+											}
+										]
+									}
+								}
+							]
+						}
+					}
+				}
+			]
+		},
+		{
+			"id": 24,
+			"name": "valuePayloadTemplate",
+			"variant": "declaration",
+			"kind": 64,
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "plugins/packages/payload/packages/value/src/Template.ts",
+					"line": 4,
+					"character": 13,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/value/src/Template.ts#L4"
+				}
+			],
+			"signatures": [
+				{
+					"id": 25,
+					"name": "valuePayloadTemplate",
+					"variant": "signature",
+					"kind": 4096,
+					"flags": {},
+					"sources": [
+						{
+							"fileName": "plugins/packages/payload/packages/value/src/Template.ts",
+							"line": 4,
+							"character": 36,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/value/src/Template.ts#L4"
+						}
+					],
+					"type": {
+						"type": "reference",
+						"target": 9,
+						"name": "Value",
+						"package": "@xyo-network/value-payload-plugin"
+					}
+				}
+			]
+		}
+	],
+	"groups": [
+		{
+			"title": "References",
+			"children": [
+				26
+			]
+		},
+		{
+			"title": "Type Aliases",
+			"children": [
+				8,
+				4,
+				3,
+				9,
+				23
+			]
+		},
+		{
+			"title": "Variables",
+			"children": [
+				22
+			]
+		},
+		{
+			"title": "Functions",
+			"children": [
+				1,
+				14,
+				24
+			]
+		}
+	],
+	"packageName": "@xyo-network/value-payload-plugin",
+	"readme": [
+		{
+			"kind": "text",
+			"text": "[![logo][]](https://xyo.network)\n\nPart of [sdk-xyo-clint-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)\n\n## License\n\n> See the [LICENSE](LICENSE) file for license details\n\n## Credits\n\n[Made with 🔥 and ❄️ by XYO](https://xyo.network)\n\n[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png"
+		}
+	],
+	"symbolIdMap": {
+		"0": {
+			"sourceFileName": "src/index.ts",
+			"qualifiedName": ""
+		},
+		"1": {
+			"sourceFileName": "src/Plugin.ts",
+			"qualifiedName": "ValuePayloadPlugin"
+		},
+		"2": {
+			"sourceFileName": "src/Plugin.ts",
+			"qualifiedName": "ValuePayloadPlugin"
+		},
+		"3": {
+			"sourceFileName": "src/Payload.ts",
+			"qualifiedName": "JsonValue"
+		},
+		"4": {
+			"sourceFileName": "src/Payload.ts",
+			"qualifiedName": "JsonObject"
+		},
+		"5": {
+			"sourceFileName": "src/Payload.ts",
+			"qualifiedName": "__type"
+		},
+		"6": {
+			"sourceFileName": "src/Payload.ts",
+			"qualifiedName": "__type.__index"
+		},
+		"8": {
+			"sourceFileName": "src/Payload.ts",
+			"qualifiedName": "JsonArray"
+		},
+		"9": {
+			"sourceFileName": "src/Payload.ts",
+			"qualifiedName": "Value"
+		},
+		"10": {
+			"sourceFileName": "src/Payload.ts",
+			"qualifiedName": "__type"
+		},
+		"11": {
+			"sourceFileName": "src/Payload.ts",
+			"qualifiedName": "__type.schema"
+		},
+		"12": {
+			"sourceFileName": "src/Payload.ts",
+			"qualifiedName": "__type.value"
+		},
+		"13": {
+			"sourceFileName": "src/Payload.ts",
+			"qualifiedName": "T"
+		},
+		"14": {
+			"sourceFileName": "src/Payload.ts",
+			"qualifiedName": "isValuePayload"
+		},
+		"15": {
+			"sourceFileName": "../../../../../protocol/packages/payload/packages/model/src/isPayloadOfSchemaType.ts",
+			"qualifiedName": "isValuePayload"
+		},
+		"16": {
+			"sourceFileName": "../../../../../protocol/packages/payload/packages/model/src/isPayloadOfSchemaType.ts",
+			"qualifiedName": "x"
+		},
+		"17": {
+			"sourceFileName": "../../../../../protocol/packages/payload/packages/model/src/Payload.ts",
+			"qualifiedName": "__type"
+		},
+		"18": {
+			"sourceFileName": "../../../../../protocol/packages/payload/packages/model/src/Payload.ts",
+			"qualifiedName": "__type.schema"
+		},
+		"19": {
+			"sourceFileName": "src/Payload.ts",
+			"qualifiedName": "__type"
+		},
+		"20": {
+			"sourceFileName": "src/Payload.ts",
+			"qualifiedName": "__type.schema"
+		},
+		"21": {
+			"sourceFileName": "src/Payload.ts",
+			"qualifiedName": "__type.value"
+		},
+		"22": {
+			"sourceFileName": "src/Schema.ts",
+			"qualifiedName": "ValueSchema"
+		},
+		"23": {
+			"sourceFileName": "src/Schema.ts",
+			"qualifiedName": "ValueSchema"
+		},
+		"24": {
+			"sourceFileName": "src/Template.ts",
+			"qualifiedName": "valuePayloadTemplate"
+		},
+		"25": {
+			"sourceFileName": "src/Template.ts",
+			"qualifiedName": "valuePayloadTemplate"
+		},
+		"26": {
+			"sourceFileName": "src/index.ts",
+			"qualifiedName": "default"
+		}
+	}
+}