@xyo-network/location-plugin 2.42.0

package/dist/esm/CurrentLocationPayloadSet.d.ts

@@ -0,0 +1,3 @@
+import { PayloadSetPayload } from '@xyo-network/payload';
+export declare const CurrentLocationPayloadSet: PayloadSetPayload;
+//# sourceMappingURL=CurrentLocationPayloadSet.d.ts.map

package/dist/esm/CurrentLocationPayloadSet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CurrentLocationPayloadSet.d.ts","sourceRoot":"","sources":["../../src/CurrentLocationPayloadSet.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAoB,MAAM,sBAAsB,CAAA;AAE1E,eAAO,MAAM,yBAAyB,EAAE,iBAQvC,CAAA"}

package/dist/esm/CurrentLocationPayloadSet.js

@@ -0,0 +1,12 @@
+import { LocationHeadingSchema, LocationSchema } from '@xyo-network/location-payload-plugin';
+import { PayloadSetSchema } from '@xyo-network/payload';
+export const CurrentLocationPayloadSet = {
+    optional: {
+        [LocationHeadingSchema]: 1,
+    },
+    required: {
+        [LocationSchema]: 1,
+    },
+    schema: PayloadSetSchema,
+};
+//# sourceMappingURL=CurrentLocationPayloadSet.js.map

package/dist/esm/CurrentLocationPayloadSet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CurrentLocationPayloadSet.js","sourceRoot":"","sources":["../../src/CurrentLocationPayloadSet.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAA;AAC5F,OAAO,EAAqB,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAE1E,MAAM,CAAC,MAAM,yBAAyB,GAAsB;IAC1D,QAAQ,EAAE;QACR,CAAC,qBAAqB,CAAC,EAAE,CAAC;KAC3B;IACD,QAAQ,EAAE;QACR,CAAC,cAAc,CAAC,EAAE,CAAC;KACpB;IACD,MAAM,EAAE,gBAAgB;CACzB,CAAA"}

package/dist/esm/CurrentLocationWitness.d.ts

@@ -0,0 +1,21 @@
+import { XyoModuleParams } from '@xyo-network/module';
+import { XyoPayload } from '@xyo-network/payload';
+import { AbstractWitness, XyoWitnessConfig } from '@xyo-network/witness';
+export type CurrentLocationWitnessConfigSchema = 'network.xyo.location.current.config';
+export declare const CurrentLocationWitnessConfigSchema: CurrentLocationWitnessConfigSchema;
+export type CurrentLocationWitnessConfig = XyoWitnessConfig<{
+    schema: CurrentLocationWitnessConfigSchema;
+}>;
+export type CurrentLocationWitnessParams = XyoModuleParams<CurrentLocationWitnessConfig> & {
+    geolocation: Geolocation;
+};
+export declare class CurrentLocationWitness extends AbstractWitness<CurrentLocationWitnessConfig> {
+    static configSchema: "network.xyo.location.current.config";
+    private _geolocation;
+    constructor(params: CurrentLocationWitnessParams);
+    get geolocation(): Geolocation;
+    static create(params?: XyoModuleParams<CurrentLocationWitnessConfig>): Promise<CurrentLocationWitness>;
+    getCurrentPosition(): Promise<GeolocationPosition>;
+    observe(_fields: XyoPayload[]): Promise<XyoPayload[]>;
+}
+//# sourceMappingURL=CurrentLocationWitness.d.ts.map

package/dist/esm/CurrentLocationWitness.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CurrentLocationWitness.d.ts","sourceRoot":"","sources":["../../src/CurrentLocationWitness.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACjD,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAExE,MAAM,MAAM,kCAAkC,GAAG,qCAAqC,CAAA;AACtF,eAAO,MAAM,kCAAkC,EAAE,kCAA0E,CAAA;AAE3H,MAAM,MAAM,4BAA4B,GAAG,gBAAgB,CAAC;IAC1D,MAAM,EAAE,kCAAkC,CAAA;CAC3C,CAAC,CAAA;AAEF,MAAM,MAAM,4BAA4B,GAAG,eAAe,CAAC,4BAA4B,CAAC,GAAG;IAAE,WAAW,EAAE,WAAW,CAAA;CAAE,CAAA;AAEvH,qBAAa,sBAAuB,SAAQ,eAAe,CAAC,4BAA4B,CAAC;IACvF,OAAgB,YAAY,wCAAqC;IAEjE,OAAO,CAAC,YAAY,CAAa;gBAErB,MAAM,EAAE,4BAA4B;IAKhD,IAAW,WAAW,IAAI,WAAW,CAEpC;WAEqB,MAAM,CAAC,MAAM,CAAC,EAAE,eAAe,CAAC,4BAA4B,CAAC,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAI9G,kBAAkB;IAaV,OAAO,CAAC,OAAO,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;CAoBrE"}

package/dist/esm/CurrentLocationWitness.js

@@ -0,0 +1,48 @@
+import { assertEx } from '@xylabs/assert';
+import { LocationHeadingSchema, LocationSchema } from '@xyo-network/location-payload-plugin';
+import { AbstractWitness } from '@xyo-network/witness';
+export const CurrentLocationWitnessConfigSchema = 'network.xyo.location.current.config';
+export class CurrentLocationWitness extends AbstractWitness {
+    static configSchema = CurrentLocationWitnessConfigSchema;
+    _geolocation;
+    constructor(params) {
+        super(params);
+        this._geolocation = params?.geolocation;
+    }
+    get geolocation() {
+        return assertEx(this._geolocation, 'No geolocation provided');
+    }
+    static async create(params) {
+        return (await super.create(params));
+    }
+    getCurrentPosition() {
+        return new Promise((resolve, reject) => {
+            this.geolocation?.getCurrentPosition((position) => {
+                resolve(position);
+            }, (error) => {
+                reject(error);
+            });
+        });
+    }
+    async observe(_fields) {
+        const location = await this.getCurrentPosition();
+        const locationPayload = {
+            altitude: location.coords.altitude ?? undefined,
+            altitudeAccuracy: location.coords.altitudeAccuracy ?? undefined,
+            latitude: location.coords.latitude,
+            longitude: location.coords.longitude,
+            schema: LocationSchema,
+        };
+        const heading = location.coords.heading
+            ? [
+                {
+                    heading: location.coords.heading ?? undefined,
+                    schema: LocationHeadingSchema,
+                    speed: location.coords.speed ?? undefined,
+                },
+            ]
+            : [];
+        return super.observe([locationPayload, ...heading]);
+    }
+}
+//# sourceMappingURL=CurrentLocationWitness.js.map

package/dist/esm/CurrentLocationWitness.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CurrentLocationWitness.js","sourceRoot":"","sources":["../../src/CurrentLocationWitness.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AACzC,OAAO,EAA0B,qBAAqB,EAAmB,cAAc,EAAE,MAAM,sCAAsC,CAAA;AAGrI,OAAO,EAAE,eAAe,EAAoB,MAAM,sBAAsB,CAAA;AAGxE,MAAM,CAAC,MAAM,kCAAkC,GAAuC,qCAAqC,CAAA;AAQ3H,MAAM,OAAO,sBAAuB,SAAQ,eAA6C;IACvF,MAAM,CAAU,YAAY,GAAG,kCAAkC,CAAA;IAEzD,YAAY,CAAa;IAEjC,YAAY,MAAoC;QAC9C,KAAK,CAAC,MAAM,CAAC,CAAA;QACb,IAAI,CAAC,YAAY,GAAG,MAAM,EAAE,WAAW,CAAA;IACzC,CAAC;IAED,IAAW,WAAW;QACpB,OAAO,QAAQ,CAAC,IAAI,CAAC,YAAY,EAAE,yBAAyB,CAAC,CAAA;IAC/D,CAAC;IAED,MAAM,CAAU,KAAK,CAAC,MAAM,CAAC,MAAsD;QACjF,OAAO,CAAC,MAAM,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAA2B,CAAA;IAC/D,CAAC;IAEM,kBAAkB;QACvB,OAAO,IAAI,OAAO,CAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC1D,IAAI,CAAC,WAAW,EAAE,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;IAEQ,KAAK,CAAC,OAAO,CAAC,OAAqB;QAC1C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAA;QAChD,MAAM,eAAe,GAAoB;YACvC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ,IAAI,SAAS;YAC/C,gBAAgB,EAAE,QAAQ,CAAC,MAAM,CAAC,gBAAgB,IAAI,SAAS;YAC/D,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ;YAClC,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,SAAS;YACpC,MAAM,EAAE,cAAc;SACvB,CAAA;QACD,MAAM,OAAO,GAA6B,QAAQ,CAAC,MAAM,CAAC,OAAO;YAC/D,CAAC,CAAC;gBACE;oBACE,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,OAAO,IAAI,SAAS;oBAC7C,MAAM,EAAE,qBAAqB;oBAC7B,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,KAAK,IAAI,SAAS;iBAC1C;aACF;YACH,CAAC,CAAC,EAAE,CAAA;QACN,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,GAAG,OAAO,CAAC,CAAC,CAAA;IACrD,CAAC"}

package/dist/esm/Plugin.d.ts

@@ -0,0 +1,15 @@
+import { XyoModuleParams } from '@xyo-network/module';
+import { PayloadSetWitnessPlugin } from '@xyo-network/payloadset-plugin';
+export declare const LocationPlugin: () => PayloadSetWitnessPlugin<XyoModuleParams<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.current.config";
+} & {
+    targetSet?: (import("@xyo-network/payload").SchemaFields & import("@xyo-network/payload").PayloadFields & import("@xyo-network/payload").PayloadSet & {
+        schema: "network.xyo.payload.set";
+    }) | undefined;
+}>>;
+//# sourceMappingURL=Plugin.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Plugin.d.ts","sourceRoot":"","sources":["../../src/Plugin.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAErD,OAAO,EAA0B,uBAAuB,EAAE,MAAM,gCAAgC,CAAA;AAIhG,eAAO,MAAM,cAAc;;;;;;;;;;;GASxB,CAAA"}

package/dist/esm/Plugin.js

@@ -0,0 +1,11 @@
+import { LocationSchema } from '@xyo-network/location-payload-plugin';
+import { PayloadSetSchema } from '@xyo-network/payload';
+import { createPayloadSetPlugin } from '@xyo-network/payloadset-plugin';
+import { CurrentLocationWitness } from './CurrentLocationWitness';
+export const LocationPlugin = () => createPayloadSetPlugin({ required: { [LocationSchema]: 1 }, schema: PayloadSetSchema }, {
+    witness: async (params) => {
+        const result = await CurrentLocationWitness.create(params);
+        return result;
+    },
+});
+//# sourceMappingURL=Plugin.js.map

package/dist/esm/Plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Plugin.js","sourceRoot":"","sources":["../../src/Plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAA;AAErE,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AACvD,OAAO,EAAE,sBAAsB,EAA2B,MAAM,gCAAgC,CAAA;AAEhG,OAAO,EAAE,sBAAsB,EAAgC,MAAM,0BAA0B,CAAA;AAE/F,MAAM,CAAC,MAAM,cAAc,GAAG,GAAG,EAAE,CACjC,sBAAsB,CACpB,EAAE,QAAQ,EAAE,EAAE,CAAC,cAAc,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,gBAAgB,EAAE,EAC/D;IACE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;QACxB,MAAM,MAAM,GAAG,MAAM,sBAAsB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QAC1D,OAAO,MAAM,CAAA;IACf,CAAC;CACF,CACF,CAAA"}

package/dist/esm/index.d.ts

@@ -0,0 +1,6 @@
+import { LocationPlugin } from './Plugin';
+export * from './CurrentLocationPayloadSet';
+export * from './CurrentLocationWitness';
+export { LocationPlugin };
+export default LocationPlugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAEzC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,0BAA0B,CAAA;AAExC,OAAO,EAAE,cAAc,EAAE,CAAA;AAGzB,eAAe,cAAc,CAAA"}

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+import { LocationPlugin } from './Plugin';
+export * from './CurrentLocationPayloadSet';
+export * from './CurrentLocationWitness';
+export { LocationPlugin };
+// eslint-disable-next-line import/no-default-export
+export default LocationPlugin;
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAEzC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,0BAA0B,CAAA;AAExC,OAAO,EAAE,cAAc,EAAE,CAAA;AAEzB,oDAAoD;AACpD,eAAe,cAAc,CAAA"}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@xyo-network/location-plugin",
+  "author": {
+    "email": "support@xyo.network",
+    "name": "XYO Development Team",
+    "url": "https://xyo.network"
+  },
+  "bugs": {
+    "email": "support@xyo.network",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
+  },
+  "dependencies": {
+    "@xylabs/assert": "^2.6.9",
+    "@xyo-network/location-payload-plugin": "^2.42.0",
+    "@xyo-network/module": "^2.42.0",
+    "@xyo-network/payload": "^2.42.0",
+    "@xyo-network/payloadset-plugin": "^2.42.0",
+    "@xyo-network/witness": "^2.42.0",
+    "tslib": "^2.4.1"
+  },
+  "description": "Primary SDK for using XYO Protocol 2.0",
+  "browser": "dist/esm/index.js",
+  "docs": "dist/docs.json",
+  "exports": {
+    ".": {
+      "node": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js"
+      },
+      "browser": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js"
+      },
+      "default": "./dist/esm/index.js"
+    },
+    "./dist/docs.json": {
+      "default": "./dist/docs.json"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "homepage": "https://xyo.network",
+  "license": "LGPL-3.0-only",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
+  },
+  "sideEffects": false,
+  "types": "dist/esm/index.d.ts",
+  "version": "2.42.0"
+}

package/src/CurrentLocationPayloadSet.ts

@@ -0,0 +1,12 @@
+import { LocationHeadingSchema, LocationSchema } from '@xyo-network/location-payload-plugin'
+import { PayloadSetPayload, PayloadSetSchema } from '@xyo-network/payload'
+
+export const CurrentLocationPayloadSet: PayloadSetPayload = {
+  optional: {
+    [LocationHeadingSchema]: 1,
+  },
+  required: {
+    [LocationSchema]: 1,
+  },
+  schema: PayloadSetSchema,
+}

package/src/CurrentLocationWitness.ts

@@ -0,0 +1,67 @@
+import { assertEx } from '@xylabs/assert'
+import { LocationHeadingPayload, LocationHeadingSchema, LocationPayload, LocationSchema } from '@xyo-network/location-payload-plugin'
+import { XyoModuleParams } from '@xyo-network/module'
+import { XyoPayload } from '@xyo-network/payload'
+import { AbstractWitness, XyoWitnessConfig } from '@xyo-network/witness'
+
+export type CurrentLocationWitnessConfigSchema = 'network.xyo.location.current.config'
+export const CurrentLocationWitnessConfigSchema: CurrentLocationWitnessConfigSchema = 'network.xyo.location.current.config'
+
+export type CurrentLocationWitnessConfig = XyoWitnessConfig<{
+  schema: CurrentLocationWitnessConfigSchema
+}>
+
+export type CurrentLocationWitnessParams = XyoModuleParams<CurrentLocationWitnessConfig> & { geolocation: Geolocation }
+
+export class CurrentLocationWitness extends AbstractWitness<CurrentLocationWitnessConfig> {
+  static override configSchema = CurrentLocationWitnessConfigSchema
+
+  private _geolocation: Geolocation
+
+  constructor(params: CurrentLocationWitnessParams) {
+    super(params)
+    this._geolocation = params?.geolocation
+  }
+
+  public get geolocation(): Geolocation {
+    return assertEx(this._geolocation, 'No geolocation provided')
+  }
+
+  static override async create(params?: XyoModuleParams<CurrentLocationWitnessConfig>): Promise<CurrentLocationWitness> {
+    return (await super.create(params)) as CurrentLocationWitness
+  }
+
+  public getCurrentPosition() {
+    return new Promise<GeolocationPosition>((resolve, reject) => {
+      this.geolocation?.getCurrentPosition(
+        (position: GeolocationPosition) => {
+          resolve(position)
+        },
+        (error: GeolocationPositionError) => {
+          reject(error)
+        },
+      )
+    })
+  }
+
+  override async observe(_fields: XyoPayload[]): Promise<XyoPayload[]> {
+    const location = await this.getCurrentPosition()
+    const locationPayload: LocationPayload = {
+      altitude: location.coords.altitude ?? undefined,
+      altitudeAccuracy: location.coords.altitudeAccuracy ?? undefined,
+      latitude: location.coords.latitude,
+      longitude: location.coords.longitude,
+      schema: LocationSchema,
+    }
+    const heading: LocationHeadingPayload[] = location.coords.heading
+      ? [
+          {
+            heading: location.coords.heading ?? undefined,
+            schema: LocationHeadingSchema,
+            speed: location.coords.speed ?? undefined,
+          },
+        ]
+      : []
+    return super.observe([locationPayload, ...heading])
+  }
+}

package/src/Plugin.spec.ts

@@ -0,0 +1,25 @@
+/**
+ * @jest-environment jsdom
+ */
+
+import { CurrentLocationSchema } from '@xyo-network/location-payload-plugin'
+import { PayloadSetPluginResolver } from '@xyo-network/payloadset-plugin'
+
+import { CurrentLocationWitnessConfigSchema } from './CurrentLocationWitness'
+import { LocationPlugin } from './Plugin'
+
+describe('LocationPlugin', () => {
+  test('Add to Resolver', () => {
+    const plugin = LocationPlugin()
+    const resolver = new PayloadSetPluginResolver().register(plugin, {
+      witness: {
+        config: {
+          schema: CurrentLocationWitnessConfigSchema,
+        },
+        geolocation: navigator.geolocation,
+      },
+    })
+    expect(resolver.resolve(plugin.set)).toBeObject()
+    expect(resolver.witness(CurrentLocationSchema)).toBeObject()
+  })
+})

package/src/Plugin.ts

@@ -0,0 +1,17 @@
+import { LocationSchema } from '@xyo-network/location-payload-plugin'
+import { XyoModuleParams } from '@xyo-network/module'
+import { PayloadSetSchema } from '@xyo-network/payload'
+import { createPayloadSetPlugin, PayloadSetWitnessPlugin } from '@xyo-network/payloadset-plugin'
+
+import { CurrentLocationWitness, CurrentLocationWitnessConfig } from './CurrentLocationWitness'
+
+export const LocationPlugin = () =>
+  createPayloadSetPlugin<PayloadSetWitnessPlugin<XyoModuleParams<CurrentLocationWitnessConfig>>>(
+    { required: { [LocationSchema]: 1 }, schema: PayloadSetSchema },
+    {
+      witness: async (params) => {
+        const result = await CurrentLocationWitness.create(params)
+        return result
+      },
+    },
+  )

package/src/index.ts

@@ -0,0 +1,9 @@
+import { LocationPlugin } from './Plugin'
+
+export * from './CurrentLocationPayloadSet'
+export * from './CurrentLocationWitness'
+
+export { LocationPlugin }
+
+// eslint-disable-next-line import/no-default-export
+export default LocationPlugin