@xyo-network/module-instance-payload-plugin 2.75.0 → 2.75.2

package/dist/docs.json

@@ -0,0 +1,734 @@
+{
+	"id": 0,
+	"name": "@xyo-network/module-instance-payload-plugin",
+	"variant": "project",
+	"kind": 1,
+	"flags": {},
+	"children": [
+		{
+			"id": 22,
+			"name": "default",
+			"variant": "reference",
+			"kind": 8388608,
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "index.ts",
+					"line": 10,
+					"character": 0,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/module-instance/src/index.ts#L10"
+				}
+			],
+			"target": 1
+		},
+		{
+			"id": 7,
+			"name": "AbstractModuleInstanceQueryConfig",
+			"variant": "declaration",
+			"kind": 256,
+			"flags": {},
+			"children": [
+				{
+					"id": 8,
+					"name": "cost",
+					"variant": "declaration",
+					"kind": 1024,
+					"flags": {
+						"isOptional": true
+					},
+					"sources": [
+						{
+							"fileName": "Payload.ts",
+							"line": 6,
+							"character": 2,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/module-instance/src/Payload.ts#L6"
+						}
+					],
+					"type": {
+						"type": "intrinsic",
+						"name": "string"
+					}
+				}
+			],
+			"groups": [
+				{
+					"title": "Properties",
+					"children": [
+						8
+					]
+				}
+			],
+			"sources": [
+				{
+					"fileName": "Payload.ts",
+					"line": 5,
+					"character": 17,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/module-instance/src/Payload.ts#L5"
+				}
+			]
+		},
+		{
+			"id": 9,
+			"name": "AbstractModuleInstancePayload",
+			"variant": "declaration",
+			"kind": 4194304,
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "Payload.ts",
+					"line": 9,
+					"character": 12,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/module-instance/src/Payload.ts#L9"
+				}
+			],
+			"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": "address",
+									"variant": "declaration",
+									"kind": 1024,
+									"flags": {},
+									"sources": [
+										{
+											"fileName": "Payload.ts",
+											"line": 10,
+											"character": 2,
+											"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/module-instance/src/Payload.ts#L10"
+										}
+									],
+									"type": {
+										"type": "intrinsic",
+										"name": "string"
+									}
+								},
+								{
+									"id": 12,
+									"name": "queries",
+									"variant": "declaration",
+									"kind": 1024,
+									"flags": {
+										"isOptional": true
+									},
+									"sources": [
+										{
+											"fileName": "Payload.ts",
+											"line": 11,
+											"character": 2,
+											"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/module-instance/src/Payload.ts#L11"
+										}
+									],
+									"type": {
+										"type": "reference",
+										"target": {
+											"sourceFileName": "../../../../../../node_modules/typescript/lib/lib.es5.d.ts",
+											"qualifiedName": "Record"
+										},
+										"typeArguments": [
+											{
+												"type": "intrinsic",
+												"name": "string"
+											},
+											{
+												"type": "reference",
+												"target": 7,
+												"name": "AbstractModuleInstanceQueryConfig",
+												"package": "@xyo-network/module-instance-payload-plugin"
+											}
+										],
+										"name": "Record",
+										"package": "typescript"
+									}
+								},
+								{
+									"id": 13,
+									"name": "schema",
+									"variant": "declaration",
+									"kind": 1024,
+									"flags": {},
+									"sources": [
+										{
+											"fileName": "Payload.ts",
+											"line": 12,
+											"character": 2,
+											"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/module-instance/src/Payload.ts#L12"
+										}
+									],
+									"type": {
+										"type": "reference",
+										"target": 14,
+										"name": "AbstractModuleInstanceSchema",
+										"package": "@xyo-network/module-instance-payload-plugin"
+									}
+								}
+							],
+							"groups": [
+								{
+									"title": "Properties",
+									"children": [
+										11,
+										12,
+										13
+									]
+								}
+							],
+							"sources": [
+								{
+									"fileName": "Payload.ts",
+									"line": 9,
+									"character": 52,
+									"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/module-instance/src/Payload.ts#L9"
+								}
+							]
+						}
+					}
+				],
+				"name": "Payload",
+				"package": "@xyo-network/payload-model"
+			}
+		},
+		{
+			"id": 15,
+			"name": "AbstractModuleInstanceSchema",
+			"variant": "declaration",
+			"kind": 4194304,
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "Schema.ts",
+					"line": 1,
+					"character": 12,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/module-instance/src/Schema.ts#L1"
+				},
+				{
+					"fileName": "Schema.ts",
+					"line": 2,
+					"character": 13,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/module-instance/src/Schema.ts#L2"
+				}
+			],
+			"type": {
+				"type": "literal",
+				"value": "network.xyo.module.instance"
+			}
+		},
+		{
+			"id": 14,
+			"name": "AbstractModuleInstanceSchema",
+			"variant": "declaration",
+			"kind": 32,
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "Schema.ts",
+					"line": 1,
+					"character": 12,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/module-instance/src/Schema.ts#L1"
+				},
+				{
+					"fileName": "Schema.ts",
+					"line": 2,
+					"character": 13,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/module-instance/src/Schema.ts#L2"
+				}
+			],
+			"type": {
+				"type": "literal",
+				"value": "network.xyo.module.instance"
+			}
+		},
+		{
+			"id": 1,
+			"name": "ModuleInstancePayloadPlugin",
+			"variant": "declaration",
+			"kind": 64,
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "Plugin.ts",
+					"line": 7,
+					"character": 13,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/module-instance/src/Plugin.ts#L7"
+				}
+			],
+			"signatures": [
+				{
+					"id": 2,
+					"name": "ModuleInstancePayloadPlugin",
+					"variant": "signature",
+					"kind": 4096,
+					"flags": {},
+					"sources": [
+						{
+							"fileName": "Plugin.ts",
+							"line": 7,
+							"character": 43,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/module-instance/src/Plugin.ts#L7"
+						}
+					],
+					"type": {
+						"type": "reference",
+						"target": {
+							"sourceFileName": "../../../../../sdk/packages/payload-plugin/src/Plugin.ts",
+							"qualifiedName": "PayloadPlugin"
+						},
+						"typeArguments": [
+							{
+								"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": 3,
+											"name": "__type",
+											"variant": "declaration",
+											"kind": 65536,
+											"flags": {},
+											"children": [
+												{
+													"id": 4,
+													"name": "address",
+													"variant": "declaration",
+													"kind": 1024,
+													"flags": {},
+													"sources": [
+														{
+															"fileName": "Payload.ts",
+															"line": 10,
+															"character": 2,
+															"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/module-instance/src/Payload.ts#L10"
+														}
+													],
+													"type": {
+														"type": "intrinsic",
+														"name": "string"
+													}
+												},
+												{
+													"id": 5,
+													"name": "queries",
+													"variant": "declaration",
+													"kind": 1024,
+													"flags": {
+														"isOptional": true
+													},
+													"sources": [
+														{
+															"fileName": "Payload.ts",
+															"line": 11,
+															"character": 2,
+															"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/module-instance/src/Payload.ts#L11"
+														}
+													],
+													"type": {
+														"type": "reference",
+														"target": {
+															"sourceFileName": "../../../../../../node_modules/typescript/lib/lib.es5.d.ts",
+															"qualifiedName": "Record"
+														},
+														"typeArguments": [
+															{
+																"type": "intrinsic",
+																"name": "string"
+															},
+															{
+																"type": "reference",
+																"target": 7,
+																"name": "AbstractModuleInstanceQueryConfig",
+																"package": "@xyo-network/module-instance-payload-plugin"
+															}
+														],
+														"name": "Record",
+														"package": "typescript"
+													}
+												},
+												{
+													"id": 6,
+													"name": "schema",
+													"variant": "declaration",
+													"kind": 1024,
+													"flags": {},
+													"sources": [
+														{
+															"fileName": "Payload.ts",
+															"line": 12,
+															"character": 2,
+															"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/module-instance/src/Payload.ts#L12"
+														}
+													],
+													"type": {
+														"type": "literal",
+														"value": "network.xyo.module.instance"
+													}
+												}
+											],
+											"groups": [
+												{
+													"title": "Properties",
+													"children": [
+														4,
+														5,
+														6
+													]
+												}
+											],
+											"sources": [
+												{
+													"fileName": "Payload.ts",
+													"line": 9,
+													"character": 52,
+													"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/module-instance/src/Payload.ts#L9"
+												}
+											]
+										}
+									}
+								]
+							}
+						],
+						"name": "PayloadPlugin",
+						"package": "@xyo-network/payload-plugin"
+					}
+				}
+			]
+		},
+		{
+			"id": 16,
+			"name": "moduleInstancePayloadTemplate",
+			"variant": "declaration",
+			"kind": 64,
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "Template.ts",
+					"line": 4,
+					"character": 13,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/module-instance/src/Template.ts#L4"
+				}
+			],
+			"signatures": [
+				{
+					"id": 17,
+					"name": "moduleInstancePayloadTemplate",
+					"variant": "signature",
+					"kind": 4096,
+					"flags": {},
+					"sources": [
+						{
+							"fileName": "Template.ts",
+							"line": 4,
+							"character": 45,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/module-instance/src/Template.ts#L4"
+						}
+					],
+					"type": {
+						"type": "reference",
+						"target": {
+							"sourceFileName": "../../../../../../node_modules/typescript/lib/lib.es5.d.ts",
+							"qualifiedName": "Partial"
+						},
+						"typeArguments": [
+							{
+								"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": 18,
+											"name": "__type",
+											"variant": "declaration",
+											"kind": 65536,
+											"flags": {},
+											"children": [
+												{
+													"id": 19,
+													"name": "address",
+													"variant": "declaration",
+													"kind": 1024,
+													"flags": {},
+													"sources": [
+														{
+															"fileName": "Payload.ts",
+															"line": 10,
+															"character": 2,
+															"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/module-instance/src/Payload.ts#L10"
+														}
+													],
+													"type": {
+														"type": "intrinsic",
+														"name": "string"
+													}
+												},
+												{
+													"id": 20,
+													"name": "queries",
+													"variant": "declaration",
+													"kind": 1024,
+													"flags": {
+														"isOptional": true
+													},
+													"sources": [
+														{
+															"fileName": "Payload.ts",
+															"line": 11,
+															"character": 2,
+															"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/module-instance/src/Payload.ts#L11"
+														}
+													],
+													"type": {
+														"type": "reference",
+														"target": {
+															"sourceFileName": "../../../../../../node_modules/typescript/lib/lib.es5.d.ts",
+															"qualifiedName": "Record"
+														},
+														"typeArguments": [
+															{
+																"type": "intrinsic",
+																"name": "string"
+															},
+															{
+																"type": "reference",
+																"target": 7,
+																"name": "AbstractModuleInstanceQueryConfig",
+																"package": "@xyo-network/module-instance-payload-plugin"
+															}
+														],
+														"name": "Record",
+														"package": "typescript"
+													}
+												},
+												{
+													"id": 21,
+													"name": "schema",
+													"variant": "declaration",
+													"kind": 1024,
+													"flags": {},
+													"sources": [
+														{
+															"fileName": "Payload.ts",
+															"line": 12,
+															"character": 2,
+															"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/module-instance/src/Payload.ts#L12"
+														}
+													],
+													"type": {
+														"type": "literal",
+														"value": "network.xyo.module.instance"
+													}
+												}
+											],
+											"groups": [
+												{
+													"title": "Properties",
+													"children": [
+														19,
+														20,
+														21
+													]
+												}
+											],
+											"sources": [
+												{
+													"fileName": "Payload.ts",
+													"line": 9,
+													"character": 52,
+													"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/9d69e27dd8f3e/packages/plugins/packages/payload/packages/module-instance/src/Payload.ts#L9"
+												}
+											]
+										}
+									}
+								]
+							}
+						],
+						"name": "Partial",
+						"package": "typescript"
+					}
+				}
+			]
+		}
+	],
+	"groups": [
+		{
+			"title": "References",
+			"children": [
+				22
+			]
+		},
+		{
+			"title": "Interfaces",
+			"children": [
+				7
+			]
+		},
+		{
+			"title": "Type Aliases",
+			"children": [
+				9,
+				15
+			]
+		},
+		{
+			"title": "Variables",
+			"children": [
+				14
+			]
+		},
+		{
+			"title": "Functions",
+			"children": [
+				1,
+				16
+			]
+		}
+	],
+	"packageName": "@xyo-network/module-instance-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": "ModuleInstancePayloadPlugin"
+		},
+		"2": {
+			"sourceFileName": "src/Plugin.ts",
+			"qualifiedName": "ModuleInstancePayloadPlugin"
+		},
+		"3": {
+			"sourceFileName": "src/Payload.ts",
+			"qualifiedName": "__type"
+		},
+		"4": {
+			"sourceFileName": "src/Payload.ts",
+			"qualifiedName": "__type.address"
+		},
+		"5": {
+			"sourceFileName": "src/Payload.ts",
+			"qualifiedName": "__type.queries"
+		},
+		"6": {
+			"sourceFileName": "src/Payload.ts",
+			"qualifiedName": "__type.schema"
+		},
+		"7": {
+			"sourceFileName": "src/Payload.ts",
+			"qualifiedName": "AbstractModuleInstanceQueryConfig"
+		},
+		"8": {
+			"sourceFileName": "src/Payload.ts",
+			"qualifiedName": "AbstractModuleInstanceQueryConfig.cost"
+		},
+		"9": {
+			"sourceFileName": "src/Payload.ts",
+			"qualifiedName": "AbstractModuleInstancePayload"
+		},
+		"10": {
+			"sourceFileName": "src/Payload.ts",
+			"qualifiedName": "__type"
+		},
+		"11": {
+			"sourceFileName": "src/Payload.ts",
+			"qualifiedName": "__type.address"
+		},
+		"12": {
+			"sourceFileName": "src/Payload.ts",
+			"qualifiedName": "__type.queries"
+		},
+		"13": {
+			"sourceFileName": "src/Payload.ts",
+			"qualifiedName": "__type.schema"
+		},
+		"14": {
+			"sourceFileName": "src/Schema.ts",
+			"qualifiedName": "AbstractModuleInstanceSchema"
+		},
+		"15": {
+			"sourceFileName": "src/Schema.ts",
+			"qualifiedName": "AbstractModuleInstanceSchema"
+		},
+		"16": {
+			"sourceFileName": "src/Template.ts",
+			"qualifiedName": "moduleInstancePayloadTemplate"
+		},
+		"17": {
+			"sourceFileName": "src/Template.ts",
+			"qualifiedName": "moduleInstancePayloadTemplate"
+		},
+		"18": {
+			"sourceFileName": "src/Payload.ts",
+			"qualifiedName": "__type"
+		},
+		"19": {
+			"sourceFileName": "src/Payload.ts",
+			"qualifiedName": "__type.address"
+		},
+		"20": {
+			"sourceFileName": "src/Payload.ts",
+			"qualifiedName": "__type.queries"
+		},
+		"21": {
+			"sourceFileName": "src/Payload.ts",
+			"qualifiedName": "__type.schema"
+		},
+		"22": {
+			"sourceFileName": "src/index.ts",
+			"qualifiedName": "default"
+		}
+	}
+}