@xyo-network/location-payload-plugin 2.23.3 → 2.24.2

package/dist/docs.json

@@ -7,23 +7,734 @@
 	"originalName": "",
 	"children": [
 		{
-			"id": 1,
+			"id": 36,
 			"name": "default",
+			"kind": 8388608,
+			"kindString": "Reference",
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "plugins/location/src/index.ts",
+					"line": 11,
+					"character": 0,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/7f6f2e0/packages/plugins/location/src/index.ts#L11"
+				}
+			],
+			"target": 1
+		},
+		{
+			"id": 23,
+			"name": "XyoLocationWitness",
+			"kind": 128,
+			"kindString": "Class",
+			"flags": {},
+			"children": [
+				{
+					"id": 25,
+					"name": "constructor",
+					"kind": 512,
+					"kindString": "Constructor",
+					"flags": {},
+					"sources": [
+						{
+							"fileName": "plugins/location/src/Witness.ts",
+							"line": 9,
+							"character": 2,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/7f6f2e0/packages/plugins/location/src/Witness.ts#L9"
+						}
+					],
+					"signatures": [
+						{
+							"id": 26,
+							"name": "new XyoLocationWitness",
+							"kind": 16384,
+							"kindString": "Constructor signature",
+							"flags": {},
+							"type": {
+								"type": "reference",
+								"id": 23,
+								"name": "XyoLocationWitness"
+							},
+							"overwrites": {
+								"type": "reference",
+								"name": "XyoSimpleWitness<XyoLocationPayload>.constructor"
+							}
+						}
+					],
+					"overwrites": {
+						"type": "reference",
+						"name": "XyoSimpleWitness<XyoLocationPayload>.constructor"
+					}
+				},
+				{
+					"id": 35,
+					"name": "config",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isOptional": true,
+						"isReadonly": true
+					},
+					"sources": [
+						{
+							"fileName": "sdk/witness/dist/esm/Witness/Witness.d.ts",
+							"line": 8,
+							"character": 13
+						}
+					],
+					"type": {
+						"type": "reference",
+						"typeArguments": [
+							{
+								"type": "reference",
+								"id": 4,
+								"name": "XyoLocationPayload"
+							}
+						],
+						"name": "XyoSimpleWitnessConfig"
+					},
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "XyoSimpleWitness.config"
+					}
+				},
+				{
+					"id": 27,
+					"name": "geoLocation",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isPrivate": true
+					},
+					"sources": [
+						{
+							"fileName": "plugins/location/src/Witness.ts",
+							"line": 8,
+							"character": 10,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/7f6f2e0/packages/plugins/location/src/Witness.ts#L8"
+						}
+					],
+					"type": {
+						"type": "reference",
+						"name": "Geolocation",
+						"qualifiedName": "Geolocation",
+						"package": "typescript"
+					}
+				},
+				{
+					"id": 32,
+					"name": "previousHash",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isOptional": true
+					},
+					"sources": [
+						{
+							"fileName": "sdk/witness/dist/esm/Witness/SimpleWitness.d.ts",
+							"line": 9,
+							"character": 4
+						}
+					],
+					"type": {
+						"type": "intrinsic",
+						"name": "string"
+					},
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "XyoSimpleWitness.previousHash"
+					}
+				},
+				{
+					"id": 24,
+					"name": "schema",
+					"kind": 1024,
+					"kindString": "Property",
+					"flags": {
+						"isStatic": true
+					},
+					"sources": [
+						{
+							"fileName": "plugins/location/src/Witness.ts",
+							"line": 49,
+							"character": 9,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/7f6f2e0/packages/plugins/location/src/Witness.ts#L49"
+						}
+					],
+					"type": {
+						"type": "literal",
+						"value": "network.xyo.location"
+					},
+					"defaultValue": "XyoLocationPayloadSchema"
+				},
+				{
+					"id": 33,
+					"name": "targetSchema",
+					"kind": 262144,
+					"kindString": "Accessor",
+					"flags": {},
+					"sources": [
+						{
+							"fileName": "sdk/witness/dist/esm/Witness/SimpleWitness.d.ts",
+							"line": 10,
+							"character": 8
+						}
+					],
+					"getSignature": {
+						"id": 34,
+						"name": "targetSchema",
+						"kind": 524288,
+						"kindString": "Get signature",
+						"flags": {},
+						"type": {
+							"type": "intrinsic",
+							"name": "string"
+						},
+						"inheritedFrom": {
+							"type": "reference",
+							"name": "XyoSimpleWitness.targetSchema"
+						}
+					},
+					"inheritedFrom": {
+						"type": "reference",
+						"name": "XyoSimpleWitness.targetSchema"
+					}
+				},
+				{
+					"id": 28,
+					"name": "getCurrentPosition",
+					"kind": 2048,
+					"kindString": "Method",
+					"flags": {
+						"isPublic": true
+					},
+					"sources": [
+						{
+							"fileName": "plugins/location/src/Witness.ts",
+							"line": 18,
+							"character": 9,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/7f6f2e0/packages/plugins/location/src/Witness.ts#L18"
+						}
+					],
+					"signatures": [
+						{
+							"id": 29,
+							"name": "getCurrentPosition",
+							"kind": 4096,
+							"kindString": "Call signature",
+							"flags": {},
+							"type": {
+								"type": "reference",
+								"typeArguments": [
+									{
+										"type": "reference",
+										"name": "GeolocationPosition",
+										"qualifiedName": "GeolocationPosition",
+										"package": "typescript"
+									}
+								],
+								"name": "Promise",
+								"qualifiedName": "Promise",
+								"package": "typescript"
+							}
+						}
+					]
+				},
+				{
+					"id": 30,
+					"name": "observe",
+					"kind": 2048,
+					"kindString": "Method",
+					"flags": {},
+					"sources": [
+						{
+							"fileName": "plugins/location/src/Witness.ts",
+							"line": 31,
+							"character": 17,
+							"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/7f6f2e0/packages/plugins/location/src/Witness.ts#L31"
+						}
+					],
+					"signatures": [
+						{
+							"id": 31,
+							"name": "observe",
+							"kind": 4096,
+							"kindString": "Call signature",
+							"flags": {},
+							"type": {
+								"type": "reference",
+								"typeArguments": [
+									{
+										"type": "reference",
+										"id": 4,
+										"name": "XyoLocationPayload"
+									}
+								],
+								"name": "Promise",
+								"qualifiedName": "Promise",
+								"package": "typescript"
+							},
+							"overwrites": {
+								"type": "reference",
+								"name": "XyoSimpleWitness.observe"
+							}
+						}
+					],
+					"overwrites": {
+						"type": "reference",
+						"name": "XyoSimpleWitness.observe"
+					}
+				}
+			],
+			"groups": [
+				{
+					"title": "Constructors",
+					"children": [
+						25
+					]
+				},
+				{
+					"title": "Properties",
+					"children": [
+						35,
+						27,
+						32,
+						24
+					]
+				},
+				{
+					"title": "Accessors",
+					"children": [
+						33
+					]
+				},
+				{
+					"title": "Methods",
+					"children": [
+						28,
+						30
+					]
+				}
+			],
+			"sources": [
+				{
+					"fileName": "plugins/location/src/Witness.ts",
+					"line": 7,
+					"character": 13,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/7f6f2e0/packages/plugins/location/src/Witness.ts#L7"
+				}
+			],
+			"extendedTypes": [
+				{
+					"type": "reference",
+					"typeArguments": [
+						{
+							"type": "reference",
+							"id": 4,
+							"name": "XyoLocationPayload"
+						}
+					],
+					"name": "XyoSimpleWitness"
+				}
+			]
+		},
+		{
+			"id": 4,
+			"name": "XyoLocationPayload",
+			"kind": 4194304,
+			"kindString": "Type alias",
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "plugins/location/src/Payload.ts",
+					"line": 5,
+					"character": 12,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/7f6f2e0/packages/plugins/location/src/Payload.ts#L5"
+				}
+			],
+			"type": {
+				"type": "reference",
+				"typeArguments": [
+					{
+						"type": "reflection",
+						"declaration": {
+							"id": 5,
+							"name": "__type",
+							"kind": 65536,
+							"kindString": "Type literal",
+							"flags": {},
+							"children": [
+								{
+									"id": 7,
+									"name": "currentLocation",
+									"kind": 1024,
+									"kindString": "Property",
+									"flags": {},
+									"sources": [
+										{
+											"fileName": "plugins/location/src/Payload.ts",
+											"line": 7,
+											"character": 2,
+											"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/7f6f2e0/packages/plugins/location/src/Payload.ts#L7"
+										}
+									],
+									"type": {
+										"type": "reflection",
+										"declaration": {
+											"id": 8,
+											"name": "__type",
+											"kind": 65536,
+											"kindString": "Type literal",
+											"flags": {},
+											"children": [
+												{
+													"id": 9,
+													"name": "coords",
+													"kind": 1024,
+													"kindString": "Property",
+													"flags": {},
+													"sources": [
+														{
+															"fileName": "plugins/location/src/Payload.ts",
+															"line": 8,
+															"character": 4,
+															"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/7f6f2e0/packages/plugins/location/src/Payload.ts#L8"
+														}
+													],
+													"type": {
+														"type": "reflection",
+														"declaration": {
+															"id": 10,
+															"name": "__type",
+															"kind": 65536,
+															"kindString": "Type literal",
+															"flags": {},
+															"children": [
+																{
+																	"id": 11,
+																	"name": "accuracy",
+																	"kind": 1024,
+																	"kindString": "Property",
+																	"flags": {
+																		"isOptional": true
+																	},
+																	"sources": [
+																		{
+																			"fileName": "plugins/location/src/Payload.ts",
+																			"line": 9,
+																			"character": 6,
+																			"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/7f6f2e0/packages/plugins/location/src/Payload.ts#L9"
+																		}
+																	],
+																	"type": {
+																		"type": "intrinsic",
+																		"name": "number"
+																	}
+																},
+																{
+																	"id": 12,
+																	"name": "altitude",
+																	"kind": 1024,
+																	"kindString": "Property",
+																	"flags": {
+																		"isOptional": true
+																	},
+																	"sources": [
+																		{
+																			"fileName": "plugins/location/src/Payload.ts",
+																			"line": 10,
+																			"character": 6,
+																			"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/7f6f2e0/packages/plugins/location/src/Payload.ts#L10"
+																		}
+																	],
+																	"type": {
+																		"type": "intrinsic",
+																		"name": "number"
+																	}
+																},
+																{
+																	"id": 13,
+																	"name": "altitudeAccuracy",
+																	"kind": 1024,
+																	"kindString": "Property",
+																	"flags": {
+																		"isOptional": true
+																	},
+																	"sources": [
+																		{
+																			"fileName": "plugins/location/src/Payload.ts",
+																			"line": 11,
+																			"character": 6,
+																			"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/7f6f2e0/packages/plugins/location/src/Payload.ts#L11"
+																		}
+																	],
+																	"type": {
+																		"type": "intrinsic",
+																		"name": "number"
+																	}
+																},
+																{
+																	"id": 14,
+																	"name": "heading",
+																	"kind": 1024,
+																	"kindString": "Property",
+																	"flags": {
+																		"isOptional": true
+																	},
+																	"sources": [
+																		{
+																			"fileName": "plugins/location/src/Payload.ts",
+																			"line": 12,
+																			"character": 6,
+																			"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/7f6f2e0/packages/plugins/location/src/Payload.ts#L12"
+																		}
+																	],
+																	"type": {
+																		"type": "intrinsic",
+																		"name": "number"
+																	}
+																},
+																{
+																	"id": 15,
+																	"name": "latitude",
+																	"kind": 1024,
+																	"kindString": "Property",
+																	"flags": {
+																		"isOptional": true
+																	},
+																	"sources": [
+																		{
+																			"fileName": "plugins/location/src/Payload.ts",
+																			"line": 13,
+																			"character": 6,
+																			"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/7f6f2e0/packages/plugins/location/src/Payload.ts#L13"
+																		}
+																	],
+																	"type": {
+																		"type": "intrinsic",
+																		"name": "number"
+																	}
+																},
+																{
+																	"id": 16,
+																	"name": "longitude",
+																	"kind": 1024,
+																	"kindString": "Property",
+																	"flags": {
+																		"isOptional": true
+																	},
+																	"sources": [
+																		{
+																			"fileName": "plugins/location/src/Payload.ts",
+																			"line": 14,
+																			"character": 6,
+																			"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/7f6f2e0/packages/plugins/location/src/Payload.ts#L14"
+																		}
+																	],
+																	"type": {
+																		"type": "intrinsic",
+																		"name": "number"
+																	}
+																},
+																{
+																	"id": 17,
+																	"name": "speed",
+																	"kind": 1024,
+																	"kindString": "Property",
+																	"flags": {
+																		"isOptional": true
+																	},
+																	"sources": [
+																		{
+																			"fileName": "plugins/location/src/Payload.ts",
+																			"line": 15,
+																			"character": 6,
+																			"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/7f6f2e0/packages/plugins/location/src/Payload.ts#L15"
+																		}
+																	],
+																	"type": {
+																		"type": "intrinsic",
+																		"name": "number"
+																	}
+																}
+															],
+															"groups": [
+																{
+																	"title": "Properties",
+																	"children": [
+																		11,
+																		12,
+																		13,
+																		14,
+																		15,
+																		16,
+																		17
+																	]
+																}
+															],
+															"sources": [
+																{
+																	"fileName": "plugins/location/src/Payload.ts",
+																	"line": 8,
+																	"character": 12,
+																	"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/7f6f2e0/packages/plugins/location/src/Payload.ts#L8"
+																}
+															]
+														}
+													}
+												},
+												{
+													"id": 18,
+													"name": "timestamp",
+													"kind": 1024,
+													"kindString": "Property",
+													"flags": {},
+													"sources": [
+														{
+															"fileName": "plugins/location/src/Payload.ts",
+															"line": 17,
+															"character": 4,
+															"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/7f6f2e0/packages/plugins/location/src/Payload.ts#L17"
+														}
+													],
+													"type": {
+														"type": "intrinsic",
+														"name": "number"
+													}
+												}
+											],
+											"groups": [
+												{
+													"title": "Properties",
+													"children": [
+														9,
+														18
+													]
+												}
+											],
+											"sources": [
+												{
+													"fileName": "plugins/location/src/Payload.ts",
+													"line": 7,
+													"character": 19,
+													"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/7f6f2e0/packages/plugins/location/src/Payload.ts#L7"
+												}
+											]
+										}
+									}
+								},
+								{
+									"id": 6,
+									"name": "schema",
+									"kind": 1024,
+									"kindString": "Property",
+									"flags": {},
+									"sources": [
+										{
+											"fileName": "plugins/location/src/Payload.ts",
+											"line": 6,
+											"character": 2,
+											"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/7f6f2e0/packages/plugins/location/src/Payload.ts#L6"
+										}
+									],
+									"type": {
+										"type": "reference",
+										"id": 19,
+										"name": "XyoLocationPayloadSchema"
+									}
+								}
+							],
+							"groups": [
+								{
+									"title": "Properties",
+									"children": [
+										7,
+										6
+									]
+								}
+							],
+							"sources": [
+								{
+									"fileName": "plugins/location/src/Payload.ts",
+									"line": 5,
+									"character": 44,
+									"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/7f6f2e0/packages/plugins/location/src/Payload.ts#L5"
+								}
+							]
+						}
+					}
+				],
+				"name": "XyoPayload"
+			}
+		},
+		{
+			"id": 20,
+			"name": "XyoLocationPayloadSchema",
+			"kind": 4194304,
+			"kindString": "Type alias",
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "plugins/location/src/Schema.ts",
+					"line": 1,
+					"character": 12,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/7f6f2e0/packages/plugins/location/src/Schema.ts#L1"
+				},
+				{
+					"fileName": "plugins/location/src/Schema.ts",
+					"line": 2,
+					"character": 13,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/7f6f2e0/packages/plugins/location/src/Schema.ts#L2"
+				}
+			],
+			"type": {
+				"type": "literal",
+				"value": "network.xyo.location"
+			}
+		},
+		{
+			"id": 19,
+			"name": "XyoLocationPayloadSchema",
+			"kind": 32,
+			"kindString": "Variable",
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "plugins/location/src/Schema.ts",
+					"line": 1,
+					"character": 12,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/7f6f2e0/packages/plugins/location/src/Schema.ts#L1"
+				},
+				{
+					"fileName": "plugins/location/src/Schema.ts",
+					"line": 2,
+					"character": 13,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/7f6f2e0/packages/plugins/location/src/Schema.ts#L2"
+				}
+			],
+			"type": {
+				"type": "literal",
+				"value": "network.xyo.location"
+			}
+		},
+		{
+			"id": 1,
+			"name": "XyoLocationPayloadPlugin",
 			"kind": 64,
 			"kindString": "Function",
 			"flags": {},
 			"sources": [
 				{
-					"fileName": "plugins/location/src/index.ts",
-					"line": 4,
-					"character": 6,
-					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/41d22c2/packages/plugins/location/src/index.ts#L4"
+					"fileName": "plugins/location/src/Plugin.ts",
+					"line": 8,
+					"character": 13,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/7f6f2e0/packages/plugins/location/src/Plugin.ts#L8"
 				}
 			],
 			"signatures": [
 				{
 					"id": 2,
-					"name": "default",
+					"name": "XyoLocationPayloadPlugin",
 					"kind": 4096,
 					"kindString": "Call signature",
 					"flags": {},
@@ -85,6 +796,7 @@
 							},
 							{
 								"type": "reference",
+								"id": 4,
 								"name": "XyoLocationPayload"
 							}
 						],
@@ -92,13 +804,68 @@
 					}
 				}
 			]
+		},
+		{
+			"id": 21,
+			"name": "XyoLocationPayloadTemplate",
+			"kind": 64,
+			"kindString": "Function",
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "plugins/location/src/Template.ts",
+					"line": 4,
+					"character": 13,
+					"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/7f6f2e0/packages/plugins/location/src/Template.ts#L4"
+				}
+			],
+			"signatures": [
+				{
+					"id": 22,
+					"name": "XyoLocationPayloadTemplate",
+					"kind": 4096,
+					"kindString": "Call signature",
+					"flags": {},
+					"type": {
+						"type": "reference",
+						"id": 4,
+						"name": "XyoLocationPayload"
+					}
+				}
+			]
 		}
 	],
 	"groups": [
+		{
+			"title": "References",
+			"children": [
+				36
+			]
+		},
+		{
+			"title": "Classes",
+			"children": [
+				23
+			]
+		},
+		{
+			"title": "Type Aliases",
+			"children": [
+				4,
+				20
+			]
+		},
+		{
+			"title": "Variables",
+			"children": [
+				19
+			]
+		},
 		{
 			"title": "Functions",
 			"children": [
-				1
+				1,
+				21
 			]
 		}
 	],
@@ -107,7 +874,7 @@
 			"fileName": "plugins/location/src/index.ts",
 			"line": 1,
 			"character": 0,
-			"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/41d22c2/packages/plugins/location/src/index.ts#L1"
+			"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/7f6f2e0/packages/plugins/location/src/index.ts#L1"
 		}
 	]
 }