@xyo-network/api 2.43.8 → 2.43.9

package/dist/esm/Api/Payload/Schema/Api.js

@@ -1,6 +1,9 @@
 import { XyoApiSimple } from '../../../Simple';
 export class XyoArchivistArchivePayloadSchemaApi extends XyoApiSimple {
     _stats;
+    /**
+     * @deprecated Use module API
+     */
     get stats() {
         this._stats =
             this._stats ??

package/dist/esm/Api/Payload/Schema/Api.js.map

@@ -1 +1 @@
-{"version":3,"file":"Api.js","sourceRoot":"","sources":["../../../../../src/Api/Payload/Schema/Api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAM9C,MAAM,OAAO,mCAAoC,SAAQ,YAAsB;IACrE,MAAM,CAAsD;IACpE,IAAW,KAAK;QACd,IAAI,CAAC,MAAM;YACT,IAAI,CAAC,MAAM;gBACX,IAAI,YAAY,CAAwC;oBACtD,GAAG,IAAI,CAAC,MAAM;oBACd,IAAI,EAAE,GAAG,IAAI,CAAC,IAAI,QAAQ;iBAC3B,CAAC,CAAA;QACJ,OAAO,IAAI,CAAC,MAAM,CAAA;IACpB,CAAC;CACF"}
+{"version":3,"file":"Api.js","sourceRoot":"","sources":["../../../../../src/Api/Payload/Schema/Api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAM9C,MAAM,OAAO,mCAAoC,SAAQ,YAAsB;IACrE,MAAM,CAAsD;IACpE;;OAEG;IACH,IAAW,KAAK;QACd,IAAI,CAAC,MAAM;YACT,IAAI,CAAC,MAAM;gBACX,IAAI,YAAY,CAAwC;oBACtD,GAAG,IAAI,CAAC,MAAM;oBACd,IAAI,EAAE,GAAG,IAAI,CAAC,IAAI,QAAQ;iBAC3B,CAAC,CAAA;QACJ,OAAO,IAAI,CAAC,MAAM,CAAA;IACpB,CAAC;CACF"}

package/package.json

@@ -11,28 +11,28 @@
   "dependencies": {
     "@xylabs/assert": "^2.6.15",
     "@xylabs/delay": "^2.6.15",
-    "@xyo-network/account": "^2.43.8",
-    "@xyo-network/api-models": "^2.43.8",
-    "@xyo-network/archivist": "^2.43.8",
-    "@xyo-network/axios": "^2.43.8",
-    "@xyo-network/boundwitness-builder": "^2.43.8",
-    "@xyo-network/boundwitness-model": "^2.43.8",
-    "@xyo-network/core": "^2.43.8",
-    "@xyo-network/diviner": "^2.43.8",
-    "@xyo-network/diviner-model": "^2.43.8",
-    "@xyo-network/huri": "^2.43.8",
-    "@xyo-network/module": "^2.43.8",
-    "@xyo-network/module-model": "^2.43.8",
-    "@xyo-network/payload-builder": "^2.43.8",
-    "@xyo-network/payload-model": "^2.43.8",
-    "@xyo-network/payload-wrapper": "^2.43.8",
-    "@xyo-network/schema-payload-plugin": "^2.43.8",
+    "@xyo-network/account": "^2.43.9",
+    "@xyo-network/api-models": "^2.43.9",
+    "@xyo-network/archivist": "^2.43.9",
+    "@xyo-network/axios": "^2.43.9",
+    "@xyo-network/boundwitness-builder": "^2.43.9",
+    "@xyo-network/boundwitness-model": "^2.43.9",
+    "@xyo-network/core": "^2.43.9",
+    "@xyo-network/diviner": "^2.43.9",
+    "@xyo-network/diviner-model": "^2.43.9",
+    "@xyo-network/huri": "^2.43.9",
+    "@xyo-network/module": "^2.43.9",
+    "@xyo-network/module-model": "^2.43.9",
+    "@xyo-network/payload-builder": "^2.43.9",
+    "@xyo-network/payload-model": "^2.43.9",
+    "@xyo-network/payload-wrapper": "^2.43.9",
+    "@xyo-network/schema-payload-plugin": "^2.43.9",
     "lodash": "^4.17.21"
   },
   "description": "Primary SDK for using XYO Protocol 2.0",
   "devDependencies": {
     "@types/lodash": "^4.14.191",
-    "@xylabs/ts-scripts-yarn3": "^2.12.3"
+    "@xylabs/ts-scripts-yarn3": "^2.12.21"
   },
   "browser": "dist/esm/index.js",
   "docs": "dist/docs.json",
@@ -67,5 +67,5 @@
   },
   "sideEffects": false,
   "types": "dist/esm/index.d.ts",
-  "version": "2.43.8"
+  "version": "2.43.9"
 }

package/src/Api/Addresses/Address/Api.ts

@@ -5,6 +5,9 @@ import { ModuleDescription } from '@xyo-network/module-model'
 import { XyoApiSimple } from '../../../Simple'
 
 export class XyoAddressApi<C extends XyoApiConfig = XyoApiConfig> extends XyoApiSimple<ModuleDescription, C> {
+  /**
+   * @deprecated Use module API
+   */
   public get boundWitnesses(): XyoApiSimple<XyoBoundWitness[]> {
     return new XyoApiSimple({
       ...this.config,

package/src/Api/Addresses/Api.ts

@@ -5,6 +5,9 @@ import { XyoApiSimple } from '../../Simple'
 import { XyoAddressApi } from './Address'
 
 export class XyoAddressesApi<C extends XyoApiConfig = XyoApiConfig> extends XyoApiSimple<ModuleDescription, C> {
+  /**
+   * @deprecated Use module API
+   */
   public address(address: string): XyoAddressApi {
     return new XyoAddressApi({
       ...this.config,

package/src/Api/Api.ts

@@ -20,6 +20,9 @@ export class XyoArchivistApi<C extends XyoApiConfig = XyoApiConfig> extends XyoA
   private _stats?: XyoApiSimple<unknown[]>
   private _user?: XyoUserApi
 
+  /**
+   * @deprecated Use module API
+   */
   public get addresses(): XyoAddressesApi {
     this._addresses =
       this._addresses ??
@@ -40,6 +43,9 @@ export class XyoArchivistApi<C extends XyoApiConfig = XyoApiConfig> extends XyoA
     return this._archives
   }
 
+  /**
+   * @deprecated Use module API
+   */
   public get stats() {
     this._stats =
       this._stats ??
@@ -85,6 +91,7 @@ export class XyoArchivistApi<C extends XyoApiConfig = XyoApiConfig> extends XyoA
 
   /**
    * Issues commands/queries as XyoBoundWitness wrapped XyoPayloads against a Node in the network
+   * @deprecated Use module API
    * @param archive Optional, the archive to issue the requests against
    * @returns Confirmation for the request, as a BoundWitness, from the network Node
    */
@@ -94,9 +101,4 @@ export class XyoArchivistApi<C extends XyoApiConfig = XyoApiConfig> extends XyoA
       root: `${this.root}${archive}/`,
     })
   }
-
-  /** @deprecated use account instead */
-  public wallet(address: DataLike) {
-    return this.account(address)
-  }
 }

package/src/Api/Archive/Api.ts

@@ -12,6 +12,9 @@ export class XyoArchivistArchiveApi extends XyoApiSimple<XyoArchive> {
   private _schemas?: XyoArchivistArchiveSchemasApi
   private _settings?: XyoArchivistArchiveSettingsApi
 
+  /**
+   * @deprecated Use module API
+   */
   public get block(): XyoArchivistArchiveBlockApi {
     this._block =
       this._block ??
@@ -22,6 +25,9 @@ export class XyoArchivistArchiveApi extends XyoApiSimple<XyoArchive> {
     return this._block
   }
 
+  /**
+   * @deprecated Use module API
+   */
   public get payload(): XyoArchivistPayloadApi {
     this._payload =
       this._payload ??
@@ -32,6 +38,9 @@ export class XyoArchivistArchiveApi extends XyoApiSimple<XyoArchive> {
     return this._payload
   }
 
+  /**
+   * @deprecated Use module API
+   */
   public get schemas(): XyoArchivistArchiveSchemasApi {
     this._schemas =
       this._schemas ??
@@ -52,6 +61,9 @@ export class XyoArchivistArchiveApi extends XyoApiSimple<XyoArchive> {
     return this._settings
   }
 
+  /**
+   * @deprecated Use module API
+   */
   public schema(schema: string): XyoArchivistArchiveSchemaApi {
     return new XyoArchivistArchiveSchemaApi({
       ...this.config,

package/src/Api/Archive/Schema/Api.ts

@@ -5,6 +5,9 @@ import { XyoApiSimple } from '../../../Simple'
 
 export class XyoArchivistArchiveSchemaApi extends XyoApiBase {
   private _recent?: XyoApiSimple<XyoPayload[]>
+  /**
+   * @deprecated Use module API
+   */
   public get recent(): XyoApiSimple<XyoPayload[]> {
     this._recent =
       this._recent ??

package/src/Api/Archive/Schemas/Api.ts

@@ -4,6 +4,9 @@ import { XyoApiSimple } from '../../../Simple'
 
 export class XyoArchivistArchiveSchemasApi extends XyoApiSimple<XyoSchemaPayload[]> {
   private _recent?: XyoApiSimple<XyoSchemaPayload[]>
+  /**
+   * @deprecated Use module API
+   */
   public get recent(): XyoApiSimple<XyoSchemaPayload[]> {
     this._recent =
       this._recent ??

package/src/Api/Archives/Api.ts

@@ -9,9 +9,4 @@ export class XyoArchivistArchivesApi extends XyoApiSimple<XyoArchive[]> {
       root: `${this.root}${archive}/`,
     })
   }
-
-  /** @deprecated: use archive(string) instead */
-  public select(archive = 'temp') {
-    return this.archive(archive)
-  }
 }

package/src/Api/Block/Api.ts

@@ -10,6 +10,9 @@ export class XyoArchivistArchiveBlockApi<
   T extends XyoBoundWitness = XyoBoundWitness,
   C extends WithArchive<XyoApiConfig> = WithArchive<XyoApiConfig>,
 > extends XyoArchivistPayloadApi<T, C> {
+  /**
+   * @deprecated Use module API
+   */
   public payloads(hash: string): XyoApiSimple<XyoPayload[][]> {
     return new XyoApiSimple<XyoPayload[][]>({
       ...this.config,

package/src/Api/Node/Api.ts

@@ -26,6 +26,7 @@ export class XyoArchivistNodeApi<
   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
@@ -35,11 +36,13 @@ export class XyoArchivistNodeApi<
   public 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
@@ -56,6 +59,7 @@ export class XyoArchivistNodeApi<
     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
@@ -66,6 +70,7 @@ export class XyoArchivistNodeApi<
   }
 
   /**
+   * @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)

package/src/Api/Payload/Api.ts

@@ -1,4 +1,3 @@
-import { assertEx } from '@xylabs/assert'
 import { XyoApiConfig } from '@xyo-network/api-models'
 import { PayloadFindFilter, XyoPayload } from '@xyo-network/payload-model'
 
@@ -15,6 +14,9 @@ export class XyoArchivistPayloadApi<
   C extends WithArchive<XyoApiConfig> = WithArchive<XyoApiConfig>,
 > extends XyoApiSimple<T[], T[], PayloadFindFilter, C> {
   private _stats?: XyoApiSimple<XyoPayloadStats>
+  /**
+   * @deprecated Use module API
+   */
   public get schema(): XyoArchivistArchivePayloadSchemaApi {
     return new XyoArchivistArchivePayloadSchemaApi({
       ...this.config,
@@ -22,6 +24,9 @@ export class XyoArchivistPayloadApi<
     })
   }
 
+  /**
+   * @deprecated Use module API
+   */
   public get stats(): XyoApiSimple<XyoPayloadStats> {
     this._stats =
       this._stats ??
@@ -32,48 +37,9 @@ export class XyoArchivistPayloadApi<
     return this._stats
   }
 
-  /** @deprecated use find */
-  public async findAfter(timestamp: number, limit = 20) {
-    return await this.find({ limit, order: 'asc', timestamp })
-  }
-
-  /** @deprecated use find */
-  public async findBefore(timestamp: number, limit = 20) {
-    return await this.find({ limit, order: 'desc', timestamp })
-  }
-
-  /** @deprecated use find */
-  public async findMostRecent(limit = 20) {
-    assertEx(limit > 0, 'min limit = 1')
-    assertEx(limit <= 100, 'max limit = 100')
-    return await this.find({ limit, order: 'desc', timestamp: 999999999999 })
-  }
-
-  /** @deprecated use find */
-  public async getAfter(timestamp: number, limit = 20) {
-    return await this.find({ limit, order: 'asc', timestamp })
-  }
-
-  /** @deprecated use findBefore */
-  public async getBefore(timestamp: number, limit = 20) {
-    return await this.find({ limit, order: 'desc', timestamp })
-  }
-
-  /** @deprecated use hash */
-  public async getByHash(hash: string) {
-    return await this.getEndpoint<T[]>(`hash/${hash}`)
-  }
-
-  /** @deprecated use find */
-  public async getMostRecent(limit = 20) {
-    return await this.find({ limit, order: 'desc', timestamp: 999999999999 })
-  }
-
-  /** @deprecated use stats instead */
-  public async getStats() {
-    return await this.getEndpoint<XyoPayloadStats>('stats')
-  }
-
+  /**
+   * @deprecated Use module API
+   */
   public hash(hash: string): XyoApiSimple<XyoPayload[]> {
     return new XyoApiSimple<XyoPayload[]>({
       ...this.config,
@@ -81,12 +47,10 @@ export class XyoArchivistPayloadApi<
     })
   }
 
+  /**
+   * @deprecated Use module API
+   */
   public async repair(hash: string) {
     return await this.getEndpoint<T[]>(`hash/${hash}/repair`)
   }
-
-  /** @deprecated use repair */
-  public async repairByHash(hash: string) {
-    return await this.repair(hash)
-  }
 }

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

@@ -6,6 +6,9 @@ export interface XyoArchivistArchivePayloadSchemaStats {
 
 export class XyoArchivistArchivePayloadSchemaApi extends XyoApiSimple<string[]> {
   private _stats?: XyoApiSimple<XyoArchivistArchivePayloadSchemaStats>
+  /**
+   * @deprecated Use module API
+   */
   public get stats() {
     this._stats =
       this._stats ??