@xyo-network/api 2.50.4 → 2.50.6

package/src/Archivist/XyoRemoteArchivist.ts

@@ -1,130 +0,0 @@
-import { AbstractArchivist, ArchivistFindQuerySchema, ArchivistInsertQuerySchema, ArchivistParams } from '@xyo-network/archivist'
-import { isXyoBoundWitnessPayload, XyoBoundWitness } from '@xyo-network/boundwitness-model'
-import { ModuleParams } from '@xyo-network/module'
-import { PayloadFindFilter, XyoPayload } from '@xyo-network/payload-model'
-import { PayloadWrapper } from '@xyo-network/payload-wrapper'
-import compact from 'lodash/compact'
-
-import { XyoArchivistApi } from '../Api'
-import { RemoteArchivistError } from './RemoteArchivistError'
-import { XyoRemoteArchivistConfig, XyoRemoteArchivistConfigSchema } from './XyoRemoteArchivistConfig'
-
-export type XyoRemoteArchivistParams = ModuleParams<XyoRemoteArchivistConfig> & { api?: XyoArchivistApi }
-
-/** @description Archivist Context that connects to a remote archivist using the API */
-export class XyoRemoteArchivist extends AbstractArchivist<ArchivistParams<XyoRemoteArchivistConfig>> {
-  static override configSchema = XyoRemoteArchivistConfigSchema
-  protected _api?: XyoArchivistApi
-
-  constructor(params: XyoRemoteArchivistParams) {
-    super(params)
-    this._api = params?.api
-  }
-
-  get api() {
-    if (this._api) {
-      return this._api
-    }
-    // eslint-disable-next-line deprecation/deprecation
-    if (this.config?.api) {
-      this.logger?.warn('api specified in config but should be specified in params')
-      // eslint-disable-next-line deprecation/deprecation
-      return this.config?.api
-    }
-    throw Error('No api specified')
-  }
-
-  get archive() {
-    return this.config?.archive
-  }
-
-  override get queries(): string[] {
-    return [ArchivistFindQuerySchema, ArchivistInsertQuerySchema, ...super.queries]
-  }
-
-  static override async create(params?: XyoRemoteArchivistParams): Promise<XyoRemoteArchivist> {
-    return (await super.create(params)) as XyoRemoteArchivist
-  }
-
-  override async find<R extends XyoPayload = XyoPayload>(filter: PayloadFindFilter): Promise<R[]> {
-    try {
-      const [payloads = [], payloadEnvelope, payloadResponse] = await this.api.archive(this.archive).payload.find(filter, 'tuple')
-      if (payloadEnvelope?.errors?.length) {
-        throw new RemoteArchivistError('find', payloadEnvelope.errors.shift(), 'payloads')
-      }
-      if (payloadResponse?.status >= 300) {
-        throw new RemoteArchivistError('find', `Invalid payload status [${payloadResponse.status}]`, 'payloads')
-      }
-      const [blocks = [], blockEnvelope, blockResponse] = await this.api.archive(this.archive).block.find(filter, 'tuple')
-      if (blockEnvelope?.errors?.length) {
-        throw new RemoteArchivistError('find', blockEnvelope.errors.shift(), 'payloads')
-      }
-      if (blockResponse?.status >= 300) {
-        throw new RemoteArchivistError('find', `Invalid block status [${blockResponse.status}]`, 'payloads')
-      }
-      return payloads.concat(blocks) as R[]
-    } catch (ex) {
-      console.error(ex)
-      throw ex
-    }
-  }
-
-  override async get(hashes: string[]): Promise<XyoPayload[]> {
-    return compact(
-      await Promise.all(
-        hashes.map(async (hash) => {
-          try {
-            const [payloads = [], payloadEnvelope, payloadResponse] = await this.api.archive(this.archive).payload.hash(hash).get('tuple')
-            if (payloadResponse?.status >= 400) {
-              throw new RemoteArchivistError('get', `Invalid payload status [${payloadResponse.status}]`, 'payloads')
-            }
-            if (payloadEnvelope?.errors?.length) {
-              throw new RemoteArchivistError('get', payloadEnvelope.errors.shift(), 'payloads')
-            }
-            const [blocks = [], blockEnvelope, blockResponse] = await this.api.archive(this.archive).block.hash(hash).get('tuple')
-            if (blockResponse?.status >= 400) {
-              throw new RemoteArchivistError('get', `Invalid block status [${blockResponse.status}]`, 'payloads')
-            }
-            if (blockEnvelope?.errors?.length) {
-              throw new RemoteArchivistError('get', blockEnvelope.errors.shift(), 'blocks')
-            }
-            return payloads?.[0] ?? blocks?.[0]
-          } catch (ex) {
-            console.error(ex)
-            throw ex
-          }
-        }),
-      ),
-    )
-  }
-
-  async insert(payloads: XyoPayload[]): Promise<XyoBoundWitness[]> {
-    try {
-      const boundWitnesses: XyoBoundWitness[] = payloads.filter(isXyoBoundWitnessPayload)
-      boundWitnesses.forEach((boundwitness) => {
-        // doing this here to prevent breaking code (for now)
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const anyBoundwitness: any = boundwitness
-        anyBoundwitness._payloads ===
-          payloads.filter((payload) => {
-            const hash = new PayloadWrapper(payload).hash
-            return boundwitness.payload_hashes.includes(hash)
-          })
-      })
-      const [boundwitness] = await this.bindResult(payloads)
-      const bwWithMeta: XyoBoundWitness & { _payloads: XyoPayload[] } = { ...boundwitness, _payloads: payloads }
-      const bwResult = await this.api.archive(this.archive).block.post([bwWithMeta], 'tuple')
-      const [, response, error] = bwResult
-      if (error?.status >= 400) {
-        throw new RemoteArchivistError('insert', `${error.statusText} [${error.status}]`)
-      }
-      if (response?.errors?.length) {
-        throw new RemoteArchivistError('insert', response?.errors)
-      }
-      return [boundwitness]
-    } catch (ex) {
-      console.error(ex)
-      throw ex
-    }
-  }
-}

package/src/Archivist/XyoRemoteArchivistConfig.ts

@@ -1,16 +0,0 @@
-import { ArchivistConfig } from '@xyo-network/archivist'
-import { XyoPayload } from '@xyo-network/payload-model'
-
-import { XyoArchivistApi } from '../Api'
-
-export type XyoRemoteArchivistConfigSchema = 'network.xyo.archivist.remote.config'
-export const XyoRemoteArchivistConfigSchema: XyoRemoteArchivistConfigSchema = 'network.xyo.archivist.remote.config'
-
-export type XyoRemoteArchivistConfig<T extends XyoPayload = XyoPayload> = ArchivistConfig<
-  {
-    /** @deprecated pass api in params instead */
-    api?: XyoArchivistApi
-    archive?: string
-    schema: XyoRemoteArchivistConfigSchema
-  } & T
->

package/src/Archivist/index.ts

@@ -1,3 +0,0 @@
-export * from './RemoteArchivistError'
-export * from './XyoRemoteArchivist'
-export * from './XyoRemoteArchivistConfig'

package/src/Diviner/AddressHistoryDiviner/XyoRemoteAddressHistoryDiviner.ts

@@ -1,70 +0,0 @@
-import { assertEx } from '@xylabs/assert'
-import { XyoBoundWitness, XyoBoundWitnessSchema } from '@xyo-network/boundwitness-model'
-import { AbstractDiviner, AddressHistoryDiviner, DivinerParams, isAddressHistoryQueryPayload } from '@xyo-network/diviner'
-import { ModuleParams } from '@xyo-network/module'
-import { XyoPayloads } from '@xyo-network/payload-model'
-
-import { XyoArchivistApi } from '../../Api'
-import { RemoteDivinerError } from '../RemoteDivinerError'
-import { XyoRemoteDivinerConfig, XyoRemoteDivinerConfigSchema } from '../XyoRemoteDivinerConfig'
-
-export type XyoRemoteAddressHistoryDivinerParams = ModuleParams<XyoRemoteDivinerConfig> & {
-  api?: XyoArchivistApi
-}
-
-/** @description Diviner Context that connects to a remote Diviner using the API */
-export class XyoRemoteAddressHistoryDiviner extends AbstractDiviner<DivinerParams<XyoRemoteDivinerConfig>> implements AddressHistoryDiviner {
-  static override configSchema = XyoRemoteDivinerConfigSchema
-  static override targetSchema = XyoBoundWitnessSchema
-
-  protected _api?: XyoArchivistApi
-
-  protected constructor(params: XyoRemoteAddressHistoryDivinerParams) {
-    super(params)
-    this._api = params?.api
-  }
-
-  get api() {
-    if (this._api) {
-      return this._api
-    }
-    // eslint-disable-next-line deprecation/deprecation
-    if (this.config?.api) {
-      this.logger?.warn('api specified in config but should be specified in params')
-      // eslint-disable-next-line deprecation/deprecation
-      return this.config?.api
-    }
-    throw Error('No api specified')
-  }
-
-  static override async create(params?: XyoRemoteAddressHistoryDivinerParams) {
-    return (await super.create(params)) as XyoRemoteAddressHistoryDiviner
-  }
-
-  override async divine(payloads?: XyoPayloads): Promise<XyoBoundWitness[]> {
-    if (!payloads) return []
-    try {
-      const query = payloads.find(isAddressHistoryQueryPayload)
-      if (!query) return []
-      const { address, limit, offset } = query
-      const singleAddress = assertEx(Array.isArray(address) ? address[0] : address, 'At least one address required')
-      const find: { limit?: number; offset?: string } = {}
-      if (limit) find.limit = limit
-      if (offset) find.offset = `${offset}`
-      const [data, body, response] =
-        Object.keys(find).length > 0
-          ? await this.api.addresses.address(singleAddress).boundWitnesses.find(find, 'tuple')
-          : await this.api.addresses.address(singleAddress).boundWitnesses.get('tuple')
-      if (response?.status >= 400) {
-        throw new RemoteDivinerError('divine', `${response.statusText} [${response.status}]`)
-      }
-      if (body?.errors?.length) {
-        throw new RemoteDivinerError('divine', body?.errors)
-      }
-      return data || []
-    } catch (ex) {
-      console.error(ex)
-      throw ex
-    }
-  }
-}

package/src/Diviner/AddressHistoryDiviner/index.ts

@@ -1 +0,0 @@
-export * from './XyoRemoteAddressHistoryDiviner'

package/src/Diviner/SchemaListApiDiviner/Payload.ts

@@ -1,9 +0,0 @@
-import { XyoPayload } from '@xyo-network/payload-model'
-import { XyoSchemaSchema } from '@xyo-network/schema-payload-plugin'
-
-export type SchemaList = XyoPayload<
-  {
-    name: string
-  },
-  XyoSchemaSchema
->

package/src/Diviner/SchemaListApiDiviner/SchemaListApiDiviner.ts

@@ -1,49 +0,0 @@
-/* eslint-disable deprecation/deprecation */
-import { assertEx } from '@xylabs/assert'
-import { AbstractDiviner, DivinerParams } from '@xyo-network/diviner'
-import { ModuleParams } from '@xyo-network/module'
-import { XyoSchemaSchema } from '@xyo-network/schema-payload-plugin'
-
-import { XyoArchivistApi } from '../../Api'
-import { SchemaList } from './Payload'
-import { XyoSchemaListApiDivinerConfig, XyoSchemaListApiDivinerConfigSchema } from './SchemaListApiDivinerConfig'
-
-export type XyoSchemaListApiDivinerParams = ModuleParams<XyoSchemaListApiDivinerConfig> & { api: XyoArchivistApi }
-
-/** @deprecated - send query to remote module instead */
-export class SchemaListApiDiviner extends AbstractDiviner<DivinerParams<XyoSchemaListApiDivinerConfig>> {
-  static override configSchema = XyoSchemaListApiDivinerConfigSchema
-  static override targetSchema = XyoSchemaSchema
-
-  protected readonly api: XyoArchivistApi
-
-  protected constructor(params: XyoSchemaListApiDivinerParams) {
-    super(params)
-    this.api = params.api
-  }
-
-  get archive() {
-    return assertEx(this.config?.archive, `SchemaListApiDiviner config.archive required [${JSON.stringify(this.config, null, 2)}]`)
-  }
-
-  static override async create(params: XyoSchemaListApiDivinerParams): Promise<SchemaListApiDiviner> {
-    return (await super.create(params)) as SchemaListApiDiviner
-  }
-
-  async divine(): Promise<SchemaList[]> {
-    const apiResult = (await this.api.archive(this.archive)?.payload.schema.get()) ?? []
-    return (
-      apiResult.map((schema) => {
-        return {
-          name: schema,
-          schema: XyoSchemaSchema,
-        }
-      }) ?? []
-    )
-  }
-
-  protected override async start() {
-    await super.start()
-    return this
-  }
-}

package/src/Diviner/SchemaListApiDiviner/SchemaListApiDivinerConfig.ts

@@ -1,13 +0,0 @@
-import { DivinerConfig } from '@xyo-network/diviner-model'
-import { XyoPayload } from '@xyo-network/payload-model'
-
-export type XyoSchemaListApiDivinerConfigSchema = 'network.xyo.diviner.schema.list.api.config'
-export const XyoSchemaListApiDivinerConfigSchema: XyoSchemaListApiDivinerConfigSchema = 'network.xyo.diviner.schema.list.api.config'
-
-export type XyoSchemaListApiDivinerConfig<T extends XyoPayload = XyoPayload> = DivinerConfig<
-  XyoPayload,
-  T & {
-    archive: string
-    schema: XyoSchemaListApiDivinerConfigSchema
-  }
->

package/src/Diviner/SchemaListApiDiviner/index.ts

@@ -1,3 +0,0 @@
-export * from './Payload'
-export * from './SchemaListApiDiviner'
-export * from './SchemaListApiDivinerConfig'

package/src/Diviner/SchemaStatsApiDiviner/Payload.ts

@@ -1,11 +0,0 @@
-import { XyoPayload } from '@xyo-network/payload-model'
-
-export type SchemaStatsSchema = 'network.xyo.schema.stats'
-export const SchemaStatsSchema: SchemaStatsSchema = 'network.xyo.schema.stats'
-
-export type SchemaStats = XyoPayload<
-  {
-    counts: Record<string, number>
-  },
-  SchemaStatsSchema
->

package/src/Diviner/SchemaStatsApiDiviner/SchemaStatsApiDiviner.ts

@@ -1,47 +0,0 @@
-/* eslint-disable deprecation/deprecation */
-import { assertEx } from '@xylabs/assert'
-import { AbstractDiviner, DivinerParams } from '@xyo-network/diviner'
-import { ModuleParams } from '@xyo-network/module'
-
-import { XyoArchivistApi } from '../../Api'
-import { SchemaStats, SchemaStatsSchema } from './Payload'
-import { XyoSchemaStatsApiDivinerConfig, XyoSchemaStatsApiDivinerConfigSchema } from './SchemaStatsApiDivinerConfig'
-
-export type XyoSchemaStatsApiDivinerParams = ModuleParams<XyoSchemaStatsApiDivinerConfig> & { api: XyoArchivistApi }
-
-/** @deprecated - send query to remote module instead */
-export class SchemaStatsApiDiviner extends AbstractDiviner<DivinerParams<XyoSchemaStatsApiDivinerConfig>> {
-  static override configSchema = XyoSchemaStatsApiDivinerConfigSchema
-  static override targetSchema = SchemaStatsSchema
-
-  protected readonly api: XyoArchivistApi
-
-  protected constructor(params: XyoSchemaStatsApiDivinerParams) {
-    super(params)
-    this.api = params.api
-  }
-
-  get archive() {
-    return assertEx(this.config?.archive, `SchemaStatsApiDiviner config.archive required [${JSON.stringify(this.config, null, 2)}]`)
-  }
-
-  static override async create(params: XyoSchemaStatsApiDivinerParams): Promise<SchemaStatsApiDiviner> {
-    return (await super.create(params)) as SchemaStatsApiDiviner
-  }
-
-  async divine(): Promise<SchemaStats[]> {
-    const stats = await this.api.archive(this.archive).payload.schema.stats.get()
-    const result: SchemaStats[] = [
-      {
-        counts: stats?.counts ?? {},
-        schema: SchemaStatsSchema,
-      },
-    ]
-    return result
-  }
-
-  protected override async start() {
-    await super.start()
-    return this
-  }
-}

package/src/Diviner/SchemaStatsApiDiviner/SchemaStatsApiDivinerConfig.ts

@@ -1,13 +0,0 @@
-import { DivinerConfig } from '@xyo-network/diviner-model'
-import { XyoPayload } from '@xyo-network/payload-model'
-
-export type XyoSchemaStatsApiDivinerConfigSchema = 'network.xyo.diviner.schema.stats.api.config'
-export const XyoSchemaStatsApiDivinerConfigSchema: XyoSchemaStatsApiDivinerConfigSchema = 'network.xyo.diviner.schema.stats.api.config'
-
-export type XyoSchemaStatsApiDivinerConfig<T extends XyoPayload = XyoPayload> = DivinerConfig<
-  XyoPayload,
-  T & {
-    archive: string
-    schema: XyoSchemaStatsApiDivinerConfigSchema
-  }
->

package/src/Diviner/SchemaStatsApiDiviner/index.ts

@@ -1,3 +0,0 @@
-export * from './Payload'
-export * from './SchemaStatsApiDiviner'
-export * from './SchemaStatsApiDivinerConfig'