@xyo-network/location-certainty-plugin 4.1.1 → 5.0.0

package/dist/neutral/index.d.ts

@@ -1,29 +1,3 @@
-import { DivinerConfig, DivinerParams, DivinerModule } from '@xyo-network/diviner-model';
-import { LocationCertaintySchema } from '@xyo-network/location-certainty-payload-plugin';
-import { Payload, Schema } from '@xyo-network/payload-model';
-import { AbstractDiviner } from '@xyo-network/diviner-abstract';
-import { AnyConfigSchema } from '@xyo-network/module-model';
-import * as _xyo_network_payloadset_plugin from '@xyo-network/payloadset-plugin';
-
-type LocationCertaintyDivinerConfigSchema = 'network.xyo.location.elevation.diviner.config';
-declare const LocationCertaintyDivinerConfigSchema: LocationCertaintyDivinerConfigSchema;
-type LocationCertaintyDivinerConfig<TConfig extends Payload = Payload> = DivinerConfig<TConfig & {
-    schema: LocationCertaintyDivinerConfigSchema;
-    targetSchema?: LocationCertaintySchema;
-}>;
-
-type LocationCertaintyDivinerParams = DivinerParams<AnyConfigSchema<LocationCertaintyDivinerConfig>>;
-declare class LocationCertaintyDiviner<TParam extends LocationCertaintyDivinerParams = LocationCertaintyDivinerParams> extends AbstractDiviner<TParam> implements DivinerModule {
-    static readonly configSchemas: Schema[];
-    static readonly defaultConfigSchema: Schema;
-    static readonly targetSchema: "network.xyo.location.certainty";
-    private static calcHeuristic;
-    private static locationsToHeuristics;
-    /** @description Given a set of locations, get the expected elevations (witness if needed), and return score/variance */
-    protected divineHandler(payloads?: Payload[]): Promise<Payload[]>;
-}
-
-declare const LocationCertaintyPlugin: () => _xyo_network_payloadset_plugin.PayloadSetDivinerPlugin<LocationCertaintyDiviner<LocationCertaintyDivinerParams>>;
-
-export { LocationCertaintyDiviner, LocationCertaintyDivinerConfigSchema, LocationCertaintyPlugin, LocationCertaintyPlugin as default };
-export type { LocationCertaintyDivinerConfig, LocationCertaintyDivinerParams };
+export * from './Diviner/index.ts';
+export { LocationCertaintyPlugin as default, LocationCertaintyPlugin } from './Plugin.ts';
+//# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/location-certainty-plugin",
-  "version": "4.1.1",
+  "version": "5.0.0",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -28,27 +28,30 @@
   },
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
   "dependencies": {
-    "@xyo-network/diviner-abstract": "^4.1.7",
-    "@xyo-network/diviner-model": "^4.1.7",
-    "@xyo-network/elevation-plugin": "^4.1.1",
-    "@xyo-network/location-certainty-payload-plugin": "^4.1.1",
-    "@xyo-network/location-payload-plugin": "^4.1.1",
-    "@xyo-network/module-model": "^4.1.7",
-    "@xyo-network/payload-builder": "^4.1.7",
-    "@xyo-network/payload-model": "^4.1.7",
-    "@xyo-network/payloadset-plugin": "^4.1.7"
+    "@xyo-network/diviner-abstract": "^5.0.0",
+    "@xyo-network/diviner-model": "^5.0.0",
+    "@xyo-network/elevation-plugin": "^5.0.0",
+    "@xyo-network/location-certainty-payload-plugin": "^5.0.0",
+    "@xyo-network/location-payload-plugin": "^5.0.0",
+    "@xyo-network/module-model": "^5.0.0",
+    "@xyo-network/payload-builder": "^5.0.0",
+    "@xyo-network/payload-model": "^5.0.0",
+    "@xyo-network/payloadset-plugin": "^5.0.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.24",
-    "@xylabs/tsconfig": "^7.0.0-rc.24",
-    "@xylabs/vitest-extended": "^4.13.23",
-    "@xyo-network/archivist-abstract": "^4.1.7",
-    "@xyo-network/archivist-memory": "^4.1.7",
-    "@xyo-network/elevation-payload-plugin": "^4.1.1",
-    "@xyo-network/module-resolver": "^4.1.7",
+    "@xylabs/ts-scripts-yarn3": "^7.0.2",
+    "@xylabs/tsconfig": "^7.0.2",
+    "@xylabs/vitest-extended": "^5.0.0",
+    "@xyo-network/archivist-abstract": "^5.0.0",
+    "@xyo-network/archivist-memory": "^5.0.0",
+    "@xyo-network/elevation-payload-plugin": "^5.0.0",
+    "@xyo-network/module-resolver": "^5.0.0",
     "fast-text-encoding": "^1.0.6",
-    "knip": "^5.62.0",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },

package/src/Diviner/spec/Diviner.spec.ts

@@ -0,0 +1,143 @@
+import '@xylabs/vitest-extended'
+
+import type { AbstractArchivist } from '@xyo-network/archivist-abstract'
+import { MemoryArchivist } from '@xyo-network/archivist-memory'
+import type { LocationCertaintyPayload } from '@xyo-network/location-certainty-payload-plugin'
+import { LocationCertaintySchema } from '@xyo-network/location-certainty-payload-plugin'
+import type { LocationPayload } from '@xyo-network/location-payload-plugin'
+import { LocationSchema } from '@xyo-network/location-payload-plugin'
+import { CompositeModuleResolver } from '@xyo-network/module-resolver'
+import {
+  beforeEach,
+  describe, expect, it,
+} from 'vitest'
+
+import { LocationCertaintyDivinerConfigSchema } from '../Config.ts'
+import { LocationCertaintyDiviner } from '../Diviner.ts'
+
+const sample1: LocationPayload[] = [
+  {
+    altitude: -5,
+    latitude: 32.716_64,
+    longitude: -117.120_33,
+    schema: LocationSchema,
+  },
+  {
+    altitude: -9,
+    latitude: 32.7174,
+    longitude: -117.116_74,
+    schema: LocationSchema,
+  },
+  {
+    altitude: -11,
+    latitude: 32.717_88,
+    longitude: -117.113_77,
+    schema: LocationSchema,
+  },
+]
+
+const sample2: LocationPayload[] = [
+  {
+    altitude: 50,
+    latitude: 32.716_64,
+    longitude: -117.120_33,
+    schema: LocationSchema,
+  },
+  {
+    altitude: 53,
+    latitude: 32.7174,
+    longitude: -117.116_74,
+    schema: LocationSchema,
+  },
+  {
+    altitude: 55,
+    latitude: 32.717_88,
+    longitude: -117.113_77,
+    schema: LocationSchema,
+  },
+]
+
+const sample3: LocationPayload[] = [
+  {
+    altitude: 151,
+    latitude: 32.716_64,
+    longitude: -117.120_33,
+    schema: LocationSchema,
+  },
+  {
+    altitude: 163,
+    latitude: 32.7174,
+    longitude: -117.116_74,
+    schema: LocationSchema,
+  },
+  {
+    altitude: 168,
+    latitude: 32.717_88,
+    longitude: -117.113_77,
+    schema: LocationSchema,
+  },
+]
+
+describe.skip('MongoDBLocationCertaintyDiviner', () => {
+  let payloadsArchivist: AbstractArchivist
+  let sut: LocationCertaintyDiviner
+  beforeEach(async () => {
+    payloadsArchivist = await MemoryArchivist.create({ account: 'random' })
+    const params = {
+      config: {
+        schema: LocationCertaintyDivinerConfigSchema,
+        targetSchema: LocationCertaintySchema,
+      },
+      resolver: new CompositeModuleResolver({ root: sut }).add(payloadsArchivist),
+    }
+    sut = (await LocationCertaintyDiviner.create(params)) as LocationCertaintyDiviner
+  })
+  describe('divine', () => {
+    describe('with valid query', () => {
+      it('divines', async () => {
+        const noLocations: LocationPayload[] = []
+        const noLocationsResult = await sut.divine(noLocations)
+        expect(noLocationsResult).toBeArrayOfSize(0)
+        const locations: LocationPayload[] = [
+          {
+            altitude: 5, quadkey: '0203', schema: LocationSchema,
+          },
+          {
+            altitude: 300, quadkey: '0102', schema: LocationSchema,
+          },
+        ]
+        const locationsResult = await sut.divine(locations)
+        expect(locationsResult).toBeArrayOfSize(1)
+        const actual = locationsResult[0] as LocationCertaintyPayload
+        expect(actual).toBeObject()
+        expect(actual.schema).toBe(LocationCertaintySchema)
+
+        const locationsResult1 = (await sut.divine(sample1)) as LocationCertaintyPayload[]
+        const locationsResult2 = (await sut.divine(sample2)) as LocationCertaintyPayload[]
+        const locationsResult3 = (await sut.divine(sample3)) as LocationCertaintyPayload[]
+        for (let r of [locationsResult1, locationsResult2, locationsResult3]) {
+          validateLocationResult(r)
+        }
+      })
+    })
+  })
+})
+
+const validateLocationResult = (results: LocationCertaintyPayload[]) => {
+  expect(results).toBeArrayOfSize(1)
+  const [result] = results
+  expect(result).toBeObject()
+  expect(result.schema).toBe(LocationCertaintySchema)
+  expect(result.altitude).toBeObject()
+  expect(result.altitude.max).toBeNumber()
+  expect(result.altitude.mean).toBeNumber()
+  expect(result.altitude.min).toBeNumber()
+  expect(result.elevation).toBeObject()
+  expect(result.elevation.max).toBeNumber()
+  expect(result.elevation.mean).toBeNumber()
+  expect(result.elevation.min).toBeNumber()
+  expect(result.variance).toBeObject()
+  expect(result.variance.max).toBeNumber()
+  expect(result.variance.mean).toBeNumber()
+  expect(result.variance.min).toBeNumber()
+}

package/src/spec/Plugin.dom.spec.ts

@@ -0,0 +1,23 @@
+// Polyfill TextDecoder
+import 'fast-text-encoding'
+import '@xylabs/vitest-extended'
+
+import { LocationCertaintySchema } from '@xyo-network/location-certainty-payload-plugin'
+import { PayloadSetPluginResolver } from '@xyo-network/payloadset-plugin'
+import {
+  describe, expect,
+  test,
+} from 'vitest'
+
+import { LocationCertaintyDivinerConfigSchema } from '../Diviner/index.ts'
+import { LocationCertaintyPlugin } from '../Plugin.ts'
+
+describe('LocationCertaintyPlugin', () => {
+  test('Add to Resolver', async () => {
+    const plugin = LocationCertaintyPlugin()
+    const resolver = await new PayloadSetPluginResolver()
+      .register(plugin, { config: { schema: LocationCertaintyDivinerConfigSchema, targetSchema: LocationCertaintySchema } })
+    expect(await resolver.resolve(plugin.set)).toBeObject()
+    expect(await resolver.diviner(plugin.set)).toBeObject()
+  })
+})

package/typedoc.json

@@ -1,5 +0,0 @@
-{
-  "$schema": "https://typedoc.org/schema.json",
-  "entryPoints": ["./src/index.ts"],
-  "tsconfig": "./tsconfig.typedoc.json"
-}

package/xy.config.ts

@@ -1,10 +0,0 @@
-import type { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
-const config: XyTsupConfig = {
-  compile: {
-    browser: {},
-    node: {},
-    neutral: { src: true },
-  },
-}
-
-export default config