@xyo-network/api 2.20.42 → 2.20.45

package/dist/esm/Archivist/Api.d.ts

@@ -6,6 +6,7 @@ import { XyoUserApi } from '../User';
 import { XyoAccountApi } from './Account';
 import { XyoArchivistArchiveApi } from './Archive';
 import { XyoArchivistArchivesApi } from './Archives';
+import { XyoArchivistNodeApi } from './Node';
 export declare class XyoArchivistApi extends XyoApiBase {
     private _archives?;
     get archives(): XyoArchivistArchivesApi;
@@ -23,7 +24,7 @@ export declare class XyoArchivistApi extends XyoApiBase {
      * @param archive Optional, the archive to issue the requests against
      * @returns Confirmation for the request, as a BoundWitness, from the network Node
      */
-    node<TResponse extends XyoBoundWitness, TData extends XyoBoundWitness = TResponse>(archive?: string): XyoApiSimple<TResponse, TData, Record<string, never>, import("../models/Api/Config").XyoApiConfig>;
+    node<TData extends XyoBoundWitness | XyoBoundWitness[] = XyoBoundWitness | XyoBoundWitness[]>(archive?: string): XyoArchivistNodeApi<TData, import("..").WithArchive<import("../models/Api/Config").XyoApiConfig>>;
     /** @deprecated use huri(huri) instead */
     get(huri: Huri | string): Promise<XyoApiResponseBody<XyoPayload>>;
     /** @deprecated use huri(huri) instead */

package/dist/esm/Archivist/Api.js

@@ -5,6 +5,7 @@ import { XyoUserApi } from '../User';
 import { XyoAccountApi } from './Account';
 import { XyoArchivistArchiveApi } from './Archive';
 import { XyoArchivistArchivesApi } from './Archives';
+import { XyoArchivistNodeApi } from './Node';
 export class XyoArchivistApi extends XyoApiBase {
     get archives() {
         this._archives =
@@ -62,10 +63,10 @@ export class XyoArchivistApi extends XyoApiBase {
      * @param archive Optional, the archive to issue the requests against
      * @returns Confirmation for the request, as a BoundWitness, from the network Node
      */
-    node(archive) {
-        return new XyoApiSimple({
+    node(archive = 'temp') {
+        return new XyoArchivistNodeApi({
             ...this.config,
-            root: archive ? `${this.root}${archive}/` : this.root,
+            root: `${this.root}${archive}/`,
         });
     }
     /** @deprecated use huri(huri) instead */

package/dist/esm/Archivist/Api.js.map

@@ -1 +1 @@
-{"version":3,"file":"Api.js","sourceRoot":"","sources":["../../../src/Archivist/Api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,eAAe,EAA4C,MAAM,mBAAmB,CAAA;AAEnG,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAEpC,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AACzC,OAAO,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAA;AAClD,OAAO,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAA;AAEpD,MAAM,OAAO,eAAgB,SAAQ,UAAU;IAE7C,IAAW,QAAQ;QACjB,IAAI,CAAC,SAAS;YACZ,IAAI,CAAC,SAAS;gBACd,IAAI,uBAAuB,CAAC;oBAC1B,GAAG,IAAI,CAAC,MAAM;oBACd,IAAI,EAAE,GAAG,IAAI,CAAC,IAAI,UAAU;iBAC7B,CAAC,CAAA;QACJ,OAAO,IAAI,CAAC,SAAS,CAAA;IACvB,CAAC;IAGD,IAAW,KAAK;QACd,IAAI,CAAC,MAAM;YACT,IAAI,CAAC,MAAM;gBACX,IAAI,YAAY,CAAY;oBAC1B,GAAG,IAAI,CAAC,MAAM;oBACd,IAAI,EAAE,GAAG,IAAI,CAAC,IAAI,QAAQ;iBAC3B,CAAC,CAAA;QACJ,OAAO,IAAI,CAAC,MAAM,CAAA;IACpB,CAAC;IAGD,IAAW,IAAI;QACb,IAAI,CAAC,KAAK;YACR,IAAI,CAAC,KAAK;gBACV,IAAI,UAAU,CAAC;oBACb,GAAG,IAAI,CAAC,MAAM;oBACd,IAAI,EAAE,GAAG,IAAI,CAAC,IAAI,OAAO;iBAC1B,CAAC,CAAA;QACJ,OAAO,IAAI,CAAC,KAAK,CAAA;IACnB,CAAC;IAEM,OAAO,CAAC,OAAO,GAAG,MAAM;QAC7B,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,EAAE,CAAA;QACzC,OAAO,IAAI,sBAAsB,CAAC;YAChC,GAAG,IAAI,CAAC,MAAM;YACd,IAAI,EAAE,GAAG,IAAI,CAAC,IAAI,WAAW,WAAW,GAAG;SAC5C,CAAC,CAAA;IACJ,CAAC;IAED,sCAAsC;IAC/B,MAAM,CAAC,OAAoB;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;IAC9B,CAAC;IAEM,OAAO,CAAC,OAAoB;QACjC,OAAO,IAAI,aAAa,CAAC;YACvB,GAAG,IAAI,CAAC,MAAM;YACd,IAAI,EAAE,GAAG,IAAI,CAAC,IAAI,UAAU,IAAI,eAAe,CAAC,OAAO,CAAC,CAAC,GAAG,GAAG;SAChE,CAAC,CAAA;IACJ,CAAC;IAEM,IAAI,CAAC,IAAmB;QAC7B,MAAM,OAAO,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;QAChE,OAAO,IAAI,YAAY,CAAa;YAClC,GAAG,IAAI,CAAC,MAAM;YACd,IAAI,EAAE,GAAG,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,GAAG;SACrC,CAAC,CAAA;IACJ,CAAC;IAED;;;;OAIG;IACI,IAAI,CAA+E,OAAgB;QACxG,OAAO,IAAI,YAAY,CAAmB;YACxC,GAAG,IAAI,CAAC,MAAM;YACd,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,GAAG,OAAO,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI;SACtD,CAAC,CAAA;IACJ,CAAC;IAQD,yCAAyC;IAClC,KAAK,CAAC,GAAG,CAAC,IAAmB,EAAE,YAAiC;QACrE,MAAM,OAAO,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;QAChE,QAAQ,YAAY,EAAE;YACpB,KAAK,OAAO;gBACV,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;YACtD;gBACE,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;SACtD;IACH,CAAC;CACF"}
+{"version":3,"file":"Api.js","sourceRoot":"","sources":["../../../src/Archivist/Api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,eAAe,EAA4C,MAAM,mBAAmB,CAAA;AAEnG,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAEpC,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AACzC,OAAO,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAA;AAClD,OAAO,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAA;AACpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,QAAQ,CAAA;AAE5C,MAAM,OAAO,eAAgB,SAAQ,UAAU;IAE7C,IAAW,QAAQ;QACjB,IAAI,CAAC,SAAS;YACZ,IAAI,CAAC,SAAS;gBACd,IAAI,uBAAuB,CAAC;oBAC1B,GAAG,IAAI,CAAC,MAAM;oBACd,IAAI,EAAE,GAAG,IAAI,CAAC,IAAI,UAAU;iBAC7B,CAAC,CAAA;QACJ,OAAO,IAAI,CAAC,SAAS,CAAA;IACvB,CAAC;IAGD,IAAW,KAAK;QACd,IAAI,CAAC,MAAM;YACT,IAAI,CAAC,MAAM;gBACX,IAAI,YAAY,CAAY;oBAC1B,GAAG,IAAI,CAAC,MAAM;oBACd,IAAI,EAAE,GAAG,IAAI,CAAC,IAAI,QAAQ;iBAC3B,CAAC,CAAA;QACJ,OAAO,IAAI,CAAC,MAAM,CAAA;IACpB,CAAC;IAGD,IAAW,IAAI;QACb,IAAI,CAAC,KAAK;YACR,IAAI,CAAC,KAAK;gBACV,IAAI,UAAU,CAAC;oBACb,GAAG,IAAI,CAAC,MAAM;oBACd,IAAI,EAAE,GAAG,IAAI,CAAC,IAAI,OAAO;iBAC1B,CAAC,CAAA;QACJ,OAAO,IAAI,CAAC,KAAK,CAAA;IACnB,CAAC;IAEM,OAAO,CAAC,OAAO,GAAG,MAAM;QAC7B,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,EAAE,CAAA;QACzC,OAAO,IAAI,sBAAsB,CAAC;YAChC,GAAG,IAAI,CAAC,MAAM;YACd,IAAI,EAAE,GAAG,IAAI,CAAC,IAAI,WAAW,WAAW,GAAG;SAC5C,CAAC,CAAA;IACJ,CAAC;IAED,sCAAsC;IAC/B,MAAM,CAAC,OAAoB;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;IAC9B,CAAC;IAEM,OAAO,CAAC,OAAoB;QACjC,OAAO,IAAI,aAAa,CAAC;YACvB,GAAG,IAAI,CAAC,MAAM;YACd,IAAI,EAAE,GAAG,IAAI,CAAC,IAAI,UAAU,IAAI,eAAe,CAAC,OAAO,CAAC,CAAC,GAAG,GAAG;SAChE,CAAC,CAAA;IACJ,CAAC;IAEM,IAAI,CAAC,IAAmB;QAC7B,MAAM,OAAO,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;QAChE,OAAO,IAAI,YAAY,CAAa;YAClC,GAAG,IAAI,CAAC,MAAM;YACd,IAAI,EAAE,GAAG,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,GAAG;SACrC,CAAC,CAAA;IACJ,CAAC;IAED;;;;OAIG;IACI,IAAI,CAA0F,OAAO,GAAG,MAAM;QACnH,OAAO,IAAI,mBAAmB,CAAQ;YACpC,GAAG,IAAI,CAAC,MAAM;YACd,IAAI,EAAE,GAAG,IAAI,CAAC,IAAI,GAAG,OAAO,GAAG;SAChC,CAAC,CAAA;IACJ,CAAC;IAQD,yCAAyC;IAClC,KAAK,CAAC,GAAG,CAAC,IAAmB,EAAE,YAAiC;QACrE,MAAM,OAAO,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;QAChE,QAAQ,YAAY,EAAE;YACpB,KAAK,OAAO;gBACV,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;YACtD;gBACE,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;SACtD;IACH,CAAC;CACF"}

package/dist/esm/Archivist/Node/Api.d.ts

@@ -0,0 +1,28 @@
+import { XyoBoundWitness, XyoPayload } from '@xyo-network/core';
+import { XyoApiConfig } from '../../models';
+import { XyoApiSimple, XyoApiSimpleQuery } from '../../Simple';
+import { WithArchive } from '../../WithArchive';
+export declare class XyoArchivistNodeApi<D extends XyoBoundWitness | XyoBoundWitness[] = XyoBoundWitness | XyoBoundWitness[], C extends WithArchive<XyoApiConfig> = WithArchive<XyoApiConfig>> extends XyoApiSimple<string[][], D, XyoApiSimpleQuery, C> {
+    /**
+     * 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>;
+    /**
+     * 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
+     */
+    performTransaction(data: D, timeout?: number, retryInterval?: number): Promise<import("../../models").XyoApiEnvelope<import("@xyo-network/core").XyoPayloadFull | undefined>[][]>;
+    /**
+     * 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
+     */
+    perform<T>(data: T, schema: string, timeout?: number, retryInterval?: number): Promise<import("../../models").XyoApiEnvelope<import("@xyo-network/core").XyoPayloadFull | undefined>>;
+}

package/dist/esm/Archivist/Node/Api.js

@@ -0,0 +1,67 @@
+import { assertEx, delay } from '@xylabs/sdk-js';
+import { XyoBoundWitnessBuilder, XyoPayloadBuilder } from '@xyo-network/core';
+import { XyoApiSimple } from '../../Simple';
+const getRequestStatuses = (results) => {
+    return results.flatMap((r) => r).map((r) => r?.[2]?.status);
+};
+const allRequestsSucceeded = (results) => {
+    return getRequestStatuses(results).every((status) => status === 200);
+};
+const anyRequestsFailed = (results) => {
+    return getRequestStatuses(results).every((status) => status > 399);
+};
+export class XyoArchivistNodeApi extends XyoApiSimple {
+    /**
+     * 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(queryId) {
+        return new XyoApiSimple({
+            ...this.config,
+            root: `/query/${queryId}/`,
+        });
+    }
+    /**
+     * 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, 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 = [];
+        for (let i = 0; i < loops; i++) {
+            await delay(retryInterval);
+            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]));
+    }
+    /**
+     * 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(data, schema, timeout = 5000, retryInterval = 100) {
+        const payload = new XyoPayloadBuilder({ schema }).fields(data).build();
+        const query = new XyoBoundWitnessBuilder({ inlinePayloads: true }).payload(payload).build();
+        const result = await this.performTransaction(query, timeout, retryInterval);
+        return result?.[0]?.[0];
+    }
+}
+//# sourceMappingURL=Api.js.map

package/dist/esm/Archivist/Node/Api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Api.js","sourceRoot":"","sources":["../../../../src/Archivist/Node/Api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAmB,sBAAsB,EAAc,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAG1G,OAAO,EAAE,YAAY,EAAqB,MAAM,cAAc,CAAA;AAG9D,MAAM,kBAAkB,GAAG,CAAC,OAA4C,EAAY,EAAE;IACpF,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAA;AAC7D,CAAC,CAAA;AAED,MAAM,oBAAoB,GAAG,CAAC,OAA4C,EAAW,EAAE;IACrF,OAAO,kBAAkB,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,KAAK,GAAG,CAAC,CAAA;AACtE,CAAC,CAAA;AAED,MAAM,iBAAiB,GAAG,CAAC,OAA4C,EAAW,EAAE;IAClF,OAAO,kBAAkB,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,GAAG,GAAG,CAAC,CAAA;AACpE,CAAC,CAAA;AAED,MAAM,OAAO,mBAGX,SAAQ,YAAiD;IACzD;;;;OAIG;IACI,MAAM,CAAoC,OAAe;QAC9D,OAAO,IAAI,YAAY,CAAI;YACzB,GAAG,IAAI,CAAC,MAAM;YACd,IAAI,EAAE,UAAU,OAAO,GAAG;SAC3B,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,kBAAkB,CAAC,IAAO,EAAE,OAAO,GAAG,IAAI,EAAE,aAAa,GAAG,GAAG;QAC1E,QAAQ,CAAC,OAAO,GAAG,CAAC,EAAE,0BAA0B,CAAC,CAAA;QACjD,QAAQ,CAAC,aAAa,GAAG,CAAC,EAAE,gCAAgC,CAAC,CAAA;QAC7D,QAAQ,CAAC,OAAO,GAAG,aAAa,EAAE,4CAA4C,CAAC,CAAA;QAC/E,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACjC,IAAI,CAAC,GAAG,EAAE,MAAM;YAAE,OAAO,EAAE,CAAA;QAC3B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,aAAa,CAAC,CAAA;QACjD,IAAI,OAAO,GAAG,EAAyC,CAAA;QACvD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE;YAC9B,MAAM,KAAK,CAAC,aAAa,CAAC,CAAA;YAC1B,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YAClH,IAAI,oBAAoB,CAAC,OAAO,CAAC;gBAAE,MAAK;YACxC,+DAA+D;YAC/D,IAAI,iBAAiB,CAAC,OAAO,CAAC;gBAAE,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAA;SACjE;QACD,iBAAiB;QACjB,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAC/C,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,OAAO,CAAI,IAAO,EAAE,MAAc,EAAE,OAAO,GAAG,IAAI,EAAE,aAAa,GAAG,GAAG;QAClF,MAAM,OAAO,GAAG,IAAI,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,CAAA;QACtE,MAAM,KAAK,GAAG,IAAI,sBAAsB,CAAC,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAO,CAAA;QAChG,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,OAAO,EAAE,aAAa,CAAC,CAAA;QAC3E,OAAO,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IACzB,CAAC;CACF"}

package/dist/esm/Archivist/Node/index.d.ts

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

package/dist/esm/Archivist/Node/index.js

@@ -0,0 +1,2 @@
+export * from './Api';
+//# sourceMappingURL=index.js.map

package/dist/esm/Archivist/Node/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/Archivist/Node/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAA"}

package/package.json

@@ -10,7 +10,7 @@
   },
   "dependencies": {
     "@xylabs/sdk-js": "^2.5.7",
-    "@xyo-network/core": "^2.20.42",
+    "@xyo-network/core": "^2.20.45",
     "axios": "^0.27.2",
     "pako": "^2.0.4",
     "uuid": "^8.3.2"
@@ -28,7 +28,7 @@
     "ethers": "^5.6.8",
     "license-checker": "^25.0.1",
     "tslib": "^2.4.0",
-    "typescript": "^4.7.2"
+    "typescript": "^4.7.3"
   },
   "browser": "dist/esm/index.js",
   "docs": "dist/docs.json",
@@ -67,6 +67,6 @@
   },
   "sideEffects": true,
   "types": "dist/esm/index.d.ts",
-  "version": "2.20.42",
+  "version": "2.20.45",
   "packageManager": "yarn@3.1.1"
 }

package/src/Archivist/Api.spec.ts

@@ -1,4 +1,4 @@
-import { XyoAccount, XyoBoundWitness, XyoBoundWitnessBuilder, XyoPayload, XyoPayloadBuilder } from '@xyo-network/core'
+import { XyoAccount, XyoBoundWitness, XyoBoundWitnessBuilder } from '@xyo-network/core'
 import { config } from 'dotenv'
 
 import { XyoApiConfig, XyoApiError } from '../models'
@@ -56,31 +56,6 @@ describe('postBoundWitnesses', () => {
   })
 })
 
-describe('node', () => {
-  describe('with archive', () => {
-    it('calculates the correct path', () => {
-      const api = new XyoArchivistApi(configData)
-      const path = api.node().config.root
-      expect(path).toBe('/')
-    })
-  })
-  describe('without archive', () => {
-    it('calculates the correct path', () => {
-      const archive = 'foo'
-      const api = new XyoArchivistApi(configData)
-      const path = api.node(archive).config.root
-      expect(path).toBe(`/${archive}/`)
-    })
-    it('posts to the root', () => {
-      const api = new XyoArchivistApi(configData)
-      const p: XyoPayload<{ foo: string }> = new XyoPayloadBuilder<XyoPayload<{ foo: string }>>({ schema: 'foo' }).fields({ foo: 'bar' }).build()
-      const bw: XyoBoundWitness = new XyoBoundWitnessBuilder({ inlinePayloads: true }).payload(p).build()
-      const path = api.node('foo').post(bw)
-      expect(path).toBe('/foo/')
-    })
-  })
-})
-
 describeSkipIfNoToken('XyoArchivistApi', () => {
   describe('get', () => {
     it('returns a new XyoArchivistApi', () => {

package/src/Archivist/Api.ts

@@ -7,6 +7,7 @@ import { XyoUserApi } from '../User'
 import { XyoAccountApi } from './Account'
 import { XyoArchivistArchiveApi } from './Archive'
 import { XyoArchivistArchivesApi } from './Archives'
+import { XyoArchivistNodeApi } from './Node'
 
 export class XyoArchivistApi extends XyoApiBase {
   private _archives?: XyoArchivistArchivesApi
@@ -75,10 +76,10 @@ export class XyoArchivistApi extends XyoApiBase {
    * @param archive Optional, the archive to issue the requests against
    * @returns Confirmation for the request, as a BoundWitness, from the network Node
    */
-  public node<TResponse extends XyoBoundWitness, TData extends XyoBoundWitness = TResponse>(archive?: string) {
-    return new XyoApiSimple<TResponse, TData>({
+  public node<TData extends XyoBoundWitness | XyoBoundWitness[] = XyoBoundWitness | XyoBoundWitness[]>(archive = 'temp') {
+    return new XyoArchivistNodeApi<TData>({
       ...this.config,
-      root: archive ? `${this.root}${archive}/` : this.root,
+      root: `${this.root}${archive}/`,
     })
   }
 

package/src/Archivist/Node/Api.spec.ts

@@ -0,0 +1,141 @@
+import { assertEx, delay } from '@xylabs/sdk-js'
+import { XyoBoundWitness, XyoBoundWitnessBuilder, XyoPayload, XyoPayloadBuilder } from '@xyo-network/core'
+import { v4 } from 'uuid'
+
+import { XyoApiConfig, XyoApiEnvelope } from '../../models'
+import { XyoArchivistApi } from '../Api'
+
+const config: XyoApiConfig = {
+  apiDomain: process.env.API_DOMAIN || 'http://localhost:8080',
+}
+
+const schema = 'network.xyo.debug'
+
+const getQuery = (count = 1): XyoBoundWitness => {
+  const payloads = [] as XyoPayload[]
+  for (let i = 0; i < count; i++) {
+    payloads.push(new XyoPayloadBuilder({ schema }).fields({ nonce: v4() }).build())
+  }
+  return new XyoBoundWitnessBuilder({ inlinePayloads: true }).payloads(payloads).build()
+}
+
+const issueQuery = async (query: XyoBoundWitness = getQuery()): Promise<string> => {
+  const api = new XyoArchivistApi(config)
+  const response = await api.node('temp').post(query)
+  const id = response?.[0]?.[0]
+  expect(id).toBeDefined()
+  return assertEx(id)
+}
+
+const validateAllResponseSchemas = (response: XyoApiEnvelope<XyoPayload | undefined>[][]): boolean => {
+  return response
+    .flatMap((r) => r)
+    .map((r) => (r as unknown as XyoPayload)?.schema)
+    .every((s) => s === schema)
+}
+
+describe('XyoArchivistNodeApi', () => {
+  describe('node', () => {
+    describe('without archive supplied', () => {
+      it('calculates the correct path', () => {
+        const api = new XyoArchivistApi(config)
+        const path = api.node().config.root
+        expect(path).toBe('/temp/')
+      })
+    })
+    describe('with archive supplied', () => {
+      const archive = 'foo'
+      it('calculates the correct path', () => {
+        const api = new XyoArchivistApi(config)
+        const path = api.node(archive).config.root
+        expect(path).toBe(`/${archive}/`)
+      })
+    })
+  })
+  describe('queryResult', () => {
+    let id = '123456789'
+    describe('with valid query id', () => {
+      beforeEach(async () => {
+        id = await issueQuery()
+      })
+      it('returns the query result', async () => {
+        const api = new XyoArchivistApi(config)
+        await delay(1000)
+        const [_, payload, response] = await api.node().result(id).get('tuple')
+        expect(_).toBeUndefined()
+        expect(payload).toBeDefined()
+        expect((payload as unknown as XyoPayload).schema).toBe(schema)
+        expect(response.status).toBe(200)
+      })
+    })
+    describe('without archive supplied', () => {
+      it('calculates the correct path', () => {
+        const api = new XyoArchivistApi(config)
+        const path = api.node().result(id).config.root
+        expect(path).toBe(`/query/${id}/`)
+      })
+    })
+    describe('with archive supplied', () => {
+      const archive = 'foo'
+      it('calculates the correct path', () => {
+        const api = new XyoArchivistApi(config)
+        const path = api.node(archive).result(id).config.root
+        expect(path).toBe(`/query/${id}/`)
+      })
+    })
+  })
+  describe('perform', () => {
+    it('creates and issues the query and returns the result', async () => {
+      const api = new XyoArchivistApi(config)
+      const response = await api.node().perform({ nonce: v4() }, schema)
+      expect(response).toBeDefined()
+      expect((response as unknown as XyoPayload).schema).toBe(schema)
+    })
+  })
+  describe('performTransaction', () => {
+    describe('with a single BoundWitness', () => {
+      describe('with a single Payload', () => {
+        it('issues the query and returns the result', async () => {
+          const api = new XyoArchivistApi(config)
+          const query = [getQuery()]
+          const response = await api.node().performTransaction(query)
+          expect(response).toBeDefined()
+          expect(Array.isArray(response)).toBeTruthy()
+          expect(validateAllResponseSchemas(response)).toBeTruthy()
+        })
+      })
+      describe('with a multiple Payloads', () => {
+        it('issues the query and returns the result', async () => {
+          const api = new XyoArchivistApi(config)
+          const query = [getQuery(2)]
+          const response = await api.node().performTransaction(query)
+          expect(response).toBeDefined()
+          expect(Array.isArray(response)).toBeTruthy()
+          expect(validateAllResponseSchemas(response)).toBeTruthy()
+        })
+      })
+    })
+    describe('with a multiple BoundWitnesses', () => {
+      describe('with a single Payload', () => {
+        it('issues the query and returns the result', async () => {
+          const api = new XyoArchivistApi(config)
+          const query = [getQuery(), getQuery()]
+          const response = await api.node().performTransaction(query)
+          expect(response).toBeDefined()
+          expect(Array.isArray(response)).toBeTruthy()
+          expect(validateAllResponseSchemas(response)).toBeTruthy()
+        })
+      })
+      describe('with a multiple Payloads', () => {
+        it('issues the query and returns the result', async () => {
+          const api = new XyoArchivistApi(config)
+          const query = [getQuery(2), getQuery(2)]
+          const response = await api.node().performTransaction(query)
+          expect(response).toBeDefined()
+          expect(Array.isArray(response)).toBeTruthy()
+          expect(validateAllResponseSchemas(response)).toBeTruthy()
+        })
+      })
+    })
+  })
+})

package/src/Archivist/Node/Api.ts

@@ -0,0 +1,75 @@
+import { assertEx, delay } from '@xylabs/sdk-js'
+import { XyoBoundWitness, XyoBoundWitnessBuilder, XyoPayload, XyoPayloadBuilder } from '@xyo-network/core'
+
+import { XyoApiConfig, XyoApiResponseTuple } from '../../models'
+import { XyoApiSimple, XyoApiSimpleQuery } from '../../Simple'
+import { WithArchive } from '../../WithArchive'
+
+const getRequestStatuses = (results: XyoApiResponseTuple<XyoPayload>[][]): number[] => {
+  return results.flatMap((r) => r).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> {
+  /**
+   * 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)
+   */
+  public result<T extends XyoPayload = XyoPayload>(queryId: string): XyoApiSimple<XyoPayload> {
+    return new XyoApiSimple<T>({
+      ...this.config,
+      root: `/query/${queryId}/`,
+    })
+  }
+
+  /**
+   * 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
+   */
+  public 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)
+      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]))
+  }
+
+  /**
+   * 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
+   */
+  public async perform<T>(data: T, schema: string, timeout = 5000, retryInterval = 100) {
+    const payload = new XyoPayloadBuilder({ schema }).fields(data).build()
+    const query = new XyoBoundWitnessBuilder({ inlinePayloads: true }).payload(payload).build() as D
+    const result = await this.performTransaction(query, timeout, retryInterval)
+    return result?.[0]?.[0]
+  }
+}

package/src/Archivist/Node/index.ts

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