@xyo-network/api 2.50.6 → 2.51.0

package/dist/types/models/Archive.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Archive.d.ts","sourceRoot":"","sources":["../../../src/models/Archive.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAE9C,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAA;AACvD,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAA;AAC9D,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG,MAAM,CAAA;AAEhD,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC,UAAU,EAAE,WAAW,CAAC,CAAA;IACxC,UAAU,CAAC,EAAE;QACX,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,MAAM,CAAC,EAAE,gBAAgB,CAAA;KAC1B,CAAA;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;CAC1C;AAED,MAAM,WAAW,UAAW,SAAQ,cAAc;IAChD,aAAa,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAA;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAA;CACd"}

package/dist/types/models/ArchiveKey.d.ts

@@ -1,6 +0,0 @@
-export interface XyoArchiveKey {
-    archive: string;
-    created?: number;
-    key: string;
-}
-//# sourceMappingURL=ArchiveKey.d.ts.map

package/dist/types/models/ArchiveKey.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ArchiveKey.d.ts","sourceRoot":"","sources":["../../../src/models/ArchiveKey.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,GAAG,EAAE,MAAM,CAAA;CACZ"}

package/src/Api/Archive/Api.ts

@@ -1,32 +0,0 @@
-import { XyoArchive } from '../../models'
-import { XyoApiSimple } from '../../Simple'
-import { XyoArchivistArchiveBlockApi } from '../Block'
-import { XyoArchivistArchiveSettingsApi } from './Settings'
-
-export class XyoArchivistArchiveApi extends XyoApiSimple<XyoArchive> {
-  private _block?: XyoArchivistArchiveBlockApi
-  private _settings?: XyoArchivistArchiveSettingsApi
-
-  /**
-   * @deprecated Use module API
-   */
-  get block(): XyoArchivistArchiveBlockApi {
-    this._block =
-      this._block ??
-      new XyoArchivistArchiveBlockApi({
-        ...this.config,
-        root: `${this.root}block/`,
-      })
-    return this._block
-  }
-
-  get settings(): XyoArchivistArchiveSettingsApi {
-    this._settings =
-      this._settings ??
-      new XyoArchivistArchiveSettingsApi({
-        ...this.config,
-        root: `${this.root}settings/`,
-      })
-    return this._settings
-  }
-}

package/src/Api/Archive/Settings/Api.ts

@@ -1,15 +0,0 @@
-import { XyoApiBase } from '../../../Base'
-import { XyoArchivistArchiveSettingsKeyApi } from './Key'
-
-export class XyoArchivistArchiveSettingsApi extends XyoApiBase {
-  private _key?: XyoArchivistArchiveSettingsKeyApi
-  get key(): XyoArchivistArchiveSettingsKeyApi {
-    this._key =
-      this._key ??
-      new XyoArchivistArchiveSettingsKeyApi({
-        ...this.config,
-        root: `${this.root}key/`,
-      })
-    return this._key
-  }
-}

package/src/Api/Archive/Settings/Key/Api.ts

@@ -1,4 +0,0 @@
-import { XyoArchiveKey } from '../../../../models'
-import { XyoApiSimple } from '../../../../Simple'
-
-export class XyoArchivistArchiveSettingsKeyApi extends XyoApiSimple<XyoArchiveKey[]> {}

package/src/Api/Archive/Settings/Key/index.ts

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

package/src/Api/Archive/Settings/index.ts

@@ -1,2 +0,0 @@
-export * from './Api'
-export * from './Key'

package/src/Api/Archive/index.ts

@@ -1,2 +0,0 @@
-export * from './Api'
-export * from './Settings'

package/src/Api/Archives/Api.ts

@@ -1,12 +0,0 @@
-import { XyoArchive } from '../../models'
-import { XyoApiSimple } from '../../Simple'
-import { XyoArchivistArchiveApi } from '../Archive'
-
-export class XyoArchivistArchivesApi extends XyoApiSimple<XyoArchive[]> {
-  archive(archive = 'temp') {
-    return new XyoArchivistArchiveApi({
-      ...this.config,
-      root: `${this.root}${archive}/`,
-    })
-  }
-}

package/src/Api/Archives/index.ts

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

package/src/Api/Block/Api.ts

@@ -1,8 +0,0 @@
-import { XyoBoundWitness } from '@xyo-network/boundwitness-model'
-
-import { XyoApiSimple } from '../../Simple'
-
-export class XyoArchivistArchiveBlockApi<
-  T extends XyoBoundWitness[] = XyoBoundWitness[],
-  C extends XyoBoundWitness[] = XyoBoundWitness[],
-> extends XyoApiSimple<T, C> {}

package/src/Api/Block/index.ts

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

package/src/Api/Node/Api.ts

@@ -1,84 +0,0 @@
-import { assertEx } from '@xylabs/assert'
-import { delay } from '@xylabs/delay'
-import { XyoApiConfig, XyoApiResponseTuple } from '@xyo-network/api-models'
-import { BoundWitnessBuilder } from '@xyo-network/boundwitness-builder'
-import { XyoBoundWitness } from '@xyo-network/boundwitness-model'
-import { XyoPayloadBuilder } from '@xyo-network/payload-builder'
-import { XyoPayload } from '@xyo-network/payload-model'
-
-import { XyoApiSimple, XyoApiSimpleQuery } from '../../Simple'
-import { WithArchive } from '../../WithArchive'
-
-const getRequestStatuses = (results: XyoApiResponseTuple<XyoPayload>[][]): number[] => {
-  return results.flat().map((r) => r?.[2]?.status)
-}
-
-const allRequestsSucceeded = (results: XyoApiResponseTuple<XyoPayload>[][]): boolean => {
-  return getRequestStatuses(results).every((status) => status === 200)
-}
-
-const anyRequestsFailed = (results: XyoApiResponseTuple<XyoPayload>[][]): boolean => {
-  return getRequestStatuses(results).every((status) => status > 399)
-}
-
-export class XyoArchivistNodeApi<
-  D extends XyoBoundWitness | XyoBoundWitness[] = XyoBoundWitness | XyoBoundWitness[],
-  C extends WithArchive<XyoApiConfig> = WithArchive<XyoApiConfig>,
-> extends XyoApiSimple<string[][], D, XyoApiSimpleQuery, C> {
-  /**
-   * @deprecated Use module API
-   * Issue the supplied query and wait (non-blocking) for the result
-   * @param data The query to issue
-   * @param timeout The max time to wait for the query results
-   * @param retryInterval The interval to poll for query results
-   * @returns The result for the issued query
-   */
-  async perform<T extends Partial<XyoPayload>>(data: T, schema: string, timeout = 5000, retryInterval = 100) {
-    const payload = new XyoPayloadBuilder({ schema }).fields(data).build()
-    const [query] = new BoundWitnessBuilder({ inlinePayloads: true }).payload(payload).build()
-    // eslint-disable-next-line deprecation/deprecation
-    const result = await this.performTransaction(query as D, timeout, retryInterval)
-    return result?.[0]?.[0]
-  }
-
-  /**
-   * @deprecated Use module API
-   * Issue the supplied queries and wait (non-blocking) for the results
-   * @param data The queries to issue
-   * @param timeout The max time to wait for the query results
-   * @param retryInterval The interval to poll for query results
-   * @returns The results for the issued queries
-   */
-  async performTransaction(data: D, timeout = 5000, retryInterval = 100) {
-    assertEx(timeout > 0, 'timeout must be positive')
-    assertEx(retryInterval > 0, 'retryInterval must be positive')
-    assertEx(timeout > retryInterval, 'timeout must be greater than retryInterval')
-    const ids = await this.post(data)
-    if (!ids?.length) return []
-    const loops = Math.floor(timeout / retryInterval)
-    let results = [] as XyoApiResponseTuple<XyoPayload>[][]
-    for (let i = 0; i < loops; i++) {
-      await delay(retryInterval)
-      // eslint-disable-next-line deprecation/deprecation
-      results = await Promise.all(ids?.map(async (bw) => await Promise.all(bw.map((p) => this.result(p).get('tuple')))))
-      if (allRequestsSucceeded(results)) break
-      // TODO: More nuanced error handling of partial success/failure
-      if (anyRequestsFailed(results)) throw new Error('Request Error')
-    }
-    // Unpack results
-    return results.map((b) => b.map((p) => p[1]))
-  }
-
-  /**
-   * @deprecated Use module API
-   * Get the result of a previously issued query (if available)
-   * @param queryId Query ID from a previously issued query
-   * @returns The result of the query (if available)
-   */
-  result<T extends XyoPayload = XyoPayload>(queryId: string): XyoApiSimple<XyoPayload> {
-    return new XyoApiSimple<T>({
-      ...this.config,
-      root: `/query/${queryId}/`,
-    })
-  }
-}

package/src/Api/Node/index.ts

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

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
-}