@xyo-network/location-payload-plugin 2.36.8 → 2.36.10

package/README.md

@@ -26,8 +26,7 @@
 
 ## Description
 
-> Primary SDK for using the XYO Protocol 2.0 from TypeScript/JavaScript.
-> Designed to work in both browser based and Node JS based solutions.
+> Location is an observation of XYZT
 
 ## Install
 

package/dist/cjs/Payload.d.ts

@@ -1,14 +1,27 @@
 import { XyoPayload } from '@xyo-network/payload';
 import { XyoLocationSchema } from './Schema';
-export declare type XyoLocationPayload = XyoPayload<{
-    schema: XyoLocationSchema;
+export interface LngLatPhysicalLocation {
+    latitude: number;
+    longitude: number;
     accuracy?: number;
+}
+export interface QuadkeyPhysicalLocation {
+    quadkey: string;
+}
+export interface AltitudePhysicalLocation {
     altitude?: number;
     altitudeAccuracy?: number;
+}
+export declare type PhysicalLocation = (LngLatPhysicalLocation | QuadkeyPhysicalLocation) & AltitudePhysicalLocation;
+export declare type VectorLocation = {
     heading?: number;
-    latitude?: number;
-    longitude?: number;
     speed?: number;
+};
+export interface TemporalLocation {
     time?: number;
-}>;
+}
+export declare type CompleteLocation = PhysicalLocation & TemporalLocation & VectorLocation;
+export declare type XyoLocationPayload = XyoPayload<{
+    schema: XyoLocationSchema;
+} & CompleteLocation>;
 //# sourceMappingURL=Payload.d.ts.map

package/dist/cjs/Payload.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAEjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAA;AAE5C,oBAAY,kBAAkB,GAAG,UAAU,CAAC;IAC1C,MAAM,EAAE,iBAAiB,CAAA;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAC,CAAA"}
+{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAEjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAA;AAE5C,MAAM,WAAW,sBAAsB;IACrC,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,wBAAwB;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAC1B;AAED,oBAAY,gBAAgB,GAAG,CAAC,sBAAsB,GAAG,uBAAuB,CAAC,GAAG,wBAAwB,CAAA;AAE5G,oBAAY,cAAc,GAAG;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,oBAAY,gBAAgB,GAAG,gBAAgB,GAAG,gBAAgB,GAAG,cAAc,CAAA;AAEnF,oBAAY,kBAAkB,GAAG,UAAU,CAAC;IAAE,MAAM,EAAE,iBAAiB,CAAA;CAAE,GAAG,gBAAgB,CAAC,CAAA"}

package/dist/cjs/Plugin.d.ts

@@ -1,39 +1,27 @@
-export declare const XyoLocationPayloadPlugin: () => import("@xyo-network/payload-plugin").XyoPayloadPlugin<import("@xyo-network/payload").SchemaFields & import("@xyo-network/payload").PayloadFields & {
-    schema: "network.xyo.location";
-    accuracy?: number | undefined;
-    altitude?: number | undefined;
-    altitudeAccuracy?: number | undefined;
-    heading?: number | undefined;
-    latitude?: number | undefined;
-    longitude?: number | undefined;
-    speed?: number | undefined;
-    time?: number | undefined;
-}, import("@xyo-network/payload").SchemaFields & import("@xyo-network/payload").PayloadFields & {
+import { XyoLocationPayload } from './Payload';
+export declare const XyoLocationPayloadPlugin: () => import("@xyo-network/payload-plugin").XyoPayloadPlugin<XyoLocationPayload, import("@xyo-network/payload").SchemaFields & import("@xyo-network/payload").PayloadFields & {
     security?: {
         allowed?: Record<string, string[][]> | undefined;
         disallowed?: Record<string, string[]> | undefined;
     } | undefined;
-    logging?: boolean | undefined;
 } & {
     schema: "network.xyo.location.config";
     geolocation: Geolocation;
 } & {
     targetSchema: "network.xyo.location";
-}, import("@xyo-network/payload").SchemaFields & import("@xyo-network/payload").PayloadFields & {
+}, (import("@xyo-network/payload").SchemaFields & import("@xyo-network/payload").PayloadFields & {
+    security?: {
+        allowed?: Record<string, string[][]> | undefined;
+        disallowed?: Record<string, string[]> | undefined;
+    } | undefined;
+} & {
+    schema: "network.xyo.location";
+} & import("./Payload").LngLatPhysicalLocation & import("./Payload").AltitudePhysicalLocation & import("./Payload").TemporalLocation & import("./Payload").VectorLocation) | (import("@xyo-network/payload").SchemaFields & import("@xyo-network/payload").PayloadFields & {
     security?: {
         allowed?: Record<string, string[][]> | undefined;
         disallowed?: Record<string, string[]> | undefined;
     } | undefined;
-    logging?: boolean | undefined;
 } & {
     schema: "network.xyo.location";
-    accuracy?: number | undefined;
-    altitude?: number | undefined;
-    altitudeAccuracy?: number | undefined;
-    heading?: number | undefined;
-    latitude?: number | undefined;
-    longitude?: number | undefined;
-    speed?: number | undefined;
-    time?: number | undefined;
-}>;
+} & import("./Payload").QuadkeyPhysicalLocation & import("./Payload").AltitudePhysicalLocation & import("./Payload").TemporalLocation & import("./Payload").VectorLocation)>;
 //# sourceMappingURL=Plugin.d.ts.map

package/dist/cjs/Plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Plugin.d.ts","sourceRoot":"","sources":["../../src/Plugin.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAYjC,CAAA"}
+{"version":3,"file":"Plugin.d.ts","sourceRoot":"","sources":["../../src/Plugin.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAA;AAK9C,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;4KAYjC,CAAA"}

package/dist/cjs/Template.d.ts

@@ -1,3 +1,3 @@
 import { XyoLocationPayload } from './Payload';
-export declare const XyoLocationPayloadTemplate: () => XyoLocationPayload;
+export declare const XyoLocationPayloadTemplate: () => Partial<XyoLocationPayload>;
 //# sourceMappingURL=Template.d.ts.map

package/dist/cjs/Template.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Template.d.ts","sourceRoot":"","sources":["../../src/Template.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAA;AAG9C,eAAO,MAAM,0BAA0B,QAAO,kBAY7C,CAAA"}
+{"version":3,"file":"Template.d.ts","sourceRoot":"","sources":["../../src/Template.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAA;AAG9C,eAAO,MAAM,0BAA0B,QAAO,QAAQ,kBAAkB,CAavE,CAAA"}

package/dist/cjs/Template.js

@@ -10,6 +10,7 @@ const XyoLocationPayloadTemplate = () => {
         heading: undefined,
         latitude: undefined,
         longitude: undefined,
+        quadkey: undefined,
         schema: Schema_1.XyoLocationSchema,
         speed: undefined,
         time: Date.now(),

package/dist/cjs/Template.js.map

@@ -1 +1 @@
-{"version":3,"file":"Template.js","sourceRoot":"","sources":["../../src/Template.ts"],"names":[],"mappings":";;;AACA,qCAA4C;AAErC,MAAM,0BAA0B,GAAG,GAAuB,EAAE;IACjE,OAAO;QACL,QAAQ,EAAE,SAAS;QACnB,QAAQ,EAAE,SAAS;QACnB,gBAAgB,EAAE,SAAS;QAC3B,OAAO,EAAE,SAAS;QAClB,QAAQ,EAAE,SAAS;QACnB,SAAS,EAAE,SAAS;QACpB,MAAM,EAAE,0BAAiB;QACzB,KAAK,EAAE,SAAS;QAChB,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE;KACjB,CAAA;AACH,CAAC,CAAA;AAZY,QAAA,0BAA0B,8BAYtC"}
+{"version":3,"file":"Template.js","sourceRoot":"","sources":["../../src/Template.ts"],"names":[],"mappings":";;;AACA,qCAA4C;AAErC,MAAM,0BAA0B,GAAG,GAAgC,EAAE;IAC1E,OAAO;QACL,QAAQ,EAAE,SAAS;QACnB,QAAQ,EAAE,SAAS;QACnB,gBAAgB,EAAE,SAAS;QAC3B,OAAO,EAAE,SAAS;QAClB,QAAQ,EAAE,SAAS;QACnB,SAAS,EAAE,SAAS;QACpB,OAAO,EAAE,SAAS;QAClB,MAAM,EAAE,0BAAiB;QACzB,KAAK,EAAE,SAAS;QAChB,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE;KACjB,CAAA;AACH,CAAC,CAAA;AAbY,QAAA,0BAA0B,8BAatC"}

package/dist/cjs/Witness.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Witness.d.ts","sourceRoot":"","sources":["../../src/Witness.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAEnE,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAA;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAA;AAE5C,oBAAY,8BAA8B,GAAG,6BAA6B,CAAA;AAC1E,eAAO,MAAM,8BAA8B,EAAE,8BAA8D,CAAA;AAE3G,oBAAY,wBAAwB,GAAG,gBAAgB,CACrD,kBAAkB,EAClB;IACE,MAAM,EAAE,8BAA8B,CAAA;IACtC,WAAW,EAAE,WAAW,CAAA;CACzB,CACF,CAAA;AAED,qBAAa,kBAAmB,SAAQ,UAAU,CAAC,kBAAkB,EAAE,wBAAwB,CAAC;IAC9F,IAAW,WAAW,4BAErB;IAEM,kBAAkB;IAaV,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAczF,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAoB;CACrD"}
+{"version":3,"file":"Witness.d.ts","sourceRoot":"","sources":["../../src/Witness.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAEnE,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAA;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAA;AAE5C,oBAAY,8BAA8B,GAAG,6BAA6B,CAAA;AAC1E,eAAO,MAAM,8BAA8B,EAAE,8BAA8D,CAAA;AAE3G,oBAAY,wBAAwB,GAAG,gBAAgB,CACrD,kBAAkB,EAClB;IACE,MAAM,EAAE,8BAA8B,CAAA;IACtC,WAAW,EAAE,WAAW,CAAA;CACzB,CACF,CAAA;AAED,qBAAa,kBAAmB,SAAQ,UAAU,CAAC,kBAAkB,EAAE,wBAAwB,CAAC;IAC9F,IAAW,WAAW,4BAErB;IAEM,kBAAkB;IAaV,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAgBzF,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAoB;CACrD"}

package/dist/cjs/Witness.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.XyoLocationWitness = exports.XyoLocationWitnessConfigSchema = void 0;
 const tslib_1 = require("tslib");
+const quadkey_1 = require("@xyo-network/quadkey");
 const witness_1 = require("@xyo-network/witness");
 const Schema_1 = require("./Schema");
 exports.XyoLocationWitnessConfigSchema = 'network.xyo.location.config';
@@ -27,6 +28,7 @@ class XyoLocationWitness extends witness_1.XyoWitness {
         var _a, _b, _c, _d;
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const location = yield this.getCurrentPosition();
+            const quadkey = quadkey_1.Quadkey.fromLngLat({ lat: location.coords.latitude, lng: location.coords.longitude }, 32);
             return _super.observe.call(this, {
                 accuracy: location.coords.accuracy,
                 altitude: (_a = location.coords.altitude) !== null && _a !== void 0 ? _a : undefined,
@@ -34,6 +36,7 @@ class XyoLocationWitness extends witness_1.XyoWitness {
                 heading: (_c = location.coords.heading) !== null && _c !== void 0 ? _c : undefined,
                 latitude: location.coords.latitude,
                 longitude: location.coords.longitude,
+                quadkey: quadkey === null || quadkey === void 0 ? void 0 : quadkey.toBase4Hash(),
                 speed: (_d = location.coords.speed) !== null && _d !== void 0 ? _d : undefined,
                 time: Date.now(),
             });

package/dist/cjs/Witness.js.map

@@ -1 +1 @@
-{"version":3,"file":"Witness.js","sourceRoot":"","sources":["../../src/Witness.ts"],"names":[],"mappings":";;;;AAAA,kDAAmE;AAGnE,qCAA4C;AAG/B,QAAA,8BAA8B,GAAmC,6BAA6B,CAAA;AAU3G,MAAa,kBAAmB,SAAQ,oBAAwD;IAC9F,IAAW,WAAW;;QACpB,OAAO,MAAA,IAAI,CAAC,MAAM,0CAAE,WAAW,CAAA;IACjC,CAAC;IAEM,kBAAkB;QACvB,OAAO,IAAI,OAAO,CAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;;YAC1D,MAAA,IAAI,CAAC,WAAW,0CAAE,kBAAkB,CAClC,CAAC,QAA6B,EAAE,EAAE;gBAChC,OAAO,CAAC,QAAQ,CAAC,CAAA;YACnB,CAAC,EACD,CAAC,KAA+B,EAAE,EAAE;gBAClC,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAEc,OAAO,CAAC,OAAoC;;;;;;YACzD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAA;YAChD,OAAO,OAAM,OAAO,YAAC;gBACnB,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ;gBAClC,QAAQ,EAAE,MAAA,QAAQ,CAAC,MAAM,CAAC,QAAQ,mCAAI,SAAS;gBAC/C,gBAAgB,EAAE,MAAA,QAAQ,CAAC,MAAM,CAAC,gBAAgB,mCAAI,SAAS;gBAC/D,OAAO,EAAE,MAAA,QAAQ,CAAC,MAAM,CAAC,OAAO,mCAAI,SAAS;gBAC7C,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ;gBAClC,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,SAAS;gBACpC,KAAK,EAAE,MAAA,QAAQ,CAAC,MAAM,CAAC,KAAK,mCAAI,SAAS;gBACzC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE;aACjB,EAAC;;KACH;;AA9BH,gDAiCC;AADQ,yBAAM,GAAsB,0BAAiB,CAAA"}
+{"version":3,"file":"Witness.js","sourceRoot":"","sources":["../../src/Witness.ts"],"names":[],"mappings":";;;;AAAA,kDAA8C;AAC9C,kDAAmE;AAGnE,qCAA4C;AAG/B,QAAA,8BAA8B,GAAmC,6BAA6B,CAAA;AAU3G,MAAa,kBAAmB,SAAQ,oBAAwD;IAC9F,IAAW,WAAW;;QACpB,OAAO,MAAA,IAAI,CAAC,MAAM,0CAAE,WAAW,CAAA;IACjC,CAAC;IAEM,kBAAkB;QACvB,OAAO,IAAI,OAAO,CAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;;YAC1D,MAAA,IAAI,CAAC,WAAW,0CAAE,kBAAkB,CAClC,CAAC,QAA6B,EAAE,EAAE;gBAChC,OAAO,CAAC,QAAQ,CAAC,CAAA;YACnB,CAAC,EACD,CAAC,KAA+B,EAAE,EAAE;gBAClC,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAEc,OAAO,CAAC,OAAoC;;;;;;YACzD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAA;YAChD,MAAM,OAAO,GAAG,iBAAO,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,EAAE,QAAQ,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,EAAE,CAAC,CAAA;YACzG,OAAO,OAAM,OAAO,YAAC;gBACnB,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ;gBAClC,QAAQ,EAAE,MAAA,QAAQ,CAAC,MAAM,CAAC,QAAQ,mCAAI,SAAS;gBAC/C,gBAAgB,EAAE,MAAA,QAAQ,CAAC,MAAM,CAAC,gBAAgB,mCAAI,SAAS;gBAC/D,OAAO,EAAE,MAAA,QAAQ,CAAC,MAAM,CAAC,OAAO,mCAAI,SAAS;gBAC7C,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ;gBAClC,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,SAAS;gBACpC,OAAO,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW,EAAE;gBAC/B,KAAK,EAAE,MAAA,QAAQ,CAAC,MAAM,CAAC,KAAK,mCAAI,SAAS;gBACzC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE;aACjB,EAAC;;KACH;;AAhCH,gDAmCC;AADQ,yBAAM,GAAsB,0BAAiB,CAAA"}