@xyo-network/api 2.50.5 → 2.51.0

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/ArchiveListApiDiviner/ArchiveListApiDiviner.ts

@@ -1,41 +0,0 @@
-import { AbstractDiviner, DivinerParams } from '@xyo-network/diviner'
-import { ModuleParams } from '@xyo-network/module'
-
-import { XyoArchivistApi } from '../../Api'
-import { XyoArchiveListApiDivinerConfig, XyoArchiveListApiDivinerConfigSchema, XyoArchiveSchema } from './ArchiveListApiDivinerConfig'
-import { ArchiveList } from './Payload'
-
-export type XyoArchiveListApiDivinerParams = ModuleParams<XyoArchiveListApiDivinerConfig> & { api: XyoArchivistApi }
-
-export class ArchiveListApiDiviner extends AbstractDiviner<DivinerParams<XyoArchiveListApiDivinerConfig>> {
-  static override configSchema = XyoArchiveListApiDivinerConfigSchema
-  static override targetSchema = XyoArchiveSchema
-
-  protected readonly api: XyoArchivistApi
-
-  protected constructor(params: XyoArchiveListApiDivinerParams) {
-    super(params)
-    this.api = params.api
-  }
-
-  static override async create(params: XyoArchiveListApiDivinerParams): Promise<ArchiveListApiDiviner> {
-    return (await super.create(params)) as ArchiveListApiDiviner
-  }
-
-  async divine(): Promise<ArchiveList[]> {
-    const apiResult = (await this.api.archives.get()) ?? []
-    return (
-      apiResult.map((archive) => {
-        return {
-          archive,
-          schema: XyoArchiveSchema,
-        }
-      }) ?? []
-    )
-  }
-
-  protected override async start() {
-    await super.start()
-    return this
-  }
-}

package/src/Diviner/ArchiveListApiDiviner/ArchiveListApiDivinerConfig.ts

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

package/src/Diviner/ArchiveListApiDiviner/Payload.ts

@@ -1,11 +0,0 @@
-import { XyoPayload } from '@xyo-network/payload-model'
-
-import { XyoArchive } from '../../models'
-import { XyoArchiveSchema } from './ArchiveListApiDivinerConfig'
-
-export type ArchiveList = XyoPayload<
-  {
-    archive: XyoArchive
-  },
-  XyoArchiveSchema
->

package/src/Diviner/ArchiveListApiDiviner/index.ts

@@ -1,3 +0,0 @@
-export * from './ArchiveListApiDiviner'
-export * from './ArchiveListApiDivinerConfig'
-export * from './Payload'

package/src/models/Archive.ts

@@ -1,28 +0,0 @@
-import { XyoArchivePath } from './ArchivePath'
-
-export type AccessLevel = 'public' | 'private' | 'none'
-export type AccessType = 'read' | 'remove' | 'create' | 'list'
-export type ExpirationWindow = 'create' | 'read'
-
-export interface XyoAccessControl {
-  access?: Record<AccessType, AccessLevel>
-  expiration?: {
-    delay?: number
-    window?: ExpirationWindow
-  }
-}
-
-export interface XyoAccessControls {
-  /**
-   * Set access controls on a per schema basis.
-   * '*' can be used as a wildcard
-   * Access control is set from a generic to specific direction if
-   * multiple wildcard versions apply to a schema
-   */
-  schema?: Record<string, XyoAccessControl>
-}
-
-export interface XyoArchive extends XyoArchivePath {
-  accessControl?: XyoAccessControl | boolean
-  user?: string
-}

package/src/models/ArchiveKey.ts

@@ -1,5 +0,0 @@
-export interface XyoArchiveKey {
-  archive: string
-  created?: number
-  key: string
-}