@xyo-network/api 4.3.0 → 5.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/api",
-  "version": "4.3.0",
+  "version": "5.0.0",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -28,26 +28,30 @@
   },
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
   "dependencies": {
-    "@xylabs/axios": "^4.15.0",
-    "@xylabs/typeof": "^4.15.0",
-    "@xyo-network/api-models": "^4.3.0",
-    "@xyo-network/diviner-model": "^4.3.0",
-    "@xyo-network/huri": "^4.3.0",
-    "@xyo-network/payload-model": "^4.3.0",
+    "@xylabs/axios": "^5.0.0",
+    "@xylabs/typeof": "^5.0.0",
+    "@xyo-network/api-models": "^5.0.0",
+    "@xyo-network/diviner-model": "^5.0.0",
+    "@xyo-network/huri": "^5.0.0",
+    "@xyo-network/payload-model": "^5.0.0",
     "axios": "^1.11.0"
   },
   "devDependencies": {
     "@types/node": "^24.1.0",
     "@types/uuid": "^10.0.0",
-    "@xylabs/hex": "^4.15.0",
-    "@xylabs/object": "^4.15.0",
-    "@xylabs/ts-scripts-yarn3": "^7.0.1",
-    "@xylabs/tsconfig": "^7.0.1",
-    "@xylabs/vitest-extended": "^4.15.0",
-    "@xyo-network/boundwitness-model": "^4.3.0",
-    "@xyo-network/module-model": "^4.3.0",
-    "@xyo-network/query-payload-plugin": "^4.3.0",
+    "@xylabs/hex": "^5.0.0",
+    "@xylabs/object": "^5.0.0",
+    "@xylabs/ts-scripts-yarn3": "^7.0.2",
+    "@xylabs/tsconfig": "^7.0.2",
+    "@xylabs/vitest-extended": "^5.0.0",
+    "@xyo-network/boundwitness-model": "^5.0.0",
+    "@xyo-network/module-model": "^5.0.0",
+    "@xyo-network/query-payload-plugin": "^5.0.0",
     "typescript": "^5.8.3",
     "uuid": "^11.1.0",
     "vitest": "^3.2.4"

package/src/Api/spec/Api.spec.ts

@@ -0,0 +1,30 @@
+import '@xylabs/vitest-extended'
+
+import type { AddressPayload } from '@xyo-network/module-model'
+import { AddressSchema } from '@xyo-network/module-model'
+import type { QueryPayload } from '@xyo-network/query-payload-plugin'
+import { QuerySchema } from '@xyo-network/query-payload-plugin'
+import {
+  describe, expect, it,
+} from 'vitest'
+
+import { getApi } from './ApiUtil.spec.ts'
+
+describe('ArchivistApi', () => {
+  describe('get', () => {
+    it('returns Node Discover', async () => {
+      const api = getApi()
+      expect(api).toBeDefined()
+      const response = await api.get()
+      expect(response).toBeArray()
+
+      expect(response).toBeArray()
+      const addressPayload = response?.find(p => p.schema === AddressSchema) as AddressPayload
+      expect(addressPayload).toBeObject()
+      expect(addressPayload.address).toBeString()
+
+      const queries = response?.filter(d => d.schema === QuerySchema) as QueryPayload[]
+      expect(queries.length).toBeGreaterThan(0)
+    })
+  })
+})

package/src/Api/spec/ApiUtil.spec.ts

@@ -0,0 +1,37 @@
+import '@xylabs/vitest-extended'
+
+import type { ApiConfig } from '@xyo-network/api-models'
+import { v4 as uuid } from 'uuid'
+import { expect, test } from 'vitest'
+
+import { ArchivistApi } from '../Api.ts'
+
+test('Must have tests defined', () => {
+  expect(true).toBeTruthy()
+})
+
+export const getApiConfig = (configData: Partial<ApiConfig> = {}): ApiConfig => {
+  const apiDomain = process.env.API_DOMAIN ?? 'http://localhost:8080'
+  const defaults: ApiConfig = {
+    apiDomain,
+    onError: error => error,
+    onFailure: response => response,
+    onSuccess: response => response,
+  }
+  return Object.assign({}, defaults, configData)
+}
+
+export const getApi = (configData: Partial<ApiConfig> = {}): ArchivistApi => {
+  return new ArchivistApi(getApiConfig(configData))
+}
+
+export const testSchemaPrefix = 'network.xyo.schema.test.'
+export const getSchemaName = (): string => {
+  return `${testSchemaPrefix}${uuid()}`
+}
+
+export const getTimestampMinutesFromNow = (minutes = 0) => {
+  const t = new Date()
+  t.setMinutes(t.getMinutes() + minutes)
+  return +t
+}

package/src/Diviner/LocationDiviner/spec/LocationDivinerApi.spec.ts

@@ -0,0 +1,93 @@
+import '@xylabs/vitest-extended'
+
+import type { ApiConfig } from '@xyo-network/api-models'
+import {
+  describe, expect, it,
+} from 'vitest'
+
+import { LocationDivinerApi } from '../LocationDivinerApi.ts'
+import type {
+  LocationHeatmapQueryCreationRequest,
+  LocationTimeRangeQueryCreationRequest,
+} from '../Queries/index.ts'
+import {
+  LocationHeatmapQuerySchema,
+  LocationTimeRangeQuerySchema,
+} from '../Queries/index.ts'
+import { LocationWitnessSchema } from '../Witnesses/index.ts'
+
+const describeIf = <T>(expr?: T | null) => (expr ? describe : describe.skip)
+
+const getLocationApiConfig = (): ApiConfig => {
+  return { apiDomain: process.env.LOCATION_API_DOMAIN || 'http://localhost:8082' }
+}
+
+const getArchiveConfig = (): ApiConfig => {
+  const apiDomain = process.env.API_DOMAIN || 'http://localhost:8080'
+  return { apiDomain }
+}
+
+const getDefaultStartStopTime = () => {
+  const startTime = new Date(0).toISOString()
+  const stopTime = new Date().toISOString()
+  return { startTime, stopTime }
+}
+
+const getLocationTimeRangeQueryCreationRequest = (): LocationTimeRangeQueryCreationRequest => {
+  const query = { schema: LocationWitnessSchema, ...getDefaultStartStopTime() }
+  const sourceArchivist = { ...getArchiveConfig() }
+  const resultArchivist = { ...getArchiveConfig() }
+  return {
+    query,
+    resultArchive: 'temp',
+    resultArchivist,
+    schema: LocationTimeRangeQuerySchema,
+    sourceArchive: 'temp',
+    sourceArchivist,
+  }
+}
+
+const getLocationHeatmapQueryCreationRequest = (): LocationHeatmapQueryCreationRequest => {
+  const query = { schema: LocationWitnessSchema, ...getDefaultStartStopTime() }
+  const sourceArchivist = { ...getArchiveConfig() }
+  const resultArchivist = { ...getArchiveConfig() }
+  return {
+    query,
+    resultArchive: 'temp',
+    resultArchivist,
+    schema: LocationHeatmapQuerySchema,
+    sourceArchive: 'temp',
+    sourceArchivist,
+  }
+}
+
+describeIf(process.env.LOCATION_API_DOMAIN)('LocationDivinerApi', () => {
+  describe('constructor', () => {
+    it('returns a new LocationDivinerApi', () => {
+      const api = new LocationDivinerApi(getLocationApiConfig())
+      expect(api).toBeDefined()
+    })
+  })
+  describe('postLocationQuery', () => {
+    it('posts a location heatmap query', async () => {
+      const api = new LocationDivinerApi(getLocationApiConfig())
+      const locationQuery = await api.postLocationQuery(getLocationHeatmapQueryCreationRequest())
+      const response = await api.getLocationQuery(locationQuery.hash)
+      expect(response.queryHash).toBe(locationQuery.hash)
+    })
+    it('posts a location time range query', async () => {
+      const api = new LocationDivinerApi(getLocationApiConfig())
+      const locationQuery = await api.postLocationQuery(getLocationTimeRangeQueryCreationRequest())
+      const response = await api.getLocationQuery(locationQuery.hash)
+      expect(response.queryHash).toBe(locationQuery.hash)
+    })
+  })
+  describe('getLocationQuery', function () {
+    it('gets the status of a previously posted location query', async () => {
+      const api = new LocationDivinerApi(getLocationApiConfig())
+      const locationQuery = await api.postLocationQuery(getLocationTimeRangeQueryCreationRequest())
+      const response = await api.getLocationQuery(locationQuery.hash)
+      expect(response.queryHash).toBe(locationQuery.hash)
+    })
+  })
+})

package/src/Test/index.spec.ts

@@ -0,0 +1,8 @@
+export * from './testBoundWitness.spec.ts'
+export * from './testPayload.spec.ts'
+
+import { expect, it } from 'vitest'
+
+it('no test', () => {
+  expect(true).toBeTruthy()
+})

package/src/Test/testBoundWitness.spec.ts

@@ -0,0 +1,22 @@
+import {
+  asAddress, asHash, asHex,
+} from '@xylabs/hex'
+import type { BoundWitness } from '@xyo-network/boundwitness-model'
+import { BoundWitnessSchema } from '@xyo-network/boundwitness-model'
+import { it } from 'vitest'
+
+const testBoundWitness: BoundWitness = {
+  $signatures: [asHex(
+    '95100e5fd2012b958e96895870cfac5353c3a33a19314cfd1304ef7d01d052ec2a3ef80d6449cf88d463027fe0d868ed8cfb8b7323d37e93a08570233eea0b17',
+    true,
+  )],
+  addresses: [asAddress('5346a2ce56ec4177b67092bda710e150ba6fa046', true)],
+  payload_hashes: [asHash('20e14207f952a09f767ff614a648546c037fe524ace0bfe55db31f818aff1f1c', true)],
+  payload_schemas: ['network.xyo.test'],
+  previous_hashes: [null],
+  schema: BoundWitnessSchema,
+} as BoundWitness
+
+it('no test', () => {})
+
+export { testBoundWitness }

package/src/Test/testPayload.spec.ts

@@ -0,0 +1,22 @@
+import type { StringKeyObject } from '@xylabs/object'
+import type { Payload } from '@xyo-network/payload-model'
+import { expect, it } from 'vitest'
+
+const testSchema = 'network.xyo.test'
+const testPayload: Payload<StringKeyObject> = {
+  _hash: '20e14207f952a09f767ff614a648546c037fe524ace0bfe55db31f818aff1f1c',
+  _timestamp: 1_609_459_255_555,
+  numberField: 1,
+  objectField: {
+    numberField: 1,
+    stringField: 'stringValue',
+  },
+  schema: testSchema,
+  stringField: 'stringValue',
+}
+
+it('no test', () => {
+  expect(true).toBeTruthy()
+})
+
+export { testPayload, testSchema }

package/xy.config.ts

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