@xyo-network/api 2.47.8 → 2.47.10

package/src/Api/Payload/Schema/Api.spec.ts

@@ -1,61 +0,0 @@
-import { XyoApiConfig } from '@xyo-network/api-models'
-import { BoundWitnessBuilder } from '@xyo-network/boundwitness-builder'
-import { XyoSchemaPayload, XyoSchemaSchema } from '@xyo-network/schema-payload-plugin'
-
-import { XyoArchivistApi } from '../../Api'
-import { getNewArchive, getSchemaName } from '../../ApiUtil.spec'
-
-const config: XyoApiConfig = {
-  apiDomain: process.env.API_DOMAIN || 'http://localhost:8080',
-}
-
-const payload: XyoSchemaPayload = {
-  definition: {
-    $id: '',
-    $schema: 'http://json-schema.org/draft-07/schema#',
-    schema: getSchemaName(),
-  },
-  schema: XyoSchemaSchema,
-}
-
-describe('XyoArchivistArchiveSchemaApi', () => {
-  const api = new XyoArchivistApi(config)
-  let archive = ''
-  beforeAll(async () => {
-    archive = await getNewArchive(api)
-    const [boundWitness] = new BoundWitnessBuilder({ inlinePayloads: true }).payload(payload).build()
-    await api.archives.archive(archive).block.post([boundWitness])
-  })
-  describe('get', () => {
-    it('calculates the correct path', () => {
-      const api = new XyoArchivistApi(config)
-      const path = api.archive(archive).payload.schema.config.root
-      expect(path).toBe(`/archive/${archive}/payload/schema/`)
-    })
-    it('lists the schema in the archive', async () => {
-      const api = new XyoArchivistApi(config)
-      const response = await api.archive(archive).payload.schema.get()
-      expect(response).toBeTruthy()
-      expect(Array.isArray(response)).toBe(true)
-      expect(response?.length).toBe(1)
-      expect(response?.[0]).toBe(payload.schema)
-    })
-  })
-  describe('stats', () => {
-    it('calculates the correct path', () => {
-      const api = new XyoArchivistApi(config)
-      const path = api.archive(archive).payload.schema.stats.config.root
-      expect(path).toBe(`/archive/${archive}/payload/schema/stats/`)
-    })
-    it('lists the stats for the payloads by schema in the archive', async () => {
-      const api = new XyoArchivistApi(config)
-      const response = await api.archive(archive).payload.schema.stats.get()
-      expect(response).toBeTruthy()
-      expect(response?.counts).toBeTruthy()
-      const schemas = Object.keys(response?.counts || {})
-      expect(schemas.length).toBe(1)
-      expect(schemas?.[0]).toBe(payload.schema)
-      expect(response?.counts[payload.schema]).toBe(1)
-    })
-  })
-})

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

@@ -1,23 +0,0 @@
-import { AddressPayload, AddressSchema } from '@xyo-network/address-payload-plugin'
-import { QueryPayload, QuerySchema } from '@xyo-network/query-payload-plugin'
-
-import { getApi } from '../ApiUtil.spec'
-
-describe('XyoArchivistApi', () => {
-  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/Archivist/XyoRemoteArchivist.spec.ts

@@ -1,55 +0,0 @@
-import { XyoApiConfig } from '@xyo-network/api-models'
-import { ArchivistWrapper } from '@xyo-network/archivist-wrapper'
-import { XyoBoundWitnessSchema } from '@xyo-network/boundwitness-model'
-import { PayloadWrapper } from '@xyo-network/payload-wrapper'
-import { IdSchema } from '@xyo-network/plugins'
-
-import { XyoArchivistApi } from '../Api'
-import { XyoRemoteArchivist } from './XyoRemoteArchivist'
-import { XyoRemoteArchivistConfigSchema } from './XyoRemoteArchivistConfig'
-
-const configData: XyoApiConfig = {
-  apiDomain: process.env.API_DOMAIN || 'http://locahost:8080',
-  onError: (error) => error,
-  onFailure: (response) => response,
-  onSuccess: (response) => response,
-}
-
-const payload = {
-  salt: `${Math.random() * 10000}`,
-  schema: IdSchema,
-}
-
-describe('XyoRemoteArchivist', () => {
-  let archivist: XyoRemoteArchivist
-  let wrapper: ArchivistWrapper
-
-  beforeEach(async () => {
-    const api = new XyoArchivistApi(configData)
-    archivist = await XyoRemoteArchivist.create({ config: { api, schema: XyoRemoteArchivistConfigSchema } })
-    wrapper = new ArchivistWrapper(archivist)
-  })
-
-  it('get return payloads', async () => {
-    const result = (await archivist.insert([payload])).pop()
-    expect(result?.payload_hashes.length).toBe(1)
-    const getResult = await archivist.get([new PayloadWrapper(payload).hash])
-    expect(getResult.length).toBe(1)
-    expect(getResult[0]?.schema).toBe(payload.schema)
-
-    const findResult = await wrapper.find()
-    expect(findResult.length).toBe(20)
-  })
-
-  it('get returns boundwitness', async () => {
-    const payload = {
-      payload_hashes: ['123456'],
-      payload_schemas: [IdSchema],
-      schema: XyoBoundWitnessSchema,
-    }
-
-    await archivist.insert([payload])
-    const getResult = await archivist.get([new PayloadWrapper(payload).hash])
-    expect(getResult?.[0].schema).toBe(XyoBoundWitnessSchema)
-  })
-})

package/src/Diviner/AddressHistoryDiviner/XyoRemoteAddressHistoryDiviner.spec.ts

@@ -1,81 +0,0 @@
-import { Account } from '@xyo-network/account'
-import { XyoApiConfig } from '@xyo-network/api-models'
-import { XyoBoundWitness, XyoBoundWitnessSchema } from '@xyo-network/boundwitness-model'
-import { BoundWitnessWrapper } from '@xyo-network/boundwitness-wrapper'
-import { AddressHistoryQueryPayload, AddressHistoryQuerySchema, DivinerWrapper } from '@xyo-network/diviner'
-import { XyoPayloadBuilder } from '@xyo-network/payload-builder'
-
-import { XyoArchivistApi } from '../../Api'
-import { XyoRemoteDivinerConfigSchema } from '../XyoRemoteDivinerConfig'
-import { XyoRemoteAddressHistoryDiviner } from './XyoRemoteAddressHistoryDiviner'
-
-const configData: XyoApiConfig = {
-  apiDomain: process.env.API_DOMAIN || 'http://locahost:8080',
-  onError: (error) => error,
-  onFailure: (response) => response,
-  onSuccess: (response) => response,
-}
-
-describe('XyoRemoteAddressHistoryDiviner', () => {
-  const address = new Account({ phrase: 'test' }).addressValue.hex
-  const api = new XyoArchivistApi(configData)
-  let diviner: XyoRemoteAddressHistoryDiviner
-  beforeAll(async () => {
-    diviner = await XyoRemoteAddressHistoryDiviner.create({ config: { api, schema: XyoRemoteDivinerConfigSchema } })
-  })
-
-  describe('with valid address returns', () => {
-    let result: XyoBoundWitness[]
-    beforeAll(async () => {
-      const source = new XyoPayloadBuilder<AddressHistoryQueryPayload>({ schema: AddressHistoryQuerySchema }).fields({ address }).build()
-      result = (await new DivinerWrapper(diviner).divine([source])) as XyoBoundWitness[]
-      expect(result.length).toBeGreaterThan(0)
-    })
-    it('array of Bound Witnesses', () => {
-      result.map((bw) => {
-        expect(bw.schema).toBe(XyoBoundWitnessSchema)
-      })
-    })
-    it('from address', () => {
-      expect(result.length).toBeGreaterThan(0)
-      result.map((bw) => {
-        expect(bw.addresses).toContain(address)
-      })
-    })
-  })
-  describe('with hash offset returns', () => {
-    let result: XyoBoundWitness[]
-    let hash: string
-    beforeAll(async () => {
-      let source = new XyoPayloadBuilder<AddressHistoryQueryPayload>({ schema: AddressHistoryQuerySchema }).fields({ address }).build()
-      result = (await new DivinerWrapper(diviner).divine([source])) as XyoBoundWitness[]
-      expect(result.length).toBeGreaterThan(0)
-      hash = new BoundWitnessWrapper(result?.[0]).hash
-      source = new XyoPayloadBuilder<AddressHistoryQueryPayload>({ schema: AddressHistoryQuerySchema }).fields({ address, offset: hash }).build()
-      result = (await new DivinerWrapper(diviner).divine([source])) as XyoBoundWitness[]
-      expect(result.length).toBeGreaterThan(0)
-    })
-    it('results starting at hash', () => {
-      expect(new BoundWitnessWrapper(result?.[0]).hash).toBe(hash)
-    })
-  })
-  describe('with limit returns', () => {
-    const limit = 1
-    let result: XyoBoundWitness[]
-    beforeAll(async () => {
-      const source = new XyoPayloadBuilder<AddressHistoryQueryPayload>({ schema: AddressHistoryQuerySchema }).fields({ address, limit }).build()
-      result = (await new DivinerWrapper(diviner).divine([source])) as XyoBoundWitness[]
-      expect(result.length).toBeGreaterThan(0)
-    })
-    it('number of results specified by the limit', () => {
-      expect(result.length).toBe(limit)
-    })
-  })
-  describe('with non-existent address', () => {
-    it('returns empty array', async () => {
-      const source = new XyoPayloadBuilder<AddressHistoryQueryPayload>({ schema: AddressHistoryQuerySchema }).fields({ address: 'foo' }).build()
-      const result = await new DivinerWrapper(diviner).divine([source])
-      expect(result.length).toBe(0)
-    })
-  })
-})

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

@@ -1,18 +0,0 @@
-import { XyoApiConfig } from '@xyo-network/api-models'
-
-import { XyoArchivistApi } from '../../Api'
-import { ArchiveListApiDiviner } from './ArchiveListApiDiviner'
-import { XyoArchiveListApiDivinerConfigSchema, XyoArchiveSchema } from './ArchiveListApiDivinerConfig'
-
-const configData: XyoApiConfig = {
-  apiDomain: process.env.API_DOMAIN || 'http://locahost:8080',
-}
-
-test('ArchiveListApiDiviner', async () => {
-  const api = new XyoArchivistApi(configData)
-  const diviner = await ArchiveListApiDiviner.create({ api, config: { schema: XyoArchiveListApiDivinerConfigSchema } })
-  expect(diviner).toBeDefined()
-  const result = await diviner.divine()
-  expect(result.length).toBeGreaterThan(0)
-  expect(result[0].schema).toBe(XyoArchiveSchema)
-})

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

@@ -1,89 +0,0 @@
-import { XyoApiConfig } from '@xyo-network/api-models'
-
-import { ApiConfig } from '../ApiConfig'
-import { XyoLocationDivinerApi } from '../LocationDivinerApi'
-import {
-  LocationHeatmapQueryCreationRequest,
-  locationHeatmapQuerySchema,
-  LocationTimeRangeQueryCreationRequest,
-  LocationTimeRangeQuerySchema,
-} from '../Queries'
-import { LocationWitnessSchema } from '../Witnesses'
-
-const getLocationApiConfig = (): ApiConfig => {
-  return {
-    apiDomain: process.env.LOCATION_API_DOMAIN || 'http://localhost:8082',
-  }
-}
-
-const getArchiveConfig = (): XyoApiConfig => {
-  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,
-  }
-}
-
-const describeSkipIfNoDiviner = process.env.LOCATION_API_DOMAIN ? describe : describe.skip
-
-describeSkipIfNoDiviner('XyoLocationDivinerApi', () => {
-  describe('constructor', () => {
-    it('returns a new XyoLocationDivinerApi', () => {
-      const api = new XyoLocationDivinerApi(getLocationApiConfig())
-      expect(api).toBeDefined()
-    })
-  })
-  describe('postLocationQuery', () => {
-    it('posts a location heatmap query', async () => {
-      const api = new XyoLocationDivinerApi(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 XyoLocationDivinerApi(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 XyoLocationDivinerApi(getLocationApiConfig())
-      const locationQuery = await api.postLocationQuery(getLocationTimeRangeQueryCreationRequest())
-      const response = await api.getLocationQuery(locationQuery.hash)
-      expect(response.queryHash).toBe(locationQuery.hash)
-    })
-  })
-})

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

@@ -1,22 +0,0 @@
-/* eslint-disable deprecation/deprecation */
-/* eslint-disable import/no-deprecated */
-import { XyoApiConfig } from '@xyo-network/api-models'
-
-import { XyoArchivistApi } from '../../Api'
-import { SchemaListApiDiviner } from './SchemaListApiDiviner'
-import { XyoSchemaListApiDivinerConfigSchema } from './SchemaListApiDivinerConfig'
-
-const configData: XyoApiConfig = {
-  apiDomain: process.env.API_DOMAIN || 'http://locahost:8080',
-}
-
-test('SchemaListApiDiviner', async () => {
-  const api = new XyoArchivistApi(configData)
-  const diviner = await SchemaListApiDiviner.create({
-    api,
-    config: { archive: 'temp', schema: XyoSchemaListApiDivinerConfigSchema },
-  })
-  expect(diviner).toBeDefined()
-  const result = await diviner.divine()
-  expect(result.length).toBeGreaterThan(0)
-})

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

@@ -1,19 +0,0 @@
-/* eslint-disable deprecation/deprecation */
-/* eslint-disable import/no-deprecated */
-import { XyoApiConfig } from '@xyo-network/api-models'
-
-import { XyoArchivistApi } from '../../Api'
-import { SchemaStatsApiDiviner } from './SchemaStatsApiDiviner'
-import { XyoSchemaStatsApiDivinerConfigSchema } from './SchemaStatsApiDivinerConfig'
-
-const configData: XyoApiConfig = {
-  apiDomain: process.env.API_DOMAIN || 'http://locahost:8080',
-}
-
-test('SchemaStatsApiDiviner', async () => {
-  const api = new XyoArchivistApi(configData)
-  const diviner = await SchemaStatsApiDiviner.create({ api, config: { archive: 'temp', schema: XyoSchemaStatsApiDivinerConfigSchema } })
-  expect(diviner).toBeDefined()
-  const result = await diviner.divine()
-  expect(result.length).toBeGreaterThan(0)
-})

package/src/User/Api.spec.ts

@@ -1,31 +0,0 @@
-import { XyoApiConfig } from '@xyo-network/api-models'
-import { typeOf } from '@xyo-network/typeof'
-
-import { XyoArchivistApi } from '../Api'
-import { XyoUserApi } from './Api'
-
-const timeout = 20000
-const config: XyoApiConfig = {
-  apiDomain: process.env.API_DOMAIN || 'http://localhost:8080',
-}
-
-describe('XyoAuthApi', () => {
-  describe('get', () => {
-    it('returns a new XyoAuthApi', () => {
-      const api = new XyoUserApi(config)
-      expect(api).toBeDefined()
-    })
-  })
-  describe('walletChallenge', function () {
-    it(
-      'returns a nonce',
-      async () => {
-        const api = new XyoArchivistApi(config)
-        const response = await api.account('0xfEf40940e776A3686Cb29eC712d60859EA9f99F7').challenge.post()
-        expect(response?.state).toBeDefined()
-        expect(typeOf(response?.state)).toBe('string')
-      },
-      timeout,
-    )
-  })
-})